@etsoo/smarterp-core 1.0.85 → 1.0.87

package/__tests__/CoreUtils.ts

@@ -0,0 +1,39 @@
+import { CoreUtils } from "../src";
+
+test("Test for validateJson with string schema", async () => {
+  const schema =
+    '{"type":"object","properties":{"cc":{"type":"array","format":"email","uniqueItems":true},"bcc":{"type":"array","format":"email","uniqueItems":true}}}';
+
+  let [valid, errors] = await CoreUtils.validateJson(schema, "{}");
+  expect(valid).toBeTruthy();
+
+  [valid, errors] = await CoreUtils.validateJson(schema, {
+    cc: ["a@b.com", "a@b.com"]
+  });
+  expect(valid).toBeFalsy();
+  expect(errors?.[0].keyword).toBe("uniqueItems");
+});
+
+test("Test for validateJson with object schema", async () => {
+  const schema = {
+    type: "object",
+    properties: {
+      cc: {
+        type: "array",
+        format: "email",
+        uniqueItems: true
+      },
+      bcc: {
+        type: "array",
+        format: "email",
+        uniqueItems: true
+      }
+    }
+  };
+
+  let [valid, errors] = await CoreUtils.validateJson(schema, {
+    cc: "abc"
+  });
+  expect(valid).toBeFalsy();
+  expect(errors?.[0].keyword).toBe("format");
+});

package/lib/cjs/CoreUtils.d.ts

@@ -1,11 +1,24 @@
+import type { ErrorObject } from "ajv";
 /**
  * Core utilities
  */
 export declare namespace CoreUtils {
     /**
      * Get avatar styles
+     * 获取头像样式
      * @param isOrg Is this an organization avatar?
      * @returns Styles
      */
     function avatarStyles(isOrg?: boolean): React.CSSProperties;
+    /**
+     * Validate JSON input against a schema
+     * 验证 JSON 输入是否符合架构
+     * @param schema JSON schema to validate against
+     * @param input JSON input to validate
+     * @returns Result
+     */
+    function validateJson(schema: string | object, input: string | object | null | undefined): Promise<[
+        boolean,
+        ErrorObject<string, Record<string, any>, unknown>[] | null | undefined
+    ]>;
 }

package/lib/cjs/CoreUtils.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CoreUtils = void 0;
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
 /**
  * Core utilities
  */
@@ -8,6 +12,7 @@ var CoreUtils;
 (function (CoreUtils) {
     /**
      * Get avatar styles
+     * 获取头像样式
      * @param isOrg Is this an organization avatar?
      * @returns Styles
      */
@@ -19,4 +24,27 @@ var CoreUtils;
         };
     }
     CoreUtils.avatarStyles = avatarStyles;
+    let ajv = null;
+    /**
+     * Validate JSON input against a schema
+     * 验证 JSON 输入是否符合架构
+     * @param schema JSON schema to validate against
+     * @param input JSON input to validate
+     * @returns Result
+     */
+    async function validateJson(schema, input) {
+        if (ajv == null) {
+            const AjvClass = (await import("ajv")).Ajv;
+            ajv = new AjvClass({
+                allErrors: true,
+                strictTypes: false
+            });
+            (0, ajv_formats_1.default)(ajv);
+        }
+        return [
+            ajv.validate(typeof schema === "string" ? JSON.parse(schema) : schema, typeof input === "string" ? JSON.parse(input) : input),
+            ajv.errors
+        ];
+    }
+    CoreUtils.validateJson = validateJson;
 })(CoreUtils || (exports.CoreUtils = CoreUtils = {}));

package/lib/cjs/OrgApi.d.ts

@@ -23,6 +23,7 @@ import { OrgUpdateApiRQ } from "./rq/org/OrgUpdateApiRQ";
 import { OrgUpdateApiReadDto } from "./dto/org/OrgUpdateApiReadDto";
 import { OrgQueryApiRQ } from "./rq/org/OrgQueryApiRQ";
 import { OrgQueryApiData } from "./dto/org/OrgQueryApiData";
+import { CoreApiService } from "./dto/org/CoreApiService";
 /**
  * Organization API
  * 机构接口
@@ -133,6 +134,14 @@ export declare class OrgApi extends EntityApi {
      * @returns Result
      */
     read(id: number, payload?: IApiPayload<OrgReadDto>): Promise<OrgReadDto | undefined>;
+    /**
+     * Read API schema
+     * 读取接口架构
+     * @param service API service
+     * @param payload Payload
+     * @returns Result
+     */
+    readApiSchema(service: CoreApiService, payload?: IApiPayload<object>): Promise<object | undefined>;
     /**
      * Get Antiforgery request token
      * 获取反伪造请求令牌

package/lib/cjs/OrgApi.js

@@ -154,6 +154,16 @@ class OrgApi extends appscript_1.EntityApi {
     read(id, payload) {
         return this.readBase(id, payload);
     }
+    /**
+     * Read API schema
+     * 读取接口架构
+     * @param service API service
+     * @param payload Payload
+     * @returns Result
+     */
+    readApiSchema(service, payload) {
+        return this.api.get(`${this.flag}/ReadApiSchema/${service}`, undefined, payload);
+    }
     /**
      * Get Antiforgery request token
      * 获取反伪造请求令牌

package/lib/mjs/CoreUtils.d.ts

@@ -1,11 +1,24 @@
+import type { ErrorObject } from "ajv";
 /**
  * Core utilities
  */
 export declare namespace CoreUtils {
     /**
      * Get avatar styles
+     * 获取头像样式
      * @param isOrg Is this an organization avatar?
      * @returns Styles
      */
     function avatarStyles(isOrg?: boolean): React.CSSProperties;
+    /**
+     * Validate JSON input against a schema
+     * 验证 JSON 输入是否符合架构
+     * @param schema JSON schema to validate against
+     * @param input JSON input to validate
+     * @returns Result
+     */
+    function validateJson(schema: string | object, input: string | object | null | undefined): Promise<[
+        boolean,
+        ErrorObject<string, Record<string, any>, unknown>[] | null | undefined
+    ]>;
 }

package/lib/mjs/CoreUtils.js

@@ -1,3 +1,4 @@
+import addFormats from "ajv-formats";
 /**
  * Core utilities
  */
@@ -5,6 +6,7 @@ export var CoreUtils;
 (function (CoreUtils) {
     /**
      * Get avatar styles
+     * 获取头像样式
      * @param isOrg Is this an organization avatar?
      * @returns Styles
      */
@@ -16,4 +18,27 @@ export var CoreUtils;
         };
     }
     CoreUtils.avatarStyles = avatarStyles;
+    let ajv = null;
+    /**
+     * Validate JSON input against a schema
+     * 验证 JSON 输入是否符合架构
+     * @param schema JSON schema to validate against
+     * @param input JSON input to validate
+     * @returns Result
+     */
+    async function validateJson(schema, input) {
+        if (ajv == null) {
+            const AjvClass = (await import("ajv")).Ajv;
+            ajv = new AjvClass({
+                allErrors: true,
+                strictTypes: false
+            });
+            addFormats(ajv);
+        }
+        return [
+            ajv.validate(typeof schema === "string" ? JSON.parse(schema) : schema, typeof input === "string" ? JSON.parse(input) : input),
+            ajv.errors
+        ];
+    }
+    CoreUtils.validateJson = validateJson;
 })(CoreUtils || (CoreUtils = {}));

package/lib/mjs/OrgApi.d.ts

@@ -23,6 +23,7 @@ import { OrgUpdateApiRQ } from "./rq/org/OrgUpdateApiRQ";
 import { OrgUpdateApiReadDto } from "./dto/org/OrgUpdateApiReadDto";
 import { OrgQueryApiRQ } from "./rq/org/OrgQueryApiRQ";
 import { OrgQueryApiData } from "./dto/org/OrgQueryApiData";
+import { CoreApiService } from "./dto/org/CoreApiService";
 /**
  * Organization API
  * 机构接口
@@ -133,6 +134,14 @@ export declare class OrgApi extends EntityApi {
      * @returns Result
      */
     read(id: number, payload?: IApiPayload<OrgReadDto>): Promise<OrgReadDto | undefined>;
+    /**
+     * Read API schema
+     * 读取接口架构
+     * @param service API service
+     * @param payload Payload
+     * @returns Result
+     */
+    readApiSchema(service: CoreApiService, payload?: IApiPayload<object>): Promise<object | undefined>;
     /**
      * Get Antiforgery request token
      * 获取反伪造请求令牌

package/lib/mjs/OrgApi.js

@@ -151,6 +151,16 @@ export class OrgApi extends EntityApi {
     read(id, payload) {
         return this.readBase(id, payload);
     }
+    /**
+     * Read API schema
+     * 读取接口架构
+     * @param service API service
+     * @param payload Payload
+     * @returns Result
+     */
+    readApiSchema(service, payload) {
+        return this.api.get(`${this.flag}/ReadApiSchema/${service}`, undefined, payload);
+    }
     /**
      * Get Antiforgery request token
      * 获取反伪造请求令牌

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/smarterp-core",
-  "version": "1.0.85",
+  "version": "1.0.87",
   "description": "TypeScript APIs for SmartERP Core",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",
@@ -40,11 +40,11 @@
   "license": "MIT",
   "homepage": "https://github.com/ETSOO/etsoo-smarterp-core#readme",
   "devDependencies": {
-    "@babel/cli": "^7.27.2",
-    "@babel/core": "^7.27.4",
-    "@babel/plugin-transform-runtime": "^7.27.4",
-    "@babel/preset-env": "^7.27.2",
-    "@babel/runtime-corejs3": "^7.27.6",
+    "@babel/cli": "^7.28.0",
+    "@babel/core": "^7.28.0",
+    "@babel/plugin-transform-runtime": "^7.28.0",
+    "@babel/preset-env": "^7.28.0",
+    "@babel/runtime-corejs3": "^7.28.0",
     "@types/react": "^18.3.23",
     "@types/react-dom": "^18.3.7",
     "@vitejs/plugin-react": "^4.6.0",
@@ -54,11 +54,13 @@
   },
   "dependencies": {
     "@etsoo/appscript": "^1.6.41",
-    "@etsoo/materialui": "^1.5.63",
+    "@etsoo/materialui": "^1.5.64",
     "@etsoo/react": "^1.8.49",
     "@etsoo/shared": "^1.2.75",
     "@etsoo/toolpad": "^1.0.40",
-    "@mui/material": "^7.1.2",
+    "@mui/material": "^7.2.0",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   }

package/src/CoreUtils.ts

@@ -1,9 +1,14 @@
+import type Ajv from "ajv";
+import type { ErrorObject } from "ajv";
+import addFormats from "ajv-formats";
+
 /**
  * Core utilities
  */
 export namespace CoreUtils {
   /**
    * Get avatar styles
+   * 获取头像样式
    * @param isOrg Is this an organization avatar?
    * @returns Styles
    */
@@ -14,4 +19,42 @@ export namespace CoreUtils {
       border: "1px solid #666"
     };
   }
+
+  let ajv: Ajv | null = null;
+
+  /**
+   * Validate JSON input against a schema
+   * 验证 JSON 输入是否符合架构
+   * @param schema JSON schema to validate against
+   * @param input JSON input to validate
+   * @returns Result
+   */
+  export async function validateJson(
+    schema: string | object,
+    input: string | object | null | undefined
+  ): Promise<
+    [
+      boolean,
+      ErrorObject<string, Record<string, any>, unknown>[] | null | undefined
+    ]
+  > {
+    if (ajv == null) {
+      const AjvClass = (await import("ajv")).Ajv;
+
+      ajv = new AjvClass({
+        allErrors: true,
+        strictTypes: false
+      });
+
+      addFormats(ajv);
+    }
+
+    return [
+      ajv!.validate(
+        typeof schema === "string" ? JSON.parse(schema) : schema,
+        typeof input === "string" ? JSON.parse(input) : input
+      ),
+      ajv!.errors
+    ];
+  }
 }

package/src/OrgApi.ts

@@ -32,6 +32,7 @@ import { OrgUpdateApiRQ } from "./rq/org/OrgUpdateApiRQ";
 import { OrgUpdateApiReadDto } from "./dto/org/OrgUpdateApiReadDto";
 import { OrgQueryApiRQ } from "./rq/org/OrgQueryApiRQ";
 import { OrgQueryApiData } from "./dto/org/OrgQueryApiData";
+import { CoreApiService } from "./dto/org/CoreApiService";
 
 /**
  * Organization API
@@ -213,6 +214,21 @@ export class OrgApi extends EntityApi {
     return this.readBase(id, payload);
   }
 
+  /**
+   * Read API schema
+   * 读取接口架构
+   * @param service API service
+   * @param payload Payload
+   * @returns Result
+   */
+  readApiSchema(service: CoreApiService, payload?: IApiPayload<object>) {
+    return this.api.get(
+      `${this.flag}/ReadApiSchema/${service}`,
+      undefined,
+      payload
+    );
+  }
+
   /**
    * Get Antiforgery request token
    * 获取反伪造请求令牌