scaffold-engine 0.1.0

package/specs/projects/pattern-examples/document-lines-demo.yaml

@@ -0,0 +1,125 @@
+meta:
+  domain: demo
+  object: requestOrder
+  label: 申请单
+  pattern: documentLines
+  version: 0.1.0
+  description: 用于验证 documentLines 模式生成效果的最小示例。
+
+data:
+  table: demo_request_order
+  fields:
+    - name: documentNo
+      label: 单据编号
+      type: string
+      required: true
+      unique: true
+    - name: documentTitle
+      label: 单据标题
+      type: string
+      required: true
+    - name: bizDate
+      label: 业务日期
+      type: date
+      required: true
+    - name: status
+      label: 状态
+      type: enum
+      options: [draft, active, closed]
+      default: draft
+  children:
+    - name: lines
+      label: 明细行
+      table: demo_request_order_line
+      foreignKey: documentId
+      fields:
+        - name: lineNo
+          label: 行号
+          type: string
+          required: true
+        - name: itemCode
+          label: 项目编码
+          type: string
+          required: true
+        - name: itemName
+          label: 项目名称
+          type: string
+          required: true
+        - name: quantity
+          label: 数量
+          type: number
+          required: true
+        - name: unitPrice
+          label: 单价
+          type: number
+        - name: amount
+          label: 金额
+          type: number
+
+app:
+  actions: [create, update, list, detail, submit, approve, reject]
+  defaultStatus: draft
+  responseContract:
+    envelope: standard
+    listSchema: pagedList
+    detailSchema: object
+    mutationSchema: object
+  permissionProfile:
+    mode: inherit
+    resourceScope: document
+    actionPolicies:
+      - action: create
+        permission: create
+      - action: update
+        permission: update
+      - action: list
+        permission: list
+      - action: detail
+        permission: detail
+      - action: submit
+        permission: submit
+      - action: approve
+        permission: approve
+      - action: reject
+        permission: reject
+  statusFlow:
+    enabled: true
+    states: [draft, submitted, approved, rejected]
+    transitions:
+      - action: submit
+        from: [draft, rejected]
+        to: submitted
+      - action: approve
+        from: [submitted]
+        to: approved
+      - action: reject
+        from: [submitted]
+        to: rejected
+  validationRules:
+    - name: statusTransition
+      scope: workflow
+      rule: statusTransition
+      fields: [status]
+      message: 状态流转必须符合既定规则
+  errorCodes:
+    - code: VALIDATION_FAILED
+      message: 输入校验失败
+    - code: RECORD_NOT_FOUND
+      message: 单据不存在
+    - code: DUPLICATE_KEY
+      message: 单据编号已存在
+    - code: INVALID_STATUS_TRANSITION
+      message: 当前状态不允许执行该动作
+
+ui:
+  list:
+    columns: [documentNo, documentTitle, bizDate, status, createdAt]
+    filters: [documentNo, documentTitle, status]
+  form:
+    groups:
+      - title: 基本信息
+        fields: [documentNo, documentTitle, bizDate, status]
+      - title: 明细行
+        childTable: lines
+  detail:
+    sections: [basicInfo, lines]

package/specs/projects/pattern-examples/tree-entity-demo.yaml

@@ -0,0 +1,79 @@
+meta:
+  domain: demo
+  object: categoryNode
+  label: 分类节点
+  pattern: treeEntity
+  version: 0.1.0
+  description: 用于验证 treeEntity 模式生成效果的最小示例。
+
+data:
+  table: demo_category_node
+  fields:
+    - name: categoryCode
+      label: 节点编码
+      type: string
+      required: true
+      unique: true
+    - name: categoryName
+      label: 节点名称
+      type: string
+      required: true
+    - name: parentId
+      label: 父节点ID
+      type: integer
+    - name: parentName
+      label: 父节点名称
+      type: string
+    - name: sortOrder
+      label: 排序号
+      type: integer
+    - name: status
+      label: 状态
+      type: enum
+      options: [active, inactive]
+      default: active
+
+app:
+  actions: [create, update, list, detail]
+  defaultStatus: active
+  responseContract:
+    envelope: standard
+    listSchema: pagedList
+    detailSchema: object
+    mutationSchema: object
+  permissionProfile:
+    mode: inherit
+    resourceScope: object
+    actionPolicies:
+      - action: create
+        permission: create
+      - action: update
+        permission: update
+      - action: list
+        permission: list
+      - action: detail
+        permission: detail
+  validationRules:
+    - name: uniqueCategoryCode
+      scope: service
+      rule: unique
+      fields: [categoryCode]
+      message: 节点编码必须唯一
+  errorCodes:
+    - code: VALIDATION_FAILED
+      message: 输入校验失败
+    - code: RECORD_NOT_FOUND
+      message: 节点不存在
+    - code: DUPLICATE_KEY
+      message: 节点编码已存在
+
+ui:
+  list:
+    columns: [categoryCode, categoryName, parentName, sortOrder, status, createdAt]
+    filters: [categoryCode, categoryName, parentName, status]
+  form:
+    groups:
+      - title: 基本信息
+        fields: [categoryCode, categoryName, parentId, parentName, sortOrder, status]
+  detail:
+    sections: [basicInfo]

package/specs/rules/business-model.schema.json

@@ -0,0 +1,262 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://aiko-boot.local/scaffold/business-model.schema.json",
+  "title": "BusinessModelSpec",
+  "type": "object",
+  "required": ["meta", "data", "app", "ui"],
+  "additionalProperties": false,
+  "properties": {
+    "meta": {
+      "type": "object",
+      "required": ["domain", "object", "label", "version"],
+      "additionalProperties": false,
+      "properties": {
+        "domain": { "type": "string", "minLength": 1 },
+        "object": { "type": "string", "minLength": 1 },
+        "label": { "type": "string", "minLength": 1 },
+        "pattern": { "type": "string", "minLength": 1 },
+        "version": { "type": "string", "minLength": 1 },
+        "description": { "type": "string" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "required": ["table", "fields"],
+      "additionalProperties": false,
+      "properties": {
+        "table": { "type": "string", "minLength": 1 },
+        "fields": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/field" }
+        },
+        "children": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/childTable" }
+        }
+      }
+    },
+    "app": {
+      "type": "object",
+      "required": ["actions"],
+      "additionalProperties": false,
+      "properties": {
+        "actions": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "enum": ["create", "update", "detail", "list", "activate", "deactivate", "submit", "approve", "reject", "close", "archive", "convert"]
+          }
+        },
+        "defaultStatus": { "type": "string" },
+        "statusFlow": { "$ref": "#/$defs/statusFlow" },
+        "responseContract": { "$ref": "#/$defs/responseContract" },
+        "permissionProfile": { "$ref": "#/$defs/permissionProfile" },
+        "validationRules": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/validationRule" }
+        },
+        "errorCodes": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/errorCode" }
+        }
+      }
+    },
+    "ui": {
+      "type": "object",
+      "required": ["list", "form", "detail"],
+      "additionalProperties": false,
+      "properties": {
+        "list": {
+          "type": "object",
+          "required": ["columns", "filters"],
+          "additionalProperties": false,
+          "properties": {
+            "columns": {
+              "type": "array",
+              "items": { "type": "string", "minLength": 1 }
+            },
+            "filters": {
+              "type": "array",
+              "items": { "type": "string", "minLength": 1 }
+            }
+          }
+        },
+        "form": {
+          "type": "object",
+          "required": ["groups"],
+          "additionalProperties": false,
+          "properties": {
+            "groups": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "object",
+                "required": ["title"],
+                "additionalProperties": false,
+                "properties": {
+                  "title": { "type": "string", "minLength": 1 },
+                  "fields": {
+                    "type": "array",
+                    "items": { "type": "string", "minLength": 1 }
+                  },
+                  "childTable": { "type": "string", "minLength": 1 }
+                }
+              }
+            }
+          }
+        },
+        "detail": {
+          "type": "object",
+          "required": ["sections"],
+          "additionalProperties": false,
+          "properties": {
+            "sections": {
+              "type": "array",
+              "minItems": 1,
+              "items": { "type": "string", "minLength": 1 }
+            }
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "field": {
+      "type": "object",
+      "required": ["name", "type"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "type": {
+          "type": "string",
+          "enum": ["string", "text", "enum", "boolean", "integer", "number", "decimal", "date", "datetime"]
+        },
+        "label": { "type": "string" },
+        "required": { "type": "boolean" },
+        "unique": { "type": "boolean" },
+        "default": {
+          "oneOf": [
+            { "type": "string" },
+            { "type": "number" },
+            { "type": "boolean" }
+          ]
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "type": "string" },
+              { "type": "number" }
+            ]
+          }
+        },
+        "column": { "type": "string" }
+      }
+    },
+    "childTable": {
+      "type": "object",
+      "required": ["name", "table", "foreignKey", "fields"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "table": { "type": "string", "minLength": 1 },
+        "foreignKey": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "fields": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/field" }
+        }
+      }
+    },
+    "statusFlow": {
+      "type": "object",
+      "required": ["enabled", "states", "transitions"],
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "states": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "transitions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["action", "from", "to"],
+            "additionalProperties": false,
+            "properties": {
+              "action": { "type": "string", "minLength": 1 },
+              "from": {
+                "type": "array",
+                "minItems": 1,
+                "items": { "type": "string", "minLength": 1 }
+              },
+              "to": { "type": "string", "minLength": 1 }
+            }
+          }
+        }
+      }
+    },
+    "errorCode": {
+      "type": "object",
+      "required": ["code", "message"],
+      "additionalProperties": false,
+      "properties": {
+        "code": { "type": "string", "minLength": 1 },
+        "message": { "type": "string", "minLength": 1 }
+      }
+    },
+    "responseContract": {
+      "type": "object",
+      "required": ["envelope", "listSchema", "detailSchema", "mutationSchema"],
+      "additionalProperties": false,
+      "properties": {
+        "envelope": { "type": "string", "enum": ["standard", "raw"] },
+        "listSchema": { "type": "string", "enum": ["pagedList", "list"] },
+        "detailSchema": { "type": "string", "enum": ["object", "detail"] },
+        "mutationSchema": { "type": "string", "enum": ["object", "mutationResult", "void"] }
+      }
+    },
+    "permissionProfile": {
+      "type": "object",
+      "required": ["mode", "resourceScope", "actionPolicies"],
+      "additionalProperties": false,
+      "properties": {
+        "mode": { "type": "string", "enum": ["inherit", "custom"] },
+        "resourceScope": { "type": "string", "minLength": 1 },
+        "actionPolicies": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["action", "permission"],
+            "additionalProperties": false,
+            "properties": {
+              "action": { "type": "string", "minLength": 1 },
+              "permission": { "type": "string", "minLength": 1 },
+              "condition": { "type": "string" }
+            }
+          }
+        }
+      }
+    },
+    "validationRule": {
+      "type": "object",
+      "required": ["name", "scope", "rule", "message"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "scope": { "type": "string", "enum": ["form", "service", "workflow"] },
+        "rule": { "type": "string", "minLength": 1 },
+        "fields": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "message": { "type": "string", "minLength": 1 }
+      }
+    }
+  }
+}

package/specs/rules/extension-boundaries.json

@@ -0,0 +1,26 @@
+{
+  "reservedTables": [
+    "sys_user",
+    "sys_role",
+    "sys_menu",
+    "sys_user_role",
+    "sys_role_menu"
+  ],
+  "reservedTablePrefixes": [
+    "sys_"
+  ],
+  "protectedDomains": [
+    "system",
+    "auth"
+  ],
+  "protectedMetaObjects": [
+    "user",
+    "role",
+    "menu"
+  ],
+  "systemFields": [
+    "id",
+    "createdAt",
+    "updatedAt"
+  ]
+}

package/specs/rules/requirement-draft.schema.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://aiko-boot.local/scaffold/requirement-draft.schema.json",
+  "title": "RequirementDraft",
+  "type": "object",
+  "required": ["contractVersion", "kind", "id", "status", "rawRequirement", "analysis", "draftModel", "history"],
+  "additionalProperties": false,
+  "properties": {
+    "contractVersion": { "type": "string", "minLength": 1 },
+    "kind": { "type": "string", "const": "requirementDraft" },
+    "id": { "type": "string", "minLength": 1 },
+    "status": {
+      "type": "string",
+      "enum": ["analyzed", "clarifying", "validated", "generated", "failed"]
+    },
+    "rawRequirement": { "type": "string", "minLength": 1 },
+    "analysis": {
+      "type": "object",
+      "required": ["decision", "nextAction", "status"],
+      "additionalProperties": true,
+      "properties": {
+        "decision": { "type": "string", "minLength": 1 },
+        "nextAction": { "type": "string", "minLength": 1 },
+        "status": { "type": "string", "minLength": 1 }
+      }
+    },
+    "draftModel": {
+      "oneOf": [
+        { "type": "object" },
+        { "type": "null" }
+      ]
+    },
+    "validation": {
+      "oneOf": [
+        { "type": "object" },
+        { "type": "null" }
+      ]
+    },
+    "generation": {
+      "oneOf": [
+        { "type": "object" },
+        { "type": "null" }
+      ]
+    },
+    "storage": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["draftRoot", "fileName", "absolutePath", "savedAt"],
+          "additionalProperties": false,
+          "properties": {
+            "draftRoot": { "type": "string", "minLength": 1 },
+            "fileName": { "type": "string", "minLength": 1 },
+            "absolutePath": { "type": "string", "minLength": 1 },
+            "savedAt": { "type": "string", "minLength": 1 }
+          }
+        },
+        { "type": "null" }
+      ]
+    },
+    "history": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["event", "timestamp"],
+        "additionalProperties": false,
+        "properties": {
+          "event": { "type": "string", "minLength": 1 },
+          "timestamp": { "type": "string", "minLength": 1 },
+          "summary": { "type": "string" }
+        }
+      }
+    }
+  }
+}

package/specs/rules/spec-governance.json

@@ -0,0 +1,29 @@
+{
+  "scopes": {
+    "template": {
+      "roots": ["specs/templates/"],
+      "allowCustomDomain": false,
+      "requireDescription": true,
+      "forbidSampleObjectSuffix": true
+    },
+    "project": {
+      "roots": ["specs/projects/"],
+      "allowCustomDomain": true,
+      "requireDescription": false,
+      "forbidSampleObjectSuffix": false
+    },
+    "generatedProject": {
+      "roots": ["specs/projects/generated-from-nl/"],
+      "allowCustomDomain": true,
+      "requireDescription": false,
+      "forbidSampleObjectSuffix": false
+    },
+    "patternExample": {
+      "roots": ["specs/projects/pattern-examples/"],
+      "allowCustomDomain": true,
+      "requireDescription": true,
+      "forbidSampleObjectSuffix": false,
+      "requirePattern": true
+    }
+  }
+}