@nocobase/flow-engine 2.0.51 → 2.0.53

package/lib/flow-registry/DetachedFlowRegistry.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { FlowDefinition } from '../FlowDefinition';
+import { FlowDefinitionOptions } from '../types';
+import { BaseFlowRegistry, IFlowRepository } from './BaseFlowRegistry';
+export type FlowRegistryData = Record<string, Omit<FlowDefinitionOptions, 'key'> & {
+    key?: string;
+}>;
+export declare class DetachedFlowRegistry extends BaseFlowRegistry {
+    constructor(flows?: FlowRegistryData);
+    saveFlow(_flow: FlowDefinition): void;
+    destroyFlow(flowKey: string): void;
+}
+export declare function serializeFlowRegistry(registry: Pick<IFlowRepository, 'getFlows'>): FlowRegistryData;
+export declare function replaceFlowRegistry(registry: Pick<IFlowRepository, 'getFlows' | 'removeFlow' | 'addFlows'>, flows: FlowRegistryData): void;

package/lib/flow-registry/DetachedFlowRegistry.js

@@ -0,0 +1,80 @@
+/**
+ * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 DetachedFlowRegistry_exports = {};
+__export(DetachedFlowRegistry_exports, {
+  DetachedFlowRegistry: () => DetachedFlowRegistry,
+  replaceFlowRegistry: () => replaceFlowRegistry,
+  serializeFlowRegistry: () => serializeFlowRegistry
+});
+module.exports = __toCommonJS(DetachedFlowRegistry_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_BaseFlowRegistry = require("./BaseFlowRegistry");
+const _DetachedFlowRegistry = class _DetachedFlowRegistry extends import_BaseFlowRegistry.BaseFlowRegistry {
+  constructor(flows = {}) {
+    super();
+    this.addFlows(import_lodash.default.cloneDeep(flows));
+  }
+  saveFlow(_flow) {
+  }
+  destroyFlow(flowKey) {
+    this.removeFlow(flowKey);
+  }
+};
+__name(_DetachedFlowRegistry, "DetachedFlowRegistry");
+let DetachedFlowRegistry = _DetachedFlowRegistry;
+function serializeFlowRegistry(registry) {
+  const flows = {};
+  for (const [key, flow] of registry.getFlows()) {
+    flows[key] = import_lodash.default.cloneDeep(flow.toData());
+  }
+  return flows;
+}
+__name(serializeFlowRegistry, "serializeFlowRegistry");
+function replaceFlowRegistry(registry, flows) {
+  for (const key of Array.from(registry.getFlows().keys())) {
+    registry.removeFlow(key);
+  }
+  registry.addFlows(import_lodash.default.cloneDeep(flows));
+}
+__name(replaceFlowRegistry, "replaceFlowRegistry");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DetachedFlowRegistry,
+  replaceFlowRegistry,
+  serializeFlowRegistry
+});

package/lib/flow-registry/index.d.ts

@@ -9,3 +9,4 @@
 export * from './BaseFlowRegistry';
 export * from './InstanceFlowRegistry';
 export * from './GlobalFlowRegistry';
+export * from './DetachedFlowRegistry';

package/lib/flow-registry/index.js

@@ -26,9 +26,11 @@ module.exports = __toCommonJS(flow_registry_exports);
 __reExport(flow_registry_exports, require("./BaseFlowRegistry"), module.exports);
 __reExport(flow_registry_exports, require("./InstanceFlowRegistry"), module.exports);
 __reExport(flow_registry_exports, require("./GlobalFlowRegistry"), module.exports);
+__reExport(flow_registry_exports, require("./DetachedFlowRegistry"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./BaseFlowRegistry"),
   ...require("./InstanceFlowRegistry"),
-  ...require("./GlobalFlowRegistry")
+  ...require("./GlobalFlowRegistry"),
+  ...require("./DetachedFlowRegistry")
 });

package/lib/flowContext.d.ts

@@ -347,6 +347,7 @@ declare class BaseFlowEngineContext extends FlowContext {
     runAction: (actionName: string, params?: Record<string, any>) => Promise<any> | any;
     engine: FlowEngine;
     api: APIClient;
+    locale: string;
     viewer: FlowViewer;
     view: FlowView;
     modal: HookAPI;

package/lib/flowContext.js

@@ -2307,6 +2307,18 @@ const _FlowEngineContext = class _FlowEngineContext extends BaseFlowEngineContex
     this.defineMethod("t", (keyOrTemplate, options) => {
       return i18n.translate(keyOrTemplate, options);
     });
+    this.defineProperty("locale", {
+      get: /* @__PURE__ */ __name(() => {
+        var _a, _b, _c;
+        return ((_b = (_a = this.api) == null ? void 0 : _a.auth) == null ? void 0 : _b.locale) || ((_c = this.i18n) == null ? void 0 : _c.language);
+      }, "get"),
+      cache: false,
+      meta: Object.assign(() => ({ type: "string", title: this.t("Current language"), sort: 970 }), {
+        title: (0, import_utils.escapeT)("Current language"),
+        sort: 970,
+        hasChildren: false
+      })
+    });
     this.defineMethod("renderJson", function(template) {
       return this.resolveJsonTemplate(template);
     });

package/lib/index.d.ts

@@ -34,5 +34,7 @@ export { getSnippetBody, listSnippetsForContext, registerRunJSSnippet } from './
 export * from './views';
 export { DATA_SOURCE_DIRTY_EVENT, ENGINE_SCOPE_KEY, getEmitterViewActivatedVersion, VIEW_ACTIVATED_EVENT, VIEW_ACTIVATED_VERSION, VIEW_ENGINE_SCOPE, } from './views/viewEvents';
 export * from './FlowDefinition';
+export { DetachedFlowRegistry, replaceFlowRegistry, serializeFlowRegistry } from './flow-registry';
+export type { FlowRegistryData } from './flow-registry';
 export { createViewScopedEngine } from './ViewScopedFlowEngine';
 export { createBlockScopedEngine } from './BlockScopedFlowEngine';

package/lib/index.js

@@ -28,6 +28,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   DATA_SOURCE_DIRTY_EVENT: () => import_viewEvents.DATA_SOURCE_DIRTY_EVENT,
+  DetachedFlowRegistry: () => import_flow_registry.DetachedFlowRegistry,
   ENGINE_SCOPE_KEY: () => import_viewEvents.ENGINE_SCOPE_KEY,
   RunJSContextRegistry: () => import_registry.RunJSContextRegistry,
   VIEW_ACTIVATED_EVENT: () => import_viewEvents.VIEW_ACTIVATED_EVENT,
@@ -47,6 +48,8 @@ __export(src_exports, {
   registerRunJSContextContribution: () => import_contributions.registerRunJSContextContribution,
   registerRunJSLib: () => import_runjsLibs.registerRunJSLib,
   registerRunJSSnippet: () => import_snippets.registerRunJSSnippet,
+  replaceFlowRegistry: () => import_flow_registry.replaceFlowRegistry,
+  serializeFlowRegistry: () => import_flow_registry.serializeFlowRegistry,
   setupRunJSContexts: () => import_setup.setupRunJSContexts
 });
 module.exports = __toCommonJS(src_exports);
@@ -75,11 +78,13 @@ var import_snippets = require("./runjs-context/snippets");
 __reExport(src_exports, require("./views"), module.exports);
 var import_viewEvents = require("./views/viewEvents");
 __reExport(src_exports, require("./FlowDefinition"), module.exports);
+var import_flow_registry = require("./flow-registry");
 var import_ViewScopedFlowEngine = require("./ViewScopedFlowEngine");
 var import_BlockScopedFlowEngine = require("./BlockScopedFlowEngine");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DATA_SOURCE_DIRTY_EVENT,
+  DetachedFlowRegistry,
   ENGINE_SCOPE_KEY,
   RunJSContextRegistry,
   VIEW_ACTIVATED_EVENT,
@@ -99,6 +104,8 @@ var import_BlockScopedFlowEngine = require("./BlockScopedFlowEngine");
   registerRunJSContextContribution,
   registerRunJSLib,
   registerRunJSSnippet,
+  replaceFlowRegistry,
+  serializeFlowRegistry,
   setupRunJSContexts,
   ...require("./types"),
   ...require("./utils"),

package/lib/views/FlowView.js

@@ -47,11 +47,21 @@ const _FlowViewer = class _FlowViewer {
     if (this.types[type]) {
       zIndex += 1;
       const onClose = others.onClose;
+      let zIndexReleased = false;
+      const releaseZIndex = /* @__PURE__ */ __name(() => {
+        if (!zIndexReleased) {
+          zIndexReleased = true;
+          zIndex -= 1;
+        }
+      }, "releaseZIndex");
       const _zIndex = others.zIndex;
       others.onClose = (...args) => {
         onClose == null ? void 0 : onClose(...args);
-        zIndex -= 1;
+        releaseZIndex();
       };
+      if (type === "embed") {
+        others.onOpenCancelled = releaseZIndex;
+      }
       if (type !== "embed") {
         others.zIndex = _zIndex ?? this.getNextZIndex();
       }

package/lib/views/PageComponent.js

@@ -55,8 +55,9 @@ const PageComponent = (0, import_react.forwardRef)((props, ref) => {
     hidden,
     title: _title,
     styles = {},
-    zIndex = 4
+    zIndex = 4,
     // 这个默认值是为了防止表格的阴影显示到子页面上面
+    onClose
   } = mergedProps;
   const closedRef = (0, import_react.useRef)(false);
   const flowEngine = (0, import_provider.useFlowEngine)();
@@ -114,11 +115,12 @@ const PageComponent = (0, import_react.forwardRef)((props, ref) => {
           type: "text",
           size: "small",
           icon: /* @__PURE__ */ import_react.default.createElement(import_icons.CloseOutlined, null),
-          onClick: () => {
-            var _a;
+          onClick: async () => {
             if (!closedRef.current) {
-              closedRef.current = true;
-              (_a = props.onClose) == null ? void 0 : _a.call(props);
+              const closed = await (onClose == null ? void 0 : onClose());
+              if (closed !== false) {
+                closedRef.current = true;
+              }
             }
           },
           style: {
@@ -138,7 +140,7 @@ const PageComponent = (0, import_react.forwardRef)((props, ref) => {
       )),
       extra && /* @__PURE__ */ import_react.default.createElement("div", null, extra)
     );
-  }, [header, _title, flowEngine.context.themeToken, styles.header, props.onClose]);
+  }, [header, _title, flowEngine.context.themeToken, styles.header, onClose]);
   const FooterComponent = (0, import_react.useMemo)(() => {
     if (!footer) return null;
     const token = flowEngine.context.themeToken;

package/lib/views/usePage.d.ts

@@ -12,27 +12,20 @@ export declare const GLOBAL_EMBED_CONTAINER_ID = "nocobase-embed-container";
 /** Dataset key used to signal embed replacement in progress (skip style reset on close) */
 export declare const EMBED_REPLACING_DATA_KEY = "nocobaseEmbedReplacing";
 export declare function usePage(): (React.JSX.Element | {
-    open: (config: any, flowContext: any) => Promise<unknown> & {
+    open: (config: any, flowContext: any) => Promise<any> & {
         type: "embed";
         inputArgs: any;
         preventClose: boolean;
+        Header: any;
+        Footer: any;
         beforeClose: any;
+        close: (result?: any, force?: boolean) => Promise<any>;
         destroy: (result?: any) => void;
         update: (newConfig: any) => void;
-        close: (result?: any, force?: boolean) => Promise<boolean>;
-        Header: React.FC<{
-            title?: React.ReactNode;
-            extra?: React.ReactNode;
-        }>;
-        Footer: React.FC<{
-            children?: React.ReactNode;
-        }>;
         setFooter: (footer: React.ReactNode) => void;
         setHeader: (header: {
             title?: React.ReactNode;
             extra?: React.ReactNode;
         }) => void;
-        navigation: any;
-        readonly record: unknown;
     };
 })[];