@etsoo/appscript 1.5.63 → 1.5.65

package/.github/workflows/main.yml

@@ -6,7 +6,8 @@
 name: Node.js Package
 
 # Event to trigger the action
-on: [push]
+on:
+  [push]
   # release:
   #  types: [created]
 
@@ -23,13 +24,13 @@ jobs:
       # https://github.com/actions/checkout, This action checks-out your repository under $GITHUB_WORKSPACE
       # so your workflow can access it.
       - uses: actions/checkout@v4
-        
+
       # Set up your GitHub Actions workflow with a specific version of node.js
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
 
       # Named after Continuous Integration, installs dependencies directly from package-lock.json
       # ci vs install
@@ -45,4 +46,4 @@ jobs:
       # For scoped package, make it public for free service
       - run: npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.ETSOONpmToken }}
+          NODE_AUTH_TOKEN: ${{ secrets.ETSOONpmToken }}

package/README.md

@@ -1,4 +1,5 @@
 # AppScript
+
 **TypeScript application scripts shared by different frameworks.**
 
 ## Installing
@@ -16,120 +17,145 @@ $ yarn add @etsoo/appscript
 ```
 
 ## Client data security framework
--   CoreApp, constructor, reads deviceId from session storage
--   restore, when deviceId is empty, try to restore from persisted storage, get the passphrase (encryption / decription) or remove all data keys
--   initCall (everytime the application running), if passphrase is there, just return, otherwise read from serverside
--   device updated will cause validataion failure. Please call initCall(undefined, true);
+
+- CoreApp, constructor, reads deviceId from session storage
+- restore, when deviceId is empty, try to restore from persisted storage, get the passphrase (encryption / decription) or remove all data keys
+- initCall (everytime the application running), if passphrase is there, just return, otherwise read from serverside
+- device updated will cause validataion failure. Please call initCall(undefined, true);
 
 ## Structure
 
 ### address - Address (region) related
 
-#### AddressContinent.ts ####
--   AddressContinent - Continent Enum
+#### AddressContinent.ts
+
+- AddressContinent - Continent Enum
+
+#### AddressRegion.ts
 
-#### AddressRegion.ts ####
--   IAddressRegion - Country or region interface
--   AddressRegion - Address or region
+- IAddressRegion - Country or region interface
+- AddressRegion - Address or region
 
-#### AddressUtils.ts ####
--   getRegion - Get region from regions and detected region and language
+#### AddressUtils.ts
+
+- getRegion - Get region from regions and detected region and language
 
 ### app - Application related
 
-#### AppSettings.ts ####
--   IAppSettings - App settings interface
+#### AppSettings.ts
+
+- IAppSettings - App settings interface
+
+#### CoreApp.ts
 
-#### CoreApp.ts ####
--   IDetectIPCallback - Detect IP callback interface
--   ICoreApp - Core application interface
--   CoreApp - Core application
+- 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
+#### ExternalSettings.ts
 
-#### UserRole.ts ####
--   Standard user roles
+- IExternalSettings - External settings items
+- IExternalSettingsHost - External settings host passed by external script
+
+#### UserRole.ts
+
+- Standard user roles
 
 ### bridges - Works with Electron
 
-#### BridgeUtils.ts ####
--   BridgeUtils - Bridge utils
+#### BridgeUtils.ts
+
+- BridgeUtils - Bridge utils
 
-#### FlutterHost.ts ####
--   FlutterHost - Flutter JavaScript Host
+#### FlutterHost.ts
 
-#### IBridgeHost.ts ####
--   IBridgeHost - Bridge host interface
+- FlutterHost - Flutter JavaScript Host
+
+#### IBridgeHost.ts
+
+- IBridgeHost - Bridge host interface
 
 ### business - Business logics
 
-#### BusinessTax.ts ####
--   IBusinessTax - Business tax interface
--   BusinessTax - Business tax
+#### BusinessTax.ts
+
+- IBusinessTax - Business tax interface
+- BusinessTax - Business tax
 
-#### BusinessUtils.ts ####
--   getCurrencies - Get currency collection
--   getEntityStatusLabel - Get entity status's label
--   getEntityStatus - Get entity status collection
--   getUnitLabel - Get product unit's label
--   getUnits - Get all product units
--   getRepeatOptions -  Get all repeat options
+#### BusinessUtils.ts
 
-#### EntityStatus.ts ####
--   EntityStatus - Standard entity status enum
+- getCurrencies - Get currency collection
+- getEntityStatusLabel - Get entity status's label
+- getEntityStatus - Get entity status collection
+- getUnitLabel - Get product unit's label
+- getUnits - Get all product units
+- getRepeatOptions - Get all repeat options
 
-#### ProductUnit.ts ####
--   ProductUnit - Product units enum
+#### EntityStatus.ts
 
-#### RepeatOption.ts ####
--   RepeatOption - Repeat options
+- EntityStatus - Standard entity status enum
+
+#### ProductUnit.ts
+
+- ProductUnit - Product units enum
+
+#### RepeatOption.ts
+
+- RepeatOption - Repeat options
 
 ### custom - Custom dynamic component rendering
 
-#### CustomFieldData.ts ####
--   CustomFieldSpace - Custom field space (12 columns)
--   CustomFieldData - Custom field data
+#### CustomFieldData.ts
+
+- CustomFieldSpace - Custom field space (12 columns)
+- CustomFieldData - Custom field data
 
 ### def - Type definition
 
-#### ListItem.ts ####
--   ListItem - List item definition
+#### ListItem.ts
+
+- ListItem - List item definition
 
 ### i18n - Multiple cultures
 
 ### result - API action result
 
-#### ActionResult.ts ####
--   ActionResult - API call action result extends IActionResult
+#### ActionResult.ts
+
+- ActionResult - API call action result extends IActionResult
 
-#### ActionResultError.ts ####
--   ActionResultError - Action result to error type
+#### ActionResultError.ts
 
-#### IActionResult.ts ####
--   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
+- ActionResultError - Action result to error type
 
-#### InitCallResultData.ts ####
--   InitCallResultData - Init call result data
--   InitCallResult - Init call result
+#### IActionResult.ts
+
+- 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
+
+#### InitCallResultData.ts
+
+- InitCallResultData - Init call result data
+- InitCallResult - Init call result
 
 ### erp - SmartERP APIs
 
 ### state - State management
 
-#### Culture.ts ####
--   ICulture - Culture resources state, simple i18n solution
--   ICultureGet - Culture get delegate
+#### Culture.ts
+
+- ICulture - Culture resources state, simple i18n solution
+- ICultureGet - Culture get delegate
+
+#### State.ts
+
+- IState - state interface.
+- IAction - state action interface
 
-#### State.ts ####
--   IState - state interface.
--   IAction - state action interface
+#### User.ts
 
-#### User.ts ####
--   IUserData - User basic data.
--   IUser - extends IState for user state
+- IUserData - User basic data.
+- IUser - extends IState for user state

package/__tests__/app/CoreApp.ts

@@ -1,188 +1,186 @@
-import { ApiDataError, ApiMethod } from '@etsoo/restclient';
-import { DataTypes, IActionResult } from '@etsoo/shared';
-import { EntityStatus, UserRole } from '../../src';
-import { TestApp } from './TestApp';
+import { ApiDataError, ApiMethod } from "@etsoo/restclient";
+import { DataTypes, IActionResult } from "@etsoo/shared";
+import { EntityStatus, UserRole } from "../../src";
+import { TestApp } from "./TestApp";
 
 // Arrange
 // Mixins example
 function EnhanceApp<TBase extends DataTypes.MConstructor<TestApp>>(
-    Base: TBase
+  Base: TBase
 ) {
-    return class extends Base {};
+  return class extends Base {};
 }
 
 const appClass = EnhanceApp(TestApp);
 const app = new appClass();
 app.changeCulture(app.settings.cultures[0]);
 
-test('Test for domain replacement', () => {
-    expect(app.settings.endpoint).toBe('http://localhost:9000/api/');
+test("Test for domain replacement", () => {
+  expect(app.settings.endpoint).toBe("http://localhost:9000/api/");
 
-    expect(app.settings.endpoints?.core.endpoint).toBe(
-        'https://localhost:9001/api/'
-    );
+  expect(app.settings.endpoints?.core.endpoint).toBe(
+    "https://localhost:9001/api/"
+  );
 });
 
-test('Test for properties', () => {
-    expect(app.settings.currentRegion.label).toBe('中国大陆');
+test("Test for properties", () => {
+  expect(app.settings.currentRegion.label).toBe("中国大陆");
 });
 
-test('Test for formatAction', () => {
-    Object.assign(app.settings.currentCulture.resources, {
-        appName: '司友®云ERP'
-    });
-    expect(app.formatAction('修改', '客户A')).toBe('[司友®云ERP] 修改 - 客户A');
-    expect(app.formatAction('修改', '客户A', '企业')).toBe(
-        '[司友®云ERP] 修改 - 客户A, 企业'
-    );
+test("Test for formatAction", () => {
+  Object.assign(app.settings.currentCulture.resources, {
+    appName: "司友®云ERP"
+  });
+  expect(app.formatAction("修改", "客户A")).toBe("[司友®云ERP] 修改 - 客户A");
+  expect(app.formatAction("修改", "客户A", "企业")).toBe(
+    "[司友®云ERP] 修改 - 客户A, 企业"
+  );
 });
 
-test('Tests for addRootUrl', () => {
-    expect(app.addRootUrl('/home')).toBe('/cms/home');
-    expect(app.addRootUrl('./home')).toBe('/cms/./home');
-    expect(app.addRootUrl('home')).toBe('/cms/home');
+test("Tests for addRootUrl", () => {
+  expect(app.addRootUrl("/home")).toBe("/cms/home");
+  expect(app.addRootUrl("./home")).toBe("/cms/./home");
+  expect(app.addRootUrl("home")).toBe("/cms/home");
 });
 
-test('Tests for encrypt / decrypt', async () => {
-    // Arrange
-    const input = 'Hello, world!';
-    const passphrase = 'My password';
+test("Tests for encrypt / decrypt", async () => {
+  // Arrange
+  const input = "Hello, world!";
+  const passphrase = "My password";
 
-    // Act
-    const encrypted = app.encrypt(input, passphrase);
-    const plain = app.decrypt(encrypted, passphrase);
-    expect(plain).toEqual(input);
+  // Act
+  const encrypted = app.encrypt(input, passphrase);
+  const plain = app.decrypt(encrypted, passphrase);
+  expect(plain).toEqual(input);
 });
 
-test('Tests for encryptEnhanced / decryptEnhanced', async () => {
-    // Arrange
-    const input = 'Hello, world!';
-    const passphrase = 'My password';
+test("Tests for encryptEnhanced / decryptEnhanced", async () => {
+  // Arrange
+  const input = "Hello, world!";
+  const passphrase = "My password";
 
-    // Act
-    const encrypted = app.encryptEnhanced(input, passphrase);
-    const plain = app.decryptEnhanced(encrypted, passphrase);
-    expect(plain).toEqual(input);
+  // Act
+  const encrypted = app.encryptEnhanced(input, passphrase);
+  const plain = app.decryptEnhanced(encrypted, passphrase);
+  expect(plain).toEqual(input);
 });
 
-test('Tests for initCallUpdateLocal', () => {
-    // Act
-    const passphrase = app.initCallUpdateLocal(
-        {
-            deviceId:
-                'ZmNjZlov+10067A1520126643352C2022735B85DC8F380088468402C98A5631A8CFBE14E134zXfxmw77lFopTTlbqOfsK2KUqPSsTAQb35Ejrm1BAvUaQH3SuZcwGYu3+PQ/Rd56',
-            passphrase:
-                '01397BF28A93FC031BC8B9B808F880F12C398AB792DF2ADE7A8768CADD2259EB50HJuKhqGuLQO+SmvCVzuEGUN4TdkUuPMWR0E6lliszbNiXboCziXx5SdfX3lMpoBX'
-        },
-        1639282438620
-    );
-    expect(passphrase).not.toBeNull();
+test("Tests for initCallUpdateLocal", () => {
+  // Act
+  const passphrase = app.initCallUpdateLocal(
+    {
+      deviceId:
+        "ZmNjZlov+10067A1520126643352C2022735B85DC8F380088468402C98A5631A8CFBE14E134zXfxmw77lFopTTlbqOfsK2KUqPSsTAQb35Ejrm1BAvUaQH3SuZcwGYu3+PQ/Rd56",
+      passphrase:
+        "01397BF28A93FC031BC8B9B808F880F12C398AB792DF2ADE7A8768CADD2259EB50HJuKhqGuLQO+SmvCVzuEGUN4TdkUuPMWR0E6lliszbNiXboCziXx5SdfX3lMpoBX"
+    },
+    1639282438620
+  );
+  expect(passphrase).not.toBeNull();
 });
 
-test('Tests for formatFullName', () => {
-    expect(app.formatFullName('亿速', null)).toBe('亿速');
-    expect(app.formatFullName(null, null)).toBe('');
-    expect(app.formatFullName('亿速', '思维')).toBe('亿速思维');
-    expect(app.formatFullName('Xiao', 'Garry')).toBe('Garry Xiao');
+test("Tests for formatFullName", () => {
+  expect(app.formatFullName("亿速", null)).toBe("亿速");
+  expect(app.formatFullName(null, null)).toBe("");
+  expect(app.formatFullName("亿速", "思维")).toBe("亿速思维");
+  expect(app.formatFullName("Xiao", "Garry")).toBe("Garry Xiao");
 });
 
-test('Tests for getRoles', () => {
-    const roles = app.getRoles(
-        UserRole.User | UserRole.Manager | UserRole.Admin
-    );
-    expect(roles.length).toBe(3);
-    expect(roles.map((r) => r.id)).toEqual([8, 128, 8192]);
+test("Tests for getRoles", () => {
+  const roles = app.getRoles(UserRole.User | UserRole.Manager | UserRole.Admin);
+  expect(roles.length).toBe(3);
+  expect(roles.map((r) => r.id)).toEqual([8, 128, 8192]);
 });
 
-test('Tests for getStatusList', () => {
-    const statuses = app.getStatusList([
-        EntityStatus.Normal,
-        EntityStatus.Approved,
-        EntityStatus.Doing,
-        EntityStatus.Completed,
-        EntityStatus.Deleted
-    ]);
-    expect(statuses.length).toBe(5);
-    expect(statuses.map((s) => s.id)).toStrictEqual([0, 100, 110, 250, 255]);
-
-    expect(app.getStatusList().length).toBe(9);
+test("Tests for getStatusList", () => {
+  const statuses = app.getStatusList([
+    EntityStatus.Normal,
+    EntityStatus.Approved,
+    EntityStatus.Doing,
+    EntityStatus.Completed,
+    EntityStatus.Deleted
+  ]);
+  expect(statuses.length).toBe(5);
+  expect(statuses.map((s) => s.id)).toStrictEqual([0, 100, 110, 250, 255]);
+
+  expect(app.getStatusList().length).toBe(9);
 });
 
-test('Tests for formatResult', () => {
-    const result: IActionResult = {
-        ok: false,
-        type: 'https://tools.ietf.org/html/rfc9110#section-15.5.1',
-        title: 'One or more validation errors occurred.',
-        status: 400,
-        errors: {
-            $: [
-                'JSON deserialization for type \u0027com.etsoo.CMS.RQ.User.UserCreateRQ\u0027 was missing required properties, including the following: password'
-            ],
-            rq: ['The rq field is required.']
-        },
-        traceId: '00-ed96a4f0c83f066594ecc69b77da9803-df770e3cd714fedd-00'
-    };
-
-    const formatted = app.formatResult(result);
-    expect(formatted).toBe(
-        'One or more validation errors occurred. (400, https://tools.ietf.org/html/rfc9110#section-15.5.1)'
-    );
+test("Tests for formatResult", () => {
+  const result: IActionResult = {
+    ok: false,
+    type: "https://tools.ietf.org/html/rfc9110#section-15.5.1",
+    title: "One or more validation errors occurred.",
+    status: 400,
+    errors: {
+      $: [
+        "JSON deserialization for type \u0027com.etsoo.CMS.RQ.User.UserCreateRQ\u0027 was missing required properties, including the following: password"
+      ],
+      rq: ["The rq field is required."]
+    },
+    traceId: "00-ed96a4f0c83f066594ecc69b77da9803-df770e3cd714fedd-00"
+  };
+
+  const formatted = app.formatResult(result);
+  expect(formatted).toBe(
+    "One or more validation errors occurred. (400, https://tools.ietf.org/html/rfc9110#section-15.5.1)"
+  );
 });
 
-test('Tests for formatResult with custom label', () => {
-    const result: IActionResult = {
-        ok: false,
-        type: 'ItemRequired',
-        title: '{0} is required.',
-        field: 'url'
-    };
+test("Tests for formatResult with custom label", () => {
+  const result: IActionResult = {
+    ok: false,
+    type: "ItemRequired",
+    title: "{0} is required.",
+    field: "url"
+  };
 
-    const formatted = app.formatResult(result, () => 'Url');
-    expect(formatted).toBe('Url is required. (ItemRequired, url)');
+  const formatted = app.formatResult(result, () => "Url");
+  expect(formatted).toBe("Url is required. (ItemRequired, url)");
 });
 
-test('Tests for formatResult with custom label', () => {
-    const result: IActionResult = {
-        ok: false,
-        type: 'ItemExists',
-        field: 'url'
-    };
+test("Tests for formatResult with custom label", () => {
+  const result: IActionResult = {
+    ok: false,
+    type: "ItemExists",
+    field: "url"
+  };
 
-    const fieldLabel = '文章地址';
-    const formatted = app.formatResult(result, () => fieldLabel);
-    expect(formatted).toBe(`'${fieldLabel}'已经存在 (ItemExists, url)`);
+  const fieldLabel = "文章地址";
+  const formatted = app.formatResult(result, () => fieldLabel);
+  expect(formatted).toBe(`'${fieldLabel}'已经存在 (ItemExists, url)`);
 });
 
-test('Tests for formatError', () => {
-    const error: ApiDataError = {
-        name: 'ApiDataError',
-        message: 'Api data error',
-        response: {
-            type: 'https://tools.ietf.org/html/rfc9110#section-15.5.1',
-            title: 'One or more validation errors occurred.',
-            status: 400,
-            errors: {
-                $: [
-                    'JSON deserialization for type \u0027com.etsoo.CMS.RQ.User.UserCreateRQ\u0027 was missing required properties, including the following: password'
-                ],
-                rq: ['The rq field is required.']
-            },
-            traceId: '00-ed96a4f0c83f066594ecc69b77da9803-df770e3cd714fedd-00'
-        },
-        data: {
-            data: undefined,
-            headers: [],
-            method: ApiMethod.POST,
-            params: {},
-            url: ''
-        }
-    };
-
-    expect(app.formatError(error)).toBe('Api data error (ApiDataError)');
+test("Tests for formatError", () => {
+  const error: ApiDataError = {
+    name: "ApiDataError",
+    message: "Api data error",
+    response: {
+      type: "https://tools.ietf.org/html/rfc9110#section-15.5.1",
+      title: "One or more validation errors occurred.",
+      status: 400,
+      errors: {
+        $: [
+          "JSON deserialization for type \u0027com.etsoo.CMS.RQ.User.UserCreateRQ\u0027 was missing required properties, including the following: password"
+        ],
+        rq: ["The rq field is required."]
+      },
+      traceId: "00-ed96a4f0c83f066594ecc69b77da9803-df770e3cd714fedd-00"
+    },
+    data: {
+      data: undefined,
+      headers: [],
+      method: ApiMethod.POST,
+      params: {},
+      url: ""
+    }
+  };
+
+  expect(app.formatError(error)).toBe("Api data error (ApiDataError)");
 });
 
-test('Tests for isValidPassword', () => {
-    expect(app.isValidPassword('12345678')).toBeFalsy();
-    expect(app.isValidPassword('abcd3')).toBeFalsy();
-    expect(app.isValidPassword('1234abcd')).toBeTruthy();
+test("Tests for isValidPassword", () => {
+  expect(app.isValidPassword("12345678")).toBeFalsy();
+  expect(app.isValidPassword("abcd3")).toBeFalsy();
+  expect(app.isValidPassword("1234abcd")).toBeTruthy();
 });

package/__tests__/app/Culture.ts

@@ -1,33 +1,33 @@
-import { en, zhHans } from '../../src';
+import { Culture } from "../../src";
 
-test('Tests for en', async () => {
-    const e = en(
-        { nameB: 'Name for Business' },
-        new Promise((resolve) => resolve({ no: 'No override' }))
-    );
+test("Tests for en", async () => {
+  const e = Culture.en(
+    { nameB: "Name for Business" },
+    new Promise((resolve) => resolve({ no: "No override" }))
+  );
 
-    expect(e.name).toBe('en');
+  expect(e.name).toBe("en");
 
-    const resources =
-        typeof e.resources === 'object' ? e.resources : await e.resources();
+  const resources =
+    typeof e.resources === "object" ? e.resources : await e.resources();
 
-    expect(resources.name).toBe('Name');
-    expect(resources.nameB).toBe('Name for Business');
-    expect(resources.no).toBe('No override');
+  expect(resources.name).toBe("Name");
+  expect(resources.nameB).toBe("Name for Business");
+  expect(resources.no).toBe("No override");
 });
 
-test('Tests for zhHans', async () => {
-    const zh = zhHans(
-        { nameB: '名称覆盖' },
-        new Promise((resolve) => resolve({ no: 'No override' }))
-    );
+test("Tests for zhHans", async () => {
+  const zh = Culture.zhHans(
+    { nameB: "名称覆盖" },
+    new Promise((resolve) => resolve({ no: "No override" }))
+  );
 
-    expect(zh.name).toBe('zh-Hans');
+  expect(zh.name).toBe("zh-Hans");
 
-    const resources =
-        typeof zh.resources === 'object' ? zh.resources : await zh.resources();
+  const resources =
+    typeof zh.resources === "object" ? zh.resources : await zh.resources();
 
-    expect(resources.name).toBe('姓名');
-    expect(resources.nameB).toBe('名称覆盖');
-    expect(resources.no).toBe('No override');
+  expect(resources.name).toBe("姓名");
+  expect(resources.nameB).toBe("名称覆盖");
+  expect(resources.no).toBe("No override");
 });