@modern-js/bff-core 2.69.4 → 3.0.0-alpha.0

package/dist/esm/router/index.js

@@ -1,261 +0,0 @@
-import path from "path";
-import { fs, logger } from "@modern-js/utils";
-import "reflect-metadata";
-import { HttpMethod, OperatorType, TriggerType, httpMethods } from "../types";
-import { INPUT_PARAMS_DECIDER, debug } from "../utils";
-import { APIMode, API_FILE_RULES, FRAMEWORK_MODE_APP_DIR, FRAMEWORK_MODE_LAMBDA_DIR } from "./constants";
-import { getFiles, getPathFromFilename, requireHandlerModule, sortRoutes } from "./utils";
-export * from "./types";
-export * from "./constants";
-class ApiRouter {
-  isExistLambda() {
-    return this.existLambdaDir;
-  }
-  getApiMode() {
-    return this.apiMode;
-  }
-  getLambdaDir() {
-    return this.lambdaDir;
-  }
-  isApiFile(filename) {
-    if (this.apiFiles.includes(filename)) {
-      return true;
-    }
-    return false;
-  }
-  async getSingleModuleHandlers(filename) {
-    const moduleInfo = await this.getModuleInfo(filename);
-    if (moduleInfo) {
-      return this.getModuleHandlerInfos(moduleInfo);
-    }
-    return null;
-  }
-  getHandlerInfo(filename, originFuncName, handler) {
-    const httpMethod = this.getHttpMethod(originFuncName, handler);
-    const routeName = this.getRouteName(filename, handler);
-    const action = this.getAction(handler);
-    const responseObj = {
-      handler,
-      name: originFuncName,
-      httpMethod,
-      routeName,
-      filename,
-      routePath: this.getRoutePath(this.prefix, routeName)
-    };
-    if (action) {
-      responseObj.action = action;
-    }
-    if (httpMethod && routeName) {
-      return responseObj;
-    }
-    return null;
-  }
-  // TODO: 性能提升，开发环境，判断下 lambda 目录修改时间
-  getSafeRoutePath(filename, handler) {
-    this.loadApiFiles();
-    this.validateValidApifile(filename);
-    return this.getRouteName(filename, handler);
-  }
-  getRouteName(filename, handler) {
-    if (handler) {
-      const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
-      if (trigger && trigger.type === TriggerType.Http) {
-        if (!trigger.path) {
-          throw new Error(`The http trigger ${trigger.name} needs to specify a path`);
-        }
-        return trigger.path;
-      }
-    }
-    let routePath = getPathFromFilename(this.lambdaDir, filename);
-    if (this.httpMethodDecider === "inputParams") {
-      if (routePath.endsWith("/")) {
-        routePath += `${handler === null || handler === void 0 ? void 0 : handler.name}`;
-      } else {
-        routePath += `/${handler === null || handler === void 0 ? void 0 : handler.name}`;
-      }
-    }
-    return routePath;
-  }
-  getHttpMethod(originHandlerName, handler) {
-    if (handler) {
-      const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
-      if (trigger && httpMethods.includes(trigger.method)) {
-        return trigger.method;
-      }
-    }
-    if (this.httpMethodDecider === "functionName") {
-      const upperName = originHandlerName.toUpperCase();
-      switch (upperName) {
-        case "GET":
-          return HttpMethod.Get;
-        case "POST":
-          return HttpMethod.Post;
-        case "PUT":
-          return HttpMethod.Put;
-        case "DELETE":
-        case "DEL":
-          return HttpMethod.Delete;
-        case "CONNECT":
-          return HttpMethod.Connect;
-        case "TRACE":
-          return HttpMethod.Trace;
-        case "PATCH":
-          return HttpMethod.Patch;
-        case "OPTIONS":
-          return HttpMethod.Options;
-        case "DEFAULT": {
-          return HttpMethod.Get;
-        }
-        default:
-          if (process.env.NODE_ENV !== "test") {
-            logger.warn(`Only api handlers are allowd to be exported, please remove the function ${originHandlerName} from exports`);
-          }
-          return null;
-      }
-    } else {
-      if (!handler) {
-        return null;
-      }
-      if (typeof handler === "function" && handler.length > 0) {
-        return HttpMethod.Post;
-      }
-      return HttpMethod.Get;
-    }
-  }
-  getAction(handler) {
-    if (handler) {
-      const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
-      if (trigger === null || trigger === void 0 ? void 0 : trigger.action) {
-        return trigger.action;
-      }
-    }
-  }
-  loadApiFiles() {
-    if (!this.existLambdaDir) {
-      return [];
-    }
-    const apiFiles = this.apiFiles = getFiles(this.lambdaDir, API_FILE_RULES);
-    return apiFiles;
-  }
-  getApiFiles() {
-    if (!this.existLambdaDir) {
-      return [];
-    }
-    if (this.apiFiles.length > 0) {
-      return this.apiFiles;
-    }
-    return this.loadApiFiles();
-  }
-  async getApiHandlers() {
-    const filenames = this.getApiFiles();
-    const moduleInfos = await this.getModuleInfos(filenames);
-    const apiHandlers = this.getHandlerInfos(moduleInfos);
-    debug("apiHandlers", apiHandlers.length, apiHandlers);
-    return apiHandlers;
-  }
-  /**
-  * 如果用户未传入或传入空串，默认为 /api
-  * 如果传入 /，则 prefix 为 /
-  */
-  initPrefix(prefix) {
-    if (prefix === "/") {
-      return "";
-    }
-    return prefix || "/api";
-  }
-  validateAbsolute(filename, paramsName) {
-    if (typeof filename === "string" && !path.isAbsolute(filename)) {
-      throw new Error(`The ${paramsName} ${filename} is not a abolute path`);
-    }
-  }
-  async getModuleInfos(filenames) {
-    return Promise.all(filenames.map((filename) => this.getModuleInfo(filename)).filter((moduleInfo) => Boolean(moduleInfo)));
-  }
-  async getModuleInfo(filename) {
-    try {
-      const module = await requireHandlerModule(filename);
-      return {
-        filename,
-        module
-      };
-    } catch (err) {
-      if (process.env.NODE_ENV === "production") {
-        throw err;
-      } else {
-        console.error(err);
-        return null;
-      }
-    }
-  }
-  getHandlerInfos(moduleInfos) {
-    let apiHandlers = [];
-    moduleInfos.forEach((moduleInfo) => {
-      const handlerInfos = this.getModuleHandlerInfos(moduleInfo);
-      if (handlerInfos) {
-        apiHandlers = apiHandlers.concat(handlerInfos);
-      }
-    });
-    const sortedHandlers = sortRoutes(apiHandlers);
-    return sortedHandlers;
-  }
-  getModuleHandlerInfos(moduleInfo) {
-    const { module, filename } = moduleInfo;
-    const { httpMethodDecider } = this;
-    return Object.entries(module).filter(([, handler]) => typeof handler === "function").map(([key]) => {
-      const handler = module[key];
-      if (httpMethodDecider === "inputParams") {
-        Object.assign(handler, {
-          [INPUT_PARAMS_DECIDER]: true
-        });
-      }
-      const handlerInfo = this.getHandlerInfo(filename, key, handler);
-      return handlerInfo;
-    }).filter((handlerInfo) => Boolean(handlerInfo));
-  }
-  validateValidApifile(filename) {
-    if (!this.apiFiles.includes(filename)) {
-      throw new Error(`The ${filename} is not a valid api file.`);
-    }
-  }
-  getRoutePath(prefix, routeName) {
-    const finalRouteName = routeName === "/" ? "" : routeName;
-    if (prefix === "" && finalRouteName === "") {
-      return "/";
-    }
-    return `${prefix}${finalRouteName}`;
-  }
-  constructor({ appDir, apiDir, lambdaDir, prefix, isBuild, httpMethodDecider = "functionName" }) {
-    this.apiFiles = [];
-    this.getExactApiMode = (apiDir2, lambdaDir2) => {
-      const exist = this.createExistChecker(apiDir2);
-      const existLambdaDir = lambdaDir2 && fs.pathExistsSync(lambdaDir2) || exist(FRAMEWORK_MODE_LAMBDA_DIR);
-      const existAppDir = exist(FRAMEWORK_MODE_APP_DIR);
-      const existAppFile = exist("app.ts") || exist("app.js");
-      if (existLambdaDir || existAppDir || existAppFile) {
-        return APIMode.FARMEWORK;
-      }
-      return APIMode.FUNCTION;
-    };
-    this.createExistChecker = (base) => (target) => fs.pathExistsSync(path.resolve(base, target));
-    this.getExactLambdaDir = (apiDir2, originLambdaDir) => {
-      if (this.apiMode === APIMode.FUNCTION) {
-        return apiDir2;
-      }
-      return originLambdaDir || path.join(apiDir2, FRAMEWORK_MODE_LAMBDA_DIR);
-    };
-    this.validateAbsolute(apiDir, "apiDir");
-    this.validateAbsolute(lambdaDir, "lambdaDir");
-    this.prefix = this.initPrefix(prefix);
-    this.appDir = appDir;
-    this.apiDir = apiDir;
-    this.httpMethodDecider = httpMethodDecider;
-    this.isBuild = isBuild;
-    this.apiMode = this.getExactApiMode(apiDir, lambdaDir);
-    this.lambdaDir = this.getExactLambdaDir(this.apiDir, lambdaDir);
-    this.existLambdaDir = fs.existsSync(this.lambdaDir);
-    debug(`apiDir:`, this.apiDir, `lambdaDir:`, this.lambdaDir);
-  }
-}
-export {
-  ApiRouter
-};

package/dist/esm/router/utils.js

@@ -1,62 +0,0 @@
-import path from "path";
-import { compatibleRequire, globby } from "@modern-js/utils";
-import { INDEX_SUFFIX } from "./constants";
-const getFiles = (lambdaDir, rules) => globby.sync(rules, {
-  cwd: lambdaDir,
-  gitignore: true
-}).map((file) => path.resolve(lambdaDir, file));
-const getPathFromFilename = (baseDir, filename) => {
-  const relativeName = filename.substring(baseDir.length);
-  const relativePath = relativeName.split(".").slice(0, -1).join(".");
-  const nameSplit = relativePath.split(path.sep).map((item) => {
-    if (item.length > 2) {
-      if (item.startsWith("[") && item.endsWith("]")) {
-        return `:${item.substring(1, item.length - 1)}`;
-      }
-    }
-    return item;
-  });
-  const name = nameSplit.join("/");
-  const finalName = name.endsWith(INDEX_SUFFIX) ? name.substring(0, name.length - INDEX_SUFFIX.length) : name;
-  return clearRouteName(finalName);
-};
-const clearRouteName = (routeName) => {
-  let finalRouteName = routeName.trim();
-  if (!finalRouteName.startsWith("/")) {
-    finalRouteName = `/${finalRouteName}`;
-  }
-  if (finalRouteName.length > 1 && finalRouteName.endsWith("/")) {
-    finalRouteName = finalRouteName.substring(0, finalRouteName.length - 1);
-  }
-  return finalRouteName;
-};
-const isHandler = (input) => input && typeof input === "function";
-const isFunction = (input) => input && {}.toString.call(input) === "[object Function]";
-const requireHandlerModule = async (modulePath) => {
-  const originRequire = process.env.NODE_ENV === "test" ? jest.requireActual : compatibleRequire;
-  const module = await originRequire(modulePath, false);
-  if (isFunction(module)) {
-    return {
-      default: module
-    };
-  }
-  return module;
-};
-const routeValue = (routePath) => {
-  if (routePath.includes(":")) {
-    return 11;
-  }
-  return 1;
-};
-const sortRoutes = (apiHandlers) => {
-  return apiHandlers.sort((handlerA, handlerB) => {
-    return routeValue(handlerA.routeName) - routeValue(handlerB.routeName);
-  });
-};
-export {
-  getFiles,
-  getPathFromFilename,
-  isHandler,
-  requireHandlerModule,
-  sortRoutes
-};

package/dist/esm/types.js

@@ -1,46 +0,0 @@
-var OperatorType;
-(function(OperatorType2) {
-  OperatorType2[OperatorType2["Trigger"] = 0] = "Trigger";
-  OperatorType2[OperatorType2["Middleware"] = 1] = "Middleware";
-})(OperatorType || (OperatorType = {}));
-var TriggerType;
-(function(TriggerType2) {
-  TriggerType2[TriggerType2["Http"] = 0] = "Http";
-})(TriggerType || (TriggerType = {}));
-var HttpMetadata;
-(function(HttpMetadata2) {
-  HttpMetadata2["Method"] = "METHOD";
-  HttpMetadata2["Data"] = "DATA";
-  HttpMetadata2["Query"] = "QUERY";
-  HttpMetadata2["Params"] = "PARAMS";
-  HttpMetadata2["Headers"] = "HEADERS";
-  HttpMetadata2["Response"] = "RESPONSE";
-  HttpMetadata2["Files"] = "Files";
-})(HttpMetadata || (HttpMetadata = {}));
-var ResponseMetaType;
-(function(ResponseMetaType2) {
-  ResponseMetaType2[ResponseMetaType2["StatusCode"] = 0] = "StatusCode";
-  ResponseMetaType2[ResponseMetaType2["Redirect"] = 1] = "Redirect";
-  ResponseMetaType2[ResponseMetaType2["Headers"] = 2] = "Headers";
-})(ResponseMetaType || (ResponseMetaType = {}));
-var HttpMethod;
-(function(HttpMethod2) {
-  HttpMethod2["Get"] = "GET";
-  HttpMethod2["Post"] = "POST";
-  HttpMethod2["Put"] = "PUT";
-  HttpMethod2["Delete"] = "DELETE";
-  HttpMethod2["Connect"] = "CONNECT";
-  HttpMethod2["Trace"] = "TRACE";
-  HttpMethod2["Patch"] = "PATCH";
-  HttpMethod2["Options"] = "OPTIONS";
-  HttpMethod2["Head"] = "HEAD";
-})(HttpMethod || (HttpMethod = {}));
-const httpMethods = Object.values(HttpMethod);
-export {
-  HttpMetadata,
-  HttpMethod,
-  OperatorType,
-  ResponseMetaType,
-  TriggerType,
-  httpMethods
-};

package/dist/esm/utils/alias.js

@@ -1,75 +0,0 @@
-import fs from "fs";
-import Module from "module";
-import * as os from "os";
-import * as path from "path";
-const getRelativeRuntimePath = (appDirectory, serverRuntimePath) => {
-  let relativeRuntimePath = "";
-  if (os.platform() === "win32") {
-    relativeRuntimePath = `../${path.relative(appDirectory, serverRuntimePath)}`;
-  } else {
-    relativeRuntimePath = path.join("../", path.relative(appDirectory, serverRuntimePath));
-  }
-  if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
-    relativeRuntimePath = `./${path.relative(appDirectory, serverRuntimePath)}`;
-  }
-  return relativeRuntimePath;
-};
-const sortByLongestPrefix = (arr) => {
-  return arr.concat().sort((a, b) => b.length - a.length);
-};
-const createMatchPath = (paths) => {
-  const sortedKeys = sortByLongestPrefix(Object.keys(paths));
-  const sortedPaths = {};
-  sortedKeys.forEach((key) => {
-    sortedPaths[key] = paths[key];
-  });
-  return (request) => {
-    const found = Object.keys(sortedPaths).find((key) => {
-      return request.startsWith(key);
-    });
-    if (found) {
-      let foundPaths = sortedPaths[found];
-      if (!Array.isArray(foundPaths)) {
-        foundPaths = [
-          foundPaths
-        ];
-      }
-      foundPaths = foundPaths.filter((foundPath) => path.isAbsolute(foundPath));
-      for (const p of foundPaths) {
-        const foundPath = request.replace(found, p);
-        if (fs.existsSync(foundPath)) {
-          return foundPath;
-        }
-      }
-      return request.replace(found, foundPaths[0]);
-    }
-    return null;
-  };
-};
-const registerPaths = (paths) => {
-  const originalResolveFilename = Module._resolveFilename;
-  const { builtinModules } = Module;
-  const matchPath = createMatchPath(paths);
-  Module._resolveFilename = function(request, _parent) {
-    const isCoreModule = builtinModules.includes(request);
-    if (!isCoreModule) {
-      const matched = matchPath(request);
-      if (matched) {
-        const modifiedArguments = [
-          matched,
-          ...[].slice.call(arguments, 1)
-        ];
-        return originalResolveFilename.apply(this, modifiedArguments);
-      }
-    }
-    return originalResolveFilename.apply(this, arguments);
-  };
-  return () => {
-    Module._resolveFilename = originalResolveFilename;
-  };
-};
-export {
-  createMatchPath,
-  getRelativeRuntimePath,
-  registerPaths
-};

package/dist/esm/utils/debug.js

@@ -1,5 +0,0 @@
-import { createDebugger } from "@modern-js/utils";
-const debug = createDebugger("bff");
-export {
-  debug
-};

package/dist/esm/utils/meta.js

@@ -1,14 +0,0 @@
-const HANDLER_WITH_META = "HANDLER_WITH_META";
-const INPUT_PARAMS_DECIDER = "INPUT_PARAMS_DECIDER";
-const isWithMetaHandler = (handler) => {
-  return typeof handler === "function" && handler[HANDLER_WITH_META];
-};
-const isInputParamsDeciderHandler = (handler) => {
-  return typeof handler === "function" && handler[INPUT_PARAMS_DECIDER];
-};
-export {
-  HANDLER_WITH_META,
-  INPUT_PARAMS_DECIDER,
-  isInputParamsDeciderHandler,
-  isWithMetaHandler
-};

package/dist/esm/utils/storage.js

@@ -1,40 +0,0 @@
-import * as ah from "async_hooks";
-const createStorage = () => {
-  let storage;
-  if (typeof ah.AsyncLocalStorage !== "undefined") {
-    storage = new ah.AsyncLocalStorage();
-  }
-  const run = (context, cb) => {
-    if (!storage) {
-      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
-        `);
-    }
-    return new Promise((resolve, reject) => {
-      storage.run(context, () => {
-        try {
-          return resolve(cb());
-        } catch (error) {
-          return reject(error);
-        }
-      });
-    });
-  };
-  const useContext = () => {
-    if (!storage) {
-      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
-        `);
-    }
-    const context = storage.getStore();
-    if (!context) {
-      throw new Error(`Can't call useContext out of scope, it should be placed in the bff function`);
-    }
-    return context;
-  };
-  return {
-    run,
-    useContext
-  };
-};
-export {
-  createStorage
-};

package/dist/esm/utils/validate.js

@@ -1,45 +0,0 @@
-import util from "util";
-const getTypeErrorMessage = (actual) => {
-  let msg = "";
-  if (actual == null) {
-    msg += `. Received ${actual}`;
-  } else if (typeof actual === "function" && actual.name) {
-    msg += `. Received function ${actual.name}`;
-  } else if (typeof actual === "object") {
-    var _actual_constructor;
-    if ((_actual_constructor = actual.constructor) === null || _actual_constructor === void 0 ? void 0 : _actual_constructor.name) {
-      msg += `. Received an instance of ${actual.constructor.name}`;
-    } else {
-      const inspected = util.inspect(actual, {
-        depth: -1
-      });
-      msg += `. Received ${inspected}`;
-    }
-  } else {
-    let inspected = util.inspect(actual, {
-      colors: false
-    });
-    if (inspected.length > 25) {
-      inspected = `${inspected.slice(0, 25)}...`;
-    }
-    msg += `. Received type ${typeof actual} (${inspected})`;
-  }
-  return msg;
-};
-class ERR_INVALID_ARG_TYPE extends Error {
-  constructor(funcName, expectedType, actual) {
-    const message = `[ERR_INVALID_ARG_TYPE]: The '${funcName}' argument must be of type ${expectedType}${getTypeErrorMessage(actual)}`;
-    super(message);
-  }
-}
-const validateFunction = (maybeFunc, name) => {
-  if (typeof maybeFunc !== "function") {
-    throw new ERR_INVALID_ARG_TYPE(name, "function", maybeFunc);
-  }
-  return true;
-};
-export {
-  ERR_INVALID_ARG_TYPE,
-  getTypeErrorMessage,
-  validateFunction
-};