@coding-form/form-engine 0.0.1

package/dist/types/view.d.ts

@@ -0,0 +1,80 @@
+import { DataType } from "./types";
+import { FormInstance } from "../instance";
+import { FormEvent, FormFieldValidator } from "./";
+/**
+ *  附加属性
+ */
+export interface FieldAttribute {
+    key: string;
+    label?: string;
+    value?: string;
+}
+/**
+ *  流程表单字段元数据
+ */
+export interface FormField {
+    id: string;
+    name: string;
+    code: string;
+    type: string;
+    dataType: DataType;
+    hidden: boolean;
+    required: boolean;
+    defaultValue?: string;
+    placeholder?: string;
+    tooltip?: string;
+    help?: string;
+    attributes?: FieldAttribute[];
+}
+/**
+ * 流程表单元数据
+ */
+export interface FormMeta {
+    name: string;
+    code: string;
+    fields: FormField[];
+    subForms?: FormMeta[];
+}
+/**
+ *  字段唯一标识
+ */
+export interface FieldCode {
+    /** 表单code **/
+    formCode?: string;
+    /** 字段code **/
+    fieldCode: string;
+}
+/**
+ *  表单布局
+ */
+export interface FormLayout {
+    /** 所属表单 **/
+    formCode: string;
+    /** 布局类型 **/
+    type: string;
+    /** 表单属性 **/
+    props: any;
+}
+/**
+ *  字段唯一标识
+ */
+export type FieldKey = string | FieldCode;
+/**
+ * 表单视图属性
+ */
+export interface FormViewProps {
+    /** 表单定义 **/
+    meta: FormMeta;
+    /** 表单操控对象 */
+    form?: FormInstance;
+    /** 表单数据更新事件 */
+    onValuesChange?: (values: any) => void;
+    /** 是否预览模式 */
+    review?: boolean;
+    /** 字段校验逻辑 */
+    validators?: FormFieldValidator[];
+    /** 事件定义 **/
+    events?: FormEvent[];
+    /** 布局控制 **/
+    layouts?: FormLayout[];
+}

package/dist/validate/index.d.ts

@@ -0,0 +1,15 @@
+import { FieldKey, FormFieldValidator } from "../types";
+import { FormInstance } from "../instance";
+import { FormMeta } from "../types";
+export declare class FormValidate {
+    private readonly meta;
+    private readonly instance;
+    private readonly validators;
+    private readonly formList;
+    constructor(meta: FormMeta, instance: FormInstance, validators: FormFieldValidator[]);
+    private getFormField;
+    private supportValidator;
+    getValidatorRules(fieldKey: FieldKey): {
+        validator: (rule: any, value: any, callback: any) => Promise<undefined>;
+    }[];
+}

package/dist/validate/index.js

@@ -0,0 +1,53 @@
+class FormValidate {
+    meta;
+    instance;
+    validators;
+    formList;
+    constructor(meta, instance, validators){
+        this.meta = meta;
+        this.instance = instance;
+        this.validators = validators;
+        this.formList = [];
+        this.formList.push(meta);
+        const subForms = meta.subForms || [];
+        for (const subForm of subForms)this.formList.push(subForm);
+    }
+    getFormField(fieldKey) {
+        if ("string" == typeof fieldKey) {
+            const fields = this.meta.fields;
+            for (const field of fields)if (field.code === fieldKey) return field;
+        } else {
+            const fieldCode = fieldKey;
+            for (const subForm of this.formList)if (subForm.code === fieldCode.formCode) {
+                const fields = subForm.fields;
+                for (const field of fields)if (field.code === fieldCode.fieldCode) return field;
+            }
+        }
+    }
+    supportValidator(fieldKey, validator) {
+        if (validator.target === fieldKey) return true;
+        if ("string" == typeof validator.target && "string" == typeof fieldKey) return validator.target === fieldKey;
+        if ("string" == typeof validator.target && "string" != typeof fieldKey) {
+            const fieldCode = fieldKey;
+            return validator.target === fieldCode.fieldCode;
+        }
+        if ("string" != typeof validator.target && "string" == typeof fieldKey) {
+            const targetField = validator.target;
+            if (!targetField.formCode) return targetField.fieldCode = fieldKey;
+        }
+        return false;
+    }
+    getValidatorRules(fieldKey) {
+        const rules = [];
+        const formField = this.getFormField(fieldKey);
+        if (formField && formField.hidden) return [];
+        for (const validator of this.validators)if (this.supportValidator(fieldKey, validator)) rules.push({
+            validator: async (rule, value, callback)=>{
+                const res = validator.validator(this.instance, value);
+                if (true !== res) return Promise.reject(new Error(res));
+            }
+        });
+        return rules;
+    }
+}
+export { FormValidate };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@coding-form/form-engine",
+  "version": "0.0.1",
+  "description": "form-engine components",
+  "keywords": [
+    "coding-flow",
+    "flow-engine"
+  ],
+  "homepage": "https://github.com/codingapi/form-engine",
+  "bugs": {
+    "url": "https://github.com/codingapi/form-engine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/codingapi/form-engine.git"
+  },
+  "license": "Apache-2.0",
+  "author": "1024lorne@gmail.com",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@reduxjs/toolkit": "^2.11.2",
+    "react-redux": "^9.2.0"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "push": "pnpm run build && pnpm publish --access public"
+  }
+}