diff options
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts')
| -rw-r--r-- | includes/external/matrix/node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts | 141 |
1 files changed, 0 insertions, 141 deletions
diff --git a/includes/external/matrix/node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts b/includes/external/matrix/node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts deleted file mode 100644 index adfff15..0000000 --- a/includes/external/matrix/node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts +++ /dev/null @@ -1,141 +0,0 @@ -import type { IToDeviceEvent } from "../sync-accumulator"; -import { MatrixEvent } from "../models/event"; -import { Room } from "../models/room"; -import { CryptoApi } from "../crypto-api"; -import { DeviceTrustLevel, UserTrustLevel } from "../crypto/CrossSigning"; -import { IEncryptedEventInfo } from "../crypto/api"; -import { IEventDecryptionResult } from "../@types/crypto"; -/** - * Common interface for the crypto implementations - */ -export interface CryptoBackend extends SyncCryptoCallbacks, CryptoApi { - /** - * Whether sendMessage in a room with unknown and unverified devices - * should throw an error and not send the message. This has 'Global' for - * symmetry with setGlobalBlacklistUnverifiedDevices but there is currently - * no room-level equivalent for this setting. - * - * @remarks this is here, rather than in `CryptoApi`, because I don't think we're - * going to support it in the rust crypto implementation. - */ - globalErrorOnUnknownDevices: boolean; - /** - * Shut down any background processes related to crypto - */ - stop(): void; - /** - * Get the verification level for a given user - * - * TODO: define this better - * - * @param userId - user to be checked - */ - checkUserTrust(userId: string): UserTrustLevel; - /** - * Get the verification level for a given device - * - * TODO: define this better - * - * @param userId - user to be checked - * @param deviceId - device to be checked - */ - checkDeviceTrust(userId: string, deviceId: string): DeviceTrustLevel; - /** - * Encrypt an event according to the configuration of the room. - * - * @param event - event to be sent - * - * @param room - destination room. - * - * @returns Promise which resolves when the event has been - * encrypted, or null if nothing was needed - */ - encryptEvent(event: MatrixEvent, room: Room): Promise<void>; - /** - * Decrypt a received event - * - * @returns a promise which resolves once we have finished decrypting. - * Rejects with an error if there is a problem decrypting the event. - */ - decryptEvent(event: MatrixEvent): Promise<IEventDecryptionResult>; - /** - * Get information about the encryption of an event - * - * @param event - event to be checked - */ - getEventEncryptionInfo(event: MatrixEvent): IEncryptedEventInfo; -} -/** The methods which crypto implementations should expose to the Sync api */ -export interface SyncCryptoCallbacks { - /** - * Called by the /sync loop whenever there are incoming to-device messages. - * - * The implementation may preprocess the received messages (eg, decrypt them) and return an - * updated list of messages for dispatch to the rest of the system. - * - * Note that, unlike {@link ClientEvent.ToDeviceEvent} events, this is called on the raw to-device - * messages, rather than the results of any decryption attempts. - * - * @param events - the received to-device messages - * @returns A list of preprocessed to-device messages. - */ - preprocessToDeviceMessages(events: IToDeviceEvent[]): Promise<IToDeviceEvent[]>; - /** - * Called by the /sync loop whenever there are incoming to-device messages. - * - * The implementation may preprocess the received messages (eg, decrypt them) and return an - * updated list of messages for dispatch to the rest of the system. - * - * Note that, unlike {@link ClientEvent.ToDeviceEvent} events, this is called on the raw to-device - * messages, rather than the results of any decryption attempts. - * - * @param oneTimeKeysCounts - the received one time key counts - * @returns A list of preprocessed to-device messages. - */ - preprocessOneTimeKeyCounts(oneTimeKeysCounts: Map<string, number>): Promise<void>; - /** - * Called by the /sync loop whenever there are incoming to-device messages. - * - * The implementation may preprocess the received messages (eg, decrypt them) and return an - * updated list of messages for dispatch to the rest of the system. - * - * Note that, unlike {@link ClientEvent.ToDeviceEvent} events, this is called on the raw to-device - * messages, rather than the results of any decryption attempts. - * - * @param unusedFallbackKeys - the received unused fallback keys - * @returns A list of preprocessed to-device messages. - */ - preprocessUnusedFallbackKeys(unusedFallbackKeys: Set<string>): Promise<void>; - /** - * Called by the /sync loop whenever an m.room.encryption event is received. - * - * This is called before RoomStateEvents are emitted for any of the events in the /sync - * response (even if the other events technically happened first). This works around a problem - * if the client uses a RoomStateEvent (typically a membership event) as a trigger to send a message - * in a new room (or one where encryption has been newly enabled): that would otherwise leave the - * crypto layer confused because it expects crypto to be set up, but it has not yet been. - * - * @param room - in which the event was received - * @param event - encryption event to be processed - */ - onCryptoEvent(room: Room, event: MatrixEvent): Promise<void>; - /** - * Called by the /sync loop after each /sync response is processed. - * - * Used to complete batch processing, or to initiate background processes - * - * @param syncState - information about the completed sync. - */ - onSyncCompleted(syncState: OnSyncCompletedData): void; -} -export interface OnSyncCompletedData { - /** - * The 'next_batch' result from /sync, which will become the 'since' token for the next call to /sync. - */ - nextSyncToken?: string; - /** - * True if we are working our way through a backlog of events after connecting. - */ - catchingUp?: boolean; -} -//# sourceMappingURL=CryptoBackend.d.ts.map
\ No newline at end of file |