@tachybase/resourcer 0.23.8

package/lib/resourcer.js

@@ -0,0 +1,266 @@
+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 resourcer_exports = {};
+__export(resourcer_exports, {
+  Resourcer: () => Resourcer,
+  default: () => resourcer_default
+});
+module.exports = __toCommonJS(resourcer_exports);
+var import_utils = require("@tachybase/utils");
+var import_glob = require("glob");
+var import_koa_compose = __toESM(require("koa-compose"));
+var import_lodash = __toESM(require("lodash"));
+var import_path_to_regexp = require("path-to-regexp");
+var import_resource = __toESM(require("./resource"));
+var import_utils2 = require("./utils");
+const _Resourcer = class _Resourcer {
+  /**
+   * @internal
+   */
+  options;
+  resources = /* @__PURE__ */ new Map();
+  /**
+   * 全局定义的 action handlers
+   */
+  handlers = /* @__PURE__ */ new Map();
+  actionHandlers = /* @__PURE__ */ new Map();
+  middlewareHandlers = /* @__PURE__ */ new Map();
+  middlewares;
+  middlewareSourceMap = /* @__PURE__ */ new WeakMap();
+  constructor(options = {}) {
+    this.options = options;
+    this.middlewares = new import_utils.Toposort();
+  }
+  /**
+   * 载入指定目录下的 resource 配置（配置的文件驱动）
+   *
+   * TODO: 配置的文件驱动现在会全部初始化，大数据时可能存在性能瓶颈，后续可以加入动态加载
+   *
+   * @param {object}   [options]
+   * @param {string}   [options.directory] 指定配置所在路径
+   * @param {array}    [options.extensions = ['js', 'ts', 'json']] 文件后缀
+   *
+   */
+  async import(options) {
+    const { extensions = ["js", "ts", "json"], directory } = options;
+    const patten = `${directory}/*.{${extensions.join(",")}}`;
+    const files = (0, import_glob.globSync)(patten, {
+      ignore: ["**/*.d.ts"]
+    });
+    const resources = /* @__PURE__ */ new Map();
+    for (const file of files) {
+      const options2 = await (0, import_utils.importModule)(file);
+      const table = this.define(typeof options2 === "function" ? options2(this) : options2);
+      resources.set(table.getName(), table);
+    }
+    return resources;
+  }
+  /**
+   * resource 配置
+   *
+   * @param name
+   * @param options
+   */
+  define(options) {
+    const { name } = options;
+    const resource = new import_resource.default(options, this);
+    this.resources.set(name, resource);
+    return resource;
+  }
+  isDefined(name) {
+    return this.resources.has(name);
+  }
+  /**
+   * @internal
+   */
+  removeResource(name) {
+    return this.resources.delete(name);
+  }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link this.registerActionHandler()} instead.
+   * @deprecated
+   */
+  registerAction(name, handler) {
+    this.registerActionHandler(name, handler);
+  }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link this.registerActionHandlers()} instead.
+   * @deprecated
+   */
+  registerActions(handlers) {
+    this.registerActionHandlers(handlers);
+  }
+  /**
+   * 注册全局的 action handlers
+   *
+   * @param handlers
+   */
+  registerActionHandlers(handlers) {
+    for (const [name, handler] of Object.entries(handlers)) {
+      this.registerActionHandler(name, handler);
+    }
+  }
+  registerActionHandler(name, handler) {
+    this.actionHandlers.set(name, handler);
+  }
+  /**
+   * @internal
+   */
+  getRegisteredHandler(name) {
+    return this.actionHandlers.get(name);
+  }
+  /**
+   * @internal
+   */
+  getRegisteredHandlers() {
+    return this.actionHandlers;
+  }
+  /**
+   * @internal
+   */
+  getResource(name) {
+    if (!this.resources.has(name)) {
+      throw new Error(`${name} resource does not exist`);
+    }
+    return this.resources.get(name);
+  }
+  /**
+   * @internal
+   */
+  getAction(name, action) {
+    if (this.actionHandlers.has(`${name}:${action}`)) {
+      return this.getResource(name).getAction(`${name}:${action}`);
+    }
+    return this.getResource(name).getAction(action);
+  }
+  /**
+   * @internal
+   */
+  getMiddlewares() {
+    return this.middlewares.nodes;
+  }
+  use(middlewares, options = {}) {
+    this.middlewareSourceMap.set(middlewares, (0, import_utils.getCurrentStacks)());
+    this.middlewares.add(middlewares, options);
+  }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link this.middleware()} instead.
+   * @deprecated
+   */
+  restApiMiddleware({ prefix, accessors, skipIfDataSourceExists = false } = {}) {
+    return async (ctx, next) => {
+      if (skipIfDataSourceExists) {
+        const dataSource = ctx.get("x-data-source");
+        if (dataSource) {
+          return next();
+        }
+      }
+      ctx.resourcer = this;
+      let params = (0, import_utils2.parseRequest)(
+        {
+          path: ctx.request.path,
+          method: ctx.request.method
+        },
+        {
+          prefix: this.options.prefix || prefix,
+          accessors: this.options.accessors || accessors
+        }
+      );
+      if (!params) {
+        return next();
+      }
+      try {
+        const resource = this.getResource((0, import_utils2.getNameByParams)(params));
+        if (resource.options.type && resource.options.type !== "single") {
+          params = (0, import_utils2.parseRequest)(
+            {
+              path: ctx.request.path,
+              method: ctx.request.method,
+              type: resource.options.type
+            },
+            {
+              prefix: this.options.prefix || prefix,
+              accessors: this.options.accessors || accessors
+            }
+          );
+          if (!params) {
+            return next();
+          }
+        }
+        ctx.action = this.getAction((0, import_utils2.getNameByParams)(params), params.actionName).clone();
+        ctx.action.setContext(ctx);
+        ctx.action.actionName = params.actionName;
+        ctx.action.sourceId = params.associatedIndex;
+        ctx.action.resourceOf = params.associatedIndex;
+        ctx.action.resourceName = params.associatedName ? `${params.associatedName}.${params.resourceName}` : params.resourceName;
+        ctx.action.params.filterByTk = params.resourceIndex;
+        const query = (0, import_utils2.parseQuery)(ctx.request.querystring);
+        if ((0, import_path_to_regexp.pathToRegexp)("/resourcer/{:associatedName.}:resourceName{\\::actionName}").regexp.test(ctx.request.path)) {
+          ctx.action.mergeParams({
+            ...query,
+            ...params,
+            ...ctx.request.body
+          });
+        } else {
+          ctx.action.mergeParams({
+            ...query,
+            ...params,
+            ...import_lodash.default.isEmpty(ctx.request.body) ? {} : { values: ctx.request.body }
+          });
+        }
+        return (0, import_koa_compose.default)(ctx.action.getHandlers())(ctx, next);
+      } catch (error) {
+        console.log(error);
+        return next();
+      }
+    };
+  }
+  middleware(options = {}) {
+    return this.restApiMiddleware(options);
+  }
+  /**
+   * @internal
+   */
+  async execute(options, context = {}, next) {
+    const { resource, action } = options;
+    context.resourcer = this;
+    context.action = this.getAction(resource, action);
+    return await context.action.execute(context, next);
+  }
+};
+__name(_Resourcer, "Resourcer");
+let Resourcer = _Resourcer;
+var resourcer_default = Resourcer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Resourcer
+});

package/lib/utils.d.ts

@@ -0,0 +1,31 @@
+import { ResourceType } from './resource';
+export interface ParseRequest {
+    path: string;
+    method: string;
+    namespace?: string;
+    type?: ResourceType;
+}
+export interface ParseOptions {
+    prefix?: string;
+    accessors?: {
+        list?: string;
+        create?: string;
+        get?: string;
+        update?: string;
+        delete?: string;
+        set?: string;
+        add?: string;
+    };
+}
+export interface ParsedParams {
+    actionName?: string;
+    resourceName?: string;
+    resourceIndex?: string;
+    associatedName?: string;
+    associatedIndex?: string;
+}
+export declare function getNameByParams(params: ParsedParams): string;
+export declare function parseRequest(request: ParseRequest, options?: ParseOptions): ParsedParams | false;
+export declare function parseQuery(input: string): any;
+export declare function parseFields(fields: any): any;
+export declare function mergeFields(defaults: any, inputs: any): any;

package/lib/utils.js

@@ -0,0 +1,274 @@
+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 utils_exports = {};
+__export(utils_exports, {
+  getNameByParams: () => getNameByParams,
+  mergeFields: () => mergeFields,
+  parseFields: () => parseFields,
+  parseQuery: () => parseQuery,
+  parseRequest: () => parseRequest
+});
+module.exports = __toCommonJS(utils_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_path_to_regexp = require("path-to-regexp");
+var import_qs = __toESM(require("qs"));
+function getNameByParams(params) {
+  const { resourceName, associatedName } = params;
+  return associatedName ? `${associatedName}.${resourceName}` : resourceName;
+}
+__name(getNameByParams, "getNameByParams");
+function parseRequest(request, options = {}) {
+  const accessors = {
+    // 常规 actions
+    list: "list",
+    create: "create",
+    get: "get",
+    update: "update",
+    delete: "destroy",
+    // associate 操作
+    add: "add",
+    set: "set",
+    remove: "remove",
+    ...options.accessors || {}
+  };
+  const { regexp, keys } = (0, import_path_to_regexp.pathToRegexp)("/resourcer/{:associatedName.}:resourceName{\\::actionName}");
+  const reqPath = decodeURI(request.path);
+  const matches = regexp.exec(reqPath);
+  if (matches) {
+    const params2 = {};
+    keys.forEach((obj, index) => {
+      if (matches[index + 1] === void 0) {
+        return;
+      }
+      params2[obj.name] = matches[index + 1];
+    });
+    return params2;
+  }
+  const defaults = {
+    single: {
+      "/:resourceName": {
+        get: accessors.list,
+        post: accessors.create,
+        delete: accessors.delete
+      },
+      "/:resourceName/:resourceIndex": {
+        get: accessors.get,
+        put: accessors.update,
+        patch: accessors.update,
+        delete: accessors.delete
+      },
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.list,
+        post: accessors.create,
+        delete: accessors.delete
+      },
+      "/:associatedName/:associatedIndex/:resourceName/:resourceIndex": {
+        get: accessors.get,
+        post: accessors.create,
+        put: accessors.update,
+        patch: accessors.update,
+        delete: accessors.delete
+      }
+    },
+    hasOne: {
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.get,
+        post: accessors.update,
+        put: accessors.update,
+        patch: accessors.update,
+        delete: accessors.delete
+      }
+    },
+    hasMany: {
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.list,
+        post: accessors.create,
+        delete: accessors.delete
+      },
+      "/:associatedName/:associatedIndex/:resourceName/:resourceIndex": {
+        get: accessors.get,
+        post: accessors.create,
+        put: accessors.update,
+        patch: accessors.update,
+        delete: accessors.delete
+      }
+    },
+    belongsTo: {
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.get,
+        delete: accessors.remove
+      },
+      "/:associatedName/:associatedIndex/:resourceName/:resourceIndex": {
+        post: accessors.set
+      }
+    },
+    belongsToMany: {
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.list,
+        post: accessors.set
+      },
+      "/:associatedName/:associatedIndex/:resourceName/:resourceIndex": {
+        get: accessors.get,
+        post: accessors.add,
+        put: accessors.update,
+        // Many to Many 的 update 是针对 through
+        patch: accessors.update,
+        // Many to Many 的 update 是针对 through
+        delete: accessors.remove
+      }
+    },
+    set: {
+      "/:associatedName/:associatedIndex/:resourceName": {
+        get: accessors.list,
+        post: accessors.add,
+        delete: accessors.remove
+      }
+    }
+  };
+  const params = {};
+  let prefix = (options.prefix || "").trim().replace(/\/$/, "");
+  if (prefix && !prefix.startsWith("/")) {
+    prefix = `/${prefix}`;
+  }
+  const { type = "single" } = request;
+  for (const path in defaults[type]) {
+    const { regexp: regexp2, keys: keys2 } = (0, import_path_to_regexp.pathToRegexp)(`${prefix}${path}`);
+    const matches2 = regexp2.exec(reqPath);
+    if (!matches2) {
+      continue;
+    }
+    keys2.forEach((obj, index) => {
+      if (matches2[index + 1] === void 0) {
+        return;
+      }
+      params[obj.name] = matches2[index + 1];
+    });
+    params.actionName = import_lodash.default.get(defaults, [type, path, request.method.toLowerCase()]);
+  }
+  if (Object.keys(params).length === 0) {
+    return false;
+  }
+  if (params.resourceName) {
+    const [resourceName, actionName] = params.resourceName.split(/:|@/);
+    if (actionName) {
+      params.resourceName = resourceName;
+      params.actionName = actionName;
+    }
+  }
+  return params;
+}
+__name(parseRequest, "parseRequest");
+function parseQuery(input) {
+  const query = import_qs.default.parse(input, {
+    // 原始 query string 中如果一个键连等号“=”都没有可以被认为是 null 类型
+    strictNullHandling: true
+    // 逗号分隔转换为数组
+    // comma: true,
+  });
+  if (typeof query.filter === "string") {
+    query.filter = JSON.parse(query.filter);
+  }
+  return query;
+}
+__name(parseQuery, "parseQuery");
+function parseFields(fields) {
+  if (!fields) {
+    return {};
+  }
+  if (typeof fields === "string") {
+    fields = fields.split(",").map((field) => field.trim());
+  }
+  if (Array.isArray(fields)) {
+    const onlyFields = [];
+    const output = {};
+    fields.forEach((item) => {
+      if (typeof item === "string") {
+        onlyFields.push(item);
+      } else if (typeof item === "object") {
+        if (item.only) {
+          onlyFields.push(...item.only.toString().split(","));
+        }
+        Object.assign(output, parseFields(item));
+      }
+    });
+    if (onlyFields.length) {
+      output.only = onlyFields;
+    }
+    return output;
+  }
+  if (fields.only && typeof fields.only === "string") {
+    fields.only = fields.only.split(",").map((field) => field.trim());
+  }
+  if (fields.except && typeof fields.except === "string") {
+    fields.except = fields.except.split(",").map((field) => field.trim());
+  }
+  if (fields.appends && typeof fields.appends === "string") {
+    fields.appends = fields.appends.split(",").map((field) => field.trim());
+  }
+  return fields;
+}
+__name(parseFields, "parseFields");
+function mergeFields(defaults, inputs) {
+  let fields = {};
+  defaults = parseFields(defaults);
+  inputs = parseFields(inputs);
+  if (inputs.only) {
+    if (defaults.only) {
+      fields.only = defaults.only.filter((field) => inputs.only.includes(field));
+    } else if (defaults.except) {
+      fields.only = inputs.only.filter((field) => !defaults.except.includes(field));
+    } else {
+      fields.only = inputs.only;
+    }
+  } else if (inputs.except) {
+    if (defaults.only) {
+      fields.only = defaults.only.filter((field) => !inputs.except.includes(field));
+    } else {
+      fields.except = import_lodash.default.uniq([...inputs.except, ...defaults.except || []]);
+    }
+  } else {
+    fields = defaults;
+  }
+  if (!import_lodash.default.isEmpty(inputs.appends)) {
+    fields.appends = import_lodash.default.uniq([...inputs.appends, ...defaults.appends || []]);
+  }
+  if (!fields.appends) {
+    fields.appends = [];
+  }
+  return fields;
+}
+__name(mergeFields, "mergeFields");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getNameByParams,
+  mergeFields,
+  parseFields,
+  parseQuery,
+  parseRequest
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@tachybase/resourcer",
+  "version": "0.23.8",
+  "description": "",
+  "license": "Apache-2.0",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "dependencies": {
+    "deepmerge": "^4.3.1",
+    "glob": "^11.0.0",
+    "koa-compose": "^4.1.0",
+    "lodash": "^4.17.21",
+    "path-to-regexp": "8.2.0",
+    "qs": "^6.13.1",
+    "@tachybase/utils": "0.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "20.17.10"
+  },
+  "scripts": {
+    "build": "tachybase-build --no-dts @tachybase/resourcer"
+  }
+}