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

package/dist/server/flow-surfaces/filter-group.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 declare const FLOW_SURFACE_EMPTY_FILTER_GROUP: {
+    logic: string;
+    items: any[];
+};
+export declare const FLOW_SURFACE_FILTER_GROUP_EXAMPLE: string;
+export declare function normalizeFlowSurfaceFilterGroupValue(value: any, errorPrefix: string): any;
+export declare function assertFlowSurfaceFilterGroupShape(filter: any): void;

package/dist/server/flow-surfaces/filter-group.js

@@ -0,0 +1,94 @@
+/**
+ * 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 filter_group_exports = {};
+__export(filter_group_exports, {
+  FLOW_SURFACE_EMPTY_FILTER_GROUP: () => FLOW_SURFACE_EMPTY_FILTER_GROUP,
+  FLOW_SURFACE_FILTER_GROUP_EXAMPLE: () => FLOW_SURFACE_FILTER_GROUP_EXAMPLE,
+  assertFlowSurfaceFilterGroupShape: () => assertFlowSurfaceFilterGroupShape,
+  normalizeFlowSurfaceFilterGroupValue: () => normalizeFlowSurfaceFilterGroupValue
+});
+module.exports = __toCommonJS(filter_group_exports);
+var import_utils = require("@nocobase/utils");
+var import_lodash = __toESM(require("lodash"));
+var import_errors = require("./errors");
+const FLOW_SURFACE_EMPTY_FILTER_GROUP = {
+  logic: "$and",
+  items: []
+};
+const FLOW_SURFACE_FILTER_GROUP_EXAMPLE = JSON.stringify(FLOW_SURFACE_EMPTY_FILTER_GROUP);
+function normalizeFlowSurfaceFilterGroupValue(value, errorPrefix) {
+  const normalized = value === null || import_lodash.default.isPlainObject(value) && !Object.keys(value).length ? import_lodash.default.cloneDeep(FLOW_SURFACE_EMPTY_FILTER_GROUP) : import_lodash.default.cloneDeep(value);
+  try {
+    assertFlowSurfaceFilterGroupShape(normalized);
+    (0, import_utils.transformFilter)(normalized);
+    return normalized;
+  } catch (error) {
+    const reason = error instanceof Error ? error.message : String(error);
+    (0, import_errors.throwBadRequest)(`${errorPrefix}: ${reason}`);
+  }
+}
+function assertFlowSurfaceFilterGroupShape(filter) {
+  if (!import_lodash.default.isPlainObject(filter)) {
+    throw new Error("Invalid filter: filter must be an object");
+  }
+  if (!("logic" in filter) || !("items" in filter)) {
+    throw new Error("Invalid filter: filter must have logic and items properties");
+  }
+  if (filter.logic !== "$and" && filter.logic !== "$or") {
+    throw new Error("Invalid filter: logic must be '$and' or '$or'");
+  }
+  if (!Array.isArray(filter.items)) {
+    throw new Error("Invalid filter: items must be an array");
+  }
+  filter.items.forEach((item) => {
+    if (import_lodash.default.isPlainObject(item) && "logic" in item && "items" in item) {
+      assertFlowSurfaceFilterGroupShape(item);
+      return;
+    }
+    if (import_lodash.default.isPlainObject(item) && typeof item.path === "string" && typeof item.operator === "string") {
+      return;
+    }
+    throw new Error("Invalid filter item type");
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FLOW_SURFACE_EMPTY_FILTER_GROUP,
+  FLOW_SURFACE_FILTER_GROUP_EXAMPLE,
+  assertFlowSurfaceFilterGroupShape,
+  normalizeFlowSurfaceFilterGroupValue
+});

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

@@ -33,6 +33,23 @@ var import_resourcer = require("@nocobase/resourcer");
 var import_constants = require("./constants");
 var import_errors = require("./errors");
 var import_service = require("./service");
+const FLOW_ENGINE_LOCALE_NAMESPACE = "flow-engine";
+const FLOW_SURFACE_LOCALE_FALLBACK_NAMESPACES = [
+  FLOW_ENGINE_LOCALE_NAMESPACE,
+  "@nocobase/flow-engine",
+  "@nocobase/plugin-flow-engine",
+  "client"
+];
+const FLOW_SURFACE_LOCAL_TRANSLATIONS = {
+  "zh-CN": {
+    "Popup for Add New": "\u65B0\u589E\u5F39\u7A97",
+    "Popup for Edit": "\u7F16\u8F91\u5F39\u7A97",
+    "Popup for Details": "\u8BE6\u60C5\u5F39\u7A97",
+    "Auto generated": "\u81EA\u52A8\u751F\u6210",
+    'Automatically generated popup template for collection "{{collectionLabel}}" ({{popupLabel}}).': "\u4E3A\u6570\u636E\u8868\u201C{{collectionLabel}}\u201D\u81EA\u52A8\u751F\u6210\u7684\u5F39\u7A97\u6A21\u677F\uFF08{{popupLabel}}\uFF09\u3002",
+    'Automatically generated popup template for relation field "{{associationFieldLabel}}" in collection "{{sourceCollectionLabel}}", targeting "{{targetCollectionLabel}}" ({{popupLabel}}).': "\u4E3A\u6570\u636E\u8868\u201C{{sourceCollectionLabel}}\u201D\u4E2D\u7684\u5173\u7CFB\u5B57\u6BB5\u201C{{associationFieldLabel}}\u201D\u81EA\u52A8\u751F\u6210\u7684\u5F39\u7A97\u6A21\u677F\uFF0C\u76EE\u6807\u6570\u636E\u8868\u4E3A\u201C{{targetCollectionLabel}}\u201D\uFF08{{popupLabel}}\uFF09\u3002"
+  }
+};
 function getValues(ctx) {
   var _a, _b, _c;
   return ((_b = (_a = ctx.action) == null ? void 0 : _a.params) == null ? void 0 : _b.values) ?? ((_c = ctx.action) == null ? void 0 : _c.params) ?? {};
@@ -134,6 +151,56 @@ function invokeFlowSurfaceServiceAction(service, actionName, values, options = {
   const handler = service[actionName];
   return handler.call(service, values, options);
 }
+function interpolateTranslation(value, options) {
+  return value.replace(/\{\{\s*([^}\s]+)\s*\}\}/g, (_match, name) => {
+    const replacement = options == null ? void 0 : options[name];
+    return replacement === null || typeof replacement === "undefined" ? "" : String(replacement);
+  });
+}
+function getResourceTranslation(ctx, key, options) {
+  var _a, _b, _c, _d;
+  const locale = ((_a = ctx.getCurrentLocale) == null ? void 0 : _a.call(ctx)) || ((_b = ctx.i18n) == null ? void 0 : _b.language);
+  const i18n = (_c = ctx.app) == null ? void 0 : _c.i18n;
+  if (!locale || !i18n) {
+    return void 0;
+  }
+  for (const ns of FLOW_SURFACE_LOCALE_FALLBACK_NAMESPACES) {
+    const value = (_d = i18n.getResource) == null ? void 0 : _d.call(i18n, locale, ns, key);
+    if (typeof value === "string") {
+      return interpolateTranslation(value, options);
+    }
+  }
+  return void 0;
+}
+function getLocalTranslation(ctx, key, options) {
+  var _a, _b;
+  const locale = String(((_a = ctx.getCurrentLocale) == null ? void 0 : _a.call(ctx)) || ((_b = ctx.i18n) == null ? void 0 : _b.language) || "").trim();
+  const resources = FLOW_SURFACE_LOCAL_TRANSLATIONS[locale];
+  const value = resources == null ? void 0 : resources[key];
+  return typeof value === "string" ? interpolateTranslation(value, options) : void 0;
+}
+function getFlowSurfaceTranslate(ctx) {
+  var _a, _b, _c;
+  const translate = ((_b = (_a = ctx.i18n) == null ? void 0 : _a.t) == null ? void 0 : _b.bind(ctx.i18n)) || ((_c = ctx.t) == null ? void 0 : _c.bind(ctx));
+  if (typeof translate !== "function") {
+    return void 0;
+  }
+  return (key, options) => {
+    const resourceValue = getResourceTranslation(ctx, key, options);
+    if (typeof resourceValue === "string") {
+      return resourceValue;
+    }
+    const localValue = getLocalTranslation(ctx, key, options);
+    if (typeof localValue === "string") {
+      return localValue;
+    }
+    return translate(key, {
+      ns: [FLOW_ENGINE_LOCALE_NAMESPACE, "client"],
+      nsMode: "fallback",
+      ...options || {}
+    });
+  };
+}
 function registerFlowSurfacesResource(plugin) {
   const service = new import_service.FlowSurfacesService(plugin);
   const actions = Object.fromEntries(
@@ -143,12 +210,13 @@ function registerFlowSurfacesResource(plugin) {
         await runFlowSurfaceAction(ctx, next, async () => {
           const definition = import_constants.FLOW_SURFACE_ACTION_DEFINITIONS[actionName];
           const values = definition.valueSource === "read" ? getReadValues(ctx) : getValues(ctx);
+          const t = getFlowSurfaceTranslate(ctx);
           if (definition.transaction) {
             return service.transaction(
-              (transaction) => invokeFlowSurfaceServiceAction(service, actionName, values, { transaction })
+              (transaction) => invokeFlowSurfaceServiceAction(service, actionName, values, { transaction, t })
             );
           }
-          return invokeFlowSurfaceServiceAction(service, actionName, values);
+          return invokeFlowSurfaceServiceAction(service, actionName, values, { t });
         });
       }
     ])

package/dist/server/flow-surfaces/node-use-sets.js

@@ -38,6 +38,7 @@ module.exports = __toCommonJS(node_use_sets_exports);
 var import_approval = require("./approval");
 const COLLECTION_BLOCK_USES = /* @__PURE__ */ new Set([
   "TableBlockModel",
+  "CalendarBlockModel",
   "CreateFormModel",
   "EditFormModel",
   "FormBlockModel",
@@ -65,7 +66,7 @@ const FIELD_WRAPPER_USES = /* @__PURE__ */ new Set([
   "TableColumnModel",
   ...import_approval.APPROVAL_FIELD_WRAPPER_USES
 ]);
-const CREATABLE_STANDALONE_FIELD_USES = /* @__PURE__ */ new Set(["JSColumnModel", "JSItemModel"]);
+const CREATABLE_STANDALONE_FIELD_USES = /* @__PURE__ */ new Set(["JSColumnModel", "JSItemModel", "DividerItemModel"]);
 const STANDALONE_FIELD_NODE_USES = /* @__PURE__ */ new Set([...CREATABLE_STANDALONE_FIELD_USES, "FormJSFieldItemModel"]);
 const ACTION_BUTTON_USES = /* @__PURE__ */ new Set([
   "AddNewActionModel",
@@ -104,6 +105,10 @@ const ACTION_BUTTON_USES = /* @__PURE__ */ new Set([
   "JSItemActionModel",
   "FilterFormJSActionModel",
   "JSActionModel",
+  "CalendarTodayActionModel",
+  "CalendarNavActionModel",
+  "CalendarTitleActionModel",
+  "CalendarViewSelectActionModel",
   "ApplyFormSubmitModel",
   "ApplyFormSaveDraftModel",
   "ApplyFormWithdrawModel",

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

@@ -56,6 +56,8 @@ const FLOW_SURFACE_POPUP_HOST_USES = /* @__PURE__ */ new Set([
   "ViewActionModel",
   "EditActionModel",
   "PopupCollectionActionModel",
+  "CalendarQuickCreateActionModel",
+  "CalendarEventViewActionModel",
   "ClickableFieldModel",
   "DisplayTextFieldModel",
   "DisplayEnumFieldModel",
@@ -158,6 +160,7 @@ function isBlockContainerUse(parentUse, subKey) {
 function isActionContainerUse(parentUse) {
   return [
     "TableBlockModel",
+    "CalendarBlockModel",
     "TableActionsColumnModel",
     "ListBlockModel",
     "GridCardBlockModel",

package/dist/server/flow-surfaces/public-data-surface-default-filter.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 declare const FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES: Set<string>;
+export declare function isFlowSurfacePublicDataSurfaceBlockType(blockType?: string): boolean;
+export declare function normalizeFlowSurfacePublicBlockDefaultFilter(actionName: string, defaultFilter: any, options: {
+    blockType?: string;
+    template?: unknown;
+    path?: string;
+}): any;
+export declare function backfillFlowSurfaceDefaultFilterSetting(settings: any, defaultFilter: any): any;
+export declare function backfillFlowSurfaceFilterActionDefaultFilter<T extends {
+    type?: string;
+    settings?: Record<string, any>;
+}>(actions: T[], defaultFilter: any): T[];

package/dist/server/flow-surfaces/public-data-surface-default-filter.js

@@ -0,0 +1,111 @@
+/**
+ * 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 public_data_surface_default_filter_exports = {};
+__export(public_data_surface_default_filter_exports, {
+  FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES: () => FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES,
+  backfillFlowSurfaceDefaultFilterSetting: () => backfillFlowSurfaceDefaultFilterSetting,
+  backfillFlowSurfaceFilterActionDefaultFilter: () => backfillFlowSurfaceFilterActionDefaultFilter,
+  isFlowSurfacePublicDataSurfaceBlockType: () => isFlowSurfacePublicDataSurfaceBlockType,
+  normalizeFlowSurfacePublicBlockDefaultFilter: () => normalizeFlowSurfacePublicBlockDefaultFilter
+});
+module.exports = __toCommonJS(public_data_surface_default_filter_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_errors = require("./errors");
+var import_filter_group = require("./filter-group");
+const FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES = /* @__PURE__ */ new Set(["table", "list", "gridCard"]);
+function isFlowSurfacePublicDataSurfaceBlockType(blockType) {
+  return FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES.has(String(blockType || "").trim());
+}
+function normalizeFlowSurfacePublicBlockDefaultFilter(actionName, defaultFilter, options) {
+  if (import_lodash.default.isUndefined(defaultFilter)) {
+    return void 0;
+  }
+  const fieldPath = options.path ? `${options.path}.defaultFilter` : "defaultFilter";
+  if (!isFlowSurfacePublicDataSurfaceBlockType(options.blockType) || !import_lodash.default.isUndefined(options.template)) {
+    (0, import_errors.throwBadRequest)(`flowSurfaces ${actionName} ${fieldPath} is only supported on direct table/list/gridCard blocks`);
+  }
+  return (0, import_filter_group.normalizeFlowSurfaceFilterGroupValue)(
+    defaultFilter,
+    `flowSurfaces ${actionName} ${fieldPath} expects FilterGroup like ${import_filter_group.FLOW_SURFACE_FILTER_GROUP_EXAMPLE}`
+  );
+}
+function backfillFlowSurfaceDefaultFilterSetting(settings, defaultFilter) {
+  if (import_lodash.default.isUndefined(defaultFilter)) {
+    return settings;
+  }
+  if (import_lodash.default.isUndefined(settings)) {
+    return {
+      defaultFilter: import_lodash.default.cloneDeep(defaultFilter)
+    };
+  }
+  if (!import_lodash.default.isPlainObject(settings)) {
+    return settings;
+  }
+  if (Object.prototype.hasOwnProperty.call(settings, "defaultFilter")) {
+    return settings;
+  }
+  return {
+    ...import_lodash.default.cloneDeep(settings),
+    defaultFilter: import_lodash.default.cloneDeep(defaultFilter)
+  };
+}
+function backfillFlowSurfaceFilterActionDefaultFilter(actions, defaultFilter) {
+  if (import_lodash.default.isUndefined(defaultFilter)) {
+    return actions;
+  }
+  return actions.map((action) => {
+    if (String((action == null ? void 0 : action.type) || "").trim() !== "filter") {
+      return action;
+    }
+    const settings = backfillFlowSurfaceDefaultFilterSetting(action.settings, defaultFilter);
+    if (settings === action.settings) {
+      return action;
+    }
+    return {
+      ...action,
+      settings
+    };
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FLOW_SURFACE_PUBLIC_DATA_SURFACE_BLOCK_TYPES,
+  backfillFlowSurfaceDefaultFilterSetting,
+  backfillFlowSurfaceFilterActionDefaultFilter,
+  isFlowSurfacePublicDataSurfaceBlockType,
+  normalizeFlowSurfacePublicBlockDefaultFilter
+});

package/dist/server/flow-surfaces/reaction/registry.d.ts

@@ -58,8 +58,11 @@ export declare const FLOW_SURFACE_REACTION_SUPPORTED_KINDS_BY_USE: {
     readonly ApplyTaskCardDetailsModel: readonly ["blockLinkage", "fieldLinkage"];
     readonly ApprovalTaskCardDetailsModel: readonly ["blockLinkage", "fieldLinkage"];
     readonly TableBlockModel: readonly ["blockLinkage"];
+    readonly CalendarBlockModel: readonly ["blockLinkage"];
     readonly ListBlockModel: readonly ["blockLinkage"];
     readonly GridCardBlockModel: readonly ["blockLinkage"];
+    readonly MarkdownBlockModel: readonly ["blockLinkage"];
+    readonly IframeBlockModel: readonly ["blockLinkage"];
     readonly MapBlockModel: readonly ["blockLinkage"];
     readonly CommentsBlockModel: readonly ["blockLinkage"];
     readonly ChartBlockModel: readonly ["blockLinkage"];
@@ -82,6 +85,10 @@ export declare const FLOW_SURFACE_REACTION_SUPPORTED_KINDS_BY_USE: {
     readonly JSItemActionModel: readonly ["actionLinkage"];
     readonly FilterFormJSActionModel: readonly ["actionLinkage"];
     readonly JSActionModel: readonly ["actionLinkage"];
+    readonly CalendarTodayActionModel: readonly ["actionLinkage"];
+    readonly CalendarNavActionModel: readonly ["actionLinkage"];
+    readonly CalendarTitleActionModel: readonly ["actionLinkage"];
+    readonly CalendarViewSelectActionModel: readonly ["actionLinkage"];
     readonly LinkActionModel: readonly ["actionLinkage"];
     readonly ExportActionModel: readonly ["actionLinkage"];
     readonly ExportAttachmentActionModel: readonly ["actionLinkage"];

package/dist/server/flow-surfaces/reaction/registry.js

@@ -88,8 +88,11 @@ const FLOW_SURFACE_REACTION_SUPPORTED_KINDS_BY_USE = {
   ApplyTaskCardDetailsModel: ["blockLinkage", "fieldLinkage"],
   ApprovalTaskCardDetailsModel: ["blockLinkage", "fieldLinkage"],
   TableBlockModel: ["blockLinkage"],
+  CalendarBlockModel: ["blockLinkage"],
   ListBlockModel: ["blockLinkage"],
   GridCardBlockModel: ["blockLinkage"],
+  MarkdownBlockModel: ["blockLinkage"],
+  IframeBlockModel: ["blockLinkage"],
   MapBlockModel: ["blockLinkage"],
   CommentsBlockModel: ["blockLinkage"],
   ChartBlockModel: ["blockLinkage"],
@@ -112,6 +115,10 @@ const FLOW_SURFACE_REACTION_SUPPORTED_KINDS_BY_USE = {
   JSItemActionModel: ["actionLinkage"],
   FilterFormJSActionModel: ["actionLinkage"],
   JSActionModel: ["actionLinkage"],
+  CalendarTodayActionModel: ["actionLinkage"],
+  CalendarNavActionModel: ["actionLinkage"],
+  CalendarTitleActionModel: ["actionLinkage"],
+  CalendarViewSelectActionModel: ["actionLinkage"],
   LinkActionModel: ["actionLinkage"],
   ExportActionModel: ["actionLinkage"],
   ExportAttachmentActionModel: ["actionLinkage"],

package/dist/server/flow-surfaces/service-utils.d.ts

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import _ from 'lodash';
+import { FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY, type FlowSurfaceApplyBlueprintPopupDefaultsMetadata } from './blueprint/defaults';
 import type { FlowSurfaceNodeSpec, FlowSurfaceNodeSubModel } from './types';
 export declare function buildDefinedPayload(payload: Record<string, any>): _.Dictionary<any>;
 export declare function normalizeFlowSurfaceComposeKey(key: any, context: string): string;
@@ -14,6 +15,11 @@ export declare function assertFlowSurfaceComposeUniqueKeys(items: Array<{
     key?: string;
 }>, context: string): void;
 export declare function normalizeChartCardSettings(cardSettings: any): any;
+export declare function normalizeBlockTitleDescriptionValue(value: any): any;
+export declare function normalizeBlockTitleDescription(titleDescription: any): any;
+export declare function buildBlockTitleDescriptionFromSemanticChanges(changes: Record<string, any>): {
+    titleDescription: _.Dictionary<any>;
+};
 export declare function buildChartCardSettingsFromSemanticChanges(currentCardSettings: any, changes: Record<string, any>): any;
 export declare function buildPopupTabTree(options: {
     tabUid?: string;
@@ -63,6 +69,7 @@ export type NormalizedComposeFieldSpec = {
     settings: Record<string, any>;
     popup?: Record<string, any>;
     __autoPopupForRelationField?: boolean;
+    [FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY]?: FlowSurfaceApplyBlueprintPopupDefaultsMetadata;
 };
 export declare function normalizeComposeFieldSpec(input: any, index: number): NormalizedComposeFieldSpec;
 export declare function normalizeComposeActionSpec(input: any, index: number): {

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

@@ -38,6 +38,7 @@ var service_utils_exports = {};
 __export(service_utils_exports, {
   assertFlowSurfaceComposeUniqueKeys: () => assertFlowSurfaceComposeUniqueKeys,
   assertSupportedSimpleChanges: () => assertSupportedSimpleChanges,
+  buildBlockTitleDescriptionFromSemanticChanges: () => buildBlockTitleDescriptionFromSemanticChanges,
   buildChartCardSettingsFromSemanticChanges: () => buildChartCardSettingsFromSemanticChanges,
   buildDefaultFieldState: () => buildDefaultFieldState,
   buildDefinedPayload: () => buildDefinedPayload,
@@ -57,6 +58,8 @@ __export(service_utils_exports, {
   isFieldNodeUse: () => isFieldNodeUse,
   isMissingRequiredResourceInitValue: () => isMissingRequiredResourceInitValue,
   joinRequiredFieldPaths: () => joinRequiredFieldPaths,
+  normalizeBlockTitleDescription: () => normalizeBlockTitleDescription,
+  normalizeBlockTitleDescriptionValue: () => normalizeBlockTitleDescriptionValue,
   normalizeChartCardHeightModeForWrite: () => normalizeChartCardHeightModeForWrite,
   normalizeChartCardSettings: () => normalizeChartCardSettings,
   normalizeComposeActionSpec: () => normalizeComposeActionSpec,
@@ -77,6 +80,7 @@ module.exports = __toCommonJS(service_utils_exports);
 var import_utils = require("@nocobase/utils");
 var import_lodash = __toESM(require("lodash"));
 var import_configure_options = require("./configure-options");
+var import_defaults = require("./blueprint/defaults");
 var import_errors = require("./errors");
 var import_service_helpers = require("./service-helpers");
 var import_key_registry = require("./planning/key-registry");
@@ -112,9 +116,9 @@ function normalizeChartCardSettings(cardSettings) {
     return {};
   }
   const nextCardSettings = import_lodash.default.cloneDeep(cardSettings);
-  const title = typeof import_lodash.default.get(nextCardSettings, ["titleDescription", "title"]) === "string" ? import_lodash.default.get(nextCardSettings, ["titleDescription", "title"]).trim() : import_lodash.default.get(nextCardSettings, ["titleDescription", "title"]);
-  if (title) {
-    import_lodash.default.set(nextCardSettings, ["titleDescription", "title"], title);
+  const titleDescription = normalizeBlockTitleDescription(import_lodash.default.get(nextCardSettings, ["titleDescription"]));
+  if (titleDescription) {
+    import_lodash.default.set(nextCardSettings, ["titleDescription"], titleDescription);
   } else {
     import_lodash.default.unset(nextCardSettings, ["titleDescription"]);
   }
@@ -136,13 +140,53 @@ function normalizeChartCardSettings(cardSettings) {
   }
   return nextCardSettings;
 }
+function normalizeBlockTitleDescriptionValue(value) {
+  if (import_lodash.default.isNull(value)) {
+    return "";
+  }
+  return typeof value === "string" ? value.trim() : value;
+}
+function normalizeBlockTitleDescription(titleDescription) {
+  if (!import_lodash.default.isPlainObject(titleDescription)) {
+    return void 0;
+  }
+  const nextTitleDescription = import_lodash.default.cloneDeep(titleDescription);
+  const title = normalizeBlockTitleDescriptionValue(nextTitleDescription.title);
+  const description = normalizeBlockTitleDescriptionValue(nextTitleDescription.description);
+  if (title) {
+    nextTitleDescription.title = title;
+  } else {
+    delete nextTitleDescription.title;
+  }
+  if (description) {
+    nextTitleDescription.description = description;
+  } else {
+    delete nextTitleDescription.description;
+  }
+  return Object.keys(nextTitleDescription).length ? nextTitleDescription : void 0;
+}
+function buildBlockTitleDescriptionFromSemanticChanges(changes) {
+  if (!hasDefinedValue(changes, ["title", "description"])) {
+    return void 0;
+  }
+  return {
+    titleDescription: buildDefinedPayload({
+      ...hasOwnDefined(changes, "title") ? { title: normalizeBlockTitleDescriptionValue(changes.title) } : {},
+      ...hasOwnDefined(changes, "description") ? { description: normalizeBlockTitleDescriptionValue(changes.description) } : {}
+    })
+  };
+}
 function buildChartCardSettingsFromSemanticChanges(currentCardSettings, changes) {
   const nextCardSettings = import_lodash.default.cloneDeep(currentCardSettings || {});
-  const currentTitle = typeof import_lodash.default.get(currentCardSettings, ["titleDescription", "title"]) === "string" ? import_lodash.default.get(currentCardSettings, ["titleDescription", "title"]).trim() : import_lodash.default.get(currentCardSettings, ["titleDescription", "title"]);
-  const nextTitle = hasOwnDefined(changes, "title") ? typeof changes.title === "string" ? changes.title.trim() : changes.title : currentTitle;
-  const shouldShowTitle = hasOwnDefined(changes, "displayTitle") ? changes.displayTitle !== false : !!nextTitle;
-  if (nextTitle && shouldShowTitle) {
-    import_lodash.default.set(nextCardSettings, ["titleDescription", "title"], nextTitle);
+  const currentTitleDescription = import_lodash.default.get(currentCardSettings, ["titleDescription"]);
+  const nextTitleDescription = normalizeBlockTitleDescription(
+    buildDefinedPayload({
+      title: hasOwnDefined(changes, "title") ? normalizeBlockTitleDescriptionValue(changes.title) : import_lodash.default.get(currentTitleDescription, ["title"]),
+      description: hasOwnDefined(changes, "description") ? normalizeBlockTitleDescriptionValue(changes.description) : import_lodash.default.get(currentTitleDescription, ["description"])
+    })
+  );
+  if (nextTitleDescription) {
+    import_lodash.default.set(nextCardSettings, ["titleDescription"], nextTitleDescription);
   } else {
     import_lodash.default.unset(nextCardSettings, ["titleDescription"]);
   }
@@ -324,6 +368,7 @@ function normalizeComposeFieldSpec(input, index) {
   }
   const rawKey = String(input.key || semanticType || (renderer === "js" ? `js:${fieldPath}` : fieldPath)).trim();
   const key = normalizeFlowSurfaceComposeKey(rawKey, `flowSurfaces compose field #${index + 1}`);
+  const popupDefaultsMetadata = import_lodash.default.isPlainObject(input[import_defaults.FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY]) ? input[import_defaults.FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY] : void 0;
   return {
     index: index + 1,
     key,
@@ -334,7 +379,8 @@ function normalizeComposeFieldSpec(input, index) {
     target: typeof input.target === "string" ? String(input.target || "").trim() || void 0 : void 0,
     settings: import_lodash.default.isPlainObject(input.settings) ? input.settings : {},
     popup: import_lodash.default.isPlainObject(input.popup) ? input.popup : void 0,
-    __autoPopupForRelationField: input.__autoPopupForRelationField === true
+    __autoPopupForRelationField: input.__autoPopupForRelationField === true,
+    ...popupDefaultsMetadata ? { [import_defaults.FLOW_SURFACE_APPLY_BLUEPRINT_POPUP_DEFAULTS_KEY]: popupDefaultsMetadata } : {}
   };
 }
 function normalizeComposeActionSpec(input, index) {
@@ -725,6 +771,7 @@ function getFieldBindingDefaultProps(containerUse, fieldUse, field) {
 0 && (module.exports = {
   assertFlowSurfaceComposeUniqueKeys,
   assertSupportedSimpleChanges,
+  buildBlockTitleDescriptionFromSemanticChanges,
   buildChartCardSettingsFromSemanticChanges,
   buildDefaultFieldState,
   buildDefinedPayload,
@@ -744,6 +791,8 @@ function getFieldBindingDefaultProps(containerUse, fieldUse, field) {
   isFieldNodeUse,
   isMissingRequiredResourceInitValue,
   joinRequiredFieldPaths,
+  normalizeBlockTitleDescription,
+  normalizeBlockTitleDescriptionValue,
   normalizeChartCardHeightModeForWrite,
   normalizeChartCardSettings,
   normalizeComposeActionSpec,