@nocobase/flow-engine 2.1.0-alpha.4 → 2.1.0-alpha.40

package/lib/utils/schema-utils.js

@@ -31,6 +31,7 @@ __export(schema_utils_exports, {
   resolveStepDisabledInSettings: () => resolveStepDisabledInSettings,
   resolveStepUiSchema: () => resolveStepUiSchema,
   resolveUiMode: () => resolveUiMode,
+  shouldHideEventInSettings: () => shouldHideEventInSettings,
   shouldHideStepInSettings: () => shouldHideStepInSettings
 });
 module.exports = __toCommonJS(schema_utils_exports);
@@ -195,6 +196,23 @@ async function resolveStepUiSchema(model, flow, step) {
   return resolvedStepUiSchema;
 }
 __name(resolveStepUiSchema, "resolveStepUiSchema");
+async function shouldHideEventInSettings(model, flow, event) {
+  if (!event) return true;
+  const { hideInSettings } = event;
+  if (typeof hideInSettings === "function") {
+    try {
+      const ctx = new import_flowContext.FlowRuntimeContext(model, flow.key, "settings");
+      (0, import_setupRuntimeContextSteps.setupRuntimeContextSteps)(ctx, flow.steps || {}, model, flow.key);
+      const result = await hideInSettings(ctx);
+      return !!result;
+    } catch (error) {
+      console.warn(`Error evaluating hideInSettings for event '${event.name || ""}' in flow '${flow.key}':`, error);
+      return false;
+    }
+  }
+  return !!hideInSettings;
+}
+__name(shouldHideEventInSettings, "shouldHideEventInSettings");
 async function shouldHideStepInSettings(model, flow, step) {
   var _a;
   if (!step) return true;
@@ -283,5 +301,6 @@ __name(resolveStepDisabledInSettings, "resolveStepDisabledInSettings");
   resolveStepDisabledInSettings,
   resolveStepUiSchema,
   resolveUiMode,
+  shouldHideEventInSettings,
   shouldHideStepInSettings
 });

package/lib/views/FlowView.d.ts

@@ -10,6 +10,11 @@
 import { PopoverProps as AntdPopoverProps } from 'antd';
 import { FlowContext } from '../flowContext';
 import { ViewNavigation } from './ViewNavigation';
+export type FlowViewBeforeClosePayload = {
+    result?: any;
+    force?: boolean;
+};
+export type FlowViewBeforeCloseHandler = (payload: FlowViewBeforeClosePayload) => Promise<boolean | void> | boolean | void;
 export type FlowView = {
     type: 'drawer' | 'popover' | 'dialog' | 'embed';
     inputArgs: any;
@@ -20,8 +25,9 @@ export type FlowView = {
     Footer: React.FC<{
         children?: React.ReactNode;
     }> | null;
-    close: (result?: any, force?: boolean) => void;
+    close: (result?: any, force?: boolean) => Promise<boolean | void> | boolean | void;
     update: (newConfig: any) => void;
+    beforeClose?: FlowViewBeforeCloseHandler;
     navigation?: ViewNavigation;
     /** 页面的销毁方法 */
     destroy?: () => void;

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/ViewNavigation.js

@@ -43,6 +43,10 @@ function encodeFilterByTk(val) {
   return encodeURIComponent(String(val));
 }
 __name(encodeFilterByTk, "encodeFilterByTk");
+function hasUsableSourceId(sourceId) {
+  return sourceId !== void 0 && sourceId !== null && String(sourceId) !== "";
+}
+__name(hasUsableSourceId, "hasUsableSourceId");
 function generatePathnameFromViewParams(viewParams) {
   if (!viewParams || viewParams.length === 0) {
     return "/admin";
@@ -62,8 +66,8 @@ function generatePathnameFromViewParams(viewParams) {
         segments.push("filterbytk", encoded);
       }
     }
-    if (viewParam.sourceId) {
-      segments.push("sourceid", viewParam.sourceId);
+    if (hasUsableSourceId(viewParam.sourceId)) {
+      segments.push("sourceid", String(viewParam.sourceId));
     }
   });
   return "/" + segments.join("/");

package/lib/views/runViewBeforeClose.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 { FlowView, FlowViewBeforeClosePayload } from './FlowView';
+export declare function runViewBeforeClose(view: FlowView, payload: FlowViewBeforeClosePayload): Promise<boolean>;

package/lib/views/runViewBeforeClose.js

@@ -0,0 +1,45 @@
+/**
+ * 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 __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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var runViewBeforeClose_exports = {};
+__export(runViewBeforeClose_exports, {
+  runViewBeforeClose: () => runViewBeforeClose
+});
+module.exports = __toCommonJS(runViewBeforeClose_exports);
+async function runViewBeforeClose(view, payload) {
+  var _a;
+  if (payload.force) {
+    return true;
+  }
+  const result = await ((_a = view.beforeClose) == null ? void 0 : _a.call(view, payload));
+  return result !== false;
+}
+__name(runViewBeforeClose, "runViewBeforeClose");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  runViewBeforeClose
+});

package/lib/views/useDialog.d.ts

@@ -12,9 +12,10 @@ export declare function useDialog(): (React.JSX.Element | {
         type: "dialog";
         inputArgs: any;
         preventClose: boolean;
+        beforeClose: any;
         destroy: (result?: any) => void;
         update: (newConfig: any) => void;
-        close: (result?: any, force?: boolean) => void;
+        close: (result?: any, force?: boolean) => Promise<boolean>;
         Footer: React.FC<{
             children?: React.ReactNode;
         }>;

package/lib/views/useDialog.js

@@ -52,6 +52,7 @@ var import_viewEvents = require("./viewEvents");
 var import_provider = require("../provider");
 var import_ViewScopedFlowEngine = require("../ViewScopedFlowEngine");
 var import_variablesParams = require("../utils/variablesParams");
+var import_runViewBeforeClose = require("./runViewBeforeClose");
 let uuid = 0;
 function useDialog() {
   const holderRef = React.useRef(null);
@@ -103,12 +104,16 @@ function useDialog() {
     } else {
       ctx.addDelegate(flowContext.engine.context);
     }
+    let destroyed = false;
     const currentDialog = {
       type: "dialog",
       inputArgs: config.inputArgs || {},
       preventClose: !!config.preventClose,
+      beforeClose: void 0,
       destroy: /* @__PURE__ */ __name((result) => {
         var _a2, _b2, _c2, _d;
+        if (destroyed) return;
+        destroyed = true;
         (_a2 = config.onClose) == null ? void 0 : _a2.call(config);
         (_b2 = dialogRef.current) == null ? void 0 : _b2.destroy();
         closeFunc == null ? void 0 : closeFunc();
@@ -122,16 +127,21 @@ function useDialog() {
         var _a2;
         return (_a2 = dialogRef.current) == null ? void 0 : _a2.update(newConfig);
       }, "update"),
-      close: /* @__PURE__ */ __name((result, force) => {
+      close: /* @__PURE__ */ __name(async (result, force) => {
         var _a2, _b2;
         if (config.preventClose && !force) {
-          return;
+          return false;
+        }
+        const shouldClose = await (0, import_runViewBeforeClose.runViewBeforeClose)(currentDialog, { result, force });
+        if (!shouldClose) {
+          return false;
         }
         if (config.triggerByRouter && ((_b2 = (_a2 = config.inputArgs) == null ? void 0 : _a2.navigation) == null ? void 0 : _b2.back)) {
           config.inputArgs.navigation.back();
-          return;
+          return true;
         }
         currentDialog.destroy(result);
+        return true;
       }, "close"),
       Footer: FooterComponent,
       Header: HeaderComponent,
@@ -154,6 +164,13 @@ function useDialog() {
       get: /* @__PURE__ */ __name(() => currentDialog, "get"),
       resolveOnServer: (0, import_variablesParams.createViewRecordResolveOnServer)(ctx, () => (0, import_variablesParams.getViewRecordFromParent)(flowContext, ctx))
     });
+    scopedEngine.setDestroyView(() => {
+      var _a2, _b2;
+      if (config.triggerByRouter && ((_b2 = (_a2 = config.inputArgs) == null ? void 0 : _a2.navigation) == null ? void 0 : _b2.back)) {
+        config.inputArgs.navigation.back();
+      }
+      currentDialog.destroy();
+    });
     (0, import_createViewMeta.registerPopupVariable)(ctx, currentDialog);
     const DialogWithContext = (0, import__.observer)(
       () => {

package/lib/views/useDrawer.d.ts

@@ -13,9 +13,10 @@ export declare function useDrawer(): (React.JSX.Element | {
         type: "drawer";
         inputArgs: any;
         preventClose: boolean;
+        beforeClose: any;
         destroy: (result?: any) => void;
         update: (newConfig: any) => void;
-        close: (result?: any, force?: boolean) => void;
+        close: (result?: any, force?: boolean) => Promise<boolean>;
         Footer: React.FC<{
             children?: React.ReactNode;
         }>;

package/lib/views/useDrawer.js

@@ -52,6 +52,7 @@ var import_viewEvents = require("./viewEvents");
 var import_provider = require("../provider");
 var import_ViewScopedFlowEngine = require("../ViewScopedFlowEngine");
 var import_variablesParams = require("../utils/variablesParams");
+var import_runViewBeforeClose = require("./runViewBeforeClose");
 function useDrawer() {
   const holderRef = React.useRef(null);
   const drawerList = React.useMemo(() => import__.observable.shallow({ value: [] }), []);
@@ -122,12 +123,16 @@ function useDrawer() {
     } else {
       ctx.addDelegate(flowContext.engine.context);
     }
+    let destroyed = false;
     const currentDrawer = {
       type: "drawer",
       inputArgs: config.inputArgs || {},
       preventClose: !!config.preventClose,
+      beforeClose: void 0,
       destroy: /* @__PURE__ */ __name((result) => {
         var _a2, _b2, _c, _d;
+        if (destroyed) return;
+        destroyed = true;
         (_a2 = config.onClose) == null ? void 0 : _a2.call(config);
         (_b2 = drawerRef.current) == null ? void 0 : _b2.destroy();
         closeFunc == null ? void 0 : closeFunc();
@@ -141,16 +146,21 @@ function useDrawer() {
         var _a2;
         return (_a2 = drawerRef.current) == null ? void 0 : _a2.update(newConfig);
       }, "update"),
-      close: /* @__PURE__ */ __name((result, force) => {
+      close: /* @__PURE__ */ __name(async (result, force) => {
         var _a2, _b2;
         if (config.preventClose && !force) {
-          return;
+          return false;
+        }
+        const shouldClose = await (0, import_runViewBeforeClose.runViewBeforeClose)(currentDrawer, { result, force });
+        if (!shouldClose) {
+          return false;
         }
         if (config.triggerByRouter && ((_b2 = (_a2 = config.inputArgs) == null ? void 0 : _a2.navigation) == null ? void 0 : _b2.back)) {
           config.inputArgs.navigation.back();
-          return;
+          return true;
         }
         currentDrawer.destroy(result);
+        return true;
       }, "close"),
       Footer: FooterComponent,
       Header: HeaderComponent,
@@ -173,6 +183,13 @@ function useDrawer() {
       get: /* @__PURE__ */ __name(() => currentDrawer, "get"),
       resolveOnServer: (0, import_variablesParams.createViewRecordResolveOnServer)(ctx, () => (0, import_variablesParams.getViewRecordFromParent)(flowContext, ctx))
     });
+    scopedEngine.setDestroyView(() => {
+      var _a2, _b2;
+      if (config.triggerByRouter && ((_b2 = (_a2 = config.inputArgs) == null ? void 0 : _a2.navigation) == null ? void 0 : _b2.back)) {
+        config.inputArgs.navigation.back();
+      }
+      currentDrawer.destroy();
+    });
     (0, import_createViewMeta.registerPopupVariable)(ctx, currentDrawer);
     const DrawerWithContext = React.memo(
       (0, import__.observer)((props) => {

package/lib/views/usePage.d.ts

@@ -12,26 +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) => void;
-        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;
     };
 })[];