@qingflow-tech/qingflow-cli 1.1.43 → 1.1.44-beta.2

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

@@ -0,0 +1,718 @@
+{
+  "$defs": {
+    "AppFormSpec": {
+      "additionalProperties": false,
+      "description": "表单基础配置与字段布局目标态;除 body 外,缺失属性表示保留当前值。应用内所有 q_linker 和 code_block 字段的 outputs[].targetField 必须全局唯一,同一实际字段只能被一个输出映射写入。多个生产方需要回写时,请选择不同目标字段或合并为一个生产方。",
+      "properties": {
+        "appDescription": {
+          "description": "应用描述;null 或空字符串表示清空。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "appName": {
+          "description": "应用名称;缺失时保留当前名称。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "attachments": {
+          "description": "应用附件完整目标态;空数组表示删除全部应用附件。",
+          "items": {
+            "$ref": "#/$defs/Attachment"
+          },
+          "type": "array"
+        },
+        "body": {
+          "$ref": "#/$defs/Body",
+          "description": "业务字段与布局的完整目标态;缺失字段或段落表示删除。应用内所有 Q-Linker 和代码块的 outputs[].targetField 不得重复选择同一实际字段。"
+        },
+        "dataCoverField": {
+          "description": "数据封面字段选择器;指定每条数据的封面附件来源。仅允许选择顶层 attachment 字段;null 表示清除数据封面。",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          ]
+        },
+        "dataTitleField": {
+          "description": "数据标题字段选择器;指定每条数据的主显示标题来源。创建非空 body 时必填,更新时省略表示保留当前选择;显式提供时必须唯一定位一个顶层字段,仅 body 为空时允许 null。",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          ]
+        },
+        "serialNumber": {
+          "$ref": "#/$defs/SerialNumber",
+          "description": "应用编号规则;支持默认编号或自定义组件编号。"
+        }
+      },
+      "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,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "defaultType": {
+                "const": 2
+              }
+            },
+            "required": [
+              "defaultType"
+            ]
+          },
+          "then": {
+            "properties": {
+              "defaultValue": {
+                "type": "null"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "defaultType": {
+                "const": 3
+              }
+            },
+            "required": [
+              "defaultType"
+            ]
+          },
+          "then": {
+            "properties": {
+              "defaultValue": {
+                "minLength": 1,
+                "type": [
+                  "string",
+                  "null"
+                ]
+              }
+            }
+          }
+        }
+      ],
+      "anyOf": [
+        {
+          "required": [
+            "queId"
+          ]
+        },
+        {
+          "required": [
+            "name"
+          ]
+        }
+      ],
+      "properties": {
+        "beingRequired": {
+          "description": "该字段是否必填;缺失时更新保留当前值。",
+          "type": "boolean"
+        },
+        "config": {
+          "description": "调用对应 questionType 的详细 Schema 后生成;q_linker 和 code_block 的 outputs[].targetField 还必须遵守应用级全局唯一规则。",
+          "type": "object"
+        },
+        "defaultType": {
+          "default": 1,
+          "description": "默认值类型,与 defaultValue 联动;1 表示静态值,2 表示关联/绑定值且 defaultValue 只能省略或为 null,3 表示公式值且提供 defaultValue 时必须为非空公式文本。省略 defaultType 但提供 defaultValue 时按 1 处理。",
+          "enum": [
+            1,
+            2,
+            3
+          ],
+          "type": "integer"
+        },
+        "defaultValue": {
+          "$ref": "#/$defs/ScalarDefaultValue",
+          "description": "普通字段的默认值;后端 queDefaultValue 为字符串,因此数字等字面量也必须以字符串传入。defaultType 为 1 时表示静态文本,为 3 时表示公式文本,为 2 时不携带字面量默认值。结构化默认值必须放在具体字段 config.defaultValues。显式 null 表示清除默认值。"
+        },
+        "name": {
+          "description": "字段展示名称;新增字段必填,已有字段可在携带 queId 时省略。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "queId": {
+          "description": "已有字段的后端 ID;更新时用于精确定位并复用,新增字段通常省略。",
+          "minimum": 1,
+          "type": "integer"
+        },
+        "questionDescription": {
+          "description": "字段说明;null 或空字符串表示清空。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "questionType": {
+          "description": "字段类型;必须来自 x-qingflow-supported-field-types。",
+          "type": "string"
+        },
+        "subfields": {
+          "description": "仅 subtable 使用;详情见 subtable Schema。",
+          "type": "array"
+        },
+        "width": {
+          "description": "字段在所在行的宽度百分比;只能选择 25、50、75 或 100。",
+          "enum": [
+            25,
+            50,
+            75,
+            100
+          ],
+          "type": "integer"
+        }
+      },
+      "required": [
+        "questionType"
+      ],
+      "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"
+    },
+    "ScalarDefaultValue": {
+      "description": "后端 queDefaultValue 支持的普通字段默认值;非空值必须是字符串,显式 null 表示清除默认值。数字和布尔值应先转换为字符串,对象和数组必须使用字段专用默认值配置。defaultType 为 3 时,通过 AppForm Schema 查询能力传入当前 schema_version 并设置 schema_kind=formula 获取公式语法、字段引用、运算符和全部函数说明;CLI 使用 builder app-form schema --schema-kind formula。需要配置结构化默认值时,传入当前 schema_version,并将字段的 questionType 作为 field_type 获取字段详细 Schema。",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "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"
+        }
+      ]
+    },
+    "TopField": {
+      "$ref": "#/$defs/FieldSummary"
+    }
+  },
+  "$id": "https://builder.qingflow.com/schemas/app-form-apply/v1alpha1/summary.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "required": [
+        "appKey"
+      ]
+    },
+    {
+      "not": {
+        "required": [
+          "appKey"
+        ]
+      },
+      "properties": {
+        "spec": {
+          "required": [
+            "appName"
+          ]
+        }
+      },
+      "required": [
+        "packageId"
+      ]
+    }
+  ],
+  "properties": {
+    "apiVersion": {
+      "const": "builder.qingflow.com/v1alpha1"
+    },
+    "appKey": {
+      "description": "更新已有应用时使用;存在非空值即进入更新模式。",
+      "minLength": 1,
+      "type": "string"
+    },
+    "packageId": {
+      "description": "创建时必填;更新时可选,提供后确保该包引用应用且不移除其他包引用。",
+      "minimum": 1,
+      "type": "integer"
+    },
+    "spec": {
+      "additionalProperties": false,
+      "description": "应用表单目标态;应用内所有 q_linker 和 code_block 字段的 outputs[].targetField 必须全局唯一,同一实际字段只能被一个输出映射写入。多个生产方需要回写时,请选择不同目标字段或合并为一个生产方。",
+      "properties": {
+        "appDescription": {
+          "description": "应用描述;null 或空字符串表示清空。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "appName": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "attachments": {
+          "description": "应用附件完整目标态。",
+          "items": {
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "body": {
+          "description": "业务字段与布局完整目标态;缺失业务字段表示删除。应用内所有 Q-Linker 和代码块的 outputs[].targetField 不得重复选择同一实际字段。",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/RowSummary"
+              },
+              {
+                "$ref": "#/$defs/SectionSummary"
+              }
+            ]
+          },
+          "type": "array"
+        },
+        "dataCoverField": {
+          "description": "数据封面字段选择器;指定每条数据的封面附件来源。仅允许选择顶层 attachment 字段;null 表示清除数据封面。",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          ]
+        },
+        "dataTitleField": {
+          "description": "数据标题字段选择器;指定每条数据的主显示标题来源。创建非空 body 时必填,更新时省略表示保留当前选择;显式提供时必须唯一定位一个顶层字段,仅 body 为空时允许 null。",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          ]
+        },
+        "serialNumber": {
+          "description": "default 或 custom 编号配置。",
+          "type": "object"
+        }
+      },
+      "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"
+  ]
+}