@nocobase/flow-engine 2.0.0-alpha.10

package/lib/runjs-context/contexts/JSFieldRunJSContext.js

@@ -0,0 +1,74 @@
+/**
+ * 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 JSFieldRunJSContext_exports = {};
+__export(JSFieldRunJSContext_exports, {
+  JSFieldRunJSContext: () => JSFieldRunJSContext
+});
+module.exports = __toCommonJS(JSFieldRunJSContext_exports);
+var import_flowContext = require("../../flowContext");
+const _JSFieldRunJSContext = class _JSFieldRunJSContext extends import_flowContext.FlowRunJSContext {
+};
+__name(_JSFieldRunJSContext, "JSFieldRunJSContext");
+let JSFieldRunJSContext = _JSFieldRunJSContext;
+JSFieldRunJSContext.define({
+  label: "JSField RunJS context",
+  properties: {
+    element: `ElementProxy instance providing a safe DOM container for field rendering.
+      Supports innerHTML, append, and other DOM manipulation methods.`,
+    value: `Current value of the field (read-only).
+      Contains the data value stored in this field.`,
+    record: `Current record data object (read-only).
+      Contains all field values of the parent record.`,
+    collection: `Collection definition metadata (read-only).
+      Provides schema information about the collection this field belongs to.`
+  },
+  methods: {
+    onRefReady: `Wait for field container DOM element to be ready before executing callback.
+      Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void
+      Example: ctx.onRefReady(ctx.ref, (el) => { el.innerHTML = ctx.value })`
+  }
+});
+JSFieldRunJSContext.define(
+  {
+    label: "JS \u5B57\u6BB5 RunJS \u4E0A\u4E0B\u6587",
+    properties: {
+      element: "ElementProxy\uFF0C\u5B57\u6BB5\u6E32\u67D3\u5BB9\u5668\uFF0C\u652F\u6301 innerHTML/append \u7B49 DOM \u64CD\u4F5C",
+      value: "\u5B57\u6BB5\u5F53\u524D\u503C\uFF08\u53EA\u8BFB\uFF09",
+      record: "\u5F53\u524D\u8BB0\u5F55\u5BF9\u8C61\uFF08\u53EA\u8BFB\uFF0C\u5305\u542B\u7236\u8BB0\u5F55\u5168\u90E8\u5B57\u6BB5\u503C\uFF09",
+      collection: "\u96C6\u5408\u5B9A\u4E49\u5143\u6570\u636E\uFF08\u53EA\u8BFB\uFF0C\u63CF\u8FF0\u5B57\u6BB5\u6240\u5C5E\u96C6\u5408\u7684 Schema\uFF09"
+    },
+    methods: {
+      onRefReady: "\u5728\u5B57\u6BB5\u5BB9\u5668 DOM \u5C31\u7EEA\u540E\u6267\u884C\u56DE\u8C03\u3002\u53C2\u6570\uFF1A(ref, callback, timeout?)\uFF1B\u793A\u4F8B\uFF1Actx.onRefReady(ctx.ref, el => { el.innerHTML = ctx.value })"
+    }
+  },
+  { locale: "zh-CN" }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  JSFieldRunJSContext
+});

package/lib/runjs-context/contexts/JSItemRunJSContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { FlowRunJSContext } from '../../flowContext';
+export declare class JSItemRunJSContext extends FlowRunJSContext {
+}

package/lib/runjs-context/contexts/JSItemRunJSContext.js

@@ -0,0 +1,70 @@
+/**
+ * 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 JSItemRunJSContext_exports = {};
+__export(JSItemRunJSContext_exports, {
+  JSItemRunJSContext: () => JSItemRunJSContext
+});
+module.exports = __toCommonJS(JSItemRunJSContext_exports);
+var import_flowContext = require("../../flowContext");
+const _JSItemRunJSContext = class _JSItemRunJSContext extends import_flowContext.FlowRunJSContext {
+};
+__name(_JSItemRunJSContext, "JSItemRunJSContext");
+let JSItemRunJSContext = _JSItemRunJSContext;
+JSItemRunJSContext.define({
+  label: "JSItem RunJS context",
+  properties: {
+    element: `ElementProxy instance providing a safe DOM container for form item rendering.
+      Supports innerHTML, append, and other DOM manipulation methods.`,
+    resource: `Current resource instance (read-only).
+      Provides access to the data resource associated with the current form context.`,
+    record: `Current record data object (read-only).
+      Contains all field values of the parent record.`
+  },
+  methods: {
+    onRefReady: `Wait for form item container DOM element to be ready before executing callback.
+      Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void`
+  }
+});
+JSItemRunJSContext.define(
+  {
+    label: "JS \u8868\u5355\u9879 RunJS \u4E0A\u4E0B\u6587",
+    properties: {
+      element: "ElementProxy\uFF0C\u8868\u5355\u9879\u6E32\u67D3\u5BB9\u5668\uFF0C\u652F\u6301 innerHTML/append \u7B49 DOM \u64CD\u4F5C",
+      resource: "\u5F53\u524D\u8D44\u6E90\uFF08\u53EA\u8BFB\uFF09",
+      record: "\u5F53\u524D\u8BB0\u5F55\uFF08\u53EA\u8BFB\uFF09"
+    },
+    methods: {
+      onRefReady: "\u5BB9\u5668\u5C31\u7EEA\u540E\u6267\u884C\u56DE\u8C03\u3002\u53C2\u6570\uFF1A(ref, callback, timeout?)"
+    }
+  },
+  { locale: "zh-CN" }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  JSItemRunJSContext
+});

package/lib/runjs-context/contexts/JSRecordActionRunJSContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { FlowRunJSContext } from '../../flowContext';
+export declare class JSRecordActionRunJSContext extends FlowRunJSContext {
+}

package/lib/runjs-context/contexts/JSRecordActionRunJSContext.js

@@ -0,0 +1,60 @@
+/**
+ * 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 JSRecordActionRunJSContext_exports = {};
+__export(JSRecordActionRunJSContext_exports, {
+  JSRecordActionRunJSContext: () => JSRecordActionRunJSContext
+});
+module.exports = __toCommonJS(JSRecordActionRunJSContext_exports);
+var import_flowContext = require("../../flowContext");
+const _JSRecordActionRunJSContext = class _JSRecordActionRunJSContext extends import_flowContext.FlowRunJSContext {
+};
+__name(_JSRecordActionRunJSContext, "JSRecordActionRunJSContext");
+let JSRecordActionRunJSContext = _JSRecordActionRunJSContext;
+JSRecordActionRunJSContext.define({
+  label: "JSRecordAction RunJS context",
+  properties: {
+    record: `Current record data object (read-only).
+      Contains all field values of the record associated with this action.`,
+    filterByTk: `Primary key or filter key of the current record (read-only).
+      Used to identify the specific record in database operations.`
+  }
+});
+JSRecordActionRunJSContext.define(
+  {
+    label: "JS \u8BB0\u5F55\u52A8\u4F5C RunJS \u4E0A\u4E0B\u6587",
+    properties: {
+      record: "\u5F53\u524D\u8BB0\u5F55\uFF08\u53EA\u8BFB\uFF09",
+      filterByTk: "\u4E3B\u952E/\u8FC7\u6EE4\u952E\uFF08\u53EA\u8BFB\uFF09"
+    }
+  },
+  { locale: "zh-CN" }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  JSRecordActionRunJSContext
+});

package/lib/runjs-context/contexts/base.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 function defineBaseContextMeta(): void;

package/lib/runjs-context/contexts/base.js

@@ -0,0 +1,169 @@
+/**
+ * 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 base_exports = {};
+__export(base_exports, {
+  defineBaseContextMeta: () => defineBaseContextMeta
+});
+module.exports = __toCommonJS(base_exports);
+var import_flowContext = require("../../flowContext");
+function defineBaseContextMeta() {
+  import_flowContext.FlowRunJSContext.define({
+    label: "RunJS base",
+    properties: {
+      logger: 'Pino logger instance for structured logging. Example: `ctx.logger.info({ foo: 1 }, "message")`',
+      message: 'Ant Design global message API for displaying temporary messages. Example: `ctx.message.success("Operation completed")`',
+      notification: 'Ant Design notification API for displaying notification boxes. Example: `ctx.notification.open({ message: "Title", description: "Content" })`',
+      resource: "Data resource accessible based on current user permissions",
+      urlSearchParams: "URLSearchParams object containing query parameters from the current URL",
+      token: "API authentication token for the current session",
+      role: "Current user role information",
+      auth: "Authentication context containing locale, role, user, and token information",
+      api: {
+        description: "APIClient instance for making HTTP requests.",
+        detail: "APIClient",
+        properties: {
+          request: {
+            description: "Make an HTTP request using the APIClient instance. Parameters: (options: RequestOptions) => Promise<any>.",
+            detail: "Promise<any>",
+            completion: {
+              insertText: `await ctx.api.request({ url: '', method: 'get', params: {} })`
+            }
+          }
+        }
+      },
+      i18n: {
+        description: "An instance of i18next for managing internationalization.",
+        detail: "i18next",
+        properties: {
+          language: "Current active language code."
+        }
+      },
+      React: "React namespace providing React library functions and hooks (available in RunJS environment)",
+      ReactDOM: "ReactDOM client API including createRoot for rendering React components",
+      antd: "Ant Design component library"
+    },
+    methods: {
+      t: 'Internationalization function for translating text. Parameters: (key: string, variables?: object) => string. Example: `ctx.t("Hello {name}", { name: "World" })`',
+      requireAsync: 'Asynchronously load external libraries from URL. Parameters: (url: string) => Promise<any>. Example: `const lodash = await ctx.requireAsync("https://cdn.jsdelivr.net/npm/lodash")`',
+      importAsync: 'Dynamically import ESM module by URL. Parameters: (url: string) => Promise<Module>. Example: `const mod = await ctx.importAsync("https://cdn.jsdelivr.net/npm/lit-html@2/+esm")`',
+      resolveJsonTemplate: "Resolve JSON templates containing variable expressions with {{ }} syntax. Parameters: (template: any, context?: object) => any",
+      runAction: {
+        description: 'Execute a data action on the current resource. Parameters: (actionName: string, params: object) => Promise<any>. Example: `await ctx.runAction("create", { values: { name: "test" } })`',
+        detail: "Promise<any>",
+        completion: {
+          insertText: `await ctx.runAction('create', { values: {} })`
+        }
+      },
+      openView: {
+        description: `Open a view component (page, modal, or drawer) by its unique identifier.
+      Parameters: (viewId: string, options?: OpenViewOptions) => Promise<void>
+      Options:
+        - params: Record<string, any> - Parameters passed to the view component
+        - mode: "page" | "modal" | "drawer" - Display mode (default: "drawer")
+        - title: string - Modal/drawer title
+        - width: number | string - Modal/drawer width
+        - navigation: boolean - Whether to use route navigation
+        - preventClose: boolean - Prevent closing the view
+        - viewUid: string - Custom view UID for routing
+        - isMobileLayout: boolean - Use mobile layout (displays as embed)
+      Examples:
+       - Modal with params: await ctx.openView("user-detail", { params: { id: 123 }, mode: "modal", title: "User Details", width: 800 })
+       - Drawer (default): await ctx.openView("settings-page")
+        - Page navigation: await ctx.openView("dashboard", { mode: "page" })`,
+        detail: "Promise<void>",
+        completion: {
+          insertText: `await ctx.openView('view-id', { mode: 'drawer', params: {} })`
+        }
+      }
+    }
+  });
+  import_flowContext.FlowRunJSContext.define(
+    {
+      label: "RunJS \u57FA\u7840",
+      properties: {
+        logger: 'Pino \u65E5\u5FD7\u5B9E\u4F8B\uFF08\u7ED3\u6784\u5316\u65E5\u5FD7\uFF09\u3002\u793A\u4F8B\uFF1A`ctx.logger.info({ foo: 1 }, "message")`',
+        message: 'Ant Design \u5168\u5C40\u6D88\u606F API\uFF0C\u7528\u4E8E\u663E\u793A\u4E34\u65F6\u63D0\u793A\u3002\u793A\u4F8B\uFF1A`ctx.message.success("\u64CD\u4F5C\u6210\u529F")`',
+        notification: 'Ant Design \u901A\u77E5 API\uFF0C\u7528\u4E8E\u663E\u793A\u901A\u77E5\u6846\u3002\u793A\u4F8B\uFF1A`ctx.notification.open({ message: "\u6807\u9898", description: "\u5185\u5BB9" })`',
+        resource: "\u57FA\u4E8E\u5F53\u524D\u7528\u6237\u6743\u9650\u53EF\u8BBF\u95EE\u7684\u6570\u636E\u8D44\u6E90",
+        urlSearchParams: "\u5F53\u524D URL \u7684\u67E5\u8BE2\u53C2\u6570\uFF08URLSearchParams \u5BF9\u8C61\uFF09",
+        token: "\u5F53\u524D\u4F1A\u8BDD\u7684 API \u8BA4\u8BC1 token",
+        role: "\u5F53\u524D\u7528\u6237\u89D2\u8272\u4FE1\u606F",
+        auth: "\u8BA4\u8BC1\u4E0A\u4E0B\u6587\uFF0C\u5305\u542B locale\u3001role\u3001user\u3001token \u7B49\u4FE1\u606F",
+        api: {
+          description: "\u7528\u4E8E\u53D1\u8D77 HTTP \u8BF7\u6C42\u7684 APIClient \u5B9E\u4F8B",
+          detail: "APIClient",
+          properties: {
+            request: {
+              description: "\u901A\u8FC7 ctx.api.request \u53D1\u8D77 HTTP \u8BF7\u6C42\uFF0C\u5165\u53C2\u4E3A RequestOptions\uFF0C\u8FD4\u56DE Promise\u3002",
+              detail: "Promise<any>",
+              completion: {
+                insertText: `await ctx.api.request({ url: '', method: 'get', params: {} })`
+              }
+            }
+          }
+        },
+        i18n: {
+          description: "i18next \u5B9E\u4F8B\uFF0C\u53EF\u7528\u4E8E\u7BA1\u7406\u56FD\u9645\u5316",
+          detail: "i18next",
+          properties: {
+            language: "\u5F53\u524D\u6FC0\u6D3B\u7684\u8BED\u8A00\u4EE3\u7801"
+          }
+        },
+        React: "React \u547D\u540D\u7A7A\u95F4\uFF0C\u63D0\u4F9B React \u51FD\u6570\u4E0E hooks\uFF08RunJS \u73AF\u5883\u4E2D\u53EF\u7528\uFF09",
+        ReactDOM: "ReactDOM \u5BA2\u6237\u7AEF API\uFF0C\u542B createRoot \u7B49\u6E32\u67D3\u65B9\u6CD5",
+        antd: "Ant Design \u7EC4\u4EF6\u5E93\uFF08RunJS \u73AF\u5883\u4E2D\u53EF\u7528\uFF09"
+      },
+      methods: {
+        t: '\u56FD\u9645\u5316\u51FD\u6570\uFF0C\u7528\u4E8E\u7FFB\u8BD1\u6587\u6848\u3002\u53C2\u6570\uFF1A(key: string, variables?: object) => string\u3002\u793A\u4F8B\uFF1A`ctx.t("\u4F60\u597D {name}", { name: "\u4E16\u754C" })`',
+        requireAsync: '\u6309 URL \u5F02\u6B65\u52A0\u8F7D\u5916\u90E8\u5E93\u3002\u53C2\u6570\uFF1A(url: string) => Promise<any>\u3002\u793A\u4F8B\uFF1A`const lodash = await ctx.requireAsync("https://cdn.jsdelivr.net/npm/lodash")`',
+        importAsync: '\u6309 URL \u52A8\u6001\u5BFC\u5165 ESM \u6A21\u5757\uFF08\u5F00\u53D1/\u751F\u4EA7\u5747\u53EF\u7528\uFF09\u3002\u53C2\u6570\uFF1A(url: string) => Promise<Module>\u3002\u793A\u4F8B\uFF1A`const mod = await ctx.importAsync("https://cdn.jsdelivr.net/npm/lit-html@2/+esm")`',
+        resolveJsonTemplate: "\u89E3\u6790\u542B {{ }} \u53D8\u91CF\u8868\u8FBE\u5F0F\u7684 JSON \u6A21\u677F\u3002\u53C2\u6570\uFF1A(template: any, context?: object) => any",
+        runAction: {
+          description: '\u5BF9\u5F53\u524D\u8D44\u6E90\u6267\u884C\u6570\u636E\u52A8\u4F5C\u3002\u53C2\u6570\uFF1A(actionName: string, params: object) => Promise<any>\u3002\u793A\u4F8B\uFF1A`await ctx.runAction("create", { values: { name: "test" } })`',
+          detail: "Promise<any>",
+          completion: {
+            insertText: `await ctx.runAction('create', { values: {} })`
+          }
+        },
+        openView: {
+          description: "\u6839\u636E\u552F\u4E00\u6807\u8BC6\u6253\u5F00\u89C6\u56FE\uFF08\u9875\u9762/\u5F39\u7A97/\u62BD\u5C49\uFF09\u3002\u53C2\u6570\uFF1A(viewId: string, options?: OpenViewOptions) => Promise<void>`\uFF0C\u5E38\u7528\u9009\u9879\uFF1Aparams\u3001mode\u3001title\u3001width\u3001navigation\u3001preventClose\u3001viewUid\u3001isMobileLayout\u3002",
+          detail: "Promise<void>",
+          completion: {
+            insertText: `await ctx.openView('view-id', { mode: 'drawer', params: {} })`
+          }
+        }
+      }
+    },
+    { locale: "zh-CN" }
+  );
+}
+__name(defineBaseContextMeta, "defineBaseContextMeta");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineBaseContextMeta
+});

package/lib/runjs-context/helpers.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.
+ */
+import type { FlowContext } from '../flowContext';
+import { JSRunner } from '../JSRunner';
+import type { JSRunnerOptions } from '../JSRunner';
+import { type RunJSVersion } from './registry';
+export declare function getRunJSDocFor(ctx: FlowContext, { version }?: {
+    version?: RunJSVersion;
+}): any;
+export declare function createJSRunnerWithVersion(this: FlowContext, options?: JSRunnerOptions): JSRunner;
+export declare function getRunJSScenesForModel(modelClass: string, version?: RunJSVersion): string[];
+export declare function getRunJSScenesForContext(ctx: FlowContext, { version }?: {
+    version?: RunJSVersion;
+}): string[];

package/lib/runjs-context/helpers.js

@@ -0,0 +1,88 @@
+/**
+ * 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 helpers_exports = {};
+__export(helpers_exports, {
+  createJSRunnerWithVersion: () => createJSRunnerWithVersion,
+  getRunJSDocFor: () => getRunJSDocFor,
+  getRunJSScenesForContext: () => getRunJSScenesForContext,
+  getRunJSScenesForModel: () => getRunJSScenesForModel
+});
+module.exports = __toCommonJS(helpers_exports);
+var import_JSRunner = require("../JSRunner");
+var import_registry = require("./registry");
+function getLocale(ctx) {
+  var _a, _b, _c;
+  return ((_b = (_a = ctx == null ? void 0 : ctx.api) == null ? void 0 : _a.auth) == null ? void 0 : _b.locale) || ((_c = ctx == null ? void 0 : ctx.i18n) == null ? void 0 : _c.language) || (ctx == null ? void 0 : ctx.locale);
+}
+__name(getLocale, "getLocale");
+function getRunJSDocFor(ctx, { version = "v1" } = {}) {
+  var _a, _b;
+  const modelClass = (0, import_registry.getModelClassName)(ctx);
+  const ctor = import_registry.RunJSContextRegistry.resolve(version, modelClass) || import_registry.RunJSContextRegistry.resolve(version, "*");
+  const locale = getLocale(ctx);
+  if ((_a = ctor == null ? void 0 : ctor.getDoc) == null ? void 0 : _a.length) {
+    return ctor.getDoc(locale) || {};
+  }
+  return ((_b = ctor == null ? void 0 : ctor.getDoc) == null ? void 0 : _b.call(ctor)) || {};
+}
+__name(getRunJSDocFor, "getRunJSDocFor");
+function createJSRunnerWithVersion(options) {
+  const version = (options == null ? void 0 : options.version) || "v1";
+  const modelClass = (0, import_registry.getModelClassName)(this);
+  const ensureFlowContext = /* @__PURE__ */ __name((obj) => obj, "ensureFlowContext");
+  const Ctor = import_registry.RunJSContextRegistry.resolve(version, modelClass) || import_registry.RunJSContextRegistry.resolve(version, "*");
+  if (!Ctor) {
+    throw new Error("[RunJS] No RunJSContext registered for version/model.");
+  }
+  const runCtx = new Ctor(ensureFlowContext(this));
+  const globals = { ctx: runCtx, ...(options == null ? void 0 : options.globals) || {} };
+  if (modelClass === "JSFieldModel" || modelClass === "JSBlockModel") {
+    if (typeof window !== "undefined") globals.window = window;
+    if (typeof document !== "undefined") globals.document = document;
+  }
+  const { timeoutMs } = options || {};
+  return new import_JSRunner.JSRunner({ globals, timeoutMs });
+}
+__name(createJSRunnerWithVersion, "createJSRunnerWithVersion");
+function getRunJSScenesForModel(modelClass, version = "v1") {
+  const meta = import_registry.RunJSContextRegistry.getMeta(version, modelClass);
+  return Array.isArray(meta == null ? void 0 : meta.scenes) ? [...meta.scenes] : [];
+}
+__name(getRunJSScenesForModel, "getRunJSScenesForModel");
+function getRunJSScenesForContext(ctx, { version = "v1" } = {}) {
+  const modelClass = (0, import_registry.getModelClassName)(ctx);
+  return getRunJSScenesForModel(modelClass, version);
+}
+__name(getRunJSScenesForContext, "getRunJSScenesForContext");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createJSRunnerWithVersion,
+  getRunJSDocFor,
+  getRunJSScenesForContext,
+  getRunJSScenesForModel
+});

package/lib/runjs-context/registry.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 type RunJSVersion = 'v1' | (string & {});
+export type RunJSContextCtor = new (delegate: any) => any;
+export type RunJSContextMeta = {
+    scenes?: string[];
+};
+export declare class RunJSContextRegistry {
+    private static map;
+    static register(version: RunJSVersion, modelClass: string, ctor: RunJSContextCtor, meta?: RunJSContextMeta): void;
+    static resolve(version: RunJSVersion, modelClass: string): RunJSContextCtor;
+    static getMeta(version: RunJSVersion, modelClass: string): RunJSContextMeta | undefined;
+}
+export declare function getModelClassName(ctx: any): string;

package/lib/runjs-context/registry.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 __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+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 __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+var registry_exports = {};
+__export(registry_exports, {
+  RunJSContextRegistry: () => RunJSContextRegistry,
+  getModelClassName: () => getModelClassName
+});
+module.exports = __toCommonJS(registry_exports);
+const _RunJSContextRegistry = class _RunJSContextRegistry {
+  static register(version, modelClass, ctor, meta) {
+    this.map.set(`${version}:${modelClass}`, { ctor, meta });
+  }
+  static resolve(version, modelClass) {
+    var _a, _b;
+    return ((_a = this.map.get(`${version}:${modelClass}`)) == null ? void 0 : _a.ctor) || ((_b = this.map.get(`${version}:*`)) == null ? void 0 : _b.ctor);
+  }
+  static getMeta(version, modelClass) {
+    var _a, _b;
+    return ((_a = this.map.get(`${version}:${modelClass}`)) == null ? void 0 : _a.meta) || ((_b = this.map.get(`${version}:*`)) == null ? void 0 : _b.meta);
+  }
+};
+__name(_RunJSContextRegistry, "RunJSContextRegistry");
+__publicField(_RunJSContextRegistry, "map", /* @__PURE__ */ new Map());
+let RunJSContextRegistry = _RunJSContextRegistry;
+function getModelClassName(ctx) {
+  var _a, _b;
+  return ((_b = (_a = ctx == null ? void 0 : ctx.model) == null ? void 0 : _a.constructor) == null ? void 0 : _b.name) || "*";
+}
+__name(getModelClassName, "getModelClassName");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  RunJSContextRegistry,
+  getModelClassName
+});

package/lib/runjs-context/setup.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 function setupRunJSContexts(): Promise<void>;