@nocobase/flow-engine 2.0.0-alpha.2

package/lib/resources/flowResource.js

@@ -0,0 +1,146 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var flowResource_exports = {};
+__export(flowResource_exports, {
+  FlowResource: () => FlowResource,
+  ResourceError: () => ResourceError
+});
+module.exports = __toCommonJS(flowResource_exports);
+var import_reactive = require("@formily/reactive");
+var import_flowContext = require("../flowContext");
+function toErrMessages(error) {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
+  if (typeof ((_a = error == null ? void 0 : error.response) == null ? void 0 : _a.data) === "string") {
+    const tempElement = document.createElement("div");
+    tempElement.innerHTML = (_b = error == null ? void 0 : error.response) == null ? void 0 : _b.data;
+    let message = tempElement.textContent || tempElement.innerText;
+    if (message.includes("Error occurred while trying")) {
+      message = "The application may be starting up. Please try again later.";
+      return [{ code: "APP_WARNING", message }];
+    }
+    if (message.includes("502 Bad Gateway")) {
+      message = "The application may be starting up. Please try again later.";
+      return [{ code: "APP_WARNING", message }];
+    }
+    return [{ message }];
+  }
+  if ((_d = (_c = error == null ? void 0 : error.response) == null ? void 0 : _c.data) == null ? void 0 : _d.error) {
+    return [(_f = (_e = error == null ? void 0 : error.response) == null ? void 0 : _e.data) == null ? void 0 : _f.error];
+  }
+  return ((_h = (_g = error == null ? void 0 : error.response) == null ? void 0 : _g.data) == null ? void 0 : _h.errors) || ((_j = (_i = error == null ? void 0 : error.response) == null ? void 0 : _i.data) == null ? void 0 : _j.messages) || ((_k = error == null ? void 0 : error.response) == null ? void 0 : _k.error) || [{ message: error.message || "Server error" }];
+}
+__name(toErrMessages, "toErrMessages");
+const _ResourceError = class _ResourceError extends Error {
+  data;
+  constructor(error) {
+    const data = toErrMessages(error).shift();
+    super(data.message);
+    this.name = "ResponseError";
+  }
+  get code() {
+    var _a;
+    return ((_a = this.data) == null ? void 0 : _a.code) || "UNKNOWN_ERROR";
+  }
+  get message() {
+    var _a;
+    return ((_a = this.data) == null ? void 0 : _a.message) || "An unknown error occurred";
+  }
+};
+__name(_ResourceError, "ResourceError");
+let ResourceError = _ResourceError;
+const _FlowResource = class _FlowResource {
+  _data = import_reactive.observable.ref(null);
+  _meta = import_reactive.observable.ref({});
+  _error = import_reactive.observable.ref(null);
+  context;
+  constructor(context) {
+    this.context = new import_flowContext.FlowContext();
+    this.context.addDelegate(context);
+  }
+  getData() {
+    return this._data.value;
+  }
+  hasData() {
+    const data = this.getData();
+    if (Array.isArray(data)) {
+      return data.length > 0;
+    } else if (data && typeof data === "object") {
+      return Object.keys(data).length > 0;
+    }
+    return false;
+  }
+  setData(value) {
+    this._data.value = value;
+    return this;
+  }
+  getMeta(metaKey) {
+    return metaKey ? this._meta.value[metaKey] : this._meta.value;
+  }
+  setMeta(meta) {
+    this._meta.value = { ...this._meta.value, ...meta };
+    return this;
+  }
+  get error() {
+    return this._error.value;
+  }
+  getError() {
+    return this._error.value;
+  }
+  setError(error) {
+    this._error.value = error;
+    return this;
+  }
+  clearError() {
+    this._error.value = null;
+    return this;
+  }
+  events = {};
+  on(event, callback) {
+    (this.events[event] ||= []).push(callback);
+  }
+  once(event, callback) {
+    const wrapper = /* @__PURE__ */ __name((...args) => {
+      callback(...args);
+      this.off(event, wrapper);
+    }, "wrapper");
+    this.on(event, wrapper);
+  }
+  off(event, callback) {
+    this.events[event] = (this.events[event] || []).filter((fn) => fn !== callback);
+  }
+  emit(event, ...args) {
+    (this.events[event] || []).forEach((fn) => fn(...args));
+  }
+};
+__name(_FlowResource, "FlowResource");
+let FlowResource = _FlowResource;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FlowResource,
+  ResourceError
+});

package/lib/resources/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 * from './apiResource';
+export * from './baseRecordResource';
+export * from './filterItem';
+export * from './flowResource';
+export * from './multiRecordResource';
+export * from './singleRecordResource';
+export * from './sqlResource';

package/lib/resources/index.js

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var resources_exports = {};
+module.exports = __toCommonJS(resources_exports);
+__reExport(resources_exports, require("./apiResource"), module.exports);
+__reExport(resources_exports, require("./baseRecordResource"), module.exports);
+__reExport(resources_exports, require("./filterItem"), module.exports);
+__reExport(resources_exports, require("./flowResource"), module.exports);
+__reExport(resources_exports, require("./multiRecordResource"), module.exports);
+__reExport(resources_exports, require("./singleRecordResource"), module.exports);
+__reExport(resources_exports, require("./sqlResource"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./apiResource"),
+  ...require("./baseRecordResource"),
+  ...require("./filterItem"),
+  ...require("./flowResource"),
+  ...require("./multiRecordResource"),
+  ...require("./singleRecordResource"),
+  ...require("./sqlResource")
+});

package/lib/resources/multiRecordResource.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 { BaseRecordResource } from './baseRecordResource';
+export declare class MultiRecordResource<TDataItem = any> extends BaseRecordResource<TDataItem[]> {
+    protected _data: {
+        value: TDataItem[];
+    };
+    protected _meta: {
+        value: Record<string, any>;
+    };
+    private refreshTimer;
+    protected createActionOptions: {};
+    protected updateActionOptions: {};
+    protected _refreshActionName: string;
+    protected request: {
+        method: string;
+        params: Record<string, any>;
+        headers: Record<string, any>;
+    };
+    get supportsFilter(): boolean;
+    setCreateActionOptions(options: AxiosRequestConfig): this;
+    setUpdateActionOptions(options: AxiosRequestConfig): this;
+    setSelectedRows(selectedRows: TDataItem[]): this;
+    getSelectedRows(): TDataItem[];
+    getCount(): number;
+    setPage(page: number): this;
+    getPage(): number;
+    setPageSize(pageSize: number): this;
+    getPageSize(): number;
+    getTotalPage(): number;
+    getCell(rowIndex: number, columnKey: string): TDataItem | undefined;
+    next(): Promise<void>;
+    previous(): Promise<void>;
+    goto(page: number): Promise<void>;
+    create(data: TDataItem, options?: AxiosRequestConfig): Promise<void>;
+    get(filterByTk: any): Promise<TDataItem | undefined>;
+    update(filterByTk: string | number, data: Partial<TDataItem>, options?: AxiosRequestConfig): Promise<void>;
+    destroySelectedRows(): Promise<void>;
+    destroy(filterByTk: string | number | string[] | number[] | TDataItem | TDataItem[], options?: AxiosRequestConfig): Promise<void>;
+    setItem(index: number, newDataItem: TDataItem): void;
+    /**
+     * 在同一个事件循环内多次调用 refresh 方法时，只有最后一次调用会生效。避免触发多次相同的接口请求。
+     * @returns
+     */
+    refresh(): Promise<void>;
+}

package/lib/resources/multiRecordResource.js

@@ -0,0 +1,230 @@
+/**
+ * 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.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var multiRecordResource_exports = {};
+__export(multiRecordResource_exports, {
+  MultiRecordResource: () => MultiRecordResource
+});
+module.exports = __toCommonJS(multiRecordResource_exports);
+var import_reactive = require("@formily/reactive");
+var import_lodash = __toESM(require("lodash"));
+var import_baseRecordResource = require("./baseRecordResource");
+const _MultiRecordResource = class _MultiRecordResource extends import_baseRecordResource.BaseRecordResource {
+  _data = import_reactive.observable.ref([]);
+  _meta = import_reactive.observable.ref({});
+  refreshTimer = null;
+  createActionOptions = {};
+  updateActionOptions = {};
+  _refreshActionName = "list";
+  // 请求配置 - 与 APIClient 接口保持一致
+  request = {
+    // url: null as string | null,
+    method: "get",
+    params: {
+      filter: {},
+      filterByTk: null,
+      appends: [],
+      fields: [],
+      sort: null,
+      except: null,
+      whitelist: null,
+      blacklist: null,
+      page: 1,
+      pageSize: 20
+    },
+    headers: {}
+  };
+  get supportsFilter() {
+    return true;
+  }
+  setCreateActionOptions(options) {
+    this.createActionOptions = options;
+    return this;
+  }
+  setUpdateActionOptions(options) {
+    this.updateActionOptions = options;
+    return this;
+  }
+  setSelectedRows(selectedRows) {
+    this.setMeta({ selectedRows });
+    return this;
+  }
+  getSelectedRows() {
+    return this.getMeta("selectedRows") || [];
+  }
+  getCount() {
+    return this.getMeta("count");
+  }
+  setPage(page) {
+    this.addRequestParameter("page", page);
+    return this.setMeta({ page });
+  }
+  getPage() {
+    return this.getMeta("page");
+  }
+  setPageSize(pageSize) {
+    this.addRequestParameter("pageSize", pageSize);
+    return this.setMeta({ pageSize });
+  }
+  getPageSize() {
+    return this.getMeta("pageSize");
+  }
+  getTotalPage() {
+    return this.getMeta("totalPage");
+  }
+  getCell(rowIndex, columnKey) {
+    var _a;
+    const data = this.getData();
+    return (_a = data == null ? void 0 : data[rowIndex]) == null ? void 0 : _a[columnKey];
+  }
+  async next() {
+    this.request.params.page += 1;
+    await this.refresh();
+  }
+  async previous() {
+    if (this.request.params.page > 1) {
+      this.request.params.page -= 1;
+      await this.refresh();
+    }
+  }
+  async goto(page) {
+    if (page > 0) {
+      this.request.params.page = page;
+      await this.refresh();
+    }
+  }
+  async create(data, options) {
+    const config = this.mergeRequestConfig({ data }, this.createActionOptions, options);
+    await this.runAction("create", config);
+    await this.refresh();
+  }
+  async get(filterByTk) {
+    const options = {
+      params: {
+        filterByTk
+      }
+    };
+    const { data } = await this.runAction("get", {
+      ...options
+    });
+    return data;
+  }
+  async update(filterByTk, data, options) {
+    const config = this.mergeRequestConfig(
+      {
+        params: {
+          filterByTk
+        },
+        data
+      },
+      this.updateActionOptions,
+      options
+    );
+    await this.runAction("update", config);
+    await this.refresh();
+  }
+  async destroySelectedRows() {
+    const selectedRows = this.getSelectedRows();
+    if (selectedRows.length === 0) {
+      throw new Error("No rows selected for deletion.");
+    }
+    await this.destroy(selectedRows);
+  }
+  async destroy(filterByTk, options) {
+    const config = this.mergeRequestConfig(
+      {
+        params: {
+          filterByTk: import_lodash.default.castArray(filterByTk).map((item) => {
+            return typeof item === "object" ? item["id"] : item;
+          })
+        }
+      },
+      options
+    );
+    await this.runAction("destroy", config);
+    await this.refresh();
+  }
+  setItem(index, newDataItem) {
+    const oldData = this.getData();
+    const newData = oldData.slice();
+    newData[index] = { ...newDataItem };
+    this.setData(newData);
+  }
+  /**
+   * 在同一个事件循环内多次调用 refresh 方法时，只有最后一次调用会生效。避免触发多次相同的接口请求。
+   * @returns
+   */
+  async refresh() {
+    if (this.refreshTimer) {
+      clearTimeout(this.refreshTimer);
+    }
+    return new Promise((resolve, reject) => {
+      this.refreshTimer = setTimeout(async () => {
+        try {
+          this.clearError();
+          this.loading = true;
+          const { data, meta } = await this.runAction(this._refreshActionName, {
+            method: "get",
+            ...this.getRefreshRequestOptions()
+          });
+          this.setData(data).setMeta(meta);
+          if (meta == null ? void 0 : meta.page) {
+            this.setPage(meta.page);
+          }
+          if (meta == null ? void 0 : 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;
+        }
+      });
+    });
+  }
+};
+__name(_MultiRecordResource, "MultiRecordResource");
+let MultiRecordResource = _MultiRecordResource;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MultiRecordResource
+});

package/lib/resources/singleRecordResource.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { BaseRecordResource } from './baseRecordResource';
+export declare class SingleRecordResource<TData = any> extends BaseRecordResource<TData> {
+    isNewRecord: boolean;
+    protected saveActionOptions: {};
+    protected _refreshActionName: string;
+    get supportsFilter(): boolean;
+    setSaveActionOptions(options: AxiosRequestConfig): this;
+    setFilterByTk(filterByTk: any): this;
+    save(data: TData, options?: AxiosRequestConfig & {
+        refresh?: boolean;
+    }): Promise<void>;
+    destroy(options?: AxiosRequestConfig): Promise<void>;
+    refresh(): Promise<void>;
+}

package/lib/resources/singleRecordResource.js

@@ -0,0 +1,111 @@
+/**
+ * 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.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var singleRecordResource_exports = {};
+__export(singleRecordResource_exports, {
+  SingleRecordResource: () => SingleRecordResource
+});
+module.exports = __toCommonJS(singleRecordResource_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_baseRecordResource = require("./baseRecordResource");
+const _SingleRecordResource = class _SingleRecordResource extends import_baseRecordResource.BaseRecordResource {
+  isNewRecord = false;
+  saveActionOptions = {};
+  _refreshActionName = "get";
+  get supportsFilter() {
+    return !this.isNewRecord;
+  }
+  setSaveActionOptions(options) {
+    this.saveActionOptions = options;
+    return this;
+  }
+  setFilterByTk(filterByTk) {
+    this.isNewRecord = false;
+    return super.setFilterByTk(filterByTk);
+  }
+  async save(data, options) {
+    const config = this.mergeRequestConfig(this.saveActionOptions, import_lodash.default.omit(options, ["refresh"]));
+    let actionName = "create";
+    if (!this.isNewRecord) {
+      config.params = config.params || {};
+      config.params.filterByTk = this.getFilterByTk();
+      actionName = "update";
+    }
+    await this.runAction(actionName, {
+      ...config,
+      data
+    });
+    if ((options == null ? void 0 : options.refresh) !== false) {
+      await this.refresh();
+    }
+  }
+  async destroy(options) {
+    const config = this.mergeRequestConfig(
+      {
+        params: {
+          filterByTk: this.request.params.filterByTk
+        }
+      },
+      options
+    );
+    await this.runAction("destroy", config);
+    this.setData(null);
+  }
+  async refresh() {
+    this.clearError();
+    if (this.isNewRecord) {
+      return;
+    }
+    try {
+      const { data, meta } = await this.runAction(this._refreshActionName, {
+        method: "get",
+        ...this.getRefreshRequestOptions()
+      });
+      this.setData(data).setMeta(meta);
+      this.emit("refresh");
+    } catch (error) {
+      this.setError(error);
+      throw error;
+    }
+  }
+};
+__name(_SingleRecordResource, "SingleRecordResource");
+let SingleRecordResource = _SingleRecordResource;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SingleRecordResource
+});

package/lib/resources/sqlResource.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { 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;
+};
+export declare class FlowSQLRepository {
+    protected ctx: FlowEngineContext;
+    constructor(ctx: FlowEngineContext);
+    run(sql: string, options?: SQLRunOptions): Promise<any>;
+    save(data: SQLSaveOptions): Promise<void>;
+    runById(uid: string, options?: SQLRunOptions): Promise<any>;
+    destroy(uid: string): Promise<void>;
+}
+export declare class SQLResource<TData = any> extends BaseRecordResource<TData> {
+    protected _data: {
+        value: TData;
+    };
+    protected _meta: {
+        value: Record<string, any>;
+    };
+    private refreshTimer;
+    private _debugEnabled;
+    private _sql;
+    protected request: {
+        method: string;
+        params: Record<string, any>;
+        data: Record<string, any>;
+        headers: Record<string, any>;
+    };
+    get refreshActionName(): "run" | "runById";
+    get supportsFilter(): boolean;
+    constructor(context: FlowEngineContext);
+    protected buildURL(action?: string): string;
+    setPage(page: number): this;
+    getPage(): number;
+    setPageSize(pageSize: number): this;
+    setDebug(enabled: boolean): this;
+    getPageSize(): number;
+    next(): Promise<void>;
+    previous(): Promise<void>;
+    goto(page: number): Promise<void>;
+    setDataSourceKey(dataSourceKey: string): this;
+    setSQLType(type: 'selectRows' | 'selectRow' | 'selectVar'): this;
+    setSQL(sql: string): this;
+    setFilterByTk(filterByTk: any): this;
+    setFilter(filter: Record<string, any>): this;
+    setBind(bind: Record<string, any> | Array<any>): this;
+    run(): Promise<any>;
+    runBySQL(): Promise<any>;
+    runById(): Promise<any>;
+    /**
+     * 在同一个事件循环内多次调用 refresh 方法时，只有最后一次调用会生效。避免触发多次相同的接口请求。
+     * @returns
+     */
+    refresh(): Promise<void>;
+}
+export {};