@textrp/briij-js-sdk 41.0.0

package/lib/store/index.d.ts

@@ -0,0 +1,201 @@
+import { type EventType } from "../@types/event.ts";
+import { type Room } from "../models/room.ts";
+import { type User } from "../models/user.ts";
+import { type IEvent, type BriijEvent } from "../models/event.ts";
+import { type Filter } from "../filter.ts";
+import { type RoomSummary } from "../models/room-summary.ts";
+import { type IMinimalEvent, type IRooms, type ISyncResponse } from "../sync-accumulator.ts";
+import { type IStartClientOpts } from "../client.ts";
+import { type IStateEventWithRoomId } from "../@types/search.ts";
+import { type IndexedToDeviceBatch, type ToDeviceBatchWithTxnId } from "../models/ToDeviceMessage.ts";
+import { type EventEmitterEvents } from "../models/typed-event-emitter.ts";
+export interface ISavedSync {
+    nextBatch: string;
+    roomsData: IRooms;
+    accountData: IMinimalEvent[];
+}
+export type UserCreator = (userId: string) => User;
+/**
+ * A store for most of the data js-sdk needs to store, apart from crypto data
+ */
+export interface IStore {
+    readonly accountData: Map<string, BriijEvent>;
+    on?: (event: EventEmitterEvents | "degraded" | "closed", handler: (...args: any[]) => void) => void;
+    /** @returns whether or not the database was newly created in this session. */
+    isNewlyCreated(): Promise<boolean>;
+    /**
+     * Get the sync token.
+     */
+    getSyncToken(): string | null;
+    /**
+     * Set the sync token.
+     */
+    setSyncToken(token: string): void;
+    /**
+     * Store the given room.
+     * @param room - The room to be stored. All properties must be stored.
+     */
+    storeRoom(room: Room): void;
+    /**
+     * Set the user creator which is used for creating User objects
+     * @param creator - A callback that accepts an user-id and returns an User object
+     */
+    setUserCreator(creator: UserCreator): void;
+    /**
+     * Retrieve a room by its' room ID.
+     * @param roomId - The room ID.
+     * @returns The room or null.
+     */
+    getRoom(roomId: string): Room | null;
+    /**
+     * Retrieve all known rooms.
+     * @returns A list of rooms, which may be empty.
+     */
+    getRooms(): Room[];
+    /**
+     * Permanently delete a room.
+     */
+    removeRoom(roomId: string): void;
+    /**
+     * Retrieve a summary of all the rooms.
+     * @returns A summary of each room.
+     */
+    getRoomSummaries(): RoomSummary[];
+    /**
+     * Store a User.
+     * @param user - The user to store.
+     */
+    storeUser(user: User): void;
+    /**
+     * Retrieve a User by its' user ID.
+     * @param userId - The user ID.
+     * @returns The user or null.
+     */
+    getUser(userId: string): User | null;
+    /**
+     * Retrieve all known users.
+     * @returns A list of users, which may be empty.
+     */
+    getUsers(): User[];
+    /**
+     * Retrieve scrollback for this room.
+     * @param room - The matrix room
+     * @param limit - The max number of old events to retrieve.
+     * @returns An array of objects which will be at most 'limit'
+     * length and at least 0. The objects are the raw event JSON.
+     */
+    scrollback(room: Room, limit: number): BriijEvent[];
+    /**
+     * Store events for a room.
+     * @param room - The room to store events for.
+     * @param events - The events to store.
+     * @param token - The token associated with these events.
+     * @param toStart - True if these are paginated results.
+     */
+    storeEvents(room: Room, events: BriijEvent[], token: string | null, toStart: boolean): void;
+    /**
+     * Store a filter.
+     */
+    storeFilter(filter: Filter): void;
+    /**
+     * Retrieve a filter.
+     * @returns A filter or null.
+     */
+    getFilter(userId: string, filterId: string): Filter | null;
+    /**
+     * Retrieve a filter ID with the given name.
+     * @param filterName - The filter name.
+     * @returns The filter ID or null.
+     */
+    getFilterIdByName(filterName: string): string | null;
+    /**
+     * Set a filter name to ID mapping.
+     */
+    setFilterIdByName(filterName: string, filterId?: string): void;
+    /**
+     * Store user-scoped account data events
+     * @param events - The events to store.
+     */
+    storeAccountDataEvents(events: BriijEvent[]): void;
+    /**
+     * Get account data event by event type
+     * @param eventType - The event type being queried
+     */
+    getAccountData(eventType: EventType | string): BriijEvent | undefined;
+    /**
+     * setSyncData does nothing as there is no backing data store.
+     *
+     * @param syncData - The sync data
+     * @returns An immediately resolved promise.
+     */
+    setSyncData(syncData: ISyncResponse): Promise<void>;
+    /**
+     * We never want to save because we have nothing to save to.
+     *
+     * @returns If the store wants to save
+     */
+    wantsSave(): boolean;
+    /**
+     * Save does nothing as there is no backing data store.
+     */
+    save(force?: boolean): Promise<void>;
+    /**
+     * Startup does nothing.
+     * @returns An immediately resolved promise.
+     */
+    startup(): Promise<void>;
+    /**
+     * @returns Promise which resolves with a sync response to restore the
+     * client state to where it was at the last save, or null if there
+     * is no saved sync data.
+     */
+    getSavedSync(): Promise<ISavedSync | null>;
+    /**
+     * @returns If there is a saved sync, the nextBatch token
+     * for this sync, otherwise null.
+     */
+    getSavedSyncToken(): Promise<string | null>;
+    /**
+     * Delete all data from this store. Does nothing since this store
+     * doesn't store anything.
+     * @returns An immediately resolved promise.
+     */
+    deleteAllData(): Promise<void>;
+    /**
+     * Returns the out-of-band membership events for this room that
+     * were previously loaded.
+     * @returns the events, potentially an empty array if OOB loading didn't yield any new members
+     * @returns in case the members for this room haven't been stored yet
+     */
+    getOutOfBandMembers(roomId: string): Promise<IStateEventWithRoomId[] | null>;
+    /**
+     * Stores the out-of-band membership events for this room. Note that
+     * it still makes sense to store an empty array as the OOB status for the room is
+     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null
+     * @param membershipEvents - the membership events to store
+     * @returns when all members have been stored
+     */
+    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;
+    clearOutOfBandMembers(roomId: string): Promise<void>;
+    getClientOptions(): Promise<IStartClientOpts | undefined>;
+    storeClientOptions(options: IStartClientOpts): Promise<void>;
+    getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>;
+    setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>;
+    /**
+     * Stores batches of outgoing to-device messages
+     */
+    saveToDeviceBatches(batch: ToDeviceBatchWithTxnId[]): Promise<void>;
+    /**
+     * Fetches the oldest batch of to-device messages in the queue
+     */
+    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;
+    /**
+     * Removes a specific batch of to-device messages from the queue
+     */
+    removeToDeviceBatch(id: number): Promise<void>;
+    /**
+     * Stop the store and perform any appropriate cleanup
+     */
+    destroy(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/store/index.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtG,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAE3E,MAAM,WAAW,UAAU;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,aAAa,EAAE,CAAC;CAChC;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,MAAM;IACnB,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAK9C,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,UAAU,GAAG,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC;IAEpG,8EAA8E;IAC9E,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAE3C;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,QAAQ,IAAI,IAAI,EAAE,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,IAAI,WAAW,EAAE,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,QAAQ,IAAI,IAAI,EAAE,CAAC;IAEnB;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAEpD;;;;;;OAMG;IACH,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5F;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE3D;;;;OAIG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,sBAAsB,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IAEtE;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;OAIG;IACH,YAAY,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAE3C;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/B;;;;;OAKG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,GAAG,IAAI,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9F,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;IAE1D,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAE7D,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;OAEG;IACH,mBAAmB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;OAEG;IACH,sBAAsB,IAAI,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B"}

package/lib/store/index.js

@@ -0,0 +1 @@
+export {};

package/lib/store/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/store/index.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type EventType } from \"../@types/event.ts\";\nimport { type Room } from \"../models/room.ts\";\nimport { type User } from \"../models/user.ts\";\nimport { type IEvent, type BriijEvent } from \"../models/event.ts\";\nimport { type Filter } from \"../filter.ts\";\nimport { type RoomSummary } from \"../models/room-summary.ts\";\nimport { type IMinimalEvent, type IRooms, type ISyncResponse } from \"../sync-accumulator.ts\";\nimport { type IStartClientOpts } from \"../client.ts\";\nimport { type IStateEventWithRoomId } from \"../@types/search.ts\";\nimport { type IndexedToDeviceBatch, type ToDeviceBatchWithTxnId } from \"../models/ToDeviceMessage.ts\";\nimport { type EventEmitterEvents } from \"../models/typed-event-emitter.ts\";\n\nexport interface ISavedSync {\n    nextBatch: string;\n    roomsData: IRooms;\n    accountData: IMinimalEvent[];\n}\n\nexport type UserCreator = (userId: string) => User;\n\n/**\n * A store for most of the data js-sdk needs to store, apart from crypto data\n */\nexport interface IStore {\n    readonly accountData: Map<string, BriijEvent>; // type : content\n\n    // XXX: The indexeddb store exposes a non-standard emitter for:\n    // \"degraded\" event for when it falls back to being a memory store due to errors.\n    // \"closed\" event for when the database closes unexpectedly\n    on?: (event: EventEmitterEvents | \"degraded\" | \"closed\", handler: (...args: any[]) => void) => void;\n\n    /** @returns whether or not the database was newly created in this session. */\n    isNewlyCreated(): Promise<boolean>;\n\n    /**\n     * Get the sync token.\n     */\n    getSyncToken(): string | null;\n\n    /**\n     * Set the sync token.\n     */\n    setSyncToken(token: string): void;\n\n    /**\n     * Store the given room.\n     * @param room - The room to be stored. All properties must be stored.\n     */\n    storeRoom(room: Room): void;\n\n    /**\n     * Set the user creator which is used for creating User objects\n     * @param creator - A callback that accepts an user-id and returns an User object\n     */\n    setUserCreator(creator: UserCreator): void;\n\n    /**\n     * Retrieve a room by its' room ID.\n     * @param roomId - The room ID.\n     * @returns The room or null.\n     */\n    getRoom(roomId: string): Room | null;\n\n    /**\n     * Retrieve all known rooms.\n     * @returns A list of rooms, which may be empty.\n     */\n    getRooms(): Room[];\n\n    /**\n     * Permanently delete a room.\n     */\n    removeRoom(roomId: string): void;\n\n    /**\n     * Retrieve a summary of all the rooms.\n     * @returns A summary of each room.\n     */\n    getRoomSummaries(): RoomSummary[];\n\n    /**\n     * Store a User.\n     * @param user - The user to store.\n     */\n    storeUser(user: User): void;\n\n    /**\n     * Retrieve a User by its' user ID.\n     * @param userId - The user ID.\n     * @returns The user or null.\n     */\n    getUser(userId: string): User | null;\n\n    /**\n     * Retrieve all known users.\n     * @returns A list of users, which may be empty.\n     */\n    getUsers(): User[];\n\n    /**\n     * Retrieve scrollback for this room.\n     * @param room - The matrix room\n     * @param limit - The max number of old events to retrieve.\n     * @returns An array of objects which will be at most 'limit'\n     * length and at least 0. The objects are the raw event JSON.\n     */\n    scrollback(room: Room, limit: number): BriijEvent[];\n\n    /**\n     * Store events for a room.\n     * @param room - The room to store events for.\n     * @param events - The events to store.\n     * @param token - The token associated with these events.\n     * @param toStart - True if these are paginated results.\n     */\n    storeEvents(room: Room, events: BriijEvent[], token: string | null, toStart: boolean): void;\n\n    /**\n     * Store a filter.\n     */\n    storeFilter(filter: Filter): void;\n\n    /**\n     * Retrieve a filter.\n     * @returns A filter or null.\n     */\n    getFilter(userId: string, filterId: string): Filter | null;\n\n    /**\n     * Retrieve a filter ID with the given name.\n     * @param filterName - The filter name.\n     * @returns The filter ID or null.\n     */\n    getFilterIdByName(filterName: string): string | null;\n\n    /**\n     * Set a filter name to ID mapping.\n     */\n    setFilterIdByName(filterName: string, filterId?: string): void;\n\n    /**\n     * Store user-scoped account data events\n     * @param events - The events to store.\n     */\n    storeAccountDataEvents(events: BriijEvent[]): void;\n\n    /**\n     * Get account data event by event type\n     * @param eventType - The event type being queried\n     */\n    getAccountData(eventType: EventType | string): BriijEvent | undefined;\n\n    /**\n     * setSyncData does nothing as there is no backing data store.\n     *\n     * @param syncData - The sync data\n     * @returns An immediately resolved promise.\n     */\n    setSyncData(syncData: ISyncResponse): Promise<void>;\n\n    /**\n     * We never want to save because we have nothing to save to.\n     *\n     * @returns If the store wants to save\n     */\n    wantsSave(): boolean;\n\n    /**\n     * Save does nothing as there is no backing data store.\n     */\n    save(force?: boolean): Promise<void>;\n\n    /**\n     * Startup does nothing.\n     * @returns An immediately resolved promise.\n     */\n    startup(): Promise<void>;\n\n    /**\n     * @returns Promise which resolves with a sync response to restore the\n     * client state to where it was at the last save, or null if there\n     * is no saved sync data.\n     */\n    getSavedSync(): Promise<ISavedSync | null>;\n\n    /**\n     * @returns If there is a saved sync, the nextBatch token\n     * for this sync, otherwise null.\n     */\n    getSavedSyncToken(): Promise<string | null>;\n\n    /**\n     * Delete all data from this store. Does nothing since this store\n     * doesn't store anything.\n     * @returns An immediately resolved promise.\n     */\n    deleteAllData(): Promise<void>;\n\n    /**\n     * Returns the out-of-band membership events for this room that\n     * were previously loaded.\n     * @returns the events, potentially an empty array if OOB loading didn't yield any new members\n     * @returns in case the members for this room haven't been stored yet\n     */\n    getOutOfBandMembers(roomId: string): Promise<IStateEventWithRoomId[] | null>;\n\n    /**\n     * Stores the out-of-band membership events for this room. Note that\n     * it still makes sense to store an empty array as the OOB status for the room is\n     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null\n     * @param membershipEvents - the membership events to store\n     * @returns when all members have been stored\n     */\n    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;\n\n    clearOutOfBandMembers(roomId: string): Promise<void>;\n\n    getClientOptions(): Promise<IStartClientOpts | undefined>;\n\n    storeClientOptions(options: IStartClientOpts): Promise<void>;\n\n    getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>;\n\n    setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>;\n\n    /**\n     * Stores batches of outgoing to-device messages\n     */\n    saveToDeviceBatches(batch: ToDeviceBatchWithTxnId[]): Promise<void>;\n\n    /**\n     * Fetches the oldest batch of to-device messages in the queue\n     */\n    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;\n\n    /**\n     * Removes a specific batch of to-device messages from the queue\n     */\n    removeToDeviceBatch(id: number): Promise<void>;\n\n    /**\n     * Stop the store and perform any appropriate cleanup\n     */\n    destroy(): Promise<void>;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/store/indexeddb-backend.d.ts

@@ -0,0 +1,24 @@
+import { type ISavedSync } from "./index.ts";
+import { type IEvent, type IStateEventWithRoomId, type IStoredClientOpts, type ISyncResponse } from "../briij.ts";
+import { type IndexedToDeviceBatch, type ToDeviceBatchWithTxnId } from "../models/ToDeviceMessage.ts";
+export interface IIndexedDBBackend {
+    connect(onClose?: () => void): Promise<void>;
+    syncToDatabase(userTuples: UserTuple[]): Promise<void>;
+    isNewlyCreated(): Promise<boolean>;
+    setSyncData(syncData: ISyncResponse): Promise<void>;
+    getSavedSync(): Promise<ISavedSync | null>;
+    getNextBatchToken(): Promise<string>;
+    clearDatabase(): Promise<void>;
+    getOutOfBandMembers(roomId: string): Promise<IStateEventWithRoomId[] | null>;
+    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;
+    clearOutOfBandMembers(roomId: string): Promise<void>;
+    getUserPresenceEvents(): Promise<UserTuple[]>;
+    getClientOptions(): Promise<IStoredClientOpts | undefined>;
+    storeClientOptions(options: IStoredClientOpts): Promise<void>;
+    saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;
+    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;
+    removeToDeviceBatch(id: number): Promise<void>;
+    destroy(): Promise<void>;
+}
+export type UserTuple = [userId: string, presenceEvent: Partial<IEvent>];
+//# sourceMappingURL=indexeddb-backend.d.ts.map

package/lib/store/indexeddb-backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb-backend.d.ts","sourceRoot":"","sources":["../../src/store/indexeddb-backend.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAClH,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtG,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,cAAc,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,YAAY,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC3C,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7E,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,qBAAqB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9C,gBAAgB,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC3D,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,sBAAsB,IAAI,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IAC/D,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/lib/store/indexeddb-backend.js

@@ -0,0 +1 @@
+export {};

package/lib/store/indexeddb-backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb-backend.js","names":[],"sources":["../../src/store/indexeddb-backend.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type ISavedSync } from \"./index.ts\";\nimport { type IEvent, type IStateEventWithRoomId, type IStoredClientOpts, type ISyncResponse } from \"../briij.ts\";\nimport { type IndexedToDeviceBatch, type ToDeviceBatchWithTxnId } from \"../models/ToDeviceMessage.ts\";\n\nexport interface IIndexedDBBackend {\n    connect(onClose?: () => void): Promise<void>;\n    syncToDatabase(userTuples: UserTuple[]): Promise<void>;\n    isNewlyCreated(): Promise<boolean>;\n    setSyncData(syncData: ISyncResponse): Promise<void>;\n    getSavedSync(): Promise<ISavedSync | null>;\n    getNextBatchToken(): Promise<string>;\n    clearDatabase(): Promise<void>;\n    getOutOfBandMembers(roomId: string): Promise<IStateEventWithRoomId[] | null>;\n    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;\n    clearOutOfBandMembers(roomId: string): Promise<void>;\n    getUserPresenceEvents(): Promise<UserTuple[]>;\n    getClientOptions(): Promise<IStoredClientOpts | undefined>;\n    storeClientOptions(options: IStoredClientOpts): Promise<void>;\n    saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;\n    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;\n    removeToDeviceBatch(id: number): Promise<void>;\n    destroy(): Promise<void>;\n}\n\nexport type UserTuple = [userId: string, presenceEvent: Partial<IEvent>];\n"],"mappings":"","ignoreList":[]}

package/lib/store/indexeddb-local-backend.d.ts

@@ -0,0 +1,129 @@
+import { type ISyncResponse } from "../sync-accumulator.ts";
+import { type IStateEventWithRoomId, type IStoredClientOpts } from "../briij.ts";
+import { type ISavedSync } from "./index.ts";
+import { type IIndexedDBBackend, type UserTuple } from "./indexeddb-backend.ts";
+import { type IndexedToDeviceBatch, type ToDeviceBatchWithTxnId } from "../models/ToDeviceMessage.ts";
+export declare class LocalIndexedDBStoreBackend implements IIndexedDBBackend {
+    private readonly indexedDB;
+    static exists(indexedDB: IDBFactory, dbName: string): Promise<boolean>;
+    private readonly dbName;
+    private readonly syncAccumulator;
+    private db?;
+    private disconnected;
+    private _isNewlyCreated;
+    private syncToDatabasePromise?;
+    private pendingUserPresenceData;
+    /**
+     * Does the actual reading from and writing to the indexeddb
+     *
+     * Construct a new Indexed Database store backend. This requires a call to
+     * `connect()` before this store can be used.
+     * @param indexedDB - The Indexed DB interface e.g
+     * `window.indexedDB`
+     * @param dbName - Optional database name. The same name must be used
+     * to open the same database.
+     */
+    constructor(indexedDB: IDBFactory, dbName?: string);
+    /**
+     * Attempt to connect to the database. This can fail if the user does not
+     * grant permission.
+     * @returns Promise which resolves if successfully connected.
+     */
+    connect(onClose?: () => void): Promise<void>;
+    /** @returns whether or not the database was newly created in this session. */
+    isNewlyCreated(): Promise<boolean>;
+    /**
+     * Having connected, load initial data from the database and prepare for use
+     * @returns Promise which resolves on success
+     */
+    private init;
+    /**
+     * Returns the out-of-band membership events for this room that
+     * were previously loaded.
+     * @returns the events, potentially an empty array if OOB loading didn't yield any new members
+     * @returns in case the members for this room haven't been stored yet
+     */
+    getOutOfBandMembers(roomId: string): Promise<IStateEventWithRoomId[] | null>;
+    /**
+     * Stores the out-of-band membership events for this room. Note that
+     * it still makes sense to store an empty array as the OOB status for the room is
+     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null
+     * @param membershipEvents - the membership events to store
+     */
+    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;
+    clearOutOfBandMembers(roomId: string): Promise<void>;
+    /**
+     * Clear the entire database. This should be used when logging out of a client
+     * to prevent mixing data between accounts. Closes the database.
+     * @returns Resolved when the database is cleared.
+     */
+    clearDatabase(): Promise<void>;
+    /**
+     * @param copy - If false, the data returned is from internal
+     * buffers and must not be mutated. Otherwise, a copy is made before
+     * returning such that the data can be safely mutated. Default: true.
+     *
+     * @returns Promise which resolves with a sync response to restore the
+     * client state to where it was at the last save, or null if there
+     * is no saved sync data.
+     */
+    getSavedSync(copy?: boolean): Promise<ISavedSync | null>;
+    getNextBatchToken(): Promise<string>;
+    setSyncData(syncData: ISyncResponse): Promise<void>;
+    /**
+     * Sync users and all accumulated sync data to the database.
+     * If a previous sync is in flight, the new data will be added to the
+     * next sync and the current sync's promise will be returned.
+     * @param userTuples - The user tuples
+     * @returns Promise which resolves if the data was persisted.
+     */
+    syncToDatabase(userTuples: UserTuple[]): Promise<void>;
+    private doSyncToDatabase;
+    /**
+     * Persist rooms /sync data along with the next batch token.
+     * @param nextBatch - The next_batch /sync value.
+     * @param roomsData - The 'rooms' /sync data from a SyncAccumulator
+     * @returns Promise which resolves if the data was persisted.
+     */
+    private persistSyncData;
+    /**
+     * Persist a list of account data events. Events with the same 'type' will
+     * be replaced.
+     * @param accountData - An array of raw user-scoped account data events
+     * @returns Promise which resolves if the events were persisted.
+     */
+    private persistAccountData;
+    /**
+     * Persist a list of [user id, presence event] they are for.
+     * Users with the same 'userId' will be replaced.
+     * Presence events should be the event in its raw form (not the Event
+     * object)
+     * @param tuples - An array of [userid, event] tuples
+     * @returns Promise which resolves if the users were persisted.
+     */
+    private persistUserPresenceEvents;
+    /**
+     * Load all user presence events from the database. This is not cached.
+     * FIXME: It would probably be more sensible to store the events in the
+     * sync.
+     * @returns A list of presence events in their raw form.
+     */
+    getUserPresenceEvents(): Promise<UserTuple[]>;
+    /**
+     * Load all the account data events from the database. This is not cached.
+     * @returns A list of raw global account events.
+     */
+    private loadAccountData;
+    /**
+     * Load the sync data from the database.
+     * @returns An object with "roomsData" and "nextBatch" keys.
+     */
+    private loadSyncData;
+    getClientOptions(): Promise<IStoredClientOpts | undefined>;
+    storeClientOptions(options: IStoredClientOpts): Promise<void>;
+    saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;
+    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;
+    removeToDeviceBatch(id: number): Promise<void>;
+    destroy(): Promise<void>;
+}
+//# sourceMappingURL=indexeddb-local-backend.d.ts.map

package/lib/store/indexeddb-local-backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb-local-backend.d.ts","sourceRoot":"","sources":["../../src/store/indexeddb-local-backend.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAsC,KAAK,aAAa,EAAmB,MAAM,wBAAwB,CAAC;AAIjH,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAkGtG,qBAAa,0BAA2B,YAAW,iBAAiB;IAyB5D,OAAO,CAAC,QAAQ,CAAC,SAAS;WAxBhB,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK7E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkB;IAClD,OAAO,CAAC,EAAE,CAAC,CAAc;IACzB,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,qBAAqB,CAAC,CAAgB;IAC9C,OAAO,CAAC,uBAAuB,CAAmB;IAElD;;;;;;;;;OASG;gBAEkB,SAAS,EAAE,UAAU,EACtC,MAAM,SAAY;IAMtB;;;;OAIG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDnD,8EAA8E;IACvE,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzC;;;OAGG;IACH,OAAO,CAAC,IAAI;IAgBZ;;;;;OAKG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,GAAG,IAAI,CAAC;IA0CnF;;;;;OAKG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB7F,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCjE;;;;OAIG;IACI,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BrC;;;;;;;;OAQG;IACI,YAAY,CAAC,IAAI,UAAO,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAYrD,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIpC,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1D;;;;;;OAMG;IACU,cAAc,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YAWrD,gBAAgB;IAa9B;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAgBvB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;OAOG;IACH,OAAO,CAAC,yBAAyB;IAcjC;;;;;OAKG;IACI,qBAAqB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAUpD;;;OAGG;IACH,OAAO,CAAC,eAAe;IAcvB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAiBb,gBAAgB,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAUpD,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU7D,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASrE,sBAAsB,IAAI,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAgB9D,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxC"}