diff options
Diffstat (limited to 'bot/node_modules/matrix-js-sdk/lib/store/index.d.ts')
| -rw-r--r-- | bot/node_modules/matrix-js-sdk/lib/store/index.d.ts | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/bot/node_modules/matrix-js-sdk/lib/store/index.d.ts b/bot/node_modules/matrix-js-sdk/lib/store/index.d.ts new file mode 100644 index 0000000..3523392 --- /dev/null +++ b/bot/node_modules/matrix-js-sdk/lib/store/index.d.ts @@ -0,0 +1,195 @@ +import { EventType } from "../@types/event"; +import { Room } from "../models/room"; +import { User } from "../models/user"; +import { IEvent, MatrixEvent } from "../models/event"; +import { Filter } from "../filter"; +import { RoomSummary } from "../models/room-summary"; +import { IMinimalEvent, IRooms, ISyncResponse } from "../sync-accumulator"; +import { IStartClientOpts } from "../client"; +import { IStateEventWithRoomId } from "../@types/search"; +import { IndexedToDeviceBatch, ToDeviceBatchWithTxnId } from "../models/ToDeviceMessage"; +import { EventEmitterEvents } from "../models/typed-event-emitter"; +export interface ISavedSync { + nextBatch: string; + roomsData: IRooms; + accountData: IMinimalEvent[]; +} +/** + * A store for most of the data js-sdk needs to store, apart from crypto data + */ +export interface IStore { + readonly accountData: Map<string, MatrixEvent>; + 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; + /** + * 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): MatrixEvent[]; + /** + * 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: MatrixEvent[], 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: MatrixEvent[]): void; + /** + * Get account data event by event type + * @param eventType - The event type being queried + */ + getAccountData(eventType: EventType | string): MatrixEvent | 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
\ No newline at end of file |