@nocobase/flow-engine 2.0.0-alpha.4 → 2.0.0-alpha.41

package/src/runjs-context/snippets/scene/detail/status-tag.snippet.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSFieldRunJSContext } from '../../../contexts/JSFieldRunJSContext';
+import { FormJSFieldItemRunJSContext } from '../../../contexts/FormJSFieldItemRunJSContext';
+import { JSColumnRunJSContext } from '../../../contexts/JSColumnRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSFieldRunJSContext, FormJSFieldItemRunJSContext, JSColumnRunJSContext],
+  scenes: ['detail', 'table'],
+  prefix: 'sn-jsf-status-tag',
+  label: 'Display status field as colored tag',
+  description: 'Display status values using colored tags',
+  locales: {
+    'zh-CN': {
+      label: '将状态字段显示为彩色标签',
+      description: '根据状态值显示不同颜色的标签',
+    },
+  },
+  content: `
+const statusColors = {
+  active: 'green',
+  pending: 'orange',
+  inactive: 'gray',
+  error: 'red',
+  success: 'blue',
+};
+
+const status = String(ctx.value || 'unknown');
+const color = statusColors[status] || 'default';
+
+ctx.element.innerHTML = \`
+  <span style="
+    display: inline-block;
+    padding: 2px 8px;
+    border-radius: 4px;
+    font-size: 12px;
+    background-color: var(--\${color}-1, #f0f0f0);
+    color: var(--\${color}-6, #333);
+    border: 1px solid var(--\${color}-3, #d9d9d9);
+  ">
+    \${ctx.t(status)}
+  </span>
+\`;
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/form/calculate-total.snippet.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
+  prefix: 'sn-link-calc',
+  label: 'Calculate total price (quantity × price)',
+  description: 'Automatically calculate total when quantity or unit price changes',
+  locales: {
+    'zh-CN': {
+      label: '计算总价（数量 × 单价）',
+      description: '当数量或单价变化时自动计算总价',
+    },
+  },
+  content: `
+// Get quantity and unit price from current record
+const quantity = Number(ctx.record?.quantity) || 0;
+const unitPrice = Number(ctx.record?.unitPrice) || 0;
+const total = quantity * unitPrice;
+
+// Find and update the 'totalPrice' field
+const items = ctx.model?.subModels?.grid?.subModels?.items;
+const candidates = Array.isArray(items) ? items : Array.from(items?.values?.() || items || []);
+
+const totalField = candidates.find((item) => item?.props?.name === 'totalPrice');
+
+if (totalField) {
+  totalField.setProps({ value: total.toFixed(2) });
+} else {
+  console.warn('[Form snippet] totalPrice field not found');
+}
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/form/cascade-select.snippet.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
+  prefix: 'sn-link-cascade',
+  label: 'Cascade select (load child roles)',
+  description: 'Load child roles based on the selected parent role',
+  locales: {
+    'zh-CN': {
+      label: '级联选择（加载子角色）',
+      description: '根据选择的父角色加载对应子角色',
+    },
+  },
+  content: `
+// Get selected parent role (adjust field name to match your form)
+const parentRoleId = ctx.record?.parentRole?.id;
+
+if (!parentRoleId) {
+  return;
+}
+
+const res = await ctx.api.request({
+  url: 'roles:list',
+  method: 'get',
+  params: {
+    pageSize: 100,
+    filter: {
+      parentId: parentRoleId,
+    },
+  },
+});
+
+const childRoles = res?.data?.data || [];
+
+const items = ctx.model?.subModels?.grid?.subModels?.items;
+const candidates = Array.isArray(items) ? items : Array.from(items?.values?.() || items || []);
+
+const roleField = candidates.find((item) => item?.props?.name === 'role');
+
+if (roleField) {
+  roleField.setProps({
+    dataSource: childRoles.map((role) => ({
+      value: role.id,
+      label: role.name,
+    })),
+    value: undefined,
+  });
+}
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/form/conditional-required.snippet.ts

@@ -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.
+ */
+
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
+  prefix: 'sn-link-require',
+  label: 'Conditional required field',
+  description: "Make a field required based on another field's value",
+  locales: {
+    'zh-CN': {
+      label: '条件必填',
+      description: '根据另一个字段的值动态设置必填状态',
+    },
+  },
+  content: `
+// When 'needsApproval' is true, make 'approver' field required
+const needsApproval = ctx.record?.needsApproval;
+
+const items = ctx.model?.subModels?.grid?.subModels?.items;
+const candidates = Array.isArray(items) ? items : Array.from(items?.values?.() || items || []);
+
+const approverField = candidates.find((item) => item?.props?.name === 'approver');
+
+if (approverField) {
+  approverField.setProps({
+    required: !!needsApproval,
+    // Also toggle visibility if needed
+    // display: needsApproval ? 'visible' : 'hidden',
+  });
+} else {
+  console.warn('[Form snippet] approver field not found');
+}
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/form/copy-field-values.snippet.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
+  prefix: 'sn-link-copy',
+  label: 'Copy value from another field',
+  description: 'Copy value from one field to another when checkbox is checked',
+  locales: {
+    'zh-CN': {
+      label: '复制字段值',
+      description: '勾选复选框时，将一个字段的值复制到另一个字段',
+    },
+  },
+  content: `
+// When 'sameAsAbove' is checked, copy billing address to shipping address
+const sameAsAbove = ctx.record?.sameAsAbove;
+
+if (!sameAsAbove) {
+  return;
+}
+
+const items = ctx.model?.subModels?.grid?.subModels?.items;
+const candidates = Array.isArray(items) ? items : Array.from(items?.values?.() || items || []);
+
+// Source and target field mappings
+const fieldMappings = [
+  { from: 'billingAddress', to: 'shippingAddress' },
+  { from: 'billingCity', to: 'shippingCity' },
+  { from: 'billingZipCode', to: 'shippingZipCode' },
+];
+
+fieldMappings.forEach(({ from, to }) => {
+  const sourceValue = ctx.record?.[from];
+  const targetField = candidates.find((item) => item?.props?.name === to);
+
+  if (targetField) {
+    targetField.setProps({ value: sourceValue });
+  }
+});
+
+ctx.message?.success?.(ctx.t('Address copied successfully'));
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/{jsitem → form}/render-basic.snippet.ts

@@ -7,10 +7,20 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['JSItemRunJSContext'],
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
   prefix: 'sn-jsitem-basic',
   label: 'Render form item',
+  description: 'Render custom content inside a form item container',
+  locales: {
+    'zh-CN': {
+      label: '渲染表单项',
+      description: '在表单项容器中渲染自定义内容',
+    },
+  },
   content:
     `
 ctx.element.innerHTML = ` +
@@ -25,3 +35,5 @@ ctx.element.innerHTML = ` +
     `;
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/{linkage → form}/set-disabled.snippet.ts

@@ -7,16 +7,26 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['*'],
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
   prefix: 'sn-link-disable',
   label: 'Set disabled',
+  description: 'Enable or disable another field in linkage scripts',
+  locales: {
+    'zh-CN': {
+      label: '设置禁用',
+      description: '在联动脚本中启用或禁用字段',
+    },
+  },
   content: `
 const targetFieldUid = 'FIELD_UID_OR_NAME';
 const disabled = true;
 
 const items = ctx.model?.subModels?.grid?.subModels?.items;
-const candidates: any[] = Array.isArray(items)
+const candidates = Array.isArray(items)
   ? items
   : Array.from(items?.values?.() || items || []);
 const fieldModel =
@@ -36,3 +46,5 @@ ctx.message?.success?.(
 );
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/{linkage → form}/set-field-value.snippet.ts

@@ -7,17 +7,27 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['*'],
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
   prefix: 'sn-link-set',
   label: 'Set field value',
+  description: 'Programmatically update another field in linkage scripts',
+  locales: {
+    'zh-CN': {
+      label: '设置字段值',
+      description: '在联动脚本中为其他字段设置值',
+    },
+  },
   content: `
 // Update another field in the same form/block
 const targetFieldUid = 'FIELD_UID_OR_NAME';
 const nextValue = ctx.record?.status ?? ctx.t('Updated value');
 
 const items = ctx.model?.subModels?.grid?.subModels?.items;
-const candidates: any[] = Array.isArray(items)
+const candidates = Array.isArray(items)
   ? items
   : Array.from(items?.values?.() || items || []);
 const fieldModel =
@@ -35,3 +45,5 @@ ctx.message?.success?.(
 );
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/{linkage → form}/set-required.snippet.ts

@@ -7,16 +7,26 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['*'],
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
   prefix: 'sn-link-required',
   label: 'Set required',
+  description: 'Toggle required rule for another field within linkage',
+  locales: {
+    'zh-CN': {
+      label: '设置必填',
+      description: '在联动脚本中控制字段是否必填',
+    },
+  },
   content: `
 const targetFieldUid = 'FIELD_UID_OR_NAME';
 const required = true;
 
 const items = ctx.model?.subModels?.grid?.subModels?.items;
-const candidates: any[] = Array.isArray(items)
+const candidates = Array.isArray(items)
   ? items
   : Array.from(items?.values?.() || items || []);
 const fieldModel =
@@ -36,3 +46,5 @@ ctx.message?.success?.(
 );
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/form/toggle-multiple-fields.snippet.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
+  prefix: 'sn-link-show-hide',
+  label: 'Show/hide fields based on condition',
+  description: 'Toggle multiple fields visibility based on a condition',
+  locales: {
+    'zh-CN': {
+      label: '条件显示/隐藏字段',
+      description: '根据条件批量显示或隐藏多个字段',
+    },
+  },
+  content: `
+// Show payment fields only when paymentMethod is 'online'
+const paymentMethod = ctx.record?.paymentMethod;
+const showPaymentFields = paymentMethod === 'online';
+
+const items = ctx.model?.subModels?.grid?.subModels?.items;
+const candidates = Array.isArray(items) ? items : Array.from(items?.values?.() || items || []);
+
+// Fields to toggle
+const fieldNames = ['creditCard', 'expiryDate', 'cvv'];
+
+fieldNames.forEach((fieldName) => {
+  const field = candidates.find((item) => item?.props?.name === fieldName);
+  if (field) {
+    field.setProps({
+      display: showPaymentFields ? 'visible' : 'hidden',
+      // Also clear values when hiding
+      value: showPaymentFields ? field.props.value : undefined,
+    });
+  }
+});
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/{linkage → form}/toggle-visible.snippet.ts

@@ -7,16 +7,26 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['*'],
+import type { SnippetModule } from '../../types';
+import { JSItemRunJSContext } from '../../../contexts/JSItemRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSItemRunJSContext],
   prefix: 'sn-link-visibility',
   label: 'Toggle visible',
+  description: 'Show or hide another field within linkage scripts',
+  locales: {
+    'zh-CN': {
+      label: '切换可见性',
+      description: '在联动脚本中设置字段显示或隐藏',
+    },
+  },
   content: `
 const targetFieldUid = 'FIELD_UID_OR_NAME';
 const shouldHide = true;
 
 const items = ctx.model?.subModels?.grid?.subModels?.items;
-const candidates: any[] = Array.isArray(items)
+const candidates = Array.isArray(items)
   ? items
   : Array.from(items?.values?.() || items || []);
 const fieldModel =
@@ -36,3 +46,5 @@ ctx.message?.success?.(
 );
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/table/cell-open-dialog.snippet.ts

@@ -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.
+ */
+
+import type { SnippetModule } from '../../types';
+import { JSColumnRunJSContext } from '../../../contexts/JSColumnRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSColumnRunJSContext],
+  prefix: 'sn-col-open-dialog',
+  label: 'Cell dialog with row data',
+  description: 'Render a button in cell to open dialog via ctx.openView with current row context',
+  locales: {
+    'zh-CN': {
+      label: '单元格对话框（显示行数据）',
+      description: '在单元格渲染按钮，点击后通过 ctx.openView 打开弹窗并传入当前行上下文',
+    },
+  },
+  content: `
+// Render a button inside the cell
+ctx.element.innerHTML = '<button class="nb-cell-btn" style="padding:4px 8px">' + ctx.t('View') + '</button>';
+
+const button = ctx.element.querySelector('.nb-cell-btn');
+const popupUid = ctx.model.uid + '-1'; // popupUid should be stable and better bound to ctx.model.uid
+const primaryKey = ctx.collection?.primaryKey || 'id';
+
+button?.addEventListener('click', async () => {
+  await ctx.openView(popupUid, {
+    mode: 'dialog',
+    title: ctx.t('Row detail'),
+    params: {
+      filterByTk: ctx.record?.[primaryKey],
+      record: ctx.record,
+    },
+  });
+});
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/{actions → table}/collection-selected-count.snippet.ts

@@ -7,10 +7,20 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-export default {
-  contexts: ['JSCollectionActionRunJSContext'],
+import type { SnippetModule } from '../../types';
+import { JSCollectionActionRunJSContext } from '../../../contexts/JSCollectionActionRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSCollectionActionRunJSContext],
   prefix: 'sn-act-selected-count',
   label: 'Selected count',
+  description: 'Show number of selected rows in list action',
+  locales: {
+    'zh-CN': {
+      label: '选中数量',
+      description: '提示当前选中行的数量',
+    },
+  },
   content: `
 const rows = ctx.resource?.getSelectedRows?.() || [];
 if (!rows.length) {
@@ -20,3 +30,5 @@ if (!rows.length) {
 }
 `,
 };
+
+export default snippet;

package/src/runjs-context/snippets/scene/table/concat-fields.snippet.ts

@@ -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.
+ */
+
+import type { SnippetModule } from '../../types';
+import { JSColumnRunJSContext } from '../../../contexts/JSColumnRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSColumnRunJSContext],
+  prefix: 'sn-col-concat',
+  label: 'Concat two fields',
+  description: 'Combine two field values into the current column cell',
+  locales: {
+    'zh-CN': {
+      label: '拼接两个字段值',
+      description: '在自定义列中拼接两个字段的值作为显示内容',
+    },
+  },
+  content: `
+// Demo helper: infer previous columns' dataIndex values based on the current column position
+// In production, hardcode field names to avoid surprises when columns are reordered
+function resolvePreviousDataIndexes() {
+  const parent = ctx.model?.parent;
+  const list = parent?.subModels?.columns;
+  if (!Array.isArray(list)) return [];
+  const currentUid = ctx.model?.uid;
+  const currentIndex = list.findIndex((item) => item?.uid === currentUid);
+  if (currentIndex <= 0) return [];
+  return list
+    .slice(Math.max(0, currentIndex - 2), currentIndex)
+    .map((item) => (item && item.props ? item.props.dataIndex : undefined))
+    .filter((key) => typeof key === 'string' && key.length > 0);
+}
+
+const [autoFieldA, autoFieldB] = resolvePreviousDataIndexes();
+
+// Fallback: manually specify field keys when auto detection is not enough
+const fieldA = autoFieldA || 'firstName';
+const fieldB = autoFieldB || 'lastName';
+
+const normalize = (value) => {
+  if (value === undefined || value === null) return '';
+  return String(value).trim();
+};
+
+const valueA = normalize(ctx.record?.[fieldA]);
+const valueB = normalize(ctx.record?.[fieldB]);
+
+const parts = [valueA, valueB].filter((item) => item.length > 0);
+
+ctx.element.textContent = parts.length ? parts.join(' / ') : ctx.t('N/A');
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/scene/table/destroy-selected.snippet.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+import { JSCollectionActionRunJSContext } from '../../../contexts/JSCollectionActionRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSCollectionActionRunJSContext],
+  prefix: 'sn-act-destroy-selected',
+  label: 'Destroy selected rows',
+  description: 'Delete selected rows via resource.destroySelectedRows()',
+  locales: {
+    'zh-CN': {
+      label: '删除选中行',
+      description: '通过 resource.destroySelectedRows() 删除选中行',
+    },
+  },
+  content: `
+const rows = ctx.resource?.getSelectedRows?.() || [];
+if (!rows.length) {
+  ctx.message.warning(ctx.t('Please select data'));
+  return;
+}
+
+await ctx.resource.destroySelectedRows();
+ctx.message.success(ctx.t('Deleted {{count}} rows', { count: rows.length }));
+`,
+};
+
+export default snippet;