@ddd-ts-kit/http 0.7.0 → 0.9.0

package/dist/uploads/multipart-uploads.d.ts

@@ -0,0 +1,8 @@
+import type { UploadReader } from '../pipeline/upload-reader.js';
+import type { MultipartLimits } from './multipart-limits.js';
+/**
+ * The upload reader of the kit, on busboy: pass it as `uploads` to the mount options. The file
+ * streams to the handler while the request arrives, never held whole.
+ */
+export declare function multipartUploads(limits?: MultipartLimits): UploadReader;
+//# sourceMappingURL=multipart-uploads.d.ts.map

package/dist/uploads/multipart-uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipart-uploads.d.ts","sourceRoot":"","sources":["../../src/uploads/multipart-uploads.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAG7D;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,GAAE,eAAoB,GAAG,YAAY,CAE3E"}

package/dist/uploads/multipart-uploads.js

@@ -0,0 +1,9 @@
+import { readMultipart } from './read-multipart.js';
+/**
+ * The upload reader of the kit, on busboy: pass it as `uploads` to the mount options. The file
+ * streams to the handler while the request arrives, never held whole.
+ */
+export function multipartUploads(limits = {}) {
+    return (spec, request) => readMultipart(spec, request, limits);
+}
+//# sourceMappingURL=multipart-uploads.js.map

package/dist/uploads/multipart-uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipart-uploads.js","sourceRoot":"","sources":["../../src/uploads/multipart-uploads.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAM,GAAoB,EAAE;IAC3D,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACjE,CAAC"}

package/dist/uploads/read-multipart.d.ts

@@ -0,0 +1,13 @@
+import type { RawRequest } from '../pipeline/raw-request.js';
+import type { ReceivedUpload } from '../pipeline/received-upload.js';
+import type { UploadSpec } from '../route/upload-spec.js';
+import type { MultipartLimits } from './multipart-limits.js';
+/**
+ * Parses a `multipart/form-data` request as it streams and resolves as soon as the declared file
+ * begins: the text fields read so far, and the file wrapped in a `FileInspection` that refuses it
+ * beyond `maxBytes` or when its first bytes are not one of the accepted media types. A request
+ * that announces a larger body is refused before any byte is read. A request that closes before
+ * its end fails the file stream, so whatever consumes it rejects instead of waiting forever.
+ */
+export declare function readMultipart(spec: UploadSpec, request: RawRequest, limits: MultipartLimits): Promise<ReceivedUpload>;
+//# sourceMappingURL=read-multipart.d.ts.map

package/dist/uploads/read-multipart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-multipart.d.ts","sourceRoot":"","sources":["../../src/uploads/read-multipart.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAK7D;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CA4CrH"}

package/dist/uploads/read-multipart.js

@@ -0,0 +1,65 @@
+import { pipeline } from 'node:stream/promises';
+import busboy, {} from 'busboy';
+import { FileError, FileInspection, mediaTypeOf } from '@ddd-ts-kit/kernel';
+import { headerOf } from '../route/header-of.js';
+import { missingFile } from './missing-file.js';
+/** Room for the boundaries, the part headers and the text fields over the declared size of the file. */
+const ENVELOPE_BYTES = 1_048_576;
+/**
+ * Parses a `multipart/form-data` request as it streams and resolves as soon as the declared file
+ * begins: the text fields read so far, and the file wrapped in a `FileInspection` that refuses it
+ * beyond `maxBytes` or when its first bytes are not one of the accepted media types. A request
+ * that announces a larger body is refused before any byte is read. A request that closes before
+ * its end fails the file stream, so whatever consumes it rejects instead of waiting forever.
+ */
+export function readMultipart(spec, request, limits) {
+    const contentType = headerOf(request.headers, 'content-type');
+    if (mediaTypeOf(contentType) !== 'multipart/form-data') {
+        return Promise.reject(FileError.unsupportedMediaType(mediaTypeOf(contentType), ['multipart/form-data']));
+    }
+    if (Number(headerOf(request.headers, 'content-length')) > spec.maxBytes + ENVELOPE_BYTES) {
+        return Promise.reject(FileError.tooLarge(spec.maxBytes));
+    }
+    const { stream } = request;
+    if (stream === undefined) {
+        return Promise.reject(new Error('The adapter handed no request stream: an upload cannot be read.'));
+    }
+    return new Promise((resolve, reject) => {
+        const parser = busboy({ headers: { 'content-type': contentType }, limits: limitsOf(spec, limits) });
+        const fields = {};
+        parser.on('field', (name, value) => {
+            fields[name] = value;
+        });
+        parser.on('file', (name, file, info) => {
+            if (name !== spec.field) {
+                file.resume();
+                return;
+            }
+            resolve({ fields: { ...fields }, file: inspected(spec, file, info) });
+        });
+        parser.on('error', reject);
+        parser.on('close', () => {
+            reject(missingFile(spec.field));
+        });
+        // A client that drops the connection part-way destroys the parser, which fails the file with it.
+        pipeline(stream, parser).catch(reject);
+    });
+}
+function limitsOf(spec, limits) {
+    return {
+        files: 1,
+        fileSize: spec.maxBytes + 1,
+        fields: limits.fields ?? 20,
+        fieldSize: limits.fieldBytes ?? 65_536,
+    };
+}
+function inspected(spec, file, info) {
+    const mediaType = mediaTypeOf(info.mimeType);
+    const inspection = new FileInspection({
+        maxBytes: spec.maxBytes,
+        expected: { mediaType, accepted: spec.mediaTypes },
+    });
+    void pipeline(file, inspection).catch(() => undefined);
+    return { fileName: info.filename ?? '', mediaType, stream: inspection };
+}
+//# sourceMappingURL=read-multipart.js.map

package/dist/uploads/read-multipart.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-multipart.js","sourceRoot":"","sources":["../../src/uploads/read-multipart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,MAAM,EAAE,EAAiB,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAI5E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGhD,wGAAwG;AACxG,MAAM,cAAc,GAAG,SAAS,CAAC;AAEjC;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAgB,EAAE,OAAmB,EAAE,MAAuB;IAC1F,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAE9D,IAAI,WAAW,CAAC,WAAW,CAAC,KAAK,qBAAqB,EAAE,CAAC;QACvD,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QACzF,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACpG,MAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,IAA2B,EAAE,IAAc,EAAE,EAAE;YAC9E,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;gBACxB,IAAI,CAAC,MAAM,EAAE,CAAC;gBAEd,OAAO;YACT,CAAC;YAED,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE3B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,iGAAiG;QACjG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,IAAgB,EAAE,MAAuB;IACzD,OAAO;QACL,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;QAC3B,SAAS,EAAE,MAAM,CAAC,UAAU,IAAI,MAAM;KACvC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,IAAgB,EAAE,IAA2B,EAAE,IAAc;IAC9E,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAE7C,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC;QACpC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE;KACnD,CAAC,CAAC;IAEH,KAAK,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAEvD,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAC1E,CAAC"}

package/dist/uploads.d.ts

@@ -0,0 +1,3 @@
+export type { MultipartLimits } from './uploads/multipart-limits.js';
+export { multipartUploads } from './uploads/multipart-uploads.js';
+//# sourceMappingURL=uploads.d.ts.map

package/dist/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../src/uploads.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/uploads.js

@@ -0,0 +1,2 @@
+export { multipartUploads } from './uploads/multipart-uploads.js';
+//# sourceMappingURL=uploads.js.map

package/dist/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["../src/uploads.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ddd-ts-kit/http",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Framework-agnostic route definitions with Express, Fastify and NestJS adapters and OpenAPI 3.1 generation.",
   "license": "MIT",
   "repository": {
@@ -40,20 +40,25 @@
     "./docs": {
       "types": "./dist/docs.d.ts",
       "default": "./dist/docs.js"
+    },
+    "./uploads": {
+      "types": "./dist/uploads.d.ts",
+      "default": "./dist/uploads.js"
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@ddd-ts-kit/kernel": "0.7.0",
-    "@ddd-ts-kit/validation": "0.7.0"
+    "@ddd-ts-kit/kernel": "0.9.0",
+    "@ddd-ts-kit/validation": "0.9.0"
   },
   "peerDependencies": {
     "@nestjs/common": ">=11.0.0",
     "@nestjs/core": ">=11.0.0",
     "express": "^5.0.0",
-    "fastify": "^5.0.0"
+    "fastify": "^5.0.0",
+    "busboy": "^1.6.0"
   },
   "peerDependenciesMeta": {
     "express": {
@@ -67,6 +72,9 @@
     },
     "@nestjs/core": {
       "optional": true
+    },
+    "busboy": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -74,7 +82,9 @@
     "@nestjs/core": "^12.1.2",
     "@nestjs/platform-express": "^12.1.2",
     "@nestjs/platform-fastify": "^12.1.2",
+    "@types/busboy": "^1.5.5",
     "@types/express": "^5.0.0",
+    "busboy": "^1.6.0",
     "express": "^5.3.0",
     "fastify": "^5.12.5",
     "reflect-metadata": "^0.2.2",