@textrp/briij-js-sdk 41.0.0

package/lib/receipt-accumulator.js

@@ -0,0 +1,164 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { EventType } from "./@types/event.js";
+import { isSupportedReceiptType, MapWithDefault, recursiveMapToObject } from "./utils.js";
+/**
+ * Summarises the read receipts within a room. Used by the sync accumulator.
+ *
+ * Given receipts for users, picks the most recently-received one and provides
+ * the results in a new fake receipt event returned from
+ * buildAccumulatedReceiptEvent().
+ *
+ * Handles unthreaded receipts and receipts in each thread separately, so the
+ * returned event contains the most recently received unthreaded receipt, and
+ * the most recently received receipt in each thread.
+ */
+export class ReceiptAccumulator {
+  constructor() {
+    /** user_id -\> most-recently-received unthreaded receipt */
+    _defineProperty(this, "unthreadedReadReceipts", new Map());
+    /** thread_id -\> user_id -\> most-recently-received receipt for this thread */
+    _defineProperty(this, "threadedReadReceipts", new MapWithDefault(() => new Map()));
+  }
+  /**
+   * Provide an unthreaded receipt for this user. Overwrites any other
+   * unthreaded receipt we have for this user.
+   */
+  setUnthreaded(userId, receipt) {
+    this.unthreadedReadReceipts.set(userId, receipt);
+  }
+
+  /**
+   * Provide a receipt for this user in this thread. Overwrites any other
+   * receipt we have for this user in this thread.
+   */
+  setThreaded(threadId, userId, receipt) {
+    this.threadedReadReceipts.getOrCreate(threadId).set(userId, receipt);
+  }
+
+  /**
+   * @returns an iterator of pairs of [userId, AccumulatedReceipt] - all the
+   *          most recently-received unthreaded receipts for each user.
+   */
+  allUnthreaded() {
+    return this.unthreadedReadReceipts.entries();
+  }
+
+  /**
+   * @returns an iterator of pairs of [userId, AccumulatedReceipt] - all the
+   *          most recently-received threaded receipts for each user, in all
+   *          threads.
+   */
+  *allThreaded() {
+    for (var receiptsForThread of this.threadedReadReceipts.values()) {
+      for (var e of receiptsForThread.entries()) {
+        yield e;
+      }
+    }
+  }
+
+  /**
+   * Given a list of ephemeral events, find the receipts and store the
+   * relevant ones to be returned later from buildAccumulatedReceiptEvent().
+   */
+  consumeEphemeralEvents(events) {
+    events === null || events === void 0 || events.forEach(e => {
+      if (e.type !== EventType.Receipt || !e.content) {
+        // This means we'll drop unknown ephemeral events but that
+        // seems okay.
+        return;
+      }
+
+      // Handle m.receipt events. They clobber based on:
+      //   (user_id, receipt_type)
+      // but they are keyed in the event as:
+      //   content:{ $event_id: { $receipt_type: { $user_id: {json} }}}
+      // so store them in the former so we can accumulate receipt deltas
+      // quickly and efficiently (we expect a lot of them). Fold the
+      // receipt type into the key name since we only have 1 at the
+      // moment (m.read) and nested JSON objects are slower and more
+      // of a hassle to work with. We'll inflate this back out when
+      // getJSON() is called.
+      Object.keys(e.content).forEach(eventId => {
+        Object.entries(e.content[eventId]).forEach(_ref => {
+          var [key, value] = _ref;
+          if (!isSupportedReceiptType(key)) return;
+          for (var userId of Object.keys(value)) {
+            var data = e.content[eventId][key][userId];
+            var receipt = {
+              data: e.content[eventId][key][userId],
+              type: key,
+              eventId
+            };
+
+            // In a world that supports threads, read receipts normally have
+            // a `thread_id` which is either the thread they belong in or
+            // `MAIN_ROOM_TIMELINE`, so we normally use `setThreaded(...)`
+            // here. The `MAIN_ROOM_TIMELINE` is just treated as another
+            // thread.
+            //
+            // We still encounter read receipts that are "unthreaded"
+            // (missing the `thread_id` property). These come from clients
+            // that don't support threads, and from threaded clients that
+            // are doing a "Mark room as read" operation. Unthreaded
+            // receipts mark everything "before" them as read, in all
+            // threads, where "before" means in Sync Order i.e. the order
+            // the events were received from the homeserver in a sync.
+            // [Note: we have some bugs where we use timestamp order instead
+            // of Sync Order, because we don't correctly remember the Sync
+            // Order. See #3325.]
+            //
+            // Calling the wrong method will cause incorrect behavior like
+            // messages re-appearing as "new" when you already read them
+            // previously.
+            if (!data.thread_id) {
+              this.setUnthreaded(userId, receipt);
+            } else {
+              this.setThreaded(data.thread_id, userId, receipt);
+            }
+          }
+        });
+      });
+    });
+  }
+
+  /**
+   * Build a receipt event that contains all relevant information for this
+   * room, taking the most recently received receipt for each user in an
+   * unthreaded context, and in each thread.
+   */
+  buildAccumulatedReceiptEvent(roomId) {
+    var receiptEvent = {
+      type: EventType.Receipt,
+      room_id: roomId,
+      content: {
+        // $event_id: { "m.read": { $user_id: $json } }
+      }
+    };
+    var receiptEventContent = new MapWithDefault(() => new MapWithDefault(() => new Map()));
+    for (var [userId, receiptData] of this.allUnthreaded()) {
+      receiptEventContent.getOrCreate(receiptData.eventId).getOrCreate(receiptData.type).set(userId, receiptData.data);
+    }
+    for (var [_userId, _receiptData] of this.allThreaded()) {
+      receiptEventContent.getOrCreate(_receiptData.eventId).getOrCreate(_receiptData.type).set(_userId, _receiptData.data);
+    }
+    receiptEvent.content = recursiveMapToObject(receiptEventContent);
+    return receiptEventContent.size > 0 ? receiptEvent : null;
+  }
+}
+//# sourceMappingURL=receipt-accumulator.js.map

package/lib/receipt-accumulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"receipt-accumulator.js","names":["EventType","isSupportedReceiptType","MapWithDefault","recursiveMapToObject","ReceiptAccumulator","constructor","_defineProperty","Map","setUnthreaded","userId","receipt","unthreadedReadReceipts","set","setThreaded","threadId","threadedReadReceipts","getOrCreate","allUnthreaded","entries","allThreaded","receiptsForThread","values","e","consumeEphemeralEvents","events","forEach","type","Receipt","content","Object","keys","eventId","_ref","key","value","data","thread_id","buildAccumulatedReceiptEvent","roomId","receiptEvent","room_id","receiptEventContent","receiptData","size"],"sources":["../src/receipt-accumulator.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type IMinimalEvent } from \"./sync-accumulator.ts\";\r\nimport { EventType } from \"./@types/event.ts\";\r\nimport { isSupportedReceiptType, MapWithDefault, recursiveMapToObject } from \"./utils.ts\";\r\nimport { type IContent } from \"./models/event.ts\";\r\nimport { type ReceiptContent, type ReceiptType } from \"./@types/read_receipts.ts\";\r\n\r\ninterface AccumulatedReceipt {\r\n    data: IMinimalEvent;\r\n    type: ReceiptType;\r\n    eventId: string;\r\n}\r\n\r\n/**\r\n * Summarises the read receipts within a room. Used by the sync accumulator.\r\n *\r\n * Given receipts for users, picks the most recently-received one and provides\r\n * the results in a new fake receipt event returned from\r\n * buildAccumulatedReceiptEvent().\r\n *\r\n * Handles unthreaded receipts and receipts in each thread separately, so the\r\n * returned event contains the most recently received unthreaded receipt, and\r\n * the most recently received receipt in each thread.\r\n */\r\nexport class ReceiptAccumulator {\r\n    /** user_id -\\> most-recently-received unthreaded receipt */\r\n    private unthreadedReadReceipts: Map<string, AccumulatedReceipt> = new Map();\r\n\r\n    /** thread_id -\\> user_id -\\> most-recently-received receipt for this thread */\r\n    private threadedReadReceipts: MapWithDefault<string, Map<string, AccumulatedReceipt>> = new MapWithDefault(\r\n        () => new Map(),\r\n    );\r\n\r\n    /**\r\n     * Provide an unthreaded receipt for this user. Overwrites any other\r\n     * unthreaded receipt we have for this user.\r\n     */\r\n    private setUnthreaded(userId: string, receipt: AccumulatedReceipt): void {\r\n        this.unthreadedReadReceipts.set(userId, receipt);\r\n    }\r\n\r\n    /**\r\n     * Provide a receipt for this user in this thread. Overwrites any other\r\n     * receipt we have for this user in this thread.\r\n     */\r\n    private setThreaded(threadId: string, userId: string, receipt: AccumulatedReceipt): void {\r\n        this.threadedReadReceipts.getOrCreate(threadId).set(userId, receipt);\r\n    }\r\n\r\n    /**\r\n     * @returns an iterator of pairs of [userId, AccumulatedReceipt] - all the\r\n     *          most recently-received unthreaded receipts for each user.\r\n     */\r\n    private allUnthreaded(): IterableIterator<[string, AccumulatedReceipt]> {\r\n        return this.unthreadedReadReceipts.entries();\r\n    }\r\n\r\n    /**\r\n     * @returns an iterator of pairs of [userId, AccumulatedReceipt] - all the\r\n     *          most recently-received threaded receipts for each user, in all\r\n     *          threads.\r\n     */\r\n    private *allThreaded(): IterableIterator<[string, AccumulatedReceipt]> {\r\n        for (const receiptsForThread of this.threadedReadReceipts.values()) {\r\n            for (const e of receiptsForThread.entries()) {\r\n                yield e;\r\n            }\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Given a list of ephemeral events, find the receipts and store the\r\n     * relevant ones to be returned later from buildAccumulatedReceiptEvent().\r\n     */\r\n    public consumeEphemeralEvents(events: IMinimalEvent[] | undefined): void {\r\n        events?.forEach((e) => {\r\n            if (e.type !== EventType.Receipt || !e.content) {\r\n                // This means we'll drop unknown ephemeral events but that\r\n                // seems okay.\r\n                return;\r\n            }\r\n\r\n            // Handle m.receipt events. They clobber based on:\r\n            //   (user_id, receipt_type)\r\n            // but they are keyed in the event as:\r\n            //   content:{ $event_id: { $receipt_type: { $user_id: {json} }}}\r\n            // so store them in the former so we can accumulate receipt deltas\r\n            // quickly and efficiently (we expect a lot of them). Fold the\r\n            // receipt type into the key name since we only have 1 at the\r\n            // moment (m.read) and nested JSON objects are slower and more\r\n            // of a hassle to work with. We'll inflate this back out when\r\n            // getJSON() is called.\r\n            Object.keys(e.content).forEach((eventId) => {\r\n                Object.entries<ReceiptContent>(e.content[eventId]).forEach(([key, value]) => {\r\n                    if (!isSupportedReceiptType(key)) return;\r\n\r\n                    for (const userId of Object.keys(value)) {\r\n                        const data = e.content[eventId][key][userId];\r\n\r\n                        const receipt = {\r\n                            data: e.content[eventId][key][userId],\r\n                            type: key as ReceiptType,\r\n                            eventId,\r\n                        };\r\n\r\n                        // In a world that supports threads, read receipts normally have\r\n                        // a `thread_id` which is either the thread they belong in or\r\n                        // `MAIN_ROOM_TIMELINE`, so we normally use `setThreaded(...)`\r\n                        // here. The `MAIN_ROOM_TIMELINE` is just treated as another\r\n                        // thread.\r\n                        //\r\n                        // We still encounter read receipts that are \"unthreaded\"\r\n                        // (missing the `thread_id` property). These come from clients\r\n                        // that don't support threads, and from threaded clients that\r\n                        // are doing a \"Mark room as read\" operation. Unthreaded\r\n                        // receipts mark everything \"before\" them as read, in all\r\n                        // threads, where \"before\" means in Sync Order i.e. the order\r\n                        // the events were received from the homeserver in a sync.\r\n                        // [Note: we have some bugs where we use timestamp order instead\r\n                        // of Sync Order, because we don't correctly remember the Sync\r\n                        // Order. See #3325.]\r\n                        //\r\n                        // Calling the wrong method will cause incorrect behavior like\r\n                        // messages re-appearing as \"new\" when you already read them\r\n                        // previously.\r\n                        if (!data.thread_id) {\r\n                            this.setUnthreaded(userId, receipt);\r\n                        } else {\r\n                            this.setThreaded(data.thread_id, userId, receipt);\r\n                        }\r\n                    }\r\n                });\r\n            });\r\n        });\r\n    }\r\n\r\n    /**\r\n     * Build a receipt event that contains all relevant information for this\r\n     * room, taking the most recently received receipt for each user in an\r\n     * unthreaded context, and in each thread.\r\n     */\r\n    public buildAccumulatedReceiptEvent(roomId: string): IMinimalEvent | null {\r\n        const receiptEvent: IMinimalEvent = {\r\n            type: EventType.Receipt,\r\n            room_id: roomId,\r\n            content: {\r\n                // $event_id: { \"m.read\": { $user_id: $json } }\r\n            } as IContent,\r\n        };\r\n\r\n        const receiptEventContent: MapWithDefault<\r\n            string,\r\n            MapWithDefault<ReceiptType, Map<string, object>>\r\n        > = new MapWithDefault(() => new MapWithDefault(() => new Map()));\r\n\r\n        for (const [userId, receiptData] of this.allUnthreaded()) {\r\n            receiptEventContent\r\n                .getOrCreate(receiptData.eventId)\r\n                .getOrCreate(receiptData.type)\r\n                .set(userId, receiptData.data);\r\n        }\r\n\r\n        for (const [userId, receiptData] of this.allThreaded()) {\r\n            receiptEventContent\r\n                .getOrCreate(receiptData.eventId)\r\n                .getOrCreate(receiptData.type)\r\n                .set(userId, receiptData.data);\r\n        }\r\n\r\n        receiptEvent.content = recursiveMapToObject(receiptEventContent);\r\n\r\n        return receiptEventContent.size > 0 ? receiptEvent : null;\r\n    }\r\n}\r\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,SAAS,QAAQ,mBAAmB;AAC7C,SAASC,sBAAsB,EAAEC,cAAc,EAAEC,oBAAoB,QAAQ,YAAY;AAUzF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,kBAAkB,CAAC;EAAAC,YAAA;IAC5B;IAAAC,eAAA,iCACkE,IAAIC,GAAG,CAAC,CAAC;IAE3E;IAAAD,eAAA,+BACwF,IAAIJ,cAAc,CACtG,MAAM,IAAIK,GAAG,CAAC,CAClB,CAAC;EAAA;EAED;AACJ;AACA;AACA;EACYC,aAAaA,CAACC,MAAc,EAAEC,OAA2B,EAAQ;IACrE,IAAI,CAACC,sBAAsB,CAACC,GAAG,CAACH,MAAM,EAAEC,OAAO,CAAC;EACpD;;EAEA;AACJ;AACA;AACA;EACYG,WAAWA,CAACC,QAAgB,EAAEL,MAAc,EAAEC,OAA2B,EAAQ;IACrF,IAAI,CAACK,oBAAoB,CAACC,WAAW,CAACF,QAAQ,CAAC,CAACF,GAAG,CAACH,MAAM,EAAEC,OAAO,CAAC;EACxE;;EAEA;AACJ;AACA;AACA;EACYO,aAAaA,CAAA,EAAmD;IACpE,OAAO,IAAI,CAACN,sBAAsB,CAACO,OAAO,CAAC,CAAC;EAChD;;EAEA;AACJ;AACA;AACA;AACA;EACI,CAASC,WAAWA,CAAA,EAAmD;IACnE,KAAK,IAAMC,iBAAiB,IAAI,IAAI,CAACL,oBAAoB,CAACM,MAAM,CAAC,CAAC,EAAE;MAChE,KAAK,IAAMC,CAAC,IAAIF,iBAAiB,CAACF,OAAO,CAAC,CAAC,EAAE;QACzC,MAAMI,CAAC;MACX;IACJ;EACJ;;EAEA;AACJ;AACA;AACA;EACWC,sBAAsBA,CAACC,MAAmC,EAAQ;IACrEA,MAAM,aAANA,MAAM,eAANA,MAAM,CAAEC,OAAO,CAAEH,CAAC,IAAK;MACnB,IAAIA,CAAC,CAACI,IAAI,KAAK1B,SAAS,CAAC2B,OAAO,IAAI,CAACL,CAAC,CAACM,OAAO,EAAE;QAC5C;QACA;QACA;MACJ;;MAEA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACAC,MAAM,CAACC,IAAI,CAACR,CAAC,CAACM,OAAO,CAAC,CAACH,OAAO,CAAEM,OAAO,IAAK;QACxCF,MAAM,CAACX,OAAO,CAAiBI,CAAC,CAACM,OAAO,CAACG,OAAO,CAAC,CAAC,CAACN,OAAO,CAACO,IAAA,IAAkB;UAAA,IAAjB,CAACC,GAAG,EAAEC,KAAK,CAAC,GAAAF,IAAA;UACpE,IAAI,CAAC/B,sBAAsB,CAACgC,GAAG,CAAC,EAAE;UAElC,KAAK,IAAMxB,MAAM,IAAIoB,MAAM,CAACC,IAAI,CAACI,KAAK,CAAC,EAAE;YACrC,IAAMC,IAAI,GAAGb,CAAC,CAACM,OAAO,CAACG,OAAO,CAAC,CAACE,GAAG,CAAC,CAACxB,MAAM,CAAC;YAE5C,IAAMC,OAAO,GAAG;cACZyB,IAAI,EAAEb,CAAC,CAACM,OAAO,CAACG,OAAO,CAAC,CAACE,GAAG,CAAC,CAACxB,MAAM,CAAC;cACrCiB,IAAI,EAAEO,GAAkB;cACxBF;YACJ,CAAC;;YAED;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA,IAAI,CAACI,IAAI,CAACC,SAAS,EAAE;cACjB,IAAI,CAAC5B,aAAa,CAACC,MAAM,EAAEC,OAAO,CAAC;YACvC,CAAC,MAAM;cACH,IAAI,CAACG,WAAW,CAACsB,IAAI,CAACC,SAAS,EAAE3B,MAAM,EAAEC,OAAO,CAAC;YACrD;UACJ;QACJ,CAAC,CAAC;MACN,CAAC,CAAC;IACN,CAAC,CAAC;EACN;;EAEA;AACJ;AACA;AACA;AACA;EACW2B,4BAA4BA,CAACC,MAAc,EAAwB;IACtE,IAAMC,YAA2B,GAAG;MAChCb,IAAI,EAAE1B,SAAS,CAAC2B,OAAO;MACvBa,OAAO,EAAEF,MAAM;MACfV,OAAO,EAAE;QACL;MAAA;IAER,CAAC;IAED,IAAMa,mBAGL,GAAG,IAAIvC,cAAc,CAAC,MAAM,IAAIA,cAAc,CAAC,MAAM,IAAIK,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjE,KAAK,IAAM,CAACE,MAAM,EAAEiC,WAAW,CAAC,IAAI,IAAI,CAACzB,aAAa,CAAC,CAAC,EAAE;MACtDwB,mBAAmB,CACdzB,WAAW,CAAC0B,WAAW,CAACX,OAAO,CAAC,CAChCf,WAAW,CAAC0B,WAAW,CAAChB,IAAI,CAAC,CAC7Bd,GAAG,CAACH,MAAM,EAAEiC,WAAW,CAACP,IAAI,CAAC;IACtC;IAEA,KAAK,IAAM,CAAC1B,OAAM,EAAEiC,YAAW,CAAC,IAAI,IAAI,CAACvB,WAAW,CAAC,CAAC,EAAE;MACpDsB,mBAAmB,CACdzB,WAAW,CAAC0B,YAAW,CAACX,OAAO,CAAC,CAChCf,WAAW,CAAC0B,YAAW,CAAChB,IAAI,CAAC,CAC7Bd,GAAG,CAACH,OAAM,EAAEiC,YAAW,CAACP,IAAI,CAAC;IACtC;IAEAI,YAAY,CAACX,OAAO,GAAGzB,oBAAoB,CAACsC,mBAAmB,CAAC;IAEhE,OAAOA,mBAAmB,CAACE,IAAI,GAAG,CAAC,GAAGJ,YAAY,GAAG,IAAI;EAC7D;AACJ","ignoreList":[]}

package/lib/rendezvous/MSC4108SignInWithQR.d.ts

@@ -0,0 +1,112 @@
+import { ClientRendezvousFailureReason, MSC4108FailureReason, type RendezvousFailureListener } from "./index.ts";
+import { type BriijClient } from "../client.ts";
+import { type MSC4108SecureChannel } from "./channels/MSC4108SecureChannel.ts";
+import { type CryptoApi } from "../crypto-api/index.ts";
+/**
+ * Enum representing the payload types transmissible over [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * secure channels.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export declare enum PayloadType {
+    Protocols = "m.login.protocols",
+    Protocol = "m.login.protocol",
+    Failure = "m.login.failure",
+    Success = "m.login.success",
+    Secrets = "m.login.secrets",
+    ProtocolAccepted = "m.login.protocol_accepted",
+    Declined = "m.login.declined"
+}
+/**
+ * Type representing the base payload format for [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * messages sent over the secure channel.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export interface MSC4108Payload {
+    type: PayloadType;
+}
+interface SecretsPayload extends MSC4108Payload, Awaited<ReturnType<NonNullable<CryptoApi["exportSecretsBundle"]>>> {
+    type: PayloadType.Secrets;
+}
+/**
+ * Prototype of the unstable [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * sign in with QR + OIDC flow.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export declare class MSC4108SignInWithQR {
+    private readonly channel;
+    private readonly didScanCode;
+    private readonly client?;
+    onFailure?: RendezvousFailureListener | undefined;
+    private readonly ourIntent;
+    private _code?;
+    private expectingNewDeviceId?;
+    /**
+     * Returns the check code for the secure channel or undefined if not generated yet.
+     */
+    get checkCode(): string | undefined;
+    /**
+     * @param channel - The secure channel used for communication
+     * @param client - The Matrix client in used on the device already logged in
+     * @param didScanCode - Whether this side of the channel scanned the QR code from the other party
+     * @param onFailure - Callback for when the rendezvous fails
+     */
+    constructor(channel: MSC4108SecureChannel, didScanCode: boolean, client?: BriijClient | undefined, onFailure?: RendezvousFailureListener | undefined);
+    /**
+     * Returns the code representing the rendezvous suitable for rendering in a QR code or undefined if not generated yet.
+     */
+    get code(): Uint8Array | undefined;
+    /**
+     * Generate the code including doing partial set up of the channel where required.
+     */
+    generateCode(): Promise<void>;
+    /**
+     * Returns true if the device is the already logged in device reciprocating a new login on the other side of the channel.
+     */
+    get isExistingDevice(): boolean;
+    /**
+     * Returns true if the device is the new device logging in being reciprocated by the device on the other side of the channel.
+     */
+    get isNewDevice(): boolean;
+    /**
+     * The first step in the OIDC QR login process.
+     * To be called after the QR code has been rendered or scanned.
+     * The scanning device has to discover the homeserver details, if they scanned the code then they already have it.
+     * If the new device is the one rendering the QR code then it has to wait be sent the homeserver details via the rendezvous channel.
+     */
+    negotiateProtocols(): Promise<{
+        serverName?: string;
+    }>;
+    /**
+     * The second & third step in the OIDC QR login process.
+     * To be called after `negotiateProtocols` for the existing device.
+     * To be called after OIDC negotiation for the new device. (Currently unsupported)
+     */
+    deviceAuthorizationGrant(): Promise<{
+        verificationUri?: string;
+        userCode?: string;
+    }>;
+    /**
+     * The fifth (and final) step in the OIDC QR login process.
+     * To be called after the new device has completed authentication.
+     */
+    shareSecrets(): Promise<{
+        secrets?: Omit<SecretsPayload, "type">;
+    }>;
+    private receive;
+    private send;
+    /**
+     * Decline the login on the existing device.
+     */
+    declineLoginOnExistingDevice(): Promise<void>;
+    /**
+     * Cancels the rendezvous session.
+     * @param reason the reason for the cancellation
+     */
+    cancel(reason: MSC4108FailureReason | ClientRendezvousFailureReason): Promise<void>;
+    /**
+     * Closes the rendezvous session.
+     */
+    close(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=MSC4108SignInWithQR.d.ts.map

package/lib/rendezvous/MSC4108SignInWithQR.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSC4108SignInWithQR.d.ts","sourceRoot":"","sources":["../../src/rendezvous/MSC4108SignInWithQR.ts"],"names":[],"mappings":"AAkBA,OAAO,EACH,6BAA6B,EAC7B,oBAAoB,EAEpB,KAAK,yBAAyB,EACjC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAI/E,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,oBAAY,WAAW;IACnB,SAAS,sBAAsB;IAC/B,QAAQ,qBAAqB;IAC7B,OAAO,oBAAoB;IAC3B,OAAO,oBAAoB;IAC3B,OAAO,oBAAoB;IAC3B,gBAAgB,8BAA8B;IAC9C,QAAQ,qBAAqB;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,WAAW,CAAC;CACrB;AA8CD,UAAU,cAAe,SAAQ,cAAc,EAAE,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC/G,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,mBAAmB;IAmBxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,yBAAyB;IArBhD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,KAAK,CAAC,CAAa;IAC3B,OAAO,CAAC,oBAAoB,CAAC,CAAS;IAEtC;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED;;;;;OAKG;gBAEkB,OAAO,EAAE,oBAAoB,EAC7B,WAAW,EAAE,OAAO,EACpB,MAAM,CAAC,EAAE,WAAW,YAAA,EAC9B,SAAS,CAAC,EAAE,yBAAyB,YAAA;IAKhD;;OAEG;IACH,IAAW,IAAI,IAAI,UAAU,GAAG,SAAS,CAExC;IAED;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAY1C;;OAEG;IACH,IAAW,gBAAgB,IAAI,OAAO,CAErC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED;;;;;OAKG;IACU,kBAAkB,IAAI,OAAO,CAAC;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA8DnE;;;;OAIG;IACU,wBAAwB,IAAI,OAAO,CAAC;QAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IAiEF;;;OAGG;IACU,YAAY,IAAI,OAAO,CAAC;QAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;YAyFlE,OAAO;YAIP,IAAI;IAIlB;;OAEG;IACU,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;IAU1D;;;OAGG;IACU,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhG;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGtC"}