@stalfh233/omc-cli 0.0.0-stage → 0.4.0

package/dist/intent/capabilities/report.js

@@ -0,0 +1,355 @@
+import { ENDPOINTS } from "../../endpoints.js";
+import { wireCall, WireError } from "../../wire.js";
+import { biCall, DEFAULT_BI_CORP_ID } from "../../bi-wire.js";
+import { refuse } from "../capability.js";
+import { sameValue } from "../compare.js";
+import { isScalarString, pushError } from "../validation.js";
+import { toPlain } from "../yaml.js";
+/**
+ * R1-report on the intent face — a root-scoped capability (a report is
+ * app-scoped config, sibling to a business service, not a model slice).
+ *
+ * A report is a PAGE on the platform channel plus a BI dashboard
+ * (global/attributes/charts) on `/dashboard/v1`. Ownership is ensure-present:
+ * only declared reports are read/planned, and only charts are removed when the
+ * report explicitly sets `removeUnlistedCharts:true` — undeclared BI charts on
+ * an otherwise matching report are never touched unless that flag is set.
+ *
+ * A report page has no BI dashboard until it is saved, so a fresh report plans
+ * `report.create` (which seeds the dashboard) followed by `report.configure`
+ * (global/attributes/charts). An existing report converges through
+ * `report.update` (metadata) and `report.configure` (dashboard + chart diff).
+ */
+const REPORT_KEYS = new Set(["code", "name", "appCode", "parentId", "icon", "pcAble", "mobileAble", "corpId", "global", "attributes", "charts", "removeUnlistedCharts"]);
+const CHART_KEYS = new Set(["uuid", "title", "type", "dataSourceId", "mainTable", "position", "styles", "data", "options", "authorization", "useType", "mobileOptions"]);
+function reportAuth(report) {
+    return { corpId: report.corpId ?? DEFAULT_BI_CORP_ID, reportCode: report.code, appCode: report.appCode };
+}
+/** Parse a JSON column; leave a non-string / unparseable value as-is. */
+function decodeJson(value) {
+    if (typeof value !== "string")
+        return value;
+    const text = value.trim();
+    if (!text)
+        return undefined;
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return value;
+    }
+}
+function isEmptyObject(value) {
+    return value !== null && typeof value === "object" && !Array.isArray(value) && Object.keys(value).length === 0;
+}
+/** A declared chart normalized into the stored BI chart object the write face takes. */
+function chartObject(chart) {
+    const value = { uuid: chart.uuid, title: chart.title, type: chart.type };
+    for (const key of ["dataSourceId", "mainTable", "authorization", "useType"])
+        if (chart[key] !== undefined)
+            value[key] = chart[key];
+    // Charts may pass structured sub-objects; the BI column wants JSON strings.
+    for (const key of ["position", "styles", "data", "mobileOptions"]) {
+        const entry = chart[key];
+        if (entry !== undefined)
+            value[key] = typeof entry === "string" ? entry : JSON.stringify(entry);
+    }
+    return value;
+}
+function configureArgs(report) {
+    return {
+        reportCode: report.code,
+        appCode: report.appCode,
+        ...(report.corpId ? { corpId: report.corpId } : {}),
+        ...(report.global !== undefined ? { global: report.global } : {}),
+        ...(report.attributes !== undefined ? { attributes: report.attributes } : {}),
+        ...(report.charts !== undefined ? { charts: report.charts.map(chartObject) } : {}),
+        ...(report.removeUnlistedCharts ? { removeUnlistedCharts: true } : {}),
+    };
+}
+/** Whether the declared dashboard differs from the live one (idempotence guard). */
+function dashboardNeedsConfigure(report, live) {
+    if (report.global !== undefined && !sameValue(report.global, live.global))
+        return true;
+    if (report.attributes !== undefined && !sameValue(report.attributes, live.attributes))
+        return true;
+    if (report.charts !== undefined) {
+        const liveCharts = new Map((live.charts ?? []).map((chart) => [chart.uuid, chart]));
+        for (const chart of report.charts) {
+            const current = liveCharts.get(chart.uuid);
+            if (!current || current.title !== chart.title || current.type !== chart.type)
+                return true;
+        }
+    }
+    if (report.removeUnlistedCharts === true) {
+        const declared = new Set((report.charts ?? []).map((chart) => chart.uuid));
+        if (live.chartUuids.some((uuid) => !declared.has(uuid)))
+            return true;
+    }
+    return false;
+}
+function validateChartNode(chartNode, chartBase, validation) {
+    for (const entry of chartNode.entries)
+        if (!CHART_KEYS.has(entry.key))
+            pushError(validation, "intent-key-unknown", `chart 不支持键 "${entry.key}"`, `${chartBase}.${entry.key}`);
+    const chartValue = (key) => chartNode.entries.find((entry) => entry.key === key)?.value;
+    const uuid = chartValue("uuid");
+    const title = chartValue("title");
+    const type = chartValue("type");
+    if (!isScalarString(uuid) || uuid.value.trim().length === 0)
+        pushError(validation, "intent-report-chart-uuid-invalid", "chart.uuid 必须是非空字符串", `${chartBase}.uuid`, "value");
+    if (!isScalarString(title) || title.value.trim().length === 0)
+        pushError(validation, "intent-report-chart-title-invalid", "chart.title 必须是非空字符串", `${chartBase}.title`, "value");
+    if (!isScalarString(type) || type.value.trim().length === 0)
+        pushError(validation, "intent-report-chart-type-invalid", "chart.type 必须是非空字符串（bar/line/pie/card/table/list…）", `${chartBase}.type`, "value");
+    if (!isScalarString(uuid) || !isScalarString(title) || !isScalarString(type))
+        return undefined;
+    const chart = { uuid: uuid.value.trim(), title: title.value.trim(), type: type.value.trim() };
+    for (const key of ["dataSourceId", "mainTable", "authorization", "useType"]) {
+        const entry = chartValue(key);
+        if (isScalarString(entry))
+            chart[key] = entry.value;
+    }
+    for (const key of ["position", "styles", "data", "mobileOptions", "options"]) {
+        const entry = chartValue(key);
+        if (entry !== undefined)
+            chart[key] = toPlain(entry);
+    }
+    return chart;
+}
+function validateReportNode(node, index, draft, validation) {
+    const base = `reports[${index}]`;
+    for (const entry of node.entries)
+        if (!REPORT_KEYS.has(entry.key))
+            pushError(validation, "intent-key-unknown", `report 不支持键 "${entry.key}"`, `${base}.${entry.key}`);
+    const value = (key) => node.entries.find((entry) => entry.key === key)?.value;
+    const code = value("code");
+    const name = value("name");
+    const appCode = value("appCode");
+    const parentId = value("parentId");
+    if (!isScalarString(code) || code.value.trim().length === 0)
+        pushError(validation, "intent-report-code-invalid", "report.code 必须是非空字符串", `${base}.code`, "value");
+    if (isScalarString(code) && !/^[A-Za-z][A-Za-z0-9_]{0,59}$/.test(code.value.trim()))
+        pushError(validation, "intent-report-code-invalid", "report.code 必须字母开头、≤60、仅字母数字下划线", `${base}.code`, "value");
+    if (!isScalarString(name) || name.value.trim().length === 0)
+        pushError(validation, "intent-report-name-invalid", "report.name 必须是非空字符串", `${base}.name`, "value");
+    if (!isScalarString(appCode) || appCode.value.trim().length === 0)
+        pushError(validation, "intent-report-appcode-invalid", "report.appCode 必须是非空字符串", `${base}.appCode`, "value");
+    if (!isScalarString(parentId) || parentId.value.trim().length === 0)
+        pushError(validation, "intent-report-parent-invalid", "report.parentId 必须是直属分组 id（新建报表页必填）", `${base}.parentId`, "value");
+    const chartsNode = value("charts");
+    if (chartsNode !== undefined && chartsNode.kind !== "seq")
+        pushError(validation, "intent-report-charts-invalid", "report.charts 必须是列表", `${base}.charts`, "value");
+    if (!isScalarString(code) || !isScalarString(name) || !isScalarString(appCode) || !isScalarString(parentId))
+        return;
+    const charts = [];
+    if (chartsNode?.kind === "seq") {
+        chartsNode.items.forEach((chartNode, chartIndex) => {
+            const chartBase = `${base}.charts[${chartIndex}]`;
+            if (chartNode.kind !== "map") {
+                pushError(validation, "intent-report-chart-invalid", "chart 必须是映射", chartBase, "value");
+                return;
+            }
+            const chart = validateChartNode(chartNode, chartBase, validation);
+            if (chart)
+                charts.push(chart);
+        });
+    }
+    const seen = new Set();
+    for (const chart of charts) {
+        if (seen.has(chart.uuid))
+            pushError(validation, "intent-report-chart-uuid-duplicate", `chart uuid 重复：${chart.uuid}`, `${base}.charts`, "value");
+        seen.add(chart.uuid);
+    }
+    const globalEntry = value("global");
+    const attributesEntry = value("attributes");
+    const removeNode = value("removeUnlistedCharts");
+    const corpNode = value("corpId");
+    const bool = (key) => {
+        const entry = value(key);
+        return entry?.kind === "scalar" && typeof entry.value === "boolean" ? entry.value : undefined;
+    };
+    const pcAble = bool("pcAble");
+    const mobileAble = bool("mobileAble");
+    const removeUnlisted = removeNode?.kind === "scalar" && removeNode.value === true;
+    const icon = value("icon");
+    draft.reports.push({
+        code: code.value.trim(),
+        name: name.value.trim(),
+        appCode: appCode.value.trim(),
+        parentId: parentId.value.trim(),
+        ...(isScalarString(icon) ? { icon: icon.value } : {}),
+        ...(pcAble !== undefined ? { pcAble } : {}),
+        ...(mobileAble !== undefined ? { mobileAble } : {}),
+        ...(isScalarString(corpNode) ? { corpId: corpNode.value } : {}),
+        ...(globalEntry !== undefined ? { global: toPlain(globalEntry) } : {}),
+        ...(attributesEntry !== undefined ? { attributes: toPlain(attributesEntry) } : {}),
+        ...(charts.length > 0 ? { charts } : {}),
+        ...(removeUnlisted ? { removeUnlistedCharts: true } : {}),
+    });
+}
+export const reportCapability = {
+    id: "report",
+    title: "报表",
+    requires: [],
+    operations: ["create", "update", "delete", "configure"],
+    validateRoot(tree, draft, validation) {
+        const reportsNode = tree.entries.find((entry) => entry.key === "reports")?.value;
+        if (reportsNode === undefined || (reportsNode.kind === "scalar" && reportsNode.value === null))
+            return;
+        if (reportsNode.kind !== "seq") {
+            pushError(validation, "intent-reports-not-a-list", "reports 必须是列表", "reports", "value");
+            return;
+        }
+        const seen = new Set();
+        reportsNode.items.forEach((node, index) => {
+            if (node.kind !== "map") {
+                pushError(validation, "intent-report-not-a-map", "report 必须是映射", `reports[${index}]`, "value");
+                return;
+            }
+            const before = draft.reports.length;
+            validateReportNode(node, index, draft, validation);
+            const added = draft.reports[before];
+            if (added && seen.has(added.code))
+                pushError(validation, "intent-report-code-duplicate", `report code 重复：${added.code}`, `reports[${index}].code`, "value");
+            if (added)
+                seen.add(added.code);
+        });
+    },
+    async readRoot(session, intent) {
+        const reports = intent.reports ?? [];
+        const result = [];
+        for (const report of reports) {
+            let page = null;
+            try {
+                page = (await wireCall(session, { path: ENDPOINTS.reportGet, query: { code: report.code } })).data;
+            }
+            catch (error) {
+                if (!(error instanceof WireError && error.kind === "business"))
+                    throw error;
+            }
+            if (!page || !page.id) {
+                result.push({ code: report.code, present: false, name: null, appCode: null, objectId: null, biPresent: false, chartUuids: [] });
+                continue;
+            }
+            const objectId = String(page.id);
+            let biPresent = false;
+            const chartUuids = [];
+            const charts = [];
+            let global;
+            let attributes;
+            try {
+                const data = (await biCall(session, { path: ENDPOINTS.biReportConfig, body: { objectId }, query: { lang: "cn" }, auth: reportAuth(report) }));
+                if (data && typeof data === "object") {
+                    biPresent = true;
+                    if (Array.isArray(data.charts))
+                        for (const chart of data.charts) {
+                            chartUuids.push(String(chart.uuid));
+                            charts.push({ uuid: String(chart.uuid), title: String(chart.title ?? ""), type: String(chart.type ?? "") });
+                        }
+                    global = decodeJson(data.global);
+                    attributes = decodeJson(data.attributes);
+                }
+            }
+            catch (error) {
+                if (!(error instanceof WireError && /dashboard\.not\.exist|does not exist/i.test(error.message)))
+                    throw error;
+            }
+            result.push({
+                code: report.code,
+                present: true,
+                name: typeof page.name === "string" ? page.name : null,
+                appCode: typeof page.appCode === "string" ? page.appCode : null,
+                objectId,
+                biPresent,
+                chartUuids,
+                ...(global !== undefined && !isEmptyObject(global) ? { global } : {}),
+                ...(attributes !== undefined && !isEmptyObject(attributes) ? { attributes } : {}),
+                ...(charts.length > 0 ? { charts } : {}),
+            });
+        }
+        return result;
+    },
+    planRoot(intent, baseline, emit) {
+        const reports = intent.reports ?? [];
+        const current = baseline.reports ?? [];
+        for (const report of reports) {
+            const live = current.find((entry) => entry.code === report.code);
+            const resource = `report:${report.code}`;
+            if (!live?.present) {
+                emit.change("report.create", {
+                    code: report.code,
+                    name: report.name,
+                    appCode: report.appCode,
+                    parentId: report.parentId,
+                    ...(report.icon ? { icon: report.icon } : {}),
+                    ...(report.pcAble !== undefined ? { pcAble: report.pcAble } : {}),
+                    ...(report.mobileAble !== undefined ? { mobileAble: report.mobileAble } : {}),
+                    ...(report.corpId ? { corpId: report.corpId } : {}),
+                }, resource, "report-absent");
+                if (report.global !== undefined || report.attributes !== undefined || (report.charts?.length ?? 0) > 0)
+                    emit.change("report.configure", configureArgs(report), `report:${report.code}#configure`, "report-configure");
+                continue;
+            }
+            if (live.name !== report.name || live.appCode !== report.appCode)
+                emit.change("report.update", {
+                    code: report.code,
+                    name: report.name,
+                    nameI18n: { zh: report.name },
+                    ...(report.icon ? { icon: report.icon } : {}),
+                    ...(report.pcAble !== undefined ? { pcAble: report.pcAble } : {}),
+                    ...(report.mobileAble !== undefined ? { mobileAble: report.mobileAble } : {}),
+                }, resource, "report-drift");
+            if (!live.biPresent)
+                refuse("intent-report-dashboard-absent", `报表 ${report.code} 的 BI dashboard 不存在（页面在但 dashboard 未初始化）；删除页面后用 intent 重建，或走 omc call report.create`, { resource });
+            if (!dashboardNeedsConfigure(report, live)) {
+                emit.skip(resource, "report-present");
+                continue;
+            }
+            emit.change("report.configure", configureArgs(report), `report:${report.code}#configure`, "report-configure");
+        }
+    },
+    decodeRoot(baseline, live) {
+        if (baseline.reports !== undefined)
+            live.reports = baseline.reports.map((report) => ({ ...report }));
+    },
+    compareRoot(intent, live, emit) {
+        for (const report of intent.reports ?? []) {
+            const current = live.reports?.find((entry) => entry.code === report.code);
+            const resource = `report:${report.code}`;
+            if (!current?.present) {
+                emit.difference("report-missing", resource, `报表 ${report.code} 不存在`);
+                continue;
+            }
+            if (current.name !== report.name || current.appCode !== report.appCode)
+                emit.difference("report-mismatch", resource, `报表 ${report.code} 的名称/应用不等价`);
+            if (!current.biPresent) {
+                emit.difference("report-dashboard-missing", resource, `报表 ${report.code} 的 BI dashboard 不存在`);
+                continue;
+            }
+            if (report.global !== undefined && !sameValue(report.global, current.global))
+                emit.difference("report-mismatch", resource, `报表 ${report.code} 的 global 样式不等价`);
+            if (report.attributes !== undefined && !sameValue(report.attributes, current.attributes))
+                emit.difference("report-mismatch", resource, `报表 ${report.code} 的全局筛选不等价`);
+            if (report.charts !== undefined) {
+                const liveCharts = new Map((current.charts ?? []).map((chart) => [chart.uuid, chart]));
+                for (const chart of report.charts) {
+                    const entry = liveCharts.get(chart.uuid);
+                    if (!entry) {
+                        emit.difference("report-charts-mismatch", resource, `报表 ${report.code} 缺图表 ${chart.uuid}`);
+                        continue;
+                    }
+                    if (entry.title !== chart.title || entry.type !== chart.type)
+                        emit.difference("report-charts-mismatch", resource, `报表 ${report.code} 图表 ${chart.uuid} 的标题/类型不等价`);
+                }
+            }
+            if (report.removeUnlistedCharts === true) {
+                const declared = new Set((report.charts ?? []).map((chart) => chart.uuid));
+                const unlisted = current.chartUuids.filter((uuid) => !declared.has(uuid));
+                if (unlisted.length > 0)
+                    emit.difference("report-charts-unexpected", resource, `报表 ${report.code} 含未声明图表：${unlisted.join(", ")}`);
+            }
+        }
+    },
+};
+//# sourceMappingURL=report.js.map