@nocobase/client-v2 2.1.0-beta.22 → 2.1.0-beta.24

package/src/flow/internal/utils/rebuildFieldSubModel.ts

@@ -0,0 +1,94 @@
+/**
+ * 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.
+ */
+
+/**
+ * 通用的字段子模型重建工具：
+ * - 保留原有 uid
+ * - 通过 FieldModel 入口 + fieldBinding.use 动态选择目标字段类
+ * - 支持同步父项模式（pattern）
+ * - 重建后触发 beforeRender（useCache: false）
+ */
+import { FieldModel } from '../../models/base/FieldModel';
+import { FlowEngine, FlowModel, StepParams } from '@nocobase/flow-engine';
+
+type FieldBindingParams = {
+  fieldBinding?: { use?: string };
+  fieldSettings?: { init?: unknown };
+};
+
+type FieldStepParams = Record<string, unknown> & FieldBindingParams;
+
+type FieldParentModel = FlowModel & {
+  subModels: FlowModel['subModels'] & {
+    field?: FieldModel;
+  };
+  getFieldSettingsInitParams?: () => unknown;
+};
+
+type RebuildOptions = {
+  parentModel: FieldParentModel;
+  targetUse: string;
+  defaultProps?: Record<string, unknown>;
+  pattern?: string;
+  fieldSettingsInit?: unknown;
+};
+
+export function getFieldBindingUse(fieldModel?: FieldModel): string | undefined {
+  const bindingUse = (fieldModel?.stepParams as FieldStepParams | undefined)?.fieldBinding?.use;
+  return typeof bindingUse === 'string' ? bindingUse : undefined;
+}
+
+export async function rebuildFieldSubModel({
+  parentModel,
+  targetUse,
+  defaultProps,
+  pattern,
+  fieldSettingsInit,
+}: RebuildOptions) {
+  const fieldModel = parentModel.subModels['field'];
+  const fieldUid = fieldModel?.uid;
+  const prevSubModels = fieldModel?.serialize?.()?.subModels;
+  // RecordPickerFieldModel 的子model提前创建会报错
+  for (const key in prevSubModels) {
+    const subModel = prevSubModels[key];
+    if (subModel.delegateToParent === false) {
+      delete prevSubModels[key];
+    }
+  }
+  const prevStepParams: FieldStepParams = (fieldModel?.stepParams as FieldStepParams) || {};
+  const nextFieldSettingsInit = fieldSettingsInit ?? parentModel.getFieldSettingsInitParams?.();
+
+  const nextStepParams: FieldStepParams = {
+    ...prevStepParams,
+    fieldBinding: { ...prevStepParams.fieldBinding, use: targetUse },
+    fieldSettings: {
+      init: nextFieldSettingsInit,
+    },
+  };
+
+  const engine: FlowEngine = parentModel.flowEngine;
+
+  if (fieldUid) {
+    fieldModel?.invalidateFlowCache('beforeRender', true);
+    engine.removeModelWithSubModels(fieldUid);
+  }
+
+  const subModel = parentModel.setSubModel('field', {
+    uid: fieldUid,
+    use: FieldModel,
+    props: { ...(defaultProps || {}), ...(pattern ? { pattern } : {}) },
+    stepParams: nextStepParams as StepParams,
+    // Preserve existing subModels (e.g. SubTable columns) so switching field component back and forth
+    // does not require a full page refresh to restore the UI.
+    subModels: prevSubModels,
+  });
+
+  await subModel.dispatchEvent('beforeRender', undefined, { useCache: false });
+  await parentModel.save();
+}

package/src/flow/internal/utils/saveStepParamsWithSubModels.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 const SAVE_STEP_PARAMS_WITH_SUB_MODELS_FLAG = '__saveStepParamsWithSubModels' as const;
+
+export function markSaveStepParamsWithSubModels(model: unknown) {
+  if (!model || (typeof model !== 'object' && typeof model !== 'function')) {
+    throw new Error('[saveStepParamsWithSubModels] model is not an object');
+  }
+  (model as any)[SAVE_STEP_PARAMS_WITH_SUB_MODELS_FLAG] = true;
+}
+
+export async function saveStepParamsWithSubModelsIfNeeded<T>(model: unknown, fallback: () => Promise<T>): Promise<T> {
+  if (!model || (typeof model !== 'object' && typeof model !== 'function')) {
+    throw new Error('[saveStepParamsWithSubModels] model is not an object');
+  }
+  const record = model as any;
+
+  const shouldSaveSubModels = record[SAVE_STEP_PARAMS_WITH_SUB_MODELS_FLAG] === true;
+  if (!shouldSaveSubModels) {
+    return await fallback();
+  }
+
+  if (typeof record.save !== 'function') {
+    throw new Error('[saveStepParamsWithSubModels] model.save is not a function');
+  }
+
+  try {
+    // full save (including subModels) to persist migrated field-level settings cleanup
+    return await record.save();
+  } finally {
+    delete record[SAVE_STEP_PARAMS_WITH_SUB_MODELS_FLAG];
+  }
+}

package/src/flow/internal/utils/titleFieldQuickSync.ts

@@ -0,0 +1,95 @@
+/**
+ * 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 { DataSourceManager } from '@nocobase/flow-engine';
+import type { CollectionFieldOptions } from '../../../flow-compat';
+import { DEFAULT_DATA_SOURCE_KEY } from '../../../flow-compat';
+
+type CollectionLike = {
+  name?: unknown;
+  dataSource?: unknown;
+  dataSourceKey?: unknown;
+  setOption?: (key: string, value: any) => any;
+};
+
+type ApiClientLike = {
+  request?: (options: {
+    url: string;
+    method?: string;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
+  }) => Promise<any>;
+};
+
+export function isTitleUsableField(
+  dm: DataSourceManager | undefined,
+  field: CollectionFieldOptions | undefined,
+): boolean {
+  const ifaceName = typeof field?.interface === 'string' ? field.interface : undefined;
+  if (!dm || !ifaceName) return false;
+  return !!dm.collectionFieldInterfaceManager.getFieldInterface(ifaceName)?.titleUsable;
+}
+
+function resolveDataSourceKey(targetCollection: CollectionLike | null | undefined): string {
+  const raw = targetCollection?.dataSourceKey ?? targetCollection?.dataSource;
+  if (typeof raw === 'string' && raw) return raw;
+  return DEFAULT_DATA_SOURCE_KEY;
+}
+
+function resolveCollectionName(targetCollection: CollectionLike | null | undefined): string {
+  const name = targetCollection?.name;
+  if (typeof name === 'string' && name) return name;
+  throw new Error('Target collection name is required for syncing title field.');
+}
+
+function resolveUpdateUrl(dataSourceKey: string): string {
+  if (!dataSourceKey || dataSourceKey === DEFAULT_DATA_SOURCE_KEY) {
+    return 'collections:update';
+  }
+  return `dataSources/${dataSourceKey}/collections:update`;
+}
+
+export async function syncCollectionTitleField(options: {
+  api: ApiClientLike;
+  dataSourceManager?: DataSourceManager;
+  targetCollection: CollectionLike | null | undefined;
+  titleField: string;
+}) {
+  const { api, dataSourceManager, targetCollection, titleField } = options;
+
+  if (typeof api?.request !== 'function') {
+    throw new Error('API client is unavailable.');
+  }
+  if (typeof titleField !== 'string' || !titleField) {
+    throw new Error('Title field is required.');
+  }
+
+  const collectionName = resolveCollectionName(targetCollection);
+  const dataSourceKey = resolveDataSourceKey(targetCollection);
+
+  await api.request({
+    url: resolveUpdateUrl(dataSourceKey),
+    method: 'post',
+    params: { filterByTk: collectionName },
+    data: { titleField },
+  });
+
+  targetCollection?.setOption?.('titleField', titleField);
+
+  const dataSource = dataSourceManager?.getDataSource?.(dataSourceKey);
+  if (dataSource && typeof dataSource.reload === 'function') {
+    await dataSource.reload();
+  }
+
+  return {
+    dataSourceKey,
+    collectionName,
+    titleField,
+  };
+}

package/src/flow/models/actions/AddChildActionModel.tsx

@@ -0,0 +1,69 @@
+/**
+ * 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 { tExpr } from '@nocobase/flow-engine';
+import type { ButtonProps } from 'antd/es/button';
+import { RecordActionGroupModel, PopupActionModel } from '../base';
+
+export class AddChildActionModel extends PopupActionModel {
+  static capabilityActionName = null;
+
+  defaultProps: ButtonProps = {
+    type: 'link',
+    title: tExpr('Add child'),
+    icon: 'PlusOutlined',
+  };
+
+  getAclActionName() {
+    return 'create';
+  }
+  onInit(options: any): void {
+    super.onInit(options);
+    this.context.defineProperty('association', {
+      get: () => {
+        return this.context.blockModel.dataSource.getAssociation(`${this.context.blockModel.collection.name}.children`);
+      },
+    });
+  }
+}
+
+AddChildActionModel.registerFlow({
+  key: 'addChildSettingsInit',
+  steps: {
+    addChildInit: {
+      async handler(ctx, params) {
+        ctx.model.onClick = (e) => {
+          ctx.model.dispatchEvent(
+            'click',
+            {
+              event: e,
+              ...ctx.inputArgs,
+              sourceId: ctx.record.id,
+              filterByTk: null,
+            },
+            {
+              debounce: true,
+            },
+          );
+        };
+      },
+    },
+  },
+});
+
+AddChildActionModel.define({
+  label: tExpr('Add child'),
+  hide(ctx) {
+    return ctx.collection?.template !== 'tree' || ctx.blockModel.props.treeTable === false;
+  },
+});
+
+RecordActionGroupModel.registerActionModels({
+  AddChildActionModel,
+});

package/src/flow/models/actions/AddNewActionModel.tsx

@@ -0,0 +1,32 @@
+/**
+ * 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 { tExpr } from '@nocobase/flow-engine';
+import { ButtonProps } from 'antd';
+import { ActionSceneEnum, PopupActionModel } from '../base';
+
+export class AddNewActionModel extends PopupActionModel {
+  static scene = ActionSceneEnum.collection;
+
+  defaultPopupTitle = tExpr('Add new');
+  defaultProps: ButtonProps = {
+    type: 'primary',
+    title: tExpr('Add new'),
+    icon: 'PlusOutlined',
+  };
+
+  getAclActionName() {
+    return 'create';
+  }
+}
+
+AddNewActionModel.define({
+  label: tExpr('Add new'),
+  sort: 10,
+});

package/src/flow/models/actions/BulkDeleteActionModel.tsx

@@ -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.
+ */
+
+import { tExpr, MultiRecordResource } from '@nocobase/flow-engine';
+import { ButtonProps } from 'antd';
+import { ActionModel, ActionSceneEnum } from '../base';
+
+export class BulkDeleteActionModel extends ActionModel {
+  static scene = ActionSceneEnum.collection;
+  static capabilityActionName = 'destroyMany';
+
+  defaultProps: ButtonProps = {
+    title: tExpr('Delete'),
+    icon: 'DeleteOutlined',
+  };
+
+  getAclActionName() {
+    return 'destroy';
+  }
+}
+
+BulkDeleteActionModel.define({
+  label: tExpr('Delete'),
+});
+
+BulkDeleteActionModel.registerFlow({
+  key: 'deleteSettings',
+  title: tExpr('Delete settings'),
+  on: 'click',
+  steps: {
+    confirm: {
+      use: 'confirm',
+      defaultParams: {
+        enable: true,
+        title: tExpr('Delete record'),
+        content: tExpr('Are you sure you want to delete it?'),
+      },
+    },
+    delete: {
+      async handler(ctx, params) {
+        if (!ctx.blockModel?.resource) {
+          ctx.message.error(ctx.t('No resource selected for deletion'));
+          return;
+        }
+        const resource = ctx.blockModel.resource as MultiRecordResource;
+        if (resource.getSelectedRows().length === 0) {
+          ctx.message.warning(ctx.t('Please select at least one record to delete'));
+          return;
+        }
+        await resource.destroy(ctx.blockModel.collection.getFilterByTK(resource.getSelectedRows()));
+        ctx.message.success(ctx.t('Selected records deleted successfully'));
+      },
+    },
+  },
+});

package/src/flow/models/actions/DeleteActionModel.tsx

@@ -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.
+ */
+
+import { tExpr } from '@nocobase/flow-engine';
+import type { ButtonProps } from 'antd/es/button';
+import { ActionModel, ActionSceneEnum } from '../base';
+
+export class DeleteActionModel extends ActionModel {
+  static scene = ActionSceneEnum.record;
+
+  defaultProps: ButtonProps = {
+    type: 'link',
+    title: tExpr('Delete'),
+    icon: 'DeleteOutlined',
+  };
+
+  getAclActionName() {
+    return 'destroy';
+  }
+}
+
+DeleteActionModel.define({
+  label: tExpr('Delete'),
+  sort: 60,
+});
+
+DeleteActionModel.registerFlow({
+  key: 'deleteSettings',
+  title: tExpr('Delete settings'),
+  on: 'click',
+  steps: {
+    confirm: {
+      use: 'confirm',
+      defaultParams: {
+        enable: true,
+        title: tExpr('Delete record'),
+        content: tExpr('Are you sure you want to delete it?'),
+      },
+    },
+    delete: {
+      async handler(ctx, params) {
+        if (!ctx.resource) {
+          ctx.message.error(ctx.t('No resource selected for deletion'));
+          return;
+        }
+        if (!ctx.record) {
+          ctx.message.error(ctx.t('No resource or record selected for deletion'));
+          return;
+        }
+        await ctx.resource.destroy(ctx.blockModel.collection.getFilterByTK(ctx.record));
+        ctx.message.success(ctx.t('Record deleted successfully'));
+      },
+    },
+  },
+});

package/src/flow/models/actions/EditActionModel.tsx

@@ -0,0 +1,31 @@
+/**
+ * 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 { tExpr } from '@nocobase/flow-engine';
+import type { ButtonProps } from 'antd/es/button';
+import { ActionSceneEnum, PopupActionModel } from '../base';
+
+export class EditActionModel extends PopupActionModel {
+  static scene = ActionSceneEnum.record;
+
+  defaultPopupTitle = tExpr('Edit');
+  defaultProps: ButtonProps = {
+    title: tExpr('Edit'),
+    icon: 'EditOutlined',
+  };
+
+  getAclActionName() {
+    return 'update';
+  }
+}
+
+EditActionModel.define({
+  label: tExpr('Edit'),
+  sort: 20,
+});

package/src/flow/models/actions/ExpandCollapseActionModel.tsx

@@ -0,0 +1,113 @@
+/**
+ * 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 { escapeT, MultiRecordResource } from '@nocobase/flow-engine';
+import { ActionModel, ActionSceneEnum } from '../base';
+import { ButtonProps } from 'antd';
+
+export class ExpandCollapseActionModel extends ActionModel {
+  expandFlag: boolean;
+
+  defaultProps: ButtonProps = {
+    type: 'default',
+    icon: 'DownOutlined',
+  };
+
+  static scene = ActionSceneEnum.collection;
+
+  setTitle(title) {
+    this.setProps({ title });
+  }
+
+  setExpandFlag(flag) {
+    this.expandFlag = flag;
+  }
+
+  getTitle() {
+    return this.expandFlag ? this.context.t('Collapse all') : this.context.t('Expand all');
+  }
+  getIcon() {
+    return this.expandFlag ? 'NodeCollapseOutlined' : 'NodeExpandOutlined';
+  }
+}
+
+function getIdsWithChildren(data, { idKey = 'id', childrenKey = 'children' } = {}) {
+  const ids = [];
+
+  function traverse(nodes) {
+    if (!Array.isArray(nodes)) return;
+
+    for (const node of nodes) {
+      const children = node[childrenKey];
+      ids.push(node[idKey]); // 当前节点有子节点，记录它
+      if (Array.isArray(children) && children.length > 0) {
+        traverse(children); // 递归处理子节点
+      }
+    }
+  }
+
+  traverse(data);
+  return ids;
+}
+
+const allIncludesChildren = (data) => {
+  const keys = getIdsWithChildren(data);
+  return keys;
+};
+ExpandCollapseActionModel.registerFlow({
+  key: 'expandCollapseSettingsInit',
+  sort: 200,
+  steps: {
+    init: {
+      handler(ctx, params) {
+        if (ctx.blockModel.props.defaultExpandAllRows) {
+          ctx.model.setExpandFlag(true);
+        } else {
+          ctx.model.setExpandFlag(false);
+        }
+      },
+    },
+  },
+});
+ExpandCollapseActionModel.registerFlow({
+  key: 'expandCollapseSettings',
+  on: 'click',
+  steps: {
+    expandCollapse: {
+      async handler(ctx, params) {
+        if (!ctx.blockModel?.resource) {
+          return;
+        }
+        const resource = ctx.blockModel.resource as MultiRecordResource;
+        const { treeTable } = ctx.blockModel.props;
+        if (treeTable) {
+          if (!ctx.model.expandFlag) {
+            const ids = allIncludesChildren(resource.getData());
+            ctx.blockModel.setProps({
+              expandedRowKeys: ids,
+            });
+            ctx.model.setExpandFlag(true);
+          } else {
+            ctx.blockModel.setProps({
+              expandedRowKeys: [],
+            });
+            ctx.model.setExpandFlag(false);
+          }
+        }
+      },
+    },
+  },
+});
+
+ExpandCollapseActionModel.define({
+  label: escapeT('Expand/Collapse'),
+  hide(ctx) {
+    return ctx.collection?.template !== 'tree' || ctx.model.props.treeTable === false;
+  },
+});