@qingflow-tech/qingflow-cli 1.1.61-beta.3 → 1.1.61-beta.5

package/src/qingflow_mcp/builder_facade/schemas/portals/v1alpha1/components/chart.json

@@ -0,0 +1,643 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://qingflow.com/schemas/builder/portals/v1alpha1/components/chart.json",
+  "title": "Qingflow Builder Portals Section · chart (v1alpha1)",
+  "portalChartSectionDescription": "门户报表(QingBI 图表)组件(chart)的详细配置专项 Schema。获取命令:qingflow builder portal schema --schema-kind chart(MCP: portal_schema(schema_kind=\"chart\"))。本 Schema 校验 sections[] 中单个 chart 区块(自包含,可直接交给 JSON Schema 校验器);后端 DashComponentInfo.type=1。整门户声明走 summary/complete 档。",
+  "$defs": {
+    "Position": {
+      "type": "object",
+      "additionalProperties": false,
+      "positionShapeDescription": "网格位置。PC 是 24 列网格(cols≤24),mobile 是 6 列网格(cols≤6);同行组件共享同一 y 与 rows,一行 cols 合计 24。mobile 可省略(缺省与 pc 同布局)。平铺别名 pc_x/pc_y/pc_w/pc_h、mobile_* 也接受,归一为本结构。标准行高:指标卡 rows=5、BI 图表 rows=7、数据视图 rows=11、业务入口 rows=4。",
+      "properties": {
+        "pc": {
+          "$ref": "#/$defs/PositionDetail"
+        },
+        "mobile": {
+          "$ref": "#/$defs/PositionDetail"
+        }
+      }
+    },
+    "PositionDetail": {
+      "type": "object",
+      "additionalProperties": false,
+      "positionDetailShapeDescription": "单端位置:x=列偏移、y=行偏移、cols=占宽、rows=占高。",
+      "properties": {
+        "x": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0
+        },
+        "y": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0
+        },
+        "cols": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 1
+        },
+        "rows": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 1
+        }
+      },
+      "x-backend": "DashPosition.pc / DashPosition.mobile"
+    },
+    "ChartRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "chartRefShapeDescription": "引用已存在的 QingBI 图表。chart_id 或 chart_name 至少一个;按 chart_name 解析时必须给 app_key。别名 chartId/chart_key/chartKey/chartName。",
+      "anyOf": [
+        {
+          "required": [
+            "chart_id"
+          ]
+        },
+        {
+          "required": [
+            "chart_name",
+            "app_key"
+          ]
+        }
+      ],
+      "properties": {
+        "app_key": {
+          "type": "string",
+          "chartRefAppKeyShapeDescription": "图表所属应用 key。别名 appKey。"
+        },
+        "ref_kind": {
+          "type": "string",
+          "enum": [
+            "chart",
+            "bi_chart"
+          ],
+          "chartRefKindShapeDescription": "引用面判别:chart=轻流报表(chart 表唯一键 chartKey,后端组件 type=1);bi_chart=轻析 BI 报表(bi_chart 整型 chart_id,后端组件 type=9)。缺省 bi_chart。",
+          "x-backend": "DashComponentInfo.type ∈ {1, 9}"
+        },
+        "chart_id": {
+          "type": "string",
+          "chartRefIdShapeDescription": "图表 id(后端唯一键,回读优先携带)。 ref_kind=chart 时为 chart 表唯一键 chartKey;ref_kind=bi_chart 时为 bi_chart 整型 chart_id。",
+          "x-backend": "DashComponentInfo.dashChartId"
+        },
+        "chart_name": {
+          "type": "string",
+          "chartRefNameShapeDescription": "图表名称(按名解析的定位键)。别名 name。"
+        }
+      }
+    },
+    "InlineChart": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "app_key",
+        "name",
+        "chart_type"
+      ],
+      "inlineChartShapeDescription": "内联创建 QingBI 图表(与 builder chart apply 同一公开契约的子集);同一 apply 内 app_key+name+chart_type 相同且配置一致的多个区块复用同一图表,配置不同则拒绝写入。别名 inline_chart/create_chart。",
+      "properties": {
+        "app_key": {
+          "type": "string",
+          "inlineChartAppKeyShapeDescription": "图表所属应用 key。"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "inlineChartNameShapeDescription": "图表名称(同 apply 内去重键之一)。"
+        },
+        "chart_type": {
+          "type": "string",
+          "enum": [
+            "target",
+            "indicator",
+            "summary",
+            "pie",
+            "bar",
+            "columnar",
+            "line",
+            "table",
+            "detail",
+            "area",
+            "stacked_area",
+            "pct_stack_area",
+            "funnel",
+            "waterfall",
+            "gauge",
+            "heatmap",
+            "histogram",
+            "treemap",
+            "radar",
+            "stacked_bar",
+            "pct_stack_bar",
+            "stacked_column",
+            "pct_stack_col",
+            "scatter",
+            "ring",
+            "rose",
+            "dualaxes",
+            "map",
+            "timeline"
+          ],
+          "inlineChartTypeShapeDescription": "图表类型;指标卡场景用 target/indicator 且区块 rows=5。"
+        },
+        "metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartMetricShapeDescription": "主指标;字符串如 \"count(*)\"/\"sum(金额)\" 或对象形态。"
+        },
+        "metrics": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ChartMetric"
+          },
+          "inlineChartMetricsShapeDescription": "多指标列表(多轴/组合图)。"
+        },
+        "x_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartXMetricShapeDescription": "X 轴指标(散点等)。"
+        },
+        "y_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartYMetricShapeDescription": "Y 轴指标。"
+        },
+        "left_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartLeftMetricShapeDescription": "左轴指标(双轴图)。"
+        },
+        "right_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartRightMetricShapeDescription": "右轴指标(双轴图)。"
+        },
+        "value_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartValueMetricShapeDescription": "值指标。"
+        },
+        "target_metric": {
+          "$ref": "#/$defs/ChartMetric",
+          "inlineChartTargetMetricShapeDescription": "目标值指标(target 图)。"
+        },
+        "group_by": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "inlineChartGroupByShapeDescription": "分组字段(显示名列表)。"
+        },
+        "dimension_field_ids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "inlineChartDimensionShapeDescription": "维度字段 id 列表。"
+        },
+        "indicator_field_ids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "inlineChartIndicatorShapeDescription": "指标字段 id 列表。"
+        },
+        "rows": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "inlineChartRowsShapeDescription": "行维度(透视表)。"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "inlineChartColumnsShapeDescription": "列维度(透视表)。"
+        },
+        "filters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ChartFilterRule"
+          },
+          "inlineChartFiltersShapeDescription": "图表数据过滤条件(单组 AND)。"
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility",
+          "inlineChartVisibilityShapeDescription": "图表自身可见性(可选,与门户 visibility 同源编译)。"
+        },
+        "chart_id": {
+          "type": "string",
+          "inlineChartChartIdDescription": "已有图表 id(引用形态;等价 chart_ref.chart_id)。"
+        },
+        "question_config": {
+          "type": "array",
+          "inlineChartQuestionConfigDescription": "图表字段配置透传(chart apply 受控面)。",
+          "x-backend": "ChartUpsertPatch.questionConfig"
+        },
+        "user_config": {
+          "type": "array",
+          "inlineChartUserConfigDescription": "图表用户配置透传(chart apply 受控面)。",
+          "x-backend": "ChartUpsertPatch.userConfig"
+        },
+        "config": {
+          "type": "object",
+          "inlineChartConfigDescription": "图表 raw 配置透传(chart apply 受控面)。",
+          "x-backend": "ChartUpsertPatch.config"
+        }
+      }
+    },
+    "ChartMetric": {
+      "chartMetricShapeDescription": "聚合指标:字符串形态(如 \"count(*)\"、\"sum(金额)\",裸字段名默认 sum)或对象 {op, field_name, alias};op 常用 count/sum/avg/max/min。",
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "op"
+          ],
+          "properties": {
+            "op": {
+              "type": "string",
+              "chartMetricOpShapeDescription": "聚合方式。别名 operation/agg/aggregate/aggregation。"
+            },
+            "field_name": {
+              "type": "string",
+              "chartMetricFieldShapeDescription": "聚合字段显示名;count(*) 时省略。别名 field/fieldName/name。"
+            },
+            "alias": {
+              "type": "string",
+              "chartMetricAliasShapeDescription": "指标别名(图例显示)。"
+            }
+          }
+        }
+      ]
+    },
+    "ChartFilterRule": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "field_name"
+      ],
+      "chartFilterRuleShapeDescription": "过滤规则。is_empty/not_empty 不带 values,其余 operator 必须带非空 values(单值可写作 value)。别名 field/fieldName/name。",
+      "properties": {
+        "field_name": {
+          "type": "string"
+        },
+        "operator": {
+          "type": "string",
+          "enum": [
+            "eq",
+            "neq",
+            "in",
+            "contains",
+            "gte",
+            "lte",
+            "is_empty",
+            "not_empty",
+            "belongs_to"
+          ],
+          "default": "eq",
+          "chartFilterOperatorShapeDescription": "比较符。别名 op。 belongs_to=成员/部门归属(后端 JUDGE_BELONG_TO=13,公式引擎全支持;成员类存量筛选形态)。"
+        },
+        "values": {
+          "type": "array",
+          "chartFilterValuesShapeDescription": "比较值列表。"
+        }
+      }
+    },
+    "Visibility": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mode"
+      ],
+      "visibilityShapeDescription": "可见性与授权(与门户 visibility 同源编译);整段省略时按 workspace + external_mode=not。",
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "mode": {
+                "const": "specific"
+              }
+            },
+            "required": [
+              "mode"
+            ]
+          },
+          "then": {
+            "required": [
+              "selectors"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "mode": {
+                "const": "everyone"
+              }
+            },
+            "required": [
+              "mode"
+            ]
+          },
+          "then": {
+            "required": [
+              "external_mode"
+            ],
+            "properties": {
+              "external_mode": {
+                "const": "workspace"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "external_mode": {
+                "const": "specific"
+              }
+            },
+            "required": [
+              "external_mode"
+            ]
+          },
+          "then": {
+            "required": [
+              "external_selectors"
+            ]
+          }
+        }
+      ],
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": [
+            "workspace",
+            "everyone",
+            "specific"
+          ],
+          "visibilityModeShapeDescription": "workspace=工作区可见,everyone=互联网公开(要求 external_mode=workspace),specific=指定成员/部门/角色。",
+          "x-backend": "dash.dashAuth(1/2/3)"
+        },
+        "selectors": {
+          "$ref": "#/$defs/VisibilitySelectors"
+        },
+        "external_mode": {
+          "type": "string",
+          "enum": [
+            "not",
+            "workspace",
+            "specific"
+          ],
+          "externalModeShapeDescription": "外部成员授权。别名 externalMode。",
+          "x-backend": "dash.externalAuth(NOT|WORKSPACE_ALL|SPECIFIC)"
+        },
+        "external_selectors": {
+          "$ref": "#/$defs/ExternalSelectors"
+        }
+      }
+    },
+    "VisibilitySelectors": {
+      "type": "object",
+      "additionalProperties": false,
+      "selectorsCompleteDescription": "指定成员/部门/角色选择器;各列表都不是单独必填,空对象表示指定范围但尚未配置成员(合法形态)。与 views 声明的 selectors 键集同构。",
+      "properties": {
+        "member_uids": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "memberUidsDescription": "成员 uid 列表(数字)。"
+        },
+        "member_emails": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "memberEmailsDescription": "成员邮箱列表。"
+        },
+        "member_names": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "memberNamesDescription": "成员姓名列表(重名有歧义风险,优先 uid/email)。"
+        },
+        "dept_ids": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "deptIdsDescription": "部门 id 列表。"
+        },
+        "dept_names": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "deptNamesDescription": "部门名称列表。"
+        },
+        "role_ids": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "roleIdsDescription": "角色 id 列表。"
+        },
+        "role_names": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "roleNamesDescription": "角色名称列表。"
+        },
+        "include_sub_departs": {
+          "type": "boolean",
+          "default": false,
+          "includeSubDepartsDescription": "dept 指定时是否包含子部门。"
+        }
+      }
+    },
+    "ExternalSelectors": {
+      "type": "object",
+      "additionalProperties": false,
+      "externalSelectorsCompleteDescription": "指定外部成员选择器(与 views 声明键集同构)。",
+      "properties": {
+        "member_ids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "externalMemberIdsDescription": "外部成员 id 列表。"
+        },
+        "member_emails": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "externalMemberEmailsDescription": "外部成员邮箱列表。"
+        },
+        "dept_ids": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "externalDeptIdsDescription": "外部部门 id 列表。"
+        }
+      }
+    },
+    "Section": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source_type"
+      ],
+      "properties": {
+        "title": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "sectionTitleDescription": "组件显示标题。空标题(null)是合法存量形态(显示标题开但标题空,读链渲染时回退图表名/视图名);创建语义缺省建议显式命名。",
+          "x-backend": "组件标题(DashChartInfo.title / DashChartInfo.chartComponentTitle / gridConfig.gridTitle / componentTaskTitle 等;null 落库 NULL)"
+        },
+        "source_type": {
+          "const": "chart",
+          "sourceTypeConstDescription": "组件类型固定为 chart(报表(QingBI 图表));后端 type 整数见 x-backend。",
+          "x-backend": "DashComponentInfo.type(chart)"
+        },
+        "role": {
+          "type": "string",
+          "roleShapeDescription": "组件角色标注(编排辅助,如 metric=指标卡;影响布局预设的排布与行高)。别名 zone/section_role。"
+        },
+        "position": {
+          "$ref": "#/$defs/Position"
+        },
+        "style_config": {
+          "type": "object",
+          "styleConfigSectionDescription": "组件级样式(受控键集;键白名单以 ws40013 dataset 实测形态校准,未经校准的键会被拒绝)。别名 dash_style_config/dashStyleConfigBO。",
+          "x-backend": "DashComponentInfo.dashStyleConfigBO(DashStyleConfigBO)"
+        },
+        "chart_ref": {
+          "$ref": "#/$defs/ChartRef",
+          "chartRefPropDescription": "引用已有图表(chart_ref 或 chart 二选一)。"
+        },
+        "chart": {
+          "$ref": "#/$defs/InlineChart",
+          "chartInlinePropDescription": "内联创建图表(chart_ref 或 chart 二选一)。"
+        },
+        "show_title": {
+          "type": "boolean",
+          "showTitleShapeDescription": "显示标题开关(draft_dash_chart.being_show_title 落库列)。提取侧读面必有值;存量 false 必须保真(渲染语义依赖)。声明缺省时编译回落产品默认 true。",
+          "x-backend": "DashChart.beingShowTitle(chart/view 组件)"
+        }
+      },
+      "anyOf": [
+        {
+          "required": [
+            "chart_ref"
+          ]
+        },
+        {
+          "required": [
+            "chart"
+          ]
+        }
+      ]
+    }
+  },
+  "$ref": "#/$defs/Section",
+  "x-qingflow-detail-query": {
+    "currentKind": "chart",
+    "tool": "portal_schema",
+    "cli": "qingflow builder portal schema --schema-kind chart",
+    "argument": "schema_kind",
+    "detailQueryDescription": "本文件是 报表(QingBI 图表)组件的自包含专项 Schema(内联全部引用定义,可独立交给 JSON Schema 校验器)。chart/view/grid/filter/text/link/carousel/task/favourite 各组件专项 Schema分别经 qingflow builder portal schema --schema-kind <类型> 获取。整门户声明用 qingflow builder portal schema --schema-kind summary|complete 获取;回读既有门户用 qingflow builder portal get --dash-key K --schema-kind complete。",
+    "readSources": {
+      "chartIds": "已有图表 id 用 chart 面读取;内联创建直接在 chart 键声明。",
+      "viewKeys": "视图唯一键用 qingflow builder views get --app-key APP 回读。"
+    }
+  },
+  "examples": [
+    {
+      "title": "设备总数",
+      "source_type": "chart",
+      "role": "metric",
+      "position": {
+        "pc": {
+          "x": 0,
+          "y": 4,
+          "cols": 6,
+          "rows": 5
+        }
+      },
+      "chart": {
+        "app_key": "APP_KEY_DEVICE",
+        "name": "设备总数",
+        "chart_type": "target",
+        "metric": "count(*)"
+      }
+    },
+    {
+      "title": "故障类型分布",
+      "source_type": "chart",
+      "position": {
+        "pc": {
+          "x": 0,
+          "y": 9,
+          "cols": 12,
+          "rows": 7
+        }
+      },
+      "chart": {
+        "app_key": "APP_KEY_REPAIR",
+        "name": "故障类型分布",
+        "chart_type": "columnar",
+        "metric": "count(*)",
+        "group_by": [
+          "故障类型"
+        ],
+        "filters": [
+          {
+            "field_name": "处理状态",
+            "operator": "neq",
+            "values": [
+              "已作废"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "title": "既有报表",
+      "source_type": "chart",
+      "position": {
+        "pc": {
+          "x": 12,
+          "y": 9,
+          "cols": 12,
+          "rows": 7
+        }
+      },
+      "chart_ref": {
+        "app_key": "APP_KEY_REPAIR",
+        "chart_id": "CHART_ID_1001"
+      }
+    }
+  ]
+}