@nocobase/flow-engine 2.0.0-alpha.10

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

@@ -0,0 +1,50 @@
+/**
+ * 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-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 = Array.isArray(items)
+  ? items
+  : Array.from(items?.values?.() || items || []);
+const fieldModel =
+  candidates.find((item) => item?.uid === targetFieldUid) ||
+  candidates.find((item) => item?.props?.name === targetFieldUid);
+
+if (!fieldModel) {
+  ctx.message?.warning?.(ctx.t('Field {{name}} not found', { name: targetFieldUid }));
+  return;
+}
+
+fieldModel.setProps({ required });
+ctx.message?.success?.(
+  ctx.t(required ? 'Set field {{name}} as required' : 'Field {{name}} is optional', {
+    name: fieldModel?.props?.label || targetFieldUid,
+  }),
+);
+`,
+};
+
+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/form/toggle-visible.snippet.ts

@@ -0,0 +1,50 @@
+/**
+ * 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-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 = Array.isArray(items)
+  ? items
+  : Array.from(items?.values?.() || items || []);
+const fieldModel =
+  candidates.find((item) => item?.uid === targetFieldUid) ||
+  candidates.find((item) => item?.props?.name === targetFieldUid);
+
+if (!fieldModel) {
+  ctx.message?.warning?.(ctx.t('Field {{name}} not found', { name: targetFieldUid }));
+  return;
+}
+
+fieldModel.setProps({ hiddenModel: shouldHide });
+ctx.message?.success?.(
+  ctx.t(shouldHide ? 'Hidden field {{name}}' : 'Shown field {{name}}', {
+    name: fieldModel?.props?.label || targetFieldUid,
+  }),
+);
+`,
+};
+
+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/table/collection-selected-count.snippet.ts

@@ -0,0 +1,34 @@
+/**
+ * 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-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) {
+  ctx.message.warning(ctx.t('Please select data'));
+} else {
+  ctx.message.success(ctx.t('Selected {{count}} rows', { count: 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;

package/src/runjs-context/snippets/scene/table/export-selected-json.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 { JSCollectionActionRunJSContext } from '../../../contexts/JSCollectionActionRunJSContext';
+
+const snippet: SnippetModule = {
+  contexts: [JSCollectionActionRunJSContext],
+  prefix: 'sn-act-export',
+  label: 'Export selected rows as JSON',
+  description: 'Download selected rows as a JSON file',
+  locales: {
+    'zh-CN': {
+      label: '导出选中行为 JSON',
+      description: '将选中的行导出为 JSON 文件下载',
+    },
+  },
+  content: `
+const rows = ctx.resource?.getSelectedRows?.() || [];
+if (!rows.length) {
+  ctx.message.warning(ctx.t('Please select at least one row'));
+  return;
+}
+
+// Create JSON file and download
+const jsonStr = JSON.stringify(rows, null, 2);
+const blob = new Blob([jsonStr], { type: 'application/json' });
+const url = URL.createObjectURL(blob);
+const link = document.createElement('a');
+link.href = url;
+link.download = \`export-\${new Date().toISOString().split('T')[0]}.json\`;
+link.click();
+URL.revokeObjectURL(url);
+
+ctx.message.success(ctx.t('Exported {{count}} records', { count: rows.length }));
+`,
+};
+
+export default snippet;

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

@@ -0,0 +1,33 @@
+/**
+ * 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-iterate',
+  label: 'Iterate selected rows',
+  description: 'Loop through selected rows and process each record',
+  locales: {
+    'zh-CN': {
+      label: '遍历选中行',
+      description: '遍历选中行并处理每条记录',
+    },
+  },
+  content: `
+const rows = ctx.resource?.getSelectedRows?.() || [];
+for (const row of rows) {
+  console.log(ctx.t('Selected row:'), row);
+}
+ctx.message.success(ctx.t('Processed {{count}} rows', { count: rows.length }));
+`,
+};
+
+export default snippet;

package/src/runjs-context/snippets/types.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 SnippetContextSpecifier = string | { name: string } | (new (...args: any[]) => any);
+
+export type SnippetModule = {
+  content: string;
+  contexts?: SnippetContextSpecifier[]; // e.g., [JSBlockRunJSContext] or ['*']
+  versions?: string[]; // e.g., ['v1'] or ['*']
+  scenes?: string[]; // logical placement hints like ['form', 'table']
+  prefix?: string; // completion trigger text
+  label?: string; // display name in snippets list
+  description?: string; // optional longer description
+  locales?: Record<string, { label?: string; description?: string }>;
+};