img-upload-kit 0.0.0-stage → 2.0.0

package/dist/storage.d.cts

@@ -0,0 +1,163 @@
+import { S as StorageAdapter, a as StorageListOptions, b as StoragePaginatedListResult } from './types-BrP-o9nd.cjs';
+export { c as StorageFileEntry, d as StorageFileMetadata, e as StorageListResult, f as StorageUploadOptions, g as StorageUploadParams, h as StorageUploadResult, U as UploadRecordHook, i as createStorageAdapter, t as toPaginatedListResult, v as validateStorageMetadata } from './types-BrP-o9nd.cjs';
+export { M as MemoryStorageAdapter, a as MemoryStorageOptions, S as StoredMemoryObject, c as createMemoryStorageAdapter } from './memoryAdapter-Ck0ccZbF.cjs';
+import './upload-C5Trd6Dh.cjs';
+
+interface LocalFsStorageOptions {
+    /** Absolute or relative root directory on disk (e.g. `./public/uploads`) */
+    rootDir: string;
+    /** Public URL prefix matching `rootDir` (e.g. `/uploads` or `https://cdn.example.com/uploads`) */
+    baseUrl?: string;
+    /** Include the bucket segment as a subdirectory under `rootDir`. Defaults to `true`. */
+    includeBucketInPath?: boolean;
+}
+interface LocalFsStorageAdapter extends StorageAdapter {
+    exists(bucket: string, relativePath: string): Promise<boolean>;
+    getPublicUrl(bucket: string, relativePath: string): string;
+    list(bucket: string, folder?: string, options?: StorageListOptions): Promise<StoragePaginatedListResult>;
+    deleteByUrl(url: string): Promise<boolean>;
+    parseUrl(url: string): {
+        bucket?: string;
+        path: string;
+    } | null;
+}
+declare function createLocalFsStorageAdapter(options: LocalFsStorageOptions): LocalFsStorageAdapter;
+
+interface S3PutObjectInput {
+    Bucket: string;
+    Key: string;
+    Body: Buffer | Uint8Array;
+    ContentType: string;
+    CacheControl?: string;
+    Metadata?: Record<string, string>;
+    IfNoneMatch?: string;
+}
+interface S3DeleteObjectInput {
+    Bucket: string;
+    Key: string;
+}
+interface S3HeadObjectInput {
+    Bucket: string;
+    Key: string;
+}
+interface S3ListObjectsInput {
+    Bucket: string;
+    Prefix?: string;
+    MaxKeys?: number;
+    ContinuationToken?: string;
+}
+interface S3ListedObject {
+    Key?: string;
+    Size?: number;
+    LastModified?: Date | string;
+}
+interface S3ListObjectsOutput {
+    Contents?: S3ListedObject[];
+    NextContinuationToken?: string;
+    IsTruncated?: boolean;
+}
+/** Structural S3 / Cloudflare R2 / MinIO transport with zero runtime SDK dependency. */
+interface S3TransportLike {
+    putObject(input: S3PutObjectInput): Promise<unknown>;
+    deleteObject(input: S3DeleteObjectInput): Promise<unknown>;
+    headObject?(input: S3HeadObjectInput): Promise<unknown>;
+    listObjects?(input: S3ListObjectsInput): Promise<S3ListObjectsOutput>;
+    listObjectsV2?(input: S3ListObjectsInput): Promise<S3ListObjectsOutput>;
+}
+type S3PublicUrlBuilder = (bucket: string, path: string) => string;
+interface S3StorageBaseOptions {
+    /** Public base URL prefix (e.g. `'https://cdn.example.com'`) or `(bucket, path) => string` builder. */
+    publicBaseUrl: string | S3PublicUrlBuilder;
+    /** Default `Cache-Control` header applied when `StorageUploadParams.cacheControl` is omitted. */
+    cacheControl?: string;
+    /** Include `bucket` segment in string-prefix URLs (`${publicBaseUrl}/${bucket}/${path}`). Defaults to `true`. */
+    includeBucketInUrl?: boolean;
+    /** Fallback bucket used by `deleteByUrl` when `includeBucketInUrl` is `false`. */
+    defaultBucket?: string;
+}
+type S3StorageAdapterOptions = S3StorageBaseOptions & ((S3TransportLike & {
+    client?: never;
+    transport?: never;
+}) | {
+    client: S3TransportLike;
+    transport?: never;
+    putObject?: never;
+} | {
+    transport: S3TransportLike;
+    client?: never;
+    putObject?: never;
+});
+/** Zero-dependency S3 / Cloudflare R2 / MinIO `StorageAdapter`. */
+declare function createS3StorageAdapter(options: S3StorageAdapterOptions): StorageAdapter;
+
+/**
+ * Minimal structural interface matching `@supabase/supabase-js` Storage client,
+ * avoiding a mandatory `@supabase/supabase-js` runtime dependency.
+ */
+interface SupabaseBucketClientLike {
+    upload(path: string, fileBody: Buffer | Uint8Array, fileOptions?: {
+        contentType?: string;
+        upsert?: boolean;
+        cacheControl?: string;
+        metadata?: Record<string, string>;
+    }): Promise<{
+        data: {
+            path: string;
+        } | null;
+        error: {
+            message: string;
+        } | null;
+    }>;
+    remove(paths: string[]): Promise<{
+        data?: unknown;
+        error: {
+            message: string;
+        } | null;
+    }>;
+    getPublicUrl(path: string): {
+        data: {
+            publicUrl: string;
+        };
+    };
+    list?(path?: string, options?: {
+        limit?: number;
+        offset?: number;
+        sortBy?: {
+            column: string;
+            order: string;
+        };
+    }): Promise<{
+        data: Array<{
+            name: string;
+            id: string | null;
+            created_at: string | null;
+        }> | null;
+        error: {
+            message: string;
+        } | null;
+    }>;
+}
+interface SupabaseStorageClientLike {
+    storage: {
+        from(bucket: string): SupabaseBucketClientLike;
+    };
+}
+interface SupabaseStorageAdapterOptions {
+    publicUrlPrefix?: string;
+}
+/**
+ * Plug in any `@supabase/supabase-js` client instance (e.g., service-role client)
+ * as a `StorageAdapter` with zero extra wrapper boilerplate.
+ */
+declare function createSupabaseStorageAdapter(client: SupabaseStorageClientLike, options?: SupabaseStorageAdapterOptions): StorageAdapter;
+
+interface PublicStorageInfo {
+    bucket: string;
+    path: string;
+    filename: string;
+    extension: string | null;
+}
+declare const DEFAULT_PUBLIC_STORAGE_PREFIX = "/storage/v1/object/public/";
+declare function parsePublicStorageUrl(url?: string | null, publicPrefix?: string): PublicStorageInfo | null;
+
+export { DEFAULT_PUBLIC_STORAGE_PREFIX, type LocalFsStorageAdapter, type LocalFsStorageOptions, type PublicStorageInfo, type S3DeleteObjectInput, type S3HeadObjectInput, type S3ListObjectsInput, type S3ListObjectsOutput, type S3ListedObject, type S3PublicUrlBuilder, type S3PutObjectInput, type S3StorageAdapterOptions, type S3StorageBaseOptions, type S3TransportLike, StorageAdapter, StorageListOptions, StoragePaginatedListResult, type SupabaseBucketClientLike, type SupabaseStorageAdapterOptions, type SupabaseStorageClientLike, createLocalFsStorageAdapter, createS3StorageAdapter, createSupabaseStorageAdapter, parsePublicStorageUrl };

package/dist/storage.d.ts

@@ -0,0 +1,163 @@
+import { S as StorageAdapter, a as StorageListOptions, b as StoragePaginatedListResult } from './types-sZ3KoFQY.js';
+export { c as StorageFileEntry, d as StorageFileMetadata, e as StorageListResult, f as StorageUploadOptions, g as StorageUploadParams, h as StorageUploadResult, U as UploadRecordHook, i as createStorageAdapter, t as toPaginatedListResult, v as validateStorageMetadata } from './types-sZ3KoFQY.js';
+export { M as MemoryStorageAdapter, a as MemoryStorageOptions, S as StoredMemoryObject, c as createMemoryStorageAdapter } from './memoryAdapter-DxEKaG0b.js';
+import './upload-C5Trd6Dh.js';
+
+interface LocalFsStorageOptions {
+    /** Absolute or relative root directory on disk (e.g. `./public/uploads`) */
+    rootDir: string;
+    /** Public URL prefix matching `rootDir` (e.g. `/uploads` or `https://cdn.example.com/uploads`) */
+    baseUrl?: string;
+    /** Include the bucket segment as a subdirectory under `rootDir`. Defaults to `true`. */
+    includeBucketInPath?: boolean;
+}
+interface LocalFsStorageAdapter extends StorageAdapter {
+    exists(bucket: string, relativePath: string): Promise<boolean>;
+    getPublicUrl(bucket: string, relativePath: string): string;
+    list(bucket: string, folder?: string, options?: StorageListOptions): Promise<StoragePaginatedListResult>;
+    deleteByUrl(url: string): Promise<boolean>;
+    parseUrl(url: string): {
+        bucket?: string;
+        path: string;
+    } | null;
+}
+declare function createLocalFsStorageAdapter(options: LocalFsStorageOptions): LocalFsStorageAdapter;
+
+interface S3PutObjectInput {
+    Bucket: string;
+    Key: string;
+    Body: Buffer | Uint8Array;
+    ContentType: string;
+    CacheControl?: string;
+    Metadata?: Record<string, string>;
+    IfNoneMatch?: string;
+}
+interface S3DeleteObjectInput {
+    Bucket: string;
+    Key: string;
+}
+interface S3HeadObjectInput {
+    Bucket: string;
+    Key: string;
+}
+interface S3ListObjectsInput {
+    Bucket: string;
+    Prefix?: string;
+    MaxKeys?: number;
+    ContinuationToken?: string;
+}
+interface S3ListedObject {
+    Key?: string;
+    Size?: number;
+    LastModified?: Date | string;
+}
+interface S3ListObjectsOutput {
+    Contents?: S3ListedObject[];
+    NextContinuationToken?: string;
+    IsTruncated?: boolean;
+}
+/** Structural S3 / Cloudflare R2 / MinIO transport with zero runtime SDK dependency. */
+interface S3TransportLike {
+    putObject(input: S3PutObjectInput): Promise<unknown>;
+    deleteObject(input: S3DeleteObjectInput): Promise<unknown>;
+    headObject?(input: S3HeadObjectInput): Promise<unknown>;
+    listObjects?(input: S3ListObjectsInput): Promise<S3ListObjectsOutput>;
+    listObjectsV2?(input: S3ListObjectsInput): Promise<S3ListObjectsOutput>;
+}
+type S3PublicUrlBuilder = (bucket: string, path: string) => string;
+interface S3StorageBaseOptions {
+    /** Public base URL prefix (e.g. `'https://cdn.example.com'`) or `(bucket, path) => string` builder. */
+    publicBaseUrl: string | S3PublicUrlBuilder;
+    /** Default `Cache-Control` header applied when `StorageUploadParams.cacheControl` is omitted. */
+    cacheControl?: string;
+    /** Include `bucket` segment in string-prefix URLs (`${publicBaseUrl}/${bucket}/${path}`). Defaults to `true`. */
+    includeBucketInUrl?: boolean;
+    /** Fallback bucket used by `deleteByUrl` when `includeBucketInUrl` is `false`. */
+    defaultBucket?: string;
+}
+type S3StorageAdapterOptions = S3StorageBaseOptions & ((S3TransportLike & {
+    client?: never;
+    transport?: never;
+}) | {
+    client: S3TransportLike;
+    transport?: never;
+    putObject?: never;
+} | {
+    transport: S3TransportLike;
+    client?: never;
+    putObject?: never;
+});
+/** Zero-dependency S3 / Cloudflare R2 / MinIO `StorageAdapter`. */
+declare function createS3StorageAdapter(options: S3StorageAdapterOptions): StorageAdapter;
+
+/**
+ * Minimal structural interface matching `@supabase/supabase-js` Storage client,
+ * avoiding a mandatory `@supabase/supabase-js` runtime dependency.
+ */
+interface SupabaseBucketClientLike {
+    upload(path: string, fileBody: Buffer | Uint8Array, fileOptions?: {
+        contentType?: string;
+        upsert?: boolean;
+        cacheControl?: string;
+        metadata?: Record<string, string>;
+    }): Promise<{
+        data: {
+            path: string;
+        } | null;
+        error: {
+            message: string;
+        } | null;
+    }>;
+    remove(paths: string[]): Promise<{
+        data?: unknown;
+        error: {
+            message: string;
+        } | null;
+    }>;
+    getPublicUrl(path: string): {
+        data: {
+            publicUrl: string;
+        };
+    };
+    list?(path?: string, options?: {
+        limit?: number;
+        offset?: number;
+        sortBy?: {
+            column: string;
+            order: string;
+        };
+    }): Promise<{
+        data: Array<{
+            name: string;
+            id: string | null;
+            created_at: string | null;
+        }> | null;
+        error: {
+            message: string;
+        } | null;
+    }>;
+}
+interface SupabaseStorageClientLike {
+    storage: {
+        from(bucket: string): SupabaseBucketClientLike;
+    };
+}
+interface SupabaseStorageAdapterOptions {
+    publicUrlPrefix?: string;
+}
+/**
+ * Plug in any `@supabase/supabase-js` client instance (e.g., service-role client)
+ * as a `StorageAdapter` with zero extra wrapper boilerplate.
+ */
+declare function createSupabaseStorageAdapter(client: SupabaseStorageClientLike, options?: SupabaseStorageAdapterOptions): StorageAdapter;
+
+interface PublicStorageInfo {
+    bucket: string;
+    path: string;
+    filename: string;
+    extension: string | null;
+}
+declare const DEFAULT_PUBLIC_STORAGE_PREFIX = "/storage/v1/object/public/";
+declare function parsePublicStorageUrl(url?: string | null, publicPrefix?: string): PublicStorageInfo | null;
+
+export { DEFAULT_PUBLIC_STORAGE_PREFIX, type LocalFsStorageAdapter, type LocalFsStorageOptions, type PublicStorageInfo, type S3DeleteObjectInput, type S3HeadObjectInput, type S3ListObjectsInput, type S3ListObjectsOutput, type S3ListedObject, type S3PublicUrlBuilder, type S3PutObjectInput, type S3StorageAdapterOptions, type S3StorageBaseOptions, type S3TransportLike, StorageAdapter, StorageListOptions, StoragePaginatedListResult, type SupabaseBucketClientLike, type SupabaseStorageAdapterOptions, type SupabaseStorageClientLike, createLocalFsStorageAdapter, createS3StorageAdapter, createSupabaseStorageAdapter, parsePublicStorageUrl };