@qingflow-tech/qingflow-cli 1.1.43 → 1.1.44

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

@@ -0,0 +1,580 @@
+{
+  "$defs": {
+    "AliasSelector": {
+      "additionalProperties": false,
+      "description": "Q-Linker 或代码块输出别名;已有输出优先携带 aliasId。",
+      "properties": {
+        "aliasId": {
+          "description": "后端生成的别名 ID;新增输出时可省略。",
+          "minimum": 1,
+          "type": "integer"
+        },
+        "name": {
+          "description": "输出别名名称。",
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "DataRelationCondition": {
+      "additionalProperties": false,
+      "description": "一条数据关联过滤条件;sourceField 必须属于数据来源,operator 必须适用于该字段类型。固定值请使用 literal operand,不要直接声明后端 matchRules。",
+      "properties": {
+        "operand": {
+          "$ref": "#/$defs/DataRelationOperand",
+          "description": "比较值来源;可为字面量、当前表单字段或输出别名。"
+        },
+        "operator": {
+          "description": "比较运算符;Reconciler 会结合字段类型校验可用性。",
+          "enum": [
+            "equal",
+            "not_equal",
+            "contains",
+            "not_contains",
+            "greater_than",
+            "greater_or_equal",
+            "less_than",
+            "less_or_equal",
+            "dynamic_range",
+            "equal_any",
+            "not_equal_any",
+            "is_empty",
+            "is_not_empty",
+            "belongs_to",
+            "not_belongs_to",
+            "subordinate_to",
+            "not_subordinate_to",
+            "subordinate_included",
+            "subordinate_not_included",
+            "fuzzy_match",
+            "contains_any",
+            "contains_all",
+            "decimal_range"
+          ]
+        },
+        "sourceField": {
+          "$ref": "#/$defs/FieldSelector",
+          "description": "被过滤的数据源字段。"
+        }
+      },
+      "required": [
+        "sourceField",
+        "operator",
+        "operand"
+      ],
+      "type": "object"
+    },
+    "DataRelationConfig": {
+      "additionalProperties": false,
+      "description": "数据关联字段配置;从应用、Q-Linker 或代码块输出中读取数据。",
+      "properties": {
+        "aggregation": {
+          "description": "可选聚合方式;null 表示不聚合。",
+          "enum": [
+            "sum",
+            "average",
+            "max",
+            "min",
+            "first",
+            "last",
+            "filled_count",
+            "empty_count",
+            "count",
+            null
+          ],
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "customButton": {
+          "$ref": "#/$defs/DataRelationCustomButton",
+          "description": "可选自定义按钮配置。"
+        },
+        "filters": {
+          "$ref": "#/$defs/DataRelationFilters",
+          "description": "可选过滤条件;支持简单条件组或高级公式。"
+        },
+        "sort": {
+          "$ref": "#/$defs/DataRelationSort",
+          "description": "可选排序配置。"
+        },
+        "source": {
+          "$ref": "#/$defs/DataRelationSource",
+          "description": "数据来源;按 kind 选择一种来源结构。"
+        }
+      },
+      "required": [
+        "source"
+      ],
+      "type": "object"
+    },
+    "DataRelationCustomButton": {
+      "description": "数据关联自定义按钮;启用时必须引用已有 buttonId。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "const": false
+            }
+          },
+          "required": [
+            "enabled"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "buttonId": {
+              "minimum": 1,
+              "type": "integer"
+            },
+            "enabled": {
+              "const": true
+            }
+          },
+          "required": [
+            "enabled",
+            "buttonId"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "DataRelationFilters": {
+      "description": "simple 模式的外层组为 OR、组内条件为 AND;advanced 模式使用完整公式。simple 条件只声明业务值,builder 会生成后端保存所需的 judgeValues 和 judgeValueDetails,不要在声明中直接填写这两个后端属性。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "groups": {
+              "description": "OR 条件组数组;每个内层数组是一组 AND 条件。",
+              "items": {
+                "items": {
+                  "$ref": "#/$defs/DataRelationCondition"
+                },
+                "minItems": 1,
+                "type": "array"
+              },
+              "type": "array"
+            },
+            "mode": {
+              "const": "simple"
+            }
+          },
+          "required": [
+            "mode",
+            "groups"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "formula": {
+              "description": "解码后的高级筛选公式。",
+              "minLength": 1,
+              "type": "string"
+            },
+            "mode": {
+              "const": "advanced"
+            }
+          },
+          "required": [
+            "mode",
+            "formula"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "DataRelationOperand": {
+      "description": "数据关联条件右值的判别联合。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "kind": {
+              "const": "literal"
+            },
+            "values": {
+              "description": "固定比较值列表;值必须使用字符串。选择类来源字段填写已有选项的展示文本,builder 会在 apply 时解析为后端 optId;解析不到会在写入前报错。is_empty/is_not_empty 必须传空数组,其他运算符至少传一项。",
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          },
+          "required": [
+            "kind",
+            "values"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "field": {
+              "$ref": "#/$defs/FieldSelector"
+            },
+            "kind": {
+              "const": "current_field"
+            }
+          },
+          "required": [
+            "kind",
+            "field"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "alias": {
+              "$ref": "#/$defs/AliasSelector"
+            },
+            "kind": {
+              "const": "alias"
+            },
+            "producer": {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          },
+          "required": [
+            "kind",
+            "producer",
+            "alias"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "DataRelationSort": {
+      "description": "数据关联排序开关;启用时必须指定排序来源和方向。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "const": false
+            }
+          },
+          "required": [
+            "enabled"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "by": {
+              "$ref": "#/$defs/DataRelationSortBy"
+            },
+            "direction": {
+              "enum": [
+                "asc",
+                "desc"
+              ]
+            },
+            "enabled": {
+              "const": true
+            }
+          },
+          "required": [
+            "enabled",
+            "by",
+            "direction"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "DataRelationSortBy": {
+      "description": "排序值来源;可为来源字段或输出别名。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "field": {
+              "$ref": "#/$defs/FieldSelector"
+            },
+            "kind": {
+              "const": "field"
+            }
+          },
+          "required": [
+            "kind",
+            "field"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "alias": {
+              "$ref": "#/$defs/AliasSelector"
+            },
+            "kind": {
+              "const": "alias"
+            },
+            "producer": {
+              "$ref": "#/$defs/FieldSelector"
+            }
+          },
+          "required": [
+            "kind",
+            "producer",
+            "alias"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "DataRelationSource": {
+      "description": "数据关联来源判别联合;kind 决定其余必填字段。",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "appKey": {
+              "description": "来源应用的 appKey。",
+              "minLength": 1,
+              "type": "string"
+            },
+            "field": {
+              "$ref": "#/$defs/FieldSelector",
+              "description": "来源应用中的结果字段。"
+            },
+            "kind": {
+              "const": "app"
+            }
+          },
+          "required": [
+            "kind",
+            "appKey",
+            "field"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "alias": {
+              "$ref": "#/$defs/AliasSelector",
+              "description": "Q-Linker 输出别名。"
+            },
+            "kind": {
+              "const": "q_linker"
+            },
+            "producer": {
+              "$ref": "#/$defs/FieldSelector",
+              "description": "当前应用中的 Q-Linker 字段。"
+            }
+          },
+          "required": [
+            "kind",
+            "producer",
+            "alias"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "alias": {
+              "$ref": "#/$defs/AliasSelector",
+              "description": "代码块输出别名。"
+            },
+            "kind": {
+              "const": "code_block"
+            },
+            "producer": {
+              "$ref": "#/$defs/FieldSelector",
+              "description": "当前应用中的代码块字段。"
+            }
+          },
+          "required": [
+            "kind",
+            "producer",
+            "alias"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "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"
+    },
+    "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/data_relation.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "#/$defs/FieldCommon"
+    },
+    {
+      "properties": {
+        "config": {
+          "$ref": "#/$defs/DataRelationConfig"
+        },
+        "questionType": {
+          "const": "data_relation"
+        }
+      },
+      "required": [
+        "questionType",
+        "config"
+      ]
+    }
+  ],
+  "title": "Qingflow AppForm v1alpha1 data_relation field",
+  "type": "object",
+  "unevaluatedProperties": false
+}