@pelatform/storage 1.0.0 → 1.0.2

package/dist/s3.d.cts

@@ -1,108 +0,0 @@
-import { S as StorageInterface, v as S3Config, U as UploadOptions, a as UploadResult, D as DownloadOptions, b as DownloadResult, c as DeleteOptions, d as DeleteResult, B as BatchDeleteOptions, e as BatchDeleteResult, L as ListOptions, f as ListResult, E as ExistsResult, g as CopyOptions, h as CopyResult, M as MoveOptions, i as MoveResult, j as DuplicateOptions, k as DuplicateResult, P as PresignedUrlOptions, l as PresignedUrlResult, m as CreateFolderOptions, n as CreateFolderResult, o as DeleteFolderOptions, p as DeleteFolderResult, q as ListFoldersOptions, r as ListFoldersResult, F as FolderExistsResult, R as RenameFolderOptions, s as RenameFolderResult, t as CopyFolderOptions, u as CopyFolderResult } from './storage-interface-BKeDAlGP.cjs';
-
-/**
- * S3 storage service implementation
- * High-level service wrapper for S3-compatible storage operations with convenience methods
- */
-
-/**
- * S3 storage service
- * High-level service for S3-compatible storage operations with convenience methods
- * @public
- */
-declare class S3Service implements StorageInterface {
-    private provider;
-    private config;
-    constructor();
-    constructor(config: S3Config);
-    private createProvider;
-    getConfig(): S3Config;
-    getBucket(): string;
-    getRegion(): string;
-    getProvider(): string;
-    getPublicUrl(key: string): string;
-    upload(options: UploadOptions): Promise<UploadResult>;
-    download(options: DownloadOptions): Promise<DownloadResult>;
-    delete(options: DeleteOptions): Promise<DeleteResult>;
-    batchDelete(options: BatchDeleteOptions): Promise<BatchDeleteResult>;
-    list(options?: ListOptions): Promise<ListResult>;
-    exists(key: string): Promise<ExistsResult>;
-    copy(options: CopyOptions): Promise<CopyResult>;
-    move(options: MoveOptions): Promise<MoveResult>;
-    duplicate(options: DuplicateOptions): Promise<DuplicateResult>;
-    getPresignedUrl(options: PresignedUrlOptions): Promise<PresignedUrlResult>;
-    createFolder(options: CreateFolderOptions): Promise<CreateFolderResult>;
-    deleteFolder(options: DeleteFolderOptions): Promise<DeleteFolderResult>;
-    listFolders(options?: ListFoldersOptions): Promise<ListFoldersResult>;
-    folderExists(path: string): Promise<FolderExistsResult>;
-    renameFolder(options: RenameFolderOptions): Promise<RenameFolderResult>;
-    copyFolder(options: CopyFolderOptions): Promise<CopyFolderResult>;
-    uploadFile(key: string, file: Buffer | Uint8Array | string, options?: Partial<UploadOptions>): Promise<UploadResult>;
-    downloadFile(key: string): Promise<DownloadResult>;
-    deleteFile(key: string): Promise<DeleteResult>;
-    deleteFiles(keys: string[]): Promise<BatchDeleteResult>;
-    fileExists(key: string): Promise<boolean>;
-    copyFile(sourceKey: string, destinationKey: string, options?: Partial<CopyOptions>): Promise<CopyResult>;
-    moveFile(sourceKey: string, destinationKey: string, options?: Partial<MoveOptions>): Promise<MoveResult>;
-    duplicateFile(sourceKey: string, destinationKey: string, options?: Partial<DuplicateOptions>): Promise<DuplicateResult>;
-    renameFile(sourceKey: string, newKey: string, options?: Partial<MoveOptions>): Promise<MoveResult>;
-    getDownloadUrl(key: string, expiresIn?: number): Promise<PresignedUrlResult>;
-    getUploadUrl(key: string, contentType?: string, expiresIn?: number): Promise<PresignedUrlResult>;
-    createFolderPath(path: string): Promise<CreateFolderResult>;
-    deleteFolderPath(path: string, recursive?: boolean): Promise<DeleteFolderResult>;
-    folderPathExists(path: string): Promise<boolean>;
-    renameFolderPath(oldPath: string, newPath: string): Promise<RenameFolderResult>;
-    copyFolderPath(sourcePath: string, destinationPath: string, recursive?: boolean): Promise<CopyFolderResult>;
-}
-
-/**
- * Create S3 service using environment variables or manual configuration
- * @param config Optional S3 configuration. If not provided, loads from environment variables
- * @returns S3Service instance
- * @throws Error if configuration is invalid or environment variables are missing
- * @public
- *
- * @example
- * ```typescript
- * import { createS3 } from '@pelatform/storage/s3';
- *
- * // Using environment variables
- * // Set: PELATFORM_S3_PROVIDER=aws, PELATFORM_S3_REGION=us-east-1, etc.
- * const s3FromEnv = createS3();
- * await s3FromEnv.uploadFile('test.txt', 'Hello World');
- *
- * // Using manual configuration
- * const s3Manual = createS3({
- *   provider: 'aws',
- *   region: 'us-east-1',
- *   bucket: 'my-bucket',
- *   accessKeyId: 'AKIA...',
- *   secretAccessKey: 'secret...'
- * });
- *
- * // Cloudflare R2
- * const r2 = createS3({
- *   provider: 'cloudflare-r2',
- *   region: 'auto',
- *   bucket: 'my-r2-bucket',
- *   accessKeyId: 'your-r2-key',
- *   secretAccessKey: 'your-r2-secret',
- *   endpoint: 'https://account-id.r2.cloudflarestorage.com'
- * });
- *
- * // MinIO
- * const minio = createS3({
- *   provider: 'minio',
- *   region: 'us-east-1',
- *   bucket: 'my-minio-bucket',
- *   accessKeyId: 'minioadmin',
- *   secretAccessKey: 'minioadmin',
- *   endpoint: 'http://localhost:9000',
- *   forcePathStyle: true
- * });
- * ```
- */
-declare function createS3(): S3Service;
-declare function createS3(config: S3Config): S3Service;
-
-export { S3Service, createS3 };

package/dist/storage-interface-BKeDAlGP.d.cts

@@ -1,316 +0,0 @@
-/**
- * Base storage types and configurations
- * Defines core types for storage providers, configurations, and file information
- */
-/**
- * S3-compatible provider types
- * @public
- */
-type S3ProviderType = 'aws' | 'cloudflare-r2' | 'minio' | 'digitalocean' | 'supabase' | 'custom';
-/**
- * All supported storage provider types
- * @public
- */
-type StorageProvider = S3ProviderType | 'cloudinary';
-/**
- * Union type for all storage configurations
- * @public
- */
-type StorageConfig = S3Config | CloudinaryConfig;
-/**
- * S3-compatible storage configuration
- * @public
- */
-interface S3Config {
-    /** S3-compatible provider type */
-    provider: S3ProviderType;
-    /** AWS region or provider-specific region */
-    region: string;
-    /** Bucket name */
-    bucket: string;
-    /** Access key ID for authentication */
-    accessKeyId: string;
-    /** Secret access key for authentication */
-    secretAccessKey: string;
-    /** Custom endpoint for S3-compatible services (MinIO, R2, etc.) */
-    endpoint?: string;
-    /** Force path style for services like MinIO */
-    forcePathStyle?: boolean;
-    /** Base URL for public access (CDN, custom domain) */
-    publicUrl?: string;
-}
-/**
- * Cloudinary storage configuration
- * @public
- */
-interface CloudinaryConfig {
-    /** Provider type (always 'cloudinary') */
-    provider: 'cloudinary';
-    /** Cloudinary cloud name */
-    cloudName: string;
-    /** Cloudinary API key */
-    apiKey: string;
-    /** Cloudinary API secret */
-    apiSecret: string;
-    /** Use HTTPS for URLs (default: true) */
-    secure?: boolean;
-    /** Default upload folder */
-    folder?: string;
-}
-/**
- * File information structure
- * @public
- */
-interface FileInfo {
-    /** File key/path */
-    key: string;
-    /** File size in bytes */
-    size: number;
-    /** Last modified date */
-    lastModified: Date;
-    /** Entity tag for caching */
-    etag: string;
-    /** MIME content type */
-    contentType?: string;
-    /** Custom metadata */
-    metadata?: Record<string, string>;
-}
-/**
- * Folder information structure
- * @public
- */
-interface FolderInfo {
-    /** Folder name */
-    name: string;
-    /** Full folder path */
-    path: string;
-    /** Total size of all files in folder */
-    size: number;
-    /** Number of files in folder */
-    fileCount: number;
-    /** Last modified date */
-    lastModified: Date;
-}
-
-/**
- * File operation types and interfaces
- * Defines types for file upload, download, delete, copy, move, and other file operations
- */
-
-interface UploadOptions {
-    key: string;
-    file: Buffer | Uint8Array | string;
-    contentType?: string;
-    metadata?: Record<string, string>;
-    cacheControl?: string;
-    contentDisposition?: string;
-    acl?: 'private' | 'public-read' | 'public-read-write';
-    expires?: Date;
-}
-interface UploadResult {
-    success: boolean;
-    key?: string;
-    url?: string;
-    publicUrl?: string;
-    etag?: string;
-    size?: number;
-    error?: string;
-}
-interface DownloadOptions {
-    key: string;
-    range?: string;
-}
-interface DownloadResult {
-    success: boolean;
-    content?: Buffer;
-    data?: Buffer;
-    contentType?: string;
-    contentLength?: number;
-    lastModified?: Date;
-    etag?: string;
-    metadata?: Record<string, string>;
-    error?: string;
-}
-interface DeleteOptions {
-    key: string;
-}
-interface DeleteResult {
-    success: boolean;
-    error?: string;
-}
-interface BatchDeleteOptions {
-    keys: string[];
-}
-interface BatchDeleteResult {
-    success: boolean;
-    deleted?: string[];
-    errors?: Array<{
-        key: string;
-        error: string;
-    }>;
-}
-interface CopyOptions {
-    sourceKey: string;
-    destinationKey: string;
-    metadata?: Record<string, string>;
-    metadataDirective?: 'COPY' | 'REPLACE';
-}
-interface CopyResult {
-    success: boolean;
-    etag?: string;
-    error?: string;
-}
-interface MoveOptions {
-    sourceKey: string;
-    destinationKey: string;
-    metadata?: Record<string, string>;
-    metadataDirective?: 'COPY' | 'REPLACE';
-}
-interface MoveResult {
-    success: boolean;
-    etag?: string;
-    error?: string;
-}
-type DuplicateOptions = CopyOptions;
-type DuplicateResult = CopyResult;
-interface ExistsResult {
-    exists: boolean;
-    fileInfo?: FileInfo;
-    error?: string;
-}
-interface ListOptions {
-    prefix?: string;
-    delimiter?: string;
-    maxKeys?: number;
-    continuationToken?: string;
-}
-interface ListResult {
-    success: boolean;
-    files?: FileInfo[];
-    isTruncated?: boolean;
-    nextContinuationToken?: string;
-    commonPrefixes?: string[];
-    error?: string;
-}
-interface PresignedUrlOptions {
-    key: string;
-    operation: 'get' | 'put';
-    expiresIn?: number;
-    contentType?: string;
-}
-interface PresignedUrlResult {
-    success: boolean;
-    url?: string;
-    expiresAt?: Date;
-    error?: string;
-}
-
-/**
- * Folder operation types and interfaces
- * Defines types for folder creation, deletion, listing, and other folder operations
- */
-
-interface CreateFolderOptions {
-    path: string;
-}
-interface CreateFolderResult {
-    success: boolean;
-    path?: string;
-    error?: string;
-}
-interface DeleteFolderOptions {
-    path: string;
-    recursive?: boolean;
-}
-interface DeleteFolderResult {
-    success: boolean;
-    deletedFiles?: string[];
-    error?: string;
-}
-interface ListFoldersOptions {
-    prefix?: string;
-    delimiter?: string;
-    maxKeys?: number;
-    continuationToken?: string;
-}
-interface ListFoldersResult {
-    success: boolean;
-    folders?: FolderInfo[];
-    files?: FileInfo[];
-    isTruncated?: boolean;
-    nextContinuationToken?: string;
-    error?: string;
-}
-interface FolderExistsResult {
-    exists: boolean;
-    folderInfo?: FolderInfo;
-    error?: string;
-}
-interface RenameFolderOptions {
-    oldPath: string;
-    newPath: string;
-}
-interface RenameFolderResult {
-    success: boolean;
-    movedFiles?: string[];
-    error?: string;
-}
-interface CopyFolderOptions {
-    sourcePath: string;
-    destinationPath: string;
-    recursive?: boolean;
-}
-interface CopyFolderResult {
-    success: boolean;
-    copiedFiles?: string[];
-    error?: string;
-}
-
-/**
- * Storage interface definition
- * Defines the unified interface that all storage providers must implement
- */
-
-/**
- * Main storage interface that all providers must implement
- * Provides unified API for file and folder operations across different storage providers
- * @public
- */
-interface StorageInterface {
-    /** Upload a file to storage */
-    upload(options: UploadOptions): Promise<UploadResult>;
-    /** Download a file from storage */
-    download(options: DownloadOptions): Promise<DownloadResult>;
-    /** Delete a single file from storage */
-    delete(options: DeleteOptions): Promise<DeleteResult>;
-    /** Delete multiple files from storage */
-    batchDelete(options: BatchDeleteOptions): Promise<BatchDeleteResult>;
-    /** List files in storage */
-    list(options?: ListOptions): Promise<ListResult>;
-    /** Check if a file exists in storage */
-    exists(key: string): Promise<ExistsResult>;
-    /** Copy a file within storage */
-    copy(options: CopyOptions): Promise<CopyResult>;
-    /** Move a file within storage */
-    move(options: MoveOptions): Promise<MoveResult>;
-    /** Duplicate a file within storage */
-    duplicate(options: DuplicateOptions): Promise<DuplicateResult>;
-    /** Generate a presigned URL for file access */
-    getPresignedUrl(options: PresignedUrlOptions): Promise<PresignedUrlResult>;
-    /** Get public URL for a file */
-    getPublicUrl(key: string): string;
-    /** Create a folder in storage */
-    createFolder(options: CreateFolderOptions): Promise<CreateFolderResult>;
-    /** Delete a folder from storage */
-    deleteFolder(options: DeleteFolderOptions): Promise<DeleteFolderResult>;
-    /** List folders in storage */
-    listFolders(options?: ListFoldersOptions): Promise<ListFoldersResult>;
-    /** Check if a folder exists in storage */
-    folderExists(path: string): Promise<FolderExistsResult>;
-    /** Rename a folder in storage */
-    renameFolder(options: RenameFolderOptions): Promise<RenameFolderResult>;
-    /** Copy a folder within storage */
-    copyFolder(options: CopyFolderOptions): Promise<CopyFolderResult>;
-}
-
-export type { FolderInfo as A, BatchDeleteOptions as B, CloudinaryConfig as C, DownloadOptions as D, ExistsResult as E, FolderExistsResult as F, ListOptions as L, MoveOptions as M, PresignedUrlOptions as P, RenameFolderOptions as R, StorageInterface as S, UploadOptions as U, UploadResult as a, DownloadResult as b, DeleteOptions as c, DeleteResult as d, BatchDeleteResult as e, ListResult as f, CopyOptions as g, CopyResult as h, MoveResult as i, DuplicateOptions as j, DuplicateResult as k, PresignedUrlResult as l, CreateFolderOptions as m, CreateFolderResult as n, DeleteFolderOptions as o, DeleteFolderResult as p, ListFoldersOptions as q, ListFoldersResult as r, RenameFolderResult as s, CopyFolderOptions as t, CopyFolderResult as u, S3Config as v, StorageConfig as w, S3ProviderType as x, StorageProvider as y, FileInfo as z };