@djvlc/contracts-schemas 1.2.0

package/dist/index.d.mts

@@ -0,0 +1,537 @@
+/**
+ * @djvlc/contracts-schemas - DJV 低代码平台 JSON Schema 定义包
+ *
+ * 提供所有协议的 JSON Schema 定义，用于：
+ * - Editor: 配置表单校验
+ * - Platform: 发布时校验
+ * - Runtime: 运行时校验/降级
+ *
+ * @packageDocumentation
+ */
+declare const pageSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly $id: "https://djvlc.com/schemas/page-schema.json";
+    readonly title: "PageSchema";
+    readonly description: "DJV 低代码平台页面 Schema 定义";
+    readonly type: "object";
+    readonly required: readonly ["schemaVersion", "page", "components"];
+    readonly properties: {
+        readonly schemaVersion: {
+            readonly type: "string";
+            readonly description: "Schema 版本号";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+$";
+        };
+        readonly page: {
+            readonly $ref: "#/definitions/PageConfig";
+        };
+        readonly components: {
+            readonly type: "array";
+            readonly description: "组件实例列表";
+            readonly items: {
+                readonly $ref: "#/definitions/ComponentInstance";
+            };
+        };
+        readonly actionDefVersionIds: {
+            readonly type: "array";
+            readonly description: "绑定的 ActionDefinition 版本 ID";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly dataQueryVersionIds: {
+            readonly type: "array";
+            readonly description: "绑定的 DataQuery 版本 ID";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly definitions: {
+        readonly PageConfig: {
+            readonly type: "object";
+            readonly required: readonly ["id", "title", "canvas"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "页面 ID";
+                };
+                readonly title: {
+                    readonly type: "string";
+                    readonly description: "页面标题";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly description: "页面描述";
+                };
+                readonly canvas: {
+                    readonly $ref: "#/definitions/CanvasConfig";
+                };
+                readonly meta: {
+                    readonly $ref: "#/definitions/PageMeta";
+                };
+                readonly variables: {
+                    readonly type: "object";
+                    readonly description: "页面变量";
+                };
+                readonly apis: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/definitions/ApiConfig";
+                    };
+                };
+            };
+        };
+        readonly CanvasConfig: {
+            readonly type: "object";
+            readonly required: readonly ["type", "width"];
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["h5", "tablet", "pc"];
+                    readonly description: "画布类型";
+                };
+                readonly width: {
+                    readonly type: "number";
+                    readonly description: "画布宽度";
+                };
+                readonly height: {
+                    readonly type: "number";
+                    readonly description: "画布高度";
+                };
+                readonly background: {
+                    readonly type: "string";
+                    readonly description: "背景色";
+                };
+                readonly gridSize: {
+                    readonly type: "number";
+                    readonly description: "网格大小";
+                };
+                readonly showGrid: {
+                    readonly type: "boolean";
+                    readonly description: "是否显示网格";
+                };
+                readonly showRuler: {
+                    readonly type: "boolean";
+                    readonly description: "是否显示标尺";
+                };
+            };
+        };
+        readonly PageMeta: {
+            readonly type: "object";
+            readonly properties: {
+                readonly createTime: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly updateTime: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly author: {
+                    readonly type: "string";
+                };
+                readonly version: {
+                    readonly type: "string";
+                };
+                readonly tags: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly status: {
+                    readonly type: "string";
+                    readonly enum: readonly ["draft", "published"];
+                };
+            };
+        };
+        readonly ApiConfig: {
+            readonly type: "object";
+            readonly required: readonly ["id", "name", "url", "method"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly url: {
+                    readonly type: "string";
+                };
+                readonly method: {
+                    readonly type: "string";
+                    readonly enum: readonly ["GET", "POST", "PUT", "DELETE", "PATCH"];
+                };
+                readonly headers: {
+                    readonly type: "object";
+                };
+                readonly params: {
+                    readonly type: "object";
+                };
+                readonly body: {
+                    readonly type: "object";
+                };
+                readonly timeout: {
+                    readonly type: "number";
+                };
+                readonly autoRun: {
+                    readonly type: "boolean";
+                };
+                readonly dependencies: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly ComponentInstance: {
+            readonly type: "object";
+            readonly required: readonly ["id", "type", "props", "style"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "组件实例 ID";
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly description: "组件类型";
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly description: "组件名称";
+                };
+                readonly props: {
+                    readonly type: "object";
+                    readonly description: "组件属性";
+                };
+                readonly style: {
+                    readonly type: "object";
+                    readonly description: "组件样式";
+                };
+                readonly layout: {
+                    readonly $ref: "#/definitions/ComponentLayout";
+                };
+                readonly events: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/definitions/ComponentEvent";
+                    };
+                };
+                readonly visible: {
+                    readonly type: "boolean";
+                };
+                readonly locked: {
+                    readonly type: "boolean";
+                };
+                readonly children: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/definitions/ComponentInstance";
+                    };
+                };
+            };
+        };
+        readonly ComponentLayout: {
+            readonly type: "object";
+            readonly properties: {
+                readonly x: {
+                    readonly type: "number";
+                };
+                readonly y: {
+                    readonly type: "number";
+                };
+                readonly width: {
+                    readonly type: "number";
+                };
+                readonly height: {
+                    readonly type: "number";
+                };
+                readonly rotation: {
+                    readonly type: "number";
+                };
+            };
+        };
+        readonly ComponentEvent: {
+            readonly type: "object";
+            readonly required: readonly ["id", "trigger", "actions"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly trigger: {
+                    readonly type: "string";
+                };
+                readonly actions: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/definitions/EventAction";
+                    };
+                };
+                readonly enabled: {
+                    readonly type: "boolean";
+                };
+                readonly condition: {
+                    readonly type: "string";
+                };
+                readonly debounce: {
+                    readonly type: "number";
+                };
+                readonly throttle: {
+                    readonly type: "number";
+                };
+            };
+        };
+        readonly EventAction: {
+            readonly type: "object";
+            readonly required: readonly ["id", "type", "params"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly type: {
+                    readonly type: "string";
+                };
+                readonly params: {
+                    readonly type: "object";
+                };
+                readonly enabled: {
+                    readonly type: "boolean";
+                };
+                readonly delay: {
+                    readonly type: "number";
+                };
+            };
+        };
+    };
+};
+declare const componentMetaSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly $id: "https://djvlc.com/schemas/component-meta.json";
+    readonly title: "ComponentMeta";
+    readonly description: "DJV 低代码平台组件元数据 Schema 定义";
+    readonly type: "object";
+    readonly required: readonly ["name", "version", "label", "category", "props", "events", "capabilities", "compat", "integrity", "status", "entry"];
+    readonly properties: {
+        readonly name: {
+            readonly type: "string";
+            readonly description: "组件名称";
+            readonly pattern: "^[a-z][a-z0-9-]*$";
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly description: "版本号 (semver)";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.]+)?$";
+        };
+        readonly label: {
+            readonly type: "string";
+            readonly description: "显示名称";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "组件描述";
+        };
+        readonly icon: {
+            readonly type: "string";
+            readonly description: "组件图标";
+        };
+        readonly category: {
+            readonly type: "string";
+            readonly enum: readonly ["basic", "form", "layout", "navigation", "feedback", "display", "data", "business", "chart", "other"];
+            readonly description: "组件分类";
+        };
+        readonly tags: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "组件标签";
+        };
+        readonly author: {
+            readonly type: "string";
+            readonly description: "组件作者";
+        };
+        readonly props: {
+            readonly type: "object";
+            readonly description: "属性定义";
+        };
+        readonly events: {
+            readonly type: "object";
+            readonly description: "事件定义";
+        };
+        readonly capabilities: {
+            readonly type: "object";
+            readonly description: "能力声明";
+        };
+        readonly compat: {
+            readonly type: "object";
+            readonly description: "兼容性";
+        };
+        readonly integrity: {
+            readonly type: "object";
+            readonly description: "完整性校验";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["draft", "canary", "stable", "deprecated", "blocked"];
+            readonly description: "组件状态";
+        };
+        readonly preview: {
+            readonly type: "string";
+            readonly description: "预览图 URL";
+        };
+        readonly entry: {
+            readonly type: "string";
+            readonly description: "入口文件路径";
+        };
+        readonly styles: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "样式文件路径";
+        };
+    };
+};
+declare const actionSpecSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly $id: "https://djvlc.com/schemas/action-spec.json";
+    readonly title: "ActionDefinition";
+    readonly description: "DJV 低代码平台 Action 定义 Schema";
+    readonly type: "object";
+    readonly required: readonly ["id", "name", "actionType", "paramsSchema", "requiresAuth", "version", "status"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "动作 ID";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "动作名称";
+        };
+        readonly actionType: {
+            readonly type: "string";
+            readonly description: "动作类型";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "动作描述";
+        };
+        readonly paramsSchema: {
+            readonly type: "object";
+            readonly description: "参数 Schema";
+        };
+        readonly responseSchema: {
+            readonly type: "object";
+            readonly description: "响应 Schema";
+        };
+        readonly requiresAuth: {
+            readonly type: "boolean";
+            readonly description: "是否需要认证";
+        };
+        readonly idempotencyRule: {
+            readonly type: "object";
+            readonly description: "幂等规则";
+        };
+        readonly rateLimitRule: {
+            readonly type: "object";
+            readonly description: "频控规则";
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly description: "版本号";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+$";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["active", "deprecated", "disabled"];
+            readonly description: "状态";
+        };
+    };
+};
+declare const dataQuerySpecSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly $id: "https://djvlc.com/schemas/data-query-spec.json";
+    readonly title: "DataQueryDefinition";
+    readonly description: "DJV 低代码平台 Data Query 定义 Schema";
+    readonly type: "object";
+    readonly required: readonly ["id", "name", "sourceType", "sourceConfig", "paramsSchema", "responseSchema", "version", "status"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "查询 ID";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "查询名称";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "查询描述";
+        };
+        readonly sourceType: {
+            readonly type: "string";
+            readonly enum: readonly ["api", "database", "cache", "custom"];
+            readonly description: "数据源类型";
+        };
+        readonly sourceConfig: {
+            readonly type: "object";
+            readonly description: "数据源配置";
+        };
+        readonly paramsSchema: {
+            readonly type: "object";
+            readonly description: "参数 Schema";
+        };
+        readonly responseSchema: {
+            readonly type: "object";
+            readonly description: "响应 Schema";
+        };
+        readonly allowedFields: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "字段白名单";
+        };
+        readonly maskRules: {
+            readonly type: "array";
+            readonly description: "脱敏规则";
+        };
+        readonly cacheConfig: {
+            readonly type: "object";
+            readonly description: "缓存配置";
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly description: "版本号";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+$";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["active", "deprecated", "disabled"];
+            readonly description: "状态";
+        };
+    };
+};
+declare const SCHEMA_VERSIONS: {
+    readonly pageSchema: "1.0.0";
+    readonly componentMeta: "1.0.0";
+    readonly actionSpec: "1.0.0";
+    readonly dataQuerySpec: "1.0.0";
+};
+interface SchemaMetadata {
+    name: string;
+    version: string;
+    description: string;
+    schema: object;
+}
+/**
+ * 获取所有 Schema 的元数据
+ */
+declare function getAllSchemas(): SchemaMetadata[];
+/**
+ * 根据名称获取 Schema
+ */
+declare function getSchemaByName(name: 'page-schema' | 'component-meta' | 'action-spec' | 'data-query-spec'): object;
+
+export { SCHEMA_VERSIONS, type SchemaMetadata, actionSpecSchema, componentMetaSchema, dataQuerySpecSchema, getAllSchemas, getSchemaByName, pageSchema };