@modern-js/bff-core 1.0.1-beta.0

package/dist/js/modern/router/index.js

@@ -0,0 +1,271 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import { fs, logger } from '@modern-js/utils';
+import 'reflect-metadata';
+import 'esbuild-register';
+import { HttpMethod, httpMethods, OperatorType, TriggerType } from "../types";
+import { APIMode, FRAMEWORK_MODE_LAMBDA_DIR, API_FILE_RULES } from "./constants";
+import { getFiles, getPathFromFilename, requireHandlerModule } from "./utils";
+export * from "./types";
+export * from "./constants";
+export class ApiRouter {
+  constructor({
+    apiDir: _apiDir,
+    lambdaDir: _lambdaDir,
+    prefix
+  }) {
+    _defineProperty(this, "apiDir", void 0);
+
+    _defineProperty(this, "lambdaDir", void 0);
+
+    _defineProperty(this, "prefix", void 0);
+
+    _defineProperty(this, "apiFiles", void 0);
+
+    _defineProperty(this, "getAPIMode", apiDir => {
+      const exist = this.createExistChecker(apiDir);
+
+      if (exist(FRAMEWORK_MODE_LAMBDA_DIR)) {
+        return APIMode.FARMEWORK;
+      }
+
+      return APIMode.FUNCTION;
+    });
+
+    _defineProperty(this, "createExistChecker", base => target => fs.pathExistsSync(path.resolve(base, target)));
+
+    _defineProperty(this, "getLambdaDir", apiDir => {
+      if (this.lambdaDir) {
+        return this.lambdaDir;
+      }
+
+      const mode = this.getAPIMode(apiDir);
+      const lambdaDir = mode === APIMode.FARMEWORK ? path.join(apiDir, FRAMEWORK_MODE_LAMBDA_DIR) : apiDir;
+      return lambdaDir;
+    });
+
+    this.apiFiles = [];
+
+    if (_apiDir) {
+      this.validateAbsolute(_apiDir, 'apiDir');
+    }
+
+    if (_lambdaDir) {
+      this.validateAbsolute(_lambdaDir, 'lambdaDir');
+    }
+
+    this.prefix = this.initPrefix(prefix);
+    this.apiDir = _apiDir;
+    this.lambdaDir = _lambdaDir || this.getLambdaDir(this.apiDir);
+  }
+  /**
+   * 如果用户未传入或传入空串，默认为 /api
+   * 如果传入 /，则 prefix 为 /
+   */
+
+
+  initPrefix(prefix) {
+    if (prefix === '/') {
+      return '';
+    }
+
+    return prefix || '/api';
+  }
+
+  validateAbsolute(filename, paramsName) {
+    if (!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);
+      }
+    });
+    return apiHandlers;
+  }
+
+  getModuleHandlerInfos(moduleInfo) {
+    const {
+      module,
+      filename
+    } = moduleInfo;
+    return Object.entries(module).filter(([, handler]) => typeof handler === 'function').map(([key]) => {
+      const handler = module[key];
+      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}`;
+  }
+
+  isApiFile(filename) {
+    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;
+  } // 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;
+      }
+    }
+
+    const routePath = getPathFromFilename(this.lambdaDir, filename);
+    return routePath;
+  }
+
+  getHttpMethod(originHandlerName, handler) {
+    if (handler) {
+      const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
+
+      if (trigger && httpMethods.includes(trigger.method)) {
+        return trigger.method;
+      }
+    }
+
+    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;
+    }
+  }
+
+  loadApiFiles() {
+    // eslint-disable-next-line no-multi-assign
+    const apiFiles = this.apiFiles = getFiles(this.lambdaDir, API_FILE_RULES);
+    return apiFiles;
+  }
+
+  getApiFiles() {
+    if (this.apiFiles.length > 0) {
+      return this.apiFiles;
+    }
+
+    return this.loadApiFiles();
+  }
+
+  getApiHandlers() {
+    const filenames = this.getApiFiles();
+    const moduleInfos = this.getModuleInfos(filenames);
+    return this.getHandlerInfos(moduleInfos);
+  }
+
+}

package/dist/js/modern/router/types.js

@@ -0,0 +1 @@
+export {};

package/dist/js/modern/router/utils.js

@@ -0,0 +1,53 @@
+import path from 'path';
+import { globby } from '@modern-js/utils';
+import { INDEX_SUFFIX } from "./constants";
+export const getFiles = (lambdaDir, rules) => globby.sync(rules, {
+  cwd: lambdaDir,
+  gitignore: true
+}).map(file => path.resolve(lambdaDir, file));
+export 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;
+};
+
+export const isHandler = input => input && typeof input === 'function';
+
+const isFunction = input => input && {}.toString.call(input) === '[object Function]';
+
+export const requireHandlerModule = modulePath => {
+  const module = require(modulePath);
+
+  if (isFunction(module)) {
+    return {
+      default: module
+    };
+  }
+
+  return module;
+};

package/dist/js/modern/types.js

@@ -0,0 +1,42 @@
+export let OperatorType;
+
+(function (OperatorType) {
+  OperatorType[OperatorType["Trigger"] = 0] = "Trigger";
+  OperatorType[OperatorType["Middleware"] = 1] = "Middleware";
+})(OperatorType || (OperatorType = {}));
+
+export let TriggerType;
+
+(function (TriggerType) {
+  TriggerType[TriggerType["Http"] = 0] = "Http";
+})(TriggerType || (TriggerType = {}));
+
+export let HttpMetadata;
+
+(function (HttpMetadata) {
+  HttpMetadata["Method"] = "METHOD";
+  HttpMetadata["Data"] = "DATA";
+  HttpMetadata["Query"] = "QUERY";
+  HttpMetadata["Params"] = "PARAMS";
+  HttpMetadata["Headers"] = "HEADERS";
+  HttpMetadata["Response"] = "RESPONSE";
+  HttpMetadata["StatusCode"] = "STATUS_CODE";
+  HttpMetadata["Redirect"] = "REDIRECT";
+  HttpMetadata["ResponseHeaders"] = "RESPONSE_HEADERS";
+})(HttpMetadata || (HttpMetadata = {}));
+
+export let HttpMethod;
+
+(function (HttpMethod) {
+  HttpMethod["Get"] = "GET";
+  HttpMethod["Post"] = "POST";
+  HttpMethod["Put"] = "PUT";
+  HttpMethod["Delete"] = "DELETE";
+  HttpMethod["Connect"] = "CONNECT";
+  HttpMethod["Trace"] = "TRACE";
+  HttpMethod["Patch"] = "PATCH";
+  HttpMethod["Option"] = "OPTION";
+  HttpMethod["Head"] = "HEAD";
+})(HttpMethod || (HttpMethod = {}));
+
+export const httpMethods = Object.values(HttpMethod);

package/dist/js/modern/utils.js

@@ -0,0 +1,61 @@
+import util from 'util';
+export const HANDLER_WITH_META = 'HANDLER_WITH_SCHEMA'; // export const pick = <T extends Record<string, unknown>, K extends keyof T>(
+//   obj: T,
+//   keys: readonly K[],
+// ) => {
+//   Object.entries(obj).filter(([key]) => {
+//     return (keys as readonly string[]).includes(key);
+//   });
+// };
+// fork from https://github.com/nodejs/node/blob/master/lib/internal/errors.js
+
+export 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 && _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;
+}; // eslint-disable-next-line @typescript-eslint/naming-convention
+
+export 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);
+  }
+
+}
+export const validateFunction = (maybeFunc, name) => {
+  if (typeof maybeFunc !== 'function') {
+    throw new ERR_INVALID_ARG_TYPE(name, 'function', maybeFunc);
+  }
+
+  return true;
+};
+export const isWithMetaHandler = handler => {
+  return typeof handler === 'function' && handler[HANDLER_WITH_META];
+};

package/dist/js/node/api.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Api = Api;
+
+require("reflect-metadata");
+
+var _koaCompose = _interopRequireDefault(require("koa-compose"));
+
+var _utils = require("./utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function Api(...args) {
+  const handler = args.pop();
+  (0, _utils.validateFunction)(handler, 'Apihandler');
+  const operators = args;
+  const metadataHelper = {
+    getMetadata(key) {
+      return Reflect.getMetadata(key, runner);
+    },
+
+    setMetadata(key, value) {
+      return Reflect.defineMetadata(key, value, runner);
+    }
+
+  };
+
+  for (const operator of operators) {
+    if (operator.metadata) {
+      operator.metadata(metadataHelper);
+    }
+  }
+
+  const validateHandlers = operators.filter(operator => operator.validate).map(operator => operator.validate);
+
+  async function runner(inputs) {
+    // 错误组合传给用户哪些信息？
+    // 取出来所有的 schema，然后做校验
+    // 包裹中间件，怎么根据不同框架去包裹?
+    // 需要满足的需求，可以关闭某一样 schema 的校验
+    // 可以关闭某一个字段的校验
+    // 可以设置校验函数以替换 zod ？类型怎么搞?
+    // 全局可配置校验函数
+    // middleware 多框架实现要支持在路由上配，但这样 middleware 就要在校验之前先执行了
+    // 简易模式适配怎么处理?
+    // 不同框架适配，响应怎么处理？都传入 co ntext 给这个函数？
+    // 如何不依赖 zod 库？支持用户自定义 schema 库？ Query，Data 实现可以统一代码，类型好像无解，除非这些函数是创建出来的，保证只有 http 中依赖 zod 吧
+    const executeHelper = {
+      result: null,
+
+      get inputs() {
+        return inputs;
+      }
+
+    };
+    const stack = [...validateHandlers];
+    stack.push(async (helper, next) => {
+      const res = await handler(inputs);
+      helper.result = res;
+      return next();
+    });
+    await (0, _koaCompose.default)(stack)(executeHelper);
+    return executeHelper.result;
+  }
+
+  runner[_utils.HANDLER_WITH_META] = true;
+  return runner;
+}

package/dist/js/node/client/generate-client.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateClient = exports.DEFAULT_CLIENT_REQUEST_CREATOR = void 0;
+
+var path = _interopRequireWildcard(require("path"));
+
+var _router = require("../router");
+
+var _result = require("./result");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const DEFAULT_CLIENT_REQUEST_CREATOR = '@modern-js/create-request';
+exports.DEFAULT_CLIENT_REQUEST_CREATOR = DEFAULT_CLIENT_REQUEST_CREATOR;
+
+const generateClient = async ({
+  resourcePath,
+  apiDir,
+  prefix,
+  port,
+  target,
+  requestCreator,
+  fetcher,
+  requireResolve: _requireResolve = require.resolve
+}) => {
+  if (!requestCreator) {
+    // eslint-disable-next-line no-param-reassign
+    requestCreator = _requireResolve(`${DEFAULT_CLIENT_REQUEST_CREATOR}${target ? `/${target}` : ''}`).replace(/\\/g, '/');
+  } else {
+    // 这里约束传入的 requestCreator 包也必须有两个导出 client 和 server，因为目前的机制 client 和 server 要导出不同的 configure 函数；该 api 不对使用者暴露，后续可优化
+    let resolvedPath = requestCreator;
+
+    try {
+      resolvedPath = path.dirname(_requireResolve(requestCreator));
+    } catch (error) {} // eslint-disable-next-line no-param-reassign
+
+
+    requestCreator = `${resolvedPath}${target ? `/${target}` : ''}`.replace(/\\/g, '/');
+  }
+
+  const apiRouter = new _router.ApiRouter({
+    apiDir,
+    prefix,
+    lambdaDir: apiDir
+  });
+  const handlerInfos = apiRouter.getSingleModuleHandlers(resourcePath);
+
+  if (!handlerInfos) {
+    return (0, _result.Err)(`Cannot require module ${resourcePath}`);
+  }
+
+  let handlersCode = '';
+
+  for (const handlerInfo of handlerInfos) {
+    const {
+      name,
+      httpMethod,
+      routePath
+    } = handlerInfo;
+    let exportStatement = `const ${name} =`;
+
+    if (name.toLowerCase() === 'default') {
+      exportStatement = 'default';
+    }
+
+    const upperHttpMethod = httpMethod.toUpperCase();
+    const routeName = routePath;
+    handlersCode += `export ${exportStatement} createRequest('${routeName}', '${upperHttpMethod}', process.env.PORT || ${String(port)}${fetcher ? `, fetch` : ''});
+`;
+  }
+
+  const importCode = `import { createRequest } from '${requestCreator}';
+${fetcher ? `import { fetch } from '${fetcher}';\n` : ''}`;
+  return (0, _result.Ok)(`${importCode}\n${handlersCode}`);
+};
+
+exports.generateClient = generateClient;

package/dist/js/node/client/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _generateClient = require("./generate-client");
+
+Object.keys(_generateClient).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _generateClient[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _generateClient[key];
+    }
+  });
+});

package/dist/js/node/client/result.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Ok = exports.Err = void 0;
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Err = value => {
+  const err = {
+    kind: 'Err',
+    value,
+    isErr: true,
+    isOk: false
+  };
+  return err;
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+
+exports.Err = Err;
+
+const Ok = value => {
+  const ok = {
+    kind: 'Ok',
+    value,
+    isErr: false,
+    isOk: true
+  };
+  return ok;
+};
+
+exports.Ok = Ok;

package/dist/js/node/errors/http.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ValidationError = exports.HttpError = void 0;
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+class HttpError extends Error {
+  constructor(status, message) {
+    super(message);
+
+    _defineProperty(this, "status", void 0);
+
+    this.status = status;
+  }
+
+}
+
+exports.HttpError = HttpError;
+
+class ValidationError extends HttpError {}
+
+exports.ValidationError = ValidationError;