@modern-js/plugin-express 1.4.2 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @modern-js/plugin-express
 
+## 1.5.0
+
+### Minor Changes
+
+- d2d1d6b2: feat: support server config
+
+### Patch Changes
+
+- Updated dependencies [77ff9754]
+- Updated dependencies [d2d1d6b2]
+- Updated dependencies [07a4887e]
+- Updated dependencies [ea2ae711]
+- Updated dependencies [17d0cc46]
+- Updated dependencies [d2d1d6b2]
+  - @modern-js/utils@1.4.0
+  - @modern-js/types@1.4.0
+
+## 1.4.4
+
+### Patch Changes
+
+- bebb39b6: chore: improve devDependencies and peerDependencies
+- Updated dependencies [132f7b53]
+  - @modern-js/utils@1.3.7
+
+## 1.4.3
+
+### Patch Changes
+
+- c1b8fa0a: feat: convert to new server plugin
+- Updated dependencies [c2046f37]
+  - @modern-js/utils@1.3.6
+
 ## 1.4.2
 
 ### Patch Changes

package/dist/js/modern/index.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line filenames/match-exported
 import plugin from "./plugin";
 export * from "./context";
 export default plugin;

package/dist/js/modern/plugin.js

@@ -1,7 +1,6 @@
 import * as path from 'path';
 import express from 'express';
 import cookieParser from 'cookie-parser';
-import { createPlugin } from '@modern-js/server-core';
 import { requireModule } from '@modern-js/bff-utils';
 import { fs, createDebugger } from '@modern-js/utils';
 import finalhandler from 'finalhandler';
@@ -48,115 +47,115 @@ const initApp = app => {
   return app;
 };
 
-export default createPlugin(() => ({
-  // eslint-disable-next-line max-statements
-  async prepareApiServer({
-    pwd,
-    mode,
-    config
-  }) {
-    let app;
-    const apiDir = path.join(pwd, './api');
-
-    if (mode === 'framework') {
-      app = await findAppModule(apiDir);
-
-      if (!app || !app.use) {
-        // console.warn('There is not api/app.ts.');
+export default (() => ({
+  name: '@modern-js/plugin-express',
+  pre: ['@modern-js/plugin-bff'],
+  setup: () => ({
+    async prepareApiServer({
+      pwd,
+      mode,
+      config
+    }) {
+      let app;
+      const apiDir = path.join(pwd, './api');
+
+      if (mode === 'framework') {
+        app = await findAppModule(apiDir);
+
+        if (!app || !app.use) {
+          // console.warn('There is not api/app.ts.');
+          app = express();
+        }
+
+        initApp(app);
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        } // eslint-disable-next-line react-hooks/rules-of-hooks
+
+
+        useRun(app);
+        registerRoutes(app);
+      } else if (mode === 'function') {
         app = express();
+        initApp(app);
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        } // eslint-disable-next-line react-hooks/rules-of-hooks
+
+
+        useRun(app);
+        registerRoutes(app);
+      } else {
+        throw new Error(`mode must be function or framework`);
       }
 
-      initApp(app);
+      return (req, res) => new Promise((resolve, reject) => {
+        const handler = err => {
+          if (err) {
+            return reject(err);
+          } // finalhanlder will trigger 'finish' event
 
-      if (config) {
-        const {
-          middleware
-        } = config;
-        initMiddlewares(middleware, app);
-      } // eslint-disable-next-line react-hooks/rules-of-hooks
 
+          return finalhandler(req, res, {})(null); // return resolve();
+        };
+
+        res.on('finish', err => {
+          if (err) {
+            return reject(err);
+          }
+
+          return resolve();
+        });
+        return app(req, res, handler);
+      });
+    },
 
-      useRun(app);
-      registerRoutes(app);
-    } else if (mode === 'function') {
-      app = express();
+    prepareWebServer({
+      config
+    }) {
+      const app = express();
       initApp(app);
 
       if (config) {
         const {
           middleware
         } = config;
+        debug('web middleware', middleware);
         initMiddlewares(middleware, app);
-      } // eslint-disable-next-line react-hooks/rules-of-hooks
+      }
 
+      return (req, res) => new Promise((resolve, reject) => {
+        const handler = err => {
+          if (err) {
+            return reject(err);
+          }
 
-      useRun(app);
-      registerRoutes(app);
-    } else {
-      throw new Error(`mode must be function or framework`);
-    }
+          if (res.headersSent && res.statusCode !== 200) {
+            finalhandler(req, res, {})(null);
+          }
 
-    return (req, res) => new Promise((resolve, reject) => {
-      const handler = err => {
-        if (err) {
-          return reject(err);
-        } // finalhanlder will trigger 'finish' event
+          return resolve();
+        }; // when user call res.send
 
 
-        return finalhandler(req, res, {})(null); // return resolve();
-      };
-
-      res.on('finish', err => {
-        if (err) {
-          return reject(err);
-        }
+        res.on('finish', err => {
+          if (err) {
+            return reject(err);
+          }
 
-        return resolve();
+          return resolve();
+        });
+        return app(req, res, handler);
       });
-      return app(req, res, handler);
-    });
-  },
-
-  prepareWebServer({
-    config
-  }) {
-    const app = express();
-    initApp(app);
-
-    if (config) {
-      const {
-        middleware
-      } = config;
-      debug('web middleware', middleware);
-      initMiddlewares(middleware, app);
     }
 
-    return (req, res) => new Promise((resolve, reject) => {
-      const handler = err => {
-        if (err) {
-          return reject(err);
-        }
-
-        if (res.headersSent && res.statusCode !== 200) {
-          finalhandler(req, res, {})(null);
-        }
-
-        return resolve();
-      }; // when user call res.send
-
-
-      res.on('finish', err => {
-        if (err) {
-          return reject(err);
-        }
-
-        return resolve();
-      });
-      return app(req, res, handler);
-    });
-  }
-
-}), {
-  name: '@modern-js/plugin-express',
-  pre: ['@modern-js/plugin-bff']
-});
+  })
+}));

package/dist/js/node/index.js

@@ -24,6 +24,5 @@ Object.keys(_context).forEach(function (key) {
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-// eslint-disable-next-line filenames/match-exported
 var _default = _plugin.default;
 exports.default = _default;

package/dist/js/node/plugin.js

@@ -11,8 +11,6 @@ var _express = _interopRequireDefault(require("express"));
 
 var _cookieParser = _interopRequireDefault(require("cookie-parser"));
 
-var _serverCore = require("@modern-js/server-core");
-
 var _bffUtils = require("@modern-js/bff-utils");
 
 var _utils = require("@modern-js/utils");
@@ -70,117 +68,117 @@ const initApp = app => {
   return app;
 };
 
-var _default = (0, _serverCore.createPlugin)(() => ({
-  // eslint-disable-next-line max-statements
-  async prepareApiServer({
-    pwd,
-    mode,
-    config
-  }) {
-    let app;
-    const apiDir = path.join(pwd, './api');
-
-    if (mode === 'framework') {
-      app = await findAppModule(apiDir);
-
-      if (!app || !app.use) {
-        // console.warn('There is not api/app.ts.');
+var _default = () => ({
+  name: '@modern-js/plugin-express',
+  pre: ['@modern-js/plugin-bff'],
+  setup: () => ({
+    async prepareApiServer({
+      pwd,
+      mode,
+      config
+    }) {
+      let app;
+      const apiDir = path.join(pwd, './api');
+
+      if (mode === 'framework') {
+        app = await findAppModule(apiDir);
+
+        if (!app || !app.use) {
+          // console.warn('There is not api/app.ts.');
+          app = (0, _express.default)();
+        }
+
+        initApp(app);
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        } // eslint-disable-next-line react-hooks/rules-of-hooks
+
+
+        useRun(app);
+        (0, _registerRoutes.default)(app);
+      } else if (mode === 'function') {
         app = (0, _express.default)();
+        initApp(app);
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        } // eslint-disable-next-line react-hooks/rules-of-hooks
+
+
+        useRun(app);
+        (0, _registerRoutes.default)(app);
+      } else {
+        throw new Error(`mode must be function or framework`);
       }
 
-      initApp(app);
+      return (req, res) => new Promise((resolve, reject) => {
+        const handler = err => {
+          if (err) {
+            return reject(err);
+          } // finalhanlder will trigger 'finish' event
 
-      if (config) {
-        const {
-          middleware
-        } = config;
-        initMiddlewares(middleware, app);
-      } // eslint-disable-next-line react-hooks/rules-of-hooks
 
+          return (0, _finalhandler.default)(req, res, {})(null); // return resolve();
+        };
 
-      useRun(app);
-      (0, _registerRoutes.default)(app);
-    } else if (mode === 'function') {
-      app = (0, _express.default)();
+        res.on('finish', err => {
+          if (err) {
+            return reject(err);
+          }
+
+          return resolve();
+        });
+        return app(req, res, handler);
+      });
+    },
+
+    prepareWebServer({
+      config
+    }) {
+      const app = (0, _express.default)();
       initApp(app);
 
       if (config) {
         const {
           middleware
         } = config;
+        debug('web middleware', middleware);
         initMiddlewares(middleware, app);
-      } // eslint-disable-next-line react-hooks/rules-of-hooks
+      }
 
+      return (req, res) => new Promise((resolve, reject) => {
+        const handler = err => {
+          if (err) {
+            return reject(err);
+          }
 
-      useRun(app);
-      (0, _registerRoutes.default)(app);
-    } else {
-      throw new Error(`mode must be function or framework`);
-    }
+          if (res.headersSent && res.statusCode !== 200) {
+            (0, _finalhandler.default)(req, res, {})(null);
+          }
 
-    return (req, res) => new Promise((resolve, reject) => {
-      const handler = err => {
-        if (err) {
-          return reject(err);
-        } // finalhanlder will trigger 'finish' event
+          return resolve();
+        }; // when user call res.send
 
 
-        return (0, _finalhandler.default)(req, res, {})(null); // return resolve();
-      };
-
-      res.on('finish', err => {
-        if (err) {
-          return reject(err);
-        }
+        res.on('finish', err => {
+          if (err) {
+            return reject(err);
+          }
 
-        return resolve();
+          return resolve();
+        });
+        return app(req, res, handler);
       });
-      return app(req, res, handler);
-    });
-  },
-
-  prepareWebServer({
-    config
-  }) {
-    const app = (0, _express.default)();
-    initApp(app);
-
-    if (config) {
-      const {
-        middleware
-      } = config;
-      debug('web middleware', middleware);
-      initMiddlewares(middleware, app);
     }
 
-    return (req, res) => new Promise((resolve, reject) => {
-      const handler = err => {
-        if (err) {
-          return reject(err);
-        }
-
-        if (res.headersSent && res.statusCode !== 200) {
-          (0, _finalhandler.default)(req, res, {})(null);
-        }
-
-        return resolve();
-      }; // when user call res.send
-
-
-      res.on('finish', err => {
-        if (err) {
-          return reject(err);
-        }
-
-        return resolve();
-      });
-      return app(req, res, handler);
-    });
-  }
-
-}), {
-  name: '@modern-js/plugin-express',
-  pre: ['@modern-js/plugin-bff']
+  })
 });
 
 exports.default = _default;

package/dist/types/plugin.d.ts

@@ -1,5 +1,6 @@
+import type { ServerPlugin } from '@modern-js/server-core';
 export declare type Mode = 'function' | 'framework';
 
-declare const _default: any;
+declare const _default: () => ServerPlugin;
 
 export default _default;

package/jest.config.js

@@ -2,7 +2,6 @@ const sharedConfig = require('@scripts/jest-config');
 
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
-  // eslint-disable-next-line node/no-unsupported-features/es-syntax
   ...sharedConfig,
   rootDir: __dirname,
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.2",
+  "version": "1.5.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -35,18 +35,21 @@
   "dependencies": {
     "@babel/runtime": "^7.15.3",
     "@modern-js/adapter-helpers": "^1.2.1",
-    "@modern-js/utils": "^1.3.5",
+    "@modern-js/bff-runtime": "^1.2.1",
+    "@modern-js/bff-utils": "^1.2.2",
+    "@modern-js/types": "^1.4.0",
+    "@modern-js/utils": "^1.4.0",
     "cookie-parser": "^1.4.5",
     "finalhandler": "^1.1.2",
     "formidable": "^1.2.2",
-    "type-is": "^1.6.18",
-    "@modern-js/bff-utils": "^1.2.2",
-    "@modern-js/server-core": "^1.2.3",
-    "@modern-js/bff-runtime": "^1.2.1"
+    "type-is": "^1.6.18"
   },
   "devDependencies": {
-    "express": "^4.17.1",
-    "@modern-js/server-utils": "^1.2.1",
+    "@modern-js/core": "^1.7.0",
+    "@modern-js/server-core": "^1.3.0",
+    "@modern-js/server-utils": "^1.2.2",
+    "@scripts/build": "0.0.0",
+    "@scripts/jest-config": "0.0.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express": "^4.17.13",
     "@types/finalhandler": "^1.1.1",
@@ -55,12 +58,10 @@
     "@types/node": "^14",
     "@types/supertest": "^2.0.11",
     "@types/type-is": "^1.6.3",
-    "supertest": "^6.1.6",
-    "typescript": "^4",
-    "@modern-js/core": "^1.5.0",
-    "@scripts/build": "0.0.0",
+    "express": "^4.17.1",
     "jest": "^27",
-    "@scripts/jest-config": "0.0.0"
+    "supertest": "^6.1.6",
+    "typescript": "^4"
   },
   "modernConfig": {
     "output": {

package/tests/fixtures/function-mode/api/nest/user.ts

@@ -3,7 +3,6 @@
 import { match } from '@modern-js/bff-runtime';
 import { useContext } from '../../../../../src/context';
 
-// eslint-disable-next-line arrow-body-style
 export const get = ({ query }: { query: Record<string, unknown> }) => {
   return { query };
 };

package/tests/fixtures/function-mode/api/upload.ts

@@ -0,0 +1,4 @@
+export const post = ({ formData }) => ({
+  message: 'success',
+  formData,
+});

package/tests/fixtures/lambda-mode/api/lambda/upload.ts

@@ -0,0 +1,4 @@
+export const post = ({ formData }) => ({
+  message: 'success',
+  formData,
+});

package/tests/functionMode.test.ts

@@ -90,4 +90,19 @@ describe('function-mode', () => {
     expect(res.status).toBe(200);
     expect(res.body.protocol).toBe('Farrow-API');
   });
+
+  test('should support upload file', done => {
+    request(apiHandler)
+      .post('/upload')
+      .field('my_field', 'value')
+      .attach('file', __filename)
+      .end(async (err, res) => {
+        if (err) {
+          throw err;
+        }
+        expect(res.statusCode).toBe(200);
+        expect(res.body.message).toBe('success');
+        done();
+      });
+  });
 });

package/tests/lambdaMode.test.ts

@@ -13,6 +13,7 @@ const API_DIR = './api';
 describe('lambda-mode', () => {
   const id = '666';
   const name = 'modern';
+  const prefix = '/api';
   const foo = { id, name };
   let apiHandler: any;
 
@@ -21,40 +22,41 @@ describe('lambda-mode', () => {
       .clone()
       .usePlugin(APIPlugin, plugin)
       .init();
+
     apiHandler = await runner.prepareApiServer({
       pwd,
       mode: 'framework',
-      prefix: '/api',
+      prefix,
     });
   });
 
   test('should works', async () => {
-    const res = await request(apiHandler).get('/api/hello');
+    const res = await request(apiHandler).get(`${prefix}/hello`);
     expect(res.status).toBe(200);
     expect(res.body).toEqual({ message: 'hello' });
   });
 
   test('should works with query', async () => {
-    const res = await request(apiHandler).get(`/api/nest/user?id=${id}`);
+    const res = await request(apiHandler).get(`${prefix}/nest/user?id=${id}`);
     expect(res.status).toBe(200);
     expect(res.body.query.id).toBe(id);
   });
 
   test('should works with body', async () => {
-    const res = await request(apiHandler).post('/api/nest/user').send(foo);
+    const res = await request(apiHandler).post(`${prefix}/nest/user`).send(foo);
     expect(res.status).toBe(200);
     expect(res.body.data).toEqual(foo);
   });
 
   test('should works with dynamic route ', async () => {
-    const res = await request(apiHandler).post(`/api/nest/${id}`);
+    const res = await request(apiHandler).post(`${prefix}/nest/${id}`);
     expect(res.status).toBe(200);
     expect(res.body).toEqual({ id });
   });
 
   test('should works with context', async () => {
     const res = await request(apiHandler)
-      .post(`/api/nest/user?id=${id}`)
+      .post(`${prefix}/nest/user?id=${id}`)
       .send(foo);
     expect(res.status).toBe(200);
     expect(res.body.data).toEqual(foo);
@@ -63,7 +65,7 @@ describe('lambda-mode', () => {
 
   test('should support cookies', async () => {
     const res = await request(apiHandler)
-      .post(`/api/nest/user?id=${id}`)
+      .post(`${prefix}/nest/user?id=${id}`)
       .set('Cookie', [`id=${id};name=${name}`]);
     expect(res.status).toBe(200);
     expect(res.body.cookies.id).toBe(id);
@@ -71,19 +73,19 @@ describe('lambda-mode', () => {
   });
 
   test('should works with schema', async () => {
-    const res = await request(apiHandler).patch('/api/nest/user').send({
+    const res = await request(apiHandler).patch(`${prefix}/nest/user`).send({
       id: 777,
       name: 'xxx',
     });
     expect(res.status).toBe(200);
 
-    const res2 = await request(apiHandler).patch('/api/nest/user').send({
+    const res2 = await request(apiHandler).patch(`${prefix}/nest/user`).send({
       id: 'aaa',
       name: 'xxx',
     });
     expect(res2.status).toBe(400);
 
-    const res3 = await request(apiHandler).patch('/api/nest/user').send({
+    const res3 = await request(apiHandler).patch(`${prefix}/nest/user`).send({
       id: '777',
       name: 'xxx',
     });
@@ -97,6 +99,21 @@ describe('lambda-mode', () => {
     expect(res.status).toBe(200);
     expect(res.body.protocol).toBe('Farrow-API');
   });
+
+  test('should support upload file', done => {
+    request(apiHandler)
+      .post(`${prefix}/upload`)
+      .field('my_field', 'value')
+      .attach('file', __filename)
+      .end(async (err, res) => {
+        if (err) {
+          throw err;
+        }
+        expect(res.statusCode).toBe(200);
+        expect(res.body.message).toBe('success');
+        done();
+      });
+  });
 });
 
 describe('add middwares', () => {