@pol-studios/powersync 1.0.4 → 1.0.7

package/dist/CacheSettingsManager-1exbOC6S.d.ts

@@ -0,0 +1,261 @@
+import { FileSystemAdapter, LoggerAdapter, AsyncStorageAdapter } from './platform/index.js';
+import { R as RemoteStorageAdapter, P as PowerSyncStorageAdapter, b as SupabaseStorageAdapterOptions } from './types-Bgvx7-E8.js';
+
+/**
+ * Supabase Storage Adapter for @pol-studios/powersync
+ *
+ * Provides attachment storage operations using Supabase Storage with
+ * platform-agnostic file system operations via PlatformAdapter.
+ *
+ * Key features:
+ * - Memory-efficient downloads using signed URLs + native file system
+ * - Multi-bucket support via BucketConfig/BucketResolver
+ * - Platform-agnostic via FileSystemAdapter interface
+ * - Compatible with PowerSync attachments interface
+ */
+
+/**
+ * Supabase Storage adapter for attachment downloads and local file operations.
+ *
+ * Uses PlatformAdapter's fileSystem for I/O operations to remain platform-agnostic.
+ *
+ * IMPORTANT: This adapter downloads files using signed URLs + platform file system
+ * operations to avoid loading entire files into memory. This prevents OOM crashes
+ * on large files that occurred with the previous blob-based approach.
+ *
+ * @example
+ * ```typescript
+ * const adapter = new SupabaseStorageAdapter(
+ *   {
+ *     client: supabaseClient,
+ *     bucketConfig: {
+ *       defaultBucket: 'attachments',
+ *       bucketMap: new Map([['avatars/', 'user-avatars']]),
+ *     },
+ *   },
+ *   platform.fileSystem
+ * );
+ *
+ * // Download to local path
+ * await adapter.download('photos/image.jpg', '/local/path/image.jpg');
+ *
+ * // Get signed URL for direct access
+ * const url = await adapter.getDownloadUrl('photos/image.jpg');
+ * ```
+ */
+declare class SupabaseStorageAdapter implements RemoteStorageAdapter, PowerSyncStorageAdapter {
+    private client;
+    private bucketConfig;
+    private signedUrlExpiry;
+    private fileSystem?;
+    private logger?;
+    constructor(options: SupabaseStorageAdapterOptions, fileSystem?: FileSystemAdapter);
+    /**
+     * Set the file system adapter (can be set after construction).
+     */
+    setFileSystem(fileSystem: FileSystemAdapter): void;
+    /**
+     * Resolve the storage bucket for a given file path.
+     */
+    resolveBucket(filePath: string): string;
+    /**
+     * Download a file from Supabase Storage to a local path.
+     *
+     * Uses the platform's streaming downloadFile method to avoid loading
+     * the entire file into memory (prevents OOM on large files).
+     */
+    download(remotePath: string, localPath: string): Promise<void>;
+    /**
+     * Get a signed download URL for a remote file.
+     */
+    getDownloadUrl(remotePath: string): Promise<string>;
+    /**
+     * Check if a file exists in remote storage.
+     */
+    exists(remotePath: string): Promise<boolean>;
+    /**
+     * No-op for uploads. Use SupabaseUploadHandler for upload operations.
+     *
+     * Uploads are handled separately by the upload manager pipeline to support
+     * background uploads and proper queue management.
+     */
+    uploadFile(filename: string, _data: ArrayBuffer, _options?: {
+        mediaType?: string;
+    }): Promise<void>;
+    /**
+     * Download a file from Supabase Storage and return as a Blob.
+     *
+     * Uses signed URL + fetch to download the file efficiently.
+     * This method is required by the PowerSync attachments interface.
+     *
+     * Note: This loads the file into memory as a Blob. For very large files,
+     * consider using download() to save directly to disk instead.
+     */
+    downloadFile(filePath: string): Promise<Blob>;
+    /**
+     * Write data to a local file.
+     */
+    writeFile(fileURI: string, data: string, options?: {
+        encoding?: 'utf8' | 'base64';
+    }): Promise<void>;
+    /**
+     * Read data from a local file.
+     */
+    readFile(fileURI: string, options?: {
+        encoding?: 'utf8' | 'base64';
+        mediaType?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Delete a local file.
+     */
+    deleteFile(uri: string, _options?: {
+        filename?: string;
+    }): Promise<void>;
+    /**
+     * Check if a local file exists.
+     */
+    fileExists(fileURI: string): Promise<boolean>;
+    /**
+     * Create a directory.
+     */
+    makeDir(uri: string): Promise<void>;
+    /**
+     * Copy a file.
+     */
+    copyFile(sourceUri: string, targetUri: string): Promise<void>;
+    /**
+     * Get the user storage directory.
+     */
+    getUserStorageDirectory(): string;
+}
+/**
+ * Create a SupabaseStorageAdapter with simplified configuration.
+ *
+ * @example
+ * ```typescript
+ * const adapter = createSupabaseStorageAdapter(
+ *   supabaseClient,
+ *   'attachments',
+ *   platform.fileSystem
+ * );
+ * ```
+ */
+declare function createSupabaseStorageAdapter(client: any, defaultBucket: string, fileSystem?: FileSystemAdapter, options?: {
+    bucketMap?: Map<string, string>;
+    signedUrlExpiry?: number;
+    logger?: LoggerAdapter;
+}): SupabaseStorageAdapter;
+
+/**
+ * Cache Settings Types for @pol-studios/powersync
+ *
+ * Defines types for cache configuration storage.
+ * Note: UI-specific options (labels, descriptions) should be defined in the app.
+ */
+/**
+ * Cache settings stored via AsyncStorageAdapter.
+ */
+interface CacheSettings {
+    /**
+     * Maximum cache size in megabytes.
+     * A value of 0 indicates unlimited cache size.
+     */
+    maxCacheSizeMb: number;
+    /**
+     * Compression quality for cached images (0.0 to 1.0).
+     * Higher values mean better quality but larger file sizes.
+     */
+    compressionQuality: number;
+}
+/**
+ * Options for creating a CacheSettingsManager.
+ */
+interface CacheSettingsManagerOptions {
+    /**
+     * Prefix for storage keys.
+     * Useful for namespacing when multiple apps share storage.
+     * @default '@pol-studios/cache'
+     */
+    storageKeyPrefix?: string;
+    /**
+     * Default values for cache settings.
+     */
+    defaults?: Partial<CacheSettings>;
+}
+/**
+ * Default cache settings values.
+ */
+declare const DEFAULT_CACHE_SETTINGS: CacheSettings;
+
+/**
+ * Cache Settings Manager for @pol-studios/powersync
+ *
+ * Manages persistence of cache settings via AsyncStorageAdapter.
+ * Uses platform-agnostic storage interface for cross-platform support.
+ */
+
+/**
+ * Manages cache settings persistence using AsyncStorageAdapter.
+ *
+ * @example
+ * ```typescript
+ * const manager = new CacheSettingsManager(platform.storage, {
+ *   storageKeyPrefix: '@myapp/cache',
+ *   defaults: { maxCacheSizeMb: 2048 },
+ * });
+ *
+ * const settings = await manager.getSettings();
+ * await manager.setMaxCacheSizeMb(1024);
+ * ```
+ */
+declare class CacheSettingsManager {
+    private storage;
+    private keyPrefix;
+    private defaults;
+    constructor(storage: AsyncStorageAdapter, options?: CacheSettingsManagerOptions);
+    /**
+     * Get the full storage key for a setting.
+     */
+    private getKey;
+    /**
+     * Get all cache settings.
+     */
+    getSettings(): Promise<CacheSettings>;
+    /**
+     * Get the maximum cache size in megabytes.
+     * Returns 0 for unlimited.
+     */
+    getMaxCacheSizeMb(): Promise<number>;
+    /**
+     * Set the maximum cache size in megabytes.
+     * Use 0 for unlimited.
+     *
+     * @param mb - Maximum cache size in megabytes
+     */
+    setMaxCacheSizeMb(mb: number): Promise<void>;
+    /**
+     * Get the maximum cache size in bytes.
+     * Returns Number.MAX_SAFE_INTEGER for unlimited.
+     */
+    getMaxCacheSizeBytes(): Promise<number>;
+    /**
+     * Get the compression quality (0.0 to 1.0).
+     */
+    getCompressionQuality(): Promise<number>;
+    /**
+     * Set the compression quality.
+     *
+     * @param quality - Compression quality (0.0 to 1.0)
+     */
+    setCompressionQuality(quality: number): Promise<void>;
+    /**
+     * Reset all settings to defaults.
+     */
+    resetToDefaults(): Promise<void>;
+    /**
+     * Clear all stored settings.
+     */
+    clear(): Promise<void>;
+}
+
+export { CacheSettingsManager as C, DEFAULT_CACHE_SETTINGS as D, SupabaseStorageAdapter as S, type CacheSettings as a, type CacheSettingsManagerOptions as b, createSupabaseStorageAdapter as c };