@etsoo/shared 1.1.81 → 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
 

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/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/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.81",
+    "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/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>>;