dexie-cloud-addon 4.3.9 → 4.4.1

package/dist/modern/DexieCloudAPI.d.ts

@@ -9,6 +9,15 @@ import { PermissionChecker } from './PermissionChecker';
 import { DexieCloudSyncOptions } from "./DexieCloudSyncOptions";
 import { Invite } from './Invite';
 import { BehaviorSubject, Observable } from 'rxjs';
+/** Progress state for blob downloads */
+export interface BlobProgress {
+    /** Whether blob downloads are currently in progress */
+    isDownloading: boolean;
+    /** Number of blobs remaining to download */
+    blobsRemaining: number;
+    /** Total bytes remaining to download (estimated from BlobRef.$size) */
+    bytesRemaining: number;
+}
 /** The API of db.cloud, where `db` is an instance of Dexie with dexie-cloud-addon active.
  */
 export interface LoginHints {
@@ -33,6 +42,14 @@ export interface DexieCloudAPI {
     webSocketStatus: BehaviorSubject<DXCWebSocketStatus>;
     syncState: BehaviorSubject<SyncState>;
     persistedSyncState: BehaviorSubject<PersistedSyncState | undefined>;
+    /** Observable of blob download progress.
+     *
+     * Shows the current state of background blob downloads (when blobMode='eager')
+     * or provides insight into unresolved blobs (when blobMode='lazy').
+     *
+     * Use this to show progress indicators or "downloading for offline" status.
+     */
+    blobProgress: Observable<BlobProgress>;
     events: {
         syncComplete: Observable<void>;
     };

package/dist/modern/DexieCloudOptions.d.ts

@@ -41,4 +41,23 @@ export interface DexieCloudOptions {
      * ```
      */
     oauthRedirectUri?: string;
+    /** How to handle blob downloads from cloud storage.
+     *
+     * - 'eager' (default): Download blobs in background immediately after sync.
+     *   Best for offline-first apps that need all data available offline ASAP.
+     *
+     * - 'lazy': Download blobs on-demand when accessed.
+     *   Best for apps with large media that may not all be needed offline.
+     */
+    blobMode?: 'eager' | 'lazy';
+    /** Maximum string length (in characters) before offloading to blob storage during sync.
+     *
+     * Strings longer than this threshold are uploaded as blobs during sync,
+     * reducing sync payload size. The original string is kept intact in IndexedDB.
+     *
+     * Set to `Infinity` to disable string offloading.
+     *
+     * @default 32768
+     */
+    maxStringLength?: number;
 }

package/dist/modern/TSON.d.ts

@@ -9,9 +9,3 @@ export declare const TSON: {
     stringify(value: any, alternateChannel?: any, space?: number): string;
     parse(tson: string, alternateChannel?: any): any;
 };
-export declare const BISON: {
-    toBinary(value: any): Blob;
-    stringify(value: any): [Blob, string];
-    parse<T = any>(json: string, binData: Blob): Promise<T>;
-    fromBinary<T_1 = any>(blob: Blob): Promise<T_1>;
-};

package/dist/modern/db/DexieCloudDB.d.ts

@@ -10,6 +10,7 @@ import { BroadcastedAndLocalEvent } from '../helpers/BroadcastedAndLocalEvent';
 import { SyncStatePhase } from '../types/SyncState';
 import { MessagesFromServerConsumer } from '../sync/messagesFromServerQueue';
 import { YClientMessage } from 'dexie-cloud-common';
+import { BlobDownloadTracker } from '../sync/BlobDownloadTracker';
 export interface SyncStateChangedEventData {
     phase: SyncStatePhase;
     error?: Error;
@@ -47,6 +48,7 @@ export interface DexieCloudDB extends DexieCloudDBBase {
     reconfigure(): void;
     messageConsumer: MessagesFromServerConsumer;
     messageProducer: Subject<YClientMessage>;
+    blobDownloadTracker: BlobDownloadTracker;
 }
 export declare const DEXIE_CLOUD_SCHEMA: {
     members: string;

package/dist/modern/db/entities/EntityCommon.d.ts

@@ -2,4 +2,5 @@ export interface EntityCommon {
     realmId?: string;
     owner?: string;
     $ts?: string;
+    _hasBlobRefs?: 1;
 }