@nocobase/plugin-flow-engine 2.1.0-alpha.2 → 2.1.0-alpha.20

package/dist/server/flow-surfaces/blueprint/compile-plan.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { FlowSurfaceApplyBlueprintDocument, FlowSurfaceApplyBlueprintProgram, FlowSurfaceApplyBlueprintReplaceTargetInfo } from './public-types';
+export declare function compileFlowSurfaceApplyBlueprintRequest(document: FlowSurfaceApplyBlueprintDocument, options?: {
+    replaceTarget?: FlowSurfaceApplyBlueprintReplaceTargetInfo;
+}): FlowSurfaceApplyBlueprintProgram;
+export declare function resolveApplyBlueprintPageLocator(program: FlowSurfaceApplyBlueprintProgram, executeResult: Record<string, any> | undefined): import("../types").FlowSurfaceReadLocator;

package/dist/server/flow-surfaces/blueprint/compile-plan.js

@@ -0,0 +1,308 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var compile_plan_exports = {};
+__export(compile_plan_exports, {
+  compileFlowSurfaceApplyBlueprintRequest: () => compileFlowSurfaceApplyBlueprintRequest,
+  resolveApplyBlueprintPageLocator: () => resolveApplyBlueprintPageLocator
+});
+module.exports = __toCommonJS(compile_plan_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_errors = require("../errors");
+var import_service_utils = require("../service-utils");
+var import_compile_blocks = require("./compile-blocks");
+var import_compile_reaction = require("./compile-reaction");
+const CREATE_MENU_ITEM_STEP_ID = "blueprintMenuItem";
+const CREATE_MENU_GROUP_STEP_ID = "blueprintMenuGroup";
+const CREATE_PAGE_STEP_ID = "blueprintPage";
+const PAGE_CONFIGURE_STEP_ID = "blueprintPageConfigure";
+function buildApplyBlueprintTabStepId(kind, tabIndex) {
+  const suffix = tabIndex + 1;
+  if (kind === "compose") {
+    return `blueprintComposeTab__${suffix}`;
+  }
+  if (kind === "add") {
+    return `blueprintAddTab__${suffix}`;
+  }
+  return `blueprintUpdateTab__${suffix}`;
+}
+function buildPageChrome(document) {
+  var _a, _b, _c, _d;
+  const firstTab = document.tabs[0];
+  const pageTitle = ((_a = document.page) == null ? void 0 : _a.title) || ((_c = (_b = document.navigation) == null ? void 0 : _b.item) == null ? void 0 : _c.title) || (firstTab == null ? void 0 : firstTab.title) || "Untitled page";
+  return {
+    pageTitle,
+    tabTitle: (firstTab == null ? void 0 : firstTab.title) || pageTitle,
+    tabIcon: firstTab == null ? void 0 : firstTab.icon,
+    tabDocumentTitle: firstTab == null ? void 0 : firstTab.documentTitle,
+    enableTabs: ((_d = document.page) == null ? void 0 : _d.enableTabs) ?? document.tabs.length > 1
+  };
+}
+function buildTabSelectorFromStep(stepId, path = "tabSchemaUid") {
+  return {
+    step: stepId,
+    path
+  };
+}
+function buildTabSelectorFromUid(uid) {
+  return {
+    locator: { uid }
+  };
+}
+function compileCreatePlan(document) {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A;
+  const steps = [];
+  const chrome = buildPageChrome(document);
+  if (import_lodash.default.isPlainObject((_a = document.navigation) == null ? void 0 : _a.group) && import_lodash.default.isUndefined(document.navigation.group.routeId)) {
+    steps.push({
+      id: CREATE_MENU_GROUP_STEP_ID,
+      action: "createMenu",
+      values: (0, import_service_utils.buildDefinedPayload)({
+        title: (_c = (_b = document.navigation) == null ? void 0 : _b.group) == null ? void 0 : _c.title,
+        type: "group",
+        icon: (_e = (_d = document.navigation) == null ? void 0 : _d.group) == null ? void 0 : _e.icon,
+        tooltip: (_g = (_f = document.navigation) == null ? void 0 : _f.group) == null ? void 0 : _g.tooltip,
+        hideInMenu: (_i = (_h = document.navigation) == null ? void 0 : _h.group) == null ? void 0 : _i.hideInMenu
+      })
+    });
+  }
+  steps.push({
+    id: CREATE_MENU_ITEM_STEP_ID,
+    action: "createMenu",
+    values: (0, import_service_utils.buildDefinedPayload)({
+      title: ((_k = (_j = document.navigation) == null ? void 0 : _j.item) == null ? void 0 : _k.title) || chrome.pageTitle,
+      type: "item",
+      icon: (_m = (_l = document.navigation) == null ? void 0 : _l.item) == null ? void 0 : _m.icon,
+      tooltip: (_o = (_n = document.navigation) == null ? void 0 : _n.item) == null ? void 0 : _o.tooltip,
+      hideInMenu: (_q = (_p = document.navigation) == null ? void 0 : _p.item) == null ? void 0 : _q.hideInMenu,
+      parentMenuRouteId: import_lodash.default.isUndefined((_s = (_r = document.navigation) == null ? void 0 : _r.group) == null ? void 0 : _s.routeId) ? ((_u = (_t = document.navigation) == null ? void 0 : _t.group) == null ? void 0 : _u.title) ? { step: CREATE_MENU_GROUP_STEP_ID, path: "routeId" } : void 0 : (_w = (_v = document.navigation) == null ? void 0 : _v.group) == null ? void 0 : _w.routeId
+    })
+  });
+  steps.push({
+    id: CREATE_PAGE_STEP_ID,
+    action: "createPage",
+    values: (0, import_service_utils.buildDefinedPayload)({
+      menuRouteId: { step: CREATE_MENU_ITEM_STEP_ID, path: "routeId" },
+      title: chrome.pageTitle,
+      icon: (_x = document.page) == null ? void 0 : _x.icon,
+      documentTitle: (_y = document.page) == null ? void 0 : _y.documentTitle,
+      enableHeader: (_z = document.page) == null ? void 0 : _z.enableHeader,
+      enableTabs: chrome.enableTabs,
+      displayTitle: (_A = document.page) == null ? void 0 : _A.displayTitle,
+      tabTitle: chrome.tabTitle,
+      tabIcon: chrome.tabIcon,
+      tabDocumentTitle: chrome.tabDocumentTitle,
+      tabSchemaName: document.tabs[0].key
+    })
+  });
+  steps.push({
+    id: buildApplyBlueprintTabStepId("compose", 0),
+    action: "compose",
+    selectors: {
+      target: buildTabSelectorFromStep(CREATE_PAGE_STEP_ID)
+    },
+    values: (0, import_compile_blocks.compileTabComposeValues)(document.tabs[0], document, 0, { mode: "append" })
+  });
+  document.tabs.slice(1).forEach((tab, offset) => {
+    const tabIndex = offset + 1;
+    const addTabStepId = buildApplyBlueprintTabStepId("add", tabIndex);
+    steps.push({
+      id: addTabStepId,
+      action: "addTab",
+      selectors: {
+        target: {
+          step: CREATE_PAGE_STEP_ID,
+          path: "pageUid"
+        }
+      },
+      values: (0, import_service_utils.buildDefinedPayload)({
+        title: tab.title || tab.key,
+        icon: tab.icon,
+        documentTitle: tab.documentTitle,
+        tabSchemaName: tab.key
+      })
+    });
+    steps.push({
+      id: buildApplyBlueprintTabStepId("compose", tabIndex),
+      action: "compose",
+      selectors: {
+        target: buildTabSelectorFromStep(addTabStepId)
+      },
+      values: (0, import_compile_blocks.compileTabComposeValues)(tab, document, tabIndex, { mode: "append" })
+    });
+  });
+  steps.push(...(0, import_compile_reaction.compileReactionPlanSteps)(document.reaction));
+  return {
+    document,
+    steps,
+    pageLocator: {}
+  };
+}
+function buildPageConfigureChanges(document) {
+  var _a, _b, _c, _d, _e, _f;
+  return (0, import_service_utils.buildDefinedPayload)({
+    title: (_a = document.page) == null ? void 0 : _a.title,
+    icon: (_b = document.page) == null ? void 0 : _b.icon,
+    documentTitle: (_c = document.page) == null ? void 0 : _c.documentTitle,
+    enableHeader: (_d = document.page) == null ? void 0 : _d.enableHeader,
+    enableTabs: (_e = document.page) == null ? void 0 : _e.enableTabs,
+    displayTitle: (_f = document.page) == null ? void 0 : _f.displayTitle
+  });
+}
+function compileReplacePlan(document, targetInfo) {
+  const steps = [];
+  const pageChanges = buildPageConfigureChanges(document);
+  if (Object.keys(pageChanges).length) {
+    steps.push({
+      id: PAGE_CONFIGURE_STEP_ID,
+      action: "configure",
+      selectors: {
+        target: {
+          locator: {
+            uid: targetInfo.pageUid
+          }
+        }
+      },
+      values: {
+        changes: pageChanges
+      }
+    });
+  }
+  document.tabs.forEach((tab, index) => {
+    const existingTab = targetInfo.tabs[index];
+    if (existingTab) {
+      const tabChanges = (0, import_service_utils.buildDefinedPayload)({
+        title: tab.title,
+        icon: tab.icon,
+        documentTitle: tab.documentTitle
+      });
+      if (Object.keys(tabChanges).length) {
+        steps.push({
+          id: buildApplyBlueprintTabStepId("update", index),
+          action: "updateTab",
+          selectors: {
+            target: buildTabSelectorFromUid(existingTab.uid)
+          },
+          values: tabChanges
+        });
+      }
+      steps.push({
+        id: buildApplyBlueprintTabStepId("compose", index),
+        action: "compose",
+        selectors: {
+          target: buildTabSelectorFromUid(existingTab.uid)
+        },
+        values: (0, import_compile_blocks.compileTabComposeValues)(tab, document, index, { mode: "replace" })
+      });
+      return;
+    }
+    const addTabStepId = buildApplyBlueprintTabStepId("add", index);
+    steps.push({
+      id: addTabStepId,
+      action: "addTab",
+      selectors: {
+        target: {
+          locator: {
+            uid: targetInfo.pageUid
+          }
+        }
+      },
+      values: (0, import_service_utils.buildDefinedPayload)({
+        title: tab.title || tab.key,
+        icon: tab.icon,
+        documentTitle: tab.documentTitle,
+        tabSchemaName: tab.key
+      })
+    });
+    steps.push({
+      id: buildApplyBlueprintTabStepId("compose", index),
+      action: "compose",
+      selectors: {
+        target: buildTabSelectorFromStep(addTabStepId)
+      },
+      values: (0, import_compile_blocks.compileTabComposeValues)(tab, document, index, { mode: "append" })
+    });
+  });
+  targetInfo.tabs.slice(document.tabs.length).reverse().forEach((tab, index) => {
+    steps.push({
+      id: `blueprintRemoveTab__${index + 1}`,
+      action: "removeTab",
+      selectors: {
+        target: buildTabSelectorFromUid(tab.uid)
+      }
+    });
+  });
+  steps.push(...(0, import_compile_reaction.compileReactionPlanSteps)(document.reaction));
+  return {
+    document,
+    surface: {
+      locator: import_lodash.default.cloneDeep(targetInfo.locator)
+    },
+    steps,
+    pageLocator: import_lodash.default.cloneDeep(targetInfo.locator),
+    pageUid: targetInfo.pageUid
+  };
+}
+function compileFlowSurfaceApplyBlueprintRequest(document, options = {}) {
+  if (document.mode === "create") {
+    return compileCreatePlan(document);
+  }
+  if (!options.replaceTarget) {
+    (0, import_errors.throwBadRequest)(`flowSurfaces applyBlueprint replace target resolution is missing`);
+  }
+  return compileReplacePlan(document, options.replaceTarget);
+}
+function resolveApplyBlueprintPageLocator(program, executeResult) {
+  var _a, _b, _c;
+  if (program.document.mode === "replace") {
+    return import_lodash.default.cloneDeep(program.pageLocator);
+  }
+  const resultById = Object.fromEntries(
+    import_lodash.default.castArray((executeResult == null ? void 0 : executeResult.results) || []).map((item) => [String((item == null ? void 0 : item.id) || (item == null ? void 0 : item.index)), item == null ? void 0 : item.result])
+  );
+  const pageSchemaUid = ((_a = resultById[CREATE_PAGE_STEP_ID]) == null ? void 0 : _a.pageSchemaUid) || ((_c = (_b = executeResult == null ? void 0 : executeResult.target) == null ? void 0 : _b.locator) == null ? void 0 : _c.pageSchemaUid) || void 0;
+  if (!pageSchemaUid) {
+    (0, import_errors.throwBadRequest)(`flowSurfaces applyBlueprint failed to resolve created pageSchemaUid`);
+  }
+  return {
+    pageSchemaUid: String(pageSchemaUid)
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  compileFlowSurfaceApplyBlueprintRequest,
+  resolveApplyBlueprintPageLocator
+});

package/dist/server/flow-surfaces/blueprint/compile-reaction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { FlowSurfacePlanStep } from '../types';
+import type { FlowSurfaceApplyBlueprintDocument } from './public-types';
+export declare function compileReactionPlanSteps(reaction: FlowSurfaceApplyBlueprintDocument['reaction'] | undefined): FlowSurfacePlanStep[];

package/dist/server/flow-surfaces/blueprint/compile-reaction.js

@@ -0,0 +1,72 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var compile_reaction_exports = {};
+__export(compile_reaction_exports, {
+  compileReactionPlanSteps: () => compileReactionPlanSteps
+});
+module.exports = __toCommonJS(compile_reaction_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_service_utils = require("../service-utils");
+function buildReactionStepId(index) {
+  return `blueprintReaction__${index + 1}`;
+}
+function compileReactionItem(item, index) {
+  return {
+    id: buildReactionStepId(index),
+    action: item.type,
+    selectors: {
+      target: {
+        key: item.target
+      }
+    },
+    values: (0, import_service_utils.buildDefinedPayload)({
+      rules: import_lodash.default.cloneDeep(item.rules),
+      expectedFingerprint: item.expectedFingerprint
+    })
+  };
+}
+function compileReactionPlanSteps(reaction) {
+  const reactionItems = import_lodash.default.castArray((reaction == null ? void 0 : reaction.items) || []);
+  if (!reactionItems.length) {
+    return [];
+  }
+  return reactionItems.map((item, index) => compileReactionItem(item, index));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  compileReactionPlanSteps
+});

package/dist/server/flow-surfaces/blueprint/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export type { FlowSurfaceApplyBlueprintAssetMap, FlowSurfaceApplyBlueprintAssets, FlowSurfaceApplyBlueprintDocument, FlowSurfaceApplyBlueprintMode, FlowSurfaceApplyBlueprintNavigation, FlowSurfaceApplyBlueprintNavigationGroup, FlowSurfaceApplyBlueprintPage, FlowSurfaceApplyBlueprintProgram, FlowSurfaceApplyBlueprintReaction, FlowSurfaceApplyBlueprintReplaceTargetInfo, FlowSurfaceApplyBlueprintTabDocument, FlowSurfaceApplyBlueprintTarget, } from './public-types';
+export { prepareFlowSurfaceApplyBlueprintDocument } from './normalize-document';
+export { compileFlowSurfaceApplyBlueprintRequest, resolveApplyBlueprintPageLocator } from './compile-plan';
+export { compileReactionPlanSteps } from './compile-reaction';

package/dist/server/flow-surfaces/blueprint/index.js

@@ -0,0 +1,44 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var blueprint_exports = {};
+__export(blueprint_exports, {
+  compileFlowSurfaceApplyBlueprintRequest: () => import_compile_plan.compileFlowSurfaceApplyBlueprintRequest,
+  compileReactionPlanSteps: () => import_compile_reaction.compileReactionPlanSteps,
+  prepareFlowSurfaceApplyBlueprintDocument: () => import_normalize_document.prepareFlowSurfaceApplyBlueprintDocument,
+  resolveApplyBlueprintPageLocator: () => import_compile_plan.resolveApplyBlueprintPageLocator
+});
+module.exports = __toCommonJS(blueprint_exports);
+var import_normalize_document = require("./normalize-document");
+var import_compile_plan = require("./compile-plan");
+var import_compile_reaction = require("./compile-reaction");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  compileFlowSurfaceApplyBlueprintRequest,
+  compileReactionPlanSteps,
+  prepareFlowSurfaceApplyBlueprintDocument,
+  resolveApplyBlueprintPageLocator
+});

package/dist/server/flow-surfaces/blueprint/normalize-document.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { FlowSurfaceApplyBlueprintDocument } from './public-types';
+export declare function prepareFlowSurfaceApplyBlueprintDocument(input: Record<string, any>): FlowSurfaceApplyBlueprintDocument;