@nocobase/flow-engine 2.0.0-alpha.2

package/lib/resources/apiResource.js

@@ -0,0 +1,153 @@
+/**
+ * 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 apiResource_exports = {};
+__export(apiResource_exports, {
+  APIResource: () => APIResource
+});
+module.exports = __toCommonJS(apiResource_exports);
+var import_flowResource = require("./flowResource");
+const _APIResource = class _APIResource extends import_flowResource.FlowResource {
+  // 请求配置
+  request = {
+    // url: null as string | null,
+    headers: {},
+    // 仅用于 Refresh
+    params: {},
+    method: "get",
+    data: null
+  };
+  api;
+  constructor(context) {
+    super(context);
+    if (context) {
+      this.api = context.api;
+    }
+  }
+  setAPIClient(api) {
+    this.api = api;
+    return this;
+  }
+  getURL() {
+    return this.request.url;
+  }
+  setURL(value) {
+    this.request.url = value;
+    return this;
+  }
+  get loading() {
+    return this.getMeta("loading") || false;
+  }
+  set loading(value) {
+    this.setMeta({ loading: value });
+  }
+  clearRequestParameters() {
+    this.request.params = {};
+    return this;
+  }
+  setRequestParameters(params) {
+    this.request.params = { ...this.request.params, ...params };
+    return this;
+  }
+  setRequestMethod(method) {
+    this.request.method = method;
+    return this;
+  }
+  addRequestHeader(key, value) {
+    if (!this.request.headers) {
+      this.request.headers = {};
+    }
+    this.request.headers[key] = value;
+    return this;
+  }
+  removeRequestHeader(key) {
+    if (this.request.headers && key in this.request.headers) {
+      delete this.request.headers[key];
+    }
+    return this;
+  }
+  addRequestParameter(key, value) {
+    if (!this.request.params) {
+      this.request.params = {};
+    }
+    this.request.params[key] = value;
+    return this;
+  }
+  getRequestParameter(key) {
+    if (this.request.params && key in this.request.params) {
+      return this.request.params[key];
+    }
+    return null;
+  }
+  removeRequestParameter(key) {
+    if (this.request.params && key in this.request.params) {
+      delete this.request.params[key];
+    }
+    return this;
+  }
+  setRequestBody(data) {
+    this.request.data = data;
+    return this;
+  }
+  setRequestOptions(key, value) {
+    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 import_flowResource.ResourceError(err);
+      this.setError(error);
+      throw error;
+    }
+  }
+  getRefreshRequestOptions() {
+    const options = {
+      ...this.request
+    };
+    return options;
+  }
+};
+__name(_APIResource, "APIResource");
+let APIResource = _APIResource;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  APIResource
+});

package/lib/resources/baseRecordResource.d.ts

@@ -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 { AxiosRequestConfig } from 'axios';
+import { APIResource } from './apiResource';
+import { FilterItem } from './filterItem';
+export declare abstract class BaseRecordResource<TData = any> extends APIResource<TData> {
+    protected resourceName: string;
+    protected sourceId: string | number | null;
+    protected request: {
+        method: string;
+        params: Record<string, any>;
+        headers: Record<string, any>;
+    };
+    protected updateAssociationValues: string[];
+    protected runActionOptions: {};
+    protected filterGroups: Map<string, any>;
+    protected _refreshActionName: string;
+    get supportsFilter(): boolean;
+    setRefreshAction(refreshActionName: string): void;
+    mergeRequestConfig(...args: AxiosRequestConfig[]): AxiosRequestConfig;
+    setRunActionOptions(action: string, options: AxiosRequestConfig): this;
+    protected splitValue(value: string | string[]): string[];
+    protected buildURL(action?: string): string;
+    runAction<TData = any, TMeta = any>(action: string, options: any): Promise<any>;
+    setResourceName(resourceName: string): this;
+    getResourceName(): string;
+    setSourceId(sourceId: string | number): this;
+    getSourceId(): string | number;
+    setDataSourceKey(dataSourceKey: string): this;
+    getDataSourceKey(): string;
+    setFilter(filter: Record<string, any>): this;
+    getFilter(): Record<string, any>;
+    resetFilter(): void;
+    addFilterGroup(key: string, filter: FilterItem | Record<string, any>): void;
+    removeFilterGroup(key: string): void;
+    setAppends(appends: string[]): this;
+    getAppends(): string[];
+    addAppends(appends: string | string[]): this;
+    removeAppends(appends: string | string[]): this;
+    getUpdateAssociationValues(): string[];
+    addUpdateAssociationValues(updateAssociationValues: string | string[]): this;
+    setFilterByTk(filterByTk: any): this;
+    getFilterByTk(): any;
+    setFields(fields: string[] | string): this;
+    getFields(): string[];
+    setSort(sort: string | string[]): this;
+    getSort(): string[];
+    setExcept(except: string | string[]): this;
+    getExcept(): string[];
+    setWhitelist(whitelist: string | string[]): this;
+    getWhitelist(): string[];
+    setBlacklist(blacklist: string | string[]): this;
+    getBlacklist(): string[];
+    abstract refresh(): Promise<void>;
+}

package/lib/resources/baseRecordResource.js

@@ -0,0 +1,264 @@
+/**
+ * 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 baseRecordResource_exports = {};
+__export(baseRecordResource_exports, {
+  BaseRecordResource: () => BaseRecordResource
+});
+module.exports = __toCommonJS(baseRecordResource_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_apiResource = require("./apiResource");
+var import_filterItem = require("./filterItem");
+var import_flowResource = require("./flowResource");
+const _BaseRecordResource = class _BaseRecordResource extends import_apiResource.APIResource {
+  resourceName;
+  sourceId = null;
+  // 请求配置 - 与 APIClient 接口保持一致
+  request = {
+    // url: null as string | null,
+    method: "get",
+    params: {
+      // filter: {} as Record<string, any>,
+      // filterByTk: null as string | number | string[] | number[] | null,
+      // appends: null as string[] | null,
+      // fields: null as string[] | null,
+      // sort: null as string[] | null,
+      // except: null as string[] | null,
+      // whitelist: null as string[] | null,
+      // blacklist: null as string[] | null,
+    },
+    headers: {}
+  };
+  updateAssociationValues = [];
+  runActionOptions = {};
+  filterGroups = /* @__PURE__ */ new Map();
+  _refreshActionName = "list";
+  get supportsFilter() {
+    return true;
+  }
+  setRefreshAction(refreshActionName) {
+    this._refreshActionName = refreshActionName;
+  }
+  mergeRequestConfig(...args) {
+    const base = {};
+    const customizer = /* @__PURE__ */ __name((objValue, srcValue, key, object, source, stack) => {
+      const depth = stack.size;
+      if (Array.isArray(srcValue)) {
+        return srcValue;
+      }
+      if (depth > 1) {
+        return srcValue;
+      }
+    }, "customizer");
+    return args.reduce((acc, cur) => import_lodash.default.mergeWith(acc, cur, customizer), base);
+  }
+  setRunActionOptions(action, options) {
+    this.runActionOptions[action] = options;
+    return this;
+  }
+  splitValue(value) {
+    if (typeof value === "string") {
+      return value.split(",").map((item) => item.trim());
+    }
+    return Array.isArray(value) ? value : [];
+  }
+  buildURL(action) {
+    let url = "";
+    if (this.resourceName) {
+      if (this.sourceId && this.resourceName.includes(".")) {
+        const [parentResource, childResource] = this.resourceName.split(".");
+        url = `${parentResource}/${this.sourceId}/${childResource}:${action || "get"}`;
+      } else {
+        url = `${this.resourceName}:${action || "get"}`;
+      }
+    }
+    return url;
+  }
+  async runAction(action, options) {
+    var _a;
+    const config = this.mergeRequestConfig(
+      import_lodash.default.omit(this.request, ["params", "data", "method"]),
+      {
+        method: "post",
+        url: this.buildURL(action)
+      },
+      (_a = this.runActionOptions) == null ? void 0 : _a[action],
+      options
+    );
+    if (["create", "update", "firstOrCreate", "updateOrCreate"].includes(action)) {
+      config.params = config.params || {};
+      config.params.updateAssociationValues = this.getUpdateAssociationValues();
+    }
+    try {
+      const { data } = await this.api.request(config);
+      if (!(data == null ? void 0 : data.data)) {
+        return data;
+      }
+      return { data: data.data, meta: data.meta };
+    } catch (err) {
+      throw new import_flowResource.ResourceError(err);
+    }
+  }
+  setResourceName(resourceName) {
+    this.resourceName = resourceName;
+    return this;
+  }
+  getResourceName() {
+    return this.resourceName;
+  }
+  setSourceId(sourceId) {
+    this.sourceId = sourceId;
+    return this;
+  }
+  getSourceId() {
+    return this.sourceId;
+  }
+  setDataSourceKey(dataSourceKey) {
+    return this.addRequestHeader("X-Data-Source", dataSourceKey);
+  }
+  getDataSourceKey() {
+    return this.request.headers["X-Data-Source"];
+  }
+  setFilter(filter) {
+    return this.addRequestParameter("filter", JSON.stringify(filter));
+  }
+  getFilter() {
+    const value = [...this.filterGroups.values()].filter(Boolean);
+    if (value.length === 0) {
+      return;
+    }
+    return {
+      $and: value
+    };
+  }
+  resetFilter() {
+    this.setFilter(this.getFilter());
+  }
+  addFilterGroup(key, filter) {
+    if (filter instanceof import_filterItem.FilterItem) {
+      filter = filter.toJSON();
+    }
+    this.filterGroups.set(key, filter);
+    this.resetFilter();
+  }
+  removeFilterGroup(key) {
+    this.filterGroups.delete(key);
+    this.resetFilter();
+  }
+  setAppends(appends) {
+    return this.addRequestParameter("appends", appends);
+  }
+  getAppends() {
+    return this.request.params.appends || [];
+  }
+  addAppends(appends) {
+    const currentAppends = this.getAppends();
+    const newAppends = this.splitValue(appends);
+    newAppends.forEach((append) => {
+      if (!currentAppends.includes(append)) {
+        currentAppends.push(append);
+      }
+    });
+    this.request.params.appends = currentAppends;
+    return this;
+  }
+  removeAppends(appends) {
+    if (!this.request.params.appends) {
+      return this;
+    }
+    const currentAppends = this.getAppends();
+    const removeAppends = this.splitValue(appends);
+    this.request.params.appends = currentAppends.filter((append) => !removeAppends.includes(append));
+    return this;
+  }
+  getUpdateAssociationValues() {
+    return this.updateAssociationValues || [];
+  }
+  addUpdateAssociationValues(updateAssociationValues) {
+    const currentUpdateAssociationValues = this.getUpdateAssociationValues();
+    const newUpdateAssociationValues = this.splitValue(updateAssociationValues);
+    newUpdateAssociationValues.forEach((append) => {
+      if (!currentUpdateAssociationValues.includes(append)) {
+        currentUpdateAssociationValues.push(append);
+      }
+    });
+    this.updateAssociationValues = currentUpdateAssociationValues;
+    return this;
+  }
+  setFilterByTk(filterByTk) {
+    return this.addRequestParameter("filterByTk", filterByTk);
+  }
+  getFilterByTk() {
+    return this.request.params.filterByTk;
+  }
+  setFields(fields) {
+    return this.addRequestParameter("fields", this.splitValue(fields));
+  }
+  getFields() {
+    return this.request.params.fields || [];
+  }
+  setSort(sort) {
+    return this.addRequestParameter("sort", this.splitValue(sort));
+  }
+  getSort() {
+    return this.request.params.sort || [];
+  }
+  setExcept(except) {
+    return this.addRequestParameter("except", this.splitValue(except));
+  }
+  getExcept() {
+    return this.request.params.except || [];
+  }
+  setWhitelist(whitelist) {
+    return this.addRequestParameter("whitelist", this.splitValue(whitelist));
+  }
+  getWhitelist() {
+    return this.request.params.whitelist || [];
+  }
+  setBlacklist(blacklist) {
+    return this.addRequestParameter("blacklist", this.splitValue(blacklist));
+  }
+  getBlacklist() {
+    return this.request.params.blacklist || [];
+  }
+};
+__name(_BaseRecordResource, "BaseRecordResource");
+let BaseRecordResource = _BaseRecordResource;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BaseRecordResource
+});

package/lib/resources/filterItem.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+type FilterOptions = {
+    path: string;
+    value: any;
+    operator?: string;
+};
+export declare class FilterItem {
+    protected options: FilterOptions;
+    constructor(options: FilterOptions);
+    toJSON(): {
+        [x: string]: any;
+    };
+}
+export type FilterGroupOptions = {
+    logic: '$and' | '$or';
+    items: Array<FilterItem | FilterOptions | FilterGroup | FilterGroupOptions>;
+};
+export declare class FilterGroup {
+    protected options: {
+        logic: '$and' | '$or';
+        items: Array<FilterItem | FilterGroup>;
+    };
+    constructor(options: FilterGroupOptions);
+    toJSON(): any;
+}
+export {};

package/lib/resources/filterItem.js

@@ -0,0 +1,93 @@
+/**
+ * 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 filterItem_exports = {};
+__export(filterItem_exports, {
+  FilterGroup: () => FilterGroup,
+  FilterItem: () => FilterItem
+});
+module.exports = __toCommonJS(filterItem_exports);
+const _FilterItem = class _FilterItem {
+  constructor(options) {
+    this.options = options;
+    if (options instanceof _FilterItem) {
+      return options;
+    }
+    this.options = options;
+  }
+  toJSON() {
+    if (this.options.operator) {
+      return {
+        [this.options.path]: {
+          [this.options.operator]: this.options.value
+        }
+      };
+    }
+    return {
+      [this.options.path]: this.options.value
+    };
+  }
+};
+__name(_FilterItem, "FilterItem");
+let FilterItem = _FilterItem;
+const _FilterGroup = class _FilterGroup {
+  options;
+  constructor(options) {
+    if (options instanceof _FilterGroup) {
+      return options;
+    }
+    if (options.logic !== "$and" && options.logic !== "$or") {
+      throw new Error("Logic must be either $and or $or");
+    }
+    if (!Array.isArray(options.items)) {
+      throw new Error("Items must be an array");
+    }
+    this.options = {
+      logic: options.logic,
+      items: options.items.map((item) => {
+        if (item.logic) {
+          return new _FilterGroup(item);
+        }
+        return new FilterItem(item);
+      })
+    };
+  }
+  toJSON() {
+    return {
+      [this.options.logic]: this.options.items.map((item) => {
+        return item.toJSON();
+      })
+    };
+  }
+};
+__name(_FilterGroup, "FilterGroup");
+let FilterGroup = _FilterGroup;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FilterGroup,
+  FilterItem
+});

package/lib/resources/flowResource.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { FlowContext } from '../flowContext';
+export declare class ResourceError extends Error {
+    data: {
+        message: string;
+        code?: string;
+    };
+    constructor(error: any);
+    get code(): string;
+    get message(): string;
+}
+export declare class FlowResource<TData = any> {
+    protected _data: {
+        value: TData;
+    };
+    protected _meta: {
+        value: Record<string, any>;
+    };
+    protected _error: {
+        value: ResourceError;
+    };
+    protected context: FlowContext;
+    constructor(context: FlowContext);
+    getData(): TData;
+    hasData(): boolean;
+    setData(value: TData): this;
+    getMeta(metaKey?: string): any;
+    setMeta(meta: Record<string, any>): this;
+    get error(): ResourceError | null;
+    getError(): ResourceError | null;
+    setError(error: ResourceError | null): this;
+    clearError(): this;
+    private events;
+    on(event: string, callback: (...args: any[]) => void): void;
+    once(event: string, callback: (...args: any[]) => void): void;
+    off(event: string, callback: (...args: any[]) => void): void;
+    emit(event: string, ...args: any[]): void;
+}