@modern-js/plugin-bff 2.4.1-beta.0 → 2.5.1-alpha.0

package/CHANGELOG.md

@@ -1,14 +1,25 @@
 # @modern-js/plugin-bff
 
-## 2.4.1-beta.0
+## 2.5.0
 
 ### Patch Changes
 
+- 89ca6cc: refactor: merge build-config into scripts/build
+
+  refactor: 把 build-config 合并进 scripts/build
+
+- 6fca567: feat: support bff handle complete server, include page render
+  feat: 支持 bff 处理整个服务，包括页面渲染
+- 30614fa: chore: modify package.json entry fields and build config
+  chore: 更改 package.json entry 字段以及构建配置
+- Updated dependencies [89ca6cc]
+- Updated dependencies [30614fa]
+- Updated dependencies [1b0ce87]
 - Updated dependencies [11c053b]
-  - @modern-js/utils@2.4.1-beta.0
-  - @modern-js/server-utils@2.4.1-beta.0
-  - @modern-js/bff-core@2.4.1-beta.0
-  - @modern-js/create-request@2.4.1-beta.0
+  - @modern-js/bff-core@2.5.0
+  - @modern-js/create-request@2.5.0
+  - @modern-js/server-utils@2.5.0
+  - @modern-js/utils@2.5.0
 
 ## 2.4.0
 

package/cli.js

@@ -1 +1 @@
-module.exports = require('./dist/js/node/cli');
+module.exports = require('./dist/cjs/cli');

package/dist/cjs/cli.js

@@ -0,0 +1,167 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var cli_exports = {};
+__export(cli_exports, {
+  default: () => cli_default
+});
+module.exports = __toCommonJS(cli_exports);
+var import_path = __toESM(require("path"));
+var import_utils = require("@modern-js/utils");
+var import_server_utils = require("@modern-js/server-utils");
+var import_bff_core = require("@modern-js/bff-core");
+var import_helper = require("./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 import_utils.PLUGIN_SCHEMAS["@modern-js/plugin-bff"];
+      },
+      config() {
+        const configContext = api.useConfigContext();
+        console.log("22222222222222222", configContext.bff);
+        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 { httpMethodDecider } = bff;
+              const rootDir = import_path.default.resolve(appDirectory, import_utils.API_DIR);
+              chain.resolve.alias.set("@api", rootDir);
+              const apiRouter = new import_bff_core.ApiRouter({
+                apiDir: rootDir,
+                prefix,
+                httpMethodDecider
+              });
+              const lambdaDir = apiRouter.getLambdaDir();
+              const existLambda = apiRouter.isExistLambda();
+              const apiRegexp = new RegExp(
+                (0, import_utils.normalizeOutputPath)(`${rootDir}${import_path.default.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,
+                httpMethodDecider
+              });
+            }
+          },
+          source: {
+            moduleScopes: [`./${import_utils.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 {
+                ...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 };
+      },
+      async beforeBuild() {
+        if ((0, import_utils.isProd)()) {
+          const { internalDirectory } = api.useAppContext();
+          unRegisterResolveRuntimePath = (0, import_helper.registerModernRuntimePath)(internalDirectory);
+        }
+      },
+      async afterBuild() {
+        if (unRegisterResolveRuntimePath) {
+          unRegisterResolveRuntimePath();
+        }
+        const { appDirectory, distDirectory } = api.useAppContext();
+        const modernConfig = api.useResolvedConfigContext();
+        const distDir = import_path.default.resolve(distDirectory);
+        const apiDir = import_path.default.resolve(appDirectory, import_utils.API_DIR);
+        const sharedDir = import_path.default.resolve(appDirectory, import_utils.SHARED_DIR);
+        const tsconfigPath = import_path.default.resolve(appDirectory, TS_CONFIG_FILENAME);
+        const sourceDirs = [];
+        if (import_utils.fs.existsSync(apiDir)) {
+          sourceDirs.push(apiDir);
+        }
+        if (import_utils.fs.existsSync(sharedDir)) {
+          sourceDirs.push(sharedDir);
+        }
+        const { server } = modernConfig;
+        const { alias, define, globalVars } = modernConfig.source;
+        const { babel } = modernConfig.tools;
+        if (sourceDirs.length > 0) {
+          await (0, import_server_utils.compile)(
+            appDirectory,
+            {
+              server,
+              alias,
+              define,
+              globalVars,
+              babelConfig: babel
+            },
+            {
+              sourceDirs,
+              distDir,
+              tsconfigPath
+            }
+          );
+        }
+      }
+    };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/cjs/constants.js

@@ -0,0 +1,38 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var constants_exports = {};
+__export(constants_exports, {
+  API_APP_NAME: () => API_APP_NAME,
+  BUILD_FILES: () => BUILD_FILES
+});
+module.exports = __toCommonJS(constants_exports);
+const API_APP_NAME = "_app";
+const BUILD_FILES = [
+  "**/*.[tj]sx?",
+  "!**/*.test.jsx?",
+  "!**/*.test.tsx?",
+  "!**/*.spec.jsx?",
+  "!**/*.spec.tsx?",
+  "!__tests__/*.tsx?",
+  "!__tests__/*.jsx?"
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  API_APP_NAME,
+  BUILD_FILES
+});

package/dist/cjs/helper.js

@@ -0,0 +1,43 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var helper_exports = {};
+__export(helper_exports, {
+  registerModernRuntimePath: () => registerModernRuntimePath
+});
+module.exports = __toCommonJS(helper_exports);
+var path = __toESM(require("path"));
+var import_bff_core = require("@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 = (0, import_bff_core.registerPaths)(paths);
+  return unRegister;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  registerModernRuntimePath
+});

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./constants"), module.exports);

package/dist/cjs/loader.js

@@ -0,0 +1,67 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var loader_exports = {};
+__export(loader_exports, {
+  default: () => loader_default
+});
+module.exports = __toCommonJS(loader_exports);
+var import_bff_core = require("@modern-js/bff-core");
+var import_utils = require("@modern-js/utils");
+async function loader(source) {
+  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) {
+    import_utils.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,
+    httpMethodDecider: draftOptions.httpMethodDecider
+  };
+  const { lambdaDir } = draftOptions;
+  if (!resourcePath.startsWith(lambdaDir)) {
+    import_utils.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 = await (0, import_bff_core.generateClient)(options);
+  if (result.isOk) {
+    callback(void 0, result.value);
+  } else {
+    callback(void 0, `throw new Error('${result.value}')`);
+  }
+}
+var loader_default = loader;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/cjs/server.js

@@ -0,0 +1,98 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => server_default
+});
+module.exports = __toCommonJS(server_exports);
+var import_path = __toESM(require("path"));
+var import_bff_core = require("@modern-js/bff-core");
+var import_utils = require("@modern-js/utils");
+var import_constants = require("./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 = (0, import_utils.isProd)() ? distDirectory : appDirectory;
+        const apiPath = import_path.default.resolve(root || process.cwd(), import_utils.API_DIR);
+        apiAppPath = import_path.default.resolve(apiPath, import_constants.API_APP_NAME);
+        const apiMod = (0, import_utils.requireExistModule)(apiAppPath);
+        if (apiMod && typeof apiMod === "function") {
+          apiMod(transformAPI);
+        }
+      },
+      reset() {
+        storage.reset();
+        const newApiModule = (0, import_utils.requireExistModule)(apiAppPath);
+        if (newApiModule && typeof newApiModule === "function") {
+          newApiModule(transformAPI);
+        }
+      },
+      gather({ addAPIMiddleware }) {
+        storage.middlewares.forEach((mid) => {
+          addAPIMiddleware(mid);
+        });
+      },
+      prepareApiServer(props, next) {
+        const { pwd, prefix, httpMethodDecider } = props;
+        const apiDir = import_path.default.resolve(pwd, import_utils.API_DIR);
+        const appContext = api.useAppContext();
+        const apiRouter = new import_bff_core.ApiRouter({
+          apiDir,
+          prefix,
+          httpMethodDecider
+        });
+        const apiMode = apiRouter.getApiMode();
+        const apiHandlerInfos = apiRouter.getApiHandlers();
+        api.setAppContext({
+          ...appContext,
+          apiRouter,
+          apiHandlerInfos,
+          apiMode
+        });
+        return next(props);
+      }
+    };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});