@travetto/web-upload 8.0.0-alpha.3 → 8.0.0-alpha.30

package/README.md

@@ -15,18 +15,17 @@ yarn add @travetto/web-upload
 
 This module provides a clean and direct mechanism for processing uploads, built upon [@fastify/busboy](https://github.com/fastify/busboy). The module also provides some best practices with respect to temporary file management.
 
-Once the files are uploaded, they are exposed via [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14) parameters using the [@Upload](https://github.com/travetto/travetto/tree/main/module/web-upload/src/decorator.ts#L20) decorator.  This decorator requires the related field type to be a standard [Buffer](https://nodejs.org/api/buffer.html#class-file) object, or a [FileMap](https://github.com/travetto/travetto/tree/main/module/web-upload/src/types.ts#L7).
+Once the files are uploaded, they are exposed via [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14) parameters using the [@Upload](https://github.com/travetto/travetto/tree/main/module/web-upload/src/decorator.ts#L20) decorator. This decorator requires the related field type to be a standard [Buffer](https://nodejs.org/api/buffer.html#class-file) object, or a [FileMap](https://github.com/travetto/travetto/tree/main/module/web-upload/src/types.ts#L7).
 
 A simple example:
 
 **Code: Web controller with upload support**
 ```typescript
-import { Controller, Post, Get } from '@travetto/web';
+import { Controller, Get, Post } from '@travetto/web';
 import { type FileMap, Upload } from '@travetto/web-upload';
 
 @Controller('/simple')
 export class Simple {
-
   @Get('/age')
   getAge() {
     return { age: 50 };

package/__index__.ts

@@ -1,5 +1,6 @@
-import type { } from './src/trv.d.ts';
-export * from './src/decorator.ts';
+import type {} from './src/trv.d.ts';
+
 export * from './src/config.ts';
+export * from './src/decorator.ts';
+export * from './src/types.ts';
 export * from './src/util.ts';
-export * from './src/types.ts';

package/package.json

@@ -1,39 +1,43 @@
 {
   "name": "@travetto/web-upload",
-  "version": "8.0.0-alpha.3",
-  "type": "module",
+  "version": "8.0.0-alpha.30",
+  "private": false,
   "description": "Provides integration between the travetto asset and web module.",
   "keywords": [
-    "web",
     "travetto",
     "typescript",
-    "upload"
+    "upload",
+    "web"
   ],
   "homepage": "https://travetto.io",
   "license": "MIT",
   "author": {
-    "email": "travetto.framework@gmail.com",
-    "name": "Travetto Framework"
+    "name": "Travetto Framework",
+    "email": "travetto.framework@gmail.com"
+  },
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/web-upload"
   },
   "files": [
     "__index__.ts",
     "src",
     "support"
   ],
+  "type": "module",
   "main": "__index__.ts",
-  "repository": {
-    "url": "git+https://github.com/travetto/travetto.git",
-    "directory": "module/web-upload"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@fastify/busboy": "^3.2.0",
-    "@travetto/config": "^8.0.0-alpha.3",
-    "@travetto/web": "^8.0.0-alpha.3",
-    "file-type": "^21.3.1",
+    "@fastify/busboy": "^3.2.2",
+    "@travetto/config": "^8.0.0-alpha.27",
+    "@travetto/web": "^8.0.0-alpha.30",
+    "file-type": "^22.0.2",
     "mime": "^4.1.0"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.3"
+    "@travetto/test": "^8.0.0-alpha.26"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {
@@ -42,9 +46,5 @@
   },
   "travetto": {
     "displayName": "Web Upload Support"
-  },
-  "private": false,
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/config.ts

@@ -26,4 +26,4 @@ export class WebUploadConfig {
 
   @Ignore()
   matcher: (contentType: string) => boolean;
-}
+}

package/src/decorator.ts

@@ -1,9 +1,9 @@
-import { RuntimeError, toConcrete, type ClassInstance, getClass } from '@travetto/runtime';
-import { ControllerRegistryIndex, type EndpointParameterConfig, Param } from '@travetto/web';
+import { type ClassInstance, getClass, RuntimeError, toConcrete } from '@travetto/runtime';
 import { SchemaRegistryIndex } from '@travetto/schema';
+import { ControllerRegistryIndex, type EndpointParameterConfig, Param } from '@travetto/web';
 
-import { WebUploadInterceptor } from './interceptor.ts';
 import type { WebUploadConfig } from './config.ts';
+import { WebUploadInterceptor } from './interceptor.ts';
 import type { FileMap } from './types.ts';
 import { WebUploadUtil } from './util.ts';
 
@@ -18,9 +18,8 @@ const FileMapContract = toConcrete<FileMap>();
  * @kind decorator
  */
 export function Upload(
-  param: Partial<EndpointParameterConfig> & UploadConfig = {},
+  param: Partial<EndpointParameterConfig> & UploadConfig = {}
 ): (instance: ClassInstance, property: string, idx: number) => void {
-
   const finalConfig = { ...param };
 
   return (instance: ClassInstance, property: string, idx: number): void => {
@@ -30,28 +29,24 @@ export function Upload(
     const getName = (): string => SchemaRegistryIndex.get(cls).getMethod(property).parameters[idx].name!;
 
     adapter.registerFinalizeHandler(() => {
-      adapter.registerEndpointInterceptorConfig(
-        property,
-        WebUploadInterceptor,
-        {
-          applies: true,
-          maxSize: finalConfig.maxSize,
-          types: finalConfig.types,
-          cleanupFiles: finalConfig.cleanupFiles,
-          uploads: {
-            [getName()]: {
-              maxSize: finalConfig.maxSize,
-              types: finalConfig.types,
-              cleanupFiles: finalConfig.cleanupFiles
-            }
+      adapter.registerEndpointInterceptorConfig(property, WebUploadInterceptor, {
+        applies: true,
+        maxSize: finalConfig.maxSize,
+        types: finalConfig.types,
+        cleanupFiles: finalConfig.cleanupFiles,
+        uploads: {
+          [getName()]: {
+            maxSize: finalConfig.maxSize,
+            types: finalConfig.types,
+            cleanupFiles: finalConfig.cleanupFiles
           }
         }
-      );
+      });
     });
 
-    return Param('body', {
+    Param('body', {
       ...finalConfig,
-      extract: (request) => {
+      extract: request => {
         const input = SchemaRegistryIndex.get(cls).getMethod(property).parameters[idx];
 
         if (!input) {
@@ -59,7 +54,9 @@ export function Upload(
         }
 
         if (!(input.type === Blob || input.type === File || input.type === FileMapContract)) {
-          throw new RuntimeError(`Cannot use upload decorator with ${input.type.name}, but only an ${Blob.name}, ${File.name} or ${FileMapContract.name}`);
+          throw new RuntimeError(
+            `Cannot use upload decorator with ${input.type.name}, but only an ${Blob.name}, ${File.name} or ${FileMapContract.name}`
+          );
         }
 
         const isMap = input.type === FileMapContract;
@@ -68,4 +65,4 @@ export function Upload(
       }
     })(instance, property, idx);
   };
-}
+}

package/src/interceptor.ts

@@ -1,7 +1,12 @@
 import { Inject, Injectable } from '@travetto/di';
 import {
-  BodyInterceptor, type WebInterceptor, type WebInterceptorCategory, type WebChainedContext,
-  type WebResponse, DecompressInterceptor, type WebInterceptorContext
+  BodyInterceptor,
+  DecompressInterceptor,
+  type WebChainedContext,
+  type WebInterceptor,
+  type WebInterceptorCategory,
+  type WebInterceptorContext,
+  type WebResponse
 } from '@travetto/web';
 
 import type { WebUploadConfig } from './config.ts';
@@ -9,7 +14,6 @@ import { WebUploadUtil } from './util.ts';
 
 @Injectable()
 export class WebUploadInterceptor implements WebInterceptor<WebUploadConfig> {
-
   category: WebInterceptorCategory = 'request';
   runsBefore = [BodyInterceptor];
   dependsOn = [DecompressInterceptor];
@@ -24,7 +28,7 @@ export class WebUploadInterceptor implements WebInterceptor<WebUploadConfig> {
     base.uploads ??= {};
     // Override the uploads object with all the data from the inputs
     for (const [key, config] of inputs.flatMap(inputConfig => Object.entries(inputConfig.uploads ?? {}))) {
-      Object.assign(base.uploads[key] ??= {}, config);
+      Object.assign((base.uploads[key] ??= {}), config);
     }
     return base;
   }
@@ -50,4 +54,4 @@ export class WebUploadInterceptor implements WebInterceptor<WebUploadConfig> {
       }
     }
   }
-}
+}

package/src/trv.d.ts

@@ -1,7 +1,7 @@
-import { FileMap } from './types.ts';
+import type { FileMap } from './types.ts';
 
 declare module '@travetto/web' {
   interface WebRequestInternal {
-    uploads?: FileMap
+    uploads?: FileMap;
   }
-}
+}

package/src/types.ts

@@ -4,7 +4,9 @@ import { SchemaTypeUtil } from '@travetto/schema';
 /**
  * @concrete
  */
-export interface FileMap extends Record<string, File> { }
+export interface FileMap extends Record<string, File> {}
 
-SchemaTypeUtil.register(toConcrete<FileMap>(),
-  input => typeof input === 'object' && !!input && Object.values(input).every(v => v instanceof Blob));
+SchemaTypeUtil.register(
+  toConcrete<FileMap>(),
+  input => typeof input === 'object' && !!input && Object.values(input).every(v => v instanceof Blob)
+);

package/src/util.ts

@@ -1,29 +1,37 @@
 import { createReadStream, createWriteStream } from 'node:fs';
-import path from 'node:path';
-import os from 'node:os';
 import fs from 'node:fs/promises';
-import { pipeline } from 'node:stream/promises';
+import os from 'node:os';
+import path from 'node:path';
 import { Transform } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
 
 import busboy from '@fastify/busboy';
 
-import { type WebRequest, WebCommonUtil, WebBodyUtil, WebHeaderUtil } from '@travetto/web';
-import { AsyncQueue, RuntimeError, CodecUtil, Util, BinaryUtil, type BinaryType, type BinaryStream, BinaryMetadataUtil } from '@travetto/runtime';
+import {
+  AsyncQueue,
+  BinaryMetadataUtil,
+  type BinaryStream,
+  type BinaryType,
+  BinaryUtil,
+  CodecUtil,
+  RuntimeError,
+  Util
+} from '@travetto/runtime';
+import { WebBodyUtil, WebCommonUtil, WebHeaderUtil, type WebRequest } from '@travetto/web';
 
 import type { WebUploadConfig } from './config.ts';
 import type { FileMap } from './types.ts';
 
 const MULTIPART = new Set(['application/x-www-form-urlencoded', 'multipart/form-data']);
 
-type UploadItem = { stream: BinaryStream, filename?: string, field: string, contentType?: string };
-type FileType = { ext: string, mime: string };
+type UploadItem = { stream: BinaryStream; filename?: string; field: string; contentType?: string };
+type FileType = { ext: string; mime: string };
 const WebUploadSymbol = Symbol();
 
 /**
  * Web upload utilities
  */
 export class WebUploadUtil {
-
   /**
    * Write limiter
    * @returns
@@ -39,14 +47,14 @@ export class WebUploadUtil {
         } else {
           callback(null, chunk);
         }
-      },
+      }
     });
   }
 
   /**
    * Get all the uploads, separating multipart from direct
    */
-  static async * getUploads(request: WebRequest, config: Partial<WebUploadConfig>): AsyncIterable<UploadItem> {
+  static async *getUploads(request: WebRequest, config: Partial<WebUploadConfig>): AsyncIterable<UploadItem> {
     if (!WebBodyUtil.isRawBinary(request.body)) {
       throw new RuntimeError('No input stream provided for upload', { category: 'data' });
     }
@@ -70,14 +78,14 @@ export class WebUploadUtil {
           'content-length': request.headers.get('Content-Length')!,
           'content-range': request.headers.get('Content-Range')!,
           'content-encoding': request.headers.get('Content-Encoding')!,
-          'content-transfer-encoding': request.headers.get('Content-Transfer-Encoding')!,
+          'content-transfer-encoding': request.headers.get('Content-Transfer-Encoding')!
         },
         limits: { fileSize: largestMax }
       })
         .on('file', (field, stream, filename, _encoding, mimetype) => queue.add({ stream, filename, field, contentType: mimetype }))
         .on('limit', field => queue.throw(new RuntimeError(`File size exceeded for ${field}`, { category: 'data' })))
         .on('finish', () => queue.close())
-        .on('error', (error) => queue.throw(error instanceof Error ? error : new Error(`${error}`)));
+        .on('error', error => queue.throw(error instanceof Error ? error : new Error(`${error}`)));
 
       // Upload
       void BinaryUtil.pipeline(requestBody, uploadHandler).catch(err => queue.throw(err));
@@ -93,7 +101,7 @@ export class WebUploadUtil {
    * Detect mime from request input, usually http headers
    */
   static async detectMimeTypeFromRequestInput(location?: string, contentType?: string): Promise<FileType | undefined> {
-    const { Mime } = (await import('mime'));
+    const { Mime } = await import('mime');
     const otherTypes = (await import('mime/types/other.js')).default;
     const standardTypes = (await import('mime/types/standard.js')).default;
     const checker = new Mime(standardTypes, otherTypes);
@@ -117,7 +125,7 @@ export class WebUploadUtil {
       const { fromWebStream } = await import('strtok3');
       const parser = new FileTypeParser();
       const token = fromWebStream(BinaryUtil.toReadableStream(input));
-      cleanup = (): Promise<void> => token.close();
+      cleanup = (): Promise<void> => token.close().catch(() => {});
       return await parser.fromTokenizer(token);
     } finally {
       await cleanup?.();
@@ -128,9 +136,10 @@ export class WebUploadUtil {
    * Get file type
    */
   static async getFileType(input: BinaryType, filename?: string, contentType?: string): Promise<FileType> {
-    return (await this.detectMimeTypeFromBinary(input)) ??
-      (await this.detectMimeTypeFromRequestInput(filename, contentType)) ??
-      { ext: 'bin', mime: 'application/octet-stream' };
+    return (
+      (await this.detectMimeTypeFromBinary(input)) ??
+      (await this.detectMimeTypeFromRequestInput(filename, contentType)) ?? { ext: 'bin', mime: 'application/octet-stream' }
+    );
   }
 
   /**
@@ -143,16 +152,14 @@ export class WebUploadUtil {
     filename = filename ? path.basename(filename) : `unknown_${Date.now()}`;
 
     const location = path.resolve(uniqueDirectory, filename);
-    const remove = (): Promise<void> => fs.rm(location).catch(() => { });
-    const mimeCheck = config.matcher ??= WebCommonUtil.mimeTypeMatcher(config.types);
+    const remove = (): Promise<void> => fs.rm(location).catch(() => {});
+    const mimeCheck = (config.matcher ??= WebCommonUtil.mimeTypeMatcher(config.types));
     const response = (): BinaryStream => createReadStream(location);
 
     try {
       const target = createWriteStream(location);
 
-      await (config.maxSize ?
-        pipeline(stream, this.limitWrite(config.maxSize, field), target) :
-        pipeline(stream, target));
+      await (config.maxSize ? pipeline(stream, this.limitWrite(config.maxSize, field), target) : pipeline(stream, target));
 
       const detected = await this.getFileType(response(), filename, contentType);
 
@@ -164,10 +171,10 @@ export class WebUploadUtil {
         filename = `${filename}.${detected.ext}`;
       }
 
-      const metadata = await BinaryMetadataUtil.compute(response, { contentType: detected.mime, filename, });
+      const metadata = await BinaryMetadataUtil.compute(response, { contentType: detected.mime, filename });
       const file = BinaryMetadataUtil.defineBlob(new File([], ''), response, metadata);
       Object.defineProperty(file, 'cleanup', {
-        value: () => config.cleanupFiles !== false && fs.rm(location).catch(() => { })
+        value: () => config.cleanupFiles !== false && fs.rm(location).catch(() => {})
       });
       return file;
     } catch (error) {
@@ -189,4 +196,4 @@ export class WebUploadUtil {
   static setRequestUploads(request: WebRequest & { [WebUploadSymbol]?: FileMap }, uploads: FileMap): void {
     request[WebUploadSymbol] ??= uploads;
   }
-}
+}

package/support/test/server.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert';
 
+import { Registry } from '@travetto/registry';
 import { BinaryMetadataUtil, castTo } from '@travetto/runtime';
-import { Controller, Post } from '@travetto/web';
 import { BeforeAll, Suite, Test, TestFixtures } from '@travetto/test';
-import { Registry } from '@travetto/registry';
+import { Controller, Post } from '@travetto/web';
 
 import { BaseWebSuite } from '@travetto/web/support/test/suite/base.ts';
 
@@ -14,7 +14,6 @@ const getHash = (blob: Blob) => BinaryMetadataUtil.read(blob)?.hash;
 
 @Controller('/test/upload')
 class TestUploadController {
-
   @Post('/all')
   async uploadAll(@Upload() uploads: FileMap): Promise<{ hash?: string } | undefined> {
     for (const [, blob] of Object.entries(uploads)) {
@@ -45,18 +44,19 @@ class TestUploadController {
 
 @Suite()
 export abstract class WebUploadServerSuite extends BaseWebSuite {
-
   fixture: TestFixtures;
 
-  async getUploads(...files: { name: string, resource: string, type?: string }[]): Promise<FormData> {
+  async getUploads(...files: { name: string; resource: string; type?: string }[]): Promise<FormData> {
     const data = new FormData();
-    await Promise.all(files.map(async ({ name, type, resource }) => {
-      const file = await this.fixture.readFile(resource);
-      if (type) {
-        Object.defineProperty(file, 'type', { get: () => type });
-      }
-      data.append(name, file);
-    }));
+    await Promise.all(
+      files.map(async ({ name, type, resource }) => {
+        const file = await this.fixture.readFile(resource);
+        if (type) {
+          Object.defineProperty(file, 'type', { get: () => type });
+        }
+        data.append(name, file);
+      })
+    );
     return data;
   }
 
@@ -72,7 +72,7 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
     const response = await this.request<{ hash: string }>({ body: uploads, context: { httpMethod: 'POST', path: '/test/upload/all' } });
 
     const file = await this.fixture.readBinaryStream('/logo.png');
-    assert(response.body?.hash === await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' }));
+    assert(response.body?.hash === (await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' })));
   }
 
   @Test()
@@ -82,7 +82,7 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
     const response = await this.request<{ hash: string }>({ context: { httpMethod: 'POST', path: '/test/upload' }, body: sent });
 
     const file = await this.fixture.readBinaryStream('/logo.png');
-    assert(response.body?.hash === await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' }));
+    assert(response.body?.hash === (await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' })));
   }
 
   @Test()
@@ -91,7 +91,7 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
     const response = await this.request<{ hash: string }>({ body: uploads, context: { httpMethod: 'POST', path: '/test/upload' } });
 
     const file = await this.fixture.readBinaryStream('/logo.png');
-    assert(response.body?.hash === await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' }));
+    assert(response.body?.hash === (await BinaryMetadataUtil.hash(file, { hashAlgorithm: 'sha256' })));
   }
 
   @Test()
@@ -100,10 +100,11 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
       { name: 'file1', resource: 'logo.png', type: 'image/png' },
       { name: 'file2', resource: 'logo.png', type: 'image/png' }
     );
-    const response = await this.request<{ hash1: string, hash2: string }>({
+    const response = await this.request<{ hash1: string; hash2: string }>({
       body: uploads,
       context: {
-        httpMethod: 'POST', path: '/test/upload/all-named'
+        httpMethod: 'POST',
+        path: '/test/upload/all-named'
       }
     });
     const file = await this.fixture.readBinaryStream('/logo.png');
@@ -120,20 +121,26 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
       { name: 'file2', resource: 'logo.png', type: 'image/png' }
     );
 
-    const badResponse = await this.request<{ hash1: string, hash2: string }>({
-      body: uploadBad,
-      context: { httpMethod: 'POST', path: '/test/upload/all-named-custom' },
-    }, false);
+    const badResponse = await this.request<{ hash1: string; hash2: string }>(
+      {
+        body: uploadBad,
+        context: { httpMethod: 'POST', path: '/test/upload/all-named-custom' }
+      },
+      false
+    );
     assert(badResponse.context.httpStatusCode === 400);
 
     const uploads = await this.getUploads(
       { name: 'file1', resource: 'logo.gif', type: 'image/gif' },
       { name: 'file2', resource: 'logo.png', type: 'image/png' }
     );
-    const response = await this.request<{ hash1: string, hash2: string }>({
-      body: uploads,
-      context: { httpMethod: 'POST', path: '/test/upload/all-named-custom' },
-    }, false);
+    const response = await this.request<{ hash1: string; hash2: string }>(
+      {
+        body: uploads,
+        context: { httpMethod: 'POST', path: '/test/upload/all-named-custom' }
+      },
+      false
+    );
     assert(response.context.httpStatusCode === 200);
 
     const file1 = await this.fixture.readBinaryStream('/logo.gif');
@@ -153,20 +160,26 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
       { name: 'file2', resource: 'logo.png', type: 'image/png' }
     );
 
-    const badResponse = await this.request<{ hash1: string, hash2: string }>({
-      body: uploadBad,
-      context: { httpMethod: 'POST', path: '/test/upload/all-named-size' },
-    }, false);
+    const badResponse = await this.request<{ hash1: string; hash2: string }>(
+      {
+        body: uploadBad,
+        context: { httpMethod: 'POST', path: '/test/upload/all-named-size' }
+      },
+      false
+    );
     assert(badResponse.context.httpStatusCode === 400);
 
     const uploads = await this.getUploads(
       { name: 'file1', resource: 'asset.yml', type: 'text/plain' },
       { name: 'file2', resource: 'logo.png', type: 'image/png' }
     );
-    const response = await this.request<{ hash1: string, hash2: string }>({
-      body: uploads,
-      context: { httpMethod: 'POST', path: '/test/upload/all-named-size' },
-    }, false);
+    const response = await this.request<{ hash1: string; hash2: string }>(
+      {
+        body: uploads,
+        context: { httpMethod: 'POST', path: '/test/upload/all-named-size' }
+      },
+      false
+    );
     assert(response.context.httpStatusCode === 200);
 
     const file1 = await this.fixture.readBinaryStream('/asset.yml');
@@ -178,4 +191,4 @@ export abstract class WebUploadServerSuite extends BaseWebSuite {
     assert(response.body?.hash1 === hash1);
     assert(response.body?.hash2 === hash2);
   }
-}
+}