@nocobase/flow-engine/src/resources/apiResource.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 { APIClient } from '@nocobase/sdk';
import { FlowContext } from '../flowContext';
import { FlowResource, ResourceError } from './flowResource';

export class APIResource<TData = any> extends FlowResource<TData> {
  // 请求配置
  protected request: any = {
    // url: null as string | null,
    headers: {} as Record<string, any>,

    // 仅用于 Refresh
    params: {} as Record<string, any>,
    method: 'get' as string,
    data: null as any,
  };

  protected api: APIClient;

  constructor(context?: FlowContext) {
    super(context);
    if (context) {
      this.api = context.api;
    }
  }

  setAPIClient(api: APIClient) {
    this.api = api;
    return this;
  }

  getURL(): string {
    return this.request.url;
  }

  setURL(value: string) {
    this.request.url = value;
    return this;
  }

  get loading() {
    return this.getMeta('loading') || false;
  }

  set loading(value: boolean) {
    this.setMeta({ loading: value });
  }

  clearRequestParameters() {
    this.request.params = {};
    return this;
  }

  setRequestParameters(params: Record<string, any>) {
    this.request.params = { ...this.request.params, ...params };
    return this;
  }

  setRequestMethod(method: string) {
    this.request.method = method;
    return this;
  }

  addRequestHeader(key: string, value: string) {
    if (!this.request.headers) {
      this.request.headers = {};
    }
    this.request.headers[key] = value;
    return this;
  }

  removeRequestHeader(key: string) {
    if (this.request.headers && key in this.request.headers) {
      delete this.request.headers[key];
    }
    return this;
  }

  addRequestParameter(key: string, value: any) {
    if (!this.request.params) {
      this.request.params = {};
    }
    this.request.params[key] = value;
    return this;
  }

  getRequestParameter(key: string) {
    if (this.request.params && key in this.request.params) {
      return this.request.params[key];
    }
    return null;
  }

  removeRequestParameter(key: string) {
    if (this.request.params && key in this.request.params) {
      delete this.request.params[key];
    }
    return this;
  }

  setRequestBody(data: any) {
    this.request.data = data;
    return this;
  }

  setRequestOptions(key: string, value: any) {
    this.request[key] = value;
    return this;
  }

  getRequestOptions() {
    return this.request;
  }

  async refresh() {
    if (!this.api) {
      throw new Error('API client not set');
    }
    this.clearError();
    try {
      const { data } = await this.api.request({
        url: this.getURL(),
        ...this.getRefreshRequestOptions(),
      });
      this.setData(data);
      this.emit('refresh');
    } catch (err) {
      const error = new ResourceError(err);
      this.setError(error);
      throw error;
    }
  }

  protected getRefreshRequestOptions() {
    const options = {
      ...this.request,
    };
    return options;
  }
}