@modern-js/bff-core 2.4.1-beta.0 → 2.5.1-alpha.0

package/dist/esm/router/index.js

@@ -0,0 +1,260 @@
+import path from "path";
+import { fs, logger } from "@modern-js/utils";
+import "reflect-metadata";
+import { HttpMethod, httpMethods, OperatorType, TriggerType } from "../types";
+import { debug, INPUT_PARAMS_DECIDER } from "../utils";
+import {
+  APIMode,
+  FRAMEWORK_MODE_LAMBDA_DIR,
+  API_FILE_RULES,
+  FRAMEWORK_MODE_APP_DIR
+} from "./constants";
+import {
+  getFiles,
+  getPathFromFilename,
+  requireHandlerModule,
+  sortRoutes
+} from "./utils";
+export * from "./types";
+export * from "./constants";
+class ApiRouter {
+  constructor({
+    apiDir,
+    lambdaDir,
+    prefix,
+    httpMethodDecider = "functionName"
+  }) {
+    this.apiFiles = [];
+    this.getExactApiMode = (apiDir) => {
+      const exist = this.createExistChecker(apiDir);
+      const existLambdaDir = 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 = (apiDir) => {
+      if (this.lambdaDir) {
+        return this.lambdaDir;
+      }
+      const lambdaDir = this.apiMode === APIMode.FARMEWORK ? path.join(apiDir, FRAMEWORK_MODE_LAMBDA_DIR) : apiDir;
+      return lambdaDir;
+    };
+    this.validateAbsolute(apiDir, "apiDir");
+    this.validateAbsolute(lambdaDir, "lambdaDir");
+    this.prefix = this.initPrefix(prefix);
+    this.apiDir = apiDir;
+    this.apiMode = this.getExactApiMode(apiDir);
+    this.httpMethodDecider = httpMethodDecider;
+    this.lambdaDir = lambdaDir || this.getExactLambdaDir(this.apiDir);
+    this.existLambdaDir = fs.existsSync(this.lambdaDir);
+  }
+  isExistLambda() {
+    return this.existLambdaDir;
+  }
+  getApiMode() {
+    return this.apiMode;
+  }
+  getLambdaDir() {
+    return this.lambdaDir;
+  }
+  isApiFile(filename) {
+    if (this.existLambdaDir) {
+      return false;
+    }
+    if (!this.apiFiles.includes(filename)) {
+      return false;
+    }
+    return true;
+  }
+  getSingleModuleHandlers(filename) {
+    const moduleInfo = 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);
+    if (httpMethod && routeName) {
+      return {
+        handler,
+        name: originFuncName,
+        httpMethod,
+        routeName,
+        filename,
+        routePath: this.getRoutePath(this.prefix, routeName)
+      };
+    }
+    return null;
+  }
+  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 ? void 0 : handler.name}`;
+      } else {
+        routePath += `/${handler == null ? 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 "OPTION":
+          return HttpMethod.Option;
+        case "DEFAULT": {
+          return HttpMethod.Get;
+        }
+        default:
+          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;
+    }
+  }
+  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();
+  }
+  getApiHandlers() {
+    const filenames = this.getApiFiles();
+    const moduleInfos = this.getModuleInfos(filenames);
+    const apiHandlers = this.getHandlerInfos(moduleInfos);
+    debug("apiHandlers", apiHandlers.length, apiHandlers);
+    return apiHandlers;
+  }
+  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`);
+    }
+  }
+  getModuleInfos(filenames) {
+    return filenames.map((filename) => this.getModuleInfo(filename)).filter((moduleInfo) => Boolean(moduleInfo));
+  }
+  getModuleInfo(filename) {
+    try {
+      const module = 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}`;
+  }
+}
+export {
+  ApiRouter
+};

package/dist/esm/router/utils.js

@@ -0,0 +1,83 @@
+import path from "path";
+import { 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 enableRegister = (requireFn) => {
+  let existTsLoader = false;
+  let firstCall = true;
+  return (modulePath) => {
+    if (firstCall) {
+      existTsLoader = Boolean(require.extensions[".ts"]);
+      firstCall = false;
+    }
+    if (!existTsLoader) {
+      const {
+        register
+      } = require("esbuild-register/dist/node");
+      const { unregister } = register({
+        extensions: [".ts"]
+      });
+      const requiredModule2 = requireFn(modulePath);
+      unregister();
+      return requiredModule2;
+    }
+    const requiredModule = requireFn(modulePath);
+    return requiredModule;
+  };
+};
+const isFunction = (input) => input && {}.toString.call(input) === "[object Function]";
+const requireHandlerModule = enableRegister((modulePath) => {
+  const originRequire = process.env.NODE_ENV === "test" ? jest.requireActual : require;
+  const module = originRequire(modulePath);
+  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

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

package/dist/esm/utils/alias.js

@@ -0,0 +1,76 @@
+import * as path from "path";
+import * as os from "os";
+import fs from "fs";
+import Module from "module";
+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

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

package/dist/esm/utils/index.js

@@ -0,0 +1,8 @@
+export * from "./storage";
+export * from "./alias";
+import { debug } from "./debug";
+export * from "./meta";
+export * from "./validate";
+export {
+  debug
+};

package/dist/esm/utils/meta.js

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,43 @@
+import util from "util";
+const getTypeErrorMessage = (actual) => {
+  var _a;
+  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") {
+    if ((_a = actual.constructor) == null ? void 0 : _a.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
+};

package/dist/types/client/generate-client.d.ts

@@ -1,3 +1,4 @@
+import type { HttpMethodDecider } from '@modern-js/types';
 import { Result } from './result';
 export type GenClientResult = Result<string>;
 export type GenClientOptions = {
@@ -10,6 +11,7 @@ export type GenClientOptions = {
   fetcher?: string;
   target?: string;
   requireResolve?: typeof require.resolve;
+  httpMethodDecider: HttpMethodDecider;
 };
 export declare const DEFAULT_CLIENT_REQUEST_CREATOR = "@modern-js/create-request";
 export declare const generateClient: ({
@@ -20,5 +22,6 @@ export declare const generateClient: ({
   target,
   requestCreator,
   fetcher,
-  requireResolve
+  requireResolve,
+  httpMethodDecider
 }: GenClientOptions) => Promise<GenClientResult>;

package/dist/types/index.d.ts

@@ -4,4 +4,4 @@ export * from './router';
 export * from './types';
 export * from './client';
 export * from './operators/http';
-export { getRelativeRuntimePath, HANDLER_WITH_META, isWithMetaHandler, createStorage, registerPaths } from './utils';
+export { getRelativeRuntimePath, HANDLER_WITH_META, isWithMetaHandler, INPUT_PARAMS_DECIDER, isInputParamsDeciderHandler, createStorage, registerPaths } from './utils';

package/dist/types/router/index.d.ts

@@ -1,4 +1,5 @@
 import 'reflect-metadata';
+import type { HttpMethodDecider } from '@modern-js/types';
 import { HttpMethod } from '../types';
 import { APIMode } from './constants';
 import { ApiHandler, APIHandlerInfo } from './types';
@@ -8,17 +9,20 @@ export declare class ApiRouter {
   private apiMode;
   private apiDir;
   private existLambdaDir;
+  private httpMethodDecider;
   private lambdaDir;
   private prefix;
   private apiFiles;
   constructor({
     apiDir,
     lambdaDir,
-    prefix
+    prefix,
+    httpMethodDecider
   }: {
     apiDir: string;
     lambdaDir?: string;
     prefix?: string;
+    httpMethodDecider?: HttpMethodDecider;
   });
   isExistLambda(): boolean;
   getApiMode(): APIMode;

package/dist/types/utils/meta.d.ts

@@ -1,2 +1,4 @@
 export declare const HANDLER_WITH_META = "HANDLER_WITH_META";
-export declare const isWithMetaHandler: (handler: any) => any;
+export declare const INPUT_PARAMS_DECIDER = "INPUT_PARAMS_DECIDER";
+export declare const isWithMetaHandler: (handler: any) => any;
+export declare const isInputParamsDeciderHandler: (handler: any) => any;