@kizunajs/express 2.0.0-beta.2 → 2.0.0-beta.21

package/README.md

@@ -30,7 +30,6 @@ import express from 'express';
 import kizuna from '../kizuna.config';
 
 const app = express();
-app.use(express.json());
 
 kizuna.api.mount(app);
 

package/dist/index.cjs

@@ -3,6 +3,51 @@ let express = require("express");
 let node_stream = require("node:stream");
 let kizunajs_adapter = require("kizunajs/adapter");
 //#region src/server.ts
+/**
+* Keep the body as it was sent, for routes with `rawBody: true`. Pass it as the
+* `verify` option of an `express.json()` your app runs before kizuna.
+*
+* @example
+* app.use(
+*     express.json({
+*         verify: keepRawBody,
+*     })
+* );
+*/
+const keepRawBody = (req, _res, buffer) => {
+	req.rawBody = buffer;
+};
+/**
+* Parse a kizuna route's body, unless the app already parsed it. The parser
+* keeps the text as well, for routes with `rawBody: true`.
+*/
+const bodyParserFor = (route, jsonOptions) => {
+	if (route.contentType === "multipart/form-data") return void 0;
+	const parse = route.contentType === "application/x-www-form-urlencoded" ? (0, express.urlencoded)({
+		extended: false,
+		verify: keepRawBody
+	}) : (0, express.json)({
+		...jsonOptions,
+		verify: keepRawBody
+	});
+	return (req, res, next) => {
+		if (req.body !== void 0) {
+			next();
+			return;
+		}
+		req.kizunaParsedBody = true;
+		parse(req, res, next);
+	};
+};
+/**
+* The body text for a `rawBody` route: what the parser kept, an empty body when
+* kizuna parsed and there was none, or `undefined` when the app's own parser
+* consumed it without keeping it.
+*/
+const rawBodyOf = (req) => {
+	if (req.rawBody !== void 0) return req.rawBody.toString("utf8");
+	return req.kizunaParsedBody === true ? "" : void 0;
+};
 const writeStream = (open, res, validate) => {
 	const controller = new AbortController();
 	res.on("close", () => {
@@ -29,7 +74,7 @@ const writeWebResponse = async (response, res) => {
 	}
 	node_stream.Readable.fromWeb(response.body).pipe(res);
 };
-const adapter = (0, kizunajs_adapter.createAdapter)({
+const adapter = (0, kizunajs_adapter.defineAdapter)({
 	buildHandlerContext: (adapterRequest, { res }) => ({
 		req: adapterRequest.request,
 		res
@@ -81,10 +126,12 @@ function mountExpress(api, app, options) {
 	const jobRunner = (0, kizunajs_adapter.jobRunnerFrom)(jobsMeta);
 	const expressRouter = (0, express.Router)();
 	const mountRoute = (routeKey, route, routes, router) => {
-		expressRouter[route.method.toLowerCase()](route.path, (req, _res, next) => {
+		const method = route.method.toLowerCase();
+		const parseBody = bodyParserFor(route, options?.json);
+		expressRouter[method](route.path, (req, _res, next) => {
 			req.kizunaRoute = route;
 			next();
-		}, async (req, res, next) => {
+		}, ...parseBody === void 0 ? [] : [parseBody], async (req, res, next) => {
 			const adapterRequest = {
 				request: req,
 				method: req.method,
@@ -96,7 +143,8 @@ function mountExpress(api, app, options) {
 				},
 				query: req.query,
 				headers: req.headers,
-				readBody: () => req.body
+				readBody: () => req.body,
+				readRawBody: () => rawBodyOf(req)
 			};
 			await adapter.handle({
 				routes,
@@ -153,4 +201,5 @@ const expressAdapter = (defaults) => ({
 });
 //#endregion
 exports.expressAdapter = expressAdapter;
+exports.keepRawBody = keepRawBody;
 exports.mountExpress = mountExpress;

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import { Request, Response, Router } from "express";
+import { Request, Response, Router, json } from "express";
+import { IncomingMessage, ServerResponse } from "node:http";
 import { Adapter, ApiWithRouter, ErrorFormatter, GUARDS_META, JOBS_META, REQUEST_CONTEXT_META, RouteDefinition, Routes, SCHEMES_META } from "kizunajs/adapter";
 
 //#region src/server.d.ts
@@ -23,9 +24,30 @@ declare global {
   namespace Express {
     interface Request {
       kizunaRoute?: RouteDefinition;
+      /**
+       * The body as it was sent, kept by {@link keepRawBody}.
+       */
+      rawBody?: Buffer;
+      /**
+       * Set when kizuna parsed this request's body itself.
+       */
+      kizunaParsedBody?: true;
     }
   }
 }
+/**
+ * Keep the body as it was sent, for routes with `rawBody: true`. Pass it as the
+ * `verify` option of an `express.json()` your app runs before kizuna.
+ *
+ * @example
+ * app.use(
+ *     express.json({
+ *         verify: keepRawBody,
+ *     })
+ * );
+ */
+declare const keepRawBody: (req: IncomingMessage, _res: ServerResponse, buffer: Buffer) => void;
+type JsonOptions = NonNullable<Parameters<typeof json>[0]>;
 interface ExpressOptions {
   /**
    * Validate handler return values against the route's response schemas.
@@ -39,6 +61,17 @@ interface ExpressOptions {
    * {@link ErrorFormatter}.
    */
   formatError?: ErrorFormatter<Request>;
+  /**
+   * The options for `express.json()`, like `limit` and `strict`, used to parse
+   * the bodies of kizuna's own routes. An `express.json()` your app runs
+   * first takes precedence, and kizuna uses the body it parsed.
+   *
+   * @example
+   * json: {
+   *     limit: '5mb',
+   * }
+   */
+  json?: JsonOptions;
 }
 interface AppLike {
   use: (router: Router) => unknown;
@@ -65,4 +98,4 @@ declare function mountExpress(api: ExpressApi, app: AppLike, options?: ExpressOp
  */
 declare const expressAdapter: (defaults?: ExpressOptions) => Adapter<ExpressHandlerContext, [app: AppLike, options?: ExpressOptions], Router>;
 //#endregion
-export { AppLike, ExpressApi, ExpressHandlerContext, ExpressOptions, expressAdapter, mountExpress };
+export { AppLike, ExpressApi, ExpressHandlerContext, ExpressOptions, expressAdapter, keepRawBody, mountExpress };

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { Request, Response, Router } from "express";
+import { Request, Response, Router, json } from "express";
 import { Adapter, ApiWithRouter, ErrorFormatter, GUARDS_META, JOBS_META, REQUEST_CONTEXT_META, RouteDefinition, Routes, SCHEMES_META } from "kizunajs/adapter";
+import { IncomingMessage, ServerResponse } from "node:http";
 
 //#region src/server.d.ts
 type ExpressApi<R extends Routes = Routes> = ApiWithRouter<R> & {
@@ -23,9 +24,30 @@ declare global {
   namespace Express {
     interface Request {
       kizunaRoute?: RouteDefinition;
+      /**
+       * The body as it was sent, kept by {@link keepRawBody}.
+       */
+      rawBody?: Buffer;
+      /**
+       * Set when kizuna parsed this request's body itself.
+       */
+      kizunaParsedBody?: true;
     }
   }
 }
+/**
+ * Keep the body as it was sent, for routes with `rawBody: true`. Pass it as the
+ * `verify` option of an `express.json()` your app runs before kizuna.
+ *
+ * @example
+ * app.use(
+ *     express.json({
+ *         verify: keepRawBody,
+ *     })
+ * );
+ */
+declare const keepRawBody: (req: IncomingMessage, _res: ServerResponse, buffer: Buffer) => void;
+type JsonOptions = NonNullable<Parameters<typeof json>[0]>;
 interface ExpressOptions {
   /**
    * Validate handler return values against the route's response schemas.
@@ -39,6 +61,17 @@ interface ExpressOptions {
    * {@link ErrorFormatter}.
    */
   formatError?: ErrorFormatter<Request>;
+  /**
+   * The options for `express.json()`, like `limit` and `strict`, used to parse
+   * the bodies of kizuna's own routes. An `express.json()` your app runs
+   * first takes precedence, and kizuna uses the body it parsed.
+   *
+   * @example
+   * json: {
+   *     limit: '5mb',
+   * }
+   */
+  json?: JsonOptions;
 }
 interface AppLike {
   use: (router: Router) => unknown;
@@ -65,4 +98,4 @@ declare function mountExpress(api: ExpressApi, app: AppLike, options?: ExpressOp
  */
 declare const expressAdapter: (defaults?: ExpressOptions) => Adapter<ExpressHandlerContext, [app: AppLike, options?: ExpressOptions], Router>;
 //#endregion
-export { AppLike, ExpressApi, ExpressHandlerContext, ExpressOptions, expressAdapter, mountExpress };
+export { AppLike, ExpressApi, ExpressHandlerContext, ExpressOptions, expressAdapter, keepRawBody, mountExpress };

package/dist/index.mjs

@@ -1,7 +1,52 @@
-import { Router } from "express";
+import { Router, json, urlencoded } from "express";
 import { Readable, pipeline } from "node:stream";
-import { GUARDS_META, JOBS_META, REQUEST_CONTEXT_META, ROUTER_META, SCHEMES_META, createAdapter, jobRouter, jobRoutes, jobRunnerFrom, pluginExportsOf, pluginRouterOf, pluginRoutesOf, renderJsonResult } from "kizunajs/adapter";
+import { GUARDS_META, JOBS_META, REQUEST_CONTEXT_META, ROUTER_META, SCHEMES_META, defineAdapter, jobRouter, jobRoutes, jobRunnerFrom, pluginExportsOf, pluginRouterOf, pluginRoutesOf, renderJsonResult } from "kizunajs/adapter";
 //#region src/server.ts
+/**
+* Keep the body as it was sent, for routes with `rawBody: true`. Pass it as the
+* `verify` option of an `express.json()` your app runs before kizuna.
+*
+* @example
+* app.use(
+*     express.json({
+*         verify: keepRawBody,
+*     })
+* );
+*/
+const keepRawBody = (req, _res, buffer) => {
+	req.rawBody = buffer;
+};
+/**
+* Parse a kizuna route's body, unless the app already parsed it. The parser
+* keeps the text as well, for routes with `rawBody: true`.
+*/
+const bodyParserFor = (route, jsonOptions) => {
+	if (route.contentType === "multipart/form-data") return void 0;
+	const parse = route.contentType === "application/x-www-form-urlencoded" ? urlencoded({
+		extended: false,
+		verify: keepRawBody
+	}) : json({
+		...jsonOptions,
+		verify: keepRawBody
+	});
+	return (req, res, next) => {
+		if (req.body !== void 0) {
+			next();
+			return;
+		}
+		req.kizunaParsedBody = true;
+		parse(req, res, next);
+	};
+};
+/**
+* The body text for a `rawBody` route: what the parser kept, an empty body when
+* kizuna parsed and there was none, or `undefined` when the app's own parser
+* consumed it without keeping it.
+*/
+const rawBodyOf = (req) => {
+	if (req.rawBody !== void 0) return req.rawBody.toString("utf8");
+	return req.kizunaParsedBody === true ? "" : void 0;
+};
 const writeStream = (open, res, validate) => {
 	const controller = new AbortController();
 	res.on("close", () => {
@@ -28,7 +73,7 @@ const writeWebResponse = async (response, res) => {
 	}
 	Readable.fromWeb(response.body).pipe(res);
 };
-const adapter = createAdapter({
+const adapter = defineAdapter({
 	buildHandlerContext: (adapterRequest, { res }) => ({
 		req: adapterRequest.request,
 		res
@@ -80,10 +125,12 @@ function mountExpress(api, app, options) {
 	const jobRunner = jobRunnerFrom(jobsMeta);
 	const expressRouter = Router();
 	const mountRoute = (routeKey, route, routes, router) => {
-		expressRouter[route.method.toLowerCase()](route.path, (req, _res, next) => {
+		const method = route.method.toLowerCase();
+		const parseBody = bodyParserFor(route, options?.json);
+		expressRouter[method](route.path, (req, _res, next) => {
 			req.kizunaRoute = route;
 			next();
-		}, async (req, res, next) => {
+		}, ...parseBody === void 0 ? [] : [parseBody], async (req, res, next) => {
 			const adapterRequest = {
 				request: req,
 				method: req.method,
@@ -95,7 +142,8 @@ function mountExpress(api, app, options) {
 				},
 				query: req.query,
 				headers: req.headers,
-				readBody: () => req.body
+				readBody: () => req.body,
+				readRawBody: () => rawBodyOf(req)
 			};
 			await adapter.handle({
 				routes,
@@ -151,4 +199,4 @@ const expressAdapter = (defaults) => ({
 	})
 });
 //#endregion
-export { expressAdapter, mountExpress };
+export { expressAdapter, keepRawBody, mountExpress };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kizunajs/express",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.21",
   "description": "Express adapter for Kizuna.js",
   "keywords": [
     "kizunajs",
@@ -55,17 +55,17 @@
     "access": "public"
   },
   "peerDependencies": {
+    "kizunajs": "2.0.0-beta.21",
     "express": "^5.0.0",
-    "zod": "^4.0.0",
-    "kizunajs": "2.0.0-beta.2"
+    "zod": "^4.0.0"
   },
   "devDependencies": {
+    "kizunajs": "2.0.0-beta.21",
     "@types/express": "^5.0.0",
     "express": "^5.0.0",
     "tsdown": "^0.21.0",
     "typescript": "^6.0.3",
-    "zod": "^4.0.0",
-    "kizunajs": "2.0.0-beta.2"
+    "zod": "^4.0.0"
   },
   "scripts": {
     "build": "tsdown src/index.ts --format esm,cjs --dts --clean --external kizunajs --external express --external zod",