@nocobase/plugin-flow-engine 2.1.0-alpha.13 → 2.1.0-alpha.14

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

@@ -0,0 +1,238 @@
+/**
+ * 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 locator_exports = {};
+__export(locator_exports, {
+  SurfaceLocator: () => SurfaceLocator
+});
+module.exports = __toCommonJS(locator_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_chart_config = require("./chart-config");
+var import_errors = require("./errors");
+class SurfaceLocator {
+  constructor(db, repository) {
+    this.db = db;
+    this.repository = repository;
+  }
+  async resolve(target, options = {}) {
+    var _a;
+    const transaction = options.transaction;
+    if (target.uid) {
+      return this.resolveByUid(target.uid, target, transaction);
+    }
+    if ("tabSchemaUid" in target && target.tabSchemaUid) {
+      return this.resolveByUid(target.tabSchemaUid, target, transaction);
+    }
+    if ("pageSchemaUid" in target && target.pageSchemaUid) {
+      return this.resolvePageSchemaUid(target.pageSchemaUid, target, transaction);
+    }
+    if ("routeId" in target && target.routeId) {
+      const route = await this.db.getRepository("desktopRoutes").findOne({
+        filterByTk: String(target.routeId),
+        transaction
+      });
+      if (isPageRoute(route)) {
+        return this.resolvePageSchemaUid(route.get("schemaUid"), target, transaction);
+      }
+      if ((_a = route == null ? void 0 : route.get) == null ? void 0 : _a.call(route, "schemaUid")) {
+        return this.resolveByUid(route.get("schemaUid"), target, transaction);
+      }
+    }
+    throw new import_errors.FlowSurfaceBadRequestError("flowSurfaces target not found");
+  }
+  async findParentUid(uid, transaction) {
+    var _a;
+    const parentPath = await this.db.getRepository("flowModelTreePath").findOne({
+      filter: {
+        descendant: uid,
+        depth: 1
+      },
+      transaction
+    });
+    return ((_a = parentPath == null ? void 0 : parentPath.get) == null ? void 0 : _a.call(parentPath, "ancestor")) || null;
+  }
+  async findRouteBySchemaUid(schemaUid, transaction) {
+    return this.db.getRepository("desktopRoutes").findOne({
+      filter: {
+        schemaUid
+      },
+      transaction
+    });
+  }
+  async resolveCollectionContext(uid, transaction) {
+    let cursor = uid;
+    while (cursor) {
+      const model = await this.repository.findModelById(cursor, { transaction, includeAsyncNode: true });
+      const resourceInit = import_lodash.default.get(model, ["stepParams", "resourceSettings", "init"]) || ((model == null ? void 0 : model.use) === "ChartBlockModel" ? (0, import_chart_config.getChartBuilderResourceInit)(import_lodash.default.get(model, ["stepParams", "chartSettings", "configure"])) : null);
+      if ((resourceInit == null ? void 0 : resourceInit.dataSourceKey) && (resourceInit == null ? void 0 : resourceInit.collectionName)) {
+        return {
+          ownerUid: cursor,
+          model,
+          resourceInit
+        };
+      }
+      const fieldInit = import_lodash.default.get(model, ["stepParams", "fieldSettings", "init"]);
+      if ((fieldInit == null ? void 0 : fieldInit.dataSourceKey) && (fieldInit == null ? void 0 : fieldInit.collectionName)) {
+        return {
+          ownerUid: cursor,
+          model,
+          resourceInit: {
+            dataSourceKey: fieldInit.dataSourceKey,
+            collectionName: fieldInit.collectionName,
+            associationPathName: fieldInit.associationPathName
+          }
+        };
+      }
+      cursor = await this.findParentUid(cursor, transaction);
+    }
+    return null;
+  }
+  async resolveByUid(uid, target, transaction) {
+    var _a, _b, _c, _d, _e;
+    const node = await this.repository.findModelById(uid, { transaction, includeAsyncNode: true });
+    const route = await this.findRouteBySchemaUid(uid, transaction);
+    if (!(node == null ? void 0 : node.uid) && !route) {
+      throw new import_errors.FlowSurfaceBadRequestError(`flowSurfaces uid '${uid}' not found`);
+    }
+    let pageRoute = null;
+    let tabRoute = null;
+    if (((_a = route == null ? void 0 : route.get) == null ? void 0 : _a.call(route, "type")) === "tabs") {
+      tabRoute = route;
+      pageRoute = route.get("parentId") ? await this.db.getRepository("desktopRoutes").findOne({
+        filterByTk: String(route.get("parentId")),
+        transaction
+      }) : null;
+    } else if (((_b = route == null ? void 0 : route.get) == null ? void 0 : _b.call(route, "type")) === "flowPage" || ((_c = route == null ? void 0 : route.get) == null ? void 0 : _c.call(route, "type")) === "page") {
+      pageRoute = route;
+    } else if (node == null ? void 0 : node.uid) {
+      pageRoute = await this.findPageRouteFromModel(node.uid, transaction).catch(() => {
+        return null;
+      }) || null;
+      tabRoute = await this.findRouteBySchemaUid(node.uid, transaction);
+      if (((_d = tabRoute == null ? void 0 : tabRoute.get) == null ? void 0 : _d.call(tabRoute, "type")) !== "tabs") {
+        tabRoute = null;
+      }
+    }
+    return {
+      target,
+      uid: (node == null ? void 0 : node.uid) || uid,
+      kind: ((_e = tabRoute == null ? void 0 : tabRoute.get) == null ? void 0 : _e.call(tabRoute, "type")) === "tabs" ? "tab" : isPageRoute(pageRoute) ? "page" : inferKind(node == null ? void 0 : node.use),
+      node,
+      route,
+      pageRoute,
+      tabRoute
+    };
+  }
+  async resolvePageSchemaUid(pageSchemaUid, target, transaction) {
+    var _a;
+    const pageModel = await this.repository.findModelByParentId(pageSchemaUid, {
+      transaction,
+      subKey: "page",
+      includeAsyncNode: true
+    });
+    const route = await this.db.getRepository("desktopRoutes").findOne({
+      filter: {
+        schemaUid: pageSchemaUid
+      },
+      transaction
+    });
+    if (pageModel == null ? void 0 : pageModel.uid) {
+      return {
+        target,
+        uid: pageModel.uid,
+        kind: "page",
+        node: pageModel,
+        route,
+        pageRoute: route,
+        pageModel
+      };
+    }
+    if ((_a = route == null ? void 0 : route.get) == null ? void 0 : _a.call(route, "schemaUid")) {
+      return {
+        target,
+        uid: route.get("schemaUid"),
+        kind: "page",
+        route,
+        pageRoute: route,
+        pageModel
+      };
+    }
+    throw new import_errors.FlowSurfaceBadRequestError("flowSurfaces target not found");
+  }
+  async findPageRouteFromModel(uid, transaction) {
+    var _a, _b;
+    let cursor = uid;
+    while (cursor) {
+      const route = await this.findRouteBySchemaUid(cursor, transaction);
+      if (((_a = route == null ? void 0 : route.get) == null ? void 0 : _a.call(route, "type")) === "flowPage" || ((_b = route == null ? void 0 : route.get) == null ? void 0 : _b.call(route, "type")) === "page") {
+        return route;
+      }
+      const parentUid = await this.findParentUid(cursor, transaction);
+      if (!parentUid) {
+        return null;
+      }
+      cursor = parentUid;
+    }
+    return null;
+  }
+}
+function inferKind(use) {
+  if (use === "RouteModel") {
+    return "node";
+  }
+  if (use === "RootPageModel" || use === "ChildPageModel") {
+    return "page";
+  }
+  if (use === "RootPageTabModel" || use === "ChildPageTabModel") {
+    return "tab";
+  }
+  if (/GridModel$/.test(use || "")) {
+    return "grid";
+  }
+  if (/BlockModel$/.test(use || "")) {
+    return "block";
+  }
+  return "node";
+}
+function isPageRoute(route) {
+  var _a;
+  const type = ((_a = route == null ? void 0 : route.get) == null ? void 0 : _a.call(route, "type")) || (route == null ? void 0 : route.type);
+  return type === "flowPage" || type === "page";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SurfaceLocator
+});

package/dist/server/flow-surfaces/placement.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { FlowSurfaceResolvedTarget } from './types';
+export declare const FLOW_SURFACE_POPUP_HOST_USES: Set<string>;
+export declare const FLOW_SURFACE_FORM_BLOCK_USES: Set<string>;
+export declare const FLOW_SURFACE_DETAILS_BLOCK_USES: Set<string>;
+export declare const FLOW_SURFACE_FILTER_FORM_BLOCK_USES: Set<string>;
+export declare const FLOW_SURFACE_GRID_USES: Set<string>;
+export declare const FLOW_SURFACE_FIELD_WRAPPER_USES: Set<string>;
+export declare const FLOW_SURFACE_PAGE_MODEL_USES: Set<string>;
+export declare const FLOW_SURFACE_PAGE_ROUTE_TYPES: Set<string>;
+export declare function isPopupHostUse(use?: string): boolean;
+export declare function isFormBlockUse(use?: string): boolean;
+export declare function isDetailsBlockUse(use?: string): boolean;
+export declare function isFilterFormBlockUse(use?: string): boolean;
+export declare function isGridUse(use?: string): boolean;
+export declare function isFieldWrapperUse(use?: string): boolean;
+export declare function isPageModelUse(use?: string): boolean;
+export declare function isPageRouteType(routeLike?: any): boolean;
+export declare function isTabsRouteType(routeLike?: any): boolean;
+export declare function canCatalogAddBlock(input: {
+    node?: any;
+    resolved?: Pick<FlowSurfaceResolvedTarget, 'route' | 'pageRoute' | 'tabRoute'> | null;
+}): boolean;
+export declare function isFieldContainerUse(parentUse?: string, subKey?: string): boolean;
+export declare function isBlockContainerUse(parentUse?: string, subKey?: string): boolean;
+export declare function isActionContainerUse(parentUse?: string): boolean;

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

@@ -0,0 +1,192 @@
+/**
+ * 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 placement_exports = {};
+__export(placement_exports, {
+  FLOW_SURFACE_DETAILS_BLOCK_USES: () => FLOW_SURFACE_DETAILS_BLOCK_USES,
+  FLOW_SURFACE_FIELD_WRAPPER_USES: () => FLOW_SURFACE_FIELD_WRAPPER_USES,
+  FLOW_SURFACE_FILTER_FORM_BLOCK_USES: () => FLOW_SURFACE_FILTER_FORM_BLOCK_USES,
+  FLOW_SURFACE_FORM_BLOCK_USES: () => FLOW_SURFACE_FORM_BLOCK_USES,
+  FLOW_SURFACE_GRID_USES: () => FLOW_SURFACE_GRID_USES,
+  FLOW_SURFACE_PAGE_MODEL_USES: () => FLOW_SURFACE_PAGE_MODEL_USES,
+  FLOW_SURFACE_PAGE_ROUTE_TYPES: () => FLOW_SURFACE_PAGE_ROUTE_TYPES,
+  FLOW_SURFACE_POPUP_HOST_USES: () => FLOW_SURFACE_POPUP_HOST_USES,
+  canCatalogAddBlock: () => canCatalogAddBlock,
+  isActionContainerUse: () => isActionContainerUse,
+  isBlockContainerUse: () => isBlockContainerUse,
+  isDetailsBlockUse: () => isDetailsBlockUse,
+  isFieldContainerUse: () => isFieldContainerUse,
+  isFieldWrapperUse: () => isFieldWrapperUse,
+  isFilterFormBlockUse: () => isFilterFormBlockUse,
+  isFormBlockUse: () => isFormBlockUse,
+  isGridUse: () => isGridUse,
+  isPageModelUse: () => isPageModelUse,
+  isPageRouteType: () => isPageRouteType,
+  isPopupHostUse: () => isPopupHostUse,
+  isTabsRouteType: () => isTabsRouteType
+});
+module.exports = __toCommonJS(placement_exports);
+const FLOW_SURFACE_POPUP_HOST_USES = /* @__PURE__ */ new Set([
+  "AddNewActionModel",
+  "ViewActionModel",
+  "EditActionModel",
+  "PopupCollectionActionModel",
+  "ClickableFieldModel",
+  "DisplayTextFieldModel",
+  "DisplayEnumFieldModel",
+  "DisplayDateTimeFieldModel",
+  "DisplayNumberFieldModel",
+  "DisplayPercentFieldModel",
+  "DisplayTimeFieldModel",
+  "DisplayAssociationFieldModel",
+  "DisplayAssociationField",
+  "DisplayTitleFieldModel",
+  "DisplayURLFieldModel"
+]);
+const FLOW_SURFACE_FORM_BLOCK_USES = /* @__PURE__ */ new Set([
+  "FormBlockModel",
+  "CreateFormModel",
+  "EditFormModel",
+  "AssignFormModel"
+]);
+const FLOW_SURFACE_DETAILS_BLOCK_USES = /* @__PURE__ */ new Set(["DetailsBlockModel"]);
+const FLOW_SURFACE_FILTER_FORM_BLOCK_USES = /* @__PURE__ */ new Set(["FilterFormBlockModel"]);
+const FLOW_SURFACE_GRID_USES = /* @__PURE__ */ new Set([
+  "BlockGridModel",
+  "FormGridModel",
+  "DetailsGridModel",
+  "FilterFormGridModel",
+  "AssignFormGridModel"
+]);
+const FLOW_SURFACE_FIELD_WRAPPER_USES = /* @__PURE__ */ new Set([
+  "FormItemModel",
+  "DetailsItemModel",
+  "FilterFormItemModel",
+  "TableColumnModel"
+]);
+const FLOW_SURFACE_PAGE_MODEL_USES = /* @__PURE__ */ new Set([
+  "RootPageModel",
+  "ChildPageModel",
+  "RootPageTabModel",
+  "ChildPageTabModel"
+]);
+const FLOW_SURFACE_PAGE_ROUTE_TYPES = /* @__PURE__ */ new Set(["page", "flowPage"]);
+function isPopupHostUse(use) {
+  return FLOW_SURFACE_POPUP_HOST_USES.has(use || "");
+}
+function isFormBlockUse(use) {
+  return FLOW_SURFACE_FORM_BLOCK_USES.has(use || "");
+}
+function isDetailsBlockUse(use) {
+  return FLOW_SURFACE_DETAILS_BLOCK_USES.has(use || "");
+}
+function isFilterFormBlockUse(use) {
+  return FLOW_SURFACE_FILTER_FORM_BLOCK_USES.has(use || "");
+}
+function isGridUse(use) {
+  return FLOW_SURFACE_GRID_USES.has(use || "");
+}
+function isFieldWrapperUse(use) {
+  return FLOW_SURFACE_FIELD_WRAPPER_USES.has(use || "");
+}
+function isPageModelUse(use) {
+  return FLOW_SURFACE_PAGE_MODEL_USES.has(use || "");
+}
+function isPageRouteType(routeLike) {
+  var _a;
+  const type = ((_a = routeLike == null ? void 0 : routeLike.get) == null ? void 0 : _a.call(routeLike, "type")) || (routeLike == null ? void 0 : routeLike.type);
+  return FLOW_SURFACE_PAGE_ROUTE_TYPES.has(type || "");
+}
+function isTabsRouteType(routeLike) {
+  var _a;
+  const type = ((_a = routeLike == null ? void 0 : routeLike.get) == null ? void 0 : _a.call(routeLike, "type")) || (routeLike == null ? void 0 : routeLike.type);
+  return type === "tabs";
+}
+function canCatalogAddBlock(input) {
+  var _a, _b;
+  const node = input.node;
+  const resolved = input.resolved;
+  if (!node && !resolved) {
+    return true;
+  }
+  if (isGridUse(node == null ? void 0 : node.use) || isPageModelUse(node == null ? void 0 : node.use)) {
+    return true;
+  }
+  if (isPopupHostUse(node == null ? void 0 : node.use) || ((_b = (_a = node == null ? void 0 : node.subModels) == null ? void 0 : _a.page) == null ? void 0 : _b.use) === "ChildPageModel") {
+    return true;
+  }
+  if (!(node == null ? void 0 : node.use) && isTabsRouteType(resolved == null ? void 0 : resolved.tabRoute) || (node == null ? void 0 : node.use) === "RouteModel" && isTabsRouteType(resolved == null ? void 0 : resolved.route)) {
+    return true;
+  }
+  if (!(node == null ? void 0 : node.use) && isPageRouteType(resolved == null ? void 0 : resolved.pageRoute) || (node == null ? void 0 : node.use) === "RouteModel" && isPageRouteType(resolved == null ? void 0 : resolved.route)) {
+    return true;
+  }
+  return false;
+}
+function isFieldContainerUse(parentUse, subKey) {
+  if (subKey === "columns" && parentUse === "TableBlockModel") {
+    return true;
+  }
+  return subKey === "items" && (isGridUse(parentUse) || isFormBlockUse(parentUse) || isDetailsBlockUse(parentUse) || isFilterFormBlockUse(parentUse));
+}
+function isBlockContainerUse(parentUse, subKey) {
+  return subKey === "items" && (isGridUse(parentUse) || isPopupHostUse(parentUse));
+}
+function isActionContainerUse(parentUse) {
+  return [
+    "TableBlockModel",
+    "TableActionsColumnModel",
+    "ListBlockModel",
+    "GridCardBlockModel",
+    "ListItemModel",
+    "GridCardItemModel",
+    "ActionPanelBlockModel"
+  ].includes(parentUse || "") || isFormBlockUse(parentUse) || isDetailsBlockUse(parentUse) || isFilterFormBlockUse(parentUse);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FLOW_SURFACE_DETAILS_BLOCK_USES,
+  FLOW_SURFACE_FIELD_WRAPPER_USES,
+  FLOW_SURFACE_FILTER_FORM_BLOCK_USES,
+  FLOW_SURFACE_FORM_BLOCK_USES,
+  FLOW_SURFACE_GRID_USES,
+  FLOW_SURFACE_PAGE_MODEL_USES,
+  FLOW_SURFACE_PAGE_ROUTE_TYPES,
+  FLOW_SURFACE_POPUP_HOST_USES,
+  canCatalogAddBlock,
+  isActionContainerUse,
+  isBlockContainerUse,
+  isDetailsBlockUse,
+  isFieldContainerUse,
+  isFieldWrapperUse,
+  isFilterFormBlockUse,
+  isFormBlockUse,
+  isGridUse,
+  isPageModelUse,
+  isPageRouteType,
+  isPopupHostUse,
+  isTabsRouteType
+});

package/dist/server/flow-surfaces/route-sync.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 FlowModelRepository from '../repository';
+export declare class FlowSurfaceRouteSync {
+    private readonly db;
+    private readonly repository;
+    constructor(db: any, repository: FlowModelRepository);
+    buildPageTree(pageRouteLike: any, transaction?: any): Promise<any>;
+    buildTabAnchor(tabRouteLike: any, transaction?: any): Promise<{
+        subModels?: {
+            grid: Record<string, any>;
+        };
+        uid: string;
+        use: string;
+        props: {
+            route: Record<string, any>;
+            title: string;
+            icon: string;
+        };
+        decoratorProps: Record<string, any>;
+        flowRegistry: Record<string, any>;
+        stepParams: {
+            pageTabSettings: any;
+        };
+    }>;
+    removeRouteAnchorChildren(schemaUid: string, transaction?: any): Promise<void>;
+    removeTabAnchorTree(schemaUid: string, transaction?: any): Promise<void>;
+    persistPageSettings(target: any, current: any, nextPayload: Record<string, any>, transaction?: any): Promise<void>;
+    persistTabSettings(target: any, current: any, nextPayload: Record<string, any>, transaction?: any): Promise<void>;
+    findPersistedTabAnchor(schemaUid: string, transaction?: any): Promise<any>;
+    hydrateRoute(routeLike: any, transaction?: any): Promise<any>;
+    private readPageRouteBackedState;
+    private buildPageRoutePatch;
+    private normalizePagePayload;
+    private buildTabRoutePatch;
+    normalizeTabPayload(current: any, nextPayload: Record<string, any>, routePatch: Record<string, any>): {
+        props: any;
+        stepParams: any;
+        flowRegistry: any;
+    };
+}