@modern-js/plugin-express 1.6.1 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @modern-js/plugin-express
 
+## 1.7.0
+
+### Minor Changes
+
+- aadd066: feat: support Pipe and Middleware operators
+- 83660b6: chore(server): delete unused `@modern-js/server-utils` dependence
+
+  chore(server): 删除未使用的 `@modern-js/server-utils` 依赖
+
+### Patch Changes
+
+- f745969: fix: allow BFF function to return void
+  fix: 允许 BFF 函数返回 void
+- Updated dependencies [aadd066]
+- Updated dependencies [4fc801f]
+- Updated dependencies [83660b6]
+- Updated dependencies [c8614b8]
+  - @modern-js/bff-core@1.2.0
+  - @modern-js/utils@1.8.0
+  - @modern-js/bff-runtime@1.4.0
+
 ## 1.6.1
 
 ### Patch Changes

package/dist/js/modern/registerRoutes.js

@@ -9,7 +9,13 @@ const registerRoutes = (app, handlerInfos) => {
   }) => {
     const routeHandler = createRouteHandler(handler);
     const method = httpMethod.toLowerCase();
-    app[method](routePath, routeHandler);
+    const routeMiddlwares = Reflect.getMetadata('middleware', handler) || [];
+
+    if (routeMiddlwares.length > 0) {
+      app[method](routePath, routeMiddlwares, routeHandler);
+    } else {
+      app[method](routePath, routeHandler);
+    }
   });
 };
 

package/dist/js/modern/runtime/index.js

@@ -0,0 +1,3 @@
+export * from '@modern-js/bff-core';
+export { useContext } from "../context";
+export * from "./operators";

package/dist/js/modern/runtime/operators.js

@@ -0,0 +1,25 @@
+export const Pipe = func => {
+  return {
+    name: 'pipe',
+
+    metadata(helper) {
+      const pipeFuncs = helper.getMetadata('pipe') || [];
+      pipeFuncs.push(func);
+      helper.setMetadata('pipe', pipeFuncs);
+    }
+
+  };
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+export const Middleware = middleware => {
+  return {
+    name: 'middleware',
+
+    metadata(helper) {
+      const middlewares = helper.getMetadata('pipe') || [];
+      middlewares.push(middleware);
+      helper.setMetadata('middleware', middlewares);
+    }
+
+  };
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare

package/dist/js/modern/utils.js

@@ -5,7 +5,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 import 'reflect-metadata';
-import { httpMethods, isWithMetaHandler, HttpMetadata, ResponseMetaType } from '@modern-js/bff-core';
+import { httpMethods, isWithMetaHandler, HttpMetadata, ResponseMetaType, ValidationError } from '@modern-js/bff-core';
 import { isSchemaHandler } from '@modern-js/bff-runtime';
 import typeIs from 'type-is';
 import formidable from 'formidable';
@@ -44,11 +44,49 @@ const handleResponseMeta = (res, handler) => {
 
 export const createRouteHandler = handler => {
   const apiHandler = async (req, res, next) => {
-    const input = await getInputFromRequest(req);
+    let input = await getInputFromRequest(req);
 
     if (isWithMetaHandler(handler)) {
+      const pipeFuncs = Reflect.getMetadata('pipe', handler);
+      let isPiped = true;
+
+      const end = value => {
+        isPiped = false;
+
+        if (typeof value === 'function') {
+          value(res);
+          return;
+        } // eslint-disable-next-line consistent-return
+
+
+        return value;
+      };
+
+      if (Array.isArray(pipeFuncs)) {
+        for (const pipeFunc of pipeFuncs) {
+          const output = await pipeFunc(input, end);
+
+          if (!isPiped) {
+            if (output) {
+              return res.send(output);
+            } else {
+              // eslint-disable-next-line consistent-return
+              return;
+            }
+          }
+
+          input = output;
+        }
+      }
+
       try {
         handleResponseMeta(res, handler);
+
+        if (res.headersSent) {
+          // eslint-disable-next-line consistent-return
+          return;
+        }
+
         const result = await handler(input);
         return res.json(result);
       } catch (error) {
@@ -64,6 +102,15 @@ export const createRouteHandler = handler => {
             message: error.message
           });
         }
+
+        if (error instanceof ValidationError) {
+          res.status(error.status);
+          return res.json({
+            message: error.message
+          });
+        }
+
+        throw error;
       }
     } else if (isSchemaHandler(handler)) {
       const result = await handler(input);
@@ -90,7 +137,9 @@ export const createRouteHandler = handler => {
           return await Promise.resolve();
         }
 
-        return res.json(body);
+        if (typeof body !== 'undefined') {
+          return res.json(body);
+        }
       } catch (e) {
         return next(e);
       }

package/dist/js/node/registerRoutes.js

@@ -17,7 +17,13 @@ const registerRoutes = (app, handlerInfos) => {
   }) => {
     const routeHandler = (0, _utils.createRouteHandler)(handler);
     const method = httpMethod.toLowerCase();
-    app[method](routePath, routeHandler);
+    const routeMiddlwares = Reflect.getMetadata('middleware', handler) || [];
+
+    if (routeMiddlwares.length > 0) {
+      app[method](routePath, routeMiddlwares, routeHandler);
+    } else {
+      app[method](routePath, routeHandler);
+    }
   });
 };
 

package/dist/js/node/{runtime.js → runtime/index.js}

@@ -13,8 +13,6 @@ Object.defineProperty(exports, "useContext", {
   }
 });
 
-var _context = require("./context");
-
 var _bffCore = require("@modern-js/bff-core");
 
 Object.keys(_bffCore).forEach(function (key) {
@@ -27,4 +25,20 @@ Object.keys(_bffCore).forEach(function (key) {
       return _bffCore[key];
     }
   });
+});
+
+var _context = require("../context");
+
+var _operators = require("./operators");
+
+Object.keys(_operators).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _operators[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _operators[key];
+    }
+  });
 });

package/dist/js/node/runtime/operators.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Pipe = exports.Middleware = void 0;
+
+const Pipe = func => {
+  return {
+    name: 'pipe',
+
+    metadata(helper) {
+      const pipeFuncs = helper.getMetadata('pipe') || [];
+      pipeFuncs.push(func);
+      helper.setMetadata('pipe', pipeFuncs);
+    }
+
+  };
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+
+exports.Pipe = Pipe;
+
+const Middleware = middleware => {
+  return {
+    name: 'middleware',
+
+    metadata(helper) {
+      const middlewares = helper.getMetadata('pipe') || [];
+      middlewares.push(middleware);
+      helper.setMetadata('middleware', middlewares);
+    }
+
+  };
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+
+exports.Middleware = Middleware;

package/dist/js/node/utils.js

@@ -57,11 +57,49 @@ const handleResponseMeta = (res, handler) => {
 
 const createRouteHandler = handler => {
   const apiHandler = async (req, res, next) => {
-    const input = await getInputFromRequest(req);
+    let input = await getInputFromRequest(req);
 
     if ((0, _bffCore.isWithMetaHandler)(handler)) {
+      const pipeFuncs = Reflect.getMetadata('pipe', handler);
+      let isPiped = true;
+
+      const end = value => {
+        isPiped = false;
+
+        if (typeof value === 'function') {
+          value(res);
+          return;
+        } // eslint-disable-next-line consistent-return
+
+
+        return value;
+      };
+
+      if (Array.isArray(pipeFuncs)) {
+        for (const pipeFunc of pipeFuncs) {
+          const output = await pipeFunc(input, end);
+
+          if (!isPiped) {
+            if (output) {
+              return res.send(output);
+            } else {
+              // eslint-disable-next-line consistent-return
+              return;
+            }
+          }
+
+          input = output;
+        }
+      }
+
       try {
         handleResponseMeta(res, handler);
+
+        if (res.headersSent) {
+          // eslint-disable-next-line consistent-return
+          return;
+        }
+
         const result = await handler(input);
         return res.json(result);
       } catch (error) {
@@ -77,6 +115,15 @@ const createRouteHandler = handler => {
             message: error.message
           });
         }
+
+        if (error instanceof _bffCore.ValidationError) {
+          res.status(error.status);
+          return res.json({
+            message: error.message
+          });
+        }
+
+        throw error;
       }
     } else if ((0, _bffRuntime.isSchemaHandler)(handler)) {
       const result = await handler(input);
@@ -103,7 +150,9 @@ const createRouteHandler = handler => {
           return await Promise.resolve();
         }
 
-        return res.json(body);
+        if (typeof body !== 'undefined') {
+          return res.json(body);
+        }
       } catch (e) {
         return next(e);
       }

package/dist/types/runtime/index.d.ts

@@ -0,0 +1,3 @@
+export * from '@modern-js/bff-core';
+export { useContext } from '../context';
+export * from './operators';

package/dist/types/runtime/operators.d.ts

@@ -0,0 +1,10 @@
+import { Operator } from '@modern-js/bff-core';
+import { NextFunction } from '@modern-js/types';
+import type { Request, Response } from 'express';
+export declare type EndFunction = ((func: (res: Response) => void) => void) & ((data: unknown) => void);
+declare type PipeFunction<T> = (value: T, end: EndFunction) => void;
+export declare const Pipe: <T>(func: PipeFunction<T>) => Operator<void>;
+export declare type Pipe = typeof Pipe;
+export declare const Middleware: (middleware: (req: Request, res: Response, next: NextFunction) => void) => Operator<void>;
+export declare type Middleware = typeof Middleware;
+export {};

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.6.1",
+  "version": "1.7.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -35,10 +35,10 @@
   "dependencies": {
     "@babel/runtime": "^7.18.0",
     "@modern-js/adapter-helpers": "^1.3.0",
-    "@modern-js/bff-core": "^1.1.3",
-    "@modern-js/bff-runtime": "^1.3.0",
+    "@modern-js/bff-core": "^1.2.0",
+    "@modern-js/bff-runtime": "^1.4.0",
     "@modern-js/types": "^1.6.0",
-    "@modern-js/utils": "^1.7.12",
+    "@modern-js/utils": "^1.8.0",
     "cookie-parser": "^1.4.5",
     "finalhandler": "^1.1.2",
     "formidable": "^1.2.2",
@@ -46,9 +46,8 @@
     "type-is": "^1.6.18"
   },
   "devDependencies": {
-    "@modern-js/core": "1.13.0",
+    "@modern-js/core": "1.13.1",
     "@modern-js/server-core": "1.4.1",
-    "@modern-js/server-utils": "1.2.11",
     "@scripts/build": "0.0.0",
     "@scripts/jest-config": "0.0.0",
     "@types/cookie-parser": "^1.4.2",

package/types.d.ts

@@ -11,6 +11,9 @@ declare module '@modern-js/runtime/server' {
 
   type Context = { req: Request; res: Response };
 
+  export const Pipe: import('./src/runtime').Pipe;
+  export const Middleware: import('./src/runtime').Middleware;
+
   export function useContext(): Context;
 
   export function hook(attacher: ExpressAttacher): ExpressAttacher;

package/dist/js/modern/runtime.js

@@ -1,2 +0,0 @@
-export { useContext } from "./context";
-export * from '@modern-js/bff-core';

package/dist/types/runtime.d.ts

@@ -1,2 +0,0 @@
-export { useContext } from './context';
-export * from '@modern-js/bff-core';