From 9819ca1a9813d176af96c7092a8c4f0c276d5958 Mon Sep 17 00:00:00 2001
From: Valere <bill.carson@valrsoft.com>
Date: Mon, 30 Jun 2025 15:23:50 +0200
Subject: [PATCH] quick update docs and renaming

---
 src/sliding-sync-sdk.ts |  8 ++++----
 src/sync.ts             | 12 +++++++-----
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/sliding-sync-sdk.ts b/src/sliding-sync-sdk.ts
index c514061c3..8c7d76558 100644
--- a/src/sliding-sync-sdk.ts
+++ b/src/sliding-sync-sdk.ts
@@ -152,11 +152,11 @@ class ExtensionToDevice implements Extension<ExtensionToDeviceRequest, Extension
 
     public async onResponse(data: ExtensionToDeviceResponse): Promise<void> {
         const events = data["events"] || [];
-        let processedEvents: ReceivedToDeviceMessage[];
+        let receivedToDeviceMessages: ReceivedToDeviceMessage[];
         if (this.cryptoCallbacks) {
-            processedEvents = await this.cryptoCallbacks.preprocessToDeviceMessages(events);
+            receivedToDeviceMessages = await this.cryptoCallbacks.preprocessToDeviceMessages(events);
         } else {
-            processedEvents = events
+            receivedToDeviceMessages = events
                 .filter((e) => e.type !== EventType.RoomMessageEncrypted)
                 .map((clearEvent) => {
                     // Crypto is not enabled, so we just return the clear events.
@@ -166,7 +166,7 @@ class ExtensionToDevice implements Extension<ExtensionToDeviceRequest, Extension
                     };
                 });
         }
-        processToDeviceMessages(processedEvents, this.client);
+        processToDeviceMessages(receivedToDeviceMessages, this.client);
 
         this.nextBatch = data.next_batch;
     }
diff --git a/src/sync.ts b/src/sync.ts
index 73c931e11..86e1cc594 100644
--- a/src/sync.ts
+++ b/src/sync.ts
@@ -1147,11 +1147,12 @@ export class SyncApi {
         if (data.to_device && Array.isArray(data.to_device.events) && data.to_device.events.length > 0) {
             const toDeviceMessages: IToDeviceEvent[] = data.to_device.events.filter(noUnsafeEventProps);
 
-            let processedEvents: ReceivedToDeviceMessage[];
+            let receivedToDeviceMessages: ReceivedToDeviceMessage[];
             if (this.syncOpts.cryptoCallbacks) {
-                processedEvents = await this.syncOpts.cryptoCallbacks.preprocessToDeviceMessages(toDeviceMessages);
+                receivedToDeviceMessages =
+                    await this.syncOpts.cryptoCallbacks.preprocessToDeviceMessages(toDeviceMessages);
             } else {
-                processedEvents = toDeviceMessages
+                receivedToDeviceMessages = toDeviceMessages
                     .filter((e) => e.type !== EventType.RoomMessageEncrypted)
                     .map((clearEvent) => {
                         // Crypto is not enabled, so we just return the clear events.
@@ -1162,7 +1163,7 @@ export class SyncApi {
                     });
             }
 
-            processToDeviceMessages(processedEvents, client);
+            processToDeviceMessages(receivedToDeviceMessages, client);
         } else {
             // no more to-device events: we can stop polling with a short timeout.
             this.catchingUp = false;
@@ -1921,7 +1922,8 @@ export function _createAndReEmitRoom(client: MatrixClient, roomId: string, opts:
 /**
  * Process a list of (decrypted, where possible) received to-device events.
  *
- * Converts the events into `MatrixEvent`s, and emits appropriate {@link ClientEvent.ToDeviceEvent} events.
+ * Converts the to-device message and OlmEncryptionIngo and emits appropriate {@link ClientEvent.ReceivedToDeviceMessage} events.
+ * Converts the events into `MatrixEvent`s, and emits the now deprecated {@link ClientEvent.ToDeviceEvent} events for compatibility.
  * */
 export function processToDeviceMessages(toDeviceMessages: ReceivedToDeviceMessage[], client: MatrixClient): void {
     const cancelledKeyVerificationTxns: string[] = [];