fauxbase 0.5.8 → 0.6.0

package/dist/index.d.cts

@@ -67,7 +67,32 @@ interface HttpDriverConfig {
     };
     headers?: Record<string, string>;
 }
-type DriverConfig = LocalDriverConfig | HttpDriverConfig;
+interface SyncDriverConfig$1 {
+    type: 'sync';
+    local: {
+        persist?: 'localStorage' | 'indexeddb';
+        dbName?: string;
+    };
+    remote: {
+        baseUrl: string;
+        preset?: string;
+        timeout?: number;
+        retry?: {
+            maxRetries?: number;
+            baseDelay?: number;
+        };
+        headers?: Record<string, string>;
+    };
+    sync?: {
+        interval?: number;
+        retryDelay?: number;
+        maxRetries?: number;
+        conflictStrategy?: 'last-write-wins' | 'server-wins' | 'client-wins';
+        resources?: string[];
+        pingUrl?: string;
+    };
+}
+type DriverConfig = LocalDriverConfig | HttpDriverConfig | SyncDriverConfig$1;
 interface SeedDefinition<T = any> {
     entityName: string;
     entityClass: any;
@@ -244,7 +269,7 @@ declare abstract class Service<T extends Entity> {
     private runHooks;
 }
 
-type AuthProvider$1 = () => {
+type AuthProvider$2 = () => {
     token: string;
 } | null;
 interface HttpDriverOptions extends HttpDriverConfig {
@@ -266,7 +291,7 @@ declare class HttpDriver implements Driver {
     private authProvider;
     private onUnauthorized;
     constructor(config: HttpDriverOptions);
-    setAuthProvider(provider: AuthProvider$1): void;
+    setAuthProvider(provider: AuthProvider$2): void;
     /** @internal — set callback to refresh token on 401 */
     setOnUnauthorized(handler: () => Promise<boolean>): void;
     registerEndpoint(resource: string, endpoint: string): void;
@@ -397,7 +422,7 @@ interface StorageBackend {
     getMeta(key: string): string | null;
     setMeta(key: string, value: string): void;
 }
-type AuthProvider = () => {
+type AuthProvider$1 = () => {
     userId: string;
     userName?: string;
 } | null;
@@ -414,7 +439,7 @@ declare class LocalDriver implements Driver {
     private getLatency;
     get ready(): Promise<void>;
     get isReady(): boolean;
-    setAuthProvider(provider: AuthProvider): void;
+    setAuthProvider(provider: AuthProvider$1): void;
     getStorageBackend(): StorageBackend;
     registerEntity(resource: string, entityClass: Function): void;
     list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
@@ -443,6 +468,151 @@ declare class LocalDriver implements Driver {
     clear(resource: string): void;
 }
 
+interface SyncDriverConfig {
+    type: 'sync';
+    local: {
+        persist?: 'localStorage' | 'indexeddb';
+        dbName?: string;
+    };
+    remote: {
+        baseUrl: string;
+        preset?: string;
+        timeout?: number;
+        retry?: {
+            maxRetries?: number;
+            baseDelay?: number;
+        };
+        headers?: Record<string, string>;
+    };
+    sync?: {
+        interval?: number;
+        retryDelay?: number;
+        maxRetries?: number;
+        conflictStrategy?: 'last-write-wins' | 'server-wins' | 'client-wins';
+        resources?: string[];
+        pingUrl?: string;
+    };
+}
+interface QueueEntry {
+    id: string;
+    resource: string;
+    action: 'create' | 'update' | 'delete';
+    entityId: string;
+    data: Record<string, any> | null;
+    timestamp: number;
+    status: 'pending' | 'syncing' | 'failed';
+    retries: number;
+    error?: string;
+}
+interface SyncState {
+    isOnline: boolean;
+    isSyncing: boolean;
+    pendingCount: number;
+    lastSynced: number | null;
+}
+
+declare class SyncQueue {
+    private db;
+    private cache;
+    private _ready;
+    constructor(dbName?: string);
+    get ready(): Promise<void>;
+    private open;
+    private loadAll;
+    private persist;
+    private removeFromDb;
+    enqueue(entry: Omit<QueueEntry, 'id' | 'status' | 'retries'>): Promise<void>;
+    getPending(): QueueEntry[];
+    getPendingCount(): number;
+    markSyncing(id: string): Promise<void>;
+    remove(id: string): Promise<void>;
+    markFailed(id: string, error: string): Promise<void>;
+    getDeadLetters(maxRetries: number): QueueEntry[];
+}
+
+declare class SyncEngine {
+    private localDriver;
+    private httpDriver;
+    private queue;
+    private config;
+    private eventBus;
+    private online;
+    private syncing;
+    private pullTimer;
+    private pushTimer;
+    private lastSynced;
+    private registeredResources;
+    private _syncPromise;
+    constructor(localDriver: LocalDriver, httpDriver: HttpDriver, queue: SyncQueue, syncConfig?: SyncDriverConfig['sync']);
+    setEventBus(bus: EventBus): void;
+    registerResource(resource: string, endpoint: string): void;
+    start(): void;
+    stop(): void;
+    sync(): Promise<{
+        pushed: number;
+        pulled: number;
+    }>;
+    private _doSync;
+    private push;
+    private pull;
+    private pullResource;
+    private handleConflict;
+    private setupConnectivityListeners;
+    private checkOnline;
+    private handleOnline;
+    private handleOffline;
+    getSyncState(): SyncState;
+    private emitEvent;
+    private emitSyncState;
+}
+
+type AuthProvider = () => {
+    token: string;
+} | null;
+declare class SyncDriver implements Driver {
+    private localDriver;
+    private httpDriver;
+    private queue;
+    private _syncEngine;
+    private _ready;
+    private _isReady;
+    constructor(config: SyncDriverConfig);
+    get ready(): Promise<void>;
+    get isReady(): boolean;
+    get syncEngine(): SyncEngine;
+    /** @internal — exposed for createClient auth wiring */
+    get _httpDriver(): HttpDriver;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    request<R = any>(resource: string, path: string, options?: {
+        method?: string;
+        body?: any;
+        query?: Record<string, string>;
+        local?: () => R | Promise<R>;
+    }): Promise<R>;
+    seed(resource: string, data: Array<Record<string, any>>, entityClass: Function): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(version: string): void;
+    clear(resource: string): void;
+    setAuthProvider(provider: AuthProvider): void;
+    setOnUnauthorized(handler: () => Promise<boolean>): void;
+    registerEndpoint(resource: string, endpoint: string): void;
+    registerEntity(resource: string, entityClass: Function): void;
+    getStorageBackend(): ReturnType<LocalDriver['getStorageBackend']>;
+}
+
 type FilterStyle = 'django' | 'dot' | 'bracket' | 'nestjs';
 interface Preset {
     name: string;
@@ -502,4 +672,4 @@ declare const expressPreset: Preset;
 
 declare function getPreset(name: string): Preset;
 
-export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type SSEConfig, type STOMPConfig, type SeedDefinition, Service, type SortParams, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type QueueEntry, type SSEConfig, type STOMPConfig, type SeedDefinition, Service, type SortParams, SyncDriver, type SyncDriverConfig$1 as SyncDriverConfig, type SyncState, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };

package/dist/index.d.ts

@@ -67,7 +67,32 @@ interface HttpDriverConfig {
     };
     headers?: Record<string, string>;
 }
-type DriverConfig = LocalDriverConfig | HttpDriverConfig;
+interface SyncDriverConfig$1 {
+    type: 'sync';
+    local: {
+        persist?: 'localStorage' | 'indexeddb';
+        dbName?: string;
+    };
+    remote: {
+        baseUrl: string;
+        preset?: string;
+        timeout?: number;
+        retry?: {
+            maxRetries?: number;
+            baseDelay?: number;
+        };
+        headers?: Record<string, string>;
+    };
+    sync?: {
+        interval?: number;
+        retryDelay?: number;
+        maxRetries?: number;
+        conflictStrategy?: 'last-write-wins' | 'server-wins' | 'client-wins';
+        resources?: string[];
+        pingUrl?: string;
+    };
+}
+type DriverConfig = LocalDriverConfig | HttpDriverConfig | SyncDriverConfig$1;
 interface SeedDefinition<T = any> {
     entityName: string;
     entityClass: any;
@@ -244,7 +269,7 @@ declare abstract class Service<T extends Entity> {
     private runHooks;
 }
 
-type AuthProvider$1 = () => {
+type AuthProvider$2 = () => {
     token: string;
 } | null;
 interface HttpDriverOptions extends HttpDriverConfig {
@@ -266,7 +291,7 @@ declare class HttpDriver implements Driver {
     private authProvider;
     private onUnauthorized;
     constructor(config: HttpDriverOptions);
-    setAuthProvider(provider: AuthProvider$1): void;
+    setAuthProvider(provider: AuthProvider$2): void;
     /** @internal — set callback to refresh token on 401 */
     setOnUnauthorized(handler: () => Promise<boolean>): void;
     registerEndpoint(resource: string, endpoint: string): void;
@@ -397,7 +422,7 @@ interface StorageBackend {
     getMeta(key: string): string | null;
     setMeta(key: string, value: string): void;
 }
-type AuthProvider = () => {
+type AuthProvider$1 = () => {
     userId: string;
     userName?: string;
 } | null;
@@ -414,7 +439,7 @@ declare class LocalDriver implements Driver {
     private getLatency;
     get ready(): Promise<void>;
     get isReady(): boolean;
-    setAuthProvider(provider: AuthProvider): void;
+    setAuthProvider(provider: AuthProvider$1): void;
     getStorageBackend(): StorageBackend;
     registerEntity(resource: string, entityClass: Function): void;
     list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
@@ -443,6 +468,151 @@ declare class LocalDriver implements Driver {
     clear(resource: string): void;
 }
 
+interface SyncDriverConfig {
+    type: 'sync';
+    local: {
+        persist?: 'localStorage' | 'indexeddb';
+        dbName?: string;
+    };
+    remote: {
+        baseUrl: string;
+        preset?: string;
+        timeout?: number;
+        retry?: {
+            maxRetries?: number;
+            baseDelay?: number;
+        };
+        headers?: Record<string, string>;
+    };
+    sync?: {
+        interval?: number;
+        retryDelay?: number;
+        maxRetries?: number;
+        conflictStrategy?: 'last-write-wins' | 'server-wins' | 'client-wins';
+        resources?: string[];
+        pingUrl?: string;
+    };
+}
+interface QueueEntry {
+    id: string;
+    resource: string;
+    action: 'create' | 'update' | 'delete';
+    entityId: string;
+    data: Record<string, any> | null;
+    timestamp: number;
+    status: 'pending' | 'syncing' | 'failed';
+    retries: number;
+    error?: string;
+}
+interface SyncState {
+    isOnline: boolean;
+    isSyncing: boolean;
+    pendingCount: number;
+    lastSynced: number | null;
+}
+
+declare class SyncQueue {
+    private db;
+    private cache;
+    private _ready;
+    constructor(dbName?: string);
+    get ready(): Promise<void>;
+    private open;
+    private loadAll;
+    private persist;
+    private removeFromDb;
+    enqueue(entry: Omit<QueueEntry, 'id' | 'status' | 'retries'>): Promise<void>;
+    getPending(): QueueEntry[];
+    getPendingCount(): number;
+    markSyncing(id: string): Promise<void>;
+    remove(id: string): Promise<void>;
+    markFailed(id: string, error: string): Promise<void>;
+    getDeadLetters(maxRetries: number): QueueEntry[];
+}
+
+declare class SyncEngine {
+    private localDriver;
+    private httpDriver;
+    private queue;
+    private config;
+    private eventBus;
+    private online;
+    private syncing;
+    private pullTimer;
+    private pushTimer;
+    private lastSynced;
+    private registeredResources;
+    private _syncPromise;
+    constructor(localDriver: LocalDriver, httpDriver: HttpDriver, queue: SyncQueue, syncConfig?: SyncDriverConfig['sync']);
+    setEventBus(bus: EventBus): void;
+    registerResource(resource: string, endpoint: string): void;
+    start(): void;
+    stop(): void;
+    sync(): Promise<{
+        pushed: number;
+        pulled: number;
+    }>;
+    private _doSync;
+    private push;
+    private pull;
+    private pullResource;
+    private handleConflict;
+    private setupConnectivityListeners;
+    private checkOnline;
+    private handleOnline;
+    private handleOffline;
+    getSyncState(): SyncState;
+    private emitEvent;
+    private emitSyncState;
+}
+
+type AuthProvider = () => {
+    token: string;
+} | null;
+declare class SyncDriver implements Driver {
+    private localDriver;
+    private httpDriver;
+    private queue;
+    private _syncEngine;
+    private _ready;
+    private _isReady;
+    constructor(config: SyncDriverConfig);
+    get ready(): Promise<void>;
+    get isReady(): boolean;
+    get syncEngine(): SyncEngine;
+    /** @internal — exposed for createClient auth wiring */
+    get _httpDriver(): HttpDriver;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    request<R = any>(resource: string, path: string, options?: {
+        method?: string;
+        body?: any;
+        query?: Record<string, string>;
+        local?: () => R | Promise<R>;
+    }): Promise<R>;
+    seed(resource: string, data: Array<Record<string, any>>, entityClass: Function): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(version: string): void;
+    clear(resource: string): void;
+    setAuthProvider(provider: AuthProvider): void;
+    setOnUnauthorized(handler: () => Promise<boolean>): void;
+    registerEndpoint(resource: string, endpoint: string): void;
+    registerEntity(resource: string, entityClass: Function): void;
+    getStorageBackend(): ReturnType<LocalDriver['getStorageBackend']>;
+}
+
 type FilterStyle = 'django' | 'dot' | 'bracket' | 'nestjs';
 interface Preset {
     name: string;
@@ -502,4 +672,4 @@ declare const expressPreset: Preset;
 
 declare function getPreset(name: string): Preset;
 
-export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type SSEConfig, type STOMPConfig, type SeedDefinition, Service, type SortParams, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type QueueEntry, type SSEConfig, type STOMPConfig, type SeedDefinition, Service, type SortParams, SyncDriver, type SyncDriverConfig$1 as SyncDriverConfig, type SyncState, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };