@modern-js/plugin-bff 2.6.1-alpha.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @modern-js/plugin-bff
 
+## 2.7.0
+
+### Minor Changes
+
+- 84bfb439b8: feat: support custom apiDir, lambdaDir and style of writing for bff
+  feat: 支持定制 api 目录，lambda 目录，bff 的写法
+
+### Patch Changes
+
+- 7bb1554194: fix: remove process.env.PORT from the bff generate client code
+  fix: 从 bff 的 generate client code 中移除 process.env.PORT
+- 1eea234fdd: chore: make test files naming consistent
+
+  chore: 统一测试文件命名为小驼峰格式
+
+- Updated dependencies [0f15fc597c]
+- Updated dependencies [dcad887024]
+- Updated dependencies [a4672f7c16]
+- Updated dependencies [7bb1554194]
+- Updated dependencies [7fff9020e1]
+- Updated dependencies [1eea234fdd]
+- Updated dependencies [84bfb439b8]
+  - @modern-js/utils@2.7.0
+  - @modern-js/bff-core@2.7.0
+  - @modern-js/server-utils@2.7.0
+  - @modern-js/create-request@2.7.0
+
 ## 2.6.0
 
 ### Patch Changes

package/dist/cjs/cli.js

@@ -48,12 +48,12 @@ var cli_default = () => ({
       config() {
         return {
           tools: {
-            webpackChain: (chain, { name, CHAIN_ID }) => {
+            webpackChain: (chain, { CHAIN_ID, isServer }) => {
               const { port, apiDirectory, lambdaDirectory } = api.useAppContext();
               const modernConfig = api.useResolvedConfigContext();
               const { bff } = modernConfig || {};
               const prefix = (bff == null ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-              const { httpMethodDecider } = bff;
+              const httpMethodDecider = bff == null ? void 0 : bff.httpMethodDecider;
               chain.resolve.alias.set("@api", apiDirectory);
               const apiRouter = new import_bff_core.ApiRouter({
                 apiDir: apiDirectory,
@@ -66,6 +66,7 @@ var cli_default = () => ({
               const apiRegexp = new RegExp(
                 (0, import_utils.normalizeOutputPath)(`${apiDirectory}${import_path.default.sep}.*(.[tj]s)$`)
               );
+              const name = isServer ? "server" : "client";
               chain.module.rule(CHAIN_ID.RULE.JS).exclude.add(apiRegexp);
               chain.module.rule(CHAIN_ID.RULE.JS_BFF_API).test(apiRegexp).use("custom-loader").loader(require.resolve("./loader").replace(/\\/g, "/")).options({
                 prefix,
@@ -99,7 +100,6 @@ var cli_default = () => ({
           entryPath: "",
           isSPA: false,
           isSSR: false
-          // FIXME: })) as IAppContext[`serverRoutes`];
         }));
         if (bff == null ? void 0 : bff.enableHandleWeb) {
           return {

package/dist/esm/cli.js

@@ -219,12 +219,12 @@ var cli_default = function() {
                     return {
                         tools: {
                             webpackChain: function(chain, param) {
-                                var name = param.name, CHAIN_ID = param.CHAIN_ID;
+                                var CHAIN_ID = param.CHAIN_ID, isServer = param.isServer;
                                 var _api_useAppContext = api.useAppContext(), port = _api_useAppContext.port, apiDirectory = _api_useAppContext.apiDirectory, lambdaDirectory = _api_useAppContext.lambdaDirectory;
                                 var modernConfig = api.useResolvedConfigContext();
                                 var bff = (modernConfig || {}).bff;
                                 var prefix = (bff === null || bff === void 0 ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-                                var httpMethodDecider = bff.httpMethodDecider;
+                                var httpMethodDecider = bff === null || bff === void 0 ? void 0 : bff.httpMethodDecider;
                                 chain.resolve.alias.set("@api", apiDirectory);
                                 var apiRouter = new ApiRouter({
                                     apiDir: apiDirectory,
@@ -235,6 +235,7 @@ var cli_default = function() {
                                 var lambdaDir = apiRouter.getLambdaDir();
                                 var existLambda = apiRouter.isExistLambda();
                                 var apiRegexp = new RegExp(normalizeOutputPath("".concat(apiDirectory).concat(path.sep, ".*(.[tj]s)$")));
+                                var name = isServer ? "server" : "client";
                                 chain.module.rule(CHAIN_ID.RULE.JS).exclude.add(apiRegexp);
                                 chain.module.rule(CHAIN_ID.RULE.JS_BFF_API).test(apiRegexp).use("custom-loader").loader(require.resolve("./loader").replace(/\\/g, "/")).options({
                                     prefix: prefix,

package/dist/esm-node/cli.js

@@ -23,12 +23,12 @@ var cli_default = () => ({
       config() {
         return {
           tools: {
-            webpackChain: (chain, { name, CHAIN_ID }) => {
+            webpackChain: (chain, { CHAIN_ID, isServer }) => {
               const { port, apiDirectory, lambdaDirectory } = api.useAppContext();
               const modernConfig = api.useResolvedConfigContext();
               const { bff } = modernConfig || {};
               const prefix = (bff == null ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-              const { httpMethodDecider } = bff;
+              const httpMethodDecider = bff == null ? void 0 : bff.httpMethodDecider;
               chain.resolve.alias.set("@api", apiDirectory);
               const apiRouter = new ApiRouter({
                 apiDir: apiDirectory,
@@ -41,6 +41,7 @@ var cli_default = () => ({
               const apiRegexp = new RegExp(
                 normalizeOutputPath(`${apiDirectory}${path.sep}.*(.[tj]s)$`)
               );
+              const name = isServer ? "server" : "client";
               chain.module.rule(CHAIN_ID.RULE.JS).exclude.add(apiRegexp);
               chain.module.rule(CHAIN_ID.RULE.JS_BFF_API).test(apiRegexp).use("custom-loader").loader(require.resolve("./loader").replace(/\\/g, "/")).options({
                 prefix,
@@ -74,7 +75,6 @@ var cli_default = () => ({
           entryPath: "",
           isSPA: false,
           isSSR: false
-          // FIXME: })) as IAppContext[`serverRoutes`];
         }));
         if (bff == null ? void 0 : bff.enableHandleWeb) {
           return {

package/dist/types/loader.d.ts

@@ -9,7 +9,7 @@ export type APILoaderOptions = {
   fetcher?: string;
   requestCreator?: string;
   target: string;
-  httpMethodDecider: HttpMethodDecider;
+  httpMethodDecider?: HttpMethodDecider;
 };
 declare function loader(this: LoaderContext<APILoaderOptions>, source: string): Promise<void>;
 export default loader;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.6.1-alpha.0",
+  "version": "2.7.0",
   "jsnext:source": "./src/cli.ts",
   "types": "./dist/types/cli.d.ts",
   "main": "./dist/cjs/cli.js",
@@ -50,20 +50,12 @@
   "dependencies": {
     "@babel/core": "^7.18.0",
     "@babel/runtime": "^7.18.0",
-    "@modern-js/bff-core": "2.6.0",
-    "@modern-js/create-request": "2.6.0",
-    "@modern-js/server-utils": "2.6.0",
-    "@modern-js/utils": "2.6.0"
+    "@modern-js/bff-core": "2.7.0",
+    "@modern-js/create-request": "2.7.0",
+    "@modern-js/server-utils": "2.7.0",
+    "@modern-js/utils": "2.7.0"
   },
   "devDependencies": {
-    "@modern-js/runtime": "2.6.0",
-    "@modern-js/core": "2.6.0",
-    "@modern-js/bff-runtime": "2.6.0",
-    "@modern-js/server-core": "2.6.0",
-    "@modern-js/types": "2.6.0",
-    "@modern-js/app-tools": "2.6.0",
-    "@scripts/build": "2.6.0",
-    "@scripts/jest-config": "2.6.0",
     "@types/babel__core": "^7.1.15",
     "@types/jest": "^27",
     "@types/node": "^14",
@@ -72,7 +64,15 @@
     "ts-jest": "^27.0.5",
     "typescript": "^4",
     "webpack": "^5.75.0",
-    "webpack-chain": "^6.5.1"
+    "webpack-chain": "^6.5.1",
+    "@modern-js/runtime": "2.7.0",
+    "@modern-js/core": "2.7.0",
+    "@modern-js/bff-runtime": "2.7.0",
+    "@modern-js/server-core": "2.7.0",
+    "@modern-js/types": "2.7.0",
+    "@modern-js/app-tools": "2.7.0",
+    "@scripts/build": "2.7.0",
+    "@scripts/jest-config": "2.7.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/dist/js/modern/cli.js

@@ -1,184 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import path from "path";
-import {
-  fs,
-  API_DIR,
-  PLUGIN_SCHEMAS,
-  normalizeOutputPath,
-  SHARED_DIR,
-  isProd
-} from "@modern-js/utils";
-import { compile } from "@modern-js/server-utils";
-import { ApiRouter } from "@modern-js/bff-core";
-import { registerModernRuntimePath } from "./helper";
-const DEFAULT_API_PREFIX = "/api";
-const TS_CONFIG_FILENAME = "tsconfig.json";
-var cli_default = () => ({
-  name: "@modern-js/plugin-bff",
-  setup: (api) => {
-    let unRegisterResolveRuntimePath = null;
-    return {
-      validateSchema() {
-        return PLUGIN_SCHEMAS["@modern-js/plugin-bff"];
-      },
-      config() {
-        return {
-          tools: {
-            webpackChain: (chain, { name, CHAIN_ID }) => {
-              const { appDirectory, port } = api.useAppContext();
-              const modernConfig = api.useResolvedConfigContext();
-              const { bff } = modernConfig || {};
-              const prefix = (bff == null ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-              const rootDir = path.resolve(appDirectory, API_DIR);
-              chain.resolve.alias.set("@api", rootDir);
-              const apiRouter = new ApiRouter({
-                apiDir: rootDir,
-                prefix
-              });
-              const lambdaDir = apiRouter.getLambdaDir();
-              const existLambda = apiRouter.isExistLambda();
-              const apiRegexp = new RegExp(
-                normalizeOutputPath(`${rootDir}${path.sep}.*(.[tj]s)$`)
-              );
-              chain.module.rule(CHAIN_ID.RULE.JS).exclude.add(apiRegexp);
-              chain.module.rule(CHAIN_ID.RULE.JS_BFF_API).test(apiRegexp).use("custom-loader").loader(require.resolve("./loader").replace(/\\/g, "/")).options({
-                prefix,
-                apiDir: rootDir,
-                lambdaDir,
-                existLambda,
-                port,
-                target: name
-              });
-            }
-          },
-          source: {
-            moduleScopes: [`./${API_DIR}`, /create-request/]
-          }
-        };
-      },
-      modifyServerRoutes({ routes }) {
-        const modernConfig = api.useResolvedConfigContext();
-        const { bff } = modernConfig || {};
-        const prefix = (bff == null ? void 0 : bff.prefix) || "/api";
-        const prefixList = [];
-        if (Array.isArray(prefix)) {
-          prefixList.push(...prefix);
-        } else {
-          prefixList.push(prefix);
-        }
-        const apiServerRoutes = prefixList.map((pre) => ({
-          urlPath: pre,
-          isApi: true,
-          entryPath: "",
-          isSPA: false,
-          isSSR: false
-        }));
-        if (bff == null ? void 0 : bff.enableHandleWeb) {
-          return {
-            routes: routes.map((route) => {
-              return __spreadProps(__spreadValues({}, route), {
-                isApi: true
-              });
-            }).concat(apiServerRoutes)
-          };
-        }
-        return { routes: routes.concat(apiServerRoutes) };
-      },
-      collectServerPlugins({ plugins }) {
-        plugins.push({
-          "@modern-js/plugin-bff": "@modern-js/plugin-bff/server"
-        });
-        return { plugins };
-      },
-      beforeBuild() {
-        return __async(this, null, function* () {
-          if (isProd()) {
-            const { internalDirectory } = api.useAppContext();
-            unRegisterResolveRuntimePath = registerModernRuntimePath(internalDirectory);
-          }
-        });
-      },
-      afterBuild() {
-        return __async(this, null, function* () {
-          if (unRegisterResolveRuntimePath) {
-            unRegisterResolveRuntimePath();
-          }
-          const { appDirectory, distDirectory } = api.useAppContext();
-          const modernConfig = api.useResolvedConfigContext();
-          const distDir = path.resolve(distDirectory);
-          const apiDir = path.resolve(appDirectory, API_DIR);
-          const sharedDir = path.resolve(appDirectory, SHARED_DIR);
-          const tsconfigPath = path.resolve(appDirectory, TS_CONFIG_FILENAME);
-          const sourceDirs = [];
-          if (fs.existsSync(apiDir)) {
-            sourceDirs.push(apiDir);
-          }
-          if (fs.existsSync(sharedDir)) {
-            sourceDirs.push(sharedDir);
-          }
-          const { server } = modernConfig;
-          const { alias, define, globalVars } = modernConfig.source;
-          const { babel } = modernConfig.tools;
-          if (sourceDirs.length > 0) {
-            yield compile(
-              appDirectory,
-              {
-                server,
-                alias,
-                define,
-                globalVars,
-                babelConfig: babel
-              },
-              {
-                sourceDirs,
-                distDir,
-                tsconfigPath
-              }
-            );
-          }
-        });
-      }
-    };
-  }
-});
-export {
-  cli_default as default
-};

package/dist/js/modern/constants.js

@@ -1,14 +0,0 @@
-const API_APP_NAME = "_app";
-const BUILD_FILES = [
-  "**/*.[tj]sx?",
-  "!**/*.test.jsx?",
-  "!**/*.test.tsx?",
-  "!**/*.spec.jsx?",
-  "!**/*.spec.tsx?",
-  "!__tests__/*.tsx?",
-  "!__tests__/*.jsx?"
-];
-export {
-  API_APP_NAME,
-  BUILD_FILES
-};

package/dist/js/modern/helper.js

@@ -1,14 +0,0 @@
-import * as path from "path";
-import { registerPaths } from "@modern-js/bff-core";
-const serverRuntimeAlias = "@modern-js/runtime/server";
-const serverRuntimePath = ".runtime-exports/server";
-const registerModernRuntimePath = (internalDirectory) => {
-  const paths = {
-    [serverRuntimeAlias]: path.join(internalDirectory, serverRuntimePath)
-  };
-  const unRegister = registerPaths(paths);
-  return unRegister;
-};
-export {
-  registerModernRuntimePath
-};

package/dist/js/modern/index.js

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

package/dist/js/modern/loader.js

@@ -1,67 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import { generateClient } from "@modern-js/bff-core";
-import { logger } from "@modern-js/utils";
-function loader(source) {
-  return __async(this, null, function* () {
-    this.cacheable();
-    const callback = this.async();
-    const draftOptions = this.getOptions();
-    const { resourcePath } = this;
-    const warning = `The file ${resourcePath} is not allowd to be imported in src directory, only API definition files are allowed.`;
-    if (!draftOptions.existLambda) {
-      logger.warn(warning);
-      callback(null, `throw new Error('${warning}')`);
-      return;
-    }
-    const options = {
-      prefix: Array.isArray(draftOptions.prefix) ? draftOptions.prefix[0] : draftOptions.prefix,
-      apiDir: draftOptions.apiDir,
-      target: draftOptions.target,
-      port: Number(draftOptions.port),
-      source,
-      resourcePath
-    };
-    const { lambdaDir } = draftOptions;
-    if (!resourcePath.startsWith(lambdaDir)) {
-      logger.warn(warning);
-      callback(null, `throw new Error('${warning}')`);
-      return;
-    }
-    if (draftOptions.fetcher) {
-      options.fetcher = draftOptions.fetcher;
-    }
-    if (draftOptions.requestCreator) {
-      options.requestCreator = draftOptions.requestCreator;
-    }
-    options.requireResolve = require.resolve;
-    const result = yield generateClient(options);
-    if (result.isOk) {
-      callback(void 0, result.value);
-    } else {
-      callback(void 0, `throw new Error('${result.value}')`);
-    }
-  });
-}
-var loader_default = loader;
-export {
-  loader_default as default
-};

package/dist/js/modern/server.js

@@ -1,88 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-import path from "path";
-import { ApiRouter } from "@modern-js/bff-core";
-import { API_DIR, isProd, requireExistModule } from "@modern-js/utils";
-import { API_APP_NAME } from "./constants";
-class Storage {
-  constructor() {
-    this.middlewares = [];
-  }
-  reset() {
-    this.middlewares = [];
-  }
-}
-const createTransformAPI = (storage) => ({
-  addMiddleware(fn) {
-    storage.middlewares.push(fn);
-  }
-});
-var server_default = () => ({
-  name: "@modern-js/plugin-bff",
-  setup: (api) => {
-    const storage = new Storage();
-    const transformAPI = createTransformAPI(storage);
-    let apiAppPath = "";
-    return {
-      prepare() {
-        const { appDirectory, distDirectory } = api.useAppContext();
-        const root = isProd() ? distDirectory : appDirectory;
-        const apiPath = path.resolve(root || process.cwd(), API_DIR);
-        apiAppPath = path.resolve(apiPath, API_APP_NAME);
-        const apiMod = requireExistModule(apiAppPath);
-        if (apiMod && typeof apiMod === "function") {
-          apiMod(transformAPI);
-        }
-      },
-      reset() {
-        storage.reset();
-        const newApiModule = requireExistModule(apiAppPath);
-        if (newApiModule && typeof newApiModule === "function") {
-          newApiModule(transformAPI);
-        }
-      },
-      gather({ addAPIMiddleware }) {
-        storage.middlewares.forEach((mid) => {
-          addAPIMiddleware(mid);
-        });
-      },
-      prepareApiServer(props, next) {
-        const { pwd, prefix } = props;
-        const apiDir = path.resolve(pwd, API_DIR);
-        const appContext = api.useAppContext();
-        const apiRouter = new ApiRouter({
-          apiDir,
-          prefix
-        });
-        const apiMode = apiRouter.getApiMode();
-        const apiHandlerInfos = apiRouter.getApiHandlers();
-        api.setAppContext(__spreadProps(__spreadValues({}, appContext), {
-          apiRouter,
-          apiHandlerInfos,
-          apiMode
-        }));
-        return next(props);
-      }
-    };
-  }
-});
-export {
-  server_default as default
-};