@etsoo/appscript 1.6.27 → 1.6.29

package/__tests__/business/BusinessUtils.ts

@@ -1,5 +1,4 @@
 import { ArrayUtils } from "@etsoo/shared";
-import { CultureGridItem } from "../../src";
 import { BusinessUtils } from "../../src/business/BusinessUtils";
 
 // Import the ArrayUtils
@@ -12,35 +11,3 @@ test("Tests for BusinessUtils.formatAvatarTitle", () => {
   expect(BusinessUtils.formatAvatarTitle("Etsoo", 3, "E")).toBe("E");
   expect(BusinessUtils.formatAvatarTitle("Etsoo", 5)).toBe("ETSOO");
 });
-
-test("Tests for BusinessUtils.formatCultues", () => {
-  // Arrange
-  const cultures = [
-    {
-      id: "zh-Hans",
-      label: "中文（简体）, Chinese (Simplified)"
-    },
-    {
-      id: "en",
-      label: "英语, English"
-    },
-    {
-      id: "de",
-      label: "德语, German"
-    },
-    {
-      id: "zh-Hant",
-      label: "中文（繁体）, Chinese (Traditional)"
-    }
-  ];
-  const data: { cultures: CultureGridItem[] } = {
-    cultures: [{ id: "zh-Hant", title: "繁体" }]
-  };
-
-  // Act
-  BusinessUtils.formatCultues(cultures, data);
-
-  // Assert
-  expect(data.cultures[0].id).toBe("en");
-  expect(data.cultures.slice(-1)[0].id).toBe("zh-Hant");
-});

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

@@ -354,6 +354,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @param onReady On ready callback
      */
     changeCulture(culture: DataTypes.CultureDefinition): Promise<DataTypes.StringRecord>;
+    /**
+     * Load custom resources, override to implement custom resources
+     * @param resources Resources
+     * @param culture Culture name
+     */
+    protected loadCustomResources(resources: DataTypes.StringRecord, culture: string): Promise<void> | void;
     /**
      * Update current region label
      */

package/lib/cjs/app/CoreApp.js

@@ -829,9 +829,17 @@ class CoreApp {
             // Set static resources back
             culture.resources = resources;
         }
+        // Load system custom resources
+        await this.loadCustomResources(resources, name);
         this.updateRegionLabel();
         return resources;
     }
+    /**
+     * Load custom resources, override to implement custom resources
+     * @param resources Resources
+     * @param culture Culture name
+     */
+    loadCustomResources(resources, culture) { }
     /**
      * Update current region label
      */

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

@@ -1,5 +1,5 @@
-import { ListType, ListType1 } from "@etsoo/shared";
-import { CultureGridItem } from "./CultureItem";
+import { DataTypes, ListType } from "@etsoo/shared";
+import { CustomCultureData } from "../def/CustomCulture";
 /**
  * Business utils
  */
@@ -12,14 +12,6 @@ export declare namespace BusinessUtils {
      * @returns Result
      */
     function formatAvatarTitle(title?: string, maxChars?: number, defaultTitle?: string): string;
-    /**
-     * Format cultures for data
-     * @param cultures Supported cultures
-     * @param data Data to format
-     */
-    function formatCultues(cultures: ListType1[], data: {
-        cultures?: CultureGridItem[];
-    }): void;
     /**
      * Get 12-month items
      * @param monthLabels Month labels
@@ -27,4 +19,11 @@ export declare namespace BusinessUtils {
      * @returns 12 months
      */
     function getMonths(monthLabels: string[], startMonth?: number): ListType[];
+    /**
+     * Merge custom resources to target collection
+     * @param target Target collection merges to
+     * @param resources New resources to merge
+     */
+    function mergeCustomResources(target: DataTypes.StringRecord, resources: CustomCultureData[]): void;
+    function restoreResources(target?: DataTypes.StringRecord): void;
 }

package/lib/cjs/business/BusinessUtils.js

@@ -6,6 +6,7 @@ exports.BusinessUtils = void 0;
  */
 var BusinessUtils;
 (function (BusinessUtils) {
+    let resourcesCache = {};
     /**
      * Format avatar title
      * @param title Title
@@ -38,27 +39,6 @@ var BusinessUtils;
         return defaultTitle;
     }
     BusinessUtils.formatAvatarTitle = formatAvatarTitle;
-    /**
-     * Format cultures for data
-     * @param cultures Supported cultures
-     * @param data Data to format
-     */
-    function formatCultues(cultures, data) {
-        // Add the lost cultures
-        const allCultures = data.cultures ?? [];
-        cultures.forEach((culture) => {
-            if (!allCultures.some((a) => a.id === culture.id)) {
-                allCultures.push({ id: culture.id, title: "" });
-            }
-        });
-        // Remove the default culture
-        allCultures.remove((a) => a.id === cultures[0].id);
-        // Sort
-        allCultures.sortByProperty("id", cultures.map((c) => c.id));
-        // Set back
-        data.cultures = allCultures;
-    }
-    BusinessUtils.formatCultues = formatCultues;
     /**
      * Get 12-month items
      * @param monthLabels Month labels
@@ -76,4 +56,41 @@ var BusinessUtils;
         return months;
     }
     BusinessUtils.getMonths = getMonths;
+    /**
+     * Merge custom resources to target collection
+     * @param target Target collection merges to
+     * @param resources New resources to merge
+     */
+    function mergeCustomResources(target, resources) {
+        for (const item of resources) {
+            if (item.organizationId) {
+                // Backup
+                const backup = target[item.id];
+                if (backup != null &&
+                    (typeof backup !== "object" || !("organizationId" in backup))) {
+                    resourcesCache[item.id] = backup;
+                }
+            }
+            if (item.description || item.jsonData) {
+                const { id, ...rest } = item;
+                target[item.id] = rest;
+            }
+            else {
+                target[item.id] = item.title;
+            }
+        }
+    }
+    BusinessUtils.mergeCustomResources = mergeCustomResources;
+    function restoreResources(target) {
+        // Clear cache if no target
+        if (target == null) {
+            resourcesCache = {};
+            return;
+        }
+        // Restore resources
+        for (const key in resourcesCache) {
+            target[key] = resourcesCache[key];
+        }
+    }
+    BusinessUtils.restoreResources = restoreResources;
 })(BusinessUtils || (exports.BusinessUtils = BusinessUtils = {}));

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

@@ -1,46 +1,42 @@
 /**
- * Culture item for multilingual labels
+ * Culture item
+ * 文化项目
+ * @see com.etsoo.Utils.Serialization.Country.CultureItem
  */
 export type CultureItem = {
     /**
-     * Target id
+     * Id, like zh-Hans-CN
+     * 编号，如zh-Hans-CN
      */
-    id: number;
-    /**
-     * Culture, like zh-Hans
-     */
-    culture: string;
+    id: string;
     /**
-     * Title /  label
+     * Two characters id, like zh
+     * 两个字符编号
      */
-    title: string;
+    id2: string;
     /**
-     * Description
+     * Three characters id, like zho
+     * 三个字符编号
      */
-    description?: string;
+    id3: string;
     /**
-     * JSON data related
+     * Parent culture, like zh-Hans
+     * 父文化
      */
-    jsonData?: string;
-};
-/**
- * Culture grid item for editing
- */
-export type CultureGridItem = {
-    /**
-     * Culture
-     */
-    id: string;
+    parent: string;
     /**
-     * Title /  label
+     * Name
+     * 名称
      */
-    title: string;
+    name: string;
     /**
-     * Description
+     * Native name, like 中文(简体，中国)
+     * 原生名
      */
-    description?: string;
+    nativeName: string;
     /**
-     * JSON data related
+     * English name, like Chinese (Simplified, China)
+     * 英文名
      */
-    jsonData?: string;
+    englishName: string;
 };

package/lib/cjs/def/CustomCulture.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Custom culture data
+ */
+export type CustomCultureData = {
+    /**
+     * Target id
+     */
+    id: string;
+    /**
+     * Organization id
+     */
+    organizationId?: number;
+    /**
+     * Title /  label
+     */
+    title: string;
+    /**
+     * Description
+     */
+    description?: string;
+    /**
+     * JSON data related
+     * Use Utils.parseString of @etsoo/shared to parse the string to JSON object
+     */
+    jsonData?: string;
+};
+/**
+ * Custom culture
+ */
+export type CustomCulture = CustomCultureData & {
+    /**
+     * Culture, like zh-Hans
+     */
+    culture: string;
+};

package/lib/cjs/def/CustomCulture.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/index.d.ts

@@ -59,6 +59,7 @@ export * from "./business/RepeatOption";
 export * from "./business/ShoppingCart";
 export * from "./custom/CustomField";
 export * from "./custom/CustomFieldData";
+export * from "./def/CustomCulture";
 export * from "./def/ListItem";
 export * from "./i18n/Culture";
 export { ApiAuthorizationScheme, ApiDataError, ApiMethod, ApiResponseType, createClient, createClientAsync } from "@etsoo/restclient";

package/lib/cjs/index.js

@@ -83,6 +83,7 @@ __exportStar(require("./business/ShoppingCart"), exports);
 __exportStar(require("./custom/CustomField"), exports);
 __exportStar(require("./custom/CustomFieldData"), exports);
 // def
+__exportStar(require("./def/CustomCulture"), exports);
 __exportStar(require("./def/ListItem"), exports);
 // i18n
 __exportStar(require("./i18n/Culture"), exports);

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

@@ -354,6 +354,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @param onReady On ready callback
      */
     changeCulture(culture: DataTypes.CultureDefinition): Promise<DataTypes.StringRecord>;
+    /**
+     * Load custom resources, override to implement custom resources
+     * @param resources Resources
+     * @param culture Culture name
+     */
+    protected loadCustomResources(resources: DataTypes.StringRecord, culture: string): Promise<void> | void;
     /**
      * Update current region label
      */

package/lib/mjs/app/CoreApp.js

@@ -826,9 +826,17 @@ export class CoreApp {
             // Set static resources back
             culture.resources = resources;
         }
+        // Load system custom resources
+        await this.loadCustomResources(resources, name);
         this.updateRegionLabel();
         return resources;
     }
+    /**
+     * Load custom resources, override to implement custom resources
+     * @param resources Resources
+     * @param culture Culture name
+     */
+    loadCustomResources(resources, culture) { }
     /**
      * Update current region label
      */

package/lib/mjs/business/BusinessUtils.d.ts

@@ -1,5 +1,5 @@
-import { ListType, ListType1 } from "@etsoo/shared";
-import { CultureGridItem } from "./CultureItem";
+import { DataTypes, ListType } from "@etsoo/shared";
+import { CustomCultureData } from "../def/CustomCulture";
 /**
  * Business utils
  */
@@ -12,14 +12,6 @@ export declare namespace BusinessUtils {
      * @returns Result
      */
     function formatAvatarTitle(title?: string, maxChars?: number, defaultTitle?: string): string;
-    /**
-     * Format cultures for data
-     * @param cultures Supported cultures
-     * @param data Data to format
-     */
-    function formatCultues(cultures: ListType1[], data: {
-        cultures?: CultureGridItem[];
-    }): void;
     /**
      * Get 12-month items
      * @param monthLabels Month labels
@@ -27,4 +19,11 @@ export declare namespace BusinessUtils {
      * @returns 12 months
      */
     function getMonths(monthLabels: string[], startMonth?: number): ListType[];
+    /**
+     * Merge custom resources to target collection
+     * @param target Target collection merges to
+     * @param resources New resources to merge
+     */
+    function mergeCustomResources(target: DataTypes.StringRecord, resources: CustomCultureData[]): void;
+    function restoreResources(target?: DataTypes.StringRecord): void;
 }

package/lib/mjs/business/BusinessUtils.js

@@ -3,6 +3,7 @@
  */
 export var BusinessUtils;
 (function (BusinessUtils) {
+    let resourcesCache = {};
     /**
      * Format avatar title
      * @param title Title
@@ -35,27 +36,6 @@ export var BusinessUtils;
         return defaultTitle;
     }
     BusinessUtils.formatAvatarTitle = formatAvatarTitle;
-    /**
-     * Format cultures for data
-     * @param cultures Supported cultures
-     * @param data Data to format
-     */
-    function formatCultues(cultures, data) {
-        // Add the lost cultures
-        const allCultures = data.cultures ?? [];
-        cultures.forEach((culture) => {
-            if (!allCultures.some((a) => a.id === culture.id)) {
-                allCultures.push({ id: culture.id, title: "" });
-            }
-        });
-        // Remove the default culture
-        allCultures.remove((a) => a.id === cultures[0].id);
-        // Sort
-        allCultures.sortByProperty("id", cultures.map((c) => c.id));
-        // Set back
-        data.cultures = allCultures;
-    }
-    BusinessUtils.formatCultues = formatCultues;
     /**
      * Get 12-month items
      * @param monthLabels Month labels
@@ -73,4 +53,41 @@ export var BusinessUtils;
         return months;
     }
     BusinessUtils.getMonths = getMonths;
+    /**
+     * Merge custom resources to target collection
+     * @param target Target collection merges to
+     * @param resources New resources to merge
+     */
+    function mergeCustomResources(target, resources) {
+        for (const item of resources) {
+            if (item.organizationId) {
+                // Backup
+                const backup = target[item.id];
+                if (backup != null &&
+                    (typeof backup !== "object" || !("organizationId" in backup))) {
+                    resourcesCache[item.id] = backup;
+                }
+            }
+            if (item.description || item.jsonData) {
+                const { id, ...rest } = item;
+                target[item.id] = rest;
+            }
+            else {
+                target[item.id] = item.title;
+            }
+        }
+    }
+    BusinessUtils.mergeCustomResources = mergeCustomResources;
+    function restoreResources(target) {
+        // Clear cache if no target
+        if (target == null) {
+            resourcesCache = {};
+            return;
+        }
+        // Restore resources
+        for (const key in resourcesCache) {
+            target[key] = resourcesCache[key];
+        }
+    }
+    BusinessUtils.restoreResources = restoreResources;
 })(BusinessUtils || (BusinessUtils = {}));

package/lib/mjs/business/CultureItem.d.ts

@@ -1,46 +1,42 @@
 /**
- * Culture item for multilingual labels
+ * Culture item
+ * 文化项目
+ * @see com.etsoo.Utils.Serialization.Country.CultureItem
  */
 export type CultureItem = {
     /**
-     * Target id
+     * Id, like zh-Hans-CN
+     * 编号，如zh-Hans-CN
      */
-    id: number;
-    /**
-     * Culture, like zh-Hans
-     */
-    culture: string;
+    id: string;
     /**
-     * Title /  label
+     * Two characters id, like zh
+     * 两个字符编号
      */
-    title: string;
+    id2: string;
     /**
-     * Description
+     * Three characters id, like zho
+     * 三个字符编号
      */
-    description?: string;
+    id3: string;
     /**
-     * JSON data related
+     * Parent culture, like zh-Hans
+     * 父文化
      */
-    jsonData?: string;
-};
-/**
- * Culture grid item for editing
- */
-export type CultureGridItem = {
-    /**
-     * Culture
-     */
-    id: string;
+    parent: string;
     /**
-     * Title /  label
+     * Name
+     * 名称
      */
-    title: string;
+    name: string;
     /**
-     * Description
+     * Native name, like 中文(简体，中国)
+     * 原生名
      */
-    description?: string;
+    nativeName: string;
     /**
-     * JSON data related
+     * English name, like Chinese (Simplified, China)
+     * 英文名
      */
-    jsonData?: string;
+    englishName: string;
 };

package/lib/mjs/def/CustomCulture.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Custom culture data
+ */
+export type CustomCultureData = {
+    /**
+     * Target id
+     */
+    id: string;
+    /**
+     * Organization id
+     */
+    organizationId?: number;
+    /**
+     * Title /  label
+     */
+    title: string;
+    /**
+     * Description
+     */
+    description?: string;
+    /**
+     * JSON data related
+     * Use Utils.parseString of @etsoo/shared to parse the string to JSON object
+     */
+    jsonData?: string;
+};
+/**
+ * Custom culture
+ */
+export type CustomCulture = CustomCultureData & {
+    /**
+     * Culture, like zh-Hans
+     */
+    culture: string;
+};

package/lib/mjs/def/CustomCulture.js

@@ -0,0 +1 @@
+export {};

package/lib/mjs/index.d.ts

@@ -59,6 +59,7 @@ export * from "./business/RepeatOption";
 export * from "./business/ShoppingCart";
 export * from "./custom/CustomField";
 export * from "./custom/CustomFieldData";
+export * from "./def/CustomCulture";
 export * from "./def/ListItem";
 export * from "./i18n/Culture";
 export { ApiAuthorizationScheme, ApiDataError, ApiMethod, ApiResponseType, createClient, createClientAsync } from "@etsoo/restclient";

package/lib/mjs/index.js

@@ -66,6 +66,7 @@ export * from "./business/ShoppingCart";
 export * from "./custom/CustomField";
 export * from "./custom/CustomFieldData";
 // def
+export * from "./def/CustomCulture";
 export * from "./def/ListItem";
 // i18n
 export * from "./i18n/Culture";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/appscript",
-  "version": "1.6.27",
+  "version": "1.6.29",
   "description": "Applications shared TypeScript framework",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",

package/src/app/CoreApp.ts

@@ -1229,11 +1229,25 @@ export abstract class CoreApp<
       // Set static resources back
       culture.resources = resources;
     }
+
+    // Load system custom resources
+    await this.loadCustomResources(resources, name);
+
     this.updateRegionLabel();
 
     return resources;
   }
 
+  /**
+   * Load custom resources, override to implement custom resources
+   * @param resources Resources
+   * @param culture Culture name
+   */
+  protected loadCustomResources(
+    resources: DataTypes.StringRecord,
+    culture: string
+  ): Promise<void> | void {}
+
   /**
    * Update current region label
    */

package/src/business/BusinessUtils.ts

@@ -1,10 +1,12 @@
-import { ListType, ListType1 } from "@etsoo/shared";
-import { CultureGridItem } from "./CultureItem";
+import { DataTypes, ListType } from "@etsoo/shared";
+import { CustomCultureData } from "../def/CustomCulture";
 
 /**
  * Business utils
  */
 export namespace BusinessUtils {
+  let resourcesCache: DataTypes.StringRecord = {};
+
   /**
    * Format avatar title
    * @param title Title
@@ -44,35 +46,6 @@ export namespace BusinessUtils {
     return defaultTitle;
   }
 
-  /**
-   * Format cultures for data
-   * @param cultures Supported cultures
-   * @param data Data to format
-   */
-  export function formatCultues(
-    cultures: ListType1[],
-    data: { cultures?: CultureGridItem[] }
-  ) {
-    // Add the lost cultures
-    const allCultures = data.cultures ?? [];
-    cultures.forEach((culture) => {
-      if (!allCultures.some((a) => a.id === culture.id)) {
-        allCultures.push({ id: culture.id, title: "" });
-      }
-    });
-
-    // Remove the default culture
-    allCultures.remove((a) => a.id === cultures[0].id);
-    // Sort
-    allCultures.sortByProperty(
-      "id",
-      cultures.map((c) => c.id)
-    );
-
-    // Set back
-    data.cultures = allCultures;
-  }
-
   /**
    * Get 12-month items
    * @param monthLabels Month labels
@@ -92,4 +65,47 @@ export namespace BusinessUtils {
 
     return months;
   }
+
+  /**
+   * Merge custom resources to target collection
+   * @param target Target collection merges to
+   * @param resources New resources to merge
+   */
+  export function mergeCustomResources(
+    target: DataTypes.StringRecord,
+    resources: CustomCultureData[]
+  ) {
+    for (const item of resources) {
+      if (item.organizationId) {
+        // Backup
+        const backup = target[item.id];
+        if (
+          backup != null &&
+          (typeof backup !== "object" || !("organizationId" in backup))
+        ) {
+          resourcesCache[item.id] = backup;
+        }
+      }
+
+      if (item.description || item.jsonData) {
+        const { id, ...rest } = item;
+        target[item.id] = rest;
+      } else {
+        target[item.id] = item.title;
+      }
+    }
+  }
+
+  export function restoreResources(target?: DataTypes.StringRecord) {
+    // Clear cache if no target
+    if (target == null) {
+      resourcesCache = {};
+      return;
+    }
+
+    // Restore resources
+    for (const key in resourcesCache) {
+      target[key] = resourcesCache[key];
+    }
+  }
 }

package/src/business/CultureItem.ts

@@ -1,54 +1,48 @@
 /**
- * Culture item for multilingual labels
+ * Culture item
+ * 文化项目
+ * @see com.etsoo.Utils.Serialization.Country.CultureItem
  */
 export type CultureItem = {
   /**
-   * Target id
+   * Id, like zh-Hans-CN
+   * 编号，如zh-Hans-CN
    */
-  id: number;
-
-  /**
-   * Culture, like zh-Hans
-   */
-  culture: string;
-
-  /**
-   * Title /  label
-   */
-  title: string;
+  id: string;
 
   /**
-   * Description
+   * Two characters id, like zh
+   * 两个字符编号
    */
-  description?: string;
+  id2: string;
 
   /**
-   * JSON data related
+   * Three characters id, like zho
+   * 三个字符编号
    */
-  jsonData?: string;
-};
+  id3: string;
 
-/**
- * Culture grid item for editing
- */
-export type CultureGridItem = {
   /**
-   * Culture
+   * Parent culture, like zh-Hans
+   * 父文化
    */
-  id: string;
+  parent: string;
 
   /**
-   * Title /  label
+   * Name
+   * 名称
    */
-  title: string;
+  name: string;
 
   /**
-   * Description
+   * Native name, like 中文(简体，中国)
+   * 原生名
    */
-  description?: string;
+  nativeName: string;
 
   /**
-   * JSON data related
+   * English name, like Chinese (Simplified, China)
+   * 英文名
    */
-  jsonData?: string;
+  englishName: string;
 };

package/src/def/CustomCulture.ts

@@ -0,0 +1,40 @@
+/**
+ * Custom culture data
+ */
+export type CustomCultureData = {
+  /**
+   * Target id
+   */
+  id: string;
+
+  /**
+   * Organization id
+   */
+  organizationId?: number;
+
+  /**
+   * Title /  label
+   */
+  title: string;
+
+  /**
+   * Description
+   */
+  description?: string;
+
+  /**
+   * JSON data related
+   * Use Utils.parseString of @etsoo/shared to parse the string to JSON object
+   */
+  jsonData?: string;
+};
+
+/**
+ * Custom culture
+ */
+export type CustomCulture = CustomCultureData & {
+  /**
+   * Culture, like zh-Hans
+   */
+  culture: string;
+};

package/src/index.ts

@@ -74,6 +74,7 @@ export * from "./custom/CustomField";
 export * from "./custom/CustomFieldData";
 
 // def
+export * from "./def/CustomCulture";
 export * from "./def/ListItem";
 
 // i18n