@etsoo/shared 1.1.80 → 1.1.82

package/README.md

@@ -15,6 +15,20 @@ Using yarn:
 $ yarn add @etsoo/shared
 ```
 
+## ActionResult / IActionResult, IdActionResult, DynamicActionResult
+|Name|Description|
+|---:|---|
+|static create|Create a result from error|
+|data|Result data|
+|detail|Details|
+|errors|Result errors|
+|field|Related field|
+|ok|Success or failure|
+|status|Status code|
+|title|Title|
+|traceId|Trace id|
+|type|Type|
+
 ## storage
 Storage interface and browser storage implementation
 
@@ -161,6 +175,7 @@ DOM/window related utilities
 |Name|Description|
 |---:|---|
 |clearFormData|Clear form data|
+|CultureMatch|Culture match case Enum|
 |dataAs|Cast data as template format|
 |detectedCountry|Current detected country|
 |detectedCulture|Current detected culture|

package/__tests__/DomUtils.ts

@@ -229,11 +229,25 @@ test('Tests for getCulture', () => {
         { name: 'en', label: 'English', resources: {} }
     ];
 
-    expect(DomUtils.getCulture(cultures, 'zh-CN')?.name).toBe('zh-Hans');
-    expect(DomUtils.getCulture(cultures, 'zh-Hans-CN')?.name).toBe('zh-Hans');
-    expect(DomUtils.getCulture(cultures, 'zh-Hans-HK')?.name).toBe('zh-Hans');
-    expect(DomUtils.getCulture(cultures, 'zh-SG')?.name).toBe('zh-Hans');
-    expect(DomUtils.getCulture(cultures, 'en-GB')?.name).toBe('en');
+    const [culture1, match1] = DomUtils.getCulture(cultures, 'zh-CN');
+    expect(culture1?.name).toBe('zh-Hans');
+    expect(match1).toBe(DomUtils.CultureMatch.Compatible);
+
+    const [culture2] = DomUtils.getCulture(cultures, 'zh-Hans-CN');
+    expect(culture2?.name).toBe('zh-Hans');
+
+    const [culture3] = DomUtils.getCulture(cultures, 'zh-Hans-HK');
+    expect(culture3?.name).toBe('zh-Hans');
+
+    const [culture4] = DomUtils.getCulture(cultures, 'zh-SG');
+    expect(culture4?.name).toBe('zh-Hans');
+
+    const [culture5] = DomUtils.getCulture(cultures, 'en-GB');
+    expect(culture5?.name).toBe('en');
+
+    const [culture6, match6] = DomUtils.getCulture(cultures, 'fr-CA');
+    expect(culture6?.name).toBe('zh-Hans');
+    expect(match6).toBe(DomUtils.CultureMatch.Default);
 });
 
 test('Tests for getLocationKey', () => {

package/lib/cjs/ActionResult.d.ts

@@ -0,0 +1,11 @@
+import { IActionResult } from './IActionResult';
+/**
+ * Action result
+ */
+export declare class ActionResult {
+    /**
+     * Create a result from error
+     * @returns Action result interface
+     */
+    static create<D extends object = {}>(error: Error): IActionResult<D>;
+}

package/lib/cjs/ActionResult.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionResult = void 0;
+/**
+ * Action result
+ */
+class ActionResult {
+    /**
+     * Create a result from error
+     * @returns Action result interface
+     */
+    static create(error) {
+        // If the error has status / statusCode
+        const status = 'status' in error
+            ? error.status
+            : 'statusCode' in error
+                ? error.statusCode
+                : undefined;
+        // Result
+        const result = {
+            status: typeof status === 'number' ? status : undefined,
+            ok: false,
+            type: error.name,
+            title: error.message
+        };
+        // Return
+        return result;
+    }
+}
+exports.ActionResult = ActionResult;

package/lib/cjs/DomUtils.d.ts

@@ -62,6 +62,15 @@ export declare namespace DomUtils {
      * @returns Object
      */
     function formDataToObject(form: IFormData): Record<string, FormDataFieldValue | FormDataFieldValue[]>;
+    /**
+     * Culture match case Enum
+     */
+    enum CultureMatch {
+        Exact = 0,
+        Compatible = 1,
+        SamePart = 2,
+        Default = 3
+    }
     /**
      * Get the available culture definition
      * @param items Available cultures
@@ -74,14 +83,14 @@ export declare namespace DomUtils {
          * Current detected culture
          */
         compatibleNames?: string[] | undefined;
-    }>[], culture: string) => Readonly<{
+    }>[], culture: string) => [Readonly<{
         name: string;
         label: string;
         resources: T; /**
          * Current detected culture
          */
         compatibleNames?: string[] | undefined;
-    }> | undefined;
+    }> | undefined, CultureMatch];
     /**
      * Get input value depending on its type
      * @param input HTML input

package/lib/cjs/DomUtils.js

@@ -268,6 +268,16 @@ var DomUtils;
         return dic;
     }
     DomUtils.formDataToObject = formDataToObject;
+    /**
+     * Culture match case Enum
+     */
+    let CultureMatch;
+    (function (CultureMatch) {
+        CultureMatch[CultureMatch["Exact"] = 0] = "Exact";
+        CultureMatch[CultureMatch["Compatible"] = 1] = "Compatible";
+        CultureMatch[CultureMatch["SamePart"] = 2] = "SamePart";
+        CultureMatch[CultureMatch["Default"] = 3] = "Default";
+    })(CultureMatch = DomUtils.CultureMatch || (DomUtils.CultureMatch = {}));
     /**
      * Get the available culture definition
      * @param items Available cultures
@@ -275,12 +285,12 @@ var DomUtils;
      */
     DomUtils.getCulture = (items, culture) => {
         if (items.length === 0) {
-            return undefined;
+            return [undefined, CultureMatch.Exact];
         }
         // Exact match
         const exactMatch = items.find((item) => item.name === culture);
         if (exactMatch)
-            return exactMatch;
+            return [exactMatch, CultureMatch.Exact];
         // Compatible match
         const compatibleMatch = items.find((item) => {
             var _a;
@@ -288,14 +298,14 @@ var DomUtils;
                 culture.startsWith(item + '-');
         });
         if (compatibleMatch)
-            return compatibleMatch;
+            return [compatibleMatch, CultureMatch.Compatible];
         // Same part, like zh-CN and zh-HK
         const samePart = culture.split('-')[0];
         const samePartMatch = items.find((item) => item.name.startsWith(samePart));
         if (samePartMatch)
-            return samePartMatch;
+            return [samePartMatch, CultureMatch.SamePart];
         // Default
-        return items[0];
+        return [items[0], CultureMatch.Default];
     };
     /**
      * Get input value depending on its type

package/lib/cjs/IActionResult.d.ts

@@ -0,0 +1,59 @@
+import { DataTypes } from './DataTypes';
+/**
+ * Result errors
+ * Indexable type
+ */
+export interface IResultErrors {
+    readonly [key: string]: string[];
+}
+/**
+ * Operation result interface
+ */
+export interface IActionResult<D extends object = {}> {
+    /**
+     * Status code
+     */
+    readonly status?: number;
+    /**
+     * Result data
+     */
+    readonly data?: D;
+    /**
+     * Result errors
+     */
+    readonly errors?: IResultErrors;
+    /**
+     * Title
+     */
+    title?: string;
+    /**
+     * Detail
+     */
+    detail?: string;
+    /**
+     * Trace id
+     */
+    traceId?: string;
+    /**
+     * Type
+     */
+    type?: string;
+    /**
+     * Field name
+     */
+    field?: string;
+    /**
+     * Success or not
+     */
+    readonly ok: boolean;
+}
+/**
+ * Action result with id data
+ */
+export type IdActionResult<T extends DataTypes.IdType = number> = IActionResult<{
+    id: T;
+}>;
+/**
+ * Action result with dynamic data
+ */
+export type DynamicActionResult = IActionResult<Record<string, any>>;

package/lib/cjs/IActionResult.js

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

package/lib/mjs/ActionResult.d.ts

@@ -0,0 +1,11 @@
+import { IActionResult } from './IActionResult';
+/**
+ * Action result
+ */
+export declare class ActionResult {
+    /**
+     * Create a result from error
+     * @returns Action result interface
+     */
+    static create<D extends object = {}>(error: Error): IActionResult<D>;
+}

package/lib/mjs/ActionResult.js

@@ -0,0 +1,26 @@
+/**
+ * Action result
+ */
+export class ActionResult {
+    /**
+     * Create a result from error
+     * @returns Action result interface
+     */
+    static create(error) {
+        // If the error has status / statusCode
+        const status = 'status' in error
+            ? error.status
+            : 'statusCode' in error
+                ? error.statusCode
+                : undefined;
+        // Result
+        const result = {
+            status: typeof status === 'number' ? status : undefined,
+            ok: false,
+            type: error.name,
+            title: error.message
+        };
+        // Return
+        return result;
+    }
+}

package/lib/mjs/DomUtils.d.ts

@@ -62,6 +62,15 @@ export declare namespace DomUtils {
      * @returns Object
      */
     function formDataToObject(form: IFormData): Record<string, FormDataFieldValue | FormDataFieldValue[]>;
+    /**
+     * Culture match case Enum
+     */
+    enum CultureMatch {
+        Exact = 0,
+        Compatible = 1,
+        SamePart = 2,
+        Default = 3
+    }
     /**
      * Get the available culture definition
      * @param items Available cultures
@@ -74,14 +83,14 @@ export declare namespace DomUtils {
          * Current detected culture
          */
         compatibleNames?: string[] | undefined;
-    }>[], culture: string) => Readonly<{
+    }>[], culture: string) => [Readonly<{
         name: string;
         label: string;
         resources: T; /**
          * Current detected culture
          */
         compatibleNames?: string[] | undefined;
-    }> | undefined;
+    }> | undefined, CultureMatch];
     /**
      * Get input value depending on its type
      * @param input HTML input

package/lib/mjs/DomUtils.js

@@ -265,6 +265,16 @@ export var DomUtils;
         return dic;
     }
     DomUtils.formDataToObject = formDataToObject;
+    /**
+     * Culture match case Enum
+     */
+    let CultureMatch;
+    (function (CultureMatch) {
+        CultureMatch[CultureMatch["Exact"] = 0] = "Exact";
+        CultureMatch[CultureMatch["Compatible"] = 1] = "Compatible";
+        CultureMatch[CultureMatch["SamePart"] = 2] = "SamePart";
+        CultureMatch[CultureMatch["Default"] = 3] = "Default";
+    })(CultureMatch = DomUtils.CultureMatch || (DomUtils.CultureMatch = {}));
     /**
      * Get the available culture definition
      * @param items Available cultures
@@ -272,12 +282,12 @@ export var DomUtils;
      */
     DomUtils.getCulture = (items, culture) => {
         if (items.length === 0) {
-            return undefined;
+            return [undefined, CultureMatch.Exact];
         }
         // Exact match
         const exactMatch = items.find((item) => item.name === culture);
         if (exactMatch)
-            return exactMatch;
+            return [exactMatch, CultureMatch.Exact];
         // Compatible match
         const compatibleMatch = items.find((item) => {
             var _a;
@@ -285,14 +295,14 @@ export var DomUtils;
                 culture.startsWith(item + '-');
         });
         if (compatibleMatch)
-            return compatibleMatch;
+            return [compatibleMatch, CultureMatch.Compatible];
         // Same part, like zh-CN and zh-HK
         const samePart = culture.split('-')[0];
         const samePartMatch = items.find((item) => item.name.startsWith(samePart));
         if (samePartMatch)
-            return samePartMatch;
+            return [samePartMatch, CultureMatch.SamePart];
         // Default
-        return items[0];
+        return [items[0], CultureMatch.Default];
     };
     /**
      * Get input value depending on its type

package/lib/mjs/IActionResult.d.ts

@@ -0,0 +1,59 @@
+import { DataTypes } from './DataTypes';
+/**
+ * Result errors
+ * Indexable type
+ */
+export interface IResultErrors {
+    readonly [key: string]: string[];
+}
+/**
+ * Operation result interface
+ */
+export interface IActionResult<D extends object = {}> {
+    /**
+     * Status code
+     */
+    readonly status?: number;
+    /**
+     * Result data
+     */
+    readonly data?: D;
+    /**
+     * Result errors
+     */
+    readonly errors?: IResultErrors;
+    /**
+     * Title
+     */
+    title?: string;
+    /**
+     * Detail
+     */
+    detail?: string;
+    /**
+     * Trace id
+     */
+    traceId?: string;
+    /**
+     * Type
+     */
+    type?: string;
+    /**
+     * Field name
+     */
+    field?: string;
+    /**
+     * Success or not
+     */
+    readonly ok: boolean;
+}
+/**
+ * Action result with id data
+ */
+export type IdActionResult<T extends DataTypes.IdType = number> = IActionResult<{
+    id: T;
+}>;
+/**
+ * Action result with dynamic data
+ */
+export type DynamicActionResult = IActionResult<Record<string, any>>;

package/lib/mjs/IActionResult.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.80",
+    "version": "1.1.82",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,17 +54,17 @@
     },
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "devDependencies": {
-        "@types/jest": "^29.2.3",
+        "@types/jest": "^29.2.4",
         "@types/lodash.isequal": "^4.5.6",
-        "@typescript-eslint/eslint-plugin": "^5.45.0",
-        "@typescript-eslint/parser": "^5.45.0",
-        "eslint": "^8.29.0",
+        "@typescript-eslint/eslint-plugin": "^5.46.1",
+        "@typescript-eslint/parser": "^5.46.1",
+        "eslint": "^8.30.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.26.0",
         "jest": "^29.3.1",
         "jest-environment-jsdom": "^29.3.1",
         "ts-jest": "^29.0.3",
-        "typescript": "^4.9.3"
+        "typescript": "^4.9.4"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/ActionResult.ts

@@ -0,0 +1,31 @@
+import { IActionResult } from './IActionResult';
+
+/**
+ * Action result
+ */
+export class ActionResult {
+    /**
+     * Create a result from error
+     * @returns Action result interface
+     */
+    static create<D extends object = {}>(error: Error) {
+        // If the error has status / statusCode
+        const status =
+            'status' in error
+                ? error.status
+                : 'statusCode' in error
+                ? error.statusCode
+                : undefined;
+
+        // Result
+        const result: IActionResult<D> = {
+            status: typeof status === 'number' ? status : undefined,
+            ok: false,
+            type: error.name,
+            title: error.message
+        };
+
+        // Return
+        return result;
+    }
+}

package/src/DomUtils.ts

@@ -307,6 +307,16 @@ export namespace DomUtils {
         return dic;
     }
 
+    /**
+     * Culture match case Enum
+     */
+    export enum CultureMatch {
+        Exact,
+        Compatible,
+        SamePart,
+        Default
+    }
+
     /**
      * Get the available culture definition
      * @param items Available cultures
@@ -315,14 +325,14 @@ export namespace DomUtils {
     export const getCulture = <T extends DataTypes.StringRecord>(
         items: DataTypes.CultureDefinition<T>[],
         culture: string
-    ) => {
+    ): [DataTypes.CultureDefinition<T> | undefined, CultureMatch] => {
         if (items.length === 0) {
-            return undefined;
+            return [undefined, CultureMatch.Exact];
         }
 
         // Exact match
         const exactMatch = items.find((item) => item.name === culture);
-        if (exactMatch) return exactMatch;
+        if (exactMatch) return [exactMatch, CultureMatch.Exact];
 
         // Compatible match
         const compatibleMatch = items.find(
@@ -330,17 +340,17 @@ export namespace DomUtils {
                 item.compatibleNames?.includes(culture) ||
                 culture.startsWith(item + '-')
         );
-        if (compatibleMatch) return compatibleMatch;
+        if (compatibleMatch) return [compatibleMatch, CultureMatch.Compatible];
 
         // Same part, like zh-CN and zh-HK
         const samePart = culture.split('-')[0];
         const samePartMatch = items.find((item) =>
             item.name.startsWith(samePart)
         );
-        if (samePartMatch) return samePartMatch;
+        if (samePartMatch) return [samePartMatch, CultureMatch.SamePart];
 
         // Default
-        return items[0];
+        return [items[0], CultureMatch.Default];
     };
 
     /**

package/src/IActionResult.ts

@@ -0,0 +1,72 @@
+import { DataTypes } from './DataTypes';
+
+/**
+ * Result errors
+ * Indexable type
+ */
+export interface IResultErrors {
+    readonly [key: string]: string[];
+}
+
+/**
+ * Operation result interface
+ */
+export interface IActionResult<D extends object = {}> {
+    /**
+     * Status code
+     */
+    readonly status?: number;
+
+    /**
+     * Result data
+     */
+    readonly data?: D;
+
+    /**
+     * Result errors
+     */
+    readonly errors?: IResultErrors;
+
+    /**
+     * Title
+     */
+    title?: string;
+
+    /**
+     * Detail
+     */
+    detail?: string;
+
+    /**
+     * Trace id
+     */
+    traceId?: string;
+
+    /**
+     * Type
+     */
+    type?: string;
+
+    /**
+     * Field name
+     */
+    field?: string;
+
+    /**
+     * Success or not
+     */
+    readonly ok: boolean;
+}
+
+/**
+ * Action result with id data
+ */
+export type IdActionResult<T extends DataTypes.IdType = number> =
+    IActionResult<{
+        id: T;
+    }>;
+
+/**
+ * Action result with dynamic data
+ */
+export type DynamicActionResult = IActionResult<Record<string, any>>;