@nocobase/plugin-flow-engine 2.1.0-beta.41 → 2.1.0-beta.42

package/dist/server/flow-surfaces/service.js

@@ -81,6 +81,7 @@ var import_placement = require("./placement");
 var import_route_sync = require("./route-sync");
 var import_surface_context = require("./surface-context");
 var import_context = require("./context");
+var import_event_flow_normalizer = require("./event-flow-normalizer");
 var import_configure_options = require("./configure-options");
 var import_public_compatibility = require("./public-compatibility");
 var import_support_matrix = require("./support-matrix");
@@ -103,14 +104,38 @@ var import_template_service_utils = require("./template-service-utils");
 var import_hidden_popup_contract = require("./hidden-popup-contract");
 var import_hidden_popup_calendar = require("./hidden-popup-calendar");
 var import_hidden_popup_kanban = require("./hidden-popup-kanban");
-const FLOW_SURFACE_CHART_REPAIR_HINT = "This is a chart payload shape problem. Repair the current chart block payload using assets.charts.<key>.query/visual plus block.chart, or localized settings.query/settings.visual. Do not change this block type to table, jsBlock, actionPanel, gridCard, or another block type. Do not drop or defer the chart. KPI / summary numbers should use jsBlock; charts are for trends, distributions, rankings, and visual analysis.";
+const FLOW_SURFACE_CHART_REPAIR_HINT = "This is a chart payload shape problem. Keep using chart and repair the current chart block payload using assets.charts.<key>.query/visual plus block.chart, or localized settings.query/settings.visual. Do not change this block type to table, jsBlock, actionPanel, gridCard, or another block type. Do not drop or defer the chart. KPI / summary numbers should use jsBlock; charts are for trends, distributions, rankings, and visual analysis.";
 const FLOW_SURFACE_CHART_REPAIR_STEPS = [
   "Keep the block type as chart.",
-  "Define assets.charts.<key>.query and assets.charts.<key>.visual, or repair the localized settings.query/settings.visual on the existing chart block.",
+  "Define assets.charts.<key>.query and assets.charts.<key>.visual, or fill localized settings.query and settings.visual on the existing chart block.",
   "Reference the asset from the chart block with block.chart = <key> when using assets.charts.",
   "Retry the chart payload instead of replacing the chart with another block type, omitting it, or deferring it."
 ];
 const FLOW_SURFACE_CHART_EXPECTED_SHAPE = {
+  settings: {
+    query: {
+      mode: "builder",
+      resource: {
+        dataSourceKey: "main",
+        collectionName: "employees"
+      },
+      measures: [
+        {
+          field: "id",
+          aggregation: "count",
+          alias: "employeeCount"
+        }
+      ]
+    },
+    visual: {
+      mode: "basic",
+      type: "bar",
+      mappings: {
+        x: "status",
+        y: "employeeCount"
+      }
+    }
+  },
   assets: {
     charts: {
       chartKey: {
@@ -126,29 +151,80 @@ const FLOW_SURFACE_CHART_EXPECTED_SHAPE = {
 };
 const FLOW_SURFACE_CHART_FORBIDDEN_FALLBACKS = [
   "table",
+  "list",
   "jsBlock",
   "actionPanel",
   "gridCard",
+  "markdown",
   "drop chart",
   "defer chart"
 ];
+const FLOW_SURFACE_CHART_REPAIR_EXAMPLE = {
+  settings: {
+    query: {
+      mode: "builder",
+      resource: {
+        dataSourceKey: "main",
+        collectionName: "<collectionName>"
+      },
+      measures: [
+        {
+          field: "id",
+          aggregation: "count",
+          alias: "recordCount"
+        }
+      ],
+      dimensions: [
+        {
+          field: "<dimensionField>"
+        }
+      ]
+    },
+    visual: {
+      mode: "basic",
+      type: "bar",
+      mappings: {
+        x: "<dimensionField>",
+        y: "recordCount"
+      }
+    }
+  }
+};
 function withChartRepairMessage(message) {
   return `${message}. ${FLOW_SURFACE_CHART_REPAIR_HINT}`;
 }
 function withFlowSurfaceChartRepairDetails(details = {}) {
   return {
     ...details,
+    requiredBlockType: "chart",
+    fixStrategy: "repair_same_block_type",
     repairHint: FLOW_SURFACE_CHART_REPAIR_HINT,
     repairSteps: FLOW_SURFACE_CHART_REPAIR_STEPS,
     expectedShape: FLOW_SURFACE_CHART_EXPECTED_SHAPE,
+    repairExample: FLOW_SURFACE_CHART_REPAIR_EXAMPLE,
     forbiddenFallbacks: FLOW_SURFACE_CHART_FORBIDDEN_FALLBACKS
   };
 }
-function throwChartRepairBadRequest(message, details = {}) {
+function throwChartRepairBadRequest(message, options = {}) {
+  const details = import_lodash.default.isPlainObject(options.details) ? options.details : {};
   (0, import_errors.throwBadRequest)(withChartRepairMessage(message), {
+    ...options,
     details: withFlowSurfaceChartRepairDetails(details)
   });
 }
+function isChartConfigureBadRequestError(error) {
+  return error instanceof import_errors.FlowSurfaceBadRequestError && String(error.message || "").startsWith("chart ");
+}
+function buildChartConfigureFromSemanticChangesWithRepair(currentConfigure, changes) {
+  try {
+    return (0, import_chart_config.buildChartConfigureFromSemanticChanges)(currentConfigure, changes);
+  } catch (error) {
+    if (isChartConfigureBadRequestError(error)) {
+      throwChartRepairBadRequest(error.message, error.options);
+    }
+    throw error;
+  }
+}
 function isFlowSurfaceChartRepairError(error) {
   var _a, _b;
   return error instanceof import_errors.FlowSurfaceBadRequestError && ((_b = (_a = error.options) == null ? void 0 : _a.details) == null ? void 0 : _b.repairHint) === FLOW_SURFACE_CHART_REPAIR_HINT;
@@ -1088,7 +1164,7 @@ class FlowSurfacesService {
             parentId: null,
             options: {
               documentTitle: values.tabDocumentTitle,
-              flowRegistry: values.tabFlowRegistry || {}
+              flowRegistry: this.normalizeEventFlowRegistry("createMenu", values.tabFlowRegistry || {})
             }
           }
         ]
@@ -2819,7 +2895,7 @@ class FlowSurfacesService {
           use: "RootPageTabModel",
           props: import_lodash.default.omit(import_lodash.default.cloneDeep((currentNode == null ? void 0 : currentNode.props) || {}), ["route"]),
           decoratorProps: import_lodash.default.cloneDeep((currentNode == null ? void 0 : currentNode.decoratorProps) || {}),
-          flowRegistry: import_lodash.default.cloneDeep((currentNode == null ? void 0 : currentNode.flowRegistry) || {}),
+          flowRegistry: this.getEventFlowRegistry(currentNode),
           stepParams: import_lodash.default.cloneDeep((values == null ? void 0 : values.stepParams) || (currentNode == null ? void 0 : currentNode.stepParams) || {})
         }),
         { transaction: options == null ? void 0 : options.transaction }
@@ -3040,7 +3116,7 @@ class FlowSurfacesService {
         continue;
       }
       (0, import_service_utils.assertSupportedSimpleChanges)("chart", chartAsset, (0, import_configure_options.getConfigureOptionKeysForUse)("ChartBlockModel"));
-      const nextConfigure = (0, import_chart_config.buildChartConfigureFromSemanticChanges)(void 0, chartAsset);
+      const nextConfigure = buildChartConfigureFromSemanticChangesWithRepair(void 0, chartAsset);
       await this.validateChartConfigureForRuntime(
         `applyBlueprint assets.charts.${chartKey}`,
         nextConfigure,
@@ -3450,16 +3526,6 @@ class FlowSurfacesService {
       await this.assertApplyBlueprintAuthoringPayload(values, options);
       const document = (0, import_blueprint.prepareFlowSurfaceApplyBlueprintDocument)(values);
       await this.prevalidateApplyBlueprintChartAssets(document);
-      if (document.mode === "create") {
-        return await this.applyBlueprintWithTransaction(
-          values,
-          { ...options, skipAuthoringValidation: true },
-          createdKanbanSortFields,
-          {
-            readSurface: false
-          }
-        );
-      }
       return await this.transaction(
         (transaction) => this.applyBlueprintWithTransaction(
           values,
@@ -5553,7 +5619,7 @@ class FlowSurfacesService {
           parentId: routeId,
           options: {
             documentTitle: values.tabDocumentTitle,
-            flowRegistry: values.tabFlowRegistry || {}
+            flowRegistry: this.normalizeEventFlowRegistry("createPage", values.tabFlowRegistry || {})
           }
         },
         transaction
@@ -5572,7 +5638,10 @@ class FlowSurfacesService {
           options: {
             ...this.readRouteOptions(tabRoute),
             documentTitle: values.tabDocumentTitle ?? this.readRouteOptions(tabRoute).documentTitle,
-            flowRegistry: values.tabFlowRegistry || this.readRouteOptions(tabRoute).flowRegistry || {}
+            flowRegistry: this.normalizeEventFlowRegistry(
+              "createPage",
+              values.tabFlowRegistry || this.readRouteOptions(tabRoute).flowRegistry || {}
+            )
           }
         },
         transaction
@@ -5714,7 +5783,7 @@ class FlowSurfacesService {
         hidden: !pageRoute.get("enableTabs"),
         options: {
           documentTitle: values.documentTitle,
-          flowRegistry: values.flowRegistry || {}
+          flowRegistry: this.normalizeEventFlowRegistry("addTab", values.flowRegistry || {})
         }
       },
       transaction: options.transaction
@@ -5762,7 +5831,7 @@ class FlowSurfacesService {
           )
         }
       } : void 0,
-      flowRegistry: !import_lodash.default.isUndefined(values.flowRegistry) ? values.flowRegistry : void 0
+      flowRegistry: !import_lodash.default.isUndefined(values.flowRegistry) ? this.normalizeEventFlowRegistry("updateTab", values.flowRegistry) : void 0
     });
     await this.routeSync.persistTabSettings(target, current, nextPayload, options.transaction);
     return {
@@ -5878,7 +5947,7 @@ class FlowSurfacesService {
       title: values.title,
       icon: values.icon,
       documentTitle: values.documentTitle,
-      flowRegistry: values.flowRegistry
+      flowRegistry: this.normalizeEventFlowRegistry("addPopupTab", values.flowRegistry)
     });
     await this.repository.upsertModel(
       {
@@ -5933,7 +6002,7 @@ class FlowSurfacesService {
           }
         }
       } : void 0,
-      flowRegistry: !import_lodash.default.isUndefined(values.flowRegistry) ? values.flowRegistry : void 0
+      flowRegistry: !import_lodash.default.isUndefined(values.flowRegistry) ? this.normalizeEventFlowRegistry("updatePopupTab", values.flowRegistry) : void 0
     });
     if (Object.keys(nextPayload).length === 1) {
       return { uid: popupTab.uid };
@@ -6134,7 +6203,7 @@ class FlowSurfacesService {
           use: "ReferenceFormGridModel",
           props: currentGrid.props,
           decoratorProps: currentGrid.decoratorProps,
-          flowRegistry: currentGrid.flowRegistry,
+          flowRegistry: this.getEventFlowRegistry(currentGrid),
           sortIndex: currentGrid.sortIndex,
           parentId: blockUid,
           subKey: "grid",
@@ -7390,7 +7459,7 @@ class FlowSurfacesService {
       props: actionSettingsPayload.props,
       decoratorProps: values.decoratorProps,
       stepParams: actionSettingsPayload.stepParams,
-      flowRegistry: values.flowRegistry
+      flowRegistry: this.normalizeEventFlowRegistry("addAction", values.flowRegistry)
     });
     this.contractGuard.validateNodeTreeAgainstContract(action);
     const created = await this.repository.upsertModel(
@@ -7517,7 +7586,7 @@ class FlowSurfacesService {
       props: actionSettingsPayload.props,
       decoratorProps: values.decoratorProps,
       stepParams: actionSettingsPayload.stepParams,
-      flowRegistry: values.flowRegistry
+      flowRegistry: this.normalizeEventFlowRegistry("addRecordAction", values.flowRegistry)
     });
     this.contractGuard.validateNodeTreeAgainstContract(action);
     const created = await this.repository.upsertModel(
@@ -7569,7 +7638,8 @@ class FlowSurfacesService {
         },
         {
           ...options,
-          preserveSingleScopeDataBlockTitle
+          preserveSingleScopeDataBlockTitle,
+          skipAuthoringValidation: true
         }
       )
     });
@@ -11157,6 +11227,7 @@ class FlowSurfacesService {
       }
       if (domain === "flowRegistry") {
         this.assertNoTreeConnectFieldsFlowRegistry(current, normalizedValues[domain], "updateSettings");
+        normalizedValues[domain] = this.normalizeEventFlowRegistry("updateSettings", normalizedValues[domain]);
       }
       if (!contract.editableDomains.includes(domain)) {
         (0, import_errors.throwBadRequest)(`flowSurfaces updateSettings domain '${domain}' is not editable`);
@@ -11173,6 +11244,9 @@ class FlowSurfacesService {
         current.use
       );
     });
+    if (!import_lodash.default.isUndefined(nextPayload.flowRegistry)) {
+      nextPayload.flowRegistry = this.normalizeEventFlowRegistry("updateSettings", nextPayload.flowRegistry);
+    }
     this.replaceExplicitPopupStepParamSubtreesForUpdateSettings(
       current,
       normalizedValues,
@@ -11239,7 +11313,7 @@ class FlowSurfacesService {
       props: nextPayload.props ?? current.props,
       decoratorProps: nextPayload.decoratorProps ?? current.decoratorProps,
       stepParams: nextPayload.stepParams ?? current.stepParams,
-      flowRegistry: nextPayload.flowRegistry ?? current.flowRegistry
+      flowRegistry: nextPayload.flowRegistry ?? this.getEventFlowRegistry(current)
     };
     const shouldValidateFlowRegistry = !import_lodash.default.isUndefined(nextPayload.flowRegistry) || !import_lodash.default.isUndefined(nextPayload.stepParams);
     assertNoFlowSurfaceIdTitleFieldSettings(import_lodash.default.pick(effectiveNode, ["props", "stepParams"]), {
@@ -12448,6 +12522,8 @@ class FlowSurfacesService {
       options
     );
     const flowRegistry = this.getEventFlowRegistry(current);
+    const directEvents = import_lodash.default.cloneDeep(((_a = contract.eventCapabilities) == null ? void 0 : _a.direct) || []);
+    const objectEvents = import_lodash.default.uniq([...import_lodash.default.cloneDeep(((_b = contract.eventCapabilities) == null ? void 0 : _b.object) || []), ...directEvents]);
     return {
       target: {
         uid: target.uid,
@@ -12456,8 +12532,8 @@ class FlowSurfacesService {
       },
       flowRegistry,
       events: {
-        direct: import_lodash.default.cloneDeep(((_a = contract.eventCapabilities) == null ? void 0 : _a.direct) || []),
-        object: import_lodash.default.cloneDeep(((_b = contract.eventCapabilities) == null ? void 0 : _b.object) || [])
+        direct: directEvents,
+        object: objectEvents
       },
       phases: {
         supported: ["beforeAllFlows", "afterAllFlows", "beforeFlow", "afterFlow", "beforeStep", "afterStep"],
@@ -12492,13 +12568,12 @@ class FlowSurfacesService {
     if (phase !== "beforeAllFlows") {
       (0, import_errors.throwBadRequest)(`flowSurfaces addEventFlow only supports phase 'beforeAllFlows'`);
     }
-    const flow = this.normalizeAddEventFlowInput(key, values, phase);
-    const nextFlowRegistry = {
+    const nextFlowRegistry = this.normalizeEventFlowRegistry("addEventFlow", {
       ...flowRegistry,
-      [key]: flow
-    };
+      [key]: this.normalizeAddEventFlowInput(key, values, phase)
+    });
     await this.persistEventFlowRegistry("addEventFlow", target, current, nextFlowRegistry, options);
-    return this.buildEventFlowWriteResult(target, key, flow, nextFlowRegistry);
+    return this.buildEventFlowWriteResult(target, key, nextFlowRegistry[key], nextFlowRegistry);
   }
   async setEventFlow(values, options = {}) {
     var _a;
@@ -12512,13 +12587,12 @@ class FlowSurfacesService {
     const key = this.normalizeEventFlowKey("setEventFlow", (values == null ? void 0 : values.key) ?? ((_a = values == null ? void 0 : values.flow) == null ? void 0 : _a.key));
     this.assertEventFlowFingerprint("setEventFlow", values == null ? void 0 : values.expectedFingerprint, flowRegistry);
     const flowInput = import_lodash.default.isPlainObject(values == null ? void 0 : values.flow) ? values.flow : values;
-    const flow = this.normalizeEventFlowObject("setEventFlow", key, flowInput);
-    const nextFlowRegistry = {
+    const nextFlowRegistry = this.normalizeEventFlowRegistry("setEventFlow", {
       ...flowRegistry,
-      [key]: flow
-    };
+      [key]: this.normalizeEventFlowObject("setEventFlow", key, flowInput)
+    });
     await this.persistEventFlowRegistry("setEventFlow", target, current, nextFlowRegistry, options);
-    return this.buildEventFlowWriteResult(target, key, flow, nextFlowRegistry);
+    return this.buildEventFlowWriteResult(target, key, nextFlowRegistry[key], nextFlowRegistry);
   }
   async removeEventFlow(values, options = {}) {
     (0, import_payload_shape.validateFlowSurfacePayloadShape)("removeEventFlow", values, "values");
@@ -12533,14 +12607,14 @@ class FlowSurfacesService {
       (0, import_errors.throwBadRequest)(`flowSurfaces removeEventFlow flow '${key}' does not exist`);
     }
     this.assertEventFlowFingerprint("removeEventFlow", values == null ? void 0 : values.expectedFingerprint, flowRegistry);
-    const nextFlowRegistry = import_lodash.default.omit(flowRegistry, [key]);
+    const nextFlowRegistry = this.normalizeEventFlowRegistry("removeEventFlow", import_lodash.default.omit(flowRegistry, [key]));
     await this.persistEventFlowRegistry("removeEventFlow", target, current, nextFlowRegistry, options);
     return this.buildEventFlowWriteResult(target, key, void 0, nextFlowRegistry);
   }
   async setEventFlows(values, options = {}) {
     (0, import_payload_shape.validateFlowSurfacePayloadShape)("setEventFlows", values, "values");
     const { target, current } = await this.resolveEventFlowTarget("setEventFlows", values == null ? void 0 : values.target, values, options);
-    const flows = values.flowRegistry || values.flows || {};
+    const flows = this.normalizeEventFlowRegistry("setEventFlows", values.flowRegistry || values.flows || {});
     await this.persistEventFlowRegistry("setEventFlows", target, current, flows, options);
     return {
       uid: target.uid,
@@ -12566,7 +12640,10 @@ class FlowSurfacesService {
     };
   }
   getEventFlowRegistry(node) {
-    return import_lodash.default.isPlainObject(node == null ? void 0 : node.flowRegistry) ? import_lodash.default.cloneDeep(node.flowRegistry) : {};
+    return import_lodash.default.isPlainObject(node == null ? void 0 : node.flowRegistry) ? this.normalizeEventFlowRegistry("getEventFlowRegistry", node.flowRegistry) : {};
+  }
+  normalizeEventFlowRegistry(actionName, flowRegistry) {
+    return (0, import_event_flow_normalizer.normalizeFlowSurfaceEventFlowRegistry)(actionName, flowRegistry);
   }
   buildEventFlowFingerprint(flowRegistry) {
     return this.buildSurfaceFingerprint({
@@ -12604,7 +12681,9 @@ class FlowSurfacesService {
   normalizeAddEventFlowInput(key, values, phase) {
     var _a, _b, _c;
     const flow = import_lodash.default.isPlainObject(values.flow) ? import_lodash.default.cloneDeep(values.flow) : {};
-    const eventName = String(values.eventName ?? ((_a = flow == null ? void 0 : flow.on) == null ? void 0 : _a.eventName) ?? "").trim();
+    const eventName = String(
+      values.eventName ?? (typeof flow.on === "string" ? flow.on : (_a = flow == null ? void 0 : flow.on) == null ? void 0 : _a.eventName) ?? ""
+    ).trim();
     if (!eventName) {
       (0, import_errors.throwBadRequest)(`flowSurfaces addEventFlow requires eventName`);
     }
@@ -12627,25 +12706,7 @@ class FlowSurfacesService {
     });
   }
   normalizeEventFlowObject(actionName, key, flowInput) {
-    if (!import_lodash.default.isPlainObject(flowInput)) {
-      (0, import_errors.throwBadRequest)(`flowSurfaces ${actionName} flow '${key}' must be an object`);
-    }
-    const flow = import_lodash.default.cloneDeep(flowInput);
-    flow.key = key;
-    if (import_lodash.default.isPlainObject(flow.on)) {
-      const eventName = String(flow.on.eventName || "").trim();
-      if (eventName) {
-        flow.on.eventName = eventName;
-      }
-      const phase = String(flow.on.phase || "").trim();
-      if (phase) {
-        flow.on.phase = phase;
-      }
-    }
-    if (import_lodash.default.isUndefined(flow.steps)) {
-      flow.steps = {};
-    }
-    return flow;
+    return (0, import_event_flow_normalizer.normalizeFlowSurfaceEventFlow)(actionName, key, flowInput);
   }
   async persistEventFlowRegistry(actionName, target, current, flowRegistry, options = {}) {
     this.assertNoTreeConnectFieldsFlowRegistry(current, flowRegistry, actionName);
@@ -16037,7 +16098,10 @@ class FlowSurfacesService {
     const shouldLoadCurrent = shouldUpdateConfigure || shouldUpdateCardSettings;
     const resolved = shouldLoadCurrent ? await this.locator.resolve(target, options) : null;
     const current = resolved ? await this.loadResolvedNode(resolved, options.transaction) : null;
-    let nextConfigure = shouldUpdateConfigure ? (0, import_chart_config.buildChartConfigureFromSemanticChanges)(import_lodash.default.get(current, ["stepParams", "chartSettings", "configure"]), changes) : void 0;
+    let nextConfigure = shouldUpdateConfigure ? buildChartConfigureFromSemanticChangesWithRepair(
+      import_lodash.default.get(current, ["stepParams", "chartSettings", "configure"]),
+      changes
+    ) : void 0;
     if (shouldUpdateConfigure) {
       nextConfigure = await this.stripBasicSqlVisualWhenPreviewUnavailable(nextConfigure, changes, options.transaction);
     }
@@ -21637,7 +21701,7 @@ ${AI_EMPLOYEE_CURRENT_RECORD_PROMPT_VARIABLE}` : AI_EMPLOYEE_CURRENT_RECORD_PROM
         (value) => !import_lodash.default.isUndefined(value)
       ),
       decoratorProps: import_lodash.default.cloneDeep(innerField.decoratorProps || {}),
-      flowRegistry: import_lodash.default.cloneDeep(innerField.flowRegistry || {}),
+      flowRegistry: this.getEventFlowRegistry(innerField),
       stepParams: import_lodash.default.merge({}, innerField.stepParams || {}, {
         fieldBinding: {
           use: normalizedTargetUse

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "前端流引擎",
   "description": "",
   "description.zh-CN": "",
-  "version": "2.1.0-beta.41",
+  "version": "2.1.0-beta.42",
   "main": "./dist/server/index.js",
   "license": "Apache-2.0",
   "devDependencies": {
@@ -26,5 +26,5 @@
     "@nocobase/test": "2.x",
     "@nocobase/utils": "2.x"
   },
-  "gitHead": "ea3f966811146edb13c9e8016bf4cdc81597a003"
+  "gitHead": "619b4d06c934bf3266ba7f388438db018217c87d"
 }