@travetto/web-upload 7.0.0-rc.1 → 7.0.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/web-upload",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
   "description": "Provides integration between the travetto asset and web module.",
   "keywords": [
     "web",
@@ -26,13 +26,13 @@
   },
   "dependencies": {
     "@fastify/busboy": "^3.2.0",
-    "@travetto/config": "^7.0.0-rc.0",
-    "@travetto/web": "^7.0.0-rc.1",
+    "@travetto/config": "^7.0.0-rc.2",
+    "@travetto/web": "^7.0.0-rc.3",
     "file-type": "^21.1.1",
     "mime": "^4.1.0"
   },
   "peerDependencies": {
-    "@travetto/test": "^7.0.0-rc.0"
+    "@travetto/test": "^7.0.0-rc.2"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/decorator.ts

@@ -19,29 +19,30 @@ const FileMapContract = toConcrete<FileMap>();
  */
 export function Upload(
   param: Partial<EndpointParameterConfig> & UploadConfig = {},
-): (instance: ClassInstance, property: string | symbol, idx: number) => void {
+): (instance: ClassInstance, property: string, idx: number) => void {
 
-  const finalConf = { ...param };
+  const finalConfig = { ...param };
 
-  return (instance: ClassInstance, property: string | symbol, idx: number): void => {
+  return (instance: ClassInstance, property: string, idx: number): void => {
     // Register field
-    const cls = ControllerRegistryIndex.getForRegister(getClass(instance));
-    const getName = (): string => SchemaRegistryIndex.getMethodConfig(instance.constructor, property).parameters[idx].name!.toString();
+    const cls = getClass(instance);
+    const adapter = ControllerRegistryIndex.getForRegister(cls);
+    const getName = (): string => SchemaRegistryIndex.get(cls).getMethod(property).parameters[idx].name!;
 
-    cls.registerFinalizeHandler(() => {
-      cls.registerEndpointInterceptorConfig(
+    adapter.registerFinalizeHandler(() => {
+      adapter.registerEndpointInterceptorConfig(
         property,
         WebUploadInterceptor,
         {
           applies: true,
-          maxSize: finalConf.maxSize,
-          types: finalConf.types,
-          cleanupFiles: finalConf.cleanupFiles,
+          maxSize: finalConfig.maxSize,
+          types: finalConfig.types,
+          cleanupFiles: finalConfig.cleanupFiles,
           uploads: {
             [getName()]: {
-              maxSize: finalConf.maxSize,
-              types: finalConf.types,
-              cleanupFiles: finalConf.cleanupFiles
+              maxSize: finalConfig.maxSize,
+              types: finalConfig.types,
+              cleanupFiles: finalConfig.cleanupFiles
             }
           }
         }
@@ -49,9 +50,9 @@ export function Upload(
     });
 
     return Param('body', {
-      ...finalConf,
+      ...finalConfig,
       extract: (request) => {
-        const input = SchemaRegistryIndex.getMethodConfig(instance.constructor, property).parameters[idx];
+        const input = SchemaRegistryIndex.get(cls).getMethod(property).parameters[idx];
 
         if (!input) {
           throw new AppError(`Unknown field type, ensure you are using ${Blob.name}, ${File.name} or ${FileMapContract.name}`);

package/src/interceptor.ts

@@ -24,8 +24,8 @@ export class WebUploadInterceptor implements WebInterceptor<WebUploadConfig> {
   finalizeConfig({ config: base }: WebInterceptorContext<WebUploadConfig>, inputs: Partial<WebUploadConfig>[]): WebUploadConfig {
     base.uploads ??= {};
     // Override the uploads object with all the data from the inputs
-    for (const [k, cfg] of inputs.flatMap(el => Object.entries(el.uploads ?? {}))) {
-      Object.assign(base.uploads[k] ??= {}, cfg);
+    for (const [key, config] of inputs.flatMap(inputConfig => Object.entries(inputConfig.uploads ?? {}))) {
+      Object.assign(base.uploads[key] ??= {}, config);
     }
     return base;
   }

package/src/util.ts

@@ -64,9 +64,11 @@ export class WebUploadUtil {
     const contentType = WebHeaderUtil.parseHeaderSegment(request.headers.get('Content-Type'));
 
     if (MULTIPART.has(contentType.value)) {
-      const fileMaxes = Object.values(config.uploads ?? {}).map(x => x.maxSize).filter(x => x !== undefined);
+      const fileMaxes = Object.values(config.uploads ?? {})
+        .map(uploadConfig => uploadConfig.maxSize)
+        .filter(uploadConfig => uploadConfig !== undefined);
       const largestMax = fileMaxes.length ? Math.max(...fileMaxes) : config.maxSize;
-      const itr = new AsyncQueue<UploadItem>();
+      const queue = new AsyncQueue<UploadItem>();
 
       // Upload
       bodyStream.pipe(busboy({
@@ -80,12 +82,12 @@ export class WebUploadUtil {
         },
         limits: { fileSize: largestMax }
       })
-        .on('file', (field, stream, filename) => itr.add({ stream, filename, field }))
-        .on('limit', field => itr.throw(new AppError(`File size exceeded for ${field}`, { category: 'data' })))
-        .on('finish', () => itr.close())
-        .on('error', (err) => itr.throw(err instanceof Error ? err : new Error(`${err}`))));
+        .on('file', (field, stream, filename) => queue.add({ stream, filename, field }))
+        .on('limit', field => queue.throw(new AppError(`File size exceeded for ${field}`, { category: 'data' })))
+        .on('finish', () => queue.close())
+        .on('error', (error) => queue.throw(error instanceof Error ? error : new Error(`${error}`))));
 
-      yield* itr;
+      yield* queue;
     } else {
       const filename = WebHeaderUtil.parseHeaderSegment(request.headers.get('Content-Disposition')).parameters.filename;
       yield { stream: bodyStream, filename, field: 'file' };
@@ -96,12 +98,12 @@ export class WebUploadUtil {
    * Convert an UploadItem to a File
    */
   static async toFile({ stream, filename, field }: UploadItem, config: Partial<WebUploadConfig>): Promise<File> {
-    const uniqueDir = path.resolve(os.tmpdir(), `file_${Date.now()}_${Util.uuid(5)}`);
-    await fs.mkdir(uniqueDir, { recursive: true });
+    const uniqueDirectory = path.resolve(os.tmpdir(), `file_${Date.now()}_${Util.uuid(5)}`);
+    await fs.mkdir(uniqueDirectory, { recursive: true });
 
     filename = filename ? path.basename(filename) : `unknown_${Date.now()}`;
 
-    const location = path.resolve(uniqueDir, filename);
+    const location = path.resolve(uniqueDirectory, filename);
     const remove = (): Promise<void> => fs.rm(location).catch(() => { });
     const mimeCheck = config.matcher ??= WebCommonUtil.mimeTypeMatcher(config.types);
 
@@ -132,9 +134,9 @@ export class WebUploadUtil {
       Object.assign(file, { [RawFileSymbol]: location });
 
       return file;
-    } catch (err) {
+    } catch (error) {
       await remove();
-      throw err;
+      throw error;
     }
   }
 
@@ -146,14 +148,14 @@ export class WebUploadUtil {
     const { fromStream } = await import('strtok3');
 
     const parser = new FileTypeParser();
-    let tok: ReturnType<typeof fromStream> | undefined;
+    let token: ReturnType<typeof fromStream> | undefined;
     let matched: FileType | undefined;
 
     try {
-      tok = await fromStream(typeof input === 'string' ? createReadStream(input) : input);
-      matched = await parser.fromTokenizer(tok);
+      token = await fromStream(typeof input === 'string' ? createReadStream(input) : input);
+      matched = await parser.fromTokenizer(token);
     } finally {
-      await tok?.close();
+      await token?.close();
     }
 
     if (!matched && typeof input === 'string') {