@pelatform/storage 1.0.0

package/dist/s3.d.cts

@@ -0,0 +1,108 @@
+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/s3.d.ts

@@ -0,0 +1,108 @@
+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.js';
+
+/**
+ * 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 };