@pactor-app/schema 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pactor Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# @pactor-app/schema
+
+[Pactor](https://github.com/426-330/pactor) 的 Schema 校验包：DSL 版本常量、Page DSL 与 DslNode 的 JSON Schema、基于 Ajv 的结构化校验器。
+
+## 安装
+
+```bash
+npm install @pactor-app/schema
+# 或
+pnpm add @pactor-app/schema
+```
+
+## 示例
+
+```ts
+import { DSL_VERSION, validatePageDsl } from '@pactor-app/schema';
+
+DSL_VERSION; // "1.0"
+
+const result = validatePageDsl(pageDsl);
+if (!result.valid) {
+  for (const error of result.errors) {
+    // { path: "/page/id", message: "...", keyword: "required" }
+    console.error(`${error.path}: ${error.message} (${error.keyword})`);
+  }
+}
+```
+
+特点：
+
+- 结构化错误（不暴露 Ajv 原始错误对象），`required` 错误路径精确到缺失字段
+- `allErrors` 模式，一次返回全部错误
+- `body` 及任意深度 `children` 递归校验
+- JSON Schema 可导出复用（服务端 / CLI 校验）
+
+## 文档
+
+完整文档见 <https://github.com/426-330/pactor/tree/main/docs>（`pnpm docs:dev` 本地启动文档站）。
+
+## License
+
+[MIT](../../LICENSE)

package/dist/index.cjs

@@ -0,0 +1,281 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ACTION_CONFIG_SCHEMA_ID: () => ACTION_CONFIG_SCHEMA_ID,
+  DSL_NODE_SCHEMA_ID: () => DSL_NODE_SCHEMA_ID,
+  DSL_VERSION: () => DSL_VERSION,
+  PAGE_DSL_SCHEMA_ID: () => PAGE_DSL_SCHEMA_ID,
+  actionConfigSchema: () => actionConfigSchema,
+  dslNodeSchema: () => dslNodeSchema,
+  pageDslSchema: () => pageDslSchema,
+  validatePageDsl: () => validatePageDsl
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/version.ts
+var DSL_VERSION = "1.0";
+
+// src/schemas/dsl-node.ts
+var ACTION_CONFIG_SCHEMA_ID = "pactor:action-config";
+var DSL_NODE_SCHEMA_ID = "pactor:dsl-node";
+var permissionSchema = {
+  anyOf: [
+    { type: "string", minLength: 1 },
+    { type: "array", items: { type: "string", minLength: 1 } },
+    {
+      type: "object",
+      required: ["code"],
+      properties: {
+        code: {
+          anyOf: [
+            { type: "string", minLength: 1 },
+            { type: "array", items: { type: "string", minLength: 1 } }
+          ]
+        },
+        denied: { enum: ["hidden", "disabled", "readonly"] }
+      },
+      additionalProperties: false
+    }
+  ]
+};
+var conditionSchema = {
+  anyOf: [
+    { type: "string" },
+    {
+      type: "object",
+      required: ["expression"],
+      properties: {
+        expression: { type: "string" }
+      },
+      additionalProperties: false
+    }
+  ]
+};
+var actionConfigSchema = {
+  $id: ACTION_CONFIG_SCHEMA_ID,
+  type: "object",
+  required: ["action"],
+  properties: {
+    id: { type: "string", minLength: 1 },
+    action: { type: "string", minLength: 1 },
+    params: { type: "object" },
+    condition: conditionSchema,
+    permission: permissionSchema
+  },
+  additionalProperties: false
+};
+var actionOrArraySchema = {
+  anyOf: [
+    { $ref: ACTION_CONFIG_SCHEMA_ID },
+    { type: "array", items: { $ref: ACTION_CONFIG_SCHEMA_ID } }
+  ]
+};
+var dslNodeSchema = {
+  $id: DSL_NODE_SCHEMA_ID,
+  type: "object",
+  required: ["type"],
+  properties: {
+    id: { type: "string" },
+    type: { type: "string", minLength: 1 },
+    props: { type: "object" },
+    children: {
+      type: "array",
+      items: { $ref: DSL_NODE_SCHEMA_ID }
+    },
+    events: {
+      type: "object",
+      additionalProperties: actionOrArraySchema
+    },
+    permission: permissionSchema,
+    when: conditionSchema
+  },
+  additionalProperties: false
+};
+
+// src/schemas/page-dsl.ts
+var PAGE_DSL_SCHEMA_ID = "pactor:page-dsl";
+var permissionSchema2 = {
+  anyOf: [
+    { type: "string", minLength: 1 },
+    { type: "array", items: { type: "string", minLength: 1 } },
+    {
+      type: "object",
+      required: ["code"],
+      properties: {
+        code: {
+          anyOf: [
+            { type: "string", minLength: 1 },
+            { type: "array", items: { type: "string", minLength: 1 } }
+          ]
+        },
+        denied: { enum: ["hidden", "disabled", "readonly"] }
+      },
+      additionalProperties: false
+    }
+  ]
+};
+var actionOrArraySchema2 = {
+  anyOf: [
+    { $ref: ACTION_CONFIG_SCHEMA_ID },
+    { type: "array", items: { $ref: ACTION_CONFIG_SCHEMA_ID } }
+  ]
+};
+var dataSourceSchema = {
+  type: "object",
+  required: ["type"],
+  properties: {
+    type: { enum: ["http", "service", "static", "computed", "resource"] },
+    service: { type: "string", minLength: 1 },
+    autoLoad: { type: "boolean" },
+    params: { type: "object" },
+    request: {
+      type: "object",
+      required: ["url"],
+      properties: {
+        method: { type: "string" },
+        url: { type: "string", minLength: 1 },
+        params: { type: "object" },
+        headers: { type: "object", additionalProperties: { type: "string" } },
+        body: true
+      },
+      additionalProperties: false
+    },
+    pagination: {
+      type: "object",
+      properties: {
+        page: true,
+        pageSize: true
+      },
+      additionalProperties: false
+    },
+    value: true
+  },
+  additionalProperties: false
+};
+var pageDslSchema = {
+  $id: PAGE_DSL_SCHEMA_ID,
+  type: "object",
+  required: ["dsl", "page"],
+  properties: {
+    /** DSL Specification Version，如 "1.0" */
+    dsl: { type: "string", minLength: 1 },
+    requires: {
+      type: "object",
+      properties: {
+        /** Runtime 版本范围（semver range 字符串），如 ">=1.0.0" */
+        runtime: { type: "string", minLength: 1 },
+        /** 组件 API 版本要求：组件名 → semver range 字符串 */
+        components: {
+          type: "object",
+          additionalProperties: { type: "string", minLength: 1 }
+        }
+      },
+      additionalProperties: false
+    },
+    page: {
+      type: "object",
+      required: ["id"],
+      properties: {
+        id: { type: "string", minLength: 1 },
+        title: { type: "string" },
+        type: { type: "string" },
+        permission: permissionSchema2
+      },
+      additionalProperties: false
+    },
+    state: { type: "object" },
+    dataSources: {
+      type: "object",
+      additionalProperties: dataSourceSchema
+    },
+    lifecycle: {
+      type: "object",
+      properties: {
+        onInit: actionOrArraySchema2,
+        onLoad: actionOrArraySchema2,
+        onReady: actionOrArraySchema2,
+        onShow: actionOrArraySchema2,
+        onHide: actionOrArraySchema2,
+        onDestroy: actionOrArraySchema2
+      },
+      additionalProperties: false
+    },
+    body: { $ref: DSL_NODE_SCHEMA_ID }
+  },
+  additionalProperties: false
+};
+
+// src/validate.ts
+var import_ajv = __toESM(require("ajv"), 1);
+var ajv = new import_ajv.default({ allErrors: true, strict: false });
+ajv.addSchema(actionConfigSchema);
+ajv.addSchema(dslNodeSchema);
+ajv.addSchema(pageDslSchema);
+function toStructuredErrors(errors) {
+  return errors.map((error) => {
+    let path = error.instancePath || "/";
+    if (error.keyword === "required") {
+      const missing = error.params.missingProperty;
+      if (missing) {
+        path = `${path === "/" ? "" : path}/${missing}`;
+      }
+    }
+    return {
+      path,
+      message: error.message ?? "invalid",
+      keyword: error.keyword
+    };
+  });
+}
+function getValidator() {
+  const validate = ajv.getSchema(PAGE_DSL_SCHEMA_ID);
+  if (!validate) {
+    throw new Error(`schema not registered: ${PAGE_DSL_SCHEMA_ID}`);
+  }
+  return validate;
+}
+function validatePageDsl(document) {
+  const validate = getValidator();
+  const valid = validate(document);
+  return { valid, errors: valid ? [] : toStructuredErrors(validate.errors ?? []) };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ACTION_CONFIG_SCHEMA_ID,
+  DSL_NODE_SCHEMA_ID,
+  DSL_VERSION,
+  PAGE_DSL_SCHEMA_ID,
+  actionConfigSchema,
+  dslNodeSchema,
+  pageDslSchema,
+  validatePageDsl
+});