@nocobase/flow-engine 2.0.0-beta.9 → 2.0.0

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

@@ -42,7 +42,12 @@ FormJSFieldItemRunJSContext.define({
       Supports innerHTML, append, and other DOM manipulation methods.`,
     value: `Current field value (read-only in display mode; in controlled scenarios, use setProps to modify).`,
     record: `Current record data object (read-only).
-      Contains all field values of the parent record.`
+      Contains all field values of the parent record.`,
+    formValues: {
+      description: "Snapshot of current form values (object). Available in form contexts (CreateForm/EditForm).",
+      detail: "Record<string, any>",
+      examples: ["const { name, status } = ctx.formValues || {};"]
+    }
   },
   methods: {
     onRefReady: `Wait for form field container DOM element to be ready before executing callback.
@@ -58,7 +63,12 @@ FormJSFieldItemRunJSContext.define(
     properties: {
       element: "ElementProxy\uFF0C\u8868\u5355\u5B57\u6BB5\u5BB9\u5668",
       value: "\u5B57\u6BB5\u503C\uFF08\u5C55\u793A\u6A21\u5F0F\u4E3A\u53EA\u8BFB\uFF1B\u53D7\u63A7\u573A\u666F\u7528 setProps \u4FEE\u6539\uFF09",
-      record: "\u5F53\u524D\u8BB0\u5F55\uFF08\u53EA\u8BFB\uFF09"
+      record: "\u5F53\u524D\u8BB0\u5F55\uFF08\u53EA\u8BFB\uFF09",
+      formValues: {
+        description: "\u5F53\u524D\u8868\u5355\u503C\u5FEB\u7167\uFF08\u5BF9\u8C61\uFF09\u3002\u4EC5\u8868\u5355\u76F8\u5173\u4E0A\u4E0B\u6587\u53EF\u7528\uFF08Create/Edit Form\uFF09\u3002",
+        detail: "Record<string, any>",
+        examples: ["const { name, status } = ctx.formValues || {};"]
+      }
     },
     methods: {
       onRefReady: "\u5BB9\u5668\u5C31\u7EEA\u56DE\u8C03",

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

@@ -58,7 +58,7 @@ JSBlockRunJSContext.define({
       Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void
       Example: ctx.onRefReady(ctx.ref, (el) => { el.innerHTML = "Ready!" })`,
     requireAsync: "Load external library: `const lib = await ctx.requireAsync(url)`",
-    importAsync: "Dynamically import ESM module: `const mod = await ctx.importAsync(url)`"
+    importAsync: "Dynamically import an ESM module by URL: `const mod = await ctx.importAsync(url)`.\nNote: if the module has only a default export, ctx.importAsync returns that default value directly (no `.default`)."
   }
 });
 JSBlockRunJSContext.define(
@@ -80,7 +80,7 @@ JSBlockRunJSContext.define(
     methods: {
       onRefReady: "\u5BB9\u5668 ref \u5C31\u7EEA\u56DE\u8C03\uFF1A\n```js\nctx.onRefReady(ctx.ref, el => { /* ... */ })\n```",
       requireAsync: "\u52A0\u8F7D\u5916\u90E8\u5E93\uFF1A`const lib = await ctx.requireAsync(url)`",
-      importAsync: "\u6309 URL \u52A8\u6001\u5BFC\u5165 ESM \u6A21\u5757\uFF1A`const mod = await ctx.importAsync(url)`"
+      importAsync: "\u6309 URL \u52A8\u6001\u5BFC\u5165 ESM \u6A21\u5757\uFF1A`const mod = await ctx.importAsync(url)`\u3002\n\u6CE8\u610F\uFF1A\u5F53\u6A21\u5757\u53EA\u6709 default \u4E00\u4E2A\u5BFC\u51FA\u65F6\uFF0Cctx.importAsync \u4F1A\u76F4\u63A5\u8FD4\u56DE default \u503C\uFF08\u65E0\u9700\u518D\u5199 `.default`\uFF09\u3002"
     }
   },
   { locale: "zh-CN" }

package/lib/runjs-context/contexts/JSEditableFieldRunJSContext.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.
+ */
+import { FlowRunJSContext } from '../../flowContext';
+/**
+ * RunJS context for JSEditableFieldModel (form editable custom field).
+ * NOTE: Some APIs (e.g., getValue/setValue/element) are provided by the model's runtime handler.
+ * This doc is used for editor autocomplete and AI coding assistance.
+ */
+export declare class JSEditableFieldRunJSContext extends FlowRunJSContext {
+}

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

@@ -0,0 +1,125 @@
+/**
+ * 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 JSEditableFieldRunJSContext_exports = {};
+__export(JSEditableFieldRunJSContext_exports, {
+  JSEditableFieldRunJSContext: () => JSEditableFieldRunJSContext
+});
+module.exports = __toCommonJS(JSEditableFieldRunJSContext_exports);
+var import_flowContext = require("../../flowContext");
+const _JSEditableFieldRunJSContext = class _JSEditableFieldRunJSContext extends import_flowContext.FlowRunJSContext {
+};
+__name(_JSEditableFieldRunJSContext, "JSEditableFieldRunJSContext");
+let JSEditableFieldRunJSContext = _JSEditableFieldRunJSContext;
+JSEditableFieldRunJSContext.define({
+  label: "JSEditableField RunJS context",
+  properties: {
+    element: {
+      description: "ElementProxy instance providing a safe DOM container for field rendering. In editable mode this container is typically a <span> element.",
+      detail: "ElementProxy"
+    },
+    value: {
+      description: "Current field value (read-only snapshot). In editable scenarios, prefer ctx.getValue()/ctx.setValue(v) for two-way binding.",
+      detail: "any",
+      examples: ["const v = ctx.getValue?.() ?? ctx.value;", 'ctx.setValue?.("new value");']
+    },
+    record: {
+      description: "Current record data object (read-only). Available in forms that are bound to a record.",
+      detail: "Record<string, any>"
+    },
+    form: {
+      description: 'Ant Design Form instance for reading/writing other fields. Example: ctx.form.getFieldValue("name")',
+      detail: "FormInstance"
+    },
+    formValues: {
+      description: "Snapshot of current form values (object). Prefer ctx.form.getFieldsValue() when you need the latest values.",
+      detail: "Record<string, any>"
+    },
+    namePath: {
+      description: "Field namePath in the form (array). Useful for advanced Form operations.",
+      detail: "Array<string | number>"
+    },
+    disabled: "Whether the field is disabled (boolean).",
+    readOnly: "Whether the field is read-only (boolean)."
+  },
+  methods: {
+    getValue: {
+      description: "Get current field value (recommended for editable custom fields).",
+      detail: "() => any",
+      completion: { insertText: "ctx.getValue?.()" }
+    },
+    setValue: {
+      description: "Set current field value (two-way binding with the form).",
+      detail: "(value: any) => void",
+      completion: { insertText: "ctx.setValue?.(value)" },
+      examples: ["ctx.setValue?.(e.target.value);"]
+    }
+  }
+});
+JSEditableFieldRunJSContext.define(
+  {
+    label: "JS \u53EF\u7F16\u8F91\u5B57\u6BB5 RunJS \u4E0A\u4E0B\u6587",
+    properties: {
+      element: {
+        description: "ElementProxy\uFF0C\u5B57\u6BB5\u6E32\u67D3\u7684\u5B89\u5168\u5BB9\u5668\uFF08\u901A\u5E38\u4E3A <span> \u5BB9\u5668\uFF09\u3002",
+        detail: "ElementProxy"
+      },
+      value: {
+        description: "\u5B57\u6BB5\u5F53\u524D\u503C\uFF08\u53EA\u8BFB\u5FEB\u7167\uFF09\u3002\u53EF\u7F16\u8F91\u573A\u666F\u5EFA\u8BAE\u4F7F\u7528 ctx.getValue()/ctx.setValue(v) \u505A\u53CC\u5411\u7ED1\u5B9A\u3002",
+        detail: "any",
+        examples: ["const v = ctx.getValue?.() ?? ctx.value;", 'ctx.setValue?.("\u65B0\u503C");']
+      },
+      record: { description: "\u5F53\u524D\u8BB0\u5F55\u5BF9\u8C61\uFF08\u53EA\u8BFB\uFF1B\u8868\u5355\u7ED1\u5B9A\u8BB0\u5F55\u65F6\u53EF\u7528\uFF09\u3002", detail: "Record<string, any>" },
+      form: { description: "Ant Design Form \u5B9E\u4F8B\uFF0C\u53EF\u8BFB\u5199\u5176\u5B83\u5B57\u6BB5\u3002", detail: "FormInstance" },
+      formValues: {
+        description: "\u5F53\u524D\u8868\u5355\u503C\u5FEB\u7167\uFF08\u5BF9\u8C61\uFF09\u3002\u9700\u8981\u6700\u65B0\u503C\u53EF\u7528 ctx.form.getFieldsValue()\u3002",
+        detail: "Record<string, any>"
+      },
+      namePath: { description: "\u5B57\u6BB5\u5728\u8868\u5355\u4E2D\u7684 namePath\uFF08\u6570\u7EC4\uFF09\u3002", detail: "Array<string | number>" },
+      disabled: "\u662F\u5426\u7981\u7528\uFF08boolean\uFF09",
+      readOnly: "\u662F\u5426\u53EA\u8BFB\uFF08boolean\uFF09"
+    },
+    methods: {
+      getValue: {
+        description: "\u83B7\u53D6\u5B57\u6BB5\u5F53\u524D\u503C\uFF08\u53EF\u7F16\u8F91\u5B57\u6BB5\u63A8\u8350\u4F7F\u7528\uFF09\u3002",
+        detail: "() => any",
+        completion: { insertText: "ctx.getValue?.()" }
+      },
+      setValue: {
+        description: "\u8BBE\u7F6E\u5B57\u6BB5\u5F53\u524D\u503C\uFF08\u4E0E\u8868\u5355\u53CC\u5411\u7ED1\u5B9A\uFF09\u3002",
+        detail: "(value: any) => void",
+        completion: { insertText: "ctx.setValue?.(value)" },
+        examples: ["ctx.setValue?.(e.target.value);"]
+      }
+    }
+  },
+  { locale: "zh-CN" }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  JSEditableFieldRunJSContext
+});

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

@@ -43,7 +43,12 @@ JSItemRunJSContext.define({
     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.`
+      Contains all field values of the parent record.`,
+    formValues: {
+      description: "Snapshot of current form values (object). Available in form contexts (CreateForm/EditForm).",
+      detail: "Record<string, any>",
+      examples: ["const { name, status } = ctx.formValues || {};"]
+    }
   },
   methods: {
     onRefReady: `Wait for form item container DOM element to be ready before executing callback.
@@ -56,7 +61,12 @@ JSItemRunJSContext.define(
     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"
+      record: "\u5F53\u524D\u8BB0\u5F55\uFF08\u53EA\u8BFB\uFF09",
+      formValues: {
+        description: "\u5F53\u524D\u8868\u5355\u503C\u5FEB\u7167\uFF08\u5BF9\u8C61\uFF09\u3002\u4EC5\u8868\u5355\u76F8\u5173\u4E0A\u4E0B\u6587\u53EF\u7528\uFF08Create/Edit Form\uFF09\u3002",
+        detail: "Record<string, any>",
+        examples: ["const { name, status } = ctx.formValues || {};"]
+      }
     },
     methods: {
       onRefReady: "\u5BB9\u5668\u5C31\u7EEA\u540E\u6267\u884C\u56DE\u8C03\u3002\u53C2\u6570\uFF1A(ref, callback, timeout?)"