@nocobase/flow-engine/src/resources/singleRecordResource.ts

A standalone flow engine for NocoBase, managing workflows, models, and actions.

/**
 * 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 { AxiosRequestConfig } from 'axios';
import _ from 'lodash';
import { BaseRecordResource } from './baseRecordResource';

export class SingleRecordResource<TData = any> extends BaseRecordResource<TData> {
  isNewRecord = false;
  protected saveActionOptions = {};
  protected _refreshActionName = 'get';

  get supportsFilter() {
    return !this.isNewRecord;
  }

  setSaveActionOptions(options: AxiosRequestConfig) {
    this.saveActionOptions = options;
    return this;
  }

  setFilterByTk(filterByTk: any) {
    this.isNewRecord = false;
    return super.setFilterByTk(filterByTk);
  }

  async save(data: TData, options?: AxiosRequestConfig & { refresh?: boolean }): Promise<void> {
    const config = this.mergeRequestConfig(this.saveActionOptions, _.omit(options, ['refresh']));
    let actionName = 'create';
    // 如果有 filterByTk，则表示是更新操作
    if (!this.isNewRecord) {
      config.params = config.params || {};
      config.params.filterByTk = this.getFilterByTk();
      actionName = 'update';
    }
    await this.runAction(actionName, {
      ...config,
      data,
    });
    if (options?.refresh !== false) {
      await this.refresh();
    }
  }

  async destroy(options?: AxiosRequestConfig): Promise<void> {
    const config = this.mergeRequestConfig(
      {
        params: {
          filterByTk: this.request.params.filterByTk,
        },
      },
      options,
    );
    await this.runAction('destroy', config);
    this.setData(null);
  }

  async refresh(): Promise<void> {
    this.clearError();
    // 如果没有设置 filterByTk，则不执行刷新操作
    // 这是为了避免在没有指定记录的情况下进行不必要的 API 调用
    if (this.isNewRecord) {
      return;
    }
    try {
      const { data, meta } = await this.runAction<TData, any>(this._refreshActionName, {
        method: 'get',
        ...this.getRefreshRequestOptions(),
      });
      this.setData(data).setMeta(meta);
      this.emit('refresh');
    } catch (error) {
      this.setError(error);
      throw error;
    }
  }
}