@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/sync.d.ts

@@ -0,0 +1,260 @@
+import type { SyncCryptoCallbacks } from "./common-crypto/CryptoBackend.ts";
+import { Room } from "./models/room.ts";
+import { IStoredClientOpts, MatrixClient, ResetTimelineCallback } from "./client.ts";
+import { MatrixEvent } from "./models/event.ts";
+import { Crypto } from "./crypto/index.ts";
+export declare enum SyncState {
+    /** Emitted after we try to sync more than `FAILED_SYNC_ERROR_THRESHOLD`
+     * times and are still failing. Or when we enounter a hard error like the
+     * token being invalid. */
+    Error = "ERROR",
+    /** Emitted after the first sync events are ready (this could even be sync
+     * events from the cache) */
+    Prepared = "PREPARED",
+    /** Emitted when the sync loop is no longer running */
+    Stopped = "STOPPED",
+    /** Emitted after each sync request happens */
+    Syncing = "SYNCING",
+    /** Emitted after a connectivity error and we're ready to start syncing again */
+    Catchup = "CATCHUP",
+    /** Emitted for each time we try reconnecting. Will switch to `Error` after
+     * we reach the `FAILED_SYNC_ERROR_THRESHOLD`
+     */
+    Reconnecting = "RECONNECTING"
+}
+/**
+ * Options passed into the constructor of SyncApi by MatrixClient
+ */
+export interface SyncApiOptions {
+    /**
+     * Crypto manager
+     *
+     * @deprecated in favour of cryptoCallbacks
+     */
+    crypto?: Crypto;
+    /**
+     * If crypto is enabled on our client, callbacks into the crypto module
+     */
+    cryptoCallbacks?: SyncCryptoCallbacks;
+    /**
+     * A function which is called
+     * with a room ID and returns a boolean. It should return 'true' if the SDK can
+     * SAFELY remove events from this room. It may not be safe to remove events if
+     * there are other references to the timelines for this room.
+     */
+    canResetEntireTimeline?: ResetTimelineCallback;
+}
+export interface ISyncStateData {
+    /**
+     * The matrix error if `state=ERROR`.
+     */
+    error?: Error;
+    /**
+     * The 'since' token passed to /sync.
+     *    `null` for the first successful sync since this client was
+     *    started. Only present if `state=PREPARED` or
+     *    `state=SYNCING`.
+     */
+    oldSyncToken?: string;
+    /**
+     * The 'next_batch' result from /sync, which
+     *    will become the 'since' token for the next call to /sync. Only present if
+     *    `state=PREPARED</code> or <code>state=SYNCING`.
+     */
+    nextSyncToken?: string;
+    /**
+     * True if we are working our way through a
+     *    backlog of events after connecting. Only present if `state=SYNCING`.
+     */
+    catchingUp?: boolean;
+    fromCache?: boolean;
+}
+export declare enum SetPresence {
+    Offline = "offline",
+    Online = "online",
+    Unavailable = "unavailable"
+}
+/** add default settings to an IStoredClientOpts */
+export declare function defaultClientOpts(opts?: IStoredClientOpts): IStoredClientOpts;
+export declare function defaultSyncApiOpts(syncOpts?: SyncApiOptions): SyncApiOptions;
+export declare class SyncApi {
+    private readonly client;
+    private readonly opts;
+    private readonly syncOpts;
+    private _peekRoom;
+    private currentSyncRequest?;
+    private abortController?;
+    private syncState;
+    private syncStateData?;
+    private catchingUp;
+    private running;
+    private keepAliveTimer?;
+    private connectionReturnedDefer?;
+    private notifEvents;
+    private failedSyncCount;
+    private storeIsInvalid;
+    private presence?;
+    /**
+     * Construct an entity which is able to sync with a homeserver.
+     * @param client - The matrix client instance to use.
+     * @param opts - client config options
+     * @param syncOpts - sync-specific options passed by the client
+     * @internal
+     */
+    constructor(client: MatrixClient, opts?: IStoredClientOpts, syncOpts?: SyncApiOptions);
+    createRoom(roomId: string): Room;
+    /** When we see the marker state change in the room, we know there is some
+     * new historical messages imported by MSC2716 `/batch_send` somewhere in
+     * the room and we need to throw away the timeline to make sure the
+     * historical messages are shown when we paginate `/messages` again.
+     * @param room - The room where the marker event was sent
+     * @param markerEvent - The new marker event
+     * @param setStateOptions - When `timelineWasEmpty` is set
+     * as `true`, the given marker event will be ignored
+     */
+    private onMarkerStateEvent;
+    /**
+     * Sync rooms the user has left.
+     * @returns Resolved when they've been added to the store.
+     */
+    syncLeftRooms(): Promise<Room[]>;
+    /**
+     * Peek into a room. This will result in the room in question being synced so it
+     * is accessible via getRooms(). Live updates for the room will be provided.
+     * @param roomId - The room ID to peek into.
+     * @param limit - The number of timeline events to initially retrieve.
+     * @returns A promise which resolves once the room has been added to the
+     * store.
+     */
+    peek(roomId: string, limit?: number): Promise<Room>;
+    /**
+     * Stop polling for updates in the peeked room. NOPs if there is no room being
+     * peeked.
+     */
+    stopPeeking(): void;
+    /**
+     * Do a peek room poll.
+     * @param token - from= token
+     */
+    private peekPoll;
+    /**
+     * Returns the current state of this sync object
+     * @see MatrixClient#event:"sync"
+     */
+    getSyncState(): SyncState | null;
+    /**
+     * Returns the additional data object associated with
+     * the current sync state, or null if there is no
+     * such data.
+     * Sync errors, if available, are put in the 'error' key of
+     * this object.
+     */
+    getSyncStateData(): ISyncStateData | null;
+    recoverFromSyncStartupError(savedSyncPromise: Promise<void> | undefined, error: Error): Promise<void>;
+    private shouldAbortSync;
+    private getPushRules;
+    private buildDefaultFilter;
+    private prepareLazyLoadingForSync;
+    private storeClientOptions;
+    private getFilter;
+    private savedSyncPromise?;
+    /**
+     * Main entry point
+     */
+    sync(): Promise<void>;
+    /**
+     * Stops the sync object from syncing.
+     */
+    stop(): void;
+    /**
+     * Retry a backed off syncing request immediately. This should only be used when
+     * the user <b>explicitly</b> attempts to retry their lost connection.
+     * @returns True if this resulted in a request being retried.
+     */
+    retryImmediately(): boolean;
+    /**
+     * Process a single set of cached sync data.
+     * @param savedSync - a saved sync that was persisted by a store. This
+     * should have been acquired via client.store.getSavedSync().
+     */
+    private syncFromCache;
+    /**
+     * Invoke me to do /sync calls
+     */
+    private doSync;
+    private doSyncRequest;
+    private getSyncParams;
+    /**
+     * Specify the set_presence value to be used for subsequent calls to the Sync API.
+     * @param presence - the presence to specify to set_presence of sync calls
+     */
+    setPresence(presence?: SetPresence): void;
+    private onSyncError;
+    /**
+     * Process data returned from a sync response and propagate it
+     * into the model objects
+     *
+     * @param syncEventData - Object containing sync tokens associated with this sync
+     * @param data - The response from /sync
+     */
+    private processSyncResponse;
+    /**
+     * Starts polling the connectivity check endpoint
+     * @param delay - How long to delay until the first poll.
+     *        defaults to a short, randomised interval (to prevent
+     *        tight-looping if /versions succeeds but /sync etc. fail).
+     * @returns which resolves once the connection returns
+     */
+    private startKeepAlives;
+    /**
+     * Make a dummy call to /_matrix/client/versions, to see if the HS is
+     * reachable.
+     *
+     * On failure, schedules a call back to itself. On success, resolves
+     * this.connectionReturnedDefer.
+     *
+     * @param connDidFail - True if a connectivity failure has been detected. Optional.
+     */
+    private pokeKeepAlive;
+    private mapSyncResponseToRoomArray;
+    private mapSyncEventsFormat;
+    /**
+     */
+    private resolveInvites;
+    private findEncryptionEvent;
+    private isRoomEncrypted;
+    /**
+     * Injects events into a room's model.
+     * @param stateEventList - A list of state events. This is the state
+     * at the *START* of the timeline list if it is supplied.
+     * @param timelineEventList - A list of timeline events, including threaded. Lower index
+     * is earlier in time. Higher index is later.
+     * @param fromCache - whether the sync response came from cache
+     */
+    injectRoomEvents(room: Room, stateEventList: MatrixEvent[], timelineEventList?: MatrixEvent[], fromCache?: boolean): Promise<void>;
+    /**
+     * Takes a list of timelineEvents and adds and adds to notifEvents
+     * as appropriate.
+     * This must be called after the room the events belong to has been stored.
+     *
+     * @param timelineEventList - A list of timeline events. Lower index
+     * is earlier in time. Higher index is later.
+     */
+    private processEventsForNotifs;
+    private getGuestFilter;
+    /**
+     * Sets the sync state and emits an event to say so
+     * @param newState - The new state string
+     * @param data - Object of additional data to emit in the event
+     */
+    private updateSyncState;
+    /**
+     * Event handler for the 'online' event
+     * This event is generally unreliable and precise behaviour
+     * varies between browsers, so we poll for connectivity too,
+     * but this might help us reconnect a little faster.
+     */
+    private onOnline;
+}
+export declare function _createAndReEmitRoom(client: MatrixClient, roomId: string, opts: Partial<IStoredClientOpts>): Room;
+//# sourceMappingURL=sync.d.ts.map

package/lib/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../src/sync.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAE5E,OAAO,EAAyB,IAAI,EAAa,MAAM,kBAAkB,CAAC;AAK1E,OAAO,EAAe,iBAAiB,EAAE,YAAY,EAAwB,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAgBxH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAWhD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAgB3C,oBAAY,SAAS;IACjB;;8BAE0B;IAC1B,KAAK,UAAU;IACf;gCAC4B;IAC5B,QAAQ,aAAa;IACrB,sDAAsD;IACtD,OAAO,YAAY;IACnB,8CAA8C;IAC9C,OAAO,YAAY;IACnB,gFAAgF;IAChF,OAAO,YAAY;IACnB;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAmBD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;IAEtC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,qBAAqB,CAAC;CAClD;AAOD,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,oBAAY,WAAW;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,WAAW,gBAAgB;CAC9B;AAkBD,mDAAmD;AACnD,wBAAgB,iBAAiB,CAAC,IAAI,CAAC,EAAE,iBAAiB,GAAG,iBAAiB,CAS7E;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,cAAc,GAAG,cAAc,CAK5E;AAED,qBAAa,OAAO;IA0BZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAzB3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAE1C,OAAO,CAAC,SAAS,CAAwB;IACzC,OAAO,CAAC,kBAAkB,CAAC,CAAyB;IACpD,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,aAAa,CAAC,CAAiB;IACvC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAC,CAAgC;IACvD,OAAO,CAAC,uBAAuB,CAAC,CAAqB;IACrD,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAc;IAE/B;;;;;;OAMG;gBAEkB,MAAM,EAAE,YAAY,EACrC,IAAI,CAAC,EAAE,iBAAiB,EACxB,QAAQ,CAAC,EAAE,cAAc;IAUtB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAUvC;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IA0D1B;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAqE7C;;;;;;;OAOG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuE9D;;;OAGG;IACI,WAAW,IAAI,IAAI;IAI1B;;;OAGG;IACH,OAAO,CAAC,QAAQ;IA2EhB;;;OAGG;IACI,YAAY,IAAI,SAAS,GAAG,IAAI;IAIvC;;;;;;OAMG;IACI,gBAAgB,IAAI,cAAc,GAAG,IAAI;IAInC,2BAA2B,CAAC,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAWlH,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,YAAY,CAgBlB;IAEF,OAAO,CAAC,kBAAkB,CAMxB;IAEF,OAAO,CAAC,yBAAyB,CAe/B;IAEF,OAAO,CAAC,kBAAkB,CASxB;IAEF,OAAO,CAAC,SAAS,CAyBf;IAEF,OAAO,CAAC,gBAAgB,CAAC,CAAgB;IAEzC;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAmFlC;;OAEG;IACI,IAAI,IAAI,IAAI;IAenB;;;;OAIG;IACI,gBAAgB,IAAI,OAAO;IAOlC;;;;OAIG;YACW,aAAa;IAqC3B;;OAEG;YACW,MAAM;IAgGpB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,aAAa;IAoDrB;;;OAGG;IACI,WAAW,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,IAAI;YAIlC,WAAW;IAmDzB;;;;;;OAMG;YACW,mBAAmB;IA6djC;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAmBvB;;;;;;;;OAQG;IACH,OAAO,CAAC,aAAa;IA8DrB,OAAO,CAAC,0BAA0B;IAwBlC,OAAO,CAAC,mBAAmB;IAkB3B;OACG;IACH,OAAO,CAAC,cAAc;IA2CtB,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,eAAe;IAQvB;;;;;;;OAOG;IACU,gBAAgB,CACzB,IAAI,EAAE,IAAI,EACV,cAAc,EAAE,WAAW,EAAE,EAC7B,iBAAiB,CAAC,EAAE,WAAW,EAAE,EACjC,SAAS,UAAQ,GAClB,OAAO,CAAC,IAAI,CAAC;IAgEhB;;;;;;;OAOG;IACH,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,cAAc;IAMtB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAOvB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAGd;CACL;AAID,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CA2CjH"}