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

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

@@ -0,0 +1,133 @@
+/**
+ * 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 defaults_exports = {};
+__export(defaults_exports, {
+  FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY: () => FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY,
+  attachFlowSurfaceApplyBlueprintPopupDefaults: () => attachFlowSurfaceApplyBlueprintPopupDefaults,
+  buildFlowSurfaceApplyBlueprintPopupDefaultsMetadata: () => buildFlowSurfaceApplyBlueprintPopupDefaultsMetadata,
+  getFlowSurfaceApplyBlueprintDefaultCollection: () => getFlowSurfaceApplyBlueprintDefaultCollection,
+  hasFlowSurfaceApplyBlueprintDefaults: () => hasFlowSurfaceApplyBlueprintDefaults,
+  readFlowSurfaceApplyBlueprintPopupDefaultsMetadata: () => readFlowSurfaceApplyBlueprintPopupDefaultsMetadata,
+  resolveFlowSurfaceApplyBlueprintDefaultPopupMetadata: () => resolveFlowSurfaceApplyBlueprintDefaultPopupMetadata
+});
+module.exports = __toCommonJS(defaults_exports);
+var import_lodash = __toESM(require("lodash"));
+const FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY = "__flowSurfaceApplyBlueprintPopupDefaults";
+function hasFlowSurfaceApplyBlueprintDefaults(defaults) {
+  return import_lodash.default.isPlainObject(defaults == null ? void 0 : defaults.collections) && Object.keys((defaults == null ? void 0 : defaults.collections) || {}).length > 0;
+}
+function buildFlowSurfaceApplyBlueprintPopupDefaultsMetadata(defaults) {
+  if (!hasFlowSurfaceApplyBlueprintDefaults(defaults)) {
+    return void 0;
+  }
+  return {
+    collections: defaults == null ? void 0 : defaults.collections
+  };
+}
+function attachFlowSurfaceApplyBlueprintPopupDefaults(popup, metadata) {
+  if (!metadata) {
+    return popup;
+  }
+  return {
+    ...import_lodash.default.isPlainObject(popup) ? import_lodash.default.cloneDeep(popup) : {},
+    [FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY]: import_lodash.default.cloneDeep(metadata)
+  };
+}
+function readFlowSurfaceApplyBlueprintPopupDefaultsMetadata(value) {
+  const metadata = value == null ? void 0 : value[FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY];
+  if (!import_lodash.default.isPlainObject(metadata) || !import_lodash.default.isPlainObject(metadata.collections)) {
+    return void 0;
+  }
+  return metadata;
+}
+function getFlowSurfaceApplyBlueprintDefaultCollection(metadata, collectionName) {
+  var _a;
+  const normalizedCollectionName = String(collectionName || "").trim();
+  if (!normalizedCollectionName) {
+    return void 0;
+  }
+  const collectionDefaults = (_a = metadata == null ? void 0 : metadata.collections) == null ? void 0 : _a[normalizedCollectionName];
+  return import_lodash.default.isPlainObject(collectionDefaults) ? collectionDefaults : void 0;
+}
+function readPopupMetadata(popupMap, actionType) {
+  var _a, _b;
+  if (!popupMap || !actionType) {
+    return void 0;
+  }
+  const normalizedName = String(((_a = popupMap[actionType]) == null ? void 0 : _a.name) || "").trim();
+  const normalizedDescription = String(((_b = popupMap[actionType]) == null ? void 0 : _b.description) || "").trim();
+  if (!normalizedName || !normalizedDescription) {
+    return void 0;
+  }
+  return {
+    name: normalizedName,
+    description: normalizedDescription
+  };
+}
+function resolveFlowSurfaceApplyBlueprintDefaultPopupMetadata(input) {
+  var _a;
+  const actionType = input.actionType;
+  const sourceCollectionDefaults = getFlowSurfaceApplyBlueprintDefaultCollection(
+    input.metadata,
+    input.sourceCollectionName
+  );
+  const associationField = String(input.associationField || "").trim();
+  if (((_a = sourceCollectionDefaults == null ? void 0 : sourceCollectionDefaults.popups) == null ? void 0 : _a.associations) && associationField) {
+    const associationPopupMetadata = readPopupMetadata(
+      sourceCollectionDefaults.popups.associations[associationField],
+      actionType
+    );
+    if (associationPopupMetadata) {
+      return associationPopupMetadata;
+    }
+  }
+  const targetCollectionDefaults = getFlowSurfaceApplyBlueprintDefaultCollection(
+    input.metadata,
+    input.targetCollectionName
+  );
+  return readPopupMetadata(targetCollectionDefaults == null ? void 0 : targetCollectionDefaults.popups, actionType);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY,
+  attachFlowSurfaceApplyBlueprintPopupDefaults,
+  buildFlowSurfaceApplyBlueprintPopupDefaultsMetadata,
+  getFlowSurfaceApplyBlueprintDefaultCollection,
+  hasFlowSurfaceApplyBlueprintDefaults,
+  readFlowSurfaceApplyBlueprintPopupDefaultsMetadata,
+  resolveFlowSurfaceApplyBlueprintDefaultPopupMetadata
+});

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

@@ -6,7 +6,7 @@
  * 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 type { FlowSurfaceApplyBlueprintAssetMap, FlowSurfaceApplyBlueprintAssets, FlowSurfaceApplyBlueprintDefaultCollection, FlowSurfaceApplyBlueprintDefaultFieldGroupSpec, FlowSurfaceApplyBlueprintDefaultPopupActionMap, FlowSurfaceApplyBlueprintDefaultPopupName, FlowSurfaceApplyBlueprintDefaultPopups, FlowSurfaceApplyBlueprintDefaults, 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/normalize-document.js

@@ -52,8 +52,14 @@ const APPLY_BLUEPRINT_REACTION_TYPES = [
   "setActionLinkageRules"
 ];
 const APPLY_BLUEPRINT_REACTION_TYPE_SET = new Set(APPLY_BLUEPRINT_REACTION_TYPES);
+const APPLY_BLUEPRINT_DEFAULT_COLLECTION_ALLOWED_KEYS = ["fieldGroups", "popups"];
+const APPLY_BLUEPRINT_DEFAULT_FIELD_GROUP_ALLOWED_KEYS = ["key", "title", "fields"];
+const APPLY_BLUEPRINT_DEFAULT_POPUPS_ALLOWED_KEYS = ["view", "addNew", "edit", "associations"];
+const APPLY_BLUEPRINT_DEFAULT_POPUP_ACTION_ALLOWED_KEYS = ["name", "description"];
+const APPLY_BLUEPRINT_DEFAULT_POPUP_ASSOCIATION_ALLOWED_KEYS = ["view", "addNew", "edit"];
+const APPLY_BLUEPRINT_DEFAULT_POPUP_ACTIONS = ["view", "addNew", "edit"];
 function assertSupportedApplyBlueprintTopLevelKeys(input) {
-  const allowedKeys = ["version", "mode", "target", "navigation", "page", "assets", "tabs", "reaction"];
+  const allowedKeys = ["version", "mode", "target", "navigation", "page", "defaults", "assets", "tabs", "reaction"];
   const unsupportedKeys = Object.keys(input).filter((key) => !allowedKeys.includes(key));
   if (!unsupportedKeys.length) {
     return;
@@ -160,6 +166,118 @@ function normalizeNavigation(input) {
   });
   return Object.keys(normalized).length ? normalized : void 0;
 }
+function normalizeDefaultFieldGroups(input, context) {
+  if (import_lodash.default.isUndefined(input)) {
+    return void 0;
+  }
+  if (!Array.isArray(input) || !input.length) {
+    (0, import_errors.throwBadRequest)(`${context} must be a non-empty array`);
+  }
+  return input.map((group, groupIndex) => {
+    const groupContext = `${context}[${groupIndex}]`;
+    (0, import_private_utils.assertPlainObject)(group, groupContext);
+    (0, import_private_utils.assertOnlyAllowedKeys)(group, groupContext, APPLY_BLUEPRINT_DEFAULT_FIELD_GROUP_ALLOWED_KEYS);
+    if (!Array.isArray(group.fields) || !group.fields.length) {
+      (0, import_errors.throwBadRequest)(`${groupContext}.fields must be a non-empty array`);
+    }
+    return (0, import_service_utils.buildDefinedPayload)({
+      key: (0, import_private_utils.readOptionalString)(group.key),
+      title: (0, import_private_utils.assertNonEmptyString)(group.title, `${groupContext}.title`),
+      fields: group.fields.map(
+        (field, fieldIndex) => (0, import_private_utils.assertNonEmptyString)(field, `${groupContext}.fields[${fieldIndex}]`)
+      )
+    });
+  });
+}
+function normalizeDefaultPopupName(input, context) {
+  if (import_lodash.default.isUndefined(input)) {
+    return void 0;
+  }
+  (0, import_private_utils.assertPlainObject)(input, context);
+  (0, import_private_utils.assertOnlyAllowedKeys)(input, context, APPLY_BLUEPRINT_DEFAULT_POPUP_ACTION_ALLOWED_KEYS);
+  return {
+    name: (0, import_private_utils.assertNonEmptyString)(input.name, `${context}.name`),
+    description: (0, import_private_utils.assertNonEmptyString)(input.description, `${context}.description`)
+  };
+}
+function normalizeDefaultPopupActionMap(input, context, allowedKeys) {
+  if (import_lodash.default.isUndefined(input)) {
+    return void 0;
+  }
+  (0, import_private_utils.assertPlainObject)(input, context);
+  (0, import_private_utils.assertOnlyAllowedKeys)(input, context, [...allowedKeys]);
+  const normalized = (0, import_service_utils.buildDefinedPayload)(
+    Object.fromEntries(
+      APPLY_BLUEPRINT_DEFAULT_POPUP_ACTIONS.map((action) => [
+        action,
+        normalizeDefaultPopupName(input[action], `${context}.${action}`)
+      ])
+    )
+  );
+  return Object.keys(normalized).length ? normalized : void 0;
+}
+function normalizeDefaultPopups(input, context) {
+  if (import_lodash.default.isUndefined(input)) {
+    return void 0;
+  }
+  const actionMap = normalizeDefaultPopupActionMap(input, context, APPLY_BLUEPRINT_DEFAULT_POPUPS_ALLOWED_KEYS);
+  const associationsInput = input.associations;
+  const associations = import_lodash.default.isUndefined(associationsInput) ? void 0 : (() => {
+    (0, import_private_utils.assertPlainObject)(associationsInput, `${context}.associations`);
+    return Object.fromEntries(
+      Object.entries(associationsInput).flatMap(([field, value]) => {
+        const associationField = (0, import_private_utils.assertNonEmptyString)(field, `${context}.associations key`);
+        const normalizedValue = normalizeDefaultPopupActionMap(
+          value,
+          `${context}.associations.${associationField}`,
+          APPLY_BLUEPRINT_DEFAULT_POPUP_ASSOCIATION_ALLOWED_KEYS
+        );
+        return normalizedValue ? [[associationField, normalizedValue]] : [];
+      })
+    );
+  })();
+  const normalized = (0, import_service_utils.buildDefinedPayload)({
+    ...actionMap,
+    associations: associations && Object.keys(associations).length ? associations : void 0
+  });
+  return Object.keys(normalized).length ? normalized : void 0;
+}
+function normalizeDefaultCollection(input, context) {
+  (0, import_private_utils.assertPlainObject)(input, context);
+  (0, import_private_utils.assertOnlyAllowedKeys)(input, context, APPLY_BLUEPRINT_DEFAULT_COLLECTION_ALLOWED_KEYS);
+  return (0, import_service_utils.buildDefinedPayload)({
+    fieldGroups: normalizeDefaultFieldGroups(input.fieldGroups, `${context}.fieldGroups`),
+    popups: normalizeDefaultPopups(input.popups, `${context}.popups`)
+  });
+}
+function normalizeDefaults(input) {
+  if (import_lodash.default.isUndefined(input)) {
+    return void 0;
+  }
+  (0, import_private_utils.assertPlainObject)(input, "flowSurfaces applyBlueprint defaults");
+  (0, import_private_utils.assertOnlyAllowedKeys)(input, "flowSurfaces applyBlueprint defaults", ["collections"]);
+  if (import_lodash.default.isUndefined(input.collections)) {
+    return {};
+  }
+  (0, import_private_utils.assertPlainObject)(input.collections, "flowSurfaces applyBlueprint defaults.collections");
+  return {
+    collections: Object.fromEntries(
+      Object.entries(input.collections).map(([collectionName, collectionDefaults]) => {
+        const normalizedCollectionName = (0, import_private_utils.assertNonEmptyString)(
+          collectionName,
+          "flowSurfaces applyBlueprint defaults.collections key"
+        );
+        return [
+          normalizedCollectionName,
+          normalizeDefaultCollection(
+            collectionDefaults,
+            `flowSurfaces applyBlueprint defaults.collections.${normalizedCollectionName}`
+          )
+        ];
+      })
+    )
+  };
+}
 function normalizeTabs(input) {
   const seenTabKeys = /* @__PURE__ */ new Set();
   return input.map((tab, index) => {
@@ -251,6 +369,7 @@ function prepareFlowSurfaceApplyBlueprintDocument(input) {
   }
   const page = normalizePage(input.page);
   const navigation = normalizeNavigation(input.navigation);
+  const defaults = normalizeDefaults(input.defaults);
   if (mode === "create" && !import_lodash.default.isUndefined(input.target)) {
     (0, import_errors.throwBadRequest)(`flowSurfaces applyBlueprint create mode does not accept target`);
   }
@@ -285,6 +404,7 @@ function prepareFlowSurfaceApplyBlueprintDocument(input) {
     ...target ? { target } : {},
     ...navigation ? { navigation } : {},
     ...page ? { page } : {},
+    ...defaults ? { defaults } : {},
     tabs,
     assets,
     ...reaction ? { reaction } : {}

package/dist/server/flow-surfaces/blueprint/public-types.d.ts

@@ -93,6 +93,35 @@ export type FlowSurfaceApplyBlueprintFieldObjectSpec = {
     chart?: string;
 };
 export type FlowSurfaceApplyBlueprintFieldSpec = string | FlowSurfaceApplyBlueprintFieldObjectSpec;
+export type FlowSurfaceApplyBlueprintFieldGroupSpec = {
+    key?: string;
+    title: string;
+    fields: FlowSurfaceApplyBlueprintFieldSpec[];
+};
+export type FlowSurfaceApplyBlueprintDefaultFieldGroupSpec = {
+    key?: string;
+    title: string;
+    fields: string[];
+};
+export type FlowSurfaceApplyBlueprintDefaultPopupName = {
+    name: string;
+    description: string;
+};
+export type FlowSurfaceApplyBlueprintDefaultPopupActionMap = {
+    view?: FlowSurfaceApplyBlueprintDefaultPopupName;
+    addNew?: FlowSurfaceApplyBlueprintDefaultPopupName;
+    edit?: FlowSurfaceApplyBlueprintDefaultPopupName;
+};
+export type FlowSurfaceApplyBlueprintDefaultPopups = FlowSurfaceApplyBlueprintDefaultPopupActionMap & {
+    associations?: Record<string, FlowSurfaceApplyBlueprintDefaultPopupActionMap>;
+};
+export type FlowSurfaceApplyBlueprintDefaultCollection = {
+    fieldGroups?: FlowSurfaceApplyBlueprintDefaultFieldGroupSpec[];
+    popups?: FlowSurfaceApplyBlueprintDefaultPopups;
+};
+export type FlowSurfaceApplyBlueprintDefaults = {
+    collections?: Record<string, FlowSurfaceApplyBlueprintDefaultCollection>;
+};
 export type FlowSurfaceApplyBlueprintActionObjectSpec = {
     key?: string;
     type: string;
@@ -117,7 +146,9 @@ export type FlowSurfaceApplyBlueprintBlockSpec = {
     template?: Record<string, any>;
     settings?: Record<string, any>;
     fields?: FlowSurfaceApplyBlueprintFieldSpec[];
+    fieldGroups?: FlowSurfaceApplyBlueprintFieldGroupSpec[];
     fieldsLayout?: FlowSurfaceApplyBlueprintLayout;
+    defaultFilter?: Record<string, any>;
     actions?: FlowSurfaceApplyBlueprintActionSpec[];
     recordActions?: FlowSurfaceApplyBlueprintActionSpec[];
     script?: string;
@@ -140,6 +171,7 @@ export type FlowSurfaceApplyBlueprintDocument = {
     target?: FlowSurfaceApplyBlueprintTarget;
     navigation?: FlowSurfaceApplyBlueprintNavigation;
     page?: FlowSurfaceApplyBlueprintPage;
+    defaults?: FlowSurfaceApplyBlueprintDefaults;
     tabs: FlowSurfaceApplyBlueprintTabDocument[];
     assets: FlowSurfaceApplyBlueprintAssets;
     reaction?: FlowSurfaceApplyBlueprintReaction;

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

@@ -158,14 +158,14 @@ export declare function buildFieldTree(params: BuildFieldParams): {
     };
 };
 export declare function buildStandaloneFieldNode(options: {
-    use: 'JSColumnModel' | 'JSItemModel';
+    use: 'JSColumnModel' | 'JSItemModel' | 'DividerItemModel';
     uid?: string;
     props?: Record<string, any>;
     decoratorProps?: Record<string, any>;
     stepParams?: Record<string, any>;
 }): {
     uid: string;
-    use: "JSColumnModel" | "JSItemModel";
+    use: "JSColumnModel" | "JSItemModel" | "DividerItemModel";
     props: Record<string, any>;
     decoratorProps: Record<string, any>;
     stepParams: Record<string, any>;