@qingflow-tech/qingflow-cli 1.1.41 → 1.1.43-beta.1

package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/summary.json

@@ -0,0 +1,713 @@
+{
+  "$defs": {
+    "AppFormSpec": {
+      "additionalProperties": false,
+      "description": "表单基础配置与字段布局目标态;除 body 外,缺失属性表示保留当前值。",
+      "properties": {
+        "appName": {
+          "description": "应用名称;缺失时保留当前名称。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "attachments": {
+          "description": "应用附件完整目标态;空数组表示删除全部应用附件。",
+          "items": {
+            "$ref": "#/$defs/Attachment"
+          },
+          "type": "array"
+        },
+        "body": {
+          "$ref": "#/$defs/Body",
+          "description": "业务字段与布局的完整目标态;缺失字段或段落表示删除。"
+        },
+        "color": {
+          "description": "新应用图标颜色;仅创建分支允许,必须来自 workspace icon color catalog。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "description": {
+          "description": "应用描述;null 或空字符串表示清空。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "icon": {
+          "description": "新应用图标;仅创建分支允许,必须来自 workspace icon catalog 且不得为 template。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "serialNumber": {
+          "$ref": "#/$defs/SerialNumber",
+          "description": "应用编号规则;支持默认编号或自定义组件编号。"
+        },
+        "style": {
+          "description": "应用样式;对象内缺失属性保留当前值,null 表示清除全部自定义样式。",
+          "oneOf": [
+            {
+              "$ref": "#/$defs/Style"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "theme": {
+          "description": "应用主题 ID;null 表示清除自定义主题。",
+          "type": [
+            "integer",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "body"
+      ],
+      "type": "object"
+    },
+    "Attachment": {
+      "additionalProperties": false,
+      "description": "应用级附件;已有附件由 attachId 复用,新增附件省略 attachId。",
+      "properties": {
+        "attachId": {
+          "description": "后端生成的附件 ID;get 返回,新增时省略。",
+          "minimum": 1,
+          "type": "integer"
+        },
+        "fileName": {
+          "description": "附件展示名称。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "fileUrl": {
+          "description": "已上传文件的可访问 URL。",
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "fileName",
+        "fileUrl"
+      ],
+      "type": "object"
+    },
+    "Body": {
+      "description": "有序表单内容块;空数组表示删除全部业务字段和段落。",
+      "items": {
+        "$ref": "#/$defs/BodyBlock"
+      },
+      "type": "array"
+    },
+    "BodyBlock": {
+      "description": "根级普通行或独占外层位置的段落。",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/RowBlock"
+        },
+        {
+          "$ref": "#/$defs/SectionBlock"
+        }
+      ]
+    },
+    "FieldRow": {
+      "additionalProperties": false,
+      "description": "段落内部字段行。",
+      "properties": {
+        "fields": {
+          "description": "本行的 1 到 4 个顶层字段。",
+          "items": {
+            "$ref": "#/$defs/TopField"
+          },
+          "maxItems": 4,
+          "minItems": 1,
+          "type": "array"
+        }
+      },
+      "required": [
+        "fields"
+      ],
+      "type": "object"
+    },
+    "FieldSelector": {
+      "additionalProperties": false,
+      "anyOf": [
+        {
+          "required": [
+            "queId"
+          ]
+        },
+        {
+          "required": [
+            "name"
+          ]
+        }
+      ],
+      "description": "跨字段引用选择器;至少提供 queId 或 name,两者同时提供时必须指向同一字段。",
+      "properties": {
+        "name": {
+          "description": "字段名称;仅在当前作用域内唯一时可用于解析。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "queId": {
+          "description": "已有字段的后端 ID;优先用于精确解析。",
+          "minimum": 1,
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    },
+    "FieldSummary": {
+      "additionalProperties": false,
+      "properties": {
+        "config": {
+          "description": "调用对应 field_type 的详细 Schema 后生成。",
+          "type": "object"
+        },
+        "dataCover": {
+          "type": "boolean"
+        },
+        "dataTitle": {
+          "type": "boolean"
+        },
+        "description": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "name": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "queId": {
+          "minimum": 1,
+          "type": "integer"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "subfields": {
+          "description": "仅 subtable 使用;详情见 subtable Schema。",
+          "type": "array"
+        },
+        "type": {
+          "description": "必须来自 x-qingflow-supported-field-types。",
+          "type": "string"
+        },
+        "width": {
+          "maximum": 100,
+          "minimum": 1,
+          "type": "integer"
+        }
+      },
+      "required": [
+        "name",
+        "type"
+      ],
+      "type": "object"
+    },
+    "RowBlock": {
+      "additionalProperties": false,
+      "description": "根级普通字段行;字段顺序即展示顺序。",
+      "properties": {
+        "fields": {
+          "description": "本行的 1 到 4 个顶层字段。",
+          "items": {
+            "$ref": "#/$defs/TopField"
+          },
+          "maxItems": 4,
+          "minItems": 1,
+          "type": "array"
+        },
+        "kind": {
+          "const": "row",
+          "description": "普通行判别值。"
+        }
+      },
+      "required": [
+        "kind",
+        "fields"
+      ],
+      "type": "object"
+    },
+    "RowSummary": {
+      "additionalProperties": false,
+      "properties": {
+        "fields": {
+          "items": {
+            "$ref": "#/$defs/FieldSummary"
+          },
+          "maxItems": 4,
+          "minItems": 1,
+          "type": "array"
+        },
+        "kind": {
+          "const": "row"
+        }
+      },
+      "required": [
+        "kind",
+        "fields"
+      ],
+      "type": "object"
+    },
+    "SectionBlock": {
+      "additionalProperties": false,
+      "description": "段落布局容器;不是业务字段,必须独占一个根级块。",
+      "properties": {
+        "kind": {
+          "const": "section",
+          "description": "段落判别值。"
+        },
+        "rows": {
+          "description": "段落内的非空有序字段行。",
+          "items": {
+            "$ref": "#/$defs/FieldRow"
+          },
+          "minItems": 1,
+          "type": "array"
+        },
+        "sectionId": {
+          "description": "已有段落的真实身份;get 把后端数值 queId 输出为无前导零的正十进制字符串,apply 仅在构造后端 payload 时转回数值 queId,新增段落省略。",
+          "pattern": "^[1-9][0-9]*$",
+          "type": "string"
+        },
+        "title": {
+          "description": "段落标题。",
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "kind",
+        "title",
+        "rows"
+      ],
+      "type": "object"
+    },
+    "SectionSummary": {
+      "additionalProperties": false,
+      "properties": {
+        "kind": {
+          "const": "section"
+        },
+        "rows": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "fields": {
+                "items": {
+                  "$ref": "#/$defs/FieldSummary"
+                },
+                "maxItems": 4,
+                "minItems": 1,
+                "type": "array"
+              }
+            },
+            "required": [
+              "fields"
+            ],
+            "type": "object"
+          },
+          "minItems": 1,
+          "type": "array"
+        },
+        "sectionId": {
+          "pattern": "^[1-9][0-9]*$",
+          "type": "string"
+        },
+        "title": {
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "kind",
+        "title",
+        "rows"
+      ],
+      "type": "object"
+    },
+    "SerialComponent": {
+      "description": "自定义编号的组成部分;id 仅用于复用已有组件。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "description": "后端生成的组件 ID;get 返回,新增时省略。",
+              "minimum": 1,
+              "type": "integer"
+            },
+            "length": {
+              "description": "自动计数部分的位数。",
+              "maximum": 9,
+              "minimum": 3,
+              "type": "integer"
+            },
+            "repeatPeriod": {
+              "description": "自动计数器的重置周期。",
+              "enum": [
+                "none",
+                "day",
+                "week",
+                "month",
+                "year"
+              ]
+            },
+            "type": {
+              "const": "auto_count"
+            }
+          },
+          "required": [
+            "type",
+            "length",
+            "repeatPeriod"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "dateFormat": {
+              "description": "提交时间在编号中的格式。",
+              "enum": [
+                "year",
+                "year_month",
+                "year_month_day"
+              ]
+            },
+            "id": {
+              "minimum": 1,
+              "type": "integer"
+            },
+            "type": {
+              "const": "submit_datetime"
+            }
+          },
+          "required": [
+            "type",
+            "dateFormat"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "minimum": 1,
+              "type": "integer"
+            },
+            "type": {
+              "const": "fixed_text"
+            },
+            "value": {
+              "description": "固定拼接文本。",
+              "minLength": 1,
+              "type": "string"
+            }
+          },
+          "required": [
+            "type",
+            "value"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "dateFormat": {
+              "description": "来源为日期字段时的格式。",
+              "enum": [
+                "year",
+                "year_month",
+                "year_month_day"
+              ]
+            },
+            "field": {
+              "$ref": "#/$defs/FieldSelector",
+              "description": "取值来源字段。"
+            },
+            "id": {
+              "minimum": 1,
+              "type": "integer"
+            },
+            "type": {
+              "const": "field"
+            }
+          },
+          "required": [
+            "type",
+            "field"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "SerialNumber": {
+      "description": "应用数据编号配置;自定义模式必须且只能包含一个自动计数组件。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "const": "default",
+              "description": "使用系统默认编号规则。"
+            }
+          },
+          "required": [
+            "mode"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "components": {
+              "contains": {
+                "properties": {
+                  "type": {
+                    "const": "auto_count"
+                  }
+                },
+                "required": [
+                  "type"
+                ],
+                "type": "object"
+              },
+              "description": "自定义编号组件的完整有序目标态。",
+              "items": {
+                "$ref": "#/$defs/SerialComponent"
+              },
+              "maxContains": 1,
+              "minContains": 1,
+              "minItems": 1,
+              "type": "array"
+            },
+            "mode": {
+              "const": "custom",
+              "description": "使用按数组顺序拼接的自定义编号组件。"
+            }
+          },
+          "required": [
+            "mode",
+            "components"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "Style": {
+      "additionalProperties": false,
+      "description": "表单背景和头部视觉样式;颜色使用 CSS 颜色字符串。",
+      "properties": {
+        "bgColor": {
+          "description": "表单背景色;null 表示清除。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "bgImage": {
+          "description": "表单背景图片 URL;null 表示清除。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "fontColor": {
+          "description": "表单头部字体颜色;null 表示清除。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "headerColor": {
+          "description": "表单头部背景色;null 表示清除。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "headerImage": {
+          "description": "表单头图 URL;null 表示清除。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "opacity": {
+          "description": "背景透明度,取值 0 到 1;null 表示清除。",
+          "maximum": 1,
+          "minimum": 0,
+          "type": [
+            "number",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "TopField": {}
+  },
+  "$id": "https://builder.qingflow.com/schemas/app-form-apply/v1alpha1/summary.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "properties": {
+        "spec": {
+          "not": {
+            "anyOf": [
+              {
+                "required": [
+                  "icon"
+                ]
+              },
+              {
+                "required": [
+                  "color"
+                ]
+              }
+            ]
+          }
+        }
+      },
+      "required": [
+        "appKey"
+      ]
+    },
+    {
+      "not": {
+        "required": [
+          "appKey"
+        ]
+      },
+      "properties": {
+        "spec": {
+          "required": [
+            "appName",
+            "icon",
+            "color"
+          ]
+        }
+      },
+      "required": [
+        "packageId"
+      ]
+    }
+  ],
+  "properties": {
+    "apiVersion": {
+      "const": "builder.qingflow.com/v1alpha1"
+    },
+    "appKey": {
+      "description": "更新已有应用时使用;存在非空值即进入更新模式。",
+      "minLength": 1,
+      "type": "string"
+    },
+    "packageId": {
+      "description": "创建时必填;更新时可选,提供后确保该包引用应用且不移除其他包引用。",
+      "minimum": 1,
+      "type": "integer"
+    },
+    "spec": {
+      "additionalProperties": false,
+      "properties": {
+        "appName": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "attachments": {
+          "description": "应用附件完整目标态。",
+          "items": {
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "body": {
+          "description": "业务字段与布局完整目标态;缺失业务字段表示删除。",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/RowSummary"
+              },
+              {
+                "$ref": "#/$defs/SectionSummary"
+              }
+            ]
+          },
+          "type": "array"
+        },
+        "color": {
+          "description": "仅创建时使用;必须来自 workspace icon color catalog。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "description": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "icon": {
+          "description": "仅创建时使用;必须来自 workspace icon catalog 且不得为 template。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "serialNumber": {
+          "description": "default 或 custom 编号配置。",
+          "type": "object"
+        },
+        "style": {
+          "description": "应用样式;详细属性为 bgImage/bgColor/opacity/headerImage/headerColor/fontColor。",
+          "type": [
+            "object",
+            "null"
+          ]
+        },
+        "theme": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "body"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "apiVersion",
+    "spec"
+  ],
+  "title": "Qingflow AppFormApply v1alpha1 Summary",
+  "type": "object",
+  "x-qingflow-field-detail-query": "app_form_schema(schema_version, field_type)",
+  "x-qingflow-supported-field-types": [
+    "text",
+    "long_text",
+    "number",
+    "amount",
+    "link",
+    "date",
+    "datetime",
+    "member",
+    "department",
+    "single_choice",
+    "single_select",
+    "multi_select",
+    "phone",
+    "email",
+    "address",
+    "attachment",
+    "q_linker",
+    "code_block",
+    "data_relation",
+    "relation",
+    "subtable"
+  ]
+}