@modern-js/bff-core 1.21.1 → 1.21.2-beta.0

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.21.1",
+  "version": "1.21.2-beta.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -20,6 +20,7 @@
   "exports": {
     ".": {
       "jsnext:source": "./src/index.ts",
+      "types": "./dist/types/index.d.ts",
       "default": "./dist/js/node/index.js"
     }
   },

package/dist/js/modern/api.js

@@ -1,54 +0,0 @@
-import 'reflect-metadata';
-import compose from 'koa-compose';
-import { validateFunction, HANDLER_WITH_META } from "./utils";
-export function Api(...args) {
-  const handler = args.pop();
-  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);
-  const pipeHandlers = operators.filter(operator => operator.execute).map(operator => operator.execute);
-
-  async function runner(inputs) {
-    const executeHelper = {
-      result: null,
-
-      get inputs() {
-        return inputs;
-      },
-
-      set inputs(val) {
-        // eslint-disable-next-line no-param-reassign
-        inputs = val;
-      }
-
-    };
-    const stack = [...validateHandlers, ...pipeHandlers];
-    stack.push(async (helper, next) => {
-      const res = await handler(helper.inputs);
-      helper.result = res;
-      return next();
-    });
-    await compose(stack)(executeHelper);
-    return executeHelper.result;
-  }
-
-  runner[HANDLER_WITH_META] = true;
-  return runner;
-}

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

@@ -1,63 +0,0 @@
-import * as path from 'path';
-import { ApiRouter } from "../router";
-import { Ok, Err } from "./result";
-export const DEFAULT_CLIENT_REQUEST_CREATOR = '@modern-js/create-request';
-export 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 ApiRouter({
-    apiDir,
-    prefix
-  });
-  const handlerInfos = apiRouter.getSingleModuleHandlers(resourcePath);
-
-  if (!handlerInfos) {
-    return Err(`generate client error: 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 Ok(`${importCode}\n${handlersCode}`);
-};

package/dist/js/modern/client/index.js

@@ -1 +0,0 @@
-export * from "./generate-client";

package/dist/js/modern/client/result.js

@@ -1,20 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const Err = value => {
-  const err = {
-    kind: 'Err',
-    value,
-    isErr: true,
-    isOk: false
-  };
-  return err;
-}; // eslint-disable-next-line @typescript-eslint/no-redeclare
-
-export const Ok = value => {
-  const ok = {
-    kind: 'Ok',
-    value,
-    isErr: false,
-    isOk: true
-  };
-  return ok;
-};

package/dist/js/modern/errors/http.js

@@ -1,22 +0,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; }
-
-export class HttpError extends Error {
-  constructor(status, message) {
-    super(message);
-
-    _defineProperty(this, "status", void 0);
-
-    this.status = status;
-  }
-
-}
-export class ValidationError extends HttpError {
-  constructor(status, message) {
-    super(status, message);
-
-    _defineProperty(this, "code", void 0);
-
-    this.code = 'VALIDATION_ERROR';
-  }
-
-}

package/dist/js/modern/index.js

@@ -1,7 +0,0 @@
-export { Api } from "./api";
-export { HttpError, ValidationError } from "./errors/http";
-export * from "./router";
-export * from "./types";
-export * from "./client";
-export * from "./operators/http";
-export { getRelativeRuntimePath, HANDLER_WITH_META, isWithMetaHandler, createStorage, registerPaths } from "./utils";

package/dist/js/modern/operators/http.js

@@ -1,187 +0,0 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-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 { HttpMetadata, OperatorType, HttpMethod, TriggerType, ResponseMetaType } from "../types";
-import { ValidationError } from "../errors/http";
-
-const validateInput = async (schema, input) => {
-  try {
-    return await schema.parseAsync(input);
-  } catch (error) {
-    const {
-      z: zod
-    } = require('zod');
-
-    if (error instanceof zod.ZodError) {
-      throw new ValidationError(400, error.message);
-    }
-
-    throw error;
-  }
-};
-
-export const createHttpOperator = method => {
-  return urlPath => {
-    return {
-      name: method,
-
-      metadata({
-        setMetadata
-      }) {
-        setMetadata(OperatorType.Trigger, {
-          type: TriggerType.Http,
-          path: urlPath,
-          method
-        });
-      }
-
-    };
-  };
-};
-export const Get = createHttpOperator(HttpMethod.Get);
-export const Post = createHttpOperator(HttpMethod.Post);
-export const Put = createHttpOperator(HttpMethod.Put);
-export const Delete = createHttpOperator(HttpMethod.Delete);
-export const Connect = createHttpOperator(HttpMethod.Connect);
-export const Trace = createHttpOperator(HttpMethod.Trace);
-export const Patch = createHttpOperator(HttpMethod.Patch);
-export const Option = createHttpOperator(HttpMethod.Option);
-export const Head = createHttpOperator(HttpMethod.Head);
-export const Data = schema => {
-  return {
-    name: HttpMetadata.Data,
-
-    metadata({
-      setMetadata
-    }) {
-      setMetadata(HttpMetadata.Data, schema);
-    },
-
-    async validate(helper, next) {
-      const {
-        inputs: {
-          data
-        }
-      } = helper;
-      helper.inputs = _objectSpread(_objectSpread({}, helper.inputs), {}, {
-        data: await validateInput(schema, data)
-      });
-      return next();
-    }
-
-  };
-};
-export const Query = schema => {
-  return {
-    name: HttpMetadata.Query,
-
-    metadata({
-      setMetadata
-    }) {
-      setMetadata(HttpMetadata.Query, schema);
-    },
-
-    async validate(helper, next) {
-      const {
-        inputs: {
-          query
-        }
-      } = helper;
-      helper.inputs = _objectSpread(_objectSpread({}, helper.inputs), {}, {
-        query: await validateInput(schema, query)
-      });
-      return next();
-    }
-
-  };
-};
-export const Params = schema => {
-  return {
-    name: HttpMetadata.Params,
-
-    metadata({
-      setMetadata
-    }) {
-      setMetadata(HttpMetadata.Params, schema);
-    },
-
-    async validate(helper, next) {
-      const {
-        inputs: {
-          params
-        }
-      } = helper;
-      helper.inputs = _objectSpread(_objectSpread({}, helper.inputs), {}, {
-        params: await validateInput(schema, params)
-      });
-      return next();
-    }
-
-  };
-};
-export const Headers = schema => {
-  return {
-    name: HttpMetadata.Headers,
-
-    metadata({
-      setMetadata
-    }) {
-      setMetadata(HttpMetadata.Headers, schema);
-    },
-
-    async validate(helper, next) {
-      const {
-        inputs: {
-          headers
-        }
-      } = helper;
-      helper.inputs = _objectSpread(_objectSpread({}, helper.inputs), {}, {
-        headers: await validateInput(schema, headers)
-      });
-      return next();
-    }
-
-  };
-};
-
-const setResponseMeta = (helper, type, value) => {
-  const responseMetaData = helper.getMetadata(HttpMetadata.Response) || [];
-  helper.setMetadata(HttpMetadata.Response, [...responseMetaData, {
-    type,
-    value
-  }]);
-};
-
-export const HttpCode = statusCode => {
-  return {
-    name: 'HttpCode',
-
-    metadata(helper) {
-      setResponseMeta(helper, ResponseMetaType.StatusCode, statusCode);
-    }
-
-  };
-};
-export const SetHeaders = headers => {
-  return {
-    name: 'SetHeaders',
-
-    metadata(helper) {
-      setResponseMeta(helper, ResponseMetaType.Headers, headers);
-    }
-
-  };
-};
-export const Redirect = url => {
-  return {
-    name: 'Redirect',
-
-    metadata(helper) {
-      setResponseMeta(helper, ResponseMetaType.Redirect, url);
-    }
-
-  };
-};

package/dist/js/modern/router/constants.js

@@ -1,14 +0,0 @@
-import { HttpMethod } from "../types";
-export const AllHttpMethods = Object.values(HttpMethod);
-export let APIMode;
-
-(function (APIMode) {
-  APIMode["FARMEWORK"] = "framework";
-  APIMode["FUNCTION"] = "function";
-})(APIMode || (APIMode = {}));
-
-export const FRAMEWORK_MODE_LAMBDA_DIR = 'lambda';
-export const FRAMEWORK_MODE_APP_DIR = 'app';
-export const INDEX_SUFFIX = 'index';
-export const API_DIR = 'api';
-export const API_FILE_RULES = ['**/*.[tj]s', '!**/_*', '!**/_*/**/*.[tj]s', '!**/*.test.js', '!**/*.test.ts', '!**/*.d.ts', '!__test__/*.ts', '!__tests__/*.ts', '!node_modules/**', '!bootstrap.js'];

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

@@ -1,299 +0,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; }
-
-import path from 'path';
-import { fs, logger } from '@modern-js/utils';
-import 'reflect-metadata';
-import { HttpMethod, httpMethods, OperatorType, TriggerType } from "../types";
-import { debug } 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";
-export class ApiRouter {
-  // lambdaDir is the dir which equal to the apiDir in function mode, and equal to the api/lambda dir in framework mode
-  constructor({
-    apiDir: _apiDir,
-    lambdaDir: _lambdaDir,
-    prefix
-  }) {
-    _defineProperty(this, "apiMode", void 0);
-
-    _defineProperty(this, "apiDir", void 0);
-
-    _defineProperty(this, "existLambdaDir", void 0);
-
-    _defineProperty(this, "lambdaDir", void 0);
-
-    _defineProperty(this, "prefix", void 0);
-
-    _defineProperty(this, "apiFiles", []);
-
-    _defineProperty(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;
-    });
-
-    _defineProperty(this, "createExistChecker", base => target => fs.pathExistsSync(path.resolve(base, target)));
-
-    _defineProperty(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.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;
-  } // 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() {
-    if (!this.existLambdaDir) {
-      return [];
-    } // eslint-disable-next-line no-multi-assign
-
-
-    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;
-  }
-  /**
-   * 如果用户未传入或传入空串，默认为 /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`);
-    }
-  }
-
-  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;
-    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}`;
-  }
-
-}

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

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