feature/create-dun-js-package

Author: Kenneth

.gitignore

@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+lib
+node_modules
+# dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+.env*

.prettierrc

@@ -0,0 +1,7 @@
+{
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 80,
+    "tabWidth": 2
+}

README.md

@@ -0,0 +1,199 @@
+## Getting started
+
+### Installation
+
+Before you start, make sure you have a fresh version of [Node.js](https://nodejs.org/en/) installed. The current Long Term Support (LTS) release is an ideal starting point.
+
+```bash
+# Run this command in your project root folder.
+# yarn
+yarn add dun-js
+
+# npm
+npm install --save dun-js
+```
+
+Then you can simply import or require the module.
+
+```javascript
+// ES module
+import { AuthClient } from 'dun-js';
+const authClient = new AuthClient(/* configOptions */);
+```
+
+```javascript
+// CommonJS
+var AuthClient = require('dun-js').AuthClient;
+var authClient = new AuthClient(/* configOptions */);
+```
+
+## Usage guide
+
+### Example Client
+
+```javascript
+const config = {
+  mode: 'development',
+  brandUrl: 'jframework.io',
+};
+
+const authClient = new AuthClient(config);
+```
+
+### Usage with Typescript
+
+Type definitions are provided implicitly through the `types` entry in `package.json`. Types can also be referenced explicitly by importing them.
+
+```typescript
+import { AuthClient, DunConfig } from 'dun-js';
+
+const config: DunConfig = {
+  mode: 'development',
+  brandUrl: 'jframework.io',
+};
+
+const authClient: AuthClient = new AuthClient(config);
+```
+
+### Using API
+
+You can easily utilize the API by importing it and then invoking its methods.
+
+Example:
+
+```typescript
+import { ISignInPayload, signInAPI } from 'dun-js';
+
+const payload: ISignInPayload = {
+  username: formValues.username,
+  password: formValues.password,
+};
+
+const response = await signInAPI(payload);
+```
+
+## Configuration reference
+
+### Configuration options
+
+These options can be included when instantiating DUN Auth JS (`new AuthClient(config)`).
+
+#### `brandUrl`
+
+> :warning: This option is required
+
+The url for your DUN brand.
+
+#### `mode`
+
+The default environment for your application is set to 'production'. To switch to a development environment, set the environment to 'development'.
+
+### Methods
+
+#### `setAuthKey()`
+
+Upon logging in, you will receive an `authKey` from the server. Use the following method to set the `authKey` in the request header.
+
+Example:
+
+```javascript
+authClient.setAuthKey(authKey);
+```
+
+#### `setHeaders()`
+
+If you want to set headers for all APIs, use this method.
+
+Example:
+
+```javascript
+const userHeaders = {
+  UrlRequest: window.location.href,
+};
+
+authClient.setHeaders(userHeaders);
+```
+
+## API Reference
+
+- [auth](https://developers.jframework.io/references/api-reference/authentication)
+  - [signInUsingUsernameAPI](https://developers.jframework.io/references/api-reference/endpoints/users/authentication)
+  - [signInUsingEmailAPI](https://developers.jframework.io/references/api-reference/endpoints/users/authentication-by-email)
+  - [getGoogleLinkAPI](https://developers.jframework.io/guide/login-with-google#get-a-google-login-url-from-dun)
+- [brand](https://developers.jframework.io/references/api-reference/endpoints/brands)
+  - [getListBrandEmailsAPI](https://developers.jframework.io/references/api-reference/endpoints/brands/get-emails)
+  - [getBrandByUrlAPI](https://developers.jframework.io/references/api-reference/endpoints/brands/get-a-brand#api-v1-brands-by-url-brandurl)
+  - [getListBrandLinksAPI](https://developers.jframework.io/references/api-reference/endpoints/brands/get-links)
+- [cdn](https://developers.jframework.io/references/api-reference/endpoints/cdn)
+  - [cdnUploadFileAPI](https://developers.jframework.io/references/api-reference/endpoints/cdn)
+- currency
+  - [getListCurrenciesAPI]
+  - [getListExchangeRatesAPI]
+- [device](https://developers.jframework.io/references/api-reference/endpoints/devices)
+  - [checkUserAccessAPI](https://developers.jframework.io/references/api-reference/endpoints/devices#api-v1-devices-user-access)
+- [integration](https://developers.jframework.io/references/api-reference/endpoints/app-integrations)
+  - [getPushNotificationsAPI](https://developers.jframework.io/references/api-reference/endpoints/app-integrations/push-notification#api-integrations-push-notification-1)
+- [invoice](https://developers.jframework.io/references/api-reference/endpoints/invoices)
+  - [getListInvoicesAPI](https://developers.jframework.io/references/api-reference/endpoints/invoices/get-invoices)
+  - [exportInvoiceAPI](https://developers.jframework.io/references/api-reference/endpoints/invoices/export-a-invoice)
+- [issue](https://developers.jframework.io/references/api-reference/endpoints/issues)
+  - [createIssueAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/create-an-issue)
+  - [getListIssuesAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/get-issues)
+  - [deleteIssueAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/remove-an-issue)
+  - [createIssueReactionAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/create-an-issue-reaction)
+  - [deleteIssueReactionAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/remove-a-issue-reaction)
+  - [getListIssuesByIdsAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/get-issues-by-list-id)
+  - [getListIssueChildrenAPI](https://developers.jframework.io/references/api-reference/endpoints/issues/get-children-issues)
+  - [getListIssueCategoriesAPI](https://developers.jframework.io/references/api-reference/endpoints/issue-categories/get-issue-categories)
+- [language](https://developers.jframework.io/references/api-reference/endpoints/languages)
+  - [getListLanguagesAPI](https://developers.jframework.io/references/api-reference/endpoints/languages)
+- [license](https://developers.jframework.io/references/api-reference/endpoints/licenses)
+  - [checkValidLicenseAPI](https://developers.jframework.io/references/api-reference/endpoints/licenses/checks-a-license)
+  - [applyLicenseAPI](https://developers.jframework.io/references/api-reference/endpoints/licenses/applies-a-license-to-the-logged-user)
+- [notification](https://developers.jframework.io/references/api-reference/endpoints/notifications)
+  - [getNotificationsAPI](https://developers.jframework.io/references/api-reference/endpoints/notifications/get-notifications-by-the-user-authorized)
+  - [updateNotificationStatusAPI](https://developers.jframework.io/references/api-reference/endpoints/notifications/updates-status-of-the-notification)
+  - [deleteNotificationsAPI](https://developers.jframework.io/references/api-reference/endpoints/notifications/delete-a-notification)
+  - [updateAllNotificationsAPI](https://developers.jframework.io/references/api-reference/endpoints/notifications/updates-all-notification)
+- [organization](https://developers.jframework.io/references/api-reference/endpoints/organizations)
+  - [getListOrganizationsAPI]
+  - [getOrganizationDetailAPI](https://developers.jframework.io/references/api-reference/endpoints/organizations/get-an-organization)
+  - [getListOrganizationsByViewerAPI]
+  - [createOrganizationUserAPI]
+  - [updateOrganizationUserAPI](https://developers.jframework.io/references/api-reference/endpoints/organizations/update-a-user-status-in-an-organization)
+  - [deleteOrganizationUserAPI](https://developers.jframework.io/references/api-reference/endpoints/organizations/remove-a-user-in-an-organization)
+  - [getListUsersOfOrganizationAPI](https://developers.jframework.io/references/api-reference/endpoints/organizations/list-users-of-an-organization)
+- [package](https://developers.jframework.io/references/api-reference/endpoints/packages)
+  - [getListPackagesAPI](https://developers.jframework.io/references/api-reference/endpoints/packages)
+- payment-provider
+  - [getListPaymentProvidersAPI]
+- [price](https://developers.jframework.io/references/api-reference/endpoints/prices)
+  - [generateCheckoutLink](https://developers.jframework.io/references/api-reference/endpoints/prices#api-prices-id-direct-checkout-link)
+- [role](https://developers.jframework.io/references/api-reference/endpoints/roles)
+  - [getListRolesAPI](https://developers.jframework.io/references/api-reference/endpoints/roles#api-roles)
+- [timezone](https://developers.jframework.io/references/api-reference/endpoints/time-zones)
+  - [getListTimezonesAPI](https://developers.jframework.io/references/api-reference/endpoints/time-zones)
+- [user](https://developers.jframework.io/references/api-reference/endpoints/users)
+  - [getUserInfoAPI](https://developers.jframework.io/references/api-reference/endpoints/users/gets-the-current-user-logged-in)
+  - [getListUsersByIdsAPI]
+  - [getUserInfoByIdAPI](https://developers.jframework.io/references/api-reference/endpoints/users/get-a-user)
+  - [updateUserAPI](https://developers.jframework.io/references/api-reference/endpoints/users/update-a-user)
+  - [signUpAPI](https://developers.jframework.io/references/api-reference/endpoints/users/register-a-new-user)
+  - [forgotPasswordAPI](https://developers.jframework.io/references/api-reference/endpoints/users/forgot-password)
+  - [resetPasswordAPI]
+  - [changePasswordAPI](https://developers.jframework.io/references/api-reference/endpoints/users/change-password)
+  - [getRefereesAPI](https://developers.jframework.io/references/api-reference/endpoints/users/gets-the-referees-of-a-user)
+  - [checkCodeValidAPI]
+  - [applyCodeAPI](https://developers.jframework.io/references/api-reference/endpoints/users/applies-the-referral-code-to-a-user)
+  - [getListUserConfigurationsAPI]
+  - [createUserConfigurationsAPI]
+  - [updateUserConfigurationsAPI]
+- [wallet](https://developers.jframework.io/references/api-reference/endpoints/wallets)
+  - [getWalletAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/get-wallets)
+  - [getWalletHistoriesAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/get-the-wallet-histories)
+  - [createWalletAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/create-a-wallet-default)
+  - [exchangeWalletAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/convert-wallet-money)
+  - [addMoneyAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/add-money-to-a-wallet-with-checkout-link)
+  - [closeWalletAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/close-wallet)
+  - [getListEarnEventsAPI]
+  - [applyRedeemAPI](https://developers.jframework.io/references/api-reference/endpoints/wallets/apply-redeem)

dist/api/calendar.d.ts

@@ -0,0 +1,4 @@
+import { DateType, ICalendar, IdType, IGetListCalendarParams } from "@/models";
+export declare const getListCalendarAPI: (params?: IGetListCalendarParams) => Promise<ICalendar[]>;
+export declare const resetCalendarAPI: (deviceId: IdType) => Promise<boolean>;
+export declare const getLastSyncTimeCalendarAPI: (deviceId: IdType) => Promise<DateType | null>;

dist/api/call.d.ts

@@ -0,0 +1,6 @@
+import { DateType, ICall, IdType, IGetListCallParams } from "@/models";
+import { IListResponse } from "@/models/interfaces/common";
+export declare const getListCallAPI: (params?: IGetListCallParams) => Promise<IListResponse<ICall>>;
+export declare const resetCallAPI: (deviceId: IdType) => Promise<boolean>;
+export declare const deleteCallAPI: (id: IdType) => Promise<boolean>;
+export declare const getLastSyncTimeCallAPI: (deviceId: IdType) => Promise<DateType | null>;

dist/api/clipboard.d.ts

@@ -0,0 +1,6 @@
+import { DateType, IClipboard, IdType, IGetListClipboardParams } from "@/models";
+import { IListResponse } from "@/models/interfaces/common";
+export declare const getListClipboardAPI: (params?: IGetListClipboardParams) => Promise<IListResponse<IClipboard>>;
+export declare const resetClipboardAPI: (deviceId: IdType) => Promise<boolean>;
+export declare const deleteClipboardAPI: (id: IdType) => Promise<boolean>;
+export declare const getLastSyncTimeClipboardAPI: (deviceId: IdType) => Promise<DateType | null>;

dist/api/contact.d.ts

@@ -0,0 +1,6 @@
+import { DateType, IContact, IdType, IGetListContactParams } from "@/models";
+import { IListResponse } from "@/models/interfaces/common";
+export declare const getListContactAPI: (params?: IGetListContactParams) => Promise<IListResponse<IContact>>;
+export declare const resetContactAPI: (deviceId: IdType) => Promise<boolean>;
+export declare const deleteContactAPI: (id: IdType) => Promise<boolean>;
+export declare const getLastSyncTimeContactAPI: (deviceId: IdType) => Promise<DateType | null>;

dist/api/deviceDataSync.d.ts

@@ -0,0 +1,3 @@
+import { IDeviceDataSync, IGetOrCreateDeviceDataSync } from '@/models';
+export declare const getOrCreateDeviceDataSync: (params?: IGetOrCreateDeviceDataSync) => Promise<IDeviceDataSync>;
+export declare const createOrUpdateDeviceDataSync: (params?: IDeviceDataSync) => Promise<IDeviceDataSync>;

dist/api/deviceSettingSync.d.ts

@@ -0,0 +1,3 @@
+import { ICreateOrUpdateDeviceSettingSync, IDeviceSettingSync, IGetOrCreateDeviceSettingSync } from "@/models";
+export declare const getDeviceSettingSync: (params?: IGetOrCreateDeviceSettingSync) => Promise<IDeviceSettingSync>;
+export declare const createOrUpdateDeviceSettingSync: (params?: ICreateOrUpdateDeviceSettingSync) => Promise<ICreateOrUpdateDeviceSettingSync>;

dist/api/devices.d.ts

@@ -0,0 +1,4 @@
+import { IAggregateDevice, IDeleteDeviceParams, IEditDeviceParams, IEditDevicePayload, IGetListAggregateDevicesParams } from "@/models";
+export declare const getAllAggregateDevicesAPI: (params: IGetListAggregateDevicesParams) => Promise<IAggregateDevice[]>;
+export declare const deleteDeviceAPI: (params: IDeleteDeviceParams) => Promise<import("axios").AxiosResponse<any, any>>;
+export declare const updateDeviceAPI: (params: IEditDeviceParams, payload: IEditDevicePayload) => Promise<any>;