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

package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/q_linker.json

@@ -0,0 +1,412 @@
+{
+  "$defs": {
+    "FieldCommon": {
+      "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"
+          ]
+        }
+      ],
+      "description": "顶层业务字段的公共属性;字段类型由 TopField 的判别分支定义。",
+      "properties": {
+        "beingRequired": {
+          "description": "该字段是否必填;缺失时保留已有字段当前值。",
+          "type": "boolean"
+        },
+        "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": "字段类型;具体可用值由当前字段详情 Schema 的判别分支约束。",
+          "type": "string"
+        },
+        "width": {
+          "description": "字段在所在行的宽度百分比;只能选择 25、50、75 或 100。",
+          "enum": [
+            25,
+            50,
+            75,
+            100
+          ],
+          "type": "integer"
+        }
+      },
+      "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"
+    },
+    "QLinkerBinding": {
+      "additionalProperties": false,
+      "description": "Q-Linker 的输入映射、请求配置和输出映射;每个输出目标还必须满足应用级唯一性规则,不能与任何 Q-Linker 或代码块的其他输出指向同一实际字段。多个生产方需要回写时,请选择不同目标字段或合并为一个生产方。",
+      "properties": {
+        "inputs": {
+          "description": "将当前表单字段映射到请求参数的规则。query_param、header、url_encoded 会直接生成对应位置的动态参数;json_path 用于替换 request.url、request.jsonValue 或 request.xmlValue 中的 {{key}} 占位符。",
+          "items": {
+            "$ref": "#/$defs/QLinkerInputBinding"
+          },
+          "type": "array"
+        },
+        "outputs": {
+          "description": "将响应路径映射到目标字段的规则;至少一个。所有 targetField 在整个应用的 Q-Linker 和代码块输出中必须全局唯一。",
+          "items": {
+            "$ref": "#/$defs/QLinkerOutputBinding"
+          },
+          "minItems": 1,
+          "type": "array"
+        },
+        "request": {
+          "$ref": "#/$defs/QLinkerRequest",
+          "description": "远程请求配置。"
+        }
+      },
+      "required": [
+        "request",
+        "outputs"
+      ],
+      "type": "object"
+    },
+    "QLinkerConfig": {
+      "additionalProperties": false,
+      "description": "Q-Linker 的高层声明;无法无损还原为该结构时阻断处理。",
+      "properties": {
+        "qLinkerBinding": {
+          "$ref": "#/$defs/QLinkerBinding"
+        }
+      },
+      "required": [
+        "qLinkerBinding"
+      ],
+      "type": "object"
+    },
+    "QLinkerInputBinding": {
+      "additionalProperties": false,
+      "description": "一个表单字段到请求参数的映射。需要把字段值嵌入 URL、JSON 或 XML 字符串时,source 必须为 json_path,key 必须等于所选字段名,并在对应请求字符串中写 {{key}};其他 source 不会替换 {{key}}。",
+      "properties": {
+        "field": {
+          "$ref": "#/$defs/FieldSelector",
+          "description": "输入来源字段。"
+        },
+        "key": {
+          "description": "请求参数名。source 为 json_path 时必须等于 field 选中的字段名,并与请求字符串中的 {{key}} 完全一致。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "source": {
+          "description": "字段值的写入位置。query_param、header、url_encoded 分别生成动态查询参数、请求头、表单项;json_path 替换 URL、JSON 或 XML 中的 {{key}}。不要用前三种 source 提供字符串占位符。",
+          "enum": [
+            "query_param",
+            "header",
+            "url_encoded",
+            "json_path"
+          ]
+        }
+      },
+      "required": [
+        "field",
+        "key",
+        "source"
+      ],
+      "type": "object"
+    },
+    "QLinkerKeyValue": {
+      "additionalProperties": false,
+      "description": "HTTP 请求中的键值对。",
+      "properties": {
+        "key": {
+          "description": "参数名。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "value": {
+          "description": "参数值;null 表示空值。",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "key"
+      ],
+      "type": "object"
+    },
+    "QLinkerOutputBinding": {
+      "additionalProperties": false,
+      "description": "一个响应值到表单目标字段的映射;同一实际目标字段在整个应用中只能被一个 Q-Linker 或代码块输出映射写入。",
+      "properties": {
+        "alias": {
+          "description": "输出别名;用于后续数据关联引用。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "aliasId": {
+          "description": "后端生成的输出别名 ID;新增输出时省略,Builder 在首次写入后按 alias 与 path 自动回填再保存关系。更新已有输出时必须保留 get 返回值,不得自行编造或置空。",
+          "minimum": 1,
+          "type": "integer"
+        },
+        "path": {
+          "description": "从响应中取值的 JSONPath。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "targetField": {
+          "$ref": "#/$defs/FieldSelector",
+          "description": "接收结果的当前表单字段;该字段在整个应用的全部 Q-Linker 和代码块 outputs 中只能作为 targetField 出现一次,不得被多个输出关系重复写入。"
+        }
+      },
+      "required": [
+        "alias",
+        "path",
+        "targetField"
+      ],
+      "type": "object"
+    },
+    "QLinkerRequest": {
+      "additionalProperties": false,
+      "description": "Q-Linker 远程 HTTP 请求配置。",
+      "properties": {
+        "autoTrigger": {
+          "description": "是否在输入变化时自动触发请求。",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "bodyType": {
+          "default": "url_encoded",
+          "description": "请求体格式;分别映射后端 bodyType 1、2、3。",
+          "enum": [
+            "url_encoded",
+            "json",
+            "xml"
+          ]
+        },
+        "customButtonText": {
+          "description": "自定义触发按钮文案。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "customButtonTextEnabled": {
+          "description": "是否启用自定义触发按钮文案。",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "headers": {
+          "description": "请求头键值对。",
+          "items": {
+            "$ref": "#/$defs/QLinkerKeyValue"
+          },
+          "type": "array"
+        },
+        "hideOnForm": {
+          "description": "是否在表单填写界面隐藏该 Q-Linker 字段。",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "insertValueDirectly": {
+          "description": "是否把请求结果直接写入目标字段。",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "jsonValue": {
+          "description": "bodyType 为 json 时的 JSON 请求体字符串。动态字段值写成 {{key}},且 inputs 必须存在同名 source=json_path 映射;query_param、header、url_encoded 不会替换这里的占位符。",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "method": {
+          "default": "GET",
+          "description": "HTTP 方法;当前 Q-Linker 仅支持 GET 和 POST,缺失时按 GET 处理。",
+          "enum": [
+            "GET",
+            "POST"
+          ]
+        },
+        "queryParams": {
+          "description": "URL 查询参数键值对。",
+          "items": {
+            "$ref": "#/$defs/QLinkerKeyValue"
+          },
+          "type": "array"
+        },
+        "resultType": {
+          "default": "json",
+          "description": "响应解析格式;分别映射后端 resultType 1、2、3。",
+          "enum": [
+            "json",
+            "xml",
+            "text"
+          ]
+        },
+        "url": {
+          "description": "请求 URL;动态嵌入字段值时使用 {{key}},并在 inputs 中提供同名 source=json_path 映射。",
+          "minLength": 1,
+          "type": "string"
+        },
+        "urlEncodedValue": {
+          "description": "bodyType 为 url_encoded 时的表单键值对。",
+          "items": {
+            "$ref": "#/$defs/QLinkerKeyValue"
+          },
+          "type": "array"
+        },
+        "xmlValue": {
+          "description": "bodyType 为 xml 时的 XML 请求体字符串。动态字段值写成 {{key}},且 inputs 必须存在同名 source=json_path 映射。",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "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"
+      ]
+    }
+  },
+  "$id": "https://builder.qingflow.com/schemas/app-form-apply/v1alpha1/fields/q_linker.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "#/$defs/FieldCommon"
+    },
+    {
+      "properties": {
+        "config": {
+          "$ref": "#/$defs/QLinkerConfig"
+        },
+        "questionType": {
+          "const": "q_linker"
+        }
+      },
+      "required": [
+        "questionType",
+        "config"
+      ]
+    }
+  ],
+  "title": "Qingflow AppForm v1alpha1 q_linker field",
+  "type": "object",
+  "unevaluatedProperties": false
+}