@modern-js/bff-core 1.17.0 → 1.18.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @modern-js/bff-core
 
+## 1.18.0
+
+### Patch Changes
+
+- 3d5e3a5: chore: get api mode from bff core
+  chore: 从 bff core 中获取 api mode
+- Updated dependencies [8280920]
+- Updated dependencies [5227370]
+- Updated dependencies [7928bae]
+  - @modern-js/utils@1.18.0
+  - @modern-js/bff-runtime@1.18.0
+
 ## 1.17.0
 
 ### Patch Changes

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

@@ -3,11 +3,12 @@ export const AllHttpMethods = Object.values(HttpMethod);
 export let APIMode;
 
 (function (APIMode) {
-  APIMode["FARMEWORK"] = "FARMEWORK";
-  APIMode["FUNCTION"] = "FUNCTION";
+  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

@@ -5,30 +5,36 @@ 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 } from "./constants";
+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, "lambdaDir", void 0);
+    _defineProperty(this, "existLambdaDir", void 0);
 
-    _defineProperty(this, "existLambda", void 0);
+    _defineProperty(this, "lambdaDir", void 0);
 
     _defineProperty(this, "prefix", void 0);
 
-    _defineProperty(this, "apiFiles", void 0);
+    _defineProperty(this, "apiFiles", []);
 
-    _defineProperty(this, "getAPIMode", apiDir => {
+    _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 (exist(FRAMEWORK_MODE_LAMBDA_DIR)) {
+      if (existLambdaDir || existAppDir || existAppFile) {
         return APIMode.FARMEWORK;
       }
 
@@ -42,29 +48,25 @@ export class ApiRouter {
         return this.lambdaDir;
       }
 
-      const mode = this.getAPIMode(apiDir);
-      const lambdaDir = mode === APIMode.FARMEWORK ? path.join(apiDir, FRAMEWORK_MODE_LAMBDA_DIR) : apiDir;
+      const lambdaDir = this.apiMode === 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.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.existLambda = this.checkExistLambda(this.apiDir, this.lambdaDir);
+    this.existLambdaDir = fs.existsSync(this.lambdaDir);
   }
 
   isExistLambda() {
-    return this.existLambda;
+    return this.existLambdaDir;
+  }
+
+  getApiMode() {
+    return this.apiMode;
   }
 
   getLambdaDir() {
@@ -72,7 +74,7 @@ export class ApiRouter {
   }
 
   isApiFile(filename) {
-    if (this.existLambda) {
+    if (this.existLambdaDir) {
       return false;
     }
 
@@ -184,7 +186,7 @@ export class ApiRouter {
   }
 
   loadApiFiles() {
-    if (!this.existLambda) {
+    if (!this.existLambdaDir) {
       return [];
     } // eslint-disable-next-line no-multi-assign
 
@@ -194,7 +196,7 @@ export class ApiRouter {
   }
 
   getApiFiles() {
-    if (!this.existLambda) {
+    if (!this.existLambdaDir) {
       return [];
     }
 
@@ -226,39 +228,8 @@ export class ApiRouter {
     return prefix || '/api';
   }
 
-  checkExistLambda(apiDir, lambdaDir) {
-    const isSame = apiDir === lambdaDir;
-
-    if (!isSame) {
-      return true;
-    }
-
-    const exts = ['.ts', '.js'];
-
-    const existAppDir = apiDir => {
-      return fs.existsSync(path.join(apiDir, 'app'));
-    };
-
-    const existAppFile = apiDir => {
-      const exists = exts.some(ext => {
-        return fs.existsSync(path.join(apiDir, `app${ext}`));
-      });
-      return exists;
-    };
-
-    if (isSame && existAppDir(apiDir)) {
-      return false;
-    }
-
-    if (isSame && existAppFile(apiDir)) {
-      return false;
-    }
-
-    return true;
-  }
-
   validateAbsolute(filename, paramsName) {
-    if (!path.isAbsolute(filename)) {
+    if (typeof filename === 'string' && !path.isAbsolute(filename)) {
       throw new Error(`The ${paramsName} ${filename} is not a abolute path`);
     }
   }

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

@@ -3,7 +3,7 @@
 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;
+exports.INDEX_SUFFIX = exports.FRAMEWORK_MODE_LAMBDA_DIR = exports.FRAMEWORK_MODE_APP_DIR = exports.AllHttpMethods = exports.API_FILE_RULES = exports.API_DIR = exports.APIMode = void 0;
 
 var _types = require("../types");
 
@@ -13,12 +13,14 @@ let APIMode;
 exports.APIMode = APIMode;
 
 (function (APIMode) {
-  APIMode["FARMEWORK"] = "FARMEWORK";
-  APIMode["FUNCTION"] = "FUNCTION";
+  APIMode["FARMEWORK"] = "framework";
+  APIMode["FUNCTION"] = "function";
 })(APIMode || (exports.APIMode = APIMode = {}));
 
 const FRAMEWORK_MODE_LAMBDA_DIR = 'lambda';
 exports.FRAMEWORK_MODE_LAMBDA_DIR = FRAMEWORK_MODE_LAMBDA_DIR;
+const FRAMEWORK_MODE_APP_DIR = 'app';
+exports.FRAMEWORK_MODE_APP_DIR = FRAMEWORK_MODE_APP_DIR;
 const INDEX_SUFFIX = 'index';
 exports.INDEX_SUFFIX = INDEX_SUFFIX;
 const API_DIR = 'api';

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

@@ -53,25 +53,31 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 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 {
+  // 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, "lambdaDir", void 0);
+    _defineProperty(this, "existLambdaDir", void 0);
 
-    _defineProperty(this, "existLambda", void 0);
+    _defineProperty(this, "lambdaDir", void 0);
 
     _defineProperty(this, "prefix", void 0);
 
-    _defineProperty(this, "apiFiles", void 0);
+    _defineProperty(this, "apiFiles", []);
 
-    _defineProperty(this, "getAPIMode", apiDir => {
+    _defineProperty(this, "getExactApiMode", apiDir => {
       const exist = this.createExistChecker(apiDir);
+      const existLambdaDir = exist(_constants.FRAMEWORK_MODE_LAMBDA_DIR);
+      const existAppDir = exist(_constants.FRAMEWORK_MODE_APP_DIR);
+      const existAppFile = exist('app.ts') || exist('app.js');
 
-      if (exist(_constants.FRAMEWORK_MODE_LAMBDA_DIR)) {
+      if (existLambdaDir || existAppDir || existAppFile) {
         return _constants.APIMode.FARMEWORK;
       }
 
@@ -85,29 +91,25 @@ class ApiRouter {
         return this.lambdaDir;
       }
 
-      const mode = this.getAPIMode(apiDir);
-      const lambdaDir = mode === _constants.APIMode.FARMEWORK ? _path.default.join(apiDir, _constants.FRAMEWORK_MODE_LAMBDA_DIR) : apiDir;
+      const lambdaDir = this.apiMode === _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.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.existLambda = this.checkExistLambda(this.apiDir, this.lambdaDir);
+    this.existLambdaDir = _utils.fs.existsSync(this.lambdaDir);
   }
 
   isExistLambda() {
-    return this.existLambda;
+    return this.existLambdaDir;
+  }
+
+  getApiMode() {
+    return this.apiMode;
   }
 
   getLambdaDir() {
@@ -115,7 +117,7 @@ class ApiRouter {
   }
 
   isApiFile(filename) {
-    if (this.existLambda) {
+    if (this.existLambdaDir) {
       return false;
     }
 
@@ -228,7 +230,7 @@ class ApiRouter {
   }
 
   loadApiFiles() {
-    if (!this.existLambda) {
+    if (!this.existLambdaDir) {
       return [];
     } // eslint-disable-next-line no-multi-assign
 
@@ -238,7 +240,7 @@ class ApiRouter {
   }
 
   getApiFiles() {
-    if (!this.existLambda) {
+    if (!this.existLambdaDir) {
       return [];
     }
 
@@ -270,39 +272,8 @@ class ApiRouter {
     return prefix || '/api';
   }
 
-  checkExistLambda(apiDir, lambdaDir) {
-    const isSame = apiDir === lambdaDir;
-
-    if (!isSame) {
-      return true;
-    }
-
-    const exts = ['.ts', '.js'];
-
-    const existAppDir = apiDir => {
-      return _utils.fs.existsSync(_path.default.join(apiDir, 'app'));
-    };
-
-    const existAppFile = apiDir => {
-      const exists = exts.some(ext => {
-        return _utils.fs.existsSync(_path.default.join(apiDir, `app${ext}`));
-      });
-      return exists;
-    };
-
-    if (isSame && existAppDir(apiDir)) {
-      return false;
-    }
-
-    if (isSame && existAppFile(apiDir)) {
-      return false;
-    }
-
-    return true;
-  }
-
   validateAbsolute(filename, paramsName) {
-    if (!_path.default.isAbsolute(filename)) {
+    if (typeof filename === 'string' && !_path.default.isAbsolute(filename)) {
       throw new Error(`The ${paramsName} ${filename} is not a abolute path`);
     }
   }

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

@@ -3,14 +3,15 @@ export declare enum APIMode {
   /**
    * 框架模式
    */
-  FARMEWORK = "FARMEWORK",
+  FARMEWORK = "framework",
 
   /**
    * 函数模式
    */
-  FUNCTION = "FUNCTION",
+  FUNCTION = "function",
 }
 export declare const FRAMEWORK_MODE_LAMBDA_DIR = "lambda";
+export declare const FRAMEWORK_MODE_APP_DIR = "app";
 export declare const INDEX_SUFFIX = "index";
 export declare const API_DIR = "api";
 export declare const API_FILE_RULES: string[];

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

@@ -1,12 +1,14 @@
 import 'reflect-metadata';
 import { HttpMethod } from '../types';
+import { APIMode } from './constants';
 import { ApiHandler, APIHandlerInfo } from './types';
 export * from './types';
 export * from './constants';
 export declare class ApiRouter {
+  private apiMode;
   private apiDir;
+  private existLambdaDir;
   private lambdaDir;
-  private existLambda;
   private prefix;
   private apiFiles;
   constructor({
@@ -19,6 +21,7 @@ export declare class ApiRouter {
     prefix?: string;
   });
   isExistLambda(): boolean;
+  getApiMode(): APIMode;
   getLambdaDir(): string;
   isApiFile(filename: string): boolean;
   getSingleModuleHandlers(filename: string): APIHandlerInfo[] | null;
@@ -35,9 +38,8 @@ export declare class ApiRouter {
    */
 
   private initPrefix;
-  private checkExistLambda;
   private validateAbsolute;
-  private getAPIMode;
+  private getExactApiMode;
   private createExistChecker;
   private getExactLambdaDir;
   private getModuleInfos;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.17.0",
+  "version": "1.18.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -25,16 +25,16 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.18.0",
-    "@modern-js/bff-runtime": "1.17.0",
-    "@modern-js/utils": "1.17.0",
+    "@modern-js/bff-runtime": "1.18.0",
+    "@modern-js/utils": "1.18.0",
     "esbuild": "^0.14.38",
     "esbuild-register": "^3.3.3",
     "koa-compose": "^4.1.0",
     "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {
-    "@scripts/build": "1.17.0",
-    "@scripts/jest-config": "1.17.0",
+    "@scripts/build": "1.18.0",
+    "@scripts/jest-config": "1.18.0",
     "@types/jest": "^27",
     "@types/koa-compose": "^3.2.5",
     "@types/node": "^14",