@modern-js/plugin-bff 1.1.1 → 1.1.3-rc.0

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @modern-js/plugin-bff
 
+## 1.1.3-rc.0
+
+### Patch Changes
+
+- Updated dependencies [d927bc83]
+- Updated dependencies [d73ff455]
+- Updated dependencies [9c1ab865]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d927bc83]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d73ff455]
+  - @modern-js/utils@1.1.4-rc.0
+  - @modern-js/core@1.1.4-rc.0
+  - @modern-js/babel-preset-lib@1.1.3-rc.0
+  - @modern-js/bff-utils@1.1.2-rc.0
+  - @modern-js/create-request@1.1.2-rc.0
+  - @modern-js/server-utils@1.1.3-rc.0
+  - @modern-js/babel-compiler@1.1.3-rc.0
+  - @modern-js/server-plugin@1.1.2
+  - @modern-js/babel-chain@1.1.1
+
+## 1.1.2
+
+### Patch Changes
+
+- 085a6a58: refactor server plugin
+- 39e8137d: fix: support prefix array & webpack loader should read requestCreator & adjust runtime path to relative
+- 085a6a58: refactor server plugin
+- 085a6a58: refactor server conifg
+- 085a6a58: support server runtime
+- 085a6a58: feat: refactor server plugin
+- Updated dependencies [085a6a58]
+- Updated dependencies [085a6a58]
+- Updated dependencies [085a6a58]
+- Updated dependencies [d280ea33]
+- Updated dependencies [d4fcc73a]
+- Updated dependencies [085a6a58]
+- Updated dependencies [ed1f6b12]
+- Updated dependencies [a5ebbb00]
+- Updated dependencies [085a6a58]
+  - @modern-js/core@1.1.3
+  - @modern-js/server-plugin@1.1.2
+  - @modern-js/server-utils@1.1.2
+  - @modern-js/utils@1.1.3
+
 ## 1.1.1
 
 ### Patch Changes

package/dist/js/modern/cli.js

@@ -2,9 +2,8 @@ import path from 'path';
 import fs from 'fs-extra';
 import { createPlugin, useAppContext, useResolvedConfigContext } from '@modern-js/core';
 import { compiler } from '@modern-js/babel-compiler';
-import { PLUGIN_SCHEMAS, normalizeOutputPath } from '@modern-js/utils';
+import { PLUGIN_SCHEMAS, normalizeOutputPath, API_DIR } from '@modern-js/utils';
 import { resolveBabelConfig } from '@modern-js/server-utils';
-import { API_DIR } from "./constants";
 const DEFAULT_API_PREFIX = '/api';
 const TS_CONFIG_FILENAME = 'tsconfig.json';
 const FILE_EXTENSIONS = ['.js', '.ts', '.mjs', '.ejs'];
@@ -41,7 +40,8 @@ export default createPlugin(() => ({
             apiDir: rootDir,
             port,
             fetcher,
-            target: _config.name
+            target: _config.name,
+            requestCreator: bff === null || bff === void 0 ? void 0 : bff.requestCreator
           });
         }
       },

package/dist/js/modern/constants.js

@@ -1,2 +1,2 @@
-export const API_DIR = 'api';
+export const API_APP_NAME = '_app';
 export const BUILD_FILES = ['**/*.[tj]sx?', '!**/*.test.jsx?', '!**/*.test.tsx?', '!**/*.spec.jsx?', '!**/*.spec.tsx?', '!__tests__/*.tsx?', '!__tests__/*.jsx?'];

package/dist/js/modern/loader.js

@@ -9,7 +9,7 @@ async function loader(source) {
 
   const draftOptions = getOptions(this);
   const options = {
-    prefix: draftOptions.prefix,
+    prefix: Array.isArray(draftOptions.prefix) ? draftOptions.prefix[0] : draftOptions.prefix,
     apiDir: draftOptions.apiDir,
     target: draftOptions.target,
     port: Number(draftOptions.port),

package/dist/js/modern/server.js

@@ -1,18 +1,73 @@
 import path from 'path';
 import { createPlugin } from '@modern-js/server-plugin';
 import { injectAPIHandlerInfos } from '@modern-js/bff-utils';
-import { API_DIR } from "./constants";
-export default createPlugin(() => ({
-  prepareApiServer(props, next) {
-    const {
-      pwd,
-      prefix
-    } = props;
-    const apiDir = path.resolve(pwd, API_DIR);
-    injectAPIHandlerInfos(apiDir, prefix);
-    return next(props);
+import { useAppContext } from '@modern-js/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);
+  }
+
+});
+
+export default createPlugin(() => {
+  const {
+    appDirectory,
+    distDirectory
+  } = useAppContext();
+  const root = isProd() ? distDirectory : appDirectory;
+  const apiPath = path.resolve(root || process.cwd(), API_DIR);
+  const apiAppPath = path.resolve(apiPath, API_APP_NAME);
+  const storage = new Storage();
+  const transformAPI = createTransformAPI(storage);
+  const apiMod = requireExistModule(apiAppPath);
+
+  if (apiMod) {
+    apiMod(transformAPI);
   }
 
-}), {
+  return {
+    reset() {
+      storage.reset();
+      const newApiModule = requireExistModule(apiAppPath);
+
+      if (newApiModule) {
+        newApiModule(transformAPI);
+      }
+    },
+
+    gather({
+      addAPIMiddleware
+    }) {
+      storage.middlewares.forEach(mid => {
+        addAPIMiddleware(mid);
+      });
+    },
+
+    prepareApiServer(props, next) {
+      const {
+        pwd,
+        prefix
+      } = props;
+      const apiDir = path.resolve(pwd, API_DIR);
+      injectAPIHandlerInfos(apiDir, prefix);
+      return next(props);
+    }
+
+  };
+}, {
   name: '@modern-js/plugin-bff'
 });

package/dist/js/node/cli.js

@@ -17,8 +17,6 @@ var _utils = require("@modern-js/utils");
 
 var _serverUtils = require("@modern-js/server-utils");
 
-var _constants = require("./constants");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const DEFAULT_API_PREFIX = '/api';
@@ -51,7 +49,7 @@ var _default = (0, _core.createPlugin)(() => ({
           } = bff || {};
           const prefix = (bff === null || bff === void 0 ? void 0 : bff.prefix) || DEFAULT_API_PREFIX;
 
-          const rootDir = _path.default.resolve(appDirectory, _constants.API_DIR);
+          const rootDir = _path.default.resolve(appDirectory, _utils.API_DIR);
 
           chain.resolve.alias.set('@api', rootDir);
           const apiRegexp = new RegExp((0, _utils.normalizeOutputPath)(`${appDirectory}${_path.default.sep}api${_path.default.sep}.*(.[tj]s)$`));
@@ -60,12 +58,13 @@ var _default = (0, _core.createPlugin)(() => ({
             apiDir: rootDir,
             port,
             fetcher,
-            target: _config.name
+            target: _config.name,
+            requestCreator: bff === null || bff === void 0 ? void 0 : bff.requestCreator
           });
         }
       },
       source: {
-        moduleScopes: [`./${_constants.API_DIR}`]
+        moduleScopes: [`./${_utils.API_DIR}`]
       }
     };
   },
@@ -109,11 +108,11 @@ var _default = (0, _core.createPlugin)(() => ({
 
     const modernConfig = (0, _core.useResolvedConfigContext)();
 
-    const rootDir = _path.default.resolve(appDirectory, _constants.API_DIR);
+    const rootDir = _path.default.resolve(appDirectory, _utils.API_DIR);
 
-    const distDir = _path.default.resolve(distDirectory, _constants.API_DIR);
+    const distDir = _path.default.resolve(distDirectory, _utils.API_DIR);
 
-    const sourceAbsDir = _path.default.resolve(appDirectory, _constants.API_DIR);
+    const sourceAbsDir = _path.default.resolve(appDirectory, _utils.API_DIR);
 
     const tsconfigPath = _path.default.resolve(appDirectory, TS_CONFIG_FILENAME);
 

package/dist/js/node/constants.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.BUILD_FILES = exports.API_DIR = void 0;
-const API_DIR = 'api';
-exports.API_DIR = API_DIR;
+exports.BUILD_FILES = exports.API_APP_NAME = void 0;
+const API_APP_NAME = '_app';
+exports.API_APP_NAME = API_APP_NAME;
 const BUILD_FILES = ['**/*.[tj]sx?', '!**/*.test.jsx?', '!**/*.test.tsx?', '!**/*.spec.jsx?', '!**/*.spec.tsx?', '!__tests__/*.tsx?', '!__tests__/*.jsx?'];
 exports.BUILD_FILES = BUILD_FILES;

package/dist/js/node/loader.js

@@ -17,7 +17,7 @@ async function loader(source) {
 
   const draftOptions = (0, _loaderUtils.getOptions)(this);
   const options = {
-    prefix: draftOptions.prefix,
+    prefix: Array.isArray(draftOptions.prefix) ? draftOptions.prefix[0] : draftOptions.prefix,
     apiDir: draftOptions.apiDir,
     target: draftOptions.target,
     port: Number(draftOptions.port),

package/dist/js/node/server.js

@@ -11,24 +11,83 @@ var _serverPlugin = require("@modern-js/server-plugin");
 
 var _bffUtils = require("@modern-js/bff-utils");
 
+var _core = require("@modern-js/core");
+
+var _utils = require("@modern-js/utils");
+
 var _constants = require("./constants");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var _default = (0, _serverPlugin.createPlugin)(() => ({
-  prepareApiServer(props, next) {
-    const {
-      pwd,
-      prefix
-    } = props;
+class Storage {
+  constructor() {
+    this.middlewares = [];
+  }
+
+  reset() {
+    this.middlewares = [];
+  }
 
-    const apiDir = _path.default.resolve(pwd, _constants.API_DIR);
+}
 
-    (0, _bffUtils.injectAPIHandlerInfos)(apiDir, prefix);
-    return next(props);
+const createTransformAPI = storage => ({
+  addMiddleware(fn) {
+    storage.middlewares.push(fn);
   }
 
-}), {
+});
+
+var _default = (0, _serverPlugin.createPlugin)(() => {
+  const {
+    appDirectory,
+    distDirectory
+  } = (0, _core.useAppContext)();
+  const root = (0, _utils.isProd)() ? distDirectory : appDirectory;
+
+  const apiPath = _path.default.resolve(root || process.cwd(), _utils.API_DIR);
+
+  const apiAppPath = _path.default.resolve(apiPath, _constants.API_APP_NAME);
+
+  const storage = new Storage();
+  const transformAPI = createTransformAPI(storage);
+  const apiMod = (0, _utils.requireExistModule)(apiAppPath);
+
+  if (apiMod) {
+    apiMod(transformAPI);
+  }
+
+  return {
+    reset() {
+      storage.reset();
+      const newApiModule = (0, _utils.requireExistModule)(apiAppPath);
+
+      if (newApiModule) {
+        newApiModule(transformAPI);
+      }
+    },
+
+    gather({
+      addAPIMiddleware
+    }) {
+      storage.middlewares.forEach(mid => {
+        addAPIMiddleware(mid);
+      });
+    },
+
+    prepareApiServer(props, next) {
+      const {
+        pwd,
+        prefix
+      } = props;
+
+      const apiDir = _path.default.resolve(pwd, _utils.API_DIR);
+
+      (0, _bffUtils.injectAPIHandlerInfos)(apiDir, prefix);
+      return next(props);
+    }
+
+  };
+}, {
   name: '@modern-js/plugin-bff'
 });
 

package/dist/types/cli.d.ts

@@ -2,7 +2,7 @@ declare module '@modern-js/core' {
   interface UserConfig {
     bff: {
       prefix?: string;
-      requestCreater?: string;
+      requestCreator?: string;
       fetcher?: string;
       proxy: Record<string, any>;
     };

package/dist/types/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const API_DIR = "api";
+export declare const API_APP_NAME = "_app";
 export declare const BUILD_FILES: string[];

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.1.1",
+  "version": "1.1.3-rc.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -45,23 +45,23 @@
     "@babel/core": "^7.15.5",
     "@babel/runtime": "^7",
     "@modern-js/babel-chain": "^1.1.1",
-    "@modern-js/babel-compiler": "^1.1.2",
-    "@modern-js/babel-preset-lib": "^1.1.1",
-    "@modern-js/create-request": "^1.1.1",
-    "@modern-js/server-utils": "^1.1.1",
-    "@modern-js/utils": "^1.1.2",
+    "@modern-js/babel-compiler": "^1.1.3-rc.0",
+    "@modern-js/babel-preset-lib": "^1.1.3-rc.0",
+    "@modern-js/create-request": "^1.1.2-rc.0",
+    "@modern-js/server-utils": "^1.1.3-rc.0",
+    "@modern-js/utils": "^1.1.4-rc.0",
     "fs-extra": "^10.0.0",
     "loader-utils": "^2.0.0"
   },
   "devDependencies": {
-    "@modern-js/bff-utils": "^1.1.1",
-    "@modern-js/core": "^1.1.2",
-    "@modern-js/module-tools": "^1.1.0",
-    "@modern-js/plugin-analyze": "^1.1.1",
-    "@modern-js/plugin-testing": "^1.1.0",
-    "@modern-js/runtime": "^1.1.1",
-    "@modern-js/server-plugin": "^1.1.1",
-    "@modern-js/types": "^1.1.2",
+    "@modern-js/bff-utils": "^1.1.2-rc.0",
+    "@modern-js/core": "^1.1.4-rc.0",
+    "@modern-js/module-tools": "^1.1.1",
+    "@modern-js/plugin-analyze": "^1.1.2-rc.0",
+    "@modern-js/plugin-testing": "^1.1.1",
+    "@modern-js/runtime": "^1.1.2-rc.0",
+    "@modern-js/server-plugin": "^1.1.2",
+    "@modern-js/types": "^1.1.3-rc.0",
     "@types/babel__core": "^7.1.15",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^26",
@@ -74,9 +74,9 @@
     "webpack-chain": "^6.5.1"
   },
   "peerDependencies": {
-    "@modern-js/bff-utils": "^1.1.1",
-    "@modern-js/core": "^1.1.2",
-    "@modern-js/server-plugin": "^1.1.1"
+    "@modern-js/bff-utils": "^1.1.2-rc.0",
+    "@modern-js/core": "^1.1.4-rc.0",
+    "@modern-js/server-plugin": "^1.1.2"
   },
   "modernConfig": {
     "output": {
@@ -93,5 +93,6 @@
     "build": "modern build",
     "dev": "modern build --watch",
     "test": "modern test"
-  }
+  },
+  "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/src/cli.ts

@@ -6,19 +6,18 @@ import {
   useResolvedConfigContext,
 } from '@modern-js/core';
 import { compiler } from '@modern-js/babel-compiler';
-import { PLUGIN_SCHEMAS, normalizeOutputPath } from '@modern-js/utils';
+import { PLUGIN_SCHEMAS, normalizeOutputPath, API_DIR } from '@modern-js/utils';
 import { resolveBabelConfig } from '@modern-js/server-utils';
 
 import type { Configuration } from 'webpack';
 import type Chain from 'webpack-chain';
 import type { ServerRoute } from '@modern-js/types';
-import { API_DIR } from './constants';
 
 declare module '@modern-js/core' {
   interface UserConfig {
     bff: {
       prefix?: string;
-      requestCreater?: string;
+      requestCreator?: string;
       fetcher?: string;
       proxy: Record<string, any>;
     };
@@ -69,6 +68,7 @@ export default createPlugin(
                 port,
                 fetcher,
                 target: _config.name,
+                requestCreator: bff?.requestCreator,
               });
           },
         },

package/src/constants.ts

@@ -1,4 +1,4 @@
-export const API_DIR = 'api';
+export const API_APP_NAME = '_app';
 
 export const BUILD_FILES = [
   '**/*.[tj]sx?',

package/src/loader.ts

@@ -20,7 +20,9 @@ async function loader(this: LoaderContext<APILoaderOptions>, source: string) {
   const draftOptions = getOptions(this as any);
 
   const options: GenClientOptions = {
-    prefix: draftOptions.prefix as string,
+    prefix: (Array.isArray(draftOptions.prefix)
+      ? draftOptions.prefix[0]
+      : draftOptions.prefix) as string,
     apiDir: draftOptions.apiDir as string,
     target: draftOptions.target as string,
     port: Number(draftOptions.port),

package/src/server.ts

@@ -1,18 +1,64 @@
 import path from 'path';
 import { createPlugin } from '@modern-js/server-plugin';
 import { injectAPIHandlerInfos } from '@modern-js/bff-utils';
-import { API_DIR } from './constants';
+import { useAppContext } from '@modern-js/core';
+import { API_DIR, isProd, requireExistModule } from '@modern-js/utils';
+import { API_APP_NAME } from './constants';
+
+type SF = (args: any) => void;
+class Storage {
+  public middlewares: SF[] = [];
+
+  reset() {
+    this.middlewares = [];
+  }
+}
+
+const createTransformAPI = (storage: Storage) => ({
+  addMiddleware(fn: SF) {
+    storage.middlewares.push(fn);
+  },
+});
 
 export default createPlugin(
-  () => ({
-    prepareApiServer(props, next) {
-      const { pwd, prefix } = props;
-      const apiDir = path.resolve(pwd, API_DIR);
+  () => {
+    const { appDirectory, distDirectory } = useAppContext();
+
+    const root = isProd() ? distDirectory : appDirectory;
+
+    const apiPath = path.resolve(root || process.cwd(), API_DIR);
+    const apiAppPath = path.resolve(apiPath, API_APP_NAME);
+
+    const storage = new Storage();
+    const transformAPI = createTransformAPI(storage);
+
+    const apiMod = requireExistModule(apiAppPath);
+    if (apiMod) {
+      apiMod(transformAPI);
+    }
+
+    return {
+      reset() {
+        storage.reset();
+        const newApiModule = requireExistModule(apiAppPath);
+        if (newApiModule) {
+          newApiModule(transformAPI);
+        }
+      },
+      gather({ addAPIMiddleware }) {
+        storage.middlewares.forEach(mid => {
+          addAPIMiddleware(mid);
+        });
+      },
+      prepareApiServer(props, next) {
+        const { pwd, prefix } = props;
+        const apiDir = path.resolve(pwd, API_DIR);
 
-      injectAPIHandlerInfos(apiDir, prefix);
+        injectAPIHandlerInfos(apiDir, prefix);
 
-      return next(props);
-    },
-  }),
+        return next(props);
+      },
+    };
+  },
   { name: '@modern-js/plugin-bff' },
 ) as any;

package/tests/__snapshots__/cli.test.ts.snap

@@ -25,12 +25,18 @@ Array [
             "type": "string",
           },
           "prefix": Object {
-            "type": "string",
+            "items": Object {
+              "type": "string",
+            },
+            "type": Array [
+              "string",
+              "array",
+            ],
           },
           "proxy": Object {
             "type": "object",
           },
-          "requestCreater": Object {
+          "requestCreator": Object {
             "type": "string",
           },
         },