@etsoo/appscript 1.4.97 → 1.4.99

package/.github/workflows/main.yml

@@ -22,13 +22,13 @@ jobs:
     steps:
       # https://github.com/actions/checkout, This action checks-out your repository under $GITHUB_WORKSPACE
       # so your workflow can access it.
-      - uses: actions/checkout@v2
+      - 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@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
 
       # Named after Continuous Integration, installs dependencies directly from package-lock.json

package/__tests__/app/CoreApp.ts

@@ -264,6 +264,30 @@ test('Tests for formatResult', () => {
     );
 });
 
+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)');
+});
+
+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)`);
+});
+
 test('Tests for formatError', () => {
     const error: ApiDataError = {
         name: 'ApiDataError',

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

@@ -7,7 +7,7 @@ import { InitCallDto } from '../erp/dto/InitCallDto';
 import { InitCallResult, InitCallResultData } from '../result/InitCallResult';
 import { IUser } from '../state/User';
 import { IAppSettings } from './AppSettings';
-import { IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
+import { FormatResultCustomCallback, IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
 import { UserRole } from './UserRole';
 /**
  * Core application interface
@@ -229,12 +229,19 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Fields
      */
     protected initCallEncryptedUpdateFields(): string[];
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
-    alertResult(result: IActionResult | string, callback?: NotificationReturn<void>): void;
+    alertResult(result: IActionResult, callback?: NotificationReturn<void>, forceToLocal?: FormatResultCustomCallback): void;
     /**
      * Authorize
      * @param token New token
@@ -381,12 +388,13 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Message
      */
     formatRefreshTokenResult(result: RefreshTokenResult): string | undefined;
+    private getFieldLabel;
     /**
      * Format result text
      * @param result Action result
      * @param forceToLocal Force to local labels
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean): string;
+    formatResult(result: IActionResult, forceToLocal?: FormatResultCustomCallback): string;
     /**
      * Get culture resource
      * @param key key

package/lib/cjs/app/CoreApp.js

@@ -504,13 +504,10 @@ class CoreApp {
     initCallEncryptedUpdateFields() {
         return [this.fields.headerToken];
     }
-    /**
-     * Alert action result
-     * @param result Action result or message
-     * @param callback Callback
-     */
-    alertResult(result, callback) {
-        const message = typeof result === 'string' ? result : this.formatResult(result);
+    alertResult(result, callback, forceToLocal) {
+        const message = typeof result === 'string'
+            ? result
+            : this.formatResult(result, forceToLocal);
         this.notifier.alert(message, callback);
     }
     /**
@@ -939,33 +936,47 @@ class CoreApp {
                 ? ActionResultError_1.ActionResultError.format(result)
                 : result;
     }
+    getFieldLabel(field) {
+        return this.get(field.formatInitial(false)) ?? field;
+    }
     /**
      * Format result text
      * @param result Action result
      * @param forceToLocal Force to local labels
      */
     formatResult(result, forceToLocal) {
-        const title = result.title;
-        if (title && /^\w+$/.test(title)) {
-            const key = title.formatInitial(false);
-            const localTitle = this.get(key);
-            if (localTitle) {
-                result.title = localTitle;
-                // Hold the original title in type when type is null
-                if (result.type == null)
-                    result.type = title;
-            }
+        // Destruct the result
+        const { title, type, field } = result;
+        const data = { title, type, field };
+        if (type === 'ItemExists' && field) {
+            // Special case
+            const fieldLabel = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(field);
+            result.title = this.get('itemExists')?.format(fieldLabel);
+        }
+        else if (title?.includes('{0}')) {
+            // When title contains {0}, replace with the field label
+            const fieldLabel = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? (field ? this.getFieldLabel(field) : '');
+            result.title = title.format(fieldLabel);
         }
-        else if ((title == null || forceToLocal) && result.type != null) {
-            // Get label from type
-            const key = result.type.formatInitial(false);
-            result.title = this.get(key);
+        else if (title && /^\w+$/.test(title)) {
+            // When title is a single word
+            // Hold the original title in type when type is null
+            if (type == null)
+                result.type = title;
+            const localTitle = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(title);
+            result.title = localTitle;
         }
-        // When title contains {0}, replace with the field label
-        if (result.field && result.title?.includes('{0}')) {
-            const fieldLabel = this.get(result.field.formatInitial(false));
-            if (fieldLabel)
-                result.title = result.title.format(fieldLabel);
+        else if ((title == null || forceToLocal) && type != null) {
+            const localTitle = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(type);
+            result.title = localTitle;
         }
         return ActionResultError_1.ActionResultError.format(result);
     }

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

@@ -26,6 +26,18 @@ export interface NavigateOptions {
  * other cases means failed with differnet message
  */
 export type RefreshTokenResult = boolean | string | ApiDataError | IActionResult;
+/**
+ * Format result custom type
+ */
+export type FormatResultCustom = {
+    title?: string;
+    type?: string;
+    field?: string;
+};
+/**
+ * Format result custom callback type
+ */
+export type FormatResultCustomCallback = ((data: FormatResultCustom) => string | null | undefined) | boolean;
 /**
  * Refresh token props
  */
@@ -147,12 +159,19 @@ export interface IApp {
      * @returns Result
      */
     addRootUrl(url: string): string;
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
-    alertResult(result: IActionResult | string, callback?: NotificationReturn<void>): void;
+    alertResult(result: IActionResult, callback?: NotificationReturn<void>, forceToLocal?: FormatResultCustomCallback): void;
     /**
      * Authorize
      * @param token New token
@@ -298,7 +317,7 @@ export interface IApp {
      * @param forceToLocal Force to local labels
      * @returns Message
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean): string;
+    formatResult(result: IActionResult, forceToLocal?: FormatResultCustomCallback): string;
     /**
      * Fresh countdown UI
      * @param callback Callback

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

@@ -7,7 +7,7 @@ import { InitCallDto } from '../erp/dto/InitCallDto';
 import { InitCallResult, InitCallResultData } from '../result/InitCallResult';
 import { IUser } from '../state/User';
 import { IAppSettings } from './AppSettings';
-import { IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
+import { FormatResultCustomCallback, IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
 import { UserRole } from './UserRole';
 /**
  * Core application interface
@@ -229,12 +229,19 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Fields
      */
     protected initCallEncryptedUpdateFields(): string[];
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
-    alertResult(result: IActionResult | string, callback?: NotificationReturn<void>): void;
+    alertResult(result: IActionResult, callback?: NotificationReturn<void>, forceToLocal?: FormatResultCustomCallback): void;
     /**
      * Authorize
      * @param token New token
@@ -381,12 +388,13 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Message
      */
     formatRefreshTokenResult(result: RefreshTokenResult): string | undefined;
+    private getFieldLabel;
     /**
      * Format result text
      * @param result Action result
      * @param forceToLocal Force to local labels
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean): string;
+    formatResult(result: IActionResult, forceToLocal?: FormatResultCustomCallback): string;
     /**
      * Get culture resource
      * @param key key

package/lib/mjs/app/CoreApp.js

@@ -501,13 +501,10 @@ export class CoreApp {
     initCallEncryptedUpdateFields() {
         return [this.fields.headerToken];
     }
-    /**
-     * Alert action result
-     * @param result Action result or message
-     * @param callback Callback
-     */
-    alertResult(result, callback) {
-        const message = typeof result === 'string' ? result : this.formatResult(result);
+    alertResult(result, callback, forceToLocal) {
+        const message = typeof result === 'string'
+            ? result
+            : this.formatResult(result, forceToLocal);
         this.notifier.alert(message, callback);
     }
     /**
@@ -936,33 +933,47 @@ export class CoreApp {
                 ? ActionResultError.format(result)
                 : result;
     }
+    getFieldLabel(field) {
+        return this.get(field.formatInitial(false)) ?? field;
+    }
     /**
      * Format result text
      * @param result Action result
      * @param forceToLocal Force to local labels
      */
     formatResult(result, forceToLocal) {
-        const title = result.title;
-        if (title && /^\w+$/.test(title)) {
-            const key = title.formatInitial(false);
-            const localTitle = this.get(key);
-            if (localTitle) {
-                result.title = localTitle;
-                // Hold the original title in type when type is null
-                if (result.type == null)
-                    result.type = title;
-            }
+        // Destruct the result
+        const { title, type, field } = result;
+        const data = { title, type, field };
+        if (type === 'ItemExists' && field) {
+            // Special case
+            const fieldLabel = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(field);
+            result.title = this.get('itemExists')?.format(fieldLabel);
+        }
+        else if (title?.includes('{0}')) {
+            // When title contains {0}, replace with the field label
+            const fieldLabel = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? (field ? this.getFieldLabel(field) : '');
+            result.title = title.format(fieldLabel);
         }
-        else if ((title == null || forceToLocal) && result.type != null) {
-            // Get label from type
-            const key = result.type.formatInitial(false);
-            result.title = this.get(key);
+        else if (title && /^\w+$/.test(title)) {
+            // When title is a single word
+            // Hold the original title in type when type is null
+            if (type == null)
+                result.type = title;
+            const localTitle = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(title);
+            result.title = localTitle;
         }
-        // When title contains {0}, replace with the field label
-        if (result.field && result.title?.includes('{0}')) {
-            const fieldLabel = this.get(result.field.formatInitial(false));
-            if (fieldLabel)
-                result.title = result.title.format(fieldLabel);
+        else if ((title == null || forceToLocal) && type != null) {
+            const localTitle = (typeof forceToLocal === 'function'
+                ? forceToLocal(data)
+                : undefined) ?? this.getFieldLabel(type);
+            result.title = localTitle;
         }
         return ActionResultError.format(result);
     }

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

@@ -26,6 +26,18 @@ export interface NavigateOptions {
  * other cases means failed with differnet message
  */
 export type RefreshTokenResult = boolean | string | ApiDataError | IActionResult;
+/**
+ * Format result custom type
+ */
+export type FormatResultCustom = {
+    title?: string;
+    type?: string;
+    field?: string;
+};
+/**
+ * Format result custom callback type
+ */
+export type FormatResultCustomCallback = ((data: FormatResultCustom) => string | null | undefined) | boolean;
 /**
  * Refresh token props
  */
@@ -147,12 +159,19 @@ export interface IApp {
      * @returns Result
      */
     addRootUrl(url: string): string;
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
-    alertResult(result: IActionResult | string, callback?: NotificationReturn<void>): void;
+    alertResult(result: IActionResult, callback?: NotificationReturn<void>, forceToLocal?: FormatResultCustomCallback): void;
     /**
      * Authorize
      * @param token New token
@@ -298,7 +317,7 @@ export interface IApp {
      * @param forceToLocal Force to local labels
      * @returns Message
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean): string;
+    formatResult(result: IActionResult, forceToLocal?: FormatResultCustomCallback): string;
     /**
      * Fresh countdown UI
      * @param callback Callback

package/package.json

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

package/src/app/CoreApp.ts

@@ -32,6 +32,7 @@ import { IUser } from '../state/User';
 import { IAppSettings } from './AppSettings';
 import {
     appFields,
+    FormatResultCustomCallback,
     IApp,
     IAppFields,
     IDetectIPCallback,
@@ -752,17 +753,34 @@ export abstract class CoreApp<
         return [this.fields.headerToken];
     }
 
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
+
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
+    alertResult(
+        result: IActionResult,
+        callback?: NotificationReturn<void>,
+        forceToLocal?: FormatResultCustomCallback
+    ): void;
+
     alertResult(
         result: IActionResult | string,
-        callback?: NotificationReturn<void>
+        callback?: NotificationReturn<void>,
+        forceToLocal?: FormatResultCustomCallback
     ) {
         const message =
-            typeof result === 'string' ? result : this.formatResult(result);
+            typeof result === 'string'
+                ? result
+                : this.formatResult(result, forceToLocal);
         this.notifier.alert(message, callback);
     }
 
@@ -1307,32 +1325,53 @@ export abstract class CoreApp<
             : result;
     }
 
+    private getFieldLabel(field: string) {
+        return this.get(field.formatInitial(false)) ?? field;
+    }
+
     /**
      * Format result text
      * @param result Action result
      * @param forceToLocal Force to local labels
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean) {
-        const title = result.title;
-        if (title && /^\w+$/.test(title)) {
-            const key = title.formatInitial(false);
-            const localTitle = this.get(key);
-            if (localTitle) {
-                result.title = localTitle;
-
-                // Hold the original title in type when type is null
-                if (result.type == null) result.type = title;
-            }
-        } else if ((title == null || forceToLocal) && result.type != null) {
-            // Get label from type
-            const key = result.type.formatInitial(false);
-            result.title = this.get(key);
-        }
-
-        // When title contains {0}, replace with the field label
-        if (result.field && result.title?.includes('{0}')) {
-            const fieldLabel = this.get(result.field.formatInitial(false));
-            if (fieldLabel) result.title = result.title.format(fieldLabel);
+    formatResult(
+        result: IActionResult,
+        forceToLocal?: FormatResultCustomCallback
+    ) {
+        // Destruct the result
+        const { title, type, field } = result;
+        const data = { title, type, field };
+
+        if (type === 'ItemExists' && field) {
+            // Special case
+            const fieldLabel =
+                (typeof forceToLocal === 'function'
+                    ? forceToLocal(data)
+                    : undefined) ?? this.getFieldLabel(field);
+            result.title = this.get('itemExists')?.format(fieldLabel);
+        } else if (title?.includes('{0}')) {
+            // When title contains {0}, replace with the field label
+            const fieldLabel =
+                (typeof forceToLocal === 'function'
+                    ? forceToLocal(data)
+                    : undefined) ?? (field ? this.getFieldLabel(field) : '');
+
+            result.title = title.format(fieldLabel);
+        } else if (title && /^\w+$/.test(title)) {
+            // When title is a single word
+            // Hold the original title in type when type is null
+            if (type == null) result.type = title;
+            const localTitle =
+                (typeof forceToLocal === 'function'
+                    ? forceToLocal(data)
+                    : undefined) ?? this.getFieldLabel(title);
+            result.title = localTitle;
+        } else if ((title == null || forceToLocal) && type != null) {
+            const localTitle =
+                (typeof forceToLocal === 'function'
+                    ? forceToLocal(data)
+                    : undefined) ?? this.getFieldLabel(type);
+            result.title = localTitle;
         }
 
         return ActionResultError.format(result);

package/src/app/IApp.ts

@@ -49,6 +49,22 @@ export type RefreshTokenResult =
     | ApiDataError
     | IActionResult;
 
+/**
+ * Format result custom type
+ */
+export type FormatResultCustom = {
+    title?: string;
+    type?: string;
+    field?: string;
+};
+
+/**
+ * Format result custom callback type
+ */
+export type FormatResultCustomCallback =
+    | ((data: FormatResultCustom) => string | null | undefined)
+    | boolean;
+
 /**
  * Refresh token props
  */
@@ -201,14 +217,23 @@ export interface IApp {
      */
     addRootUrl(url: string): string;
 
+    /**
+     * Alert result
+     * @param result Result message
+     * @param callback Callback
+     */
+    alertResult(result: string, callback?: NotificationReturn<void>): void;
+
     /**
      * Alert action result
-     * @param result Action result or message
+     * @param result Action result
      * @param callback Callback
+     * @param forceToLocal Force to local labels
      */
     alertResult(
-        result: IActionResult | string,
-        callback?: NotificationReturn<void>
+        result: IActionResult,
+        callback?: NotificationReturn<void>,
+        forceToLocal?: FormatResultCustomCallback
     ): void;
 
     /**
@@ -410,7 +435,10 @@ export interface IApp {
      * @param forceToLocal Force to local labels
      * @returns Message
      */
-    formatResult(result: IActionResult, forceToLocal?: boolean): string;
+    formatResult(
+        result: IActionResult,
+        forceToLocal?: FormatResultCustomCallback
+    ): string;
 
     /**
      * Fresh countdown UI