@fatagnus/dink-sync 1.0.0

package/dist/client/synced-offline-edge-types.d.ts

@@ -0,0 +1,540 @@
+/**
+ * Type definitions for SyncedOfflineEdge.
+ *
+ * SyncedOfflineEdge is a high-level API that combines offline-first persistence
+ * with configurable sync modes and lifecycle hooks.
+ *
+ * @module synced-offline-edge-types
+ */
+import type { PersistenceProvider } from '../persistence/types.js';
+import type { OfflineEdgeConfig, OfflineEdgeClient, SyncError, SyncedDocument, SyncMetadata, SyncRejectedEvent, Signal, Unsubscribe, InsertOptions, UpdateOptions, QueryOptions } from './types.js';
+import type { ConnectionState, SyncEngine } from './sync-engine.js';
+/**
+ * Sync mode for a collection.
+ *
+ * - 'auto': Changes are synced automatically in the background (default)
+ * - 'manual': Changes are queued but only synced when explicitly triggered
+ * - 'disabled': No syncing - local changes stay local
+ */
+export type SyncMode = 'auto' | 'manual' | 'disabled';
+/**
+ * Map of collection names to their sync modes.
+ * Used for per-collection sync configuration.
+ *
+ * @example
+ * ```typescript
+ * const syncConfig: SyncConfigMap = {
+ *   tasks: 'auto',      // Sync automatically
+ *   drafts: 'manual',   // Only sync when triggered
+ *   localCache: 'disabled', // Never sync
+ * };
+ * ```
+ */
+export type SyncConfigMap = Record<string, SyncMode>;
+/**
+ * Context provided to the onBeforeSync hook.
+ * Contains information about the pending sync operation.
+ */
+export interface BeforeSyncContext {
+    /** The collection being synced */
+    readonly collection: string;
+    /** The document ID being synced */
+    readonly documentId: string;
+    /** The binary changes (Yjs update) about to be sent */
+    readonly changes: Uint8Array;
+}
+/**
+ * Context provided to the onAfterSync hook.
+ * Contains information about the completed sync operation.
+ */
+export interface AfterSyncContext {
+    /** The collection that was synced */
+    readonly collection: string;
+    /** The document ID that was synced */
+    readonly documentId: string;
+    /** Whether the sync was successful */
+    readonly success: boolean;
+    /** Timestamp when the sync completed */
+    readonly timestamp: number;
+    /** Error if the sync failed (only present when success is false) */
+    readonly error?: Error;
+}
+/**
+ * Context provided to the onSyncError hook.
+ * Contains information about the sync error and retry state.
+ */
+export interface SyncErrorContext {
+    /** The collection where the error occurred */
+    readonly collection: string;
+    /** The document ID where the error occurred */
+    readonly documentId: string;
+    /** The error that occurred */
+    readonly error: Error;
+    /** The current retry count (0 for first attempt) */
+    readonly retryCount: number;
+    /** Whether the sync will be retried */
+    readonly willRetry: boolean;
+}
+/**
+ * Context provided to the onSyncRejected hook.
+ * Contains information about the server rejection.
+ */
+export interface SyncRejectedContext {
+    /** The collection where the rejection occurred */
+    readonly collection: string;
+    /** The document ID where the rejection occurred */
+    readonly documentId: string;
+    /** The rejection error from the server */
+    readonly error: {
+        readonly code: string;
+        readonly message: string;
+        readonly field?: string;
+    };
+}
+/**
+ * Lifecycle hooks for sync operations.
+ * All hooks are optional and can be used to customize sync behavior.
+ *
+ * @example
+ * ```typescript
+ * const hooks: SyncLifecycleHooks = {
+ *   onBeforeSync: async (context) => {
+ *     // Log or modify sync behavior
+ *     console.log(`Syncing ${context.documentId}`);
+ *     return true; // Return false to skip this sync
+ *   },
+ *   onAfterSync: (context) => {
+ *     if (context.success) {
+ *       console.log(`Synced ${context.documentId}`);
+ *     }
+ *   },
+ *   onSyncError: (collection, documentId, error) => {
+ *     console.error(`Sync error: ${error.message}`);
+ *   },
+ *   onSyncRejected: (collection, documentId, error) => {
+ *     // Handle server-side rejection (e.g., validation error)
+ *     alert(`Server rejected: ${error.message}`);
+ *   },
+ * };
+ * ```
+ */
+export interface SyncLifecycleHooks {
+    /**
+     * Called before a sync operation starts.
+     * Return false to skip the sync, or true/void to proceed.
+     * Can be async for performing validation or transformation.
+     *
+     * @param context - Information about the pending sync
+     * @returns Whether to proceed with the sync (default: true)
+     */
+    onBeforeSync?: (context: BeforeSyncContext) => boolean | void | Promise<boolean | void>;
+    /**
+     * Called after a sync operation completes (success or failure).
+     * Useful for updating UI state or logging.
+     *
+     * @param context - Information about the completed sync
+     */
+    onAfterSync?: (context: AfterSyncContext) => void | Promise<void>;
+    /**
+     * Called when a sync operation fails due to a network or transport error.
+     * The error is typically retryable.
+     *
+     * @param collection - The collection name
+     * @param documentId - The document ID
+     * @param error - The error that occurred
+     */
+    onSyncError?: (collection: string, documentId: string, error: Error) => void | Promise<void>;
+    /**
+     * Called when the server rejects a sync operation.
+     * This typically indicates a validation error, permission issue,
+     * or constraint violation that requires user intervention.
+     *
+     * @param collection - The collection name
+     * @param documentId - The document ID
+     * @param error - Detailed sync error from the server
+     */
+    onSyncRejected?: (collection: string, documentId: string, error: SyncError) => void | Promise<void>;
+}
+/**
+ * Configuration for creating a SyncedOfflineEdge instance.
+ *
+ * @example
+ * ```typescript
+ * const config: SyncedOfflineEdgeConfig = {
+ *   persistence: new IndexedDBPersistence('my-app'),
+ *   config: {
+ *     serverUrl: 'nats://localhost:4222',
+ *     apiKey: 'edge-api-key',
+ *   },
+ *   syncConfig: {
+ *     tasks: 'auto',
+ *     drafts: 'manual',
+ *   },
+ *   hooks: {
+ *     onAfterSync: (ctx) => console.log('Synced:', ctx.documentId),
+ *   },
+ * };
+ * ```
+ */
+export interface SyncedOfflineEdgeConfig {
+    /** Persistence provider for local storage (required) */
+    readonly persistence: PersistenceProvider;
+    /** Connection configuration (required) */
+    readonly config: OfflineEdgeConfig;
+    /**
+     * Per-collection sync mode configuration.
+     * Collections not specified default to 'auto' mode.
+     */
+    readonly syncConfig?: SyncConfigMap;
+    /**
+     * Lifecycle hooks for customizing sync behavior.
+     */
+    readonly hooks?: SyncLifecycleHooks;
+}
+/**
+ * A synced collection with offline-first capabilities.
+ * Provides all standard collection operations plus sync-specific methods.
+ */
+export interface SyncedOfflineCollection<T extends {
+    id: string;
+}> {
+    /** Collection name */
+    readonly name: string;
+    /**
+     * Insert a new document into the collection.
+     * The document is stored locally immediately and queued for sync.
+     */
+    insert(data: Omit<T, 'id'>, options?: InsertOptions): Promise<SyncedDocument<T>>;
+    /**
+     * Update an existing document.
+     * Changes are applied locally immediately and queued for sync.
+     */
+    update(id: string, data: Partial<Omit<T, 'id'>>, options?: UpdateOptions): Promise<SyncedDocument<T>>;
+    /**
+     * Delete a document from the collection.
+     * The deletion is applied locally immediately and queued for sync.
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Get a document by ID.
+     * Returns the local version of the document.
+     */
+    get(id: string): Promise<SyncedDocument<T> | null>;
+    /**
+     * List all documents in the collection.
+     * Returns local documents including unsynced changes.
+     */
+    list(): Promise<SyncedDocument<T>[]>;
+    /**
+     * Query documents with filtering, sorting, and pagination.
+     */
+    query(options: QueryOptions<T>): Promise<SyncedDocument<T>[]>;
+    /**
+     * Subscribe to collection changes.
+     * Callback is invoked immediately with current documents and on every change.
+     */
+    subscribe(callback: (docs: SyncedDocument<T>[]) => void): Unsubscribe;
+    /**
+     * Subscribe to sync rejection events for this collection.
+     */
+    onSyncRejected(callback: (event: SyncRejectedEvent<T>) => void): Unsubscribe;
+    /**
+     * Get sync status for a specific document.
+     */
+    getSyncStatus(id: string): Promise<SyncMetadata | null>;
+    /**
+     * Retry sync for a specific document.
+     * Resets retry counter and triggers immediate sync attempt.
+     */
+    retrySync(id: string): Promise<void>;
+    /**
+     * Get the count of documents with pending changes in this collection.
+     */
+    getPendingSyncCount(): Promise<number>;
+}
+/**
+ * SyncedOfflineEdge is a high-level API for offline-first applications.
+ *
+ * It provides:
+ * - Automatic local persistence with configurable providers
+ * - Configurable sync modes (auto/manual/disabled) per collection
+ * - Lifecycle hooks for customizing sync behavior
+ * - Manual sync control for fine-grained sync management
+ * - Real-time connection state tracking
+ *
+ * @example
+ * ```typescript
+ * import { createSyncedOfflineEdge } from '@fatagnus/dink-sync';
+ *
+ * const edge = await createSyncedOfflineEdge({
+ *   persistence: new IndexedDBPersistence('my-app'),
+ *   config: {
+ *     serverUrl: 'nats://localhost:4222',
+ *     apiKey: 'your-edge-api-key',
+ *   },
+ *   syncConfig: {
+ *     tasks: 'auto',
+ *     drafts: 'manual',
+ *   },
+ * });
+ *
+ * // Get a collection - works offline!
+ * const tasks = edge.collection<Task>('tasks');
+ *
+ * // Insert works immediately, syncs in background
+ * await tasks.insert({ title: 'Buy milk', completed: false });
+ *
+ * // Manual sync when needed
+ * await edge.syncCollection('drafts');
+ *
+ * // Pause all syncing (e.g., for battery saving)
+ * edge.pauseSync();
+ *
+ * // Cleanup when done
+ * await edge.destroy();
+ * ```
+ */
+export interface SyncedOfflineEdge {
+    /**
+     * Get or create a typed collection.
+     * The collection provides offline-first CRUD operations.
+     *
+     * @param name - Collection name
+     * @returns A synced collection instance
+     */
+    collection<T extends {
+        id: string;
+    }>(name: string): SyncedOfflineCollection<T>;
+    /**
+     * Get the underlying OfflineEdgeClient.
+     * Provides direct access to the raw client for advanced use cases.
+     *
+     * @returns The OfflineEdgeClient instance
+     */
+    getOfflineClient(): OfflineEdgeClient;
+    /**
+     * Get the underlying SyncEngine.
+     * Provides direct access to the sync engine for advanced use cases.
+     *
+     * @returns The SyncEngine instance
+     */
+    getSyncEngine(): SyncEngine;
+    /**
+     * Reactive signal tracking the current connection state.
+     * Delegates to the SyncEngine's connection state.
+     */
+    readonly connectionState: Signal<ConnectionState>;
+    /**
+     * Get the current connection state.
+     */
+    getConnectionState(): ConnectionState;
+    /**
+     * Check if currently connected to the server.
+     * Shorthand for getConnectionState() === 'online'.
+     */
+    isConnected(): boolean;
+    /**
+     * Subscribe to connection state changes.
+     * Callback is invoked immediately with current state and on every change.
+     *
+     * @param callback - Function called with new connection state
+     * @returns Unsubscribe function
+     */
+    onConnectionChange(callback: (state: ConnectionState) => void): Unsubscribe;
+    /**
+     * Get the sync mode for a collection.
+     * Returns 'auto' if not explicitly configured.
+     *
+     * @param collection - Collection name
+     * @returns The sync mode for the collection
+     */
+    getSyncMode(collection: string): SyncMode;
+    /**
+     * Set the sync mode for a collection.
+     * Changes take effect immediately.
+     *
+     * @param collection - Collection name
+     * @param mode - New sync mode
+     */
+    setSyncMode(collection: string, mode: SyncMode): void;
+    /**
+     * Subscribe to sync mode change events.
+     * Called when a collection's sync mode is changed via setSyncMode.
+     *
+     * @param callback - Function called with collection name and new mode
+     * @returns Unsubscribe function
+     */
+    onSyncModeChange(callback: (collection: string, mode: SyncMode) => void): Unsubscribe;
+    /**
+     * Add a callback to be called before sync operations.
+     * Callbacks are called in registration order.
+     * Return false to cancel the sync, true or void to proceed.
+     *
+     * @param callback - Function called before sync with context
+     */
+    addOnBeforeSync(callback: (context: BeforeSyncContext) => boolean | void | Promise<boolean | void>): void;
+    /**
+     * Remove a previously added onBeforeSync callback.
+     *
+     * @param callback - The callback to remove
+     */
+    removeOnBeforeSync(callback: (context: BeforeSyncContext) => boolean | void | Promise<boolean | void>): void;
+    /**
+     * Add a callback to be called after successful sync operations.
+     * Callbacks are called in registration order.
+     *
+     * @param callback - Function called after sync with context
+     */
+    addOnAfterSync(callback: (context: AfterSyncContext) => void | Promise<void>): void;
+    /**
+     * Remove a previously added onAfterSync callback.
+     *
+     * @param callback - The callback to remove
+     */
+    removeOnAfterSync(callback: (context: AfterSyncContext) => void | Promise<void>): void;
+    /**
+     * Add a callback to be called when sync errors occur.
+     * Callbacks are called in registration order.
+     *
+     * @param callback - Function called on sync error with context
+     */
+    addOnSyncError(callback: (context: SyncErrorContext) => void | Promise<void>): void;
+    /**
+     * Remove a previously added onSyncError callback.
+     *
+     * @param callback - The callback to remove
+     */
+    removeOnSyncError(callback: (context: SyncErrorContext) => void | Promise<void>): void;
+    /**
+     * Add a callback to be called when sync is rejected by the server.
+     * Callbacks are called in registration order.
+     *
+     * @param callback - Function called on sync rejection with context
+     */
+    addOnSyncRejected(callback: (context: SyncRejectedContext) => void | Promise<void>): void;
+    /**
+     * Remove a previously added onSyncRejected callback.
+     *
+     * @param callback - The callback to remove
+     */
+    removeOnSyncRejected(callback: (context: SyncRejectedContext) => void | Promise<void>): void;
+    /**
+     * Immediately sync pending changes.
+     *
+     * @param collection - Optional collection name. If provided, syncs only that collection.
+     *                     If omitted, syncs all collections with pending changes.
+     * @returns Promise that resolves when sync completes
+     *
+     * @example
+     * ```typescript
+     * // Flush all pending changes
+     * await edge.flush();
+     *
+     * // Flush only the 'drafts' collection
+     * await edge.flush('drafts');
+     * ```
+     */
+    flush(collection?: string): Promise<void>;
+    /**
+     * Trigger immediate sync for all pending changes.
+     * Only affects collections in 'auto' or 'manual' mode.
+     *
+     * @returns Promise that resolves when sync completes
+     * @deprecated Use flush() instead
+     */
+    syncNow(): Promise<void>;
+    /**
+     * Trigger immediate sync for a specific collection.
+     *
+     * @param collection - Collection name to sync
+     * @returns Promise that resolves when sync completes
+     * @deprecated Use flush(collection) instead
+     */
+    syncCollection(collection: string): Promise<void>;
+    /**
+     * Trigger immediate sync for a specific document.
+     *
+     * @param collection - Collection name
+     * @param documentId - Document ID to sync
+     * @returns Promise that resolves when sync completes
+     */
+    syncDocument(collection: string, documentId: string): Promise<void>;
+    /**
+     * Pause all automatic sync operations globally.
+     * Changes continue to be queued locally but won't be sent to the server.
+     * Manual flush() calls still work while paused.
+     * Useful for battery saving, batch operations, or user-initiated offline mode.
+     *
+     * @example
+     * ```typescript
+     * edge.pause();
+     * // Make many changes without triggering syncs
+     * await tasks.insert({ title: 'Task 1' });
+     * await tasks.insert({ title: 'Task 2' });
+     * // When ready, resume to sync all changes
+     * edge.resume();
+     * ```
+     */
+    pause(): void;
+    /**
+     * Resume automatic sync operations after pausing.
+     * Triggers immediate flush of pending changes for all auto-mode collections.
+     * Manual-mode collections still require explicit flush() calls.
+     */
+    resume(): void;
+    /**
+     * Check if automatic sync is currently paused.
+     *
+     * @returns true if paused, false otherwise
+     */
+    isPaused(): boolean;
+    /**
+     * Pause all sync operations.
+     * Changes continue to be queued locally but won't be sent to the server.
+     * Useful for battery saving or user-initiated offline mode.
+     * @deprecated Use pause() instead
+     */
+    pauseSync(): void;
+    /**
+     * Resume sync operations after pausing.
+     * Triggers immediate sync of any pending changes.
+     * @deprecated Use resume() instead
+     */
+    resumeSync(): void;
+    /**
+     * Check if sync is currently paused.
+     * @deprecated Use isPaused() instead
+     */
+    isSyncPaused(): boolean;
+    /**
+     * Manually force offline mode.
+     * Prevents sync operations even when network is available.
+     * Useful for testing offline behavior or saving battery.
+     * Delegates to SyncEngine.goOffline().
+     */
+    goOffline(): void;
+    /**
+     * Exit manual offline mode.
+     * Flushes any pending changes if transport and network are available.
+     * Delegates to SyncEngine.goOnline().
+     */
+    goOnline(): void;
+    /**
+     * Check if there are any pending changes across all collections.
+     */
+    hasPendingChanges(): boolean;
+    /**
+     * Get the count of documents with pending changes.
+     *
+     * @param collection - Optional collection name to filter by
+     * @returns Count of documents with pending changes
+     */
+    getPendingCount(collection?: string): Promise<number>;
+    /**
+     * Destroy the edge client and release all resources.
+     * Disconnects from the server and closes persistence.
+     * The instance cannot be used after calling destroy.
+     */
+    destroy(): Promise<void>;
+}
+//# sourceMappingURL=synced-offline-edge-types.d.ts.map

package/dist/client/synced-offline-edge-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synced-offline-edge-types.d.ts","sourceRoot":"","sources":["../../src/client/synced-offline-edge-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,MAAM,EACN,WAAW,EACX,aAAa,EACb,aAAa,EACb,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,kCAAkC;IAClC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,mCAAmC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,wCAAwC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,oEAAoE;IACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,uCAAuC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAExF;;;;;OAKG;IACH,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7F;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrG;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,uBAAuB;IACtC,wDAAwD;IACxD,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAE1C,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE;IAC/D,sBAAsB;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjF;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtG;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEnD;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9D;;;OAGG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,GAAG,WAAW,CAAC;IAEtE;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,WAAW,CAAC;IAE7E;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAExD;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;OAEG;IACH,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,WAAW,iBAAiB;IAGhC;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,SAAS;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAI/E;;;;;OAKG;IACH,gBAAgB,IAAI,iBAAiB,CAAC;IAEtC;;;;;OAKG;IACH,aAAa,IAAI,UAAU,CAAC;IAI5B;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAElD;;OAEG;IACH,kBAAkB,IAAI,eAAe,CAAC;IAEtC;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC;IAEvB;;;;;;OAMG;IACH,kBAAkB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,GAAG,WAAW,CAAC;IAI5E;;;;;;OAMG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE1C;;;;;;OAMG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEtD;;;;;;OAMG;IACH,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,WAAW,CAAC;IAItF;;;;;;OAMG;IACH,eAAe,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1G;;;;OAIG;IACH,kBAAkB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7G;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpF;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEvF;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpF;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEvF;;;;;OAKG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAI7F;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;;OAMG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;;;OAMG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAIpE;;;;;;;;;;;;;;;OAeG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;OAIG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,IAAI,IAAI,CAAC;IAElB;;;;OAIG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC;IAIxB;;;;;OAKG;IACH,SAAS,IAAI,IAAI,CAAC;IAElB;;;;OAIG;IACH,QAAQ,IAAI,IAAI,CAAC;IAIjB;;OAEG;IACH,iBAAiB,IAAI,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,eAAe,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAItD;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B"}

package/dist/client/synced-offline-edge-types.js

@@ -0,0 +1,10 @@
+/**
+ * Type definitions for SyncedOfflineEdge.
+ *
+ * SyncedOfflineEdge is a high-level API that combines offline-first persistence
+ * with configurable sync modes and lifecycle hooks.
+ *
+ * @module synced-offline-edge-types
+ */
+export {};
+//# sourceMappingURL=synced-offline-edge-types.js.map

package/dist/client/synced-offline-edge-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synced-offline-edge-types.js","sourceRoot":"","sources":["../../src/client/synced-offline-edge-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/dist/client/synced-offline-edge.d.ts

@@ -0,0 +1,54 @@
+/**
+ * SyncedOfflineEdge - A high-level API for offline-first applications
+ * with configurable per-collection sync modes.
+ *
+ * Combines OfflineEdgeClient with SyncEngine for automatic sync,
+ * providing granular per-collection sync control, lifecycle hooks,
+ * and manual sync controls.
+ *
+ * @module synced-offline-edge
+ */
+import type { PersistenceProvider } from '../persistence/types.js';
+import type { OfflineEdgeConfig } from './types.js';
+import type { SyncConfigMap, SyncLifecycleHooks, SyncedOfflineEdge } from './synced-offline-edge-types.js';
+import type { Transport } from './transport.js';
+/**
+ * Extended configuration for creating a SyncedOfflineEdge instance.
+ * Includes optional transport for testing.
+ */
+export interface CreateSyncedOfflineEdgeOptions {
+    /** Persistence provider for local storage (required) */
+    persistence: PersistenceProvider;
+    /** Connection configuration (required) */
+    config: OfflineEdgeConfig;
+    /**
+     * Per-collection sync mode configuration.
+     * Collections not specified default to 'auto' mode.
+     */
+    syncConfig?: SyncConfigMap;
+    /**
+     * Lifecycle hooks for customizing sync behavior.
+     */
+    hooks?: SyncLifecycleHooks;
+    /**
+     * Custom transport for testing (optional).
+     * If not provided, a real NATS transport will be created.
+     */
+    transport?: Transport;
+    /**
+     * Debounce time in ms before syncing changes (default: 200).
+     */
+    debounceMs?: number;
+    /**
+     * Max retries for failed sync operations (default: 5).
+     */
+    maxRetries?: number;
+}
+/**
+ * Create a SyncedOfflineEdge instance.
+ *
+ * @param options - Configuration options
+ * @returns A promise that resolves to a SyncedOfflineEdge instance
+ */
+export declare function createSyncedOfflineEdge(options: CreateSyncedOfflineEdgeOptions): Promise<SyncedOfflineEdge>;
+//# sourceMappingURL=synced-offline-edge.d.ts.map

package/dist/client/synced-offline-edge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synced-offline-edge.d.ts","sourceRoot":"","sources":["../../src/client/synced-offline-edge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EASV,iBAAiB,EAClB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAEV,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EAMlB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,KAAK,EAAE,SAAS,EAA4B,MAAM,gBAAgB,CAAC;AAK1E;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,wDAAwD;IACxD,WAAW,EAAE,mBAAmB,CAAC;IAEjC,0CAA0C;IAC1C,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,iBAAiB,CAAC,CAo0B5B"}