@towns-protocol/sdk 0.0.191

package/dist/syncedStreamsLoop.d.ts

@@ -0,0 +1,121 @@
+/// <reference types="node" />
+import { SyncCookie } from '@towns-protocol/proto';
+import { StreamRpcClient } from './makeStreamRpcClient';
+import { UnpackEnvelopeOpts } from './sign';
+import { SyncedStreamEvents } from './streamEvents';
+import TypedEmitter from 'typed-emitter';
+import { ParsedEvent, ParsedStreamResponse } from './types';
+export declare enum SyncState {
+    Canceling = "Canceling",// syncLoop, maybe syncId if was syncing, not is was starting or retrying
+    NotSyncing = "NotSyncing",// no syncLoop
+    Retrying = "Retrying",// syncLoop set, no syncId
+    Starting = "Starting",// syncLoop set, no syncId
+    Syncing = "Syncing"
+}
+/**
+ * Valid state transitions:
+ * - [*] -\> NotSyncing
+ * - NotSyncing -\> Starting
+ * - Starting -\> Syncing
+ * - Starting -\> Canceling: failed / stop sync
+ * - Starting -\> Retrying: connection error
+ * - Syncing -\> Canceling: connection aborted / stop sync
+ * - Syncing -\> Retrying: connection error
+ * - Syncing -\> Syncing: resync
+ * - Retrying -\> Canceling: stop sync
+ * - Retrying -\> Syncing: resume
+ * - Retrying -\> Retrying: still retrying
+ * - Canceling -\> NotSyncing
+ * @see https://www.notion.so/herenottherelabs/RFC-Sync-hardening-e0552a4ed68a4d07b42ae34c69ee1bec?pvs=4#861081756f86423ea668c62b9eb76f4b
+ */
+export declare const stateConstraints: Record<SyncState, Set<SyncState>>;
+export interface ISyncedStream {
+    syncCookie?: SyncCookie;
+    stop(): void;
+    initializeFromResponse(response: ParsedStreamResponse): Promise<void>;
+    appendEvents(events: ParsedEvent[], nextSyncCookie: SyncCookie, cleartexts: Record<string, Uint8Array | string> | undefined): Promise<void>;
+    resetUpToDate(): void;
+}
+interface NonceStats {
+    sequence: number;
+    nonce: string;
+    pingAt: number;
+    receivedAt?: number;
+    duration?: number;
+}
+interface Nonces {
+    [nonce: string]: NonceStats;
+}
+export interface PingInfo {
+    nonces: Nonces;
+    currentSequence: number;
+    pingTimeout?: NodeJS.Timeout;
+}
+export declare class SyncedStreamsLoop {
+    readonly unpackEnvelopeOpts: UnpackEnvelopeOpts | undefined;
+    private highPriorityIds;
+    private streamOpts;
+    private readonly streams;
+    private readonly logSync;
+    private readonly logDebug;
+    private readonly logError;
+    private readonly clientEmitter;
+    private syncLoop?;
+    private syncId?;
+    private rpcClient;
+    private _syncState;
+    private releaseRetryWait;
+    private currentRetryCount;
+    private forceStopSyncStreams;
+    private interruptSync;
+    private isMobileSafariBackgrounded;
+    private responsesQueue;
+    private inProgressTick?;
+    private pendingSyncCookies;
+    private inFlightSyncCookies;
+    private pendingStreamsToDelete;
+    private lastLogInflightAt;
+    private syncStartedAt;
+    private readonly MAX_IN_FLIGHT_COOKIES;
+    private readonly MIN_IN_FLIGHT_COOKIES;
+    private readonly MAX_IN_FLIGHT_STREAMS_TO_DELETE;
+    pingInfo: PingInfo;
+    constructor(clientEmitter: TypedEmitter<SyncedStreamEvents>, rpcClient: StreamRpcClient, streams: {
+        syncCookie: SyncCookie;
+        stream: ISyncedStream;
+    }[], logNamespace: string, unpackEnvelopeOpts: UnpackEnvelopeOpts | undefined, highPriorityIds: Set<string>, streamOpts: {
+        useModifySync?: boolean;
+    } | undefined);
+    get syncState(): SyncState;
+    stats(): {
+        syncState: SyncState;
+        streams: number;
+        syncId: string | undefined;
+        queuedResponses: number;
+    };
+    getSyncId(): string | undefined;
+    start(): void;
+    stop(): Promise<void>;
+    addStreamToSync(streamId: string, syncCookie: SyncCookie, stream: ISyncedStream): void;
+    removeStreamFromSync(inStreamId: string | Uint8Array): Promise<void>;
+    setHighPriorityStreams(streamIds: string[]): void;
+    onNetworkStatusChanged(isOnline: boolean): void;
+    private createSyncLoop;
+    private onMobileSafariBackgrounded;
+    private checkStartTicking;
+    private tick;
+    private waitForSyncingState;
+    private setSyncState;
+    private attemptRetry;
+    private syncStarted;
+    private syncDown;
+    private syncClosed;
+    private onUpdate;
+    private sendKeepAlivePings;
+    private stopPing;
+    private printNonces;
+    private logInvalidStateAndReturnError;
+    private log;
+}
+export {};
+//# sourceMappingURL=syncedStreamsLoop.d.ts.map

package/dist/syncedStreamsLoop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncedStreamsLoop.d.ts","sourceRoot":"","sources":["../src/syncedStreamsLoop.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAA+B,MAAM,uBAAuB,CAAA;AAE/E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,kBAAkB,EAAuC,MAAM,QAAQ,CAAA;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,YAAY,MAAM,eAAe,CAAA;AAgBxC,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAG3D,oBAAY,SAAS;IACjB,SAAS,cAAc,CAAE,yEAAyE;IAClG,UAAU,eAAe,CAAE,cAAc;IACzC,QAAQ,aAAa,CAAE,0BAA0B;IACjD,QAAQ,aAAa,CAAE,0BAA0B;IACjD,OAAO,YAAY;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAW9D,CAAA;AAED,MAAM,WAAW,aAAa;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,IAAI,IAAI,CAAA;IACZ,sBAAsB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACrE,YAAY,CACR,MAAM,EAAE,WAAW,EAAE,EACrB,cAAc,EAAE,UAAU,EAC1B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,GAAG,SAAS,GAC5D,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,aAAa,IAAI,IAAI,CAAA;CACxB;AAED,UAAU,UAAU;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,UAAU,MAAM;IACZ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAA;CAC9B;AAED,MAAM,WAAW,QAAQ;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;CAC/B;AACD,qBAAa,iBAAiB;IAyDtB,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,SAAS;IAC3D,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,UAAU;IAzDtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgE;IAExF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAMhE,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAMlC,OAAO,CAAC,MAAM,CAAC,CAAQ;IAGvB,OAAO,CAAC,SAAS,CAAiB;IAElC,OAAO,CAAC,UAAU,CAAkC;IAEpD,OAAO,CAAC,gBAAgB,CAA0B;IAClD,OAAO,CAAC,iBAAiB,CAAY;IACrC,OAAO,CAAC,oBAAoB,CAA0B;IACtD,OAAO,CAAC,aAAa,CAAsC;IAC3D,OAAO,CAAC,0BAA0B,CAAQ;IAK1C,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,kBAAkB,CAAe;IACzC,OAAO,CAAC,mBAAmB,CAAoB;IAC/C,OAAO,CAAC,sBAAsB,CAAe;IAC7C,OAAO,CAAC,iBAAiB,CAAI;IAC7B,OAAO,CAAC,aAAa,CAAgC;IACrD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAK;IAC3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAK;IAC3C,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAAK;IAE9C,QAAQ,EAAE,QAAQ,CAGxB;gBAGG,aAAa,EAAE,YAAY,CAAC,kBAAkB,CAAC,EAC/C,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,EAAE,EAC5D,YAAY,EAAE,MAAM,EACX,kBAAkB,EAAE,kBAAkB,GAAG,SAAS,EACnD,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,EAC5B,UAAU,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS;IAe/D,IAAW,SAAS,IAAI,SAAS,CAEhC;IAEM,KAAK;;;;;;IASL,SAAS,IAAI,MAAM,GAAG,SAAS;IAI/B,KAAK;IAQC,IAAI;IAyCV,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa;IAmBzE,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC1E,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE;IAI1C,sBAAsB,CAAC,QAAQ,EAAE,OAAO;IAO/C,OAAO,CAAC,cAAc;IA+LtB,OAAO,CAAC,0BAA0B,CASjC;IAED,OAAO,CAAC,iBAAiB;YA2BX,IAAI;YAiEJ,mBAAmB;IAoBjC,OAAO,CAAC,YAAY;YAaN,YAAY;IAyD1B,OAAO,CAAC,WAAW;IAsBnB,OAAO,CAAC,QAAQ;IAsDhB,OAAO,CAAC,UAAU;YAUJ,QAAQ;IAuGtB,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,6BAA6B;IAKrC,OAAO,CAAC,GAAG;CAGd"}