@visulima/storage 1.0.0-alpha.9 → 1.0.0

package/dist/handler/base/base-handler-core.d.ts

@@ -1,91 +0,0 @@
-import { EventEmitter } from "node:events";
-import type { BaseStorage } from "../../storage/storage.d.ts";
-import type { UploadFile } from "../../storage/utils/index.d.ts";
-import type MediaTransformer from "../../transformer/media-transformer.d.ts";
-import type { ErrorResponses } from "../../utils/errors.d.ts";
-import type { ResponseBodyType } from "../../utils/types.d.ts";
-import type { UploadOptions } from "../types.d.ts";
-/**
- * Core base class containing shared business logic for all handlers.
- * This class is platform-agnostic and contains no Node.js or Web API specific code.
- * @template TFile The file type used by this handler.
- */
-declare abstract class BaseHandlerCore<TFile extends UploadFile> extends EventEmitter {
-    /**
-     * Response body type for the handler.
-     */
-    responseType: ResponseBodyType;
-    /**
-     * Storage instance for file operations.
-     */
-    storage: BaseStorage<TFile>;
-    /**
-     * Optional media transformer for image/video processing.
-     */
-    mediaTransformer?: MediaTransformer;
-    /**
-     * Whether to disable termination for finished uploads.
-     */
-    disableTerminationForFinishedUploads?: boolean;
-    /**
-     * Logger instance for debugging and error reporting.
-     */
-    protected logger?: Console;
-    /**
-     * Gets the logger instance.
-     * @returns Logger instance or undefined.
-     */
-    get loggerInstance(): Console | undefined;
-    /**
-     * Internal error responses configuration.
-     */
-    protected internalErrorResponses: ErrorResponses;
-    /**
-     * Gets the error responses configuration.
-     * @returns Error responses configuration.
-     */
-    get errorResponses(): ErrorResponses;
-    constructor({ disableTerminationForFinishedUploads, mediaTransformer, storage }: UploadOptions<TFile>);
-    /**
-     * Sets custom error responses.
-     * @param value Partial error responses to override defaults.
-     */
-    set errorResponses(value: Partial<ErrorResponses>);
-    /**
-     * Assemble error responses by merging defaults with custom overrides.
-     * @param customErrors Custom error responses to override defaults
-     */
-    assembleErrors: (customErrors?: {}) => void;
-    /**
-     * Parses HTTP Range header and returns start/end byte positions for partial content requests.
-     * @param rangeHeader HTTP Range header value (e.g., "bytes=0-1023").
-     * @param fileSize Total size of the file in bytes.
-     * @returns Object with start and end positions, or undefined if range is invalid.
-     */
-    parseRangeHeader(rangeHeader: string | undefined, fileSize: number): {
-        end: number;
-        start: number;
-    } | undefined;
-    /**
-     * Build file URL from request and file data.
-     * Platform-agnostic version that accepts URL string.
-     * @param requestUrl Request URL string
-     * @param file File object containing ID and content type
-     * @returns Constructed file URL with extension based on content type
-     */
-    protected buildFileUrlFromString(requestUrl: string, file: TFile): string;
-    /**
-     * Negotiates content type based on Accept header and supported formats.
-     * Platform-agnostic version that accepts header string.
-     * @param acceptHeader Accept header value
-     * @param supportedTypes Array of supported MIME types to match against
-     * @returns Best matching content type or undefined if no match found
-     */
-    negotiateContentTypeFromHeader(acceptHeader: string | undefined, supportedTypes: string[]): string | undefined;
-    /**
-     * Check for undefined ID or path errors and throw appropriate HTTP errors.
-     * @param error The error to check
-     */
-    protected checkForUndefinedIdOrPath(error: unknown): void;
-}
-export default BaseHandlerCore;

package/dist/handler/base/base-handler-fetch.d.ts

@@ -1,76 +0,0 @@
-import type { UploadFile } from "../../storage/utils/index.d.ts";
-import type { UploadResponse } from "../../utils/types.d.ts";
-import type { Handlers, ResponseFile, ResponseList, UploadOptions } from "../types.d.ts";
-import BaseHandlerCore from "./base-handler-core.d.ts";
-/**
- * Base handler for Web API Fetch platform (Request/Response).
- * Extends BaseHandlerCore with Fetch-specific request/response handling.
- * @template TFile The file type used by this handler.
- */
-declare abstract class BaseHandlerFetch<TFile extends UploadFile> extends BaseHandlerCore<TFile> {
-    /**
-     * Limiting enabled HTTP method handler.
-     */
-    static readonly methods: Handlers[];
-    /**
-     * Map of registered HTTP method handlers.
-     */
-    protected registeredHandlers: Map<string, (request: Request) => Promise<ResponseFile<TFile> | ResponseList<TFile>>>;
-    constructor(options: UploadOptions<TFile>);
-    /**
-     * Gets the registered handlers map.
-     * @returns Map of registered handlers.
-     */
-    get handlers(): Map<string, (request: Request) => Promise<ResponseFile<TFile> | ResponseList<TFile>>>;
-    /**
-     * Handles Web API Fetch requests (for Hono, Cloudflare Workers, etc.).
-     * @param request Web API Request object.
-     * @returns Promise resolving to Web API Response.
-     */
-    fetch(request: Request): Promise<globalThis.Response>;
-    /**
-     * Compose and register HTTP method handlers.
-     * Subclasses should override this to register their specific handlers.
-     */
-    protected abstract compose(): void;
-    /**
-     * Handle the response from handlers for fetch requests and convert to Web API Response.
-     * @param request Web API Request object
-     * @param file Response file or list from handler
-     * @returns Promise resolving to Web API Response object
-     */
-    protected handleFetchResponse(request: Request, file: ResponseFile<TFile> | ResponseList<TFile>): Promise<globalThis.Response>;
-    /**
-     * Convert headers to Web API Headers format by flattening arrays and converting to strings.
-     * @param headers Headers object with potentially array values
-     * @returns Headers object with all values as strings
-     */
-    protected convertHeaders(headers: Record<string, number | string | string[]>): Record<string, string>;
-    /**
-     * Create Web API Response from UploadResponse object.
-     * @param uploadResponse Upload response containing body, headers, and status code
-     * @returns Web API Response object
-     */
-    protected createResponse(uploadResponse: UploadResponse): globalThis.Response;
-    /**
-     * Create error Response from Error object with appropriate status code and message.
-     * @param error Error object to convert to HTTP error response
-     * @returns Web API Response object with error details
-     */
-    protected createErrorResponse(error: Error): Promise<globalThis.Response>;
-    /**
-     * Build file URL from request and file data.
-     * @param request Web API Request object
-     * @param file File object containing ID and content type
-     * @returns Constructed file URL with extension based on content type
-     */
-    protected buildFileUrl(request: Request, file: TFile): string;
-    /**
-     * Negotiates content type based on Accept header and supported formats.
-     * @param request Web API Request object containing Accept header.
-     * @param supportedTypes Array of supported MIME types to match against.
-     * @returns Best matching content type or undefined if no match found.
-     */
-    negotiateContentType(request: Request, supportedTypes: string[]): string | undefined;
-}
-export default BaseHandlerFetch;

package/dist/handler/base/base-handler-node.d.ts

@@ -1,137 +0,0 @@
-import type { IncomingMessage, ServerResponse } from "node:http";
-import type { Readable } from "node:stream";
-import type { UploadFile } from "../../storage/utils/index.d.ts";
-import type { UploadResponse } from "../../utils/types.d.ts";
-import type { AsyncHandler, Handlers, MethodHandler, ResponseFile, ResponseList, UploadOptions } from "../types.d.ts";
-import BaseHandlerCore from "./base-handler-core.d.ts";
-/**
- * Base handler for Node.js platform (IncomingMessage/ServerResponse).
- * Extends BaseHandlerCore with Node.js-specific request/response handling.
- * @template TFile The file type used by this handler.
- * @template NodeRequest The Node.js request type.
- * @template NodeResponse The Node.js response type.
- */
-declare abstract class BaseHandlerNode<TFile extends UploadFile, NodeRequest extends IncomingMessage = IncomingMessage, NodeResponse extends ServerResponse = ServerResponse> extends BaseHandlerCore<TFile> implements MethodHandler<NodeRequest, NodeResponse> {
-    /**
-     * Limiting enabled HTTP method handler.
-     */
-    static readonly methods: Handlers[];
-    /**
-     * Map of registered HTTP method handlers.
-     */
-    protected registeredHandlers: Map<string, AsyncHandler<NodeRequest, NodeResponse>>;
-    constructor(options: UploadOptions<TFile>);
-    /**
-     * Gets the registered handlers map.
-     * @returns Map of registered handlers.
-     */
-    get handlers(): Map<string, AsyncHandler<NodeRequest, NodeResponse>>;
-    /**
-     * Handles HTTP request (alias for upload method).
-     * @param request Node.js IncomingMessage.
-     * @param response Node.js ServerResponse.
-     */
-    handle: (request: NodeRequest, response: NodeResponse) => Promise<void>;
-    /**
-     * Main upload handler that processes HTTP requests and routes them to appropriate method handlers.
-     * @param request Node.js IncomingMessage.
-     * @param response Node.js ServerResponse.
-     * @param next Optional Express-style next function for middleware compatibility.
-     * @throws {UploadError} When storage is not ready or method is not allowed.
-     */
-    upload: (request: NodeRequest, response: NodeResponse, next?: () => void) => Promise<void>;
-    /**
-     * Compose and register HTTP method handlers.
-     * Subclasses should override this to register their specific handlers.
-     */
-    protected abstract compose(): void;
-    /**
-     * Sends an HTTP response with the provided body, headers, and status code.
-     * @param response Node.js ServerResponse to send data to.
-     * @param body Response body, headers, and status code.
-     */
-    send(response: NodeResponse, { body, headers, statusCode }: UploadResponse): void;
-    /**
-     * Sends an error response to the client with appropriate status code and message.
-     * @param response Node.js ServerResponse to send error to.
-     * @param error Error object to convert to HTTP error response.
-     */
-    sendError(response: NodeResponse, error: Error): Promise<void>;
-    /**
-     * Sends streaming response to client with proper backpressure handling and range request support.
-     * @param response Node.js ServerResponse to stream data to.
-     * @param stream Readable stream containing the file data.
-     * @param options Streaming options including headers, range, size, and status code.
-     */
-    sendStream(response: NodeResponse, stream: Readable, { headers, range, size, statusCode, }: {
-        headers?: Record<string, string | number>;
-        range?: {
-            end: number;
-            start: number;
-        };
-        size?: number;
-        statusCode?: number;
-    }): void;
-    /**
-     * Finish upload by sending final response to client with completed file data.
-     * @param _request HTTP request (unused parameter)
-     * @param response HTTP response object to send final response to
-     * @param uploadResponse Final upload response data containing body, headers, and status code
-     */
-    protected finish(_request: NodeRequest, response: NodeResponse, uploadResponse: UploadResponse | ResponseFile<TFile>): void;
-    /**
-     * Build file URL from request and file data.
-     * @param request HTTP request with optional originalUrl property
-     * @param file File object containing ID and content type
-     * @returns Constructed file URL with extension based on content type
-     */
-    protected buildFileUrl(request: NodeRequest & {
-        originalUrl?: string;
-    }, file: TFile): string;
-    /**
-     * Negotiates content type based on Accept header and supported formats.
-     * @param request HTTP request object containing Accept header.
-     * @param supportedTypes Array of supported MIME types to match against.
-     * @returns Best matching content type or undefined if no match found.
-     */
-    negotiateContentType(request: NodeRequest, supportedTypes: string[]): string | undefined;
-    /**
-     * Default OPTIONS handler.
-     * @param _request HTTP request (unused)
-     * @param _response HTTP response (unused)
-     * @returns Promise resolving to ResponseFile with CORS headers
-     */
-    options(_request: NodeRequest, _response: NodeResponse): Promise<ResponseFile<TFile>>;
-    /**
-     * Retrieves a file or list of files based on the request path.
-     * @param request Node.js IncomingMessage with optional originalUrl.
-     * @param response Node.js ServerResponse.
-     * @returns Promise resolving to a single file, paginated list, or array of files.
-     * @throws {UploadError} When file is not found or storage error occurs.
-     */
-    get(request: NodeRequest & {
-        originalUrl?: string;
-    }, _response: NodeResponse): Promise<ResponseFile<TFile> | ResponseList<TFile>>;
-    /**
-     * Returns a list of uploaded files with optional pagination support.
-     * @param request Node.js IncomingMessage containing query parameters for pagination.
-     * @param _response Node.js ServerResponse (unused).
-     * @returns Promise resolving to a paginated or complete list of uploaded files.
-     */
-    list(request: NodeRequest, _response: NodeResponse): Promise<ResponseList<TFile>>;
-    /**
-     * Streams download of a file with resumable support using HTTP range requests.
-     * @param request Node.js IncomingMessage with optional originalUrl and range header.
-     * @param response Node.js ServerResponse to stream the file to.
-     * @throws {HttpError} When file is not found or streaming is not supported.
-     */
-    download(request: NodeRequest & {
-        originalUrl?: string;
-    }, response: NodeResponse): Promise<void>;
-    /**
-     * Check if error is related to undefined ID or path and throw appropriate HTTP error.
-     * @param error Error object to check
-     */
-    protected checkForUndefinedIdOrPath(error: unknown): void;
-}
-export default BaseHandlerNode;

package/dist/handler/multipart/multipart-base.d.ts

@@ -1,84 +0,0 @@
-import type { FileInit, UploadFile } from "../../storage/utils/index.d.ts";
-import type { ResponseFile } from "../types.d.ts";
-/**
- * Base class containing shared Multipart business logic.
- * Platform-agnostic - contains no Node.js or Web API specific code.
- * @template TFile The file type used by this handler.
- */
-declare abstract class MultipartBase<TFile extends UploadFile> {
-    /**
-     * Handle multipart POST (upload file).
-     * @param filePart File part from multipart parser
-     * @param filePart.bytes File bytes data
-     * @param filePart.filename Original filename
-     * @param filePart.mediaType Content type
-     * @param filePart.size File size in bytes
-     * @param metadataParts All parts from multipart parser (for extracting metadata)
-     * @param requestUrl Request URL for Location header
-     * @returns Promise resolving to ResponseFile with upload result
-     */
-    handlePost(filePart: {
-        bytes: unknown;
-        filename?: string;
-        mediaType?: string;
-        size: number;
-    }, metadataParts: {
-        isFile: boolean;
-        name?: string;
-        text?: string;
-    }[], requestUrl: string): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle DELETE (delete file).
-     * @param id File ID from URL
-     * @returns Promise resolving to ResponseFile with deletion result
-     */
-    handleDelete(id: string): Promise<ResponseFile<TFile>>;
-    /**
-     * Storage instance for file operations.
-     */
-    protected get storage(): {
-        create: (config: FileInit) => Promise<TFile>;
-        delete: (options: {
-            id: string;
-        }) => Promise<TFile>;
-        maxUploadSize: number;
-        update: (options: {
-            id: string;
-        }, updates: {
-            metadata?: Record<string, unknown>;
-        }) => Promise<TFile>;
-        write: (options: {
-            body: unknown;
-            contentLength: number;
-            id: string;
-            start: number;
-        }) => Promise<TFile>;
-    };
-    /**
-     * Maximum file size allowed for multipart uploads
-     */
-    protected abstract get maxFileSize(): number;
-    /**
-     * Maximum header size allowed for multipart parser
-     */
-    protected abstract get maxHeaderSize(): number;
-    /**
-     * Build file URL from request URL and file data.
-     * @param _requestUrl Request URL string
-     * @param _file File object containing ID and content type
-     * @returns Constructed file URL with extension based on content type
-     */
-    protected buildFileUrl(_requestUrl: string, _file: TFile): string;
-    /**
-     * Create a stream from bytes data.
-     * @param bytes Bytes data (Uint8Array, Buffer, or other)
-     * @returns Stream object
-     */
-    protected abstract createStreamFromBytes(bytes: unknown): unknown;
-    /**
-     * Create an empty stream for signaling completion.
-     * @returns Empty stream object
-     */
-    protected abstract createEmptyStream(): unknown;
-}
-export default MultipartBase;

package/dist/handler/multipart/multipart-fetch.d.ts

@@ -1,64 +0,0 @@
-import type { UploadFile } from "../../storage/utils/index.d.ts";
-import BaseHandlerFetch from "../base/base-handler-fetch.d.ts";
-import type { Handlers, ResponseFile, UploadOptions } from "../types.d.ts";
-/**
- * Multipart/form-data upload handler (Web API Fetch version).
- * @example
- * ```ts
- * const multipart = new MultipartFetch({
- *   storage,
- *   maxFileSize: 100 * 1024 * 1024, // 100MB
- * });
- *
- * // Use with Hono, Cloudflare Workers, etc.
- * app.all('/files/*', async (c) => {
- *   return multipart.fetch(c.req.raw);
- * });
- * ```
- */
-declare class Multipart<TFile extends UploadFile> extends BaseHandlerFetch<TFile> {
-    /**
-     * Limiting enabled http method handler
-     */
-    static readonly methods: Handlers[];
-    private readonly multipartBase;
-    /**
-     * Maximum file size allowed for multipart uploads
-     */
-    private maxFileSize;
-    /**
-     * Maximum header size allowed for multipart parser
-     */
-    private maxHeaderSize;
-    constructor(options: UploadOptions<TFile>);
-    /**
-     * Handles multipart/form-data POST requests for file uploads.
-     * @param request Web API Request containing multipart data.
-     * @returns Promise resolving to ResponseFile with upload result.
-     */
-    post(request: Request): Promise<ResponseFile<TFile>>;
-    /**
-     * Delete an uploaded file.
-     * @param request Web API Request with file ID
-     * @returns Promise resolving to ResponseFile with deletion result
-     */
-    delete(request: Request): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle OPTIONS requests with CORS headers.
-     * @param _request Web API Request (unused)
-     * @returns Promise resolving to ResponseFile with CORS headers
-     */
-    options(_request: Request): Promise<ResponseFile<TFile>>;
-    /**
-     * Retrieves a file or list of files based on the request path.
-     * Delegates to BaseHandlerFetch.fetch() method.
-     * @param _request Web API Request
-     * @returns Promise resolving to Web API Response
-     */
-    get(_request: Request): Promise<ResponseFile<TFile>>;
-    /**
-     * Compose and register HTTP method handlers.
-     */
-    protected compose(): void;
-}
-export default Multipart;

package/dist/handler/multipart/multipart.d.ts

@@ -1,49 +0,0 @@
-import type { IncomingMessage, ServerResponse } from "node:http";
-import type { UploadFile } from "../../storage/utils/index.d.ts";
-import BaseHandlerNode from "../base/base-handler-node.d.ts";
-import type { Handlers, ResponseFile, UploadOptions } from "../types.d.ts";
-/**
- * Multipart/form-data upload handler (Node.js version).
- * @example
- * ```ts
- * const multipart = new Multipart({
- *   storage,
- *   maxFileSize: 100 * 1024 * 1024, // 100MB
- * });
- *
- * app.use('/files', multipart.handle);
- * ```
- */
-declare class Multipart<TFile extends UploadFile, NodeRequest extends IncomingMessage = IncomingMessage, NodeResponse extends ServerResponse = ServerResponse> extends BaseHandlerNode<TFile, NodeRequest, NodeResponse> {
-    /**
-     * Limiting enabled http method handler
-     */
-    static readonly methods: Handlers[];
-    private readonly multipartBase;
-    /**
-     * Maximum file size allowed for multipart uploads
-     */
-    private maxFileSize;
-    /**
-     * Maximum header size allowed for multipart parser
-     */
-    private maxHeaderSize;
-    constructor(options: UploadOptions<TFile>);
-    /**
-     * Handles multipart/form-data POST requests for file uploads.
-     * @param request Node.js IncomingMessage containing multipart data.
-     * @returns Promise resolving to ResponseFile with upload result.
-     */
-    post(request: NodeRequest): Promise<ResponseFile<TFile>>;
-    /**
-     * Delete an uploaded file.
-     * @param request Node.js IncomingMessage with file ID
-     * @returns Promise resolving to ResponseFile with deletion result
-     */
-    delete(request: NodeRequest): Promise<ResponseFile<TFile>>;
-    /**
-     * Compose and register HTTP method handlers.
-     */
-    protected compose(): void;
-}
-export default Multipart;

package/dist/handler/rest/rest-base.d.ts

@@ -1,106 +0,0 @@
-import type { FileInit, UploadFile } from "../../storage/utils/index.d.ts";
-import type { ResponseFile, ResponseList } from "../types.d.ts";
-/**
- * Base class containing shared REST API business logic.
- * Platform-agnostic - contains no Node.js or Web API specific code.
- * @template TFile The file type used by this handler.
- */
-declare abstract class RestBase<TFile extends UploadFile> {
-    /**
-     * Handle single file deletion.
-     * @param id File ID to delete
-     * @returns Promise resolving to ResponseFile with deletion result
-     */
-    deleteSingle(id: string): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle file creation (POST).
-     * @param config File initialization config
-     * @param isChunkedUpload Whether this is a chunked upload initialization
-     * @param requestUrl Request URL for Location header
-     * @param bodyStream Request body stream (for non-chunked uploads)
-     * @param contentLength Content length (for non-chunked uploads)
-     * @returns Promise resolving to ResponseFile with upload result
-     */
-    handlePost(config: FileInit, isChunkedUpload: boolean, requestUrl: string, bodyStream: unknown, contentLength: number): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle file update or creation (PUT).
-     * @param id File ID from URL
-     * @param config File initialization config (for new files)
-     * @param requestUrl Request URL for Location header
-     * @param bodyStream Request body stream
-     * @param contentLength Content length
-     * @param metadata Optional metadata to merge (for updates)
-     * @returns Promise resolving to ResponseFile with upload result
-     */
-    handlePut(id: string, config: FileInit, requestUrl: string, bodyStream: unknown, contentLength: number, metadata?: Record<string, unknown>): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle chunked upload chunk (PATCH).
-     * @param id File ID from URL
-     * @param chunkOffset Chunk offset in bytes
-     * @param contentLength Chunk content length
-     * @param chunkChecksum Optional chunk checksum
-     * @param requestUrl Request URL for Location header
-     * @param bodyStream Request body stream
-     * @returns Promise resolving to ResponseFile with upload progress
-     */
-    handlePatch(id: string, chunkOffset: number, contentLength: number, chunkChecksum: string | undefined, requestUrl: string, bodyStream: unknown): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle file metadata retrieval (HEAD).
-     * @param id File ID from URL
-     * @returns Promise resolving to ResponseFile with metadata headers
-     */
-    handleHead(id: string): Promise<ResponseFile<TFile>>;
-    /**
-     * Handle OPTIONS request with REST API capabilities.
-     * @param methods Array of supported HTTP methods
-     * @param maxUploadSize Maximum upload size
-     * @returns ResponseFile with CORS headers
-     */
-    handleOptions(methods: string[], maxUploadSize: number): ResponseFile<TFile>;
-    /**
-     * Handle batch file deletion.
-     * @param ids Array of file IDs to delete
-     * @returns Promise resolving to ResponseList with deletion results
-     */
-    deleteBatch(ids: string[]): Promise<ResponseList<TFile>>;
-    /**
-     * Storage instance for file operations.
-     */
-    protected get storage(): {
-        create: (config: FileInit) => Promise<TFile>;
-        delete: (options: {
-            id: string;
-        }) => Promise<TFile>;
-        deleteBatch: (ids: string[]) => Promise<{
-            failed: {
-                error: string;
-                id: string;
-            }[];
-            failedCount: number;
-            successful: TFile[];
-            successfulCount: number;
-        }>;
-        getMeta: (id: string) => Promise<TFile>;
-        maxUploadSize: number;
-        update: (options: {
-            id: string;
-        }, updates: {
-            metadata?: Record<string, unknown>;
-            status?: string;
-        }) => Promise<void>;
-        write: (options: {
-            body: unknown;
-            contentLength: number;
-            id: string;
-            start: number;
-        }) => Promise<TFile>;
-    };
-    /**
-     * Build file URL from request URL and file data.
-     * @param _requestUrl Request URL string
-     * @param _file File object containing ID and content type
-     * @returns Constructed file URL with extension based on content type
-     */
-    protected buildFileUrl(_requestUrl: string, _file: TFile): string;
-}
-export default RestBase;