@visulima/storage 1.0.0-alpha.14 → 1.0.0-alpha.16

package/dist/packem_shared/s3-base-storage.d-CczjSe98.d.ts

@@ -0,0 +1,251 @@
+import { Readable } from 'node:stream';
+import { F as File, M as MetaStorage, c as createRetryWrapper, b as FileInit, B as BaseStorage, R as RetryConfig, d as FilePart, e as FileQuery, a as FileReturn } from "./storage.d-BOMUJD96.js";
+/**
+* Part interface for multipart uploads.
+*/
+interface Part {
+  ETag?: string;
+  PartNumber: number;
+  Size?: number;
+}
+/**
+* Base file type for S3-compatible storage.
+*/
+interface S3CompatibleFile extends File {
+  Parts?: Part[];
+  partSize?: number;
+  partsUrls?: string[];
+  UploadId?: string;
+  uri?: string;
+}
+/**
+* S3 API operations interface that must be implemented by concrete storage classes.
+*/
+interface S3ApiOperations {
+  abortMultipartUpload: (params: {
+    Bucket: string;
+    Key: string;
+    UploadId: string;
+  }) => Promise<void>;
+  checkBucketAccess: (params: {
+    Bucket: string;
+  }) => Promise<void>;
+  completeMultipartUpload: (params: {
+    Bucket: string;
+    Key: string;
+    Parts: {
+      ETag: string;
+      PartNumber: number;
+    }[];
+    UploadId: string;
+  }) => Promise<{
+    ETag?: string;
+    Location: string;
+  }>;
+  copyObject: (params: {
+    Bucket: string;
+    CopySource: string;
+    Key: string;
+    StorageClass?: string;
+  }) => Promise<void>;
+  createMultipartUpload: (params: {
+    ACL?: string;
+    Bucket: string;
+    ContentType?: string;
+    Key: string;
+    Metadata?: Record<string, string>;
+  }) => Promise<{
+    UploadId: string;
+  }>;
+  deleteObject: (params: {
+    Bucket: string;
+    Key: string;
+  }) => Promise<void>;
+  getObject: (params: {
+    Bucket: string;
+    Key: string;
+  }) => Promise<{
+    Body?: ReadableStream | Readable;
+    ContentLength?: number;
+    ContentType?: string;
+    ETag?: string;
+    Expires?: Date;
+    LastModified?: Date;
+    Metadata?: Record<string, string>;
+  }>;
+  getPresignedUrl: (params: {
+    Bucket: string;
+    expiresIn: number;
+    Key: string;
+    PartNumber: number;
+    UploadId: string;
+  }) => Promise<string>;
+  headObject: (params: {
+    Bucket: string;
+    Key: string;
+  }) => Promise<{
+    ContentLength?: number;
+    ContentType?: string;
+    ETag?: string;
+    Expires?: Date;
+    LastModified?: Date;
+    Metadata?: Record<string, string>;
+  }>;
+  listObjectsV2: (params: {
+    Bucket: string;
+    ContinuationToken?: string;
+    MaxKeys?: number;
+  }) => Promise<{
+    Contents?: {
+      Key?: string;
+      LastModified?: Date;
+    }[];
+    IsTruncated?: boolean;
+    NextContinuationToken?: string;
+  }>;
+  listParts: (params: {
+    Bucket: string;
+    Key: string;
+    UploadId: string;
+  }) => Promise<{
+    Parts?: Part[];
+  }>;
+  uploadPart: (params: {
+    Body: Readable | ReadableStream | Uint8Array;
+    Bucket: string;
+    ContentLength?: number;
+    ContentMD5?: string;
+    Key: string;
+    PartNumber: number;
+    UploadId: string;
+  }) => Promise<{
+    ETag: string;
+  }>;
+}
+/**
+* Base class for S3-compatible storage implementations.
+* Contains all shared business logic for S3 operations.
+* @template TFile The file type used by this storage backend.
+*/
+declare abstract class S3BaseStorage<TFile extends S3CompatibleFile = S3CompatibleFile> extends BaseStorage<TFile> {
+  override checksumTypes: string[];
+  protected bucket: string;
+  protected meta: MetaStorage<TFile>;
+  /**
+  * S3 multipart upload does not allow more than 10000 parts.
+  */
+  protected readonly MAX_PARTS = 1e4;
+  protected readonly partSize: number;
+  protected readonly retry: ReturnType<typeof createRetryWrapper>;
+  /**
+  * Abstract method to get S3 API operations implementation.
+  */
+  protected abstract getS3Api(): S3ApiOperations;
+  /**
+  * Abstract method to get the file class constructor.
+  */
+  protected abstract getFileClass(): new (config: FileInit) => TFile;
+  /**
+  * Abstract method to get ACL value.
+  */
+  protected abstract getAcl(): string | undefined;
+  /**
+  * Abstract method for access check.
+  */
+  protected abstract accessCheck(maxWaitTime?: number): Promise<void>;
+  constructor(config: {
+    bucket: string;
+    clientDirectUpload?: boolean;
+    expiration?: {
+      maxAge?: string;
+    };
+    filename?: (file: TFile) => string;
+    logger?: BaseStorage<TFile>["logger"];
+    metaStorage?: MetaStorage<TFile>;
+    metaStorageConfig?: unknown;
+    partSize?: number | string;
+    retryConfig?: RetryConfig;
+  });
+  /**
+  * Creates a new S3 multipart upload.
+  */
+  create(config: FileInit): Promise<TFile>;
+  /**
+  * Writes data to an S3 multipart upload.
+  */
+  write(part: FilePart | FileQuery | TFile): Promise<TFile>;
+  /**
+  * Deletes an upload and its metadata.
+  */
+  delete({
+    id
+  }: FileQuery): Promise<TFile>;
+  /**
+  * Copies an upload file to a new location.
+  */
+  copy(name: string, destination: string, options?: {
+    storageClass?: string;
+  }): Promise<TFile>;
+  /**
+  * Moves an upload file to a new location.
+  */
+  move(name: string, destination: string): Promise<TFile>;
+  /**
+  * Lists files in the bucket.
+  */
+  override list(limit?: number): Promise<TFile[]>;
+  /**
+  * Checks if a file exists by verifying both metadata and the actual S3 object.
+  * Returns true only if both the metadata and the S3 object exist.
+  * @param query File query containing the file ID to check.
+  * @returns Promise resolving to true if both metadata and S3 object exist, false otherwise.
+  */
+  override exists({
+    id
+  }: FileQuery): Promise<boolean>;
+  /**
+  * Gets an uploaded file by ID.
+  */
+  get({
+    id
+  }: FileQuery): Promise<FileReturn>;
+  /**
+  * Gets file stream (abstract - must be implemented by subclasses due to stream differences).
+  */
+  abstract override getStream(query: FileQuery): Promise<{
+    headers?: Record<string, string>;
+    size?: number;
+    stream: Readable;
+  }>;
+  /**
+  * Builds presigned URLs for client uploads.
+  */
+  protected buildPresigned(file: TFile): Promise<TFile>;
+  /**
+  * Gets presigned URLs for all parts.
+  */
+  protected getPartsPresignedUrls(file: TFile): Promise<string[]>;
+  /**
+  * Gets parts for a multipart upload.
+  */
+  protected getParts(file: TFile): Promise<Part[]>;
+  /**
+  * Completes a multipart upload.
+  */
+  protected completeMultipartUpload(file: TFile): Promise<{
+    ETag?: string;
+    Location: string;
+  }>;
+  /**
+  * Aborts a multipart upload.
+  */
+  protected abortMultipartUpload(file: TFile): Promise<void>;
+  /**
+  * Internal onComplete handler.
+  */
+  protected internalOnComplete: (file: TFile) => Promise<[{
+    ETag?: string;
+    Location: string;
+  }, TFile]>;
+}
+export { Part as P, S3ApiOperations as S, S3BaseStorage as a };