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

package/dist/js/node/index.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  Api: true,
+  HttpError: true,
+  ValidationError: true
+};
+Object.defineProperty(exports, "Api", {
+  enumerable: true,
+  get: function () {
+    return _api.Api;
+  }
+});
+Object.defineProperty(exports, "HttpError", {
+  enumerable: true,
+  get: function () {
+    return _http.HttpError;
+  }
+});
+Object.defineProperty(exports, "ValidationError", {
+  enumerable: true,
+  get: function () {
+    return _http.ValidationError;
+  }
+});
+
+var _api = require("./api");
+
+var _http = require("./errors/http");
+
+var _router = require("./router");
+
+Object.keys(_router).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _router[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _router[key];
+    }
+  });
+});
+
+var _types = require("./types");
+
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+
+var _utils = require("./utils");
+
+Object.keys(_utils).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _utils[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _utils[key];
+    }
+  });
+});
+
+var _client = require("./client");
+
+Object.keys(_client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _client[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _client[key];
+    }
+  });
+});
+
+var _http2 = require("./operators/http");
+
+Object.keys(_http2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _http2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _http2[key];
+    }
+  });
+});

package/dist/js/node/operators/http.js

@@ -0,0 +1,227 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createHttpOperator = exports.Trace = exports.SetHeaders = exports.Redirect = exports.Query = exports.Put = exports.Post = exports.Patch = exports.Params = exports.Option = exports.Middleware = exports.HttpCode = exports.Headers = exports.Head = exports.Get = exports.Delete = exports.Data = exports.Connect = void 0;
+
+var _zod = require("zod");
+
+var _types = require("../types");
+
+var _http = require("../errors/http");
+
+const validateInput = async (schema, input) => {
+  try {
+    await schema.parseAsync(input);
+  } catch (error) {
+    if (error instanceof _zod.z.ZodError) {
+      throw new _http.ValidationError(400, error.message);
+    }
+
+    throw error;
+  }
+};
+
+const createHttpOperator = method => {
+  return urlPath => {
+    return {
+      name: method,
+
+      metadata({
+        setMetadata
+      }) {
+        setMetadata(_types.OperatorType.Trigger, {
+          type: _types.TriggerType.Http,
+          path: urlPath,
+          method
+        });
+      }
+
+    };
+  };
+};
+
+exports.createHttpOperator = createHttpOperator;
+const Get = createHttpOperator(_types.HttpMethod.Get);
+exports.Get = Get;
+const Post = createHttpOperator(_types.HttpMethod.Post);
+exports.Post = Post;
+const Put = createHttpOperator(_types.HttpMethod.Put);
+exports.Put = Put;
+const Delete = createHttpOperator(_types.HttpMethod.Delete);
+exports.Delete = Delete;
+const Connect = createHttpOperator(_types.HttpMethod.Connect);
+exports.Connect = Connect;
+const Trace = createHttpOperator(_types.HttpMethod.Trace);
+exports.Trace = Trace;
+const Patch = createHttpOperator(_types.HttpMethod.Patch);
+exports.Patch = Patch;
+const Option = createHttpOperator(_types.HttpMethod.Option);
+exports.Option = Option;
+const Head = createHttpOperator(_types.HttpMethod.Head);
+exports.Head = Head;
+
+const Data = schema => {
+  return {
+    name: _types.HttpMetadata.Data,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.Data, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        data
+      } = inputs;
+      await validateInput(schema, data);
+      return next();
+    }
+
+  };
+};
+
+exports.Data = Data;
+
+const Query = schema => {
+  return {
+    name: _types.HttpMetadata.Query,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.Query, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        query
+      } = inputs;
+      await validateInput(schema, query);
+      return next();
+    }
+
+  };
+};
+
+exports.Query = Query;
+
+const Params = schema => {
+  return {
+    name: _types.HttpMetadata.Params,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.Params, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        params
+      } = inputs;
+      await validateInput(schema, params);
+      return next();
+    }
+
+  };
+};
+
+exports.Params = Params;
+
+const Headers = schema => {
+  return {
+    name: _types.HttpMetadata.Headers,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.Headers, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        headers
+      } = inputs;
+      await validateInput(schema, headers);
+      return next();
+    }
+
+  };
+};
+
+exports.Headers = Headers;
+
+const HttpCode = statusCode => {
+  return {
+    name: 'HttpCode',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.StatusCode, statusCode);
+    }
+
+  };
+};
+
+exports.HttpCode = HttpCode;
+
+const SetHeaders = headers => {
+  return {
+    name: 'SetHeaders',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.ResponseHeaders, headers);
+    }
+
+  };
+};
+
+exports.SetHeaders = SetHeaders;
+
+const Redirect = url => {
+  return {
+    name: 'Redirect',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.HttpMetadata.Redirect, url);
+    }
+
+  };
+};
+
+exports.Redirect = Redirect;
+
+const Middleware = middleware => {
+  return {
+    name: 'Middleware',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(_types.OperatorType.Middleware, middleware);
+    }
+
+  };
+};
+
+exports.Middleware = Middleware;

package/dist/js/node/router/constants.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INDEX_SUFFIX = exports.FRAMEWORK_MODE_LAMBDA_DIR = exports.AllHttpMethods = exports.API_FILE_RULES = exports.API_DIR = exports.APIMode = void 0;
+
+var _types = require("../types");
+
+const AllHttpMethods = Object.values(_types.HttpMethod);
+exports.AllHttpMethods = AllHttpMethods;
+let APIMode;
+exports.APIMode = APIMode;
+
+(function (APIMode) {
+  APIMode["FARMEWORK"] = "FARMEWORK";
+  APIMode["FUNCTION"] = "FUNCTION";
+})(APIMode || (exports.APIMode = APIMode = {}));
+
+const FRAMEWORK_MODE_LAMBDA_DIR = 'lambda';
+exports.FRAMEWORK_MODE_LAMBDA_DIR = FRAMEWORK_MODE_LAMBDA_DIR;
+const INDEX_SUFFIX = 'index';
+exports.INDEX_SUFFIX = INDEX_SUFFIX;
+const API_DIR = 'api';
+exports.API_DIR = API_DIR;
+const API_FILE_RULES = ['**/*.[tj]s', '!**/_*', '!**/_*/**/*.[tj]s', '!**/*.test.js', '!**/*.test.ts', '!**/*.d.ts', '!__test__/*.ts', '!__tests__/*.ts', '!node_modules/**', '!bootstrap.js'];
+exports.API_FILE_RULES = API_FILE_RULES;

package/dist/js/node/router/index.js

@@ -0,0 +1,317 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  ApiRouter: true
+};
+exports.ApiRouter = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+require("reflect-metadata");
+
+require("esbuild-register");
+
+var _types = require("../types");
+
+var _constants = require("./constants");
+
+Object.keys(_constants).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _constants[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _constants[key];
+    }
+  });
+});
+
+var _utils2 = require("./utils");
+
+var _types2 = require("./types");
+
+Object.keys(_types2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _types2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types2[key];
+    }
+  });
+});
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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 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(_constants.FRAMEWORK_MODE_LAMBDA_DIR)) {
+        return _constants.APIMode.FARMEWORK;
+      }
+
+      return _constants.APIMode.FUNCTION;
+    });
+
+    _defineProperty(this, "createExistChecker", base => target => _utils.fs.pathExistsSync(_path.default.resolve(base, target)));
+
+    _defineProperty(this, "getLambdaDir", apiDir => {
+      if (this.lambdaDir) {
+        return this.lambdaDir;
+      }
+
+      const mode = this.getAPIMode(apiDir);
+      const lambdaDir = mode === _constants.APIMode.FARMEWORK ? _path.default.join(apiDir, _constants.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.default.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 = (0, _utils2.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(_types.OperatorType.Trigger, handler);
+
+      if (trigger && trigger.type === _types.TriggerType.Http) {
+        if (!trigger.path) {
+          throw new Error(`The http trigger ${trigger.name} needs to specify a path`);
+        }
+
+        return trigger.path;
+      }
+    }
+
+    const routePath = (0, _utils2.getPathFromFilename)(this.lambdaDir, filename);
+    return routePath;
+  }
+
+  getHttpMethod(originHandlerName, handler) {
+    if (handler) {
+      const trigger = Reflect.getMetadata(_types.OperatorType.Trigger, handler);
+
+      if (trigger && _types.httpMethods.includes(trigger.method)) {
+        return trigger.method;
+      }
+    }
+
+    const upperName = originHandlerName.toUpperCase();
+
+    switch (upperName) {
+      case 'GET':
+        return _types.HttpMethod.Get;
+
+      case 'POST':
+        return _types.HttpMethod.Post;
+
+      case 'PUT':
+        return _types.HttpMethod.Put;
+
+      case 'DELETE':
+      case 'DEL':
+        return _types.HttpMethod.Delete;
+
+      case 'CONNECT':
+        return _types.HttpMethod.Connect;
+
+      case 'TRACE':
+        return _types.HttpMethod.Trace;
+
+      case 'PATCH':
+        return _types.HttpMethod.Patch;
+
+      case 'OPTION':
+        return _types.HttpMethod.Option;
+
+      case 'DEFAULT':
+        {
+          return _types.HttpMethod.Get;
+        }
+
+      default:
+        _utils.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 = (0, _utils2.getFiles)(this.lambdaDir, _constants.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);
+  }
+
+}
+
+exports.ApiRouter = ApiRouter;

package/dist/js/node/router/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});