@modern-js/plugin-bff 2.69.7 → 3.0.0-alpha.1

package/dist/esm-node/cli.js

@@ -1,246 +0,0 @@
-import path from "path";
-import { ApiRouter } from "@modern-js/bff-core";
-import { compile } from "@modern-js/server-utils";
-import { fs, API_DIR, DEFAULT_API_PREFIX, SHARED_DIR, normalizeOutputPath } from "@modern-js/utils";
-import clientGenerator from "./utils/clientGenerator";
-import pluginGenerator from "./utils/pluginGenerator";
-import runtimeGenerator from "./utils/runtimeGenerator";
-const TS_CONFIG_FILENAME = "tsconfig.json";
-const RUNTIME_CREATE_REQUEST = "@modern-js/plugin-bff/runtime/create-request";
-const RUNTIME_HONO = "@modern-js/plugin-bff/hono";
-const bffPlugin = () => ({
-  name: "@modern-js/plugin-bff",
-  setup: (api) => {
-    const compileApi = async () => {
-      const { appDirectory, distDirectory, apiDirectory, sharedDirectory, moduleType } = api.useAppContext();
-      const modernConfig = api.useResolvedConfigContext();
-      const distDir = path.resolve(distDirectory);
-      const apiDir = apiDirectory || path.resolve(appDirectory, API_DIR);
-      const sharedDir = sharedDirectory || path.resolve(appDirectory, SHARED_DIR);
-      const tsconfigPath = path.resolve(appDirectory, TS_CONFIG_FILENAME);
-      const sourceDirs = [];
-      if (await fs.pathExists(apiDir)) {
-        sourceDirs.push(apiDir);
-      }
-      if (await fs.pathExists(sharedDir)) {
-        sourceDirs.push(sharedDir);
-      }
-      const { server } = modernConfig;
-      const { alias } = modernConfig.source;
-      const { alias: resolveAlias } = modernConfig.resolve;
-      const { babel } = modernConfig.tools;
-      if (sourceDirs.length > 0) {
-        const combinedAlias = [].concat(alias !== null && alias !== void 0 ? alias : []).concat(resolveAlias !== null && resolveAlias !== void 0 ? resolveAlias : []);
-        await compile(appDirectory, {
-          server,
-          alias: combinedAlias,
-          babelConfig: babel
-        }, {
-          sourceDirs,
-          distDir,
-          tsconfigPath,
-          moduleType,
-          throwErrorInsteadOfExit: true
-        });
-      }
-    };
-    const generator = async () => {
-      var _modernConfig_output_distPath, _modernConfig_output;
-      const { appDirectory, apiDirectory, lambdaDirectory, port } = api.useAppContext();
-      const modernConfig = api.useResolvedConfigContext();
-      const relativeDistPath = (modernConfig === null || modernConfig === void 0 ? void 0 : (_modernConfig_output = modernConfig.output) === null || _modernConfig_output === void 0 ? void 0 : (_modernConfig_output_distPath = _modernConfig_output.distPath) === null || _modernConfig_output_distPath === void 0 ? void 0 : _modernConfig_output_distPath.root) || "dist";
-      const { bff } = modernConfig || {};
-      const prefix = (bff === null || bff === void 0 ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-      const httpMethodDecider = bff === null || bff === void 0 ? void 0 : bff.httpMethodDecider;
-      const apiRouter = new ApiRouter({
-        apiDir: apiDirectory,
-        appDir: appDirectory,
-        lambdaDir: lambdaDirectory,
-        prefix,
-        httpMethodDecider,
-        isBuild: true
-      });
-      const lambdaDir = apiRouter.getLambdaDir();
-      const existLambda = apiRouter.isExistLambda();
-      const runtime = (bff === null || bff === void 0 ? void 0 : bff.runtimeCreateRequest) || RUNTIME_CREATE_REQUEST;
-      const relativeApiPath = path.relative(appDirectory, apiDirectory);
-      const relativeLambdaPath = path.relative(appDirectory, lambdaDir);
-      await pluginGenerator({
-        prefix,
-        appDirectory,
-        relativeDistPath,
-        relativeApiPath,
-        relativeLambdaPath
-      });
-      await clientGenerator({
-        prefix,
-        appDir: appDirectory,
-        apiDir: apiDirectory,
-        lambdaDir,
-        existLambda,
-        port,
-        requestCreator: bff === null || bff === void 0 ? void 0 : bff.requestCreator,
-        httpMethodDecider,
-        relativeDistPath,
-        relativeApiPath
-      });
-      await runtimeGenerator({
-        runtime,
-        appDirectory,
-        relativeDistPath
-      });
-    };
-    const handleCrossProjectInvocation = async (isBuild = false) => {
-      const { bff } = api.useResolvedConfigContext();
-      if (bff === null || bff === void 0 ? void 0 : bff.crossProject) {
-        if (!isBuild) {
-          await compileApi();
-        }
-        await generator();
-      }
-    };
-    const isHono = () => {
-      const { bffRuntimeFramework } = api.useAppContext();
-      return bffRuntimeFramework === "hono";
-    };
-    return {
-      config() {
-        var _api_useConfigContext_tools, _api_useConfigContext, _api_useConfigContext_bff, _api_useConfigContext1;
-        const honoRuntimePath = isHono() ? {
-          [RUNTIME_HONO]: RUNTIME_HONO
-        } : void 0;
-        const devServer = (_api_useConfigContext = api.useConfigContext()) === null || _api_useConfigContext === void 0 ? void 0 : (_api_useConfigContext_tools = _api_useConfigContext.tools) === null || _api_useConfigContext_tools === void 0 ? void 0 : _api_useConfigContext_tools.devServer;
-        const prefix = ((_api_useConfigContext1 = api.useConfigContext()) === null || _api_useConfigContext1 === void 0 ? void 0 : (_api_useConfigContext_bff = _api_useConfigContext1.bff) === null || _api_useConfigContext_bff === void 0 ? void 0 : _api_useConfigContext_bff.prefix) || DEFAULT_API_PREFIX;
-        if (typeof devServer === "object" && devServer !== null && !Array.isArray(devServer)) {
-          const compress = devServer.compress;
-          if (typeof compress === "undefined" || compress === true) {
-            devServer.compress = {
-              filter: (req) => {
-                var _req_url;
-                return !((_req_url = req.url) === null || _req_url === void 0 ? void 0 : _req_url.includes(prefix));
-              }
-            };
-          }
-        }
-        return {
-          tools: {
-            bundlerChain: (chain, { CHAIN_ID, isServer }) => {
-              const { port, appDirectory, apiDirectory, lambdaDirectory } = api.useAppContext();
-              const modernConfig = api.useResolvedConfigContext();
-              const { bff } = modernConfig || {};
-              const prefix2 = (bff === null || bff === void 0 ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
-              const httpMethodDecider = bff === null || bff === void 0 ? void 0 : bff.httpMethodDecider;
-              const apiRouter = new ApiRouter({
-                apiDir: apiDirectory,
-                appDir: appDirectory,
-                lambdaDir: lambdaDirectory,
-                prefix: prefix2,
-                httpMethodDecider,
-                isBuild: true
-              });
-              const lambdaDir = apiRouter.getLambdaDir();
-              const existLambda = apiRouter.isExistLambda();
-              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("js-bff-api").test(apiRegexp).use("custom-loader").loader(require.resolve("./loader").replace(/\\/g, "/")).options({
-                prefix: prefix2,
-                appDir: appDirectory,
-                apiDir: apiDirectory,
-                lambdaDir,
-                existLambda,
-                port,
-                target: name,
-                // Internal field
-                requestCreator: bff === null || bff === void 0 ? void 0 : bff.requestCreator,
-                httpMethodDecider
-              });
-              chain.resolve.alias.set("@api", apiDirectory);
-              chain.resolve.alias.set("@modern-js/runtime/bff", RUNTIME_CREATE_REQUEST);
-            }
-          },
-          source: {
-            moduleScopes: [
-              `./${API_DIR}`,
-              /create-request/
-            ]
-          },
-          output: {
-            externals: honoRuntimePath
-          }
-        };
-      },
-      modifyServerRoutes({ routes }) {
-        const modernConfig = api.useResolvedConfigContext();
-        const { bff } = modernConfig || {};
-        const prefix = (bff === null || bff === void 0 ? 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 (!isHono() && (bff === null || bff === void 0 ? void 0 : bff.enableHandleWeb)) {
-          return {
-            routes: routes.map((route) => {
-              return {
-                ...route,
-                isApi: true
-              };
-            }).concat(apiServerRoutes)
-          };
-        }
-        return {
-          routes: routes.concat(apiServerRoutes)
-        };
-      },
-      _internalServerPlugins({ plugins }) {
-        plugins.push({
-          name: "@modern-js/plugin-bff/server"
-        });
-        return {
-          plugins
-        };
-      },
-      async beforeDev() {
-        await handleCrossProjectInvocation();
-      },
-      async afterBuild() {
-        await compileApi();
-        await handleCrossProjectInvocation(true);
-      },
-      async watchFiles() {
-        var _config_bff;
-        const appContext = api.useAppContext();
-        const config = api.useResolvedConfigContext();
-        if (config === null || config === void 0 ? void 0 : (_config_bff = config.bff) === null || _config_bff === void 0 ? void 0 : _config_bff.crossProject) {
-          return [
-            appContext.apiDirectory
-          ];
-        } else {
-          return [];
-        }
-      },
-      async fileChange(e) {
-        const { filename, eventType, isPrivate } = e;
-        const { appDirectory, apiDirectory } = api.useAppContext();
-        const relativeApiPath = path.relative(appDirectory, apiDirectory);
-        if (!isPrivate && (eventType === "change" || eventType === "unlink") && filename.startsWith(`${relativeApiPath}/`) && (filename.endsWith(".ts") || filename.endsWith(".js"))) {
-          await handleCrossProjectInvocation();
-        }
-      }
-    };
-  }
-});
-var cli_default = bffPlugin;
-export {
-  bffPlugin,
-  cli_default as default
-};

package/dist/esm-node/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/esm-node/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/esm-node/loader.js

@@ -1,49 +0,0 @@
-import { generateClient } from "@modern-js/bff-core";
-import { logger } from "@modern-js/utils";
-async function loader(source) {
-  this.cacheable();
-  const { resourcePath } = this;
-  delete require.cache[resourcePath];
-  const callback = this.async();
-  const draftOptions = this.getOptions();
-  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,
-    appDir: draftOptions.appDir,
-    apiDir: draftOptions.apiDir,
-    lambdaDir: draftOptions.lambdaDir,
-    target: draftOptions.target,
-    port: Number(draftOptions.port),
-    source,
-    resourcePath,
-    httpMethodDecider: draftOptions.httpMethodDecider
-  };
-  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 = await 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/esm-node/runtime/hono/adapter.js

@@ -1,103 +0,0 @@
-import { Hono } from "@modern-js/server-core";
-import { isProd, logger } from "@modern-js/utils";
-import createHonoRoutes from "../../utils/createHonoRoutes";
-const before = [
-  "custom-server-hook",
-  "custom-server-middleware",
-  "render"
-];
-class HonoAdapter {
-  wrapInArray(handler) {
-    if (Array.isArray(handler)) {
-      return handler;
-    } else {
-      return [
-        handler
-      ];
-    }
-  }
-  constructor(api) {
-    this.apiMiddleware = [];
-    this.apiServer = null;
-    this.isHono = true;
-    this.setHandlers = async () => {
-      if (!this.isHono) {
-        return;
-      }
-      const { apiHandlerInfos } = this.api.useAppContext();
-      const honoHandlers = createHonoRoutes(apiHandlerInfos);
-      this.apiMiddleware = honoHandlers.map(({ path, method, handler }) => ({
-        name: "hono-bff-api",
-        path,
-        method,
-        handler,
-        order: "post",
-        before
-      }));
-    };
-    this.registerApiRoutes = async () => {
-      if (!this.isHono) {
-        return;
-      }
-      this.apiServer = new Hono();
-      this.apiMiddleware.forEach(({ path = "*", method = "all", handler }) => {
-        var _this_apiServer;
-        const handlers = this.wrapInArray(handler);
-        (_this_apiServer = this.apiServer) === null || _this_apiServer === void 0 ? void 0 : _this_apiServer[method](path, ...handlers);
-      });
-      this.apiServer.onError(async (err, c) => {
-        try {
-          const serverConfig = this.api.useConfigContext();
-          const onErrorHandler = serverConfig === null || serverConfig === void 0 ? void 0 : serverConfig.onError;
-          if (onErrorHandler) {
-            const result = await onErrorHandler(err, c);
-            if (result instanceof Response) {
-              return result;
-            }
-          }
-        } catch (configError) {
-          logger.error(`Error in serverConfig.onError handler: ${configError}`);
-        }
-        return c.json({
-          message: (err === null || err === void 0 ? void 0 : err.message) || "[BFF] Internal Server Error"
-        }, (err === null || err === void 0 ? void 0 : err.status) || 500);
-      });
-    };
-    this.registerMiddleware = async (options) => {
-      const { prefix } = options;
-      const { bffRuntimeFramework } = this.api.useAppContext();
-      if (bffRuntimeFramework !== "hono") {
-        this.isHono = false;
-        return;
-      }
-      const { middlewares: globalMiddlewares } = this.api.useAppContext();
-      await this.setHandlers();
-      if (isProd()) {
-        globalMiddlewares.push(...this.apiMiddleware);
-      } else {
-        await this.registerApiRoutes();
-        const dynamicApiMiddleware = {
-          name: "dynamic-bff-handler",
-          path: `${prefix}/*`,
-          method: "all",
-          order: "post",
-          before,
-          handler: async (c, next) => {
-            if (this.apiServer) {
-              const response = await this.apiServer.fetch(c.req, c.env);
-              if (response.status !== 404) {
-                return new Response(response.body, response);
-              }
-            }
-            await next();
-          }
-        };
-        globalMiddlewares.push(dynamicApiMiddleware);
-      }
-    };
-    this.api = api;
-  }
-}
-export {
-  HonoAdapter
-};

package/dist/esm-node/runtime/hono/operators.js

@@ -1,46 +0,0 @@
-import { useHonoContext } from "@modern-js/server-core";
-const Pipe = (func) => {
-  return {
-    name: "pipe",
-    async execute(executeHelper, next) {
-      const { inputs } = executeHelper;
-      const ctx = useHonoContext();
-      const { res } = ctx;
-      if (typeof func === "function") {
-        let isPiped = true;
-        const end = (value) => {
-          isPiped = false;
-          if (typeof value === "function") {
-            value(res);
-            return;
-          }
-          return value;
-        };
-        const output = await func(inputs, end);
-        if (!isPiped) {
-          if (output) {
-            return executeHelper.result = output;
-          } else {
-            return;
-          }
-        }
-        executeHelper.inputs = output;
-        await next();
-      }
-    }
-  };
-};
-const Middleware = (middleware) => {
-  return {
-    name: "middleware",
-    metadata(helper) {
-      const middlewares = helper.getMetadata("pipe") || [];
-      middlewares.push(middleware);
-      helper.setMetadata("middleware", middlewares);
-    }
-  };
-};
-export {
-  Middleware,
-  Pipe
-};

package/dist/esm-node/server.js

@@ -1,142 +0,0 @@
-import path from "path";
-import { ApiRouter } from "@modern-js/bff-core";
-import { API_DIR, isProd, isWebOnly, requireExistModule } from "@modern-js/utils";
-import { isFunction } from "@modern-js/utils";
-import { API_APP_NAME } from "./constants";
-import { HonoAdapter } from "./runtime/hono/adapter";
-class Storage {
-  reset() {
-    this.middlewares = [];
-  }
-  constructor() {
-    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 = "";
-    let apiRouter;
-    const honoAdapter = new HonoAdapter(api);
-    return {
-      async prepare() {
-        var _config_bff, _config_bff1, _config_bff2;
-        const appContext = api.useAppContext();
-        const { appDirectory, distDirectory, render } = appContext;
-        const root = isProd() ? distDirectory : appDirectory;
-        const apiPath = path.resolve(root || process.cwd(), API_DIR);
-        apiAppPath = path.resolve(apiPath, API_APP_NAME);
-        const apiMod = await requireExistModule(apiAppPath);
-        if (apiMod && typeof apiMod === "function") {
-          apiMod(transformAPI);
-        }
-        const { middlewares } = storage;
-        api.setAppContext({
-          ...appContext,
-          apiMiddlewares: middlewares
-        });
-        const config = api.useConfigContext();
-        const prefix = (config === null || config === void 0 ? void 0 : (_config_bff = config.bff) === null || _config_bff === void 0 ? void 0 : _config_bff.prefix) || "/api";
-        const enableHandleWeb = config === null || config === void 0 ? void 0 : (_config_bff1 = config.bff) === null || _config_bff1 === void 0 ? void 0 : _config_bff1.enableHandleWeb;
-        const httpMethodDecider = config === null || config === void 0 ? void 0 : (_config_bff2 = config.bff) === null || _config_bff2 === void 0 ? void 0 : _config_bff2.httpMethodDecider;
-        const { distDirectory: pwd, middlewares: globalMiddlewares } = api.useAppContext();
-        const webOnly = await isWebOnly();
-        let handler;
-        if (webOnly) {
-          handler = async (c, next) => {
-            c.body("");
-            await next();
-          };
-        } else {
-          const runner = api.useHookRunners();
-          const renderHandler = enableHandleWeb ? render : null;
-          handler = await runner.prepareApiServer({
-            pwd,
-            prefix,
-            render: renderHandler,
-            httpMethodDecider
-          }, {
-            onLast: () => null
-          });
-        }
-        if (handler && isFunction(handler)) {
-          globalMiddlewares.push({
-            name: "bind-bff",
-            handler: (c, next) => {
-              if (!c.req.path.startsWith(prefix) && !enableHandleWeb) {
-                return next();
-              } else {
-                return handler(c, next);
-              }
-            },
-            order: "post",
-            before: [
-              "custom-server-hook",
-              "custom-server-middleware",
-              "render"
-            ]
-          });
-        }
-        honoAdapter.registerMiddleware({
-          prefix,
-          enableHandleWeb
-        });
-      },
-      async reset({ event }) {
-        storage.reset();
-        const appContext = api.useAppContext();
-        const newApiModule = await requireExistModule(apiAppPath);
-        if (newApiModule && typeof newApiModule === "function") {
-          newApiModule(transformAPI);
-        }
-        const { middlewares } = storage;
-        api.setAppContext({
-          ...appContext,
-          apiMiddlewares: middlewares
-        });
-        if (event.type === "file-change") {
-          const apiHandlerInfos = await apiRouter.getApiHandlers();
-          const appContext2 = api.useAppContext();
-          api.setAppContext({
-            ...appContext2,
-            apiHandlerInfos
-          });
-          await honoAdapter.setHandlers();
-          await honoAdapter.registerApiRoutes();
-        }
-      },
-      async prepareApiServer(props, next) {
-        const { pwd, prefix, httpMethodDecider } = props;
-        const apiDir = path.resolve(pwd, API_DIR);
-        const appContext = api.useAppContext();
-        const { apiDirectory, lambdaDirectory } = appContext;
-        apiRouter = new ApiRouter({
-          appDir: pwd,
-          apiDir: apiDirectory || apiDir,
-          lambdaDir: lambdaDirectory,
-          prefix,
-          httpMethodDecider
-        });
-        const apiMode = apiRouter.getApiMode();
-        const apiHandlerInfos = await apiRouter.getApiHandlers();
-        api.setAppContext({
-          ...appContext,
-          apiRouter,
-          apiHandlerInfos,
-          apiMode
-        });
-        return next(props);
-      }
-    };
-  }
-});
-export {
-  server_default as default
-};