@opra/http 1.25.6 → 1.26.0

package/impl/local-file.d.ts

@@ -0,0 +1,23 @@
+export declare class LocalFile {
+    private _autoDelete;
+    readonly storedPath: string;
+    filename: string;
+    type?: string;
+    encoding?: BufferEncoding;
+    constructor(storedPath: string, options?: LocalFile.Options);
+    text(): Promise<string>;
+    buffer(): Promise<Buffer>;
+    delete(): Promise<void>;
+    get size(): number;
+    get autoDelete(): boolean;
+    set autoDelete(value: boolean);
+    static tempFilename(filename?: string, tempDirectory?: string): string;
+}
+export declare namespace LocalFile {
+    interface Options {
+        filename?: string;
+        autoDelete?: boolean;
+        type?: string;
+        encoding?: BufferEncoding;
+    }
+}

package/impl/local-file.js

@@ -0,0 +1,70 @@
+import fs from 'node:fs';
+import fsAsync from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import { uid } from 'uid';
+const registry = new FinalizationRegistry((storedPath) => {
+    fs.unlink(storedPath, () => undefined);
+});
+export class LocalFile {
+    _autoDelete = false;
+    storedPath;
+    filename;
+    type;
+    encoding;
+    constructor(storedPath, options = {}) {
+        this.storedPath = storedPath;
+        this.filename = options.filename ?? path.basename(storedPath);
+        this.type = options.type;
+        if (options?.autoDelete)
+            this.autoDelete = true;
+    }
+    async text() {
+        return fsAsync.readFile(this.storedPath, this.encoding || 'utf-8');
+    }
+    async buffer() {
+        return fsAsync.readFile(this.storedPath);
+    }
+    async delete() {
+        if (fs.existsSync(this.storedPath)) {
+            try {
+                await fsAsync.unlink(this.storedPath);
+                this.autoDelete = false;
+            }
+            catch (error) {
+                console.error(`Failed to delete file ${this.storedPath}: ${error}`);
+            }
+        }
+    }
+    get size() {
+        return fs.statSync(this.storedPath).size;
+    }
+    get autoDelete() {
+        return this._autoDelete;
+    }
+    set autoDelete(value) {
+        if (value === this._autoDelete)
+            return;
+        this._autoDelete = value;
+        if (value) {
+            registry.register(this, this.storedPath, this); // GC-based
+            // exit-based
+            process.finalization?.register(this, obj => obj.delete());
+        }
+        else {
+            registry.unregister(this);
+            process.finalization?.unregister(this);
+        }
+    }
+    static tempFilename(filename, tempDirectory) {
+        let filePath;
+        let prefix = '';
+        tempDirectory = tempDirectory || os.tmpdir();
+        while (true) {
+            filePath = path.posix.join(tempDirectory, filename ? prefix + filename : 'opra-' + uid(12));
+            if (!fs.existsSync(filePath))
+                return filePath;
+            prefix = uid(6) + '-';
+        }
+    }
+}

package/impl/multipart-reader.d.ts

@@ -3,28 +3,7 @@ import busboy from 'busboy';
 import { EventEmitter } from 'events';
 import type { StrictOmit } from 'ts-gems';
 import type { HttpContext } from '../http-context.js';
-export declare namespace MultipartReader {
-    interface Options extends StrictOmit<busboy.BusboyConfig, 'headers'> {
-        tempDirectory?: string;
-        scope?: string;
-    }
-    interface FieldInfo {
-        kind: 'field';
-        field: string;
-        value?: any;
-        mimeType?: string;
-        encoding?: string;
-    }
-    interface FileInfo {
-        kind: 'file';
-        field: string;
-        filename: string;
-        storedPath: string;
-        mimeType?: string;
-        encoding?: string;
-    }
-    type Item = FieldInfo | FileInfo;
-}
+import { LocalFile } from './local-file.js';
 export declare class MultipartReader extends EventEmitter {
     protected context: HttpContext;
     protected mediaType?: HttpMediaType | undefined;
@@ -46,3 +25,23 @@ export declare class MultipartReader extends EventEmitter {
     pause(): void;
     purge(): Promise<PromiseSettledResult<any>[]>;
 }
+export declare class MultipartFile extends LocalFile {
+    readonly kind = "file";
+    readonly field: string;
+    constructor(field: string, storedPath: string, options?: LocalFile.Options);
+}
+export declare namespace MultipartReader {
+    interface Options extends StrictOmit<busboy.BusboyConfig, 'headers'> {
+        tempDirectory?: string;
+        scope?: string;
+    }
+    interface Field {
+        kind: 'field';
+        field: string;
+        value?: any;
+        mimeType?: string;
+        encoding?: string;
+    }
+    type File = MultipartFile;
+    type Item = Field | File;
+}

package/impl/multipart-reader.js

@@ -1,13 +1,12 @@
 import fs from 'node:fs';
 import os from 'node:os';
-import nodePath from 'node:path';
 import typeIs from '@browsery/type-is';
 import { BadRequestError } from '@opra/common';
 import busboy from 'busboy';
 import { EventEmitter } from 'events';
 import fsPromise from 'fs/promises';
-import { uid } from 'uid';
 import { isNotNullish } from 'valgen';
+import { LocalFile } from './local-file.js';
 export class MultipartReader extends EventEmitter {
     context;
     mediaType;
@@ -52,17 +51,15 @@ export class MultipartReader extends EventEmitter {
             this.emit('item', item);
         });
         form.on('file', (field, file, info) => {
-            const saveTo = generateFileName(info, this.tempDirectory);
+            const saveTo = LocalFile.tempFilename(info.filename, this.tempDirectory);
             file.pipe(fs.createWriteStream(saveTo));
             file.once('end', () => {
-                const item = {
-                    kind: 'file',
-                    field,
-                    storedPath: saveTo,
+                const item = new MultipartFile(field, saveTo, {
                     filename: info.filename,
-                    mimeType: info.mimeType,
+                    type: info.mimeType,
                     encoding: info.encoding,
-                };
+                    autoDelete: true,
+                });
                 this._items.push(item);
                 this._stack.push(item);
                 this.emit('file', item);
@@ -119,7 +116,7 @@ export class MultipartReader extends EventEmitter {
                     const arr = Array.isArray(field.contentType)
                         ? field.contentType
                         : [field.contentType];
-                    if (!(item.mimeType && arr.find(ct => typeIs.is(item.mimeType, [ct])))) {
+                    if (!(item.type && arr.find(ct => typeIs.is(item.type, [ct])))) {
                         throw new BadRequestError(`Multipart field (${item.field}) do not accept this content type`);
                     }
                 }
@@ -202,13 +199,13 @@ export class MultipartReader extends EventEmitter {
         return Promise.allSettled(promises);
     }
 }
-function generateFileName(info, tempDirectory) {
-    let filename;
-    let prefix = '';
-    while (true) {
-        filename = nodePath.posix.join(tempDirectory, info.filename ? prefix + info.filename : 'opra-' + uid(12));
-        if (!fs.existsSync(filename))
-            return filename;
-        prefix = uid(6) + '-';
+export class MultipartFile extends LocalFile {
+    kind = 'file';
+    field;
+    constructor(field, storedPath, options = {
+        autoDelete: true,
+    }) {
+        super(storedPath, options);
+        this.field = field;
     }
 }

package/index.d.ts

@@ -7,6 +7,7 @@ export * from './express-adapter.js';
 export * from './http-adapter.js';
 export * from './http-context.js';
 export * from './http-handler.js';
+export * from './impl/local-file.js';
 export * from './impl/multipart-reader.js';
 export * from './interfaces/http-incoming.interface.js';
 export * from './interfaces/http-outgoing.interface.js';

package/index.js

@@ -7,6 +7,7 @@ export * from './express-adapter.js';
 export * from './http-adapter.js';
 export * from './http-context.js';
 export * from './http-handler.js';
+export * from './impl/local-file.js';
 export * from './impl/multipart-reader.js';
 export * from './interfaces/http-incoming.interface.js';
 export * from './interfaces/http-outgoing.interface.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/http",
-  "version": "1.25.6",
+  "version": "1.26.0",
   "description": "Opra Http Server Adapter",
   "author": "Panates",
   "license": "MIT",
@@ -13,7 +13,7 @@
     "base64-stream": "^1.0.0",
     "busboy": "^1.6.0",
     "bytes": "^3.1.2",
-    "content-disposition": "^1.0.1",
+    "content-disposition": "^1.1.0",
     "content-type": "^1.0.5",
     "cookie": "^1.1.1",
     "cookie-signature": "^1.2.2",
@@ -38,8 +38,8 @@
     "yaml": "^2.8.3"
   },
   "peerDependencies": {
-    "@opra/common": "^1.25.6",
-    "@opra/core": "^1.25.6"
+    "@opra/common": "^1.26.0",
+    "@opra/core": "^1.26.0"
   },
   "optionalDependencies": {
     "express": "^4.0.0 || ^5.0.0",

package/utils/body-reader.d.ts

@@ -1,5 +1,7 @@
+import fs from 'node:fs';
 import nodeStream from 'node:stream';
 import { EventEmitter } from 'events';
+import { LocalFile } from '../impl/local-file.js';
 import type { HttpIncoming } from '../interfaces/http-incoming.interface.js';
 /**
  *
@@ -8,6 +10,7 @@ import type { HttpIncoming } from '../interfaces/http-incoming.interface.js';
 export declare namespace BodyReader {
     interface Options {
         limit?: number | string;
+        toFile?: boolean | string;
     }
 }
 type Callback = (...args: any[]) => any;
@@ -22,6 +25,8 @@ export declare class BodyReader extends EventEmitter {
     protected _buffer?: string | Buffer[];
     protected _completed?: boolean | undefined;
     protected _receivedSize: number;
+    protected _file?: LocalFile;
+    protected _fileStream?: fs.WriteStream;
     protected cleanup: Callback;
     protected onAborted: Callback;
     protected onData: Callback;

package/utils/body-reader.js

@@ -1,3 +1,5 @@
+import fs from 'node:fs';
+import path from 'node:path';
 import typeIs from '@browsery/type-is';
 import { BadRequestError, InternalServerError, OpraHttpError, } from '@opra/common';
 import { Base64Decode } from 'base64-stream';
@@ -7,6 +9,7 @@ import { EventEmitter } from 'events';
 import iconv from 'iconv-lite';
 import { Writable } from 'stream';
 import * as zlib from 'zlib';
+import { LocalFile } from '../impl/local-file.js';
 /**
  *
  * @class BodyReader
@@ -18,6 +21,8 @@ export class BodyReader extends EventEmitter {
     _buffer;
     _completed = false;
     _receivedSize = 0;
+    _file;
+    _fileStream;
     cleanup;
     onAborted;
     onData;
@@ -34,6 +39,19 @@ export class BodyReader extends EventEmitter {
                 ? options.limit
                 : byteParser(options.limit) || undefined
             : undefined;
+        if (options?.toFile === true) {
+            this._file = new LocalFile(LocalFile.tempFilename());
+        }
+        else if (typeof options?.toFile === 'string') {
+            if (path.isAbsolute(options?.toFile)) {
+                this._file = new LocalFile(options?.toFile);
+            }
+            else {
+                this._file = new LocalFile(LocalFile.tempFilename(options?.toFile));
+            }
+        }
+        if (this._file)
+            this._file.autoDelete = true;
     }
     async read() {
         /* istanbul ignore next */
@@ -118,6 +136,10 @@ export class BodyReader extends EventEmitter {
                 stream = newStream;
             }
             this._stream = stream;
+            if (this._file) {
+                this._fileStream = fs.createWriteStream(this._file.storedPath);
+                stream.pipe(this._fileStream);
+            }
             // attach listeners
             stream.on('aborted', this.onAborted);
             stream.on('close', this.cleanup);
@@ -133,9 +155,22 @@ export class BodyReader extends EventEmitter {
         if (error) {
             this._stream?.unpipe();
             this._stream?.pause();
+            this._fileStream?.close(() => {
+                this._file?.delete();
+            });
         }
-        if (error)
+        if (error) {
             this.emit('finish', error);
+        }
+        else if (this._file) {
+            if (this._fileStream) {
+                this._fileStream.once('finish', () => {
+                    this.emit('finish', undefined, this._file);
+                });
+            }
+            else
+                this.emit('finish', error, undefined);
+        }
         else if (Array.isArray(this._buffer))
             this.emit('finish', error, Buffer.concat(this._buffer));
         else
@@ -163,7 +198,7 @@ export class BodyReader extends EventEmitter {
         }));
     }
     _onData(chunk) {
-        if (this._completed)
+        if (this._completed || this._file)
             return;
         if (typeof chunk === 'string') {
             this._buffer = this._buffer || '';