@etsoo/appscript 1.1.3 → 1.1.7

package/.github/workflows/main.yml

@@ -28,7 +28,7 @@ jobs:
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.8'
+          node-version: '14.18'
           registry-url: 'https://registry.npmjs.org'
 
       # Named after Continuous Integration, installs dependencies directly from package-lock.json

package/README.md

@@ -17,8 +17,33 @@ $ yarn add @etsoo/appscript
 
 ## Structure
 
+### address - Address (region) related
+
+#### AddressContinent.ts ####
+-   AddressContinent - Continent Enum
+
+#### AddressRegion.ts ####
+-   IAddressRegion - Country or region interface
+-   AddressRegion - Address or region
+
+#### AddressUtils.ts ####
+-   getContinents - Get all continents
+-   getRegion - Get region from regions and detected region and language
+
 ### app - Application related
 
+#### AppSettings.ts ####
+-   IAppSettings - App settings interface
+
+#### CoreApp.ts ####
+-   IDetectIPCallback - Detect IP callback interface
+-   ICoreApp - Core application interface
+-   CoreApp - Core application
+
+#### ExternalSettings.ts ####
+-   IExternalSettings - External settings items
+-   IExternalSettingsHost - External settings host passed by external script
+
 ### bridges - Works with Electron
 
 #### ElectronBridge.ts ####
@@ -28,35 +53,60 @@ $ yarn add @etsoo/appscript
 -   IAppData - App data interface.
 
 #### IBridge.ts ####
--   IBridgeUnsubscribe - Bridge unsubscribe interface.
--   IBridgeListener - Bridge listener interface.
--   IBridge - Bridge interface.
+-   IBridgeUnsubscribe - Bridge unsubscribe interface
+-   IBridgeListener - Bridge listener interface
+-   IBridge - Bridge interface
+
+### business - Business logics
+
+#### BusinessTax.ts ####
+-   IBusinessTax - Business tax interface
+-   BusinessTax - Business tax
+
+#### BusinessUtils.ts ####
+-   addIdLabelBlankItem - Add blank item to id/label data array
+-   getUnitLabel - Get product unit's label
+-   getUnits - Get all product units
+
+#### ProductUnit.ts ####
+-   ProductUnit - Product units enum
+
+### dto - Data transfer object
+
+#### IdDto.ts ####
+-   IdDto - Dto with id field
+
+#### IdLabelDto.ts ####
+-   IdLabelDto - Dto with id and label field
+
+#### UpdateDto.ts ####
+-   UpdateDto - Dto with id and changedFields
 
 ### result - API action result
 
 #### ActionResult.ts ####
--   ActionResult - API call action result extends IActionResult.
+-   ActionResult - API call action result extends IActionResult
 
 #### ActionResultError.ts ####
 -   ActionResultError - Action result to error type.
 
 #### IActionResult.ts ####
--   IResultData - Result data interface.
--   IdResultData - extends IResultData for 'id' included return data.
--   IResultErrors - Result errors interface.
--   IActionResult - Action result interface.
+-   IResultData - Result data interface
+-   IdResultData - extends IResultData for 'id' included return data
+-   IResultErrors - Result errors interface
+-   IActionResult - Action result interface
 -   ActionResultId - Action result with id data
 
 ### state - State management
 
-#### Language.ts ####
--   LanguageLabels - Language labels, indexable, for simple i18n solution.
--   ILanguage - extends IState for language state.
+#### Culture.ts ####
+-   ICulture - Culture resources state, simple i18n solution
+-   ICultureGet - Culture get delegate
 
 #### State.ts ####
 -   IState - state interface.
--   IAction - state action interface.
+-   IAction - state action interface
 
 #### User.ts ####
 -   IUserData - User basic data.
--   IUser - extends IState for user state.
+-   IUser - extends IState for user state

package/lib/cjs/address/AddressUtils.d.ts

@@ -13,7 +13,7 @@ export declare namespace AddressUtils {
      */
     function getContinents(func: ICultureGet, isNumberKey?: boolean): IdLabelDto[];
     /**
-     * Get region
+     * Get region from regions and detected region and language
      * @param regions Supported regions
      * @param detectedRegion Detected region
      * @param detectedLanguage Detected language

package/lib/cjs/address/AddressUtils.js

@@ -16,19 +16,16 @@ var AddressUtils;
      * @returns Continents
      */
     function getContinents(func, isNumberKey = false) {
-        return shared_1.Utils.getEnumKeys(AddressContinent_1.AddressContinent).map((key) => {
-            var _a;
-            return ({
-                id: isNumberKey
-                    ? AddressContinent_1.AddressContinent[key]
-                    : key,
-                label: (_a = func('continent' + key)) !== null && _a !== void 0 ? _a : key
-            });
-        });
+        return shared_1.DataTypes.getEnumKeys(AddressContinent_1.AddressContinent).map((key) => ({
+            id: isNumberKey
+                ? AddressContinent_1.AddressContinent[key]
+                : key,
+            label: func('continent' + key) ?? key
+        }));
     }
     AddressUtils.getContinents = getContinents;
     /**
-     * Get region
+     * Get region from regions and detected region and language
      * @param regions Supported regions
      * @param detectedRegion Detected region
      * @param detectedLanguage Detected language

package/lib/cjs/app/AppSettings.d.ts

@@ -3,7 +3,7 @@ import { DataTypes } from '@etsoo/shared';
 import { AddressRegion } from '../address/AddressRegion';
 import { IExternalSettings } from './ExternalSettings';
 /**
- * API settings interface
+ * App settings interface
  */
 export interface IAppSettings extends IExternalSettings {
     /**

package/lib/cjs/app/CoreApp.d.ts

@@ -30,7 +30,7 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     /**
      * Label delegate
      */
-    readonly labelDelegate: <T extends DataTypes.SimpleType = string>(key: string) => T | undefined;
+    readonly labelDelegate: <T = string>(key: string) => T | undefined;
     /**
      * Culture, like zh-CN
      */
@@ -43,6 +43,10 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * Country or region, like CN
      */
     readonly region: string;
+    /**
+     * Is current authorized
+     */
+    readonly authorized: boolean;
     /**
      * IP data
      */
@@ -110,7 +114,7 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * @param key key
      * @returns Resource
      */
-    get<T extends DataTypes.SimpleType = string>(key: string): T | undefined;
+    get<T = string>(key: string): T | undefined;
     /**
      * Get multiple culture labels
      * @param keys Keys
@@ -149,6 +153,10 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * @returns Transformed url
      */
     transformUrl(url: string): string;
+    /**
+     * Try login, returning false means is loading
+     */
+    tryLogin(): boolean;
     /**
      * User login
      * @param user User data
@@ -195,7 +203,7 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     /**
      * Label delegate
      */
-    get labelDelegate(): <T extends DataTypes.SimpleType = string>(key: string) => T | undefined;
+    get labelDelegate(): <T = string>(key: string) => T | undefined;
     /**
      * IP data
      */
@@ -213,6 +221,13 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * Search input element
      */
     searchInput?: HTMLInputElement;
+    private _authorized;
+    /**
+     * Is current authorized
+     */
+    get authorized(): boolean;
+    private set authorized(value);
+    private _isTryingLogin;
     /**
      * Protected constructor
      * @param settings Settings
@@ -282,7 +297,7 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * @param key key
      * @returns Resource
      */
-    get<T extends DataTypes.SimpleType = string>(key: string): T | undefined;
+    get<T = string>(key: string): T | undefined;
     /**
      * Get multiple culture labels
      * @param keys Keys
@@ -326,9 +341,9 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      */
     transformUrl(url: string): string;
     /**
-     * Try login
+     * Try login, returning false means is loading
      */
-    abstract tryLogin(): void;
+    tryLogin(): boolean;
     /**
      * User login
      * @param user User data

package/lib/cjs/app/CoreApp.js

@@ -19,6 +19,8 @@ class CoreApp {
          * Response token header field name
          */
         this.headerTokenField = 'SmartERPRefreshToken';
+        this._authorized = false;
+        this._isTryingLogin = false;
         // onRequest, show loading or not, rewrite the property to override default action
         api.onRequest = (data) => {
             if (data.showLoading == null || data.showLoading) {
@@ -79,6 +81,15 @@ class CoreApp {
     get labelDelegate() {
         return this.get.bind(this);
     }
+    /**
+     * Is current authorized
+     */
+    get authorized() {
+        return this._authorized;
+    }
+    set authorized(value) {
+        this._authorized = value;
+    }
     /**
      * Alert action result
      * @param result Action result
@@ -93,10 +104,15 @@ class CoreApp {
      * @param keep Keep in local storage or not
      */
     authorize(token, refreshToken, keep = false) {
+        // State, when token is null, means logout
+        this.authorized = token != null;
+        // Token
         this.api.authorize(this.settings.authScheme, token);
         // Cover the current value
         shared_1.StorageUtils.setLocalData(this.headerTokenField, keep ? refreshToken : undefined);
         shared_1.StorageUtils.setSessionData(this.headerTokenField, keep ? undefined : refreshToken);
+        // Reset tryLogin state
+        this._isTryingLogin = false;
     }
     /**
      * Change country or region
@@ -178,8 +194,7 @@ class CoreApp {
     }
     // Detect IP callbacks
     detectIPCallbacks() {
-        var _a;
-        (_a = this.ipDetectCallbacks) === null || _a === void 0 ? void 0 : _a.forEach((f) => f());
+        this.ipDetectCallbacks?.forEach((f) => f());
     }
     /**
      * Format date to string
@@ -190,7 +205,7 @@ class CoreApp {
      */
     formatDate(input, options, timeZone) {
         const { currentCulture, timeZone: defaultTimeZone } = this.settings;
-        timeZone !== null && timeZone !== void 0 ? timeZone : (timeZone = defaultTimeZone);
+        timeZone ?? (timeZone = defaultTimeZone);
         return shared_1.DateUtils.format(input, currentCulture.name, options, timeZone);
     }
     /**
@@ -229,6 +244,9 @@ class CoreApp {
         const value = this.settings.currentCulture.resources[key];
         if (value == null)
             return undefined;
+        // No strict type convertion here
+        // Make sure the type is strictly match
+        // Otherwise even request number, may still return the source string type
         return value;
     }
     /**
@@ -237,7 +255,7 @@ class CoreApp {
      */
     getLabels(...keys) {
         const init = {};
-        return keys.reduce((a, v) => { var _a; return ({ ...a, [v]: (_a = this.get(v)) !== null && _a !== void 0 ? _a : '' }); }, init);
+        return keys.reduce((a, v) => ({ ...a, [v]: this.get(v) ?? '' }), init);
     }
     /**
      * Get cached token
@@ -278,9 +296,8 @@ class CoreApp {
      * @returns Time zone
      */
     getTimeZone() {
-        var _a, _b;
         // settings.timeZone = Utils.getTimeZone()
-        return (_a = this.settings.timeZone) !== null && _a !== void 0 ? _a : (_b = this.ipData) === null || _b === void 0 ? void 0 : _b.timezone;
+        return this.settings.timeZone ?? this.ipData?.timezone;
     }
     /**
      * Callback where exit a page
@@ -312,6 +329,15 @@ class CoreApp {
         // To /a/b/../ => /a
         return pathname.endsWith('/') ? pathname + url : pathname + '/' + url;
     }
+    /**
+     * Try login, returning false means is loading
+     */
+    tryLogin() {
+        if (this._isTryingLogin)
+            return false;
+        this._isTryingLogin = true;
+        return true;
+    }
     /**
      * User login
      * @param user User data

package/lib/cjs/app/ExternalSettings.d.ts

@@ -1,5 +1,5 @@
 /**
- * External settings
+ * External settings items
  */
 export interface IExternalSettings {
     /**

package/lib/cjs/business/BusinessTax.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Business tax interface
+ */
+export interface IBusinessTax {
+    /**
+     * Id
+     */
+    readonly id: string;
+    /**
+     * Name
+     */
+    readonly name: string;
+    /**
+     * Mask
+     */
+    readonly mask: string;
+    /**
+     * Get label key
+     */
+    readonly labelKey: string;
+}
+/**
+ * Business tax
+ * https://imask.js.org/
+ */
+export declare class BusinessTax implements IBusinessTax {
+    id: string;
+    name: string;
+    mask: string;
+    /**
+     * CN
+     * Unified Social Credit Code (USCC) / 统一信用代码
+     * https://zh.wikisource.org/wiki/GB_32100-2015_%E6%B3%95%E4%BA%BA%E5%92%8C%E5%85%B6%E4%BB%96%E7%BB%84%E7%BB%87%E7%BB%9F%E4%B8%80%E7%A4%BE%E4%BC%9A%E4%BF%A1%E7%94%A8%E4%BB%A3%E7%A0%81%E7%BC%96%E7%A0%81%E8%A7%84%E5%88%99
+     */
+    static CN: BusinessTax;
+    /**
+     * NZ, Inland Revenue (IRD)
+     */
+    static NZ: BusinessTax;
+    /**
+     * US, Employer Identification Number (EIN)
+     */
+    static US: BusinessTax;
+    /**
+     * CA, tax ID number (Business Number, BN)
+     */
+    static CA: BusinessTax;
+    /**
+     * HK, Business Registration Number (BRN)
+     */
+    static HK: BusinessTax;
+    /**
+     * All countries and regions
+     */
+    static all: BusinessTax[];
+    /**
+     * Get country or region by id
+     * @param id Country id
+     */
+    static getById(id: string): BusinessTax | undefined;
+    constructor(id: string, name: string, mask: string);
+    /**
+     * Get label key
+     */
+    get labelKey(): string;
+}

package/lib/cjs/business/BusinessTax.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BusinessTax = void 0;
+/**
+ * Business tax
+ * https://imask.js.org/
+ */
+class BusinessTax {
+    // Typescript constructor shorthand
+    constructor(id, name, mask) {
+        this.id = id;
+        this.name = name;
+        this.mask = mask;
+    }
+    /**
+     * Get country or region by id
+     * @param id Country id
+     */
+    static getById(id) {
+        return BusinessTax.all.find((c) => c.id === id);
+    }
+    /**
+     * Get label key
+     */
+    get labelKey() {
+        return 'tax' + this.id + this.name;
+    }
+}
+exports.BusinessTax = BusinessTax;
+/**
+ * CN
+ * Unified Social Credit Code (USCC) / 统一信用代码
+ * https://zh.wikisource.org/wiki/GB_32100-2015_%E6%B3%95%E4%BA%BA%E5%92%8C%E5%85%B6%E4%BB%96%E7%BB%84%E7%BB%87%E7%BB%9F%E4%B8%80%E7%A4%BE%E4%BC%9A%E4%BF%A1%E7%94%A8%E4%BB%A3%E7%A0%81%E7%BC%96%E7%A0%81%E8%A7%84%E5%88%99
+ */
+BusinessTax.CN = new BusinessTax('CN', 'USCC', '*0-000000-**********');
+/**
+ * NZ, Inland Revenue (IRD)
+ */
+BusinessTax.NZ = new BusinessTax('NZ', 'IRD', '00[0]-000-000');
+/**
+ * US, Employer Identification Number (EIN)
+ */
+BusinessTax.US = new BusinessTax('US', 'EIN', '00-0000000');
+/**
+ * CA, tax ID number (Business Number, BN)
+ */
+BusinessTax.CA = new BusinessTax('CA', 'BN', '000000000');
+/**
+ * HK, Business Registration Number (BRN)
+ */
+BusinessTax.HK = new BusinessTax('HK', 'BRN', '00000000');
+/**
+ * All countries and regions
+ */
+BusinessTax.all = [
+    BusinessTax.CN,
+    BusinessTax.NZ,
+    BusinessTax.US,
+    BusinessTax.CA,
+    BusinessTax.HK
+];

package/lib/cjs/business/BusinessUtils.js

@@ -24,8 +24,7 @@ var BusinessUtils;
     BusinessUtils.addIdLabelBlankItem = addIdLabelBlankItem;
     // Get unit label by key
     function getUnitLabelByKey(func, key) {
-        var _a;
-        return (_a = func('unit' + key)) !== null && _a !== void 0 ? _a : key;
+        return func('unit' + key) ?? key;
     }
     /**
      * Get product unit's label
@@ -45,7 +44,7 @@ var BusinessUtils;
      * @returns Units
      */
     function getUnits(func) {
-        return shared_1.Utils.getEnumKeys(ProductUnit_1.ProductUnit).map((key) => ({
+        return shared_1.DataTypes.getEnumKeys(ProductUnit_1.ProductUnit).map((key) => ({
             id: ProductUnit_1.ProductUnit[key],
             label: getUnitLabelByKey(func, key)
         }));

package/lib/cjs/dto/IdDto.d.ts

@@ -1,5 +1,5 @@
 /**
- * Id Dto
+ * Dto with id field
  */
 export declare type IdDto<T = number> = {
     /**

package/lib/cjs/dto/IdLabelDto.d.ts

@@ -1,6 +1,6 @@
 import { DataTypes } from '@etsoo/shared';
 /**
- * Id & label data
+ * Dto with id and label field
  */
 export declare type IdLabelDto = {
     /**

package/lib/cjs/dto/UpdateDto.d.ts

@@ -1,6 +1,6 @@
 import { IdDto } from './IdDto';
 /**
- * Update Dto
+ * Dto with id and changedFields
  */
 export declare type UpdateDto<T = number> = IdDto<T> & {
     /**

package/lib/cjs/index.d.ts

@@ -7,6 +7,7 @@ export * from './app/ExternalSettings';
 export * from './bridges/ElectronBridge';
 export * from './bridges/IAppData';
 export * from './bridges/IBridge';
+export * from './business/BusinessTax';
 export * from './business/BusinessUtils';
 export * from './business/ProductUnit';
 export * from './dto/IdDto';

package/lib/cjs/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./bridges/ElectronBridge"), exports);
 __exportStar(require("./bridges/IAppData"), exports);
 __exportStar(require("./bridges/IBridge"), exports);
 // business
+__exportStar(require("./business/BusinessTax"), exports);
 __exportStar(require("./business/BusinessUtils"), exports);
 __exportStar(require("./business/ProductUnit"), exports);
 // dto

package/lib/mjs/address/AddressUtils.d.ts

@@ -13,7 +13,7 @@ export declare namespace AddressUtils {
      */
     function getContinents(func: ICultureGet, isNumberKey?: boolean): IdLabelDto[];
     /**
-     * Get region
+     * Get region from regions and detected region and language
      * @param regions Supported regions
      * @param detectedRegion Detected region
      * @param detectedLanguage Detected language

package/lib/mjs/address/AddressUtils.js

@@ -1,4 +1,4 @@
-import { Utils } from '@etsoo/shared';
+import { DataTypes } from '@etsoo/shared';
 import { AddressRegion } from '..';
 import { AddressContinent } from './AddressContinent';
 /**
@@ -13,19 +13,16 @@ export var AddressUtils;
      * @returns Continents
      */
     function getContinents(func, isNumberKey = false) {
-        return Utils.getEnumKeys(AddressContinent).map((key) => {
-            var _a;
-            return ({
-                id: isNumberKey
-                    ? AddressContinent[key]
-                    : key,
-                label: (_a = func('continent' + key)) !== null && _a !== void 0 ? _a : key
-            });
-        });
+        return DataTypes.getEnumKeys(AddressContinent).map((key) => ({
+            id: isNumberKey
+                ? AddressContinent[key]
+                : key,
+            label: func('continent' + key) ?? key
+        }));
     }
     AddressUtils.getContinents = getContinents;
     /**
-     * Get region
+     * Get region from regions and detected region and language
      * @param regions Supported regions
      * @param detectedRegion Detected region
      * @param detectedLanguage Detected language

package/lib/mjs/app/AppSettings.d.ts

@@ -3,7 +3,7 @@ import { DataTypes } from '@etsoo/shared';
 import { AddressRegion } from '../address/AddressRegion';
 import { IExternalSettings } from './ExternalSettings';
 /**
- * API settings interface
+ * App settings interface
  */
 export interface IAppSettings extends IExternalSettings {
     /**