@nocobase/flow-engine 2.0.0-alpha.3 → 2.0.0-alpha.30

package/src/resources/singleRecordResource.ts

@@ -43,6 +43,7 @@ export class SingleRecordResource<TData = any> extends BaseRecordResource<TData>
       ...config,
       data,
     });
+    this.emit('saved', data);
     if (options?.refresh !== false) {
       await this.refresh();
     }

package/src/resources/sqlResource.ts

@@ -11,6 +11,7 @@ import { observable } from '@formily/reactive';
 import _ from 'lodash';
 import { FlowContext, FlowEngineContext } from '../flowContext';
 import { BaseRecordResource } from './baseRecordResource';
+import { parseLiquidContext, transformSQL } from '@nocobase/utils/client';
 
 type SQLRunOptions = {
   bind?: Record<string, any>;
@@ -25,20 +26,6 @@ type SQLSaveOptions = {
   dataSourceKey?: string;
 };
 
-function transformSQL(template: string) {
-  let index = 1;
-  const bind = {};
-
-  const sql = template.replace(/{{\s*([^}]+)\s*}}/g, (_, expr) => {
-    const key = `__var${index}`;
-    bind[key] = `{{${expr.trim()}}}`;
-    index++;
-    return `$${key}`;
-  });
-
-  return { sql, bind };
-}
-
 export class FlowSQLRepository {
   protected ctx: FlowEngineContext;
 
@@ -56,16 +43,17 @@ export class FlowSQLRepository {
   }
 
   async run(sql: string, options: SQLRunOptions = {}) {
-    const result = transformSQL(sql);
-    const bind = await this.ctx.resolveJsonTemplate(result.bind);
+    const { sql: transformedSQL, bind, liquidContext } = await transformSQL(sql);
+    const resolved = await this.ctx.resolveJsonTemplate({ bind, liquidContext });
+    const parsedSQL = await parseLiquidContext(transformedSQL, resolved.liquidContext);
     const { data } = await this.ctx.api.request({
       method: 'POST',
       url: 'flowSql:run',
       data: {
-        sql: result.sql,
+        sql: parsedSQL,
         ...options,
         bind: {
-          ...bind,
+          ...resolved.bind,
           ...options.bind,
         },
       },
@@ -91,7 +79,7 @@ export class FlowSQLRepository {
         uid,
       },
     });
-    const bind = await this.ctx.resolveJsonTemplate(response.data.data || {});
+    const { bind, liquidContext } = await this.ctx.resolveJsonTemplate(response.data.data || {});
     const { data } = await this.ctx.api.request({
       method: 'POST',
       url: 'flowSql:runById',
@@ -100,8 +88,9 @@ export class FlowSQLRepository {
         ...options,
         bind: {
           ...bind,
-          ...options.bind,
+          ...options?.bind,
         },
+        liquidContext,
       },
     });
     return data?.data;
@@ -233,20 +222,25 @@ export class SQLResource<TData = any> extends BaseRecordResource<TData> {
     return this;
   }
 
+  setLiquidContext(liquidContext: Record<string, any>) {
+    this.request.data.liquidContext = liquidContext;
+    return this;
+  }
+
   async run() {
     return this._debugEnabled ? await this.runBySQL() : await this.runById();
   }
 
   async runBySQL() {
     const sql = this._sql;
-    const result = transformSQL(sql);
-    const bind = await this.context.resolveJsonTemplate(result.bind);
+    const { sql: transformedSQL, bind, liquidContext } = await transformSQL(sql);
+    const resolved = await this.context.resolveJsonTemplate({ bind, liquidContext });
     const options = _.cloneDeep({
       method: 'post',
       ...this.getRefreshRequestOptions(),
     });
-    options.data.bind = bind;
-    options.data.sql = result.sql;
+    options.data.sql = await parseLiquidContext(transformedSQL, resolved.liquidContext);
+    options.data.bind = resolved.bind;
     return await this.runAction<TData, any>('run', options);
   }
 
@@ -257,8 +251,9 @@ export class SQLResource<TData = any> extends BaseRecordResource<TData> {
         uid: this.request.data.uid,
       },
     });
-    const bind = await this.context.resolveJsonTemplate(data);
+    const { bind, liquidContext } = await this.context.resolveJsonTemplate(data);
     this.setBind(bind);
+    this.setLiquidContext(liquidContext);
     return await this.runAction<TData, any>('runById', {
       method: 'post',
       ...this.getRefreshRequestOptions(),

package/src/runjs-context/contexts/FormJSFieldItemRunJSContext.ts

@@ -7,33 +7,40 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
-import { createSafeDocument, createSafeWindow } from '../../utils';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class FormJSFieldItemRunJSContext extends FlowRunJSContext {
-  static injectDefaultGlobals() {
-    return { window: createSafeWindow(), document: createSafeDocument() };
-  }
-  constructor(delegate: any) {
-    super(delegate);
-    this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
-    this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
-    this.defineProperty('value', { get: () => (this as any)._delegate['value'] });
-  }
-}
+export class FormJSFieldItemRunJSContext extends FlowRunJSContext {}
 
 FormJSFieldItemRunJSContext.define({
   label: 'FormJSFieldItem RunJS context',
   properties: {
-    element: 'ElementProxy，表单字段容器',
-    value: '字段值（读/受控场景需通过 setProps 修改）',
-    record: '当前记录（只读）',
+    element: `ElementProxy instance providing a safe DOM container for form field rendering.
+      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.`,
   },
   methods: {
-    onRefReady: '容器就绪回调',
-    setProps: '设置表单项属性：`setProps(fieldModel, { value })`（由联动/表单上下文提供）',
-  },
-  snipastes: {
-    显示字段值: { $ref: 'scene/jsfield/innerHTML-value', prefix: 'sn-form-value' },
+    onRefReady: `Wait for form field container DOM element to be ready before executing callback.
+      Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void`,
+    setProps: `Set form field properties programmatically.
+      Parameters: (fieldModel: any, props: { value?: any, disabled?: boolean, visible?: boolean }) => void
+      Example: ctx.setProps(fieldModel, { value: "new value" })`,
   },
 });
+
+FormJSFieldItemRunJSContext.define(
+  {
+    label: '表单 JS 字段项 RunJS 上下文',
+    properties: {
+      element: 'ElementProxy，表单字段容器',
+      value: '字段值（展示模式为只读；受控场景用 setProps 修改）',
+      record: '当前记录（只读）',
+    },
+    methods: {
+      onRefReady: '容器就绪回调',
+      setProps: '设置表单项属性：`setProps(fieldModel, { value })`（由联动/表单上下文提供）',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSBlockRunJSContext.ts

@@ -7,46 +7,58 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
-import { createSafeDocument, createSafeWindow } from '../../utils';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class JSBlockRunJSContext extends FlowRunJSContext {
-  static injectDefaultGlobals() {
-    return { window: createSafeWindow(), document: createSafeDocument() };
-  }
-  constructor(delegate: any) {
-    super(delegate);
-    // 显式暴露本场景所需属性
-    this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
-    this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
-    this.defineProperty('value', { get: () => (this as any)._delegate['value'] });
-  }
-}
+export class JSBlockRunJSContext extends FlowRunJSContext {}
 
 JSBlockRunJSContext.define({
-  label: 'JSBlock RunJS context',
+  label: 'RunJS context',
   properties: {
-    element: 'ElementProxy，安全 DOM 容器。支持 innerHTML/append 等',
-    record: '当前记录（只读，存在于数据块/详情等场景）',
-    value: '当前值（若存在）',
-    React: 'React（已注入）',
-    antd: 'AntD（已注入）',
+    element: {
+      description: `ElementProxy instance providing a safe DOM container.
+      Supports innerHTML, append, and other DOM manipulation methods.
+      Use this to render content in the JS block.`,
+      detail: 'ElementProxy',
+      properties: {
+        innerHTML: 'Set or read the HTML content of the container element.',
+      },
+    },
+    record: `Current record data object (read-only).
+      Available when the JS block is within a data block or detail view context.`,
+    value: 'Current value of the field or component, if available in the current context.',
+    React: 'React library',
+    antd: 'Ant Design library',
   },
   methods: {
-    onRefReady: 'Container ref ready callback:\n```js\nctx.onRefReady(ctx.ref, el => { /* ... */ })\n```',
+    onRefReady: `Wait for 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 = "Ready!" })`,
     requireAsync: 'Load external library: `const lib = await ctx.requireAsync(url)`',
-  },
-  snipastes: {
-    'Render HTML': { $ref: 'scene/jsblock/render-basic', prefix: 'sn-jsb-html' },
-    'Render React': { $ref: 'scene/jsblock/render-react', prefix: 'sn-jsb-react' },
-    'Init ECharts': { $ref: 'libs/echarts-init', prefix: 'sn-echarts' },
-    'Render card': { $ref: 'scene/jsblock/render-card', prefix: 'sn-jsb-card' },
-    'Button handler': { $ref: 'scene/jsblock/render-button-handler', prefix: 'sn-jsb-button' },
-    'JSX mount': { $ref: 'scene/jsblock/jsx-mount', prefix: 'sn-jsx-mount' },
-    'JSX unmount': { $ref: 'scene/jsblock/jsx-unmount', prefix: 'sn-jsx-unmount' },
-    Notification: { $ref: 'global/notification-open', prefix: 'sn-notify' },
-    'Window open': { $ref: 'global/window-open', prefix: 'sn-window-open' },
-    'Add click listener': { $ref: 'scene/jsblock/add-event-listener', prefix: 'sn-jsb-click' },
-    'Append style': { $ref: 'scene/jsblock/append-style', prefix: 'sn-jsb-style' },
+    importAsync: 'Dynamically import ESM module: `const mod = await ctx.importAsync(url)`',
   },
 });
+
+JSBlockRunJSContext.define(
+  {
+    label: 'RunJS 上下文',
+    properties: {
+      element: {
+        description: 'ElementProxy，安全的 DOM 容器，支持 innerHTML/append 等',
+        detail: 'ElementProxy',
+        properties: {
+          innerHTML: '读取或设置容器的 HTML 内容',
+        },
+      },
+      record: '当前记录（只读，用于数据区块/详情等场景）',
+      value: '当前值（若存在）',
+      React: 'React 库',
+      antd: 'Ant Design 库',
+    },
+    methods: {
+      onRefReady: '容器 ref 就绪回调：\n```js\nctx.onRefReady(ctx.ref, el => { /* ... */ })\n```',
+      requireAsync: '加载外部库：`const lib = await ctx.requireAsync(url)`',
+      importAsync: '按 URL 动态导入 ESM 模块：`const mod = await ctx.importAsync(url)`',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSCollectionActionRunJSContext.ts

@@ -7,26 +7,25 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class JSCollectionActionRunJSContext extends FlowRunJSContext {
-  constructor(delegate: any) {
-    super(delegate);
-    this.defineProperty('resource', { get: () => (this as any)._delegate['resource'] });
-  }
-}
+export class JSCollectionActionRunJSContext extends FlowRunJSContext {}
 
 JSCollectionActionRunJSContext.define({
   label: 'JSCollectionAction RunJS context',
   properties: {
-    resource: '列表资源（选中行/分页等）',
-  },
-  methods: {
-    runAction: 'Run action',
-    message: 'Message API',
-  },
-  snipastes: {
-    'Selected count': { $ref: 'scene/actions/collection-selected-count', prefix: 'sn-act-selected-count' },
-    'Iterate selected rows': { $ref: 'scene/actions/iterate-selected-rows', prefix: 'sn-act-iterate' },
+    resource: `Collection resource instance providing access to selected rows, pagination, and data operations.
+      Use ctx.resource.selectedRows to get selected records.
+      Use ctx.resource.pagination for page info.`,
   },
 });
+
+JSCollectionActionRunJSContext.define(
+  {
+    label: 'JS 集合动作 RunJS 上下文',
+    properties: {
+      resource: '列表资源（包含选中行/分页信息等）',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSColumnRunJSContext.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 JSColumnModel (table custom column).
+ * Focused on per-row rendering with access to current record and cell element.
+ */
+export class JSColumnRunJSContext extends FlowRunJSContext {}
+
+JSColumnRunJSContext.define({
+  label: 'JSColumn RunJS context',
+  properties: {
+    element:
+      'ElementProxy instance providing a safe DOM container for the current table cell. Supports innerHTML/append and basic DOM APIs.',
+    record: 'Current row record object (read-only).',
+    recordIndex: 'Index of the current row in the page (0-based).',
+    collection: 'Collection definition metadata (read-only).',
+    viewer:
+      'View controller providing dialog/drawer/embed helpers for interactions initiated from the cell (e.g., open details).',
+    React: 'React library',
+    antd: 'Ant Design library',
+  },
+  methods: {
+    onRefReady:
+      'Wait for cell DOM element to be ready before executing callback. Parameters: (ref, callback, timeout?) => void',
+    requireAsync: 'Load external library by URL: `const lib = await ctx.requireAsync(url)`',
+    importAsync: 'Dynamically import ESM module by URL: `const mod = await ctx.importAsync(url)`',
+  },
+});
+
+JSColumnRunJSContext.define(
+  {
+    label: 'JS 列 RunJS 上下文',
+    properties: {
+      element: 'ElementProxy，表格单元格的安全 DOM 容器，支持 innerHTML/append 等',
+      record: '当前行记录对象（只读）',
+      recordIndex: '当前行索引（从 0 开始）',
+      collection: '集合定义元数据（只读）',
+      viewer: '视图控制器，可用于在单元格中触发抽屉/对话框/内嵌等交互',
+      React: 'React 库',
+      antd: 'Ant Design 库',
+    },
+    methods: {
+      onRefReady: '等待单元格 DOM 就绪后执行回调。参数：(ref, callback, timeout?)',
+      requireAsync: '按 URL 异步加载外部库：`const lib = await ctx.requireAsync(url)`',
+      importAsync: '按 URL 动态导入 ESM 模块：`const mod = await ctx.importAsync(url)`',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSFieldRunJSContext.ts

@@ -7,37 +7,42 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
-import { createSafeDocument, createSafeWindow } from '../../utils';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class JSFieldRunJSContext extends FlowRunJSContext {
-  static injectDefaultGlobals() {
-    return { window: createSafeWindow(), document: createSafeDocument() };
-  }
-  constructor(delegate: any) {
-    super(delegate);
-    this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
-    this.defineProperty('value', { get: () => (this as any)._delegate['value'] });
-    this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
-    this.defineProperty('collection', { get: () => (this as any)._delegate['collection'] });
-  }
-}
+export class JSFieldRunJSContext extends FlowRunJSContext {}
 
 JSFieldRunJSContext.define({
   label: 'JSField RunJS context',
   properties: {
-    element: 'ElementProxy，字段渲染容器',
-    value: '字段当前值（只读）',
-    record: '当前记录（只读）',
-    collection: '集合定义（只读）',
+    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: 'Container ready callback',
-  },
-  snipastes: {
-    'Render value': { $ref: 'scene/jsfield/innerHTML-value', prefix: 'sn-jsf-value' },
-    'Message success': { $ref: 'global/message-success', prefix: 'sn-msg-ok' },
-    'Format number': { $ref: 'scene/jsfield/format-number', prefix: 'sn-jsf-num' },
-    'Color by value': { $ref: 'scene/jsfield/color-by-value', prefix: 'sn-jsf-color' },
+    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 字段 RunJS 上下文',
+    properties: {
+      element: 'ElementProxy，字段渲染容器，支持 innerHTML/append 等 DOM 操作',
+      value: '字段当前值（只读）',
+      record: '当前记录对象（只读，包含父记录全部字段值）',
+      collection: '集合定义元数据（只读，描述字段所属集合的 Schema）',
+    },
+    methods: {
+      onRefReady:
+        '在字段容器 DOM 就绪后执行回调。参数：(ref, callback, timeout?)；示例：ctx.onRefReady(ctx.ref, el => { el.innerHTML = ctx.value })',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSItemRunJSContext.ts

@@ -7,33 +7,37 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
-import { createSafeDocument, createSafeWindow } from '../../utils';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class JSItemRunJSContext extends FlowRunJSContext {
-  static injectDefaultGlobals() {
-    return { window: createSafeWindow(), document: createSafeDocument() };
-  }
-  constructor(delegate: any) {
-    super(delegate);
-    this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
-    this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
-    this.defineProperty('resource', { get: () => (this as any)._delegate['resource'] });
-  }
-}
+export class JSItemRunJSContext extends FlowRunJSContext {}
 
 JSItemRunJSContext.define({
   label: 'JSItem RunJS context',
   properties: {
-    element: 'ElementProxy，表单项渲染容器',
-    resource: '当前资源（只读）',
-    record: '当前记录（只读）',
+    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: 'Container ready callback',
-    requireAsync: 'Load external library',
-  },
-  snipastes: {
-    'Render form item': { $ref: 'scene/jsitem/render-basic', prefix: 'sn-jsitem-basic' },
+    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 表单项 RunJS 上下文',
+    properties: {
+      element: 'ElementProxy，表单项渲染容器，支持 innerHTML/append 等 DOM 操作',
+      resource: '当前资源（只读）',
+      record: '当前记录（只读）',
+    },
+    methods: {
+      onRefReady: '容器就绪后执行回调。参数：(ref, callback, timeout?)',
+    },
+  },
+  { locale: 'zh-CN' },
+);

package/src/runjs-context/contexts/JSRecordActionRunJSContext.ts

@@ -7,28 +7,27 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowRunJSContext } from './FlowRunJSContext';
+import { FlowRunJSContext } from '../../flowContext';
 
-export class JSRecordActionRunJSContext extends FlowRunJSContext {
-  constructor(delegate: any) {
-    super(delegate);
-    this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
-    this.defineProperty('filterByTk', { get: () => (this as any)._delegate['filterByTk'] });
-  }
-}
+export class JSRecordActionRunJSContext extends FlowRunJSContext {}
 
 JSRecordActionRunJSContext.define({
   label: 'JSRecordAction RunJS context',
   properties: {
-    record: '当前记录（只读）',
-    filterByTk: '主键/过滤键（只读）',
-  },
-  methods: {
-    runAction: 'Run action: `await ctx.runAction(name, params)`',
-    message: 'Message API',
-  },
-  snipastes: {
-    'Show record id': { $ref: 'scene/actions/record-id-message', prefix: 'sn-act-record-id' },
-    'Run action': { $ref: 'scene/actions/run-action-basic', prefix: 'sn-act-run' },
+    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 记录动作 RunJS 上下文',
+    properties: {
+      record: '当前记录（只读）',
+      filterByTk: '主键/过滤键（只读）',
+    },
+  },
+  { locale: 'zh-CN' },
+);