@nocobase/flow-engine 2.0.0-beta.22 → 2.0.0-beta.23

package/lib/utils/resolveRunJSObjectValues.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+/**
+ * Resolve an object's values, executing any RunJSValue entries via ctx.runjs.
+ *
+ * - Skips `undefined` values
+ * - Skips empty RunJS code (treated as not configured)
+ * - Throws when a RunJS execution fails
+ */
+export declare function resolveRunJSObjectValues(ctx: unknown, raw: unknown): Promise<Record<string, any>>;

package/lib/utils/resolveRunJSObjectValues.js

@@ -0,0 +1,61 @@
+/**
+ * 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 resolveRunJSObjectValues_exports = {};
+__export(resolveRunJSObjectValues_exports, {
+  resolveRunJSObjectValues: () => resolveRunJSObjectValues
+});
+module.exports = __toCommonJS(resolveRunJSObjectValues_exports);
+var import_runjsValue = require("./runjsValue");
+var import_safeGlobals = require("./safeGlobals");
+async function resolveRunJSObjectValues(ctx, raw) {
+  const out = {};
+  if (!raw || typeof raw !== "object") return out;
+  if (Array.isArray(raw)) return out;
+  for (const [key, value] of Object.entries(raw)) {
+    if (typeof value === "undefined") continue;
+    if ((0, import_runjsValue.isRunJSValue)(value)) {
+      const { code, version } = (0, import_runjsValue.normalizeRunJSValue)(value);
+      if (!code.trim()) continue;
+      const ret = await (0, import_safeGlobals.runjsWithSafeGlobals)(ctx, code, { version });
+      if (!(ret == null ? void 0 : ret.success)) {
+        throw new Error(`RunJS execution failed for "${key}"`);
+      }
+      if (typeof ret.value !== "undefined") {
+        out[key] = ret.value;
+      }
+      continue;
+    }
+    out[key] = value;
+  }
+  return out;
+}
+__name(resolveRunJSObjectValues, "resolveRunJSObjectValues");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  resolveRunJSObjectValues
+});

package/lib/utils/runjsValue.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 type RunJSValue = {
+    code: string;
+    version?: string;
+};
+/**
+ * Strictly detect RunJSValue to avoid conflicting with normal constant objects.
+ * - MUST be a plain object (not array)
+ * - MUST include string `code`
+ * - MAY include string `version`
+ * - MUST NOT include any other enumerable keys
+ */
+export declare function isRunJSValue(value: any): value is RunJSValue;
+export declare function normalizeRunJSValue(value: RunJSValue): Required<RunJSValue>;
+/**
+ * Heuristic extraction of ctx variable usage from RunJS code.
+ *
+ * Returns a map: varName -> string[] subPaths
+ * - subPath '' means the variable root is used (or dependency is dynamic), caller MAY treat it as wildcard.
+ * - Only best-effort parsing; correctness prefers over-approximation.
+ */
+export declare function extractUsedVariablePathsFromRunJS(code: string): Record<string, string[]>;

package/lib/utils/runjsValue.js

@@ -0,0 +1,275 @@
+/**
+ * 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 runjsValue_exports = {};
+__export(runjsValue_exports, {
+  extractUsedVariablePathsFromRunJS: () => extractUsedVariablePathsFromRunJS,
+  isRunJSValue: () => isRunJSValue,
+  normalizeRunJSValue: () => normalizeRunJSValue
+});
+module.exports = __toCommonJS(runjsValue_exports);
+const RUNJS_ALLOWED_KEYS = /* @__PURE__ */ new Set(["code", "version"]);
+function isRunJSValue(value) {
+  if (!value || typeof value !== "object") return false;
+  if (Array.isArray(value)) return false;
+  const keys = Object.keys(value);
+  if (!keys.includes("code")) return false;
+  if (typeof value.code !== "string") return false;
+  if ("version" in value && value.version != null && typeof value.version !== "string") return false;
+  for (const k of keys) {
+    if (!RUNJS_ALLOWED_KEYS.has(k)) return false;
+  }
+  return true;
+}
+__name(isRunJSValue, "isRunJSValue");
+function normalizeRunJSValue(value) {
+  return {
+    code: String((value == null ? void 0 : value.code) ?? ""),
+    version: String((value == null ? void 0 : value.version) ?? "v1")
+  };
+}
+__name(normalizeRunJSValue, "normalizeRunJSValue");
+function stripStringsAndComments(code) {
+  let out = "";
+  let state = "code";
+  for (let i = 0; i < code.length; i++) {
+    const ch = code[i];
+    const next = i + 1 < code.length ? code[i + 1] : "";
+    if (state === "code") {
+      if (ch === "/" && next === "/") {
+        out += "  ";
+        i++;
+        state = "line";
+        continue;
+      }
+      if (ch === "/" && next === "*") {
+        out += "  ";
+        i++;
+        state = "block";
+        continue;
+      }
+      if (ch === "'") {
+        out += " ";
+        state = "single";
+        continue;
+      }
+      if (ch === '"') {
+        out += " ";
+        state = "double";
+        continue;
+      }
+      out += ch;
+      continue;
+    }
+    if (state === "line") {
+      if (ch === "\n") {
+        out += "\n";
+        state = "code";
+      } else {
+        out += " ";
+      }
+      continue;
+    }
+    if (state === "block") {
+      if (ch === "*" && next === "/") {
+        out += "  ";
+        i++;
+        state = "code";
+      } else {
+        out += ch === "\n" ? "\n" : " ";
+      }
+      continue;
+    }
+    if (state === "single") {
+      if (ch === "\\") {
+        out += "  ";
+        i++;
+        continue;
+      }
+      if (ch === "'") {
+        out += " ";
+        state = "code";
+      } else {
+        out += ch === "\n" ? "\n" : " ";
+      }
+      continue;
+    }
+    if (ch === "\\") {
+      out += "  ";
+      i++;
+      continue;
+    }
+    if (ch === '"') {
+      out += " ";
+      state = "code";
+    } else {
+      out += ch === "\n" ? "\n" : " ";
+    }
+  }
+  return out;
+}
+__name(stripStringsAndComments, "stripStringsAndComments");
+function stripComments(code) {
+  let out = "";
+  let state = "code";
+  for (let i = 0; i < code.length; i++) {
+    const ch = code[i];
+    const next = i + 1 < code.length ? code[i + 1] : "";
+    if (state === "code") {
+      if (ch === "/" && next === "/") {
+        out += "  ";
+        i++;
+        state = "line";
+        continue;
+      }
+      if (ch === "/" && next === "*") {
+        out += "  ";
+        i++;
+        state = "block";
+        continue;
+      }
+      if (ch === "'") {
+        out += ch;
+        state = "single";
+        continue;
+      }
+      if (ch === '"') {
+        out += ch;
+        state = "double";
+        continue;
+      }
+      out += ch;
+      continue;
+    }
+    if (state === "line") {
+      if (ch === "\n") {
+        out += "\n";
+        state = "code";
+      } else {
+        out += " ";
+      }
+      continue;
+    }
+    if (state === "block") {
+      if (ch === "*" && next === "/") {
+        out += "  ";
+        i++;
+        state = "code";
+      } else {
+        out += ch === "\n" ? "\n" : " ";
+      }
+      continue;
+    }
+    if (state === "single") {
+      out += ch;
+      if (ch === "\\") {
+        const nextCh = i + 1 < code.length ? code[i + 1] : "";
+        if (nextCh) {
+          out += nextCh;
+          i++;
+        }
+        continue;
+      }
+      if (ch === "'") {
+        state = "code";
+      }
+      continue;
+    }
+    out += ch;
+    if (ch === "\\") {
+      const nextCh = i + 1 < code.length ? code[i + 1] : "";
+      if (nextCh) {
+        out += nextCh;
+        i++;
+      }
+      continue;
+    }
+    if (ch === '"') {
+      state = "code";
+    }
+  }
+  return out;
+}
+__name(stripComments, "stripComments");
+function normalizeSubPath(raw) {
+  if (!raw) return { subPath: "", wildcard: false };
+  let s = raw;
+  s = s.replace(/\[['"]([a-zA-Z_$][a-zA-Z0-9_$]*)['"]\]/g, ".$1");
+  const bracketRe = /\[([^\]]+)\]/g;
+  let m;
+  while (m = bracketRe.exec(s)) {
+    const inner = String(m[1] ?? "").trim();
+    if (/^\d+$/.test(inner)) continue;
+    if (/^['"][a-zA-Z_$][a-zA-Z0-9_$]*['"]$/.test(inner)) continue;
+    return { subPath: s.startsWith(".") ? s.slice(1) : s, wildcard: true };
+  }
+  if (s.startsWith(".")) s = s.slice(1);
+  return { subPath: s, wildcard: false };
+}
+__name(normalizeSubPath, "normalizeSubPath");
+function extractUsedVariablePathsFromRunJS(code) {
+  if (typeof code !== "string" || !code.trim()) return {};
+  const src = stripStringsAndComments(code);
+  const srcWithStrings = stripComments(code);
+  const usage = /* @__PURE__ */ new Map();
+  const add = /* @__PURE__ */ __name((varName, subPath) => {
+    if (!varName) return;
+    const set = usage.get(varName) || /* @__PURE__ */ new Set();
+    set.add(subPath || "");
+    usage.set(varName, set);
+  }, "add");
+  const dotRe = /ctx\.([a-zA-Z_$][a-zA-Z0-9_$]*(?:(?:\.[a-zA-Z_$][a-zA-Z0-9_$]*)|(?:\[[^\]]+\]))*)(?!\s*\()/g;
+  let match;
+  while (match = dotRe.exec(src)) {
+    const pathAfterCtx = match[1] || "";
+    const firstKeyMatch = pathAfterCtx.match(/^([a-zA-Z_$][a-zA-Z0-9_$]*)/);
+    if (!firstKeyMatch) continue;
+    const firstKey = firstKeyMatch[1];
+    const rest = pathAfterCtx.slice(firstKey.length);
+    const { subPath, wildcard } = normalizeSubPath(rest);
+    add(firstKey, wildcard ? "" : subPath);
+  }
+  const bracketRootRe = /ctx\s*\[\s*(['"])([a-zA-Z_$][a-zA-Z0-9_$]*)\1\s*\]((?:(?:\.[a-zA-Z_$][a-zA-Z0-9_$]*)|(?:\[[^\]]+\]))*)(?!\s*\()/g;
+  while (match = bracketRootRe.exec(srcWithStrings)) {
+    const varName = match[2] || "";
+    const rest = match[3] || "";
+    const { subPath, wildcard } = normalizeSubPath(rest);
+    add(varName, wildcard ? "" : subPath);
+  }
+  const out = {};
+  for (const [k, set] of usage.entries()) {
+    out[k] = Array.from(set);
+  }
+  return out;
+}
+__name(extractUsedVariablePathsFromRunJS, "extractUsedVariablePathsFromRunJS");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractUsedVariablePathsFromRunJS,
+  isRunJSValue,
+  normalizeRunJSValue
+});

package/lib/utils/safeGlobals.d.ts

@@ -12,3 +12,17 @@ export declare function __resetRunJSSafeGlobalsRegistryForTests(): void;
 export declare function createSafeWindow(extra?: Record<string, any>): Record<string, any>;
 export declare function createSafeDocument(extra?: Record<string, any>): Record<string, any>;
 export declare function createSafeNavigator(extra?: Record<string, any>): {};
+/**
+ * Create a safe globals object for RunJS execution.
+ *
+ * - Always tries to provide `navigator`
+ * - Best-effort provides `window` and `document` in browser environments
+ * - Never throws (so callers can decide how to handle missing globals)
+ */
+export declare function createSafeRunJSGlobals(extraGlobals?: Record<string, any>): Record<string, any>;
+/**
+ * Execute RunJS with safe globals (window/document/navigator).
+ *
+ * Keeps `this` binding by calling `ctx.runjs(...)` instead of passing bare function references.
+ */
+export declare function runjsWithSafeGlobals(ctx: unknown, code: string, options?: any, extraGlobals?: Record<string, any>): Promise<any>;

package/lib/utils/safeGlobals.js

@@ -30,9 +30,11 @@ __export(safeGlobals_exports, {
   __resetRunJSSafeGlobalsRegistryForTests: () => __resetRunJSSafeGlobalsRegistryForTests,
   createSafeDocument: () => createSafeDocument,
   createSafeNavigator: () => createSafeNavigator,
+  createSafeRunJSGlobals: () => createSafeRunJSGlobals,
   createSafeWindow: () => createSafeWindow,
   registerRunJSSafeDocumentGlobals: () => registerRunJSSafeDocumentGlobals,
-  registerRunJSSafeWindowGlobals: () => registerRunJSSafeWindowGlobals
+  registerRunJSSafeWindowGlobals: () => registerRunJSSafeWindowGlobals,
+  runjsWithSafeGlobals: () => runjsWithSafeGlobals
 });
 module.exports = __toCommonJS(safeGlobals_exports);
 function getRunJSSafeGlobalsRegistry() {
@@ -323,12 +325,43 @@ function createSafeNavigator(extra) {
   );
 }
 __name(createSafeNavigator, "createSafeNavigator");
+function createSafeRunJSGlobals(extraGlobals) {
+  const globals = {};
+  try {
+    const navigator = createSafeNavigator();
+    globals.navigator = navigator;
+    try {
+      globals.window = createSafeWindow({ navigator });
+    } catch {
+    }
+  } catch {
+  }
+  try {
+    globals.document = createSafeDocument();
+  } catch {
+  }
+  return extraGlobals ? { ...globals, ...extraGlobals } : globals;
+}
+__name(createSafeRunJSGlobals, "createSafeRunJSGlobals");
+async function runjsWithSafeGlobals(ctx, code, options, extraGlobals) {
+  if (!ctx || typeof ctx !== "object" && typeof ctx !== "function") return void 0;
+  const runjs = ctx.runjs;
+  if (typeof runjs !== "function") return void 0;
+  return ctx.runjs(
+    code,
+    createSafeRunJSGlobals(extraGlobals),
+    options
+  );
+}
+__name(runjsWithSafeGlobals, "runjsWithSafeGlobals");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   __resetRunJSSafeGlobalsRegistryForTests,
   createSafeDocument,
   createSafeNavigator,
+  createSafeRunJSGlobals,
   createSafeWindow,
   registerRunJSSafeDocumentGlobals,
-  registerRunJSSafeWindowGlobals
+  registerRunJSSafeWindowGlobals,
+  runjsWithSafeGlobals
 });

package/lib/utils/schema-utils.d.ts

@@ -44,3 +44,13 @@ export declare function resolveStepUiSchema<TModel extends FlowModel = FlowModel
  * - hideInSettings 可为布尔值或函数（接收 FlowRuntimeContext）。
  */
 export declare function shouldHideStepInSettings<TModel extends FlowModel = FlowModel>(model: TModel, flow: any, step: StepDefinition): Promise<boolean>;
+/**
+ * 解析步骤在设置菜单中的禁用状态与提示文案。
+ * - 支持 StepDefinition.disabledInSettings 与 ActionDefinition.disabledInSettings（step 优先）。
+ * - 支持 StepDefinition.disabledReasonInSettings 与 ActionDefinition.disabledReasonInSettings（step 优先）。
+ * - 以上属性均支持静态值与函数（接收 FlowRuntimeContext）。
+ */
+export declare function resolveStepDisabledInSettings<TModel extends FlowModel = FlowModel>(model: TModel, flow: any, step: StepDefinition): Promise<{
+    disabled: boolean;
+    reason?: string;
+}>;

package/lib/utils/schema-utils.js

@@ -28,6 +28,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var schema_utils_exports = {};
 __export(schema_utils_exports, {
   compileUiSchema: () => compileUiSchema,
+  resolveStepDisabledInSettings: () => resolveStepDisabledInSettings,
   resolveStepUiSchema: () => resolveStepUiSchema,
   resolveUiMode: () => resolveUiMode,
   shouldHideStepInSettings: () => shouldHideStepInSettings
@@ -217,9 +218,69 @@ async function shouldHideStepInSettings(model, flow, step) {
   return !!hideInSettings;
 }
 __name(shouldHideStepInSettings, "shouldHideStepInSettings");
+async function resolveStepDisabledInSettings(model, flow, step) {
+  var _a;
+  if (!step) return { disabled: false };
+  let disabledInSettings = step.disabledInSettings;
+  let disabledReasonInSettings = step.disabledReasonInSettings;
+  if ((typeof disabledInSettings === "undefined" || typeof disabledReasonInSettings === "undefined") && step.use) {
+    try {
+      const action = (_a = model.getAction) == null ? void 0 : _a.call(model, step.use);
+      if (typeof disabledInSettings === "undefined") {
+        disabledInSettings = action == null ? void 0 : action.disabledInSettings;
+      }
+      if (typeof disabledReasonInSettings === "undefined") {
+        disabledReasonInSettings = action == null ? void 0 : action.disabledReasonInSettings;
+      }
+    } catch (error) {
+      console.warn(`Failed to get action ${step.use}:`, error);
+    }
+  }
+  let ctx = null;
+  const getContext = /* @__PURE__ */ __name(() => {
+    if (ctx) return ctx;
+    ctx = new import_flowContext.FlowRuntimeContext(model, flow.key, "settings");
+    (0, import_setupRuntimeContextSteps.setupRuntimeContextSteps)(ctx, flow.steps, model, flow.key);
+    ctx.defineProperty("currentStep", { value: step });
+    return ctx;
+  }, "getContext");
+  let disabled = false;
+  if (typeof disabledInSettings === "function") {
+    try {
+      disabled = !!await disabledInSettings(getContext());
+    } catch (error) {
+      console.warn(`Error evaluating disabledInSettings for step '${step.key || ""}' in flow '${flow.key}':`, error);
+      return { disabled: false };
+    }
+  } else {
+    disabled = !!disabledInSettings;
+  }
+  if (!disabled) {
+    return { disabled: false };
+  }
+  let reason;
+  if (typeof disabledReasonInSettings === "function") {
+    try {
+      const resolved = await disabledReasonInSettings(getContext());
+      if (typeof resolved !== "undefined" && resolved !== null && resolved !== "") {
+        reason = String(resolved);
+      }
+    } catch (error) {
+      console.warn(
+        `Error evaluating disabledReasonInSettings for step '${step.key || ""}' in flow '${flow.key}':`,
+        error
+      );
+    }
+  } else if (typeof disabledReasonInSettings !== "undefined" && disabledReasonInSettings !== null && disabledReasonInSettings !== "") {
+    reason = String(disabledReasonInSettings);
+  }
+  return { disabled: true, reason };
+}
+__name(resolveStepDisabledInSettings, "resolveStepDisabledInSettings");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   compileUiSchema,
+  resolveStepDisabledInSettings,
   resolveStepUiSchema,
   resolveUiMode,
   shouldHideStepInSettings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/flow-engine",
-  "version": "2.0.0-beta.22",
+  "version": "2.0.0-beta.23",
   "private": false,
   "description": "A standalone flow engine for NocoBase, managing workflows, models, and actions.",
   "main": "lib/index.js",
@@ -8,8 +8,8 @@
   "dependencies": {
     "@formily/antd-v5": "1.x",
     "@formily/reactive": "2.x",
-    "@nocobase/sdk": "2.0.0-beta.22",
-    "@nocobase/shared": "2.0.0-beta.22",
+    "@nocobase/sdk": "2.0.0-beta.23",
+    "@nocobase/shared": "2.0.0-beta.23",
     "ahooks": "^3.7.2",
     "dayjs": "^1.11.9",
     "dompurify": "^3.0.2",
@@ -36,5 +36,5 @@
   ],
   "author": "NocoBase Team",
   "license": "AGPL-3.0",
-  "gitHead": "a49874a59e48eda08c1a1570466e8baff00b8a24"
+  "gitHead": "0279d8edffa3af9cab21956bb5f2d07322897271"
 }