@visulima/storage 1.0.9 → 1.0.11

package/dist/packem_shared/disk-storage-with-checksum.d-B-VGEsfl.d.ts

@@ -1,156 +0,0 @@
-import { F as File, M as MetaStorage, D as DiskStorageOptions, H as HttpError, d as FileInit, e as FilePart, f as FileQuery, O as OperationOptions, g as FileReturn, i as ERRORS, B as BaseStorage, j as DiskStorageWithChecksumOptions } from "./storage.d-CEM1upWM.js";
-import { Readable } from 'node:stream';
-/**
-* Local disk-based storage implementation.
-* @template TFile The file type used by this storage backend.
-* @remarks
-* ## Error Handling
-* - Filesystem operations throw errors directly (no retry logic)
-* - File not found errors are thrown immediately
-* - Permission errors are propagated as-is
-*
-* ## Retry Behavior
-* - No automatic retries (filesystem operations are typically immediate)
-* - Errors are thrown directly for immediate feedback
-*
-* ## File Paths
-* - Files are stored in the configured directory
-* - Metadata files use the `.META` suffix by default
-* - File paths are resolved relative to the storage directory
-*/
-declare class DiskStorage<TFile extends File = File> extends BaseStorage<TFile> {
-  static override readonly name: string;
-  override checksumTypes: string[];
-  override readonly supportsRange: boolean;
-  override get raw(): {
-    directory: string;
-  };
-  directory: string;
-  meta: MetaStorage<TFile>;
-  constructor(config: DiskStorageOptions<TFile>);
-  /**
-  * Normalizes errors with disk storage context.
-  * @param error The error to normalize.
-  * @returns Normalized HTTP error.
-  */
-  override normalizeError(error: Error): HttpError;
-  /**
-  * Creates a new file upload and saves its metadata.
-  * @param fileInit File initialization configuration.
-  * @returns Promise resolving to the created file object.
-  * @throws {Error} If validation fails or file already exists and is completed.
-  * @remarks
-  * Supports TTL (time-to-live) option in fileInit.
-  * Creates the file on disk if it doesn't exist.
-  * Returns existing file if it's already completed.
-  */
-  create(fileInit: FileInit): Promise<TFile>;
-  /**
-  * Writes data to a file upload.
-  * @param part File part containing data to write, file query, or full file object.
-  * @returns Promise resolving to the updated file object.
-  * @throws {Error} If file is expired (ERRORS.GONE), locked (ERRORS.FILE_LOCKED), or conflicts occur (ERRORS.FILE_CONFLICT).
-  * @remarks
-  * Supports chunked uploads with start position.
-  * Automatically detects file type from stream on first chunk if contentType is not set.
-  * Validates checksum algorithms if provided.
-  * Uses file locking to prevent concurrent writes.
-  * Updates file status to "completed" when all bytes are written.
-  */
-  write(part: FilePart | FileQuery | TFile): Promise<TFile>;
-  /**
-  * Gets an uploaded file by ID.
-  * @param query File query containing the file ID to retrieve.
-  * @param query.id File ID to retrieve.
-  * @returns Promise resolving to the file data including content buffer.
-  * @throws {Error} If the file cannot be found (ERRORS.FILE_NOT_FOUND) or has expired (ERRORS.GONE).
-  * @remarks
-  * Loads the entire file content into memory as a Buffer.
-  * For large files, consider using getStream() instead.
-  * Includes ETag (MD5 hash) for content verification.
-  */
-  get({
-    id
-  }: FileQuery, options?: OperationOptions & {
-    range?: {
-      end?: number;
-      start: number;
-    };
-  }): Promise<FileReturn>;
-  /**
-  * Checks if a file exists by verifying both metadata and the actual filesystem file.
-  * Returns true only if both the metadata and the file exist.
-  * @param query File query containing the file ID to check.
-  * @returns Promise resolving to true if both metadata and file exist, false otherwise.
-  */
-  override exists({
-    id
-  }: FileQuery): Promise<boolean>;
-  /**
-  * Gets an uploaded file as a readable stream for efficient large file handling.
-  * @param query File query containing the file ID to stream.
-  * @param query.id File ID to stream.
-  * @returns Promise resolving to an object containing the stream, headers, and size.
-  * @throws {UploadError} If the file cannot be found (ERRORS.FILE_NOT_FOUND) or has expired (ERRORS.GONE).
-  * @remarks Creates a readable stream directly from the file system for efficient memory usage.
-  */
-  override getStream({
-    id
-  }: FileQuery): Promise<{
-    headers?: Record<string, string>;
-    size?: number;
-    stream: Readable;
-  }>;
-  /**
-  * Deletes an upload and its metadata.
-  * @param query File query containing the file ID to delete.
-  * @param query.id File ID to delete.
-  * @returns Promise resolving to the deleted file object with status: "deleted".
-  * @throws {UploadError} If the file metadata cannot be found.
-  */
-  delete({
-    id
-  }: FileQuery): Promise<TFile>;
-  /**
-  * Copies an upload file to a new location.
-  * @param name Source file name/ID.
-  * @param destination Destination file name/ID.
-  * @returns Promise resolving to the copied file object.
-  * @throws {UploadError} If the source file cannot be found.
-  */
-  copy(name: string, destination: string): Promise<TFile>;
-  /**
-  * Moves an upload file to a new location.
-  * @param name Source file name/ID.
-  * @param destination Destination file name/ID.
-  * @returns Promise resolving to the moved file object.
-  * @throws {Error} If the source file cannot be found.
-  */
-  move(name: string, destination: string): Promise<TFile>;
-  /**
-  * Retrieves a list of uploaded files.
-  * @returns Promise resolving to an array of file metadata objects.
-  * @remarks Walks the storage directory and returns all files, excluding metadata files.
-  */
-  override list(): Promise<TFile[]>;
-  /**
-  * Returns the absolute on-disk path for the uploaded file, always rooted at
-  * `this.directory`. Absolute inputs and `..` traversals are rejected.
-  */
-  protected getFilePath(filename: string): string;
-  protected lazyWrite(part: File & FilePart): Promise<[number, ERRORS?]>;
-  private accessCheck;
-}
-/**
-* Additionally calculates checksum of the file/range.
-*/
-declare class DiskStorageWithChecksum<TFile extends File = File> extends DiskStorage<TFile> {
-  private hashes;
-  constructor(config: DiskStorageWithChecksumOptions<TFile>);
-  override delete({
-    id
-  }: FileQuery): Promise<TFile>;
-  override write(part: FilePart | FileQuery): Promise<TFile>;
-  protected override lazyWrite(part: File & FilePart): Promise<[number, ERRORS?]>;
-}
-export { DiskStorage as D, DiskStorageWithChecksum as a };