@nocobase/flow-engine 2.0.0-alpha.2

package/src/resources/multiRecordResource.ts

@@ -0,0 +1,219 @@
+/**
+ * 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 { observable } from '@formily/reactive';
+import { AxiosRequestConfig } from 'axios';
+import _ from 'lodash';
+import { BaseRecordResource } from './baseRecordResource';
+
+export class MultiRecordResource<TDataItem = any> extends BaseRecordResource<TDataItem[]> {
+  protected _data = observable.ref<TDataItem[]>([]);
+  protected _meta = observable.ref<Record<string, any>>({});
+  private refreshTimer: NodeJS.Timeout | null = null;
+  protected createActionOptions = {};
+  protected updateActionOptions = {};
+  protected _refreshActionName = 'list';
+
+  // 请求配置 - 与 APIClient 接口保持一致
+  protected request = {
+    // url: null as string | null,
+    method: 'get' as string,
+    params: {
+      filter: {} as Record<string, any>,
+      filterByTk: null as string | number | string[] | number[] | null,
+      appends: [] as string[],
+      fields: [] as string[],
+      sort: null as string[] | null,
+      except: null as string[] | null,
+      whitelist: null as string[] | null,
+      blacklist: null as string[] | null,
+      page: 1 as number,
+      pageSize: 20 as number,
+    } as Record<string, any>,
+    headers: {} as Record<string, any>,
+  };
+
+  get supportsFilter() {
+    return true;
+  }
+
+  setCreateActionOptions(options: AxiosRequestConfig) {
+    this.createActionOptions = options;
+    return this;
+  }
+
+  setUpdateActionOptions(options: AxiosRequestConfig) {
+    this.updateActionOptions = options;
+    return this;
+  }
+
+  setSelectedRows(selectedRows: TDataItem[]) {
+    this.setMeta({ selectedRows });
+    return this;
+  }
+
+  getSelectedRows(): TDataItem[] {
+    return this.getMeta('selectedRows') || [];
+  }
+
+  getCount(): number {
+    return this.getMeta('count');
+  }
+  setPage(page: number) {
+    this.addRequestParameter('page', page);
+    return this.setMeta({ page });
+  }
+
+  getPage(): number {
+    return this.getMeta('page');
+  }
+
+  setPageSize(pageSize: number) {
+    this.addRequestParameter('pageSize', pageSize);
+    return this.setMeta({ pageSize });
+  }
+
+  getPageSize(): number {
+    return this.getMeta('pageSize');
+  }
+
+  getTotalPage(): number {
+    return this.getMeta('totalPage');
+  }
+  getCell(rowIndex: number, columnKey: string): TDataItem | undefined {
+    const data = this.getData();
+    return data?.[rowIndex]?.[columnKey];
+  }
+
+  async next(): Promise<void> {
+    this.request.params.page += 1;
+    await this.refresh();
+  }
+
+  async previous(): Promise<void> {
+    if (this.request.params.page > 1) {
+      this.request.params.page -= 1;
+      await this.refresh();
+    }
+  }
+
+  async goto(page: number): Promise<void> {
+    if (page > 0) {
+      this.request.params.page = page;
+      await this.refresh();
+    }
+  }
+
+  async create(data: TDataItem, options?: AxiosRequestConfig): Promise<void> {
+    const config = this.mergeRequestConfig({ data }, this.createActionOptions, options);
+    await this.runAction('create', config);
+    await this.refresh();
+  }
+
+  async get(filterByTk: any): Promise<TDataItem | undefined> {
+    const options = {
+      params: {
+        filterByTk,
+      },
+    };
+    const { data } = await this.runAction<TDataItem, any>('get', {
+      ...options,
+    });
+    return data;
+  }
+
+  async update(filterByTk: string | number, data: Partial<TDataItem>, options?: AxiosRequestConfig): Promise<void> {
+    const config = this.mergeRequestConfig(
+      {
+        params: {
+          filterByTk,
+        },
+        data,
+      },
+      this.updateActionOptions,
+      options,
+    );
+    await this.runAction('update', config);
+    await this.refresh();
+  }
+
+  async destroySelectedRows(): Promise<void> {
+    const selectedRows = this.getSelectedRows();
+    if (selectedRows.length === 0) {
+      throw new Error('No rows selected for deletion.');
+    }
+    await this.destroy(selectedRows);
+  }
+
+  async destroy(
+    filterByTk: string | number | string[] | number[] | TDataItem | TDataItem[],
+    options?: AxiosRequestConfig,
+  ): Promise<void> {
+    const config = this.mergeRequestConfig(
+      {
+        params: {
+          filterByTk: _.castArray(filterByTk).map((item) => {
+            return typeof item === 'object' ? item['id'] : item; // TODO: ID 字段还需要根据实际情况更改
+          }),
+        },
+      },
+      options,
+    );
+    await this.runAction('destroy', config);
+    await this.refresh();
+  }
+
+  setItem(index: number, newDataItem: TDataItem) {
+    const oldData = this.getData();
+    const newData = oldData.slice(); // 浅拷贝
+    newData[index] = { ...newDataItem };
+    this.setData(newData);
+  }
+
+  /**
+   * 在同一个事件循环内多次调用 refresh 方法时，只有最后一次调用会生效。避免触发多次相同的接口请求。
+   * @returns
+   */
+  async refresh(): Promise<void> {
+    // 清除之前的定时器，确保只有最后一次调用生效
+    if (this.refreshTimer) {
+      clearTimeout(this.refreshTimer);
+    }
+
+    // 设置新的定时器，在下一个事件循环执行
+    return new Promise<void>((resolve, reject) => {
+      this.refreshTimer = setTimeout(async () => {
+        try {
+          this.clearError();
+          this.loading = true;
+          const { data, meta } = await this.runAction<TDataItem[], any>(this._refreshActionName, {
+            method: 'get',
+            ...this.getRefreshRequestOptions(),
+          });
+          this.setData(data).setMeta(meta);
+          if (meta?.page) {
+            this.setPage(meta.page);
+          }
+          if (meta?.pageSize) {
+            this.setPageSize(meta.pageSize);
+          }
+          this.emit('refresh');
+          this.loading = false;
+          resolve();
+        } catch (error) {
+          this.setError(error);
+          reject(error instanceof Error ? error : new Error(String(error)));
+        } finally {
+          this.refreshTimer = null;
+          this.loading = false;
+        }
+      });
+    });
+  }
+}

package/src/resources/singleRecordResource.ts

@@ -0,0 +1,83 @@
+/**
+ * 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;
+    }
+  }
+}

package/src/resources/sqlResource.ts

@@ -0,0 +1,299 @@
+/**
+ * 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 { observable } from '@formily/reactive';
+import _ from 'lodash';
+import { FlowContext, FlowEngineContext } from '../flowContext';
+import { BaseRecordResource } from './baseRecordResource';
+
+type SQLRunOptions = {
+  bind?: Record<string, any>;
+  type?: 'selectVar' | 'selectRow' | 'selectRows';
+  dataSourceKey?: string;
+  filter?: Record<string, any>;
+};
+
+type SQLSaveOptions = {
+  uid: string;
+  sql: string;
+  dataSourceKey?: string;
+};
+
+function transformSQL(template: string) {
+  let index = 1;
+  const bind = {};
+
+  const sql = template.replace(/{{\s*([^}]+)\s*}}/g, (_, expr) => {
+    const key = `__var${index}`;
+    bind[key] = `{{${expr.trim()}}}`;
+    index++;
+    return `$${key}`;
+  });
+
+  return { sql, bind };
+}
+
+export class FlowSQLRepository {
+  protected ctx: FlowEngineContext;
+
+  constructor(ctx: FlowEngineContext) {
+    this.ctx = new FlowContext() as FlowEngineContext;
+    this.ctx.addDelegate(ctx);
+    this.ctx.defineProperty('offset', {
+      get: () => 0,
+      cache: false,
+    });
+    this.ctx.defineProperty('limit', {
+      get: () => 20,
+      cache: false,
+    });
+  }
+
+  async run(sql: string, options: SQLRunOptions = {}) {
+    const result = transformSQL(sql);
+    const bind = await this.ctx.resolveJsonTemplate(result.bind);
+    const { data } = await this.ctx.api.request({
+      method: 'POST',
+      url: 'flowSql:run',
+      data: {
+        sql: result.sql,
+        ...options,
+        bind: {
+          ...bind,
+          ...options.bind,
+        },
+      },
+    });
+    return data?.data;
+  }
+
+  async save(data: SQLSaveOptions) {
+    await this.ctx.api.request({
+      method: 'POST',
+      url: 'flowSql:save',
+      data: {
+        ...data,
+      },
+    });
+  }
+
+  async runById(uid: string, options?: SQLRunOptions) {
+    const response = await this.ctx.api.request({
+      method: 'GET',
+      url: 'flowSql:getBind',
+      params: {
+        uid,
+      },
+    });
+    const bind = await this.ctx.resolveJsonTemplate(response.data.data || {});
+    const { data } = await this.ctx.api.request({
+      method: 'POST',
+      url: 'flowSql:runById',
+      data: {
+        uid,
+        ...options,
+        bind: {
+          ...bind,
+          ...options.bind,
+        },
+      },
+    });
+    return data?.data;
+  }
+
+  async destroy(uid: string) {
+    await this.ctx.api.request({
+      url: 'flowSql:destroy',
+      params: {
+        filterByTk: uid,
+      },
+    });
+  }
+}
+
+export class SQLResource<TData = any> extends BaseRecordResource<TData> {
+  protected _data = observable.ref<TData>(null);
+  protected _meta = observable.ref<Record<string, any>>({});
+  private refreshTimer: NodeJS.Timeout | null = null;
+  private _debugEnabled = false;
+  private _sql: string;
+
+  // 请求配置 - 与 APIClient 接口保持一致
+  protected request = {
+    // url: null as string | null,
+    method: 'post' as string,
+    params: {} as Record<string, any>,
+    data: {} as Record<string, any>,
+    headers: {} as Record<string, any>,
+  };
+
+  get refreshActionName() {
+    return this._debugEnabled ? 'run' : 'runById';
+  }
+
+  get supportsFilter() {
+    return true;
+  }
+
+  constructor(context: FlowEngineContext) {
+    super(context);
+    context.defineProperty('limit', {
+      get: () => this.getPageSize(),
+      cache: false,
+    });
+    context.defineProperty('offset', {
+      get: () => {
+        const page = this.getPage();
+        const pageSize = this.getPageSize();
+        return (page - 1) * pageSize;
+      },
+      cache: false,
+    });
+  }
+
+  protected buildURL(action?: string): string {
+    return `flowSql:${action || this.refreshActionName}`;
+  }
+
+  setPage(page: number) {
+    this.addRequestParameter('page', page);
+    return this.setMeta({ page });
+  }
+
+  getPage(): number {
+    return this.getMeta('page') || 1;
+  }
+
+  setPageSize(pageSize: number) {
+    this.addRequestParameter('pageSize', pageSize);
+    return this.setMeta({ pageSize });
+  }
+
+  setDebug(enabled: boolean) {
+    this._debugEnabled = enabled;
+    return this;
+  }
+
+  getPageSize(): number {
+    return this.getMeta('pageSize') || 20;
+  }
+
+  async next(): Promise<void> {
+    this.setPage(this.getPage() + 1);
+    await this.refresh();
+  }
+
+  async previous(): Promise<void> {
+    if (this.getPage() > 1) {
+      this.setPage(this.getPage() - 1);
+      await this.refresh();
+    }
+  }
+
+  async goto(page: number): Promise<void> {
+    if (page > 0) {
+      this.request.params.page = page;
+      await this.refresh();
+    }
+  }
+
+  setDataSourceKey(dataSourceKey: string): this {
+    this.request.data.dataSourceKey = dataSourceKey;
+    return this;
+  }
+
+  setSQLType(type: 'selectRows' | 'selectRow' | 'selectVar') {
+    this.request.data.type = type;
+    return this;
+  }
+
+  setSQL(sql: string) {
+    this._sql = sql;
+    return this;
+  }
+
+  setFilterByTk(filterByTk: any) {
+    this.request.data.uid = filterByTk;
+    return this;
+  }
+
+  setFilter(filter: Record<string, any>) {
+    this.request.data.filter = filter;
+    return this;
+  }
+
+  setBind(bind: Record<string, any> | Array<any>) {
+    this.request.data.bind = bind;
+    return this;
+  }
+
+  async run() {
+    return this._debugEnabled ? await this.runBySQL() : await this.runById();
+  }
+
+  async runBySQL() {
+    const sql = this._sql;
+    const result = transformSQL(sql);
+    const bind = await this.context.resolveJsonTemplate(result.bind);
+    const options = _.cloneDeep({
+      method: 'post',
+      ...this.getRefreshRequestOptions(),
+    });
+    options.data.bind = bind;
+    options.data.sql = result.sql;
+    return await this.runAction<TData, any>('run', options);
+  }
+
+  async runById() {
+    const { data } = await this.runAction<TData, any>('getBind', {
+      method: 'get',
+      params: {
+        uid: this.request.data.uid,
+      },
+    });
+    const bind = await this.context.resolveJsonTemplate(data);
+    this.setBind(bind);
+    return await this.runAction<TData, any>('runById', {
+      method: 'post',
+      ...this.getRefreshRequestOptions(),
+    });
+  }
+
+  /**
+   * 在同一个事件循环内多次调用 refresh 方法时，只有最后一次调用会生效。避免触发多次相同的接口请求。
+   * @returns
+   */
+  async refresh(): Promise<void> {
+    // 清除之前的定时器，确保只有最后一次调用生效
+    if (this.refreshTimer) {
+      clearTimeout(this.refreshTimer);
+    }
+
+    // 设置新的定时器，在下一个事件循环执行
+    return new Promise<void>((resolve, reject) => {
+      this.refreshTimer = setTimeout(async () => {
+        try {
+          this.clearError();
+          this.loading = true;
+          const { data, meta } = await this.run();
+          this.setData(data).setMeta(meta);
+          this.emit('refresh');
+          this.loading = false;
+          resolve();
+        } catch (error) {
+          this.setError(error);
+          reject(error instanceof Error ? error : new Error(String(error)));
+        } finally {
+          this.refreshTimer = null;
+          this.loading = false;
+        }
+      });
+    });
+  }
+}