dexie-cloud-addon 4.0.7 → 4.1.0-alpha.2

package/dist/modern/sync/DEXIE_CLOUD_SYNCER_ID.d.ts

@@ -0,0 +1 @@
+export declare const DEXIE_CLOUD_SYNCER_ID = "dexie-cloud-syncer";

package/dist/modern/sync/syncWithServer.d.ts

@@ -1,6 +1,6 @@
 import { DexieCloudDB } from '../db/DexieCloudDB';
 import { PersistedSyncState } from '../db/entities/PersistedSyncState';
 import { BaseRevisionMapEntry } from '../db/entities/BaseRevisionMapEntry';
-import { DBOperationsSet, DexieCloudSchema, SyncResponse } from 'dexie-cloud-common';
+import { DBOperationsSet, DexieCloudSchema, SyncResponse, YClientMessage } from 'dexie-cloud-common';
 import { UserLogin } from '../db/entities/UserLogin';
-export declare function syncWithServer(changes: DBOperationsSet, syncState: PersistedSyncState | undefined, baseRevs: BaseRevisionMapEntry[], db: DexieCloudDB, databaseUrl: string, schema: DexieCloudSchema | null, clientIdentity: string, currentUser: UserLogin): Promise<SyncResponse>;
+export declare function syncWithServer(changes: DBOperationsSet, y: YClientMessage[], syncState: PersistedSyncState | undefined, baseRevs: BaseRevisionMapEntry[], db: DexieCloudDB, databaseUrl: string, schema: DexieCloudSchema | null, clientIdentity: string, currentUser: UserLogin): Promise<SyncResponse>;

package/dist/modern/yjs/YDexieCloudSyncState.d.ts

@@ -0,0 +1,4 @@
+import { YSyncState } from "dexie";
+export interface YDexieCloudSyncState extends YSyncState {
+    serverRev: string;
+}

package/dist/modern/yjs/YTable.d.ts

@@ -0,0 +1,2 @@
+import { EntityTable, YUpdateRow } from "dexie";
+export type YTable = EntityTable<YUpdateRow, "i">;

package/dist/modern/yjs/applyYMessages.d.ts

@@ -0,0 +1,5 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { YServerMessage } from 'dexie-cloud-common';
+export declare function applyYServerMessages(yMessages: YServerMessage[], db: DexieCloudDB): Promise<{
+    [yTable: string]: number;
+}>;

package/dist/modern/yjs/awareness.d.ts

@@ -0,0 +1,4 @@
+import { type DexieCloudDB } from "../db/DexieCloudDB";
+export declare function getAwarenessLibrary(db: DexieCloudDB): typeof import('y-protocols/awareness');
+export declare const awarenessWeakMap: WeakMap<any, import("y-protocols/awareness").Awareness>;
+export declare const getDocAwareness: (doc: any) => import("y-protocols/awareness").Awareness | undefined;

package/dist/modern/yjs/createYClientUpdateObservable.d.ts

@@ -0,0 +1,4 @@
+import { Observable } from 'rxjs';
+import { YClientMessage } from 'dexie-cloud-common';
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function createYClientUpdateObservable(db: DexieCloudDB): Observable<YClientMessage>;

package/dist/modern/yjs/createYHandler.d.ts

@@ -0,0 +1,5 @@
+import { DexieYProvider } from 'dexie';
+import type { DexieCloudDB } from '../db/DexieCloudDB';
+type YDoc = import('yjs').Doc;
+export declare function createYHandler(db: DexieCloudDB): (provider: DexieYProvider<YDoc>) => void;
+export {};

package/dist/modern/yjs/downloadYDocsFromServer.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { PersistedSyncState } from '../db/entities/PersistedSyncState';
+export declare function downloadYDocsFromServer(db: DexieCloudDB, databaseUrl: string, { yDownloadedRealms, realms }: PersistedSyncState): Promise<void>;

package/dist/modern/yjs/getUpdatesTable.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+import { YTable } from "./YTable";
+export declare function getUpdatesTable(db: DexieCloudDB, table: string, ydocProp: string): YTable;

package/dist/modern/yjs/listUpdatesSince.d.ts

@@ -0,0 +1,2 @@
+import type { Table, YUpdateRow } from 'dexie';
+export declare function listUpdatesSince(yTable: Table, sinceIncluding: number): Promise<YUpdateRow[]>;

package/dist/modern/yjs/listYClientMessages.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { YClientMessage } from 'dexie-cloud-common/src/yjs/YMessage';
+export declare function listYClientMessages(db: DexieCloudDB): Promise<YClientMessage[]>;

package/dist/modern/yjs/listYClientMessagesAndStateVector.d.ts

@@ -0,0 +1,24 @@
+import type { YClientMessage } from 'dexie-cloud-common';
+import { DexieCloudDB } from '../db/DexieCloudDB';
+/** Queries the local database for YMessages to send to server.
+ *
+ * There are 2 messages that this function can provide:
+ *   YUpdateFromClientRequest ( for local updates )
+ *   YStateVector ( for state vector of foreign updates so that server can reduce the number of udpates to send back )
+ *
+ * Notice that we do not do a step 1 sync phase here to get a state vector from the server. Reason we can avoid
+ * the 2-step sync is that we are client-server and not client-client here and we keep track of the client changes
+ * sent to server by letting server acknowledge them. There is always a chance that some client update has already
+ * been sent and that the client failed to receive the ack. However, if this happens it does not matter - the change
+ * would be sent again and Yjs handles duplicate changes anyway. And it's rare so we earn the cost of roundtrips by
+ * avoiding the step1 sync and instead keep track of this in the `unsentFrom` property of the SyncState.
+ *
+ * @param db
+ * @returns
+ */
+export declare function listYClientMessagesAndStateVector(db: DexieCloudDB): Promise<{
+    yMessages: YClientMessage[];
+    lastUpdateIds: {
+        [yTable: string]: number;
+    };
+}>;

package/dist/modern/yjs/updateYSyncStates.d.ts

@@ -0,0 +1,6 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function updateYSyncStates(lastUpdateIdsBeforeSync: {
+    [yTable: string]: number;
+}, receivedUntilsAfterSync: {
+    [yTable: string]: number;
+}, db: DexieCloudDB, serverRevision: string): Promise<void>;

package/dist/modern/yjs/y.d.ts

@@ -0,0 +1,3 @@
+import type * as Y from 'yjs';
+import type { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function $Y(db: DexieCloudDB): typeof Y;

package/dist/umd/DexieCloudOptions.d.ts

@@ -1,10 +1,11 @@
-import { TokenFinalResponse } from 'dexie-cloud-common';
+import type { TokenFinalResponse } from 'dexie-cloud-common';
+import type { LoginHints } from './DexieCloudAPI';
 export interface PeriodicSyncOptions {
     minInterval?: number;
 }
 export interface DexieCloudOptions {
     databaseUrl: string;
-    requireAuth?: boolean;
+    requireAuth?: boolean | LoginHints;
     tryUseServiceWorker?: boolean;
     periodicSync?: PeriodicSyncOptions;
     customLoginGui?: boolean;
@@ -19,4 +20,5 @@ export interface DexieCloudOptions {
             email?: string;
         };
     }) => Promise<TokenFinalResponse>;
+    awarenessProtocol?: typeof import('y-protocols/awareness');
 }

package/dist/umd/WSObservable.d.ts

@@ -1,7 +1,9 @@
 import { DBOperationsSet } from 'dexie-cloud-common';
 import { BehaviorSubject, Observable, Subscriber, Subscription } from 'rxjs';
 import { DXCWebSocketStatus } from './DXCWebSocketStatus';
-export type WSClientToServerMsg = ReadyForChangesMessage;
+import type { YClientMessage } from 'dexie-cloud-common';
+import { DexieCloudDB } from './db/DexieCloudDB';
+export type WSClientToServerMsg = ReadyForChangesMessage | YClientMessage;
 export interface ReadyForChangesMessage {
     type: 'ready';
     realmSetHash: string;
@@ -39,9 +41,10 @@ export interface TokenExpiredMessage {
     type: 'token-expired';
 }
 export declare class WSObservable extends Observable<WSConnectionMsg> {
-    constructor(databaseUrl: string, rev: string, realmSetHash: string, clientIdentity: string, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>, token?: string, tokenExpiration?: Date);
+    constructor(db: DexieCloudDB, rev: string, realmSetHash: string, clientIdentity: string, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>, token?: string, tokenExpiration?: Date);
 }
 export declare class WSConnection extends Subscription {
+    db: DexieCloudDB;
     ws: WebSocket | null;
     lastServerActivity: Date;
     lastUserActivity: Date;
@@ -58,8 +61,8 @@ export declare class WSConnection extends Subscription {
     webSocketStatus: BehaviorSubject<DXCWebSocketStatus>;
     id: number;
     private pinger;
-    private messageProducerSubscription;
-    constructor(databaseUrl: string, rev: string, realmSetHash: string, clientIdentity: string, token: string | undefined, tokenExpiration: Date | undefined, subscriber: Subscriber<WSConnectionMsg>, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>);
+    private subscriptions;
+    constructor(db: DexieCloudDB, rev: string, realmSetHash: string, clientIdentity: string, token: string | undefined, tokenExpiration: Date | undefined, subscriber: Subscriber<WSConnectionMsg>, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>);
     private teardown;
     private disconnect;
     reconnecting: boolean;

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

@@ -9,6 +9,7 @@ import { DBRealm, DBRealmMember, DBRealmRole, DexieCloudSchema } from 'dexie-clo
 import { BroadcastedAndLocalEvent } from '../helpers/BroadcastedAndLocalEvent';
 import { SyncStatePhase } from '../types/SyncState';
 import { MessagesFromServerConsumer } from '../sync/messagesFromServerQueue';
+import { YClientMessage } from 'dexie-cloud-common';
 export interface SyncStateChangedEventData {
     phase: SyncStatePhase;
     error?: Error;
@@ -45,6 +46,7 @@ export interface DexieCloudDB extends DexieCloudDBBase {
     setInitiallySynced(initiallySynced: boolean): void;
     reconfigure(): void;
     messageConsumer: MessagesFromServerConsumer;
+    messageProducer: Subject<YClientMessage>;
 }
 export declare const DEXIE_CLOUD_SCHEMA: {
     members: string;

package/dist/umd/db/entities/PersistedSyncState.d.ts

@@ -11,4 +11,11 @@ export interface PersistedSyncState {
     syncedTables: string[];
     timestamp?: Date;
     error?: string;
+    yDownloadedRealms?: {
+        [realmId: string]: "*" | {
+            tbl: string;
+            prop: string;
+            key: any;
+        };
+    };
 }