@etsoo/appscript 1.5.98 → 1.6.0

package/README.md

@@ -55,7 +55,6 @@ $ yarn add @etsoo/appscript
 #### ExternalSettings.ts
 
 - IExternalSettings - External settings items
-- IExternalSettingsHost - External settings host passed by external script
 
 #### UserRole.ts
 

package/__tests__/app/CoreApp.ts

@@ -1,6 +1,11 @@
 import { ApiDataError, ApiMethod } from "@etsoo/restclient";
 import { DataTypes, IActionResult } from "@etsoo/shared";
-import { EntityStatus, UserRole } from "../../src";
+import {
+  EntityStatus,
+  ExternalEndpoint,
+  ExternalSettings,
+  UserRole
+} from "../../src";
 import { TestApp } from "./TestApp";
 
 // Arrange
@@ -16,7 +21,7 @@ const app = new appClass();
 
 await app.changeCulture(app.settings.cultures[0]);
 
-test("Test for domain replacement", () => {
+test("Test for domain substitution", () => {
   expect(app.settings.endpoint).toBe("http://localhost:9000/api/");
 
   expect(app.settings.endpoints?.core.endpoint).toBe(
@@ -24,6 +29,52 @@ test("Test for domain replacement", () => {
   );
 });
 
+test("Test for formatApp", () => {
+  expect(
+    ExternalSettings.formatApp(
+      "admin.app.local",
+      "core",
+      "https://{hostname}/api/"
+    )
+  ).toBe("https://core.app.local/api/");
+
+  expect(
+    ExternalSettings.formatApp("localhost", "admin", "https://{hostname}/api/")
+  ).toBe("https://localhost/api/");
+
+  // Custom sub domain match
+  ExternalSettings.subDomainMatch = /app(?=\.)/i;
+
+  expect(
+    ExternalSettings.formatApp(
+      "admin.app.local",
+      "core",
+      "https://{hostname}/api/"
+    )
+  ).toBe("https://admin.core.local/api/");
+});
+
+test("Test for formatHost with endpoints", () => {
+  // Reset sub domain match
+  ExternalSettings.subDomainMatch = /(?<=\/\/)[0-9a-z]+(?=\.)/i;
+
+  const endpoints: Record<string, ExternalEndpoint> = {
+    core: {
+      endpoint: "https://{hostname}/api/",
+      webUrl: "https://{hostname}/"
+    }
+  };
+
+  const result = ExternalSettings.formatHost(endpoints, "admin.app.local");
+
+  expect(result).toStrictEqual({
+    core: {
+      endpoint: "https://core.app.local/api/",
+      webUrl: "https://core.app.local/"
+    }
+  });
+});
+
 test("Test for properties", () => {
   expect(app.settings.currentRegion.label).toBe("中国大陆");
 });

package/__tests__/app/TestApp.ts

@@ -16,7 +16,7 @@ import {
   InitCallResultData,
   IUser
 } from "../../src";
-import { DataTypes, DomUtils, Utils, WindowStorage } from "@etsoo/shared";
+import { DataTypes, DomUtils, WindowStorage } from "@etsoo/shared";
 
 // Detected country or region
 const { detectedCountry } = DomUtils;
@@ -72,7 +72,9 @@ export class TestApp extends CoreApp<
    */
   constructor() {
     super(
-      ExternalSettings.format({
+      {
+        appId: 0,
+
         /**
          * Endpoint of the API service
          */
@@ -115,8 +117,8 @@ export class TestApp extends CoreApp<
         currentCulture: DomUtils.getCulture(
           supportedCultures,
           detectedCulture
-        )![0]
-      }),
+        )[0]
+      },
       createClient(),
       container,
       new WindowStorage(),
@@ -124,6 +126,19 @@ export class TestApp extends CoreApp<
     );
   }
 
+  // Example of local format settings
+  protected override formatSettings(settings: IAppSettings): IAppSettings {
+    const { endpoint, endpoints, ...rest } = settings;
+    return {
+      ...rest,
+      endpoint: ExternalSettings.formatHost(endpoint, "localhost"),
+      endpoints:
+        endpoints == null
+          ? undefined
+          : ExternalSettings.formatHost(endpoints, "localhost")
+    };
+  }
+
   freshCountdownUI(callback?: () => PromiseLike<unknown>): void {
     throw new Error("Method not implemented.");
   }

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

@@ -176,6 +176,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @param debug Debug mode
      */
     protected constructor(settings: S, api: IApi | undefined | null, notifier: INotifier<N, C>, storage: IStorage, name: string, debug?: boolean);
+    /**
+     * Format settings
+     * @param settings Original settings
+     * @returns Result
+     */
+    protected formatSettings(settings: S): S;
     private getDeviceId;
     private resetKeys;
     /**

package/lib/cjs/app/CoreApp.js

@@ -11,6 +11,7 @@ const EntityStatus_1 = require("../business/EntityStatus");
 const ActionResultError_1 = require("../result/ActionResultError");
 const IApp_1 = require("./IApp");
 const UserRole_1 = require("./UserRole");
+const ExternalSettings_1 = require("./ExternalSettings");
 const AuthApi_1 = require("../api/AuthApi");
 let CJ;
 const loadCrypto = () => import("crypto-js");
@@ -164,11 +165,10 @@ class CoreApp {
         this.passphrase = "";
         this.apis = {};
         this.tasks = [];
-        if (settings?.regions?.length === 0) {
-            throw new Error("No regions defined");
-        }
-        this.settings = settings;
-        const region = AddressRegion_1.AddressRegion.getById(settings.regions[0]);
+        // Format settings
+        this.settings = this.formatSettings(settings);
+        // Current region
+        const region = AddressRegion_1.AddressRegion.getById(this.settings.regions[0]);
         if (region == null) {
             throw new Error("No default region defined");
         }
@@ -232,6 +232,23 @@ class CoreApp {
             this.setup();
         });
     }
+    /**
+     * Format settings
+     * @param settings Original settings
+     * @returns Result
+     */
+    formatSettings(settings) {
+        const { endpoint, webUrl, endpoints, hostname = globalThis.location.hostname, ...rest } = settings;
+        return {
+            ...rest,
+            hostname,
+            endpoint: ExternalSettings_1.ExternalSettings.formatHost(endpoint, hostname),
+            webUrl: ExternalSettings_1.ExternalSettings.formatHost(webUrl, hostname),
+            endpoints: endpoints == null
+                ? undefined
+                : ExternalSettings_1.ExternalSettings.formatHost(endpoints, hostname)
+        };
+    }
     getDeviceId() {
         return this.deviceId.substring(0, 15);
     }

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

@@ -28,18 +28,44 @@ export interface IExternalSettings extends ExternalEndpoint {
      * 程序编号
      */
     readonly appId: number;
+    /**
+     * Default hostname for substitution
+     * 用于替换的默认主机名
+     */
+    hostname?: string;
     /**
      * Endpoints to other services
      */
-    readonly endpoints?: Record<"core" | "accounting" | "crm" | "calandar" | "task" | string, ExternalEndpoint>;
+    readonly endpoints?: Record<"core" | "admin" | "finance" | "crm" | "oa" | "agile" | string, ExternalEndpoint>;
 }
 /**
  * External settings namespace
  */
 export declare namespace ExternalSettings {
     /**
-     * Create instance
+     * Sub domain match regular expression
+     */
+    let subDomainMatch: RegExp;
+    /**
+     * Create settings instance
+     * @param settings Settings
+     * @returns Result
+     */
+    function create<T extends IExternalSettings = IExternalSettings>(settings?: unknown, hostname?: string): T;
+    /**
+     * Format the app
+     * @param hostname Hostname
+     * @param app App key
+     * @param endpoint Endpoint
+     * @returns Result
+     */
+    function formatApp(hostname: string, app: string, endpoint: string): string;
+    /**
+     * Format the host
+     * @param setting Setting
+     * @param hostname Hostname
+     * @returns Result
      */
-    function create<T extends IExternalSettings = IExternalSettings>(): T | undefined;
-    function format(settings: any, hostname?: string): any;
+    function formatHost(setting: string, hostname: string): string;
+    function formatHost(setting: Record<string, ExternalEndpoint>, hostname?: string | null): Record<string, ExternalEndpoint>;
 }

package/lib/cjs/app/ExternalSettings.js

@@ -7,39 +7,60 @@ exports.ExternalSettings = void 0;
 var ExternalSettings;
 (function (ExternalSettings) {
     /**
-     * Create instance
+     * Sub domain match regular expression
      */
-    function create() {
-        if ("settings" in globalThis) {
-            const settings = Reflect.get(globalThis, "settings");
-            if (typeof settings === "object") {
-                if (typeof window !== "undefined") {
-                    // Host name
-                    const hostname = globalThis.location.hostname;
-                    // replace {hostname}
-                    format(settings, hostname);
-                }
-                return settings;
+    ExternalSettings.subDomainMatch = /(?<=\/\/)[0-9a-z]+(?=\.)/i;
+    /**
+     * Create settings instance
+     * @param settings Settings
+     * @returns Result
+     */
+    function create(settings, hostname) {
+        // Default settings reading from globalThis
+        settings ?? (settings = Reflect.get(globalThis, "settings"));
+        if (settings) {
+            if (typeof settings === "string") {
+                settings = JSON.parse(settings);
+            }
+            if (settings != null &&
+                typeof settings === "object" &&
+                "appId" in settings &&
+                "endpoint" in settings) {
+                const s = settings;
+                if (hostname)
+                    s.hostname = hostname;
+                return s;
             }
         }
-        return undefined;
+        throw new Error("No external settings found");
     }
     ExternalSettings.create = create;
-    function format(settings, hostname) {
+    /**
+     * Format the app
+     * @param hostname Hostname
+     * @param app App key
+     * @param endpoint Endpoint
+     * @returns Result
+     */
+    function formatApp(hostname, app, endpoint) {
+        return formatHost(endpoint, hostname).replace(ExternalSettings.subDomainMatch, app);
+    }
+    ExternalSettings.formatApp = formatApp;
+    function formatHost(setting, hostname) {
         // Default hostname
-        if (!hostname)
-            hostname = "localhost";
-        // replace {hostname}
-        for (const key in settings) {
-            const value = settings[key];
-            if (typeof value === "string") {
-                settings[key] = value.replace("{hostname}", hostname);
-            }
-            else if (typeof value === "object") {
-                format(value, hostname);
-            }
+        hostname ?? (hostname = globalThis.location.hostname);
+        if (typeof setting === "string") {
+            return setting.replace("{hostname}", hostname);
+        }
+        else {
+            return Object.fromEntries(Object.entries(setting).map(([key, value]) => [
+                key,
+                {
+                    endpoint: formatApp(hostname, key, value.endpoint),
+                    webUrl: formatApp(hostname, key, value.webUrl)
+                }
+            ]));
         }
-        return settings;
     }
-    ExternalSettings.format = format;
+    ExternalSettings.formatHost = formatHost;
 })(ExternalSettings || (exports.ExternalSettings = ExternalSettings = {}));

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

@@ -176,6 +176,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @param debug Debug mode
      */
     protected constructor(settings: S, api: IApi | undefined | null, notifier: INotifier<N, C>, storage: IStorage, name: string, debug?: boolean);
+    /**
+     * Format settings
+     * @param settings Original settings
+     * @returns Result
+     */
+    protected formatSettings(settings: S): S;
     private getDeviceId;
     private resetKeys;
     /**

package/lib/mjs/app/CoreApp.js

@@ -8,6 +8,7 @@ import { EntityStatus } from "../business/EntityStatus";
 import { ActionResultError } from "../result/ActionResultError";
 import { appFields } from "./IApp";
 import { UserRole } from "./UserRole";
+import { ExternalSettings } from "./ExternalSettings";
 import { AuthApi } from "../api/AuthApi";
 let CJ;
 const loadCrypto = () => import("crypto-js");
@@ -161,11 +162,10 @@ export class CoreApp {
         this.passphrase = "";
         this.apis = {};
         this.tasks = [];
-        if (settings?.regions?.length === 0) {
-            throw new Error("No regions defined");
-        }
-        this.settings = settings;
-        const region = AddressRegion.getById(settings.regions[0]);
+        // Format settings
+        this.settings = this.formatSettings(settings);
+        // Current region
+        const region = AddressRegion.getById(this.settings.regions[0]);
         if (region == null) {
             throw new Error("No default region defined");
         }
@@ -229,6 +229,23 @@ export class CoreApp {
             this.setup();
         });
     }
+    /**
+     * Format settings
+     * @param settings Original settings
+     * @returns Result
+     */
+    formatSettings(settings) {
+        const { endpoint, webUrl, endpoints, hostname = globalThis.location.hostname, ...rest } = settings;
+        return {
+            ...rest,
+            hostname,
+            endpoint: ExternalSettings.formatHost(endpoint, hostname),
+            webUrl: ExternalSettings.formatHost(webUrl, hostname),
+            endpoints: endpoints == null
+                ? undefined
+                : ExternalSettings.formatHost(endpoints, hostname)
+        };
+    }
     getDeviceId() {
         return this.deviceId.substring(0, 15);
     }

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

@@ -28,18 +28,44 @@ export interface IExternalSettings extends ExternalEndpoint {
      * 程序编号
      */
     readonly appId: number;
+    /**
+     * Default hostname for substitution
+     * 用于替换的默认主机名
+     */
+    hostname?: string;
     /**
      * Endpoints to other services
      */
-    readonly endpoints?: Record<"core" | "accounting" | "crm" | "calandar" | "task" | string, ExternalEndpoint>;
+    readonly endpoints?: Record<"core" | "admin" | "finance" | "crm" | "oa" | "agile" | string, ExternalEndpoint>;
 }
 /**
  * External settings namespace
  */
 export declare namespace ExternalSettings {
     /**
-     * Create instance
+     * Sub domain match regular expression
+     */
+    let subDomainMatch: RegExp;
+    /**
+     * Create settings instance
+     * @param settings Settings
+     * @returns Result
+     */
+    function create<T extends IExternalSettings = IExternalSettings>(settings?: unknown, hostname?: string): T;
+    /**
+     * Format the app
+     * @param hostname Hostname
+     * @param app App key
+     * @param endpoint Endpoint
+     * @returns Result
+     */
+    function formatApp(hostname: string, app: string, endpoint: string): string;
+    /**
+     * Format the host
+     * @param setting Setting
+     * @param hostname Hostname
+     * @returns Result
      */
-    function create<T extends IExternalSettings = IExternalSettings>(): T | undefined;
-    function format(settings: any, hostname?: string): any;
+    function formatHost(setting: string, hostname: string): string;
+    function formatHost(setting: Record<string, ExternalEndpoint>, hostname?: string | null): Record<string, ExternalEndpoint>;
 }

package/lib/mjs/app/ExternalSettings.js

@@ -4,39 +4,60 @@
 export var ExternalSettings;
 (function (ExternalSettings) {
     /**
-     * Create instance
+     * Sub domain match regular expression
      */
-    function create() {
-        if ("settings" in globalThis) {
-            const settings = Reflect.get(globalThis, "settings");
-            if (typeof settings === "object") {
-                if (typeof window !== "undefined") {
-                    // Host name
-                    const hostname = globalThis.location.hostname;
-                    // replace {hostname}
-                    format(settings, hostname);
-                }
-                return settings;
+    ExternalSettings.subDomainMatch = /(?<=\/\/)[0-9a-z]+(?=\.)/i;
+    /**
+     * Create settings instance
+     * @param settings Settings
+     * @returns Result
+     */
+    function create(settings, hostname) {
+        // Default settings reading from globalThis
+        settings ?? (settings = Reflect.get(globalThis, "settings"));
+        if (settings) {
+            if (typeof settings === "string") {
+                settings = JSON.parse(settings);
+            }
+            if (settings != null &&
+                typeof settings === "object" &&
+                "appId" in settings &&
+                "endpoint" in settings) {
+                const s = settings;
+                if (hostname)
+                    s.hostname = hostname;
+                return s;
             }
         }
-        return undefined;
+        throw new Error("No external settings found");
     }
     ExternalSettings.create = create;
-    function format(settings, hostname) {
+    /**
+     * Format the app
+     * @param hostname Hostname
+     * @param app App key
+     * @param endpoint Endpoint
+     * @returns Result
+     */
+    function formatApp(hostname, app, endpoint) {
+        return formatHost(endpoint, hostname).replace(ExternalSettings.subDomainMatch, app);
+    }
+    ExternalSettings.formatApp = formatApp;
+    function formatHost(setting, hostname) {
         // Default hostname
-        if (!hostname)
-            hostname = "localhost";
-        // replace {hostname}
-        for (const key in settings) {
-            const value = settings[key];
-            if (typeof value === "string") {
-                settings[key] = value.replace("{hostname}", hostname);
-            }
-            else if (typeof value === "object") {
-                format(value, hostname);
-            }
+        hostname ?? (hostname = globalThis.location.hostname);
+        if (typeof setting === "string") {
+            return setting.replace("{hostname}", hostname);
+        }
+        else {
+            return Object.fromEntries(Object.entries(setting).map(([key, value]) => [
+                key,
+                {
+                    endpoint: formatApp(hostname, key, value.endpoint),
+                    webUrl: formatApp(hostname, key, value.webUrl)
+                }
+            ]));
         }
-        return settings;
     }
-    ExternalSettings.format = format;
+    ExternalSettings.formatHost = formatHost;
 })(ExternalSettings || (ExternalSettings = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/appscript",
-  "version": "1.5.98",
+  "version": "1.6.0",
   "description": "Applications shared TypeScript framework",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",
@@ -37,7 +37,7 @@
   "dependencies": {
     "@etsoo/notificationbase": "^1.1.58",
     "@etsoo/restclient": "^1.1.23",
-    "@etsoo/shared": "^1.2.60",
+    "@etsoo/shared": "^1.2.61",
     "crypto-js": "^4.2.0"
   },
   "devDependencies": {

package/src/app/CoreApp.ts

@@ -45,7 +45,7 @@ import {
 import { UserRole } from "./UserRole";
 import type CryptoJS from "crypto-js";
 import { Currency } from "../business/Currency";
-import { ExternalEndpoint } from "./ExternalSettings";
+import { ExternalEndpoint, ExternalSettings } from "./ExternalSettings";
 import { ApiRefreshTokenDto } from "../api/dto/ApiRefreshTokenDto";
 import { ApiRefreshTokenRQ } from "../api/rq/ApiRefreshTokenRQ";
 import { AuthApi } from "../api/AuthApi";
@@ -336,15 +336,15 @@ export abstract class CoreApp<
     name: string,
     debug: boolean = false
   ) {
-    if (settings?.regions?.length === 0) {
-      throw new Error("No regions defined");
-    }
-    this.settings = settings;
+    // Format settings
+    this.settings = this.formatSettings(settings);
 
-    const region = AddressRegion.getById(settings.regions[0]);
+    // Current region
+    const region = AddressRegion.getById(this.settings.regions[0]);
     if (region == null) {
       throw new Error("No default region defined");
     }
+
     this.defaultRegion = region;
 
     // Current system refresh token
@@ -433,6 +433,31 @@ export abstract class CoreApp<
     );
   }
 
+  /**
+   * Format settings
+   * @param settings Original settings
+   * @returns Result
+   */
+  protected formatSettings(settings: S): S {
+    const {
+      endpoint,
+      webUrl,
+      endpoints,
+      hostname = globalThis.location.hostname,
+      ...rest
+    } = settings;
+    return {
+      ...rest,
+      hostname,
+      endpoint: ExternalSettings.formatHost(endpoint, hostname),
+      webUrl: ExternalSettings.formatHost(webUrl, hostname),
+      endpoints:
+        endpoints == null
+          ? undefined
+          : ExternalSettings.formatHost(endpoints, hostname)
+    } as S;
+  }
+
   private getDeviceId() {
     return this.deviceId.substring(0, 15);
   }

package/src/app/ExternalSettings.ts

@@ -33,11 +33,17 @@ export interface IExternalSettings extends ExternalEndpoint {
    */
   readonly appId: number;
 
+  /**
+   * Default hostname for substitution
+   * 用于替换的默认主机名
+   */
+  hostname?: string;
+
   /**
    * Endpoints to other services
    */
   readonly endpoints?: Record<
-    "core" | "accounting" | "crm" | "calandar" | "task" | string,
+    "core" | "admin" | "finance" | "crm" | "oa" | "agile" | string,
     ExternalEndpoint
   >;
 }
@@ -47,42 +53,85 @@ export interface IExternalSettings extends ExternalEndpoint {
  */
 export namespace ExternalSettings {
   /**
-   * Create instance
+   * Sub domain match regular expression
+   */
+  export let subDomainMatch: RegExp = /(?<=\/\/)[0-9a-z]+(?=\.)/i;
+
+  /**
+   * Create settings instance
+   * @param settings Settings
+   * @returns Result
    */
-  export function create<T extends IExternalSettings = IExternalSettings>():
-    | T
-    | undefined {
-    if ("settings" in globalThis) {
-      const settings = Reflect.get(globalThis, "settings");
-      if (typeof settings === "object") {
-        if (typeof window !== "undefined") {
-          // Host name
-          const hostname = globalThis.location.hostname;
-
-          // replace {hostname}
-          format(settings, hostname);
-        }
-
-        return settings as T;
+  export function create<T extends IExternalSettings = IExternalSettings>(
+    settings?: unknown,
+    hostname?: string
+  ): T {
+    // Default settings reading from globalThis
+    settings ??= Reflect.get(globalThis, "settings");
+
+    if (settings) {
+      if (typeof settings === "string") {
+        settings = JSON.parse(settings);
+      }
+
+      if (
+        settings != null &&
+        typeof settings === "object" &&
+        "appId" in settings &&
+        "endpoint" in settings
+      ) {
+        const s = settings as T;
+        if (hostname) s.hostname = hostname;
+        return s;
       }
     }
-    return undefined;
+
+    throw new Error("No external settings found");
   }
 
-  export function format(settings: any, hostname?: string) {
+  /**
+   * Format the app
+   * @param hostname Hostname
+   * @param app App key
+   * @param endpoint Endpoint
+   * @returns Result
+   */
+  export function formatApp(hostname: string, app: string, endpoint: string) {
+    return formatHost(endpoint, hostname).replace(subDomainMatch, app);
+  }
+
+  /**
+   * Format the host
+   * @param setting Setting
+   * @param hostname Hostname
+   * @returns Result
+   */
+  export function formatHost(setting: string, hostname: string): string;
+
+  export function formatHost(
+    setting: Record<string, ExternalEndpoint>,
+    hostname?: string | null
+  ): Record<string, ExternalEndpoint>;
+
+  export function formatHost(
+    setting: string | Record<string, ExternalEndpoint>,
+    hostname?: string | null
+  ): string | Record<string, ExternalEndpoint> {
     // Default hostname
-    if (!hostname) hostname = "localhost";
-
-    // replace {hostname}
-    for (const key in settings) {
-      const value = settings[key];
-      if (typeof value === "string") {
-        settings[key] = value.replace("{hostname}", hostname);
-      } else if (typeof value === "object") {
-        format(value, hostname);
-      }
-    }
+    hostname ??= globalThis.location.hostname;
 
-    return settings;
+    if (typeof setting === "string") {
+      return setting.replace("{hostname}", hostname);
+    } else {
+      return Object.fromEntries(
+        Object.entries(setting).map(([key, value]) => [
+          key,
+          {
+            endpoint: formatApp(hostname, key, value.endpoint),
+            webUrl: formatApp(hostname, key, value.webUrl)
+          }
+        ])
+      );
+    }
   }
 }