@textrp/briij-js-sdk 41.0.0

package/lib/models/room.js

@@ -0,0 +1,3548 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2015 - 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 { M_POLL_START } from "matrix-events-sdk";
+import { DuplicateStrategy, EventTimelineSet } from "./event-timeline-set.js";
+import { Direction, EventTimeline } from "./event-timeline.js";
+import { getHttpUriForMxc } from "../content-repo.js";
+import * as utils from "../utils.js";
+import { normalize, noUnsafeEventProps, removeElement } from "../utils.js";
+import { BriijEvent, BriijEventEvent } from "./event.js";
+import { EventStatus } from "./event-status.js";
+import { RoomMember } from "./room-member.js";
+import { RoomSummary } from "./room-summary.js";
+import { logger } from "../logger.js";
+import { TypedReEmitter } from "../ReEmitter.js";
+import { EVENT_VISIBILITY_CHANGE_TYPE, EventType, RelationType, RoomCreateTypeField, RoomType, UNSIGNED_THREAD_ID_FIELD, UNSTABLE_ELEMENT_FUNCTIONAL_USERS } from "../@types/event.js";
+import { PendingEventOrdering } from "../client.js";
+import { Filter } from "../filter.js";
+import { RoomStateEvent } from "./room-state.js";
+import { BeaconEvent } from "./beacon.js";
+import { FILTER_RELATED_BY_REL_TYPES, FILTER_RELATED_BY_SENDERS, Thread, THREAD_RELATION_TYPE, ThreadEvent, ThreadFilterType } from "./thread.js";
+import { MAIN_ROOM_TIMELINE, ReceiptType } from "../@types/read_receipts.js";
+import { RelationsContainer } from "./relations-container.js";
+import { ReadReceipt, synthesizeReceipt } from "./read-receipt.js";
+import { isPollEvent, Poll, PollEvent } from "./poll.js";
+import { RoomReceipts } from "./room-receipts.js";
+import { compareEventOrdering } from "./compare-event-ordering.js";
+import { KnownMembership } from "../@types/membership.js";
+import { RoomVersionStability } from "../serverCapabilities.js";
+import { RoomStickyEventsStore, RoomStickyEventsEvent } from "./room-sticky-events.js";
+
+// These constants are used as sane defaults when the homeserver doesn't support
+// the m.room_versions capability. In practice, KNOWN_SAFE_ROOM_VERSION should be
+// the same as the common default room version whereas SAFE_ROOM_VERSIONS are the
+// room versions which are considered okay for people to run without being asked
+// to upgrade (ie: "stable"). Eventually, we should remove these when all homeservers
+// return an m.room_versions capability.
+export var KNOWN_SAFE_ROOM_VERSION = "10";
+var SAFE_ROOM_VERSIONS = ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10"];
+// When inserting a visibility event affecting event `eventId`, we
+// need to scan through existing visibility events for `eventId`.
+// In theory, this could take an unlimited amount of time if:
+//
+// - the visibility event was sent by a moderator; and
+// - `eventId` already has many visibility changes (usually, it should
+//   be 2 or less); and
+// - for some reason, the visibility changes are received out of order
+//   (usually, this shouldn't happen at all).
+//
+// For this reason, we limit the number of events to scan through,
+// expecting that a broken visibility change for a single event in
+// an extremely uncommon case (possibly a DoS) is a small
+// price to pay to keep matrix-js-sdk responsive.
+var MAX_NUMBER_OF_VISIBILITY_EVENTS_TO_SCAN_THROUGH = 30;
+export var NotificationCountType = /*#__PURE__*/function (NotificationCountType) {
+  NotificationCountType["Highlight"] = "highlight";
+  NotificationCountType["Total"] = "total";
+  return NotificationCountType;
+}({});
+export var RoomEvent = /*#__PURE__*/function (RoomEvent) {
+  RoomEvent["MyMembership"] = "Room.myMembership";
+  RoomEvent["Tags"] = "Room.tags";
+  RoomEvent["AccountData"] = "Room.accountData";
+  RoomEvent["Receipt"] = "Room.receipt";
+  RoomEvent["Name"] = "Room.name";
+  RoomEvent["Redaction"] = "Room.redaction";
+  RoomEvent["RedactionCancelled"] = "Room.redactionCancelled";
+  RoomEvent["LocalEchoUpdated"] = "Room.localEchoUpdated";
+  RoomEvent["Timeline"] = "Room.timeline";
+  RoomEvent["TimelineReset"] = "Room.timelineReset";
+  RoomEvent["TimelineRefresh"] = "Room.TimelineRefresh";
+  RoomEvent["OldStateUpdated"] = "Room.OldStateUpdated";
+  RoomEvent["CurrentStateUpdated"] = "Room.CurrentStateUpdated";
+  RoomEvent["HistoryImportedWithinTimeline"] = "Room.historyImportedWithinTimeline";
+  RoomEvent["UnreadNotifications"] = "Room.UnreadNotifications";
+  RoomEvent["Summary"] = "Room.Summary";
+  return RoomEvent;
+}({});
+export class Room extends ReadReceipt {
+  /**
+   * Construct a new Room.
+   *
+   * <p>For a room, we store an ordered sequence of timelines, which may or may not
+   * be continuous. Each timeline lists a series of events, as well as tracking
+   * the room state at the start and the end of the timeline. It also tracks
+   * forward and backward pagination tokens, as well as containing links to the
+   * next timeline in the sequence.
+   *
+   * <p>There is one special timeline - the 'live' timeline, which represents the
+   * timeline to which events are being added in real-time as they are received
+   * from the /sync API. Note that you should not retain references to this
+   * timeline - even if it is the current timeline right now, it may not remain
+   * so if the server gives us a timeline gap in /sync.
+   *
+   * <p>In order that we can find events from their ids later, we also maintain a
+   * map from event_id to timeline and index.
+   *
+   * @param roomId - Required. The ID of this room.
+   * @param client - Required. The client, used to lazy load members.
+   * @param myUserId - Required. The ID of the syncing user.
+   * @param opts - Configuration options
+   */
+  constructor(roomId, client, myUserId) {
+    var _this;
+    var opts = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+    // In some cases, we add listeners for every displayed Matrix event, so it's
+    // common to have quite a few more than the default limit.
+    super();
+    _this = this;
+    this.roomId = roomId;
+    this.client = client;
+    this.myUserId = myUserId;
+    this.opts = opts;
+    _defineProperty(this, "reEmitter", void 0);
+    _defineProperty(this, "txnToEvent", new Map());
+    // Pending in-flight requests { string: BriijEvent }
+    _defineProperty(this, "notificationCounts", {});
+    _defineProperty(this, "bumpStamp", undefined);
+    _defineProperty(this, "threadNotifications", new Map());
+    _defineProperty(this, "cachedThreadReadReceipts", new Map());
+    // Useful to know at what point the current user has started using threads in this room
+    _defineProperty(this, "oldestThreadedReceiptTs", Infinity);
+    /**
+     * A record of the latest unthread receipts per user
+     * This is useful in determining whether a user has read a thread or not
+     */
+    _defineProperty(this, "unthreadedReceipts", new Map());
+    _defineProperty(this, "timelineSets", void 0);
+    _defineProperty(this, "polls", new Map());
+    /**
+     * Empty array if the timeline sets have not been initialised. After initialisation:
+     * 0: All threads
+     * 1: Threads the current user has participated in
+     */
+    _defineProperty(this, "threadsTimelineSets", []);
+    // any filtered timeline sets we're maintaining for this room
+    _defineProperty(this, "filteredTimelineSets", {});
+    // filter_id: timelineSet
+    _defineProperty(this, "timelineNeedsRefresh", false);
+    _defineProperty(this, "pendingEventList", void 0);
+    // read by megolm via getter; boolean value - null indicates "use global value"
+    _defineProperty(this, "blacklistUnverifiedDevices", void 0);
+    _defineProperty(this, "selfMembership", void 0);
+    /**
+     * A `Hero` is a stripped `m.room.member` event which contains the important renderable fields from the event.
+     *
+     * It is used in MSC4186 (Simplified Sliding Sync) as a replacement for the old `summary` field.
+     *
+     * When we are doing old-style (`/v3/sync`) sync, we simulate the SSS behaviour by constructing
+     * a `Hero` object based on the user id we get from the summary. Obviously, in that case,
+     * the `Hero` will lack a `displayName` or `avatarUrl`.
+     */
+    _defineProperty(this, "heroes", null);
+    // flags to stop logspam about missing m.room.create events
+    _defineProperty(this, "getTypeWarning", false);
+    _defineProperty(this, "membersPromise", void 0);
+    // XXX: These should be read-only
+    /**
+     * The human-readable display name for this room.
+     */
+    _defineProperty(this, "name", void 0);
+    /**
+     * The un-homoglyphed name for this room.
+     */
+    _defineProperty(this, "normalizedName", void 0);
+    /**
+     * Dict of room tags; the keys are the tag name and the values
+     * are any metadata associated with the tag - e.g. `{ "fav" : { order: 1 } }`
+     */
+    _defineProperty(this, "tags", {});
+    // $tagName: { $metadata: $value }
+    /**
+     * accountData Dict of per-room account_data events; the keys are the
+     * event type and the values are the events.
+     */
+    _defineProperty(this, "accountData", new Map());
+    // $eventType: $event
+    /**
+     * The room summary.
+     */
+    _defineProperty(this, "summary", null);
+    /**
+     * oldState The state of the room at the time of the oldest event in the live timeline.
+     *
+     * @deprecated Present for backwards compatibility.
+     *             Use getLiveTimeline().getState(EventTimeline.BACKWARDS) instead
+     */
+    _defineProperty(this, "oldState", void 0);
+    /**
+     * currentState The state of the room at the time of the newest event in the timeline.
+     *
+     * @deprecated Present for backwards compatibility.
+     *             Use getLiveTimeline().getState(EventTimeline.FORWARDS) instead.
+     */
+    _defineProperty(this, "currentState", void 0);
+    _defineProperty(this, "relations", void 0);
+    /**
+     * A collection of events known by the client
+     * This is not a comprehensive list of the threads that exist in this room
+     */
+    _defineProperty(this, "threads", new Map());
+    /**
+     * A mapping of eventId to all visibility changes to apply
+     * to the event, by chronological order, as per
+     * https://github.com/matrix-org/matrix-doc/pull/3531
+     *
+     * # Invariants
+     *
+     * - within each list, all events are classed by
+     *   chronological order;
+     * - all events are events such that
+     *  `asVisibilityEvent()` returns a non-null `IVisibilityChange`;
+     * - within each list with key `eventId`, all events
+     *   are in relation to `eventId`.
+     *
+     * @experimental
+     */
+    _defineProperty(this, "visibilityEvents", new Map());
+    /**
+     * The latest receipts (synthetic and real) for each user in each thread
+     * (and unthreaded).
+     */
+    _defineProperty(this, "roomReceipts", new RoomReceipts(this));
+    /**
+     * Stores and tracks sticky events
+     */
+    _defineProperty(this, "stickyEvents", new RoomStickyEventsStore());
+    _defineProperty(this, "threadTimelineSetsPromise", null);
+    _defineProperty(this, "threadsReady", false);
+    _defineProperty(this, "updateThreadRootEvents", (thread, toStartOfTimeline, recreateEvent) => {
+      if (thread.length) {
+        var _this$threadsTimeline;
+        this.updateThreadRootEvent((_this$threadsTimeline = this.threadsTimelineSets) === null || _this$threadsTimeline === void 0 ? void 0 : _this$threadsTimeline[0], thread, toStartOfTimeline, recreateEvent);
+        if (thread.hasCurrentUserParticipated) {
+          var _this$threadsTimeline2;
+          this.updateThreadRootEvent((_this$threadsTimeline2 = this.threadsTimelineSets) === null || _this$threadsTimeline2 === void 0 ? void 0 : _this$threadsTimeline2[1], thread, toStartOfTimeline, recreateEvent);
+        }
+      }
+    });
+    _defineProperty(this, "updateThreadRootEvent", (timelineSet, thread, toStartOfTimeline, recreateEvent) => {
+      if (timelineSet && thread.rootEvent) {
+        if (recreateEvent) {
+          timelineSet.removeEvent(thread.id);
+        }
+        if (Thread.hasServerSideSupport) {
+          timelineSet.addLiveEvent(thread.rootEvent, {
+            duplicateStrategy: DuplicateStrategy.Replace,
+            fromCache: false,
+            roomState: this.currentState,
+            addToState: false
+          });
+        } else {
+          timelineSet.addEventToTimeline(thread.rootEvent, timelineSet.getLiveTimeline(), {
+            toStartOfTimeline,
+            addToState: false
+          });
+        }
+      }
+    });
+    _defineProperty(this, "tryApplyRedaction", event => {
+      // FIXME: apply redactions to notification list
+
+      // NB: We continue to add the redaction event to the timeline at the
+      // end of this function so clients can say "so and so redacted an event"
+      // if they wish to. Also this may be needed to trigger an update.
+
+      if (event.isRedaction()) {
+        var redactId = event.event.redacts;
+
+        // if we know about this event, redact its contents now.
+        var redactedEvent = redactId ? this.findEventById(redactId) : undefined;
+        if (redactId) {
+          try {
+            this.stickyEvents.handleRedaction(redactedEvent || redactId);
+          } catch (ex) {
+            // Non-critical failure, but we should warn.
+            logger.error("Failed to handle redaction for sticky event", ex);
+          }
+        }
+        if (redactedEvent) {
+          this.applyEventAsRedaction(event, redactedEvent);
+        }
+      } else if (event.getType() === EventType.RoomMember) {
+        var membership = event.getContent()["membership"];
+        if (membership !== KnownMembership.Ban && !(membership === KnownMembership.Leave && event.getStateKey() !== event.getSender())) {
+          // Not a ban or kick, therefore not a membership event we care about here.
+          return;
+        }
+        var redactEvents = event.getContent()["org.matrix.msc4293.redact_events"];
+        if (redactEvents !== true) {
+          // Invalid or not set - nothing to redact.
+          return;
+        }
+        var state = this.getLiveTimeline().getState(Direction.Forward);
+        if (!state.maySendRedactionForEvent(event, event.getSender())) {
+          // If the sender can't redact the membership event, then they won't be able to
+          // redact any of the target's events either, so skip.
+          return;
+        }
+
+        // The redaction is possible, so let's find all the events and apply it.
+        var events = this.getTimelineSets().map(s => s.getTimelines()).reduce((p, c) => {
+          p.push(...c);
+          return p;
+        }, []).map(t => t.getEvents().filter(e => e.getSender() === event.getStateKey())).reduce((p, c) => {
+          p.push(...c);
+          return c;
+        }, []);
+        for (var toRedact of events) {
+          this.applyEventAsRedaction(event, toRedact);
+        }
+      }
+    });
+    this.setMaxListeners(100);
+    this.reEmitter = new TypedReEmitter(this);
+    opts.pendingEventOrdering = opts.pendingEventOrdering || PendingEventOrdering.Chronological;
+    this.name = roomId;
+    this.normalizedName = roomId;
+    this.relations = new RelationsContainer(this.client, this);
+
+    // Listen to our own receipt event as a more modular way of processing our own
+    // receipts. No need to remove the listener: it's on ourself anyway.
+    this.on(RoomEvent.Receipt, this.onReceipt);
+    this.reEmitter.reEmit(this.stickyEvents, [RoomStickyEventsEvent.Update]);
+
+    // all our per-room timeline sets. the first one is the unfiltered ones;
+    // the subsequent ones are the filtered ones in no particular order.
+    this.timelineSets = [new EventTimelineSet(this, opts)];
+    this.reEmitter.reEmit(this.getUnfilteredTimelineSet(), [RoomEvent.Timeline, RoomEvent.TimelineReset]);
+    this.fixUpLegacyTimelineFields();
+    if (this.opts.pendingEventOrdering === PendingEventOrdering.Detached) {
+      this.pendingEventList = [];
+      this.client.store.getPendingEvents(this.roomId).then(events => {
+        var mapper = this.client.getEventMapper({
+          decrypt: false
+        });
+        events.forEach(/*#__PURE__*/function () {
+          var _ref = _asyncToGenerator(function* (serializedEvent) {
+            var event = mapper(serializedEvent);
+            yield client.decryptEventIfNeeded(event);
+            event.setStatus(EventStatus.NOT_SENT);
+            _this.addPendingEvent(event, event.getTxnId());
+          });
+          return function (_x) {
+            return _ref.apply(this, arguments);
+          };
+        }());
+      });
+    }
+
+    // awaited by getEncryptionTargetMembers while room members are loading
+    if (!this.opts.lazyLoadMembers) {
+      this.membersPromise = Promise.resolve(false);
+    } else {
+      this.membersPromise = undefined;
+    }
+  }
+  createThreadsTimelineSets() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      var _this2$client;
+      if (_this2.threadTimelineSetsPromise) {
+        return _this2.threadTimelineSetsPromise;
+      }
+      if ((_this2$client = _this2.client) !== null && _this2$client !== void 0 && _this2$client.supportsThreads()) {
+        try {
+          _this2.threadTimelineSetsPromise = Promise.all([_this2.createThreadTimelineSet(), _this2.createThreadTimelineSet(ThreadFilterType.My)]);
+          var timelineSets = yield _this2.threadTimelineSetsPromise;
+          _this2.threadsTimelineSets[0] = timelineSets[0];
+          _this2.threadsTimelineSets[1] = timelineSets[1];
+          return timelineSets;
+        } catch (_unused) {
+          _this2.threadTimelineSetsPromise = null;
+          return null;
+        }
+      }
+      return null;
+    })();
+  }
+
+  /**
+   * Bulk decrypt critical events in a room
+   *
+   * Critical events represents the minimal set of events to decrypt
+   * for a typical UI to function properly
+   *
+   * - Last event of every room (to generate likely message preview)
+   * - All events up to the read receipt (to calculate an accurate notification count)
+   *
+   * @returns Signals when all events have been decrypted
+   */
+  decryptCriticalEvents() {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this3.client.getCrypto()) return;
+      var readReceiptEventId = _this3.getEventReadUpTo(_this3.client.getUserId(), true);
+      var events = _this3.getLiveTimeline().getEvents();
+      var readReceiptTimelineIndex = events.findIndex(matrixEvent => {
+        return matrixEvent.event.event_id === readReceiptEventId;
+      });
+      var decryptionPromises = events.slice(readReceiptTimelineIndex).reverse().map(event => _this3.client.decryptEventIfNeeded(event));
+      yield Promise.allSettled(decryptionPromises);
+    })();
+  }
+
+  /**
+   * Bulk decrypt events in a room
+   *
+   * @returns Signals when all events have been decrypted
+   */
+  decryptAllEvents() {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this4.client.getCrypto()) return;
+      var decryptionPromises = _this4.getUnfilteredTimelineSet().getLiveTimeline().getEvents().slice(0) // copy before reversing
+      .reverse().map(event => _this4.client.decryptEventIfNeeded(event));
+      yield Promise.allSettled(decryptionPromises);
+    })();
+  }
+
+  /**
+   * Gets the creator of the room
+   * @returns The creator of the room, or null if it could not be determined
+   */
+  getCreator() {
+    var _createEvent$getSende;
+    var createEvent = this.currentState.getStateEvents(EventType.RoomCreate, "");
+    return (_createEvent$getSende = createEvent === null || createEvent === void 0 ? void 0 : createEvent.getSender()) !== null && _createEvent$getSende !== void 0 ? _createEvent$getSende : null;
+  }
+
+  /**
+   * Gets the version of the room
+   * @returns The version of the room
+   */
+  getVersion() {
+    return this.currentState.getRoomVersion();
+  }
+
+  /**
+   * Determines the recommended room version for the room. This returns an
+   * object with 3 properties: `version` as the new version the
+   * room should be upgraded to (may be the same as the current version);
+   * `needsUpgrade` to indicate if the room actually can be
+   * upgraded (ie: does the current version not match?); and `urgent`
+   * to indicate if the new version patches a vulnerability in a previous
+   * version.
+   * @returns
+   * Resolves to the version the room should be upgraded to.
+   */
+  getRecommendedVersion() {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      var capabilities = {};
+      try {
+        capabilities = yield _this5.client.getCapabilities();
+      } catch (_unused2) {}
+      var versionCap = capabilities["m.room_versions"];
+      if (!versionCap) {
+        versionCap = {
+          default: KNOWN_SAFE_ROOM_VERSION,
+          available: {}
+        };
+        for (var safeVer of SAFE_ROOM_VERSIONS) {
+          versionCap.available[safeVer] = RoomVersionStability.Stable;
+        }
+      }
+      var result = _this5.checkVersionAgainstCapability(versionCap);
+      if (result.urgent && result.needsUpgrade) {
+        // Something doesn't feel right: we shouldn't need to update
+        // because the version we're on should be in the protocol's
+        // namespace. This usually means that the server was updated
+        // before the client was, making us think the newest possible
+        // room version is not stable. As a solution, we'll refresh
+        // the capability we're using to determine this.
+        logger.warn("Refreshing room version capability because the server looks " + "to be supporting a newer room version we don't know about.");
+        try {
+          capabilities = yield _this5.client.fetchCapabilities();
+        } catch (e) {
+          logger.warn("Failed to refresh room version capabilities", e);
+        }
+        versionCap = capabilities["m.room_versions"];
+        if (!versionCap) {
+          logger.warn("No room version capability - assuming upgrade required.");
+          return result;
+        } else {
+          result = _this5.checkVersionAgainstCapability(versionCap);
+        }
+      }
+      return result;
+    })();
+  }
+  checkVersionAgainstCapability(versionCap) {
+    var currentVersion = this.getVersion();
+    logger.log("[".concat(this.roomId, "] Current version: ").concat(currentVersion));
+    logger.log("[".concat(this.roomId, "] Version capability: "), versionCap);
+    var result = {
+      version: currentVersion,
+      needsUpgrade: false,
+      urgent: false
+    };
+
+    // If the room is on the default version then nothing needs to change
+    if (currentVersion === versionCap.default) return result;
+    var stableVersions = Object.keys(versionCap.available).filter(v => versionCap.available[v] === "stable");
+
+    // Check if the room is on an unstable version. We determine urgency based
+    // off the version being in the Matrix spec namespace or not (if the version
+    // is in the current namespace and unstable, the room is probably vulnerable).
+    if (!stableVersions.includes(currentVersion)) {
+      result.version = versionCap.default;
+      result.needsUpgrade = true;
+      result.urgent = !!this.getVersion().match(/^[0-9]+[0-9.]*$/g);
+      if (result.urgent) {
+        logger.warn("URGENT upgrade required on ".concat(this.roomId));
+      } else {
+        logger.warn("Non-urgent upgrade required on ".concat(this.roomId));
+      }
+      return result;
+    }
+
+    // The room is on a stable, but non-default, version by this point.
+    // No upgrade needed.
+    return result;
+  }
+
+  /**
+   * Determines whether the given user is permitted to perform a room upgrade
+   * @param userId - The ID of the user to test against
+   * @returns True if the given user is permitted to upgrade the room
+   */
+  userMayUpgradeRoom(userId) {
+    return this.currentState.maySendStateEvent(EventType.RoomTombstone, userId);
+  }
+
+  /**
+   * Get the list of pending sent events for this room
+   *
+   * @returns A list of the sent events
+   * waiting for remote echo.
+   *
+   * @throws If `opts.pendingEventOrdering` was not 'detached'
+   */
+  getPendingEvents() {
+    if (!this.pendingEventList) {
+      throw new Error("Cannot call getPendingEvents with pendingEventOrdering == " + this.opts.pendingEventOrdering);
+    }
+    return this.pendingEventList;
+  }
+
+  /**
+   * Removes a pending event for this room
+   *
+   * @returns True if an element was removed.
+   */
+  removePendingEvent(eventId) {
+    if (!this.pendingEventList) {
+      throw new Error("Cannot call removePendingEvent with pendingEventOrdering == " + this.opts.pendingEventOrdering);
+    }
+    var removed = removeElement(this.pendingEventList, function (ev) {
+      return ev.getId() == eventId;
+    }, false);
+    this.savePendingEvents();
+    return removed;
+  }
+
+  /**
+   * Check whether the pending event list contains a given event by ID.
+   * If pending event ordering is not "detached" then this returns false.
+   *
+   * @param eventId - The event ID to check for.
+   */
+  hasPendingEvent(eventId) {
+    var _this$pendingEventLis, _this$pendingEventLis2;
+    return (_this$pendingEventLis = (_this$pendingEventLis2 = this.pendingEventList) === null || _this$pendingEventLis2 === void 0 ? void 0 : _this$pendingEventLis2.some(event => event.getId() === eventId)) !== null && _this$pendingEventLis !== void 0 ? _this$pendingEventLis : false;
+  }
+
+  /**
+   * Get a specific event from the pending event list, if configured, null otherwise.
+   *
+   * @param eventId - The event ID to check for.
+   */
+  getPendingEvent(eventId) {
+    var _this$pendingEventLis3, _this$pendingEventLis4;
+    return (_this$pendingEventLis3 = (_this$pendingEventLis4 = this.pendingEventList) === null || _this$pendingEventLis4 === void 0 ? void 0 : _this$pendingEventLis4.find(event => event.getId() === eventId)) !== null && _this$pendingEventLis3 !== void 0 ? _this$pendingEventLis3 : null;
+  }
+
+  /**
+   * Get the live unfiltered timeline for this room.
+   *
+   * @returns live timeline
+   */
+  getLiveTimeline() {
+    return this.getUnfilteredTimelineSet().getLiveTimeline();
+  }
+
+  /**
+   * The live event timeline for this room, with the oldest event at index 0.
+   *
+   * @deprecated Present for backwards compatibility.
+   *             Use getLiveTimeline().getEvents() instead
+   */
+  get timeline() {
+    return this.getLiveTimeline().getEvents();
+  }
+
+  /**
+   * Get the timestamp of the last message in the room
+   *
+   * @returns the timestamp of the last message in the room
+   */
+  getLastActiveTimestamp() {
+    var timeline = this.getLiveTimeline();
+    var events = timeline.getEvents();
+    if (events.length) {
+      var lastEvent = events[events.length - 1];
+      return lastEvent.getTs();
+    } else {
+      return Number.MIN_SAFE_INTEGER;
+    }
+  }
+
+  /**
+   * Returns the last live event of this room.
+   * "last" means latest timestamp.
+   * Instead of using timestamps, it would be better to do the comparison based on the order of the homeserver DAG.
+   * Unfortunately, this information is currently not available in the client.
+   * See {@link https://github.com/matrix-org/matrix-js-sdk/issues/3325}.
+   * "live of this room" means from all live timelines: the room and the threads.
+   *
+   * @returns BriijEvent if there is a last event; else undefined.
+   */
+  getLastLiveEvent() {
+    var _lastRoomEvent$getTs, _lastThreadEvent$getT;
+    var roomEvents = this.getLiveTimeline().getEvents();
+    var lastRoomEvent = roomEvents[roomEvents.length - 1];
+    var lastThread = this.getLastThread();
+    if (!lastThread) return lastRoomEvent;
+    var lastThreadEvent = lastThread.events[lastThread.events.length - 1];
+    return ((_lastRoomEvent$getTs = lastRoomEvent === null || lastRoomEvent === void 0 ? void 0 : lastRoomEvent.getTs()) !== null && _lastRoomEvent$getTs !== void 0 ? _lastRoomEvent$getTs : 0) > ((_lastThreadEvent$getT = lastThreadEvent === null || lastThreadEvent === void 0 ? void 0 : lastThreadEvent.getTs()) !== null && _lastThreadEvent$getT !== void 0 ? _lastThreadEvent$getT : 0) ? lastRoomEvent : lastThreadEvent;
+  }
+
+  /**
+   * Returns the last thread of this room.
+   * "last" means latest timestamp of the last thread event.
+   * Instead of using timestamps, it would be better to do the comparison based on the order of the homeserver DAG.
+   * Unfortunately, this information is currently not available in the client.
+   * See {@link https://github.com/matrix-org/matrix-js-sdk/issues/3325}.
+   *
+   * @returns the thread with the most recent event in its live time line. undefined if there is no thread.
+   */
+  getLastThread() {
+    return this.getThreads().reduce((lastThread, thread) => {
+      var _threadEvent$getTs, _lastThreadEvent$getT2;
+      if (!lastThread) return thread;
+      var threadEvent = thread.events[thread.events.length - 1];
+      var lastThreadEvent = lastThread.events[lastThread.events.length - 1];
+      if (((_threadEvent$getTs = threadEvent === null || threadEvent === void 0 ? void 0 : threadEvent.getTs()) !== null && _threadEvent$getTs !== void 0 ? _threadEvent$getTs : 0) >= ((_lastThreadEvent$getT2 = lastThreadEvent === null || lastThreadEvent === void 0 ? void 0 : lastThreadEvent.getTs()) !== null && _lastThreadEvent$getT2 !== void 0 ? _lastThreadEvent$getT2 : 0)) {
+        // Last message of current thread is newer → new last thread.
+        // Equal also means newer, because it was added to the thread map later.
+        return thread;
+      }
+      return lastThread;
+    }, undefined);
+  }
+
+  /**
+   * @returns the membership type (join | leave | invite | knock) for the logged in user
+   */
+  getMyMembership() {
+    var _this$selfMembership;
+    return (_this$selfMembership = this.selfMembership) !== null && _this$selfMembership !== void 0 ? _this$selfMembership : KnownMembership.Leave;
+  }
+
+  /**
+   * If this room is a DM we're invited to,
+   * try to find out who invited us
+   * @returns user id of the inviter
+   */
+  getDMInviter() {
+    var me = this.getMember(this.myUserId);
+    if (me) {
+      return me.getDMInviter();
+    }
+    if (this.selfMembership === KnownMembership.Invite) {
+      // fall back to summary information
+      var memberCount = this.getInvitedAndJoinedMemberCount();
+      if (memberCount === 2) {
+        var _this$heroes;
+        return (_this$heroes = this.heroes) === null || _this$heroes === void 0 || (_this$heroes = _this$heroes[0]) === null || _this$heroes === void 0 ? void 0 : _this$heroes.userId;
+      }
+    }
+  }
+
+  /**
+   * Assuming this room is a DM room, tries to guess with which user.
+   * @returns user id of the other member (could be syncing user)
+   */
+  guessDMUserId() {
+    var me = this.getMember(this.myUserId);
+    if (me) {
+      var inviterId = me.getDMInviter();
+      if (inviterId) {
+        return inviterId;
+      }
+    }
+    // Remember, we're assuming this room is a DM, so returning the first member we find should be fine
+    if (Array.isArray(this.heroes) && this.heroes.length) {
+      return this.heroes[0].userId;
+    }
+    var members = this.currentState.getMembers();
+    var anyMember = members.find(m => m.userId !== this.myUserId);
+    if (anyMember) {
+      return anyMember.userId;
+    }
+    // it really seems like I'm the only user in the room
+    // so I probably created a room with just me in it
+    // and marked it as a DM. Ok then
+    return this.myUserId;
+  }
+
+  /**
+   * Gets the "functional members" in this room.
+   *
+   * Returns the list of userIDs from the `io.element.functional_members` event. Does not consider the
+   * current membership states of those users.
+   *
+   * @see https://github.com/element-hq/element-meta/blob/develop/spec/functional_members.md.
+   */
+  getFunctionalMembers() {
+    var mFunctionalMembers = this.currentState.getStateEvents(UNSTABLE_ELEMENT_FUNCTIONAL_USERS.name, "");
+    if (Array.isArray(mFunctionalMembers === null || mFunctionalMembers === void 0 ? void 0 : mFunctionalMembers.getContent().service_members)) {
+      return mFunctionalMembers.getContent().service_members;
+    }
+    return [];
+  }
+  getAvatarFallbackMember() {
+    var _this$heroes2;
+    var functionalMembers = this.getFunctionalMembers();
+
+    // Only generate a fallback avatar if the conversation is with a single specific other user (a "DM").
+    var nonFunctionalMemberCount = 0;
+    this.getMembers().forEach(m => {
+      if (m.membership !== "join" && m.membership !== "invite") return;
+      if (functionalMembers.includes(m.userId)) return;
+      nonFunctionalMemberCount++;
+    });
+    if (nonFunctionalMemberCount > 2) return;
+
+    // Prefer the list of heroes, if present. It should only include the single other user in the DM.
+    var nonFunctionalHeroes = (_this$heroes2 = this.heroes) === null || _this$heroes2 === void 0 ? void 0 : _this$heroes2.filter(h => !functionalMembers.includes(h.userId));
+    var hasHeroes = Array.isArray(nonFunctionalHeroes) && nonFunctionalHeroes.length;
+    if (hasHeroes) {
+      // use first hero that has a display name or avatar url, or whose user ID
+      // can be looked up as a member of the room
+      for (var hero of nonFunctionalHeroes) {
+        // If the hero was from a legacy sync (`/v3/sync`), we will need to look the user ID up in the room
+        // the display name and avatar URL will not be set.
+        if (!hero.fromMSC4186) {
+          // attempt to look up renderable fields from the m.room.member event if it exists
+          var member = this.getMember(hero.userId);
+          if (member) {
+            return member;
+          }
+        } else {
+          // use the Hero supplied values for the room member.
+          // TODO: It's unfortunate that this function, which clearly only cares about the
+          //       avatar url, returns the entire RoomMember event. We need to fake an event
+          //       to meet this API shape.
+          var heroMember = new RoomMember(this.roomId, hero.userId);
+          // set the display name and avatar url
+          heroMember.setMembershipEvent(new BriijEvent({
+            // ensure it's unique even if we hit the same millisecond
+            event_id: "$" + this.roomId + hero.userId + new Date().getTime(),
+            type: EventType.RoomMember,
+            state_key: hero.userId,
+            content: {
+              displayname: hero.displayName,
+              avatar_url: hero.avatarUrl
+            }
+          }));
+          return heroMember;
+        }
+      }
+      var availableMember = nonFunctionalHeroes.map(hero => {
+        return this.getMember(hero.userId);
+      }).find(member => !!member);
+      if (availableMember) {
+        return availableMember;
+      }
+    }
+
+    // Consider *all*, including previous, members, to generate the avatar for DMs where the other user left.
+    // Needed to generate a matching avatar for rooms named "Empty Room (was Alice)".
+    var members = this.getMembers();
+    var nonFunctionalMembers = members === null || members === void 0 ? void 0 : members.filter(m => !functionalMembers.includes(m.userId));
+    if (nonFunctionalMembers.length <= 2) {
+      var _availableMember = nonFunctionalMembers.find(m => {
+        return m.userId !== this.myUserId;
+      });
+      if (_availableMember) {
+        return _availableMember;
+      }
+    }
+
+    // If all else failed, but the homeserver gave us heroes that previously could not be found in the room members,
+    // trust and try falling back to a hero, creating a one-off member for it
+    if (hasHeroes) {
+      var availableUser = nonFunctionalHeroes.map(hero => {
+        return this.client.getUser(hero.userId);
+      }).find(user => !!user);
+      if (availableUser) {
+        var _member = new RoomMember(this.roomId, availableUser.userId);
+        _member.user = availableUser;
+        return _member;
+      }
+    }
+  }
+
+  /**
+   * Sets the membership this room was received as during sync
+   * @param membership - join | leave | invite
+   */
+  updateMyMembership(membership) {
+    var prevMembership = this.selfMembership;
+    this.selfMembership = membership;
+    if (prevMembership !== membership) {
+      if (membership === KnownMembership.Leave) {
+        this.cleanupAfterLeaving();
+      }
+      this.emit(RoomEvent.MyMembership, this, membership, prevMembership);
+    }
+  }
+  loadMembersFromServer() {
+    var _this6 = this;
+    return _asyncToGenerator(function* () {
+      var lastSyncToken = _this6.client.store.getSyncToken();
+      var response = yield _this6.client.members(_this6.roomId, undefined, KnownMembership.Leave, lastSyncToken !== null && lastSyncToken !== void 0 ? lastSyncToken : undefined);
+      return response.chunk;
+    })();
+  }
+  loadMembers() {
+    var _this7 = this;
+    return _asyncToGenerator(function* () {
+      // were the members loaded from the server?
+      var fromServer = false;
+      var rawMembersEvents = yield _this7.client.store.getOutOfBandMembers(_this7.roomId);
+      // If the room is encrypted, we always fetch members from the server at
+      // least once, in case the latest state wasn't persisted properly. Note
+      // that this function is only called once (unless loading the members
+      // fails), since loadMembersIfNeeded always returns this.membersPromise
+      // if set, which will be the result of the first (successful) call.
+      if (rawMembersEvents === null || _this7.hasEncryptionStateEvent()) {
+        fromServer = true;
+        rawMembersEvents = yield _this7.loadMembersFromServer();
+        logger.log("LL: got ".concat(rawMembersEvents.length, " ") + "members from server for room ".concat(_this7.roomId));
+      }
+      var memberEvents = rawMembersEvents.filter(noUnsafeEventProps).map(_this7.client.getEventMapper());
+      return {
+        memberEvents,
+        fromServer
+      };
+    })();
+  }
+
+  /**
+   * Check if loading of out-of-band-members has completed
+   *
+   * @returns true if the full membership list of this room has been loaded (including if lazy-loading is disabled).
+   *    False if the load is not started or is in progress.
+   */
+  membersLoaded() {
+    if (!this.opts.lazyLoadMembers) {
+      return true;
+    }
+    return this.currentState.outOfBandMembersReady();
+  }
+
+  /**
+   * Preloads the member list in case lazy loading
+   * of memberships is in use. Can be called multiple times,
+   * it will only preload once.
+   * @returns when preloading is done and
+   * accessing the members on the room will take
+   * all members in the room into account
+   */
+  loadMembersIfNeeded() {
+    if (this.membersPromise) {
+      return this.membersPromise;
+    }
+
+    // mark the state so that incoming messages while
+    // the request is in flight get marked as superseding
+    // the OOB members
+    this.currentState.markOutOfBandMembersStarted();
+    var inMemoryUpdate = this.loadMembers().then(result => {
+      this.currentState.setOutOfBandMembers(result.memberEvents);
+      // recalculate the room name: it may have been based on members, so may have changed
+      this.recalculate();
+      return result.fromServer;
+    }).catch(err => {
+      // allow retries on fail
+      this.membersPromise = undefined;
+      this.currentState.markOutOfBandMembersFailed();
+      throw err;
+    });
+    // update members in storage, but don't wait for it
+    inMemoryUpdate.then(fromServer => {
+      if (fromServer) {
+        var oobMembers = this.currentState.getMembers().filter(m => m.isOutOfBand()).map(m => {
+          var _m$events$member;
+          return (_m$events$member = m.events.member) === null || _m$events$member === void 0 ? void 0 : _m$events$member.event;
+        });
+        logger.log("LL: telling store to write ".concat(oobMembers.length) + " members for room ".concat(this.roomId));
+        var store = this.client.store;
+        return store.setOutOfBandMembers(this.roomId, oobMembers)
+        // swallow any IDB error as we don't want to fail
+        // because of this
+        .catch(err => {
+          logger.log("LL: storing OOB room members failed, oh well", err);
+        });
+      }
+    }).catch(err => {
+      // as this is not awaited anywhere,
+      // at least show the error in the console
+      logger.error(err);
+    });
+    this.membersPromise = inMemoryUpdate;
+    return this.membersPromise;
+  }
+
+  /**
+   * Removes the lazily loaded members from storage if needed
+   */
+  clearLoadedMembersIfNeeded() {
+    var _this8 = this;
+    return _asyncToGenerator(function* () {
+      if (_this8.opts.lazyLoadMembers && _this8.membersPromise) {
+        yield _this8.loadMembersIfNeeded();
+        yield _this8.client.store.clearOutOfBandMembers(_this8.roomId);
+        _this8.currentState.clearOutOfBandMembers();
+        _this8.membersPromise = undefined;
+      }
+    })();
+  }
+
+  /**
+   * called when sync receives this room in the leave section
+   * to do cleanup after leaving a room. Possibly called multiple times.
+   */
+  cleanupAfterLeaving() {
+    this.clearLoadedMembersIfNeeded().catch(err => {
+      logger.error("error after clearing loaded members from " + "room ".concat(this.roomId, " after leaving"));
+      logger.log(err);
+    });
+  }
+
+  /**
+   * Empty out the current live timeline and re-request it. This is used when
+   * historical messages are imported into the room via MSC2716 `/batch_send`
+   * because the client may already have that section of the timeline loaded.
+   * We need to force the client to throw away their current timeline so that
+   * when they back paginate over the area again with the historical messages
+   * in between, it grabs the newly imported messages. We can listen for
+   * `UNSTABLE_MSC2716_MARKER`, in order to tell when historical messages are ready
+   * to be discovered in the room and the timeline needs a refresh. The SDK
+   * emits a `RoomEvent.HistoryImportedWithinTimeline` event when we detect a
+   * valid marker and can check the needs refresh status via
+   * `room.getTimelineNeedsRefresh()`.
+   */
+  refreshLiveTimeline() {
+    var _this9 = this;
+    return _asyncToGenerator(function* () {
+      var liveTimelineBefore = _this9.getLiveTimeline();
+      var forwardPaginationToken = liveTimelineBefore.getPaginationToken(EventTimeline.FORWARDS);
+      var backwardPaginationToken = liveTimelineBefore.getPaginationToken(EventTimeline.BACKWARDS);
+      var eventsBefore = liveTimelineBefore.getEvents();
+      var mostRecentEventInTimeline = eventsBefore[eventsBefore.length - 1];
+      logger.log("[refreshLiveTimeline for ".concat(_this9.roomId, "] at ") + "mostRecentEventInTimeline=".concat(mostRecentEventInTimeline && mostRecentEventInTimeline.getId(), " ") + "liveTimelineBefore=".concat(liveTimelineBefore.toString(), " ") + "forwardPaginationToken=".concat(forwardPaginationToken, " ") + "backwardPaginationToken=".concat(backwardPaginationToken));
+
+      // Get the main TimelineSet
+      var timelineSet = _this9.getUnfilteredTimelineSet();
+      var newTimeline = null;
+      // If there isn't any event in the timeline, let's go fetch the latest
+      // event and construct a timeline from it.
+      //
+      // This should only really happen if the user ran into an error
+      // with refreshing the timeline before which left them in a blank
+      // timeline from `resetLiveTimeline`.
+      if (!mostRecentEventInTimeline) {
+        newTimeline = yield _this9.client.getLatestTimeline(timelineSet);
+      } else {
+        // Empty out all of `this.timelineSets`. But we also need to keep the
+        // same `timelineSet` references around so the React code updates
+        // properly and doesn't ignore the room events we emit because it checks
+        // that the `timelineSet` references are the same. We need the
+        // `timelineSet` empty so that the `client.getEventTimeline(...)` call
+        // later, will call `/context` and create a new timeline instead of
+        // returning the same one.
+        _this9.resetLiveTimeline(null, null);
+
+        // Make the UI timeline show the new blank live timeline we just
+        // reset so that if the network fails below it's showing the
+        // accurate state of what we're working with instead of the
+        // disconnected one in the TimelineWindow which is just hanging
+        // around by reference.
+        _this9.emit(RoomEvent.TimelineRefresh, _this9, timelineSet);
+
+        // Use `client.getEventTimeline(...)` to construct a new timeline from a
+        // `/context` response state and events for the most recent event before
+        // we reset everything. The `timelineSet` we pass in needs to be empty
+        // in order for this function to call `/context` and generate a new
+        // timeline.
+        newTimeline = yield _this9.client.getEventTimeline(timelineSet, mostRecentEventInTimeline.getId());
+      }
+
+      // If a racing `/sync` beat us to creating a new timeline, use that
+      // instead because it's the latest in the room and any new messages in
+      // the scrollback will include the history.
+      var liveTimeline = timelineSet.getLiveTimeline();
+      if (!liveTimeline || liveTimeline.getPaginationToken(Direction.Forward) === null && liveTimeline.getPaginationToken(Direction.Backward) === null && liveTimeline.getEvents().length === 0) {
+        logger.log("[refreshLiveTimeline for ".concat(_this9.roomId, "] using our new live timeline"));
+        // Set the pagination token back to the live sync token (`null`) instead
+        // of using the `/context` historical token (ex. `t12-13_0_0_0_0_0_0_0_0`)
+        // so that it matches the next response from `/sync` and we can properly
+        // continue the timeline.
+        newTimeline.setPaginationToken(forwardPaginationToken, EventTimeline.FORWARDS);
+
+        // Set our new fresh timeline as the live timeline to continue syncing
+        // forwards and back paginating from.
+        timelineSet.setLiveTimeline(newTimeline);
+        // Fixup `this.oldstate` so that `scrollback` has the pagination tokens
+        // available
+        _this9.fixUpLegacyTimelineFields();
+      } else {
+        logger.log("[refreshLiveTimeline for ".concat(_this9.roomId, "] `/sync` or some other request beat us to creating a new ") + "live timeline after we reset it. We'll use that instead since any events in the scrollback from " + "this timeline will include the history.");
+      }
+
+      // The timeline has now been refreshed ✅
+      _this9.setTimelineNeedsRefresh(false);
+
+      // Emit an event which clients can react to and re-load the timeline
+      // from the SDK
+      _this9.emit(RoomEvent.TimelineRefresh, _this9, timelineSet);
+    })();
+  }
+
+  /**
+   * Reset the live timeline of all timelineSets, and start new ones.
+   *
+   * <p>This is used when /sync returns a 'limited' timeline.
+   *
+   * @param backPaginationToken -   token for back-paginating the new timeline
+   * @param forwardPaginationToken - token for forward-paginating the old live timeline,
+   * if absent or null, all timelines are reset, removing old ones (including the previous live
+   * timeline which would otherwise be unable to paginate forwards without this token).
+   * Removing just the old live timeline whilst preserving previous ones is not supported.
+   */
+  resetLiveTimeline(backPaginationToken, forwardPaginationToken) {
+    for (var timelineSet of this.timelineSets) {
+      timelineSet.resetLiveTimeline(backPaginationToken !== null && backPaginationToken !== void 0 ? backPaginationToken : undefined, forwardPaginationToken !== null && forwardPaginationToken !== void 0 ? forwardPaginationToken : undefined);
+    }
+    for (var thread of this.threads.values()) {
+      thread.resetLiveTimeline(backPaginationToken, forwardPaginationToken);
+    }
+    this.fixUpLegacyTimelineFields();
+  }
+
+  /**
+   * Fix up this.timeline, this.oldState and this.currentState
+   *
+   * @internal
+   */
+  fixUpLegacyTimelineFields() {
+    var previousOldState = this.oldState;
+    var previousCurrentState = this.currentState;
+
+    // maintain this.oldState and this.currentState as references to the
+    // state at the start and end of that timeline. These are more
+    // for backwards-compatibility than anything else.
+    this.oldState = this.getLiveTimeline().getState(EventTimeline.BACKWARDS);
+    this.currentState = this.getLiveTimeline().getState(EventTimeline.FORWARDS);
+
+    // Let people know to register new listeners for the new state
+    // references. The reference won't necessarily change every time so only
+    // emit when we see a change.
+    if (previousOldState !== this.oldState) {
+      this.emit(RoomEvent.OldStateUpdated, this, previousOldState, this.oldState);
+    }
+    if (previousCurrentState !== this.currentState) {
+      this.emit(RoomEvent.CurrentStateUpdated, this, previousCurrentState, this.currentState);
+
+      // Re-emit various events on the current room state
+      // TODO: If currentState really only exists for backwards
+      // compatibility, shouldn't we be doing this some other way?
+      this.reEmitter.stopReEmitting(previousCurrentState, [RoomStateEvent.Events, RoomStateEvent.Members, RoomStateEvent.NewMember, RoomStateEvent.Update, RoomStateEvent.Marker, BeaconEvent.New, BeaconEvent.Update, BeaconEvent.Destroy, BeaconEvent.LivenessChange]);
+      this.reEmitter.reEmit(this.currentState, [RoomStateEvent.Events, RoomStateEvent.Members, RoomStateEvent.NewMember, RoomStateEvent.Update, RoomStateEvent.Marker, BeaconEvent.New, BeaconEvent.Update, BeaconEvent.Destroy, BeaconEvent.LivenessChange]);
+    }
+  }
+  onReceipt(event) {
+    if (this.hasEncryptionStateEvent()) {
+      this.clearNotificationsOnReceipt(event);
+    }
+  }
+  clearNotificationsOnReceipt(event) {
+    // Like above, we have to listen for read receipts from ourselves in order to
+    // correctly handle notification counts on encrypted rooms.
+    // This fixes https://github.com/vector-im/element-web/issues/9421
+
+    // Figure out if we've read something or if it's just informational
+    // We need to work out what threads we've just recieved receipts for, so we
+    // know which ones to update. If we've received an unthreaded receipt, we'll
+    // need to update all threads.
+    var threadIds = [];
+    var hasUnthreadedReceipt = false;
+    var content = event.getContent();
+    for (var receiptGroup of Object.values(content)) {
+      for (var [receiptType, userReceipt] of Object.entries(receiptGroup)) {
+        if (!utils.isSupportedReceiptType(receiptType)) continue;
+        if (!userReceipt) continue;
+        for (var [userId, singleReceipt] of Object.entries(userReceipt)) {
+          if (!singleReceipt || typeof singleReceipt !== "object") continue;
+          var typedSingleReceipt = singleReceipt;
+          if (userId !== this.client.getUserId()) continue;
+          if (typedSingleReceipt.thread_id === undefined) {
+            hasUnthreadedReceipt = true;
+          } else if (typeof typedSingleReceipt.thread_id === "string") {
+            threadIds.push(typedSingleReceipt.thread_id);
+          }
+        }
+      }
+    }
+    if (hasUnthreadedReceipt) {
+      // If we have an unthreaded receipt, we need to update any threads that have a notification
+      // in them (because we know the receipt can't go backwards so we don't need to check any with
+      // no notifications: the number can only decrease from a receipt).
+      threadIds = this.getThreads().filter(thread => this.getThreadUnreadNotificationCount(thread.id, NotificationCountType.Total) > 0 || this.getThreadUnreadNotificationCount(thread.id, NotificationCountType.Highlight) > 0).map(thread => thread.id);
+      threadIds.push("main");
+    }
+    for (var threadId of threadIds) {
+      var _this$getThread;
+      // Work backwards to determine how many events are unread. We also set
+      // a limit for how back we'll look to avoid spinning CPU for too long.
+      // If we hit the limit, we assume the count is unchanged.
+      var maxHistory = 20;
+      var timeline = threadId === "main" ? this.getLiveTimeline() : (_this$getThread = this.getThread(threadId)) === null || _this$getThread === void 0 ? void 0 : _this$getThread.liveTimeline;
+      if (!timeline) {
+        logger.warn("Couldn't find timeline for thread ID ".concat(threadId, " in room ").concat(this.roomId));
+        continue;
+      }
+      var events = timeline.getEvents();
+      var highlightCount = 0;
+      for (var i = events.length - 1; i >= 0; i--) {
+        var _pushActions$tweaks;
+        if (i === events.length - maxHistory) return; // limit reached
+
+        var _event = events[i];
+        if (this.hasUserReadEvent(this.client.getUserId(), _event.getId())) {
+          // If the user has read the event, then the counting is done.
+          break;
+        }
+        var pushActions = this.client.getPushActionsForEvent(_event);
+        highlightCount += pushActions !== null && pushActions !== void 0 && (_pushActions$tweaks = pushActions.tweaks) !== null && _pushActions$tweaks !== void 0 && _pushActions$tweaks.highlight ? 1 : 0;
+      }
+
+      // Note: we don't need to handle 'total' notifications because the counts
+      // will come from the server.
+      if (threadId === "main") {
+        this.setUnreadNotificationCount(NotificationCountType.Highlight, highlightCount);
+      } else {
+        this.setThreadUnreadNotificationCount(threadId, NotificationCountType.Highlight, highlightCount);
+      }
+    }
+  }
+
+  /**
+   * Return the timeline sets for this room.
+   * @returns array of timeline sets for this room
+   */
+  getTimelineSets() {
+    return this.timelineSets;
+  }
+
+  /**
+   * Helper to return the main unfiltered timeline set for this room
+   * @returns room's unfiltered timeline set
+   */
+  getUnfilteredTimelineSet() {
+    return this.timelineSets[0];
+  }
+
+  /**
+   * Get the timeline which contains the given event from the unfiltered set, if any
+   *
+   * @param eventId -  event ID to look for
+   * @returns timeline containing
+   * the given event, or null if unknown
+   */
+  getTimelineForEvent(eventId) {
+    var event = this.findEventById(eventId);
+    var thread = this.findThreadForEvent(event);
+    if (thread) {
+      return thread.timelineSet.getTimelineForEvent(eventId);
+    } else {
+      return this.getUnfilteredTimelineSet().getTimelineForEvent(eventId);
+    }
+  }
+
+  /**
+   * Add a new timeline to this room's unfiltered timeline set
+   *
+   * @returns newly-created timeline
+   */
+  addTimeline() {
+    return this.getUnfilteredTimelineSet().addTimeline();
+  }
+
+  /**
+   * Whether the timeline needs to be refreshed in order to pull in new
+   * historical messages that were imported.
+   * @param value - The value to set
+   */
+  setTimelineNeedsRefresh(value) {
+    this.timelineNeedsRefresh = value;
+  }
+
+  /**
+   * Whether the timeline needs to be refreshed in order to pull in new
+   * historical messages that were imported.
+   * @returns .
+   */
+  getTimelineNeedsRefresh() {
+    return this.timelineNeedsRefresh;
+  }
+
+  /**
+   * Get an event which is stored in our unfiltered timeline set, or in a thread
+   *
+   * @param eventId - event ID to look for
+   * @returns the given event, or undefined if unknown
+   */
+  findEventById(eventId) {
+    var event = this.getUnfilteredTimelineSet().findEventById(eventId);
+    if (!event) {
+      var threads = this.getThreads();
+      for (var i = 0; i < threads.length; i++) {
+        var thread = threads[i];
+        event = thread.findEventById(eventId);
+        if (event) {
+          return event;
+        }
+      }
+    }
+    return event;
+  }
+
+  /**
+   * Get one of the notification counts for this room
+   * @param type - The type of notification count to get. default: 'total'
+   * @returns The notification count, or undefined if there is no count
+   *                  for this type.
+   */
+  getUnreadNotificationCount() {
+    var type = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : NotificationCountType.Total;
+    var count = this.getRoomUnreadNotificationCount(type);
+    for (var threadNotification of this.threadNotifications.values()) {
+      var _threadNotification$t;
+      count += (_threadNotification$t = threadNotification[type]) !== null && _threadNotification$t !== void 0 ? _threadNotification$t : 0;
+    }
+    return count;
+  }
+
+  /**
+   * Get the notification for the event context (room or thread timeline)
+   */
+  getUnreadCountForEventContext() {
+    var _ref2;
+    var type = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : NotificationCountType.Total;
+    var event = arguments.length > 1 ? arguments[1] : undefined;
+    var isThreadEvent = !!event.threadRootId && !event.isThreadRoot;
+    return (_ref2 = isThreadEvent ? this.getThreadUnreadNotificationCount(event.threadRootId, type) : this.getRoomUnreadNotificationCount(type)) !== null && _ref2 !== void 0 ? _ref2 : 0;
+  }
+
+  /**
+   * Get one of the notification counts for this room
+   * @param type - The type of notification count to get. default: 'total'
+   * @returns The notification count, or undefined if there is no count
+   *                  for this type.
+   */
+  getRoomUnreadNotificationCount() {
+    var _this$notificationCou;
+    var type = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : NotificationCountType.Total;
+    return (_this$notificationCou = this.notificationCounts[type]) !== null && _this$notificationCou !== void 0 ? _this$notificationCou : 0;
+  }
+
+  /**
+   * Get one of the notification counts for a thread
+   * @param threadId - the root event ID
+   * @param type - The type of notification count to get. default: 'total'
+   * @returns The notification count, or undefined if there is no count
+   *          for this type.
+   */
+  getThreadUnreadNotificationCount(threadId) {
+    var _this$threadNotificat, _this$threadNotificat2;
+    var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : NotificationCountType.Total;
+    return (_this$threadNotificat = (_this$threadNotificat2 = this.threadNotifications.get(threadId)) === null || _this$threadNotificat2 === void 0 ? void 0 : _this$threadNotificat2[type]) !== null && _this$threadNotificat !== void 0 ? _this$threadNotificat : 0;
+  }
+
+  /**
+   * Checks if the current room has unread thread notifications
+   * @returns
+   */
+  hasThreadUnreadNotification() {
+    for (var notification of this.threadNotifications.values()) {
+      var _notification$highlig, _notification$total;
+      if (((_notification$highlig = notification.highlight) !== null && _notification$highlig !== void 0 ? _notification$highlig : 0) > 0 || ((_notification$total = notification.total) !== null && _notification$total !== void 0 ? _notification$total : 0) > 0) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Swet one of the notification count for a thread
+   * @param threadId - the root event ID
+   * @param type - The type of notification count to get. default: 'total'
+   * @returns
+   */
+  setThreadUnreadNotificationCount(threadId, type, count) {
+    var _this$threadNotificat3, _this$threadNotificat4;
+    var notification = _objectSpread({
+      highlight: (_this$threadNotificat3 = this.threadNotifications.get(threadId)) === null || _this$threadNotificat3 === void 0 ? void 0 : _this$threadNotificat3.highlight,
+      total: (_this$threadNotificat4 = this.threadNotifications.get(threadId)) === null || _this$threadNotificat4 === void 0 ? void 0 : _this$threadNotificat4.total
+    }, {
+      [type]: count
+    });
+    this.threadNotifications.set(threadId, notification);
+    this.emit(RoomEvent.UnreadNotifications, notification, threadId);
+  }
+
+  /**
+   * @returns the notification count type for all the threads in the room
+   */
+  get threadsAggregateNotificationType() {
+    var type = null;
+    for (var threadNotification of this.threadNotifications.values()) {
+      var _threadNotification$h, _threadNotification$t2;
+      if (((_threadNotification$h = threadNotification.highlight) !== null && _threadNotification$h !== void 0 ? _threadNotification$h : 0) > 0) {
+        return NotificationCountType.Highlight;
+      } else if (((_threadNotification$t2 = threadNotification.total) !== null && _threadNotification$t2 !== void 0 ? _threadNotification$t2 : 0) > 0 && !type) {
+        type = NotificationCountType.Total;
+      }
+    }
+    return type;
+  }
+
+  /**
+   * Resets the total thread notifications for all threads in this room to zero,
+   * excluding any threads whose IDs are given in `exceptThreadIds`.
+   *
+   * If the room is not encrypted, also resets the highlight notification count to zero
+   * for the same set of threads.
+   *
+   * This is intended for use from the sync code since we calculate highlight notification
+   * counts locally from decrypted messages. We want to partially trust the total from the
+   * server such that we clear notifications when read receipts arrive. The weird name is
+   * intended to reflect this. You probably do not want to use this.
+   *
+   * @param exceptThreadIds - The thread IDs to exclude from the reset.
+   */
+  resetThreadUnreadNotificationCountFromSync() {
+    var exceptThreadIds = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+    var isEncrypted = this.hasEncryptionStateEvent();
+    for (var [threadId, notifs] of this.threadNotifications) {
+      if (!exceptThreadIds.includes(threadId)) {
+        notifs.total = 0;
+        if (!isEncrypted) {
+          notifs.highlight = 0;
+        }
+      }
+    }
+    this.emit(RoomEvent.UnreadNotifications);
+  }
+
+  /**
+   * Set the bump stamp for this room. This can be used for sorting rooms when the timeline
+   * entries are unknown. Used in MSC4186: Simplified Sliding Sync.
+   * @param bumpStamp The bump_stamp value from the server
+   */
+  setBumpStamp(bumpStamp) {
+    this.bumpStamp = bumpStamp;
+  }
+
+  /**
+   * Get the bump stamp for this room. This can be used for sorting rooms when the timeline
+   * entries are unknown. Used in MSC4186: Simplified Sliding Sync.
+   * @returns The bump stamp for the room, if it exists.
+   */
+  getBumpStamp() {
+    return this.bumpStamp;
+  }
+
+  /**
+   * Set one of the notification counts for this room
+   * @param type - The type of notification count to set.
+   * @param count - The new count
+   */
+  setUnreadNotificationCount(type, count) {
+    this.notificationCounts[type] = count;
+    this.emit(RoomEvent.UnreadNotifications, this.notificationCounts);
+  }
+  setUnread(type, count) {
+    return this.setUnreadNotificationCount(type, count);
+  }
+
+  /**
+   * Takes a legacy room summary (/v3/sync as opposed to MSC4186) and updates the room with it.
+   *
+   * @param summary - The room summary to update the room with
+   */
+  setSummary(summary) {
+    var _summary$mHeroes;
+    var heroes = (_summary$mHeroes = summary["m.heroes"]) === null || _summary$mHeroes === void 0 ? void 0 : _summary$mHeroes.map(h => ({
+      userId: h,
+      fromMSC4186: false
+    }));
+    var joinedCount = summary["m.joined_member_count"];
+    var invitedCount = summary["m.invited_member_count"];
+    if (Number.isInteger(joinedCount)) {
+      this.currentState.setJoinedMemberCount(joinedCount);
+    }
+    if (Number.isInteger(invitedCount)) {
+      this.currentState.setInvitedMemberCount(invitedCount);
+    }
+    if (Array.isArray(heroes)) {
+      // filter out ourselves just in case
+      this.heroes = heroes.filter(h => {
+        return h.userId != this.myUserId;
+      });
+    }
+    this.emit(RoomEvent.Summary, summary);
+  }
+
+  /**
+   * Takes information from the MSC4186 room summary and updates the room with it.
+   *
+   * @param heroes - The room's hero members
+   * @param joinedCount - The number of joined members
+   * @param invitedCount - The number of invited members
+   */
+  setMSC4186SummaryData(heroes, joinedCount, invitedCount) {
+    if (heroes) {
+      this.heroes = heroes.filter(h => h.user_id !== this.myUserId).map(h => ({
+        userId: h.user_id,
+        displayName: h.displayname,
+        avatarUrl: h.avatar_url,
+        fromMSC4186: true
+      }));
+    }
+    if (joinedCount !== undefined && Number.isInteger(joinedCount)) {
+      this.currentState.setJoinedMemberCount(joinedCount);
+    }
+    if (invitedCount !== undefined && Number.isInteger(invitedCount)) {
+      this.currentState.setInvitedMemberCount(invitedCount);
+    }
+
+    // Construct a summary object to emit as the event wants the info in a single object
+    // more like old-style (/v3/sync) summaries.
+    this.emit(RoomEvent.Summary, {
+      "m.heroes": this.heroes ? this.heroes.map(h => h.userId) : [],
+      "m.joined_member_count": joinedCount,
+      "m.invited_member_count": invitedCount
+    });
+  }
+
+  /**
+   * Whether to send encrypted messages to devices within this room.
+   * @param value - true to blacklist unverified devices, null
+   * to use the global value for this room.
+   */
+  setBlacklistUnverifiedDevices(value) {
+    this.blacklistUnverifiedDevices = value;
+  }
+
+  /**
+   * Whether to send encrypted messages to devices within this room.
+   * @returns true if blacklisting unverified devices, null
+   * if the global value should be used for this room.
+   */
+  getBlacklistUnverifiedDevices() {
+    if (this.blacklistUnverifiedDevices === undefined) return null;
+    return this.blacklistUnverifiedDevices;
+  }
+
+  /**
+   * Get the avatar URL for a room if one was set.
+   * @param baseUrl - The homeserver base URL. See
+   * {@link BriijClient#getHomeserverUrl}.
+   * @param width - The desired width of the thumbnail.
+   * @param height - The desired height of the thumbnail.
+   * @param resizeMethod - The thumbnail resize method to use, either
+   * "crop" or "scale".
+   * @param allowDefault - True to allow an identicon for this room if an
+   * avatar URL wasn't explicitly set. Default: true. (Deprecated)
+   * @param useAuthentication - (optional) If true, the caller supports authenticated
+   * media and wants an authentication-required URL. Note that server support for
+   * authenticated media will not be checked - it is the caller's responsibility
+   * to do so before calling this function. Note also that useAuthentication
+   * implies allowRedirects. Defaults to false (unauthenticated endpoints).
+   * @returns the avatar URL or null.
+   */
+  getAvatarUrl(baseUrl, width, height, resizeMethod) {
+    var allowDefault = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
+    var useAuthentication = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+    var mainUrl = this.getMxcAvatarUrl();
+    if (!mainUrl && !allowDefault) {
+      return null;
+    }
+    if (mainUrl) {
+      return getHttpUriForMxc(baseUrl, mainUrl, width, height, resizeMethod, undefined, undefined, useAuthentication);
+    }
+    return null;
+  }
+
+  /**
+   * Get the mxc avatar url for the room, if one was set.
+   * @returns the mxc avatar url or falsy
+   */
+  getMxcAvatarUrl() {
+    var _this$currentState$ge;
+    var url = (_this$currentState$ge = this.currentState.getStateEvents(EventType.RoomAvatar, "")) === null || _this$currentState$ge === void 0 ? void 0 : _this$currentState$ge.getContent().url;
+    return url && typeof url === "string" ? url : null;
+  }
+
+  /**
+   * Get this room's canonical alias
+   * The alias returned by this function may not necessarily
+   * still point to this room.
+   * @returns The room's canonical alias, or null if there is none
+   */
+  getCanonicalAlias() {
+    var _this$currentState$ge2;
+    var canonicalAlias = (_this$currentState$ge2 = this.currentState.getStateEvents(EventType.RoomCanonicalAlias, "")) === null || _this$currentState$ge2 === void 0 ? void 0 : _this$currentState$ge2.getContent().alias;
+    return canonicalAlias && typeof canonicalAlias === "string" ? canonicalAlias : null;
+  }
+
+  /**
+   * Get this room's alternative aliases
+   * @returns The room's alternative aliases, or an empty array
+   */
+  getAltAliases() {
+    var _this$currentState$ge3;
+    var altAliases = (_this$currentState$ge3 = this.currentState.getStateEvents(EventType.RoomCanonicalAlias, "")) === null || _this$currentState$ge3 === void 0 ? void 0 : _this$currentState$ge3.getContent().alt_aliases;
+    if (Array.isArray(altAliases)) {
+      return altAliases.filter(alias => typeof alias === "string");
+    }
+    return [];
+  }
+
+  /**
+   * Add events to a timeline
+   *
+   * <p>Will fire "Room.timeline" for each event added.
+   *
+   * @param events - A list of events to add.
+   *
+   * @param toStartOfTimeline -   True to add these events to the start
+   * (oldest) instead of the end (newest) of the timeline. If true, the oldest
+   * event will be the <b>last</b> element of 'events'.
+   *
+   * @param timeline -   timeline to
+   *    add events to.
+   *
+   * @param paginationToken -   token for the next batch of events
+   *
+   * @remarks
+   * Fires {@link RoomEvent.Timeline}
+   */
+  addEventsToTimeline(events, toStartOfTimeline, addToState, timeline, paginationToken) {
+    timeline.getTimelineSet().addEventsToTimeline(events, toStartOfTimeline, addToState, timeline, paginationToken);
+  }
+
+  /**
+   * Get the instance of the thread associated with the current event
+   * @param eventId - the ID of the current event
+   * @returns a thread instance if known
+   */
+  getThread(eventId) {
+    var _this$threads$get;
+    return (_this$threads$get = this.threads.get(eventId)) !== null && _this$threads$get !== void 0 ? _this$threads$get : null;
+  }
+
+  /**
+   * Get all the known threads in the room
+   */
+  getThreads() {
+    return Array.from(this.threads.values());
+  }
+
+  /**
+   * Get a member from the current room state.
+   * @param userId - The user ID of the member.
+   * @returns The member or `null`.
+   */
+  getMember(userId) {
+    return this.currentState.getMember(userId);
+  }
+
+  /**
+   * Get all currently loaded members from the current
+   * room state.
+   * @returns Room members
+   */
+  getMembers() {
+    return this.currentState.getMembers();
+  }
+
+  /**
+   * Get a list of members whose membership state is "join".
+   * @returns A list of currently joined members.
+   */
+  getJoinedMembers() {
+    return this.getMembersWithMembership(KnownMembership.Join);
+  }
+
+  /**
+   * Returns the number of joined members in this room
+   * This method caches the result.
+   * This is a wrapper around the method of the same name in roomState, returning
+   * its result for the room's current state.
+   * @returns The number of members in this room whose membership is 'join'
+   */
+  getJoinedMemberCount() {
+    return this.currentState.getJoinedMemberCount();
+  }
+
+  /**
+   * Returns the number of invited members in this room
+   * @returns The number of members in this room whose membership is 'invite'
+   */
+  getInvitedMemberCount() {
+    return this.currentState.getInvitedMemberCount();
+  }
+
+  /**
+   * Returns the number of invited + joined members in this room
+   * @returns The number of members in this room whose membership is 'invite' or 'join'
+   */
+  getInvitedAndJoinedMemberCount() {
+    return this.getInvitedMemberCount() + this.getJoinedMemberCount();
+  }
+
+  /**
+   * Get a list of members with given membership state.
+   * @param membership - The membership state.
+   * @returns A list of members with the given membership state.
+   */
+  getMembersWithMembership(membership) {
+    return this.currentState.getMembers().filter(function (m) {
+      return m.membership === membership;
+    });
+  }
+
+  /**
+   * Get a list of members we should be encrypting for in this room
+   * @returns A list of members who
+   * we should encrypt messages for in this room.
+   */
+  getEncryptionTargetMembers() {
+    var _this0 = this;
+    return _asyncToGenerator(function* () {
+      yield _this0.loadMembersIfNeeded();
+      var members = _this0.getMembersWithMembership(KnownMembership.Join);
+      if (_this0.shouldEncryptForInvitedMembers()) {
+        members = members.concat(_this0.getMembersWithMembership(KnownMembership.Invite));
+      }
+      return members;
+    })();
+  }
+
+  /**
+   * Determine whether we should encrypt messages for invited users in this room
+   * @returns if we should encrypt messages for invited users
+   */
+  shouldEncryptForInvitedMembers() {
+    var _ev$getContent;
+    var ev = this.currentState.getStateEvents(EventType.RoomHistoryVisibility, "");
+    return (ev === null || ev === void 0 || (_ev$getContent = ev.getContent()) === null || _ev$getContent === void 0 ? void 0 : _ev$getContent.history_visibility) !== "joined";
+  }
+
+  /**
+   * Get the default room name (i.e. what a given user would see if the
+   * room had no m.room.name)
+   * @param userId - The userId from whose perspective we want
+   * to calculate the default name
+   * @returns The default room name
+   */
+  getDefaultRoomName(userId) {
+    return this.calculateRoomName(userId, true);
+  }
+
+  /**
+   * Check if the given user_id has the given membership state.
+   * @param userId - The user ID to check.
+   * @param membership - The membership e.g. `'join'`
+   * @returns True if this user_id has the given membership state.
+   */
+  hasMembershipState(userId, membership) {
+    var member = this.getMember(userId);
+    if (!member) {
+      return false;
+    }
+    return member.membership === membership;
+  }
+
+  /**
+   * Add a timelineSet for this room with the given filter
+   * @param filter - The filter to be applied to this timelineSet
+   * @param opts - Configuration options
+   * @returns The timelineSet
+   */
+  getOrCreateFilteredTimelineSet(filter) {
+    var {
+      prepopulateTimeline = true,
+      useSyncEvents = true,
+      pendingEvents = true
+    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    if (this.filteredTimelineSets[filter.filterId]) {
+      return this.filteredTimelineSets[filter.filterId];
+    }
+    var opts = Object.assign({
+      filter,
+      pendingEvents
+    }, this.opts);
+    var timelineSet = new EventTimelineSet(this, opts);
+    this.reEmitter.reEmit(timelineSet, [RoomEvent.Timeline, RoomEvent.TimelineReset]);
+    if (useSyncEvents) {
+      this.filteredTimelineSets[filter.filterId] = timelineSet;
+      this.timelineSets.push(timelineSet);
+    }
+    var unfilteredLiveTimeline = this.getLiveTimeline();
+    // Not all filter are possible to replicate client-side only
+    // When that's the case we do not want to prepopulate from the live timeline
+    // as we would get incorrect results compared to what the server would send back
+    if (prepopulateTimeline) {
+      // populate up the new timelineSet with filtered events from our live
+      // unfiltered timeline.
+      //
+      // XXX: This is risky as our timeline
+      // may have grown huge and so take a long time to filter.
+      // see https://github.com/vector-im/vector-web/issues/2109
+
+      unfilteredLiveTimeline.getEvents().forEach(function (event) {
+        timelineSet.addLiveEvent(event, {
+          addToState: false
+        }); // Filtered timeline sets should not track state
+      });
+
+      // find the earliest unfiltered timeline
+      var timeline = unfilteredLiveTimeline;
+      while (timeline.getNeighbouringTimeline(EventTimeline.BACKWARDS)) {
+        timeline = timeline.getNeighbouringTimeline(EventTimeline.BACKWARDS);
+      }
+      timelineSet.getLiveTimeline().setPaginationToken(timeline.getPaginationToken(EventTimeline.BACKWARDS), EventTimeline.BACKWARDS);
+    } else if (useSyncEvents) {
+      var livePaginationToken = unfilteredLiveTimeline.getPaginationToken(Direction.Forward);
+      timelineSet.getLiveTimeline().setPaginationToken(livePaginationToken, Direction.Backward);
+    }
+
+    // alternatively, we could try to do something like this to try and re-paginate
+    // in the filtered events from nothing, but Mark says it's an abuse of the API
+    // to do so:
+    //
+    // timelineSet.resetLiveTimeline(
+    //      unfilteredLiveTimeline.getPaginationToken(EventTimeline.FORWARDS)
+    // );
+
+    return timelineSet;
+  }
+  getThreadListFilter() {
+    var _arguments = arguments,
+      _this1 = this;
+    return _asyncToGenerator(function* () {
+      var filterType = _arguments.length > 0 && _arguments[0] !== undefined ? _arguments[0] : ThreadFilterType.All;
+      var myUserId = _this1.client.getUserId();
+      var filter = new Filter(myUserId);
+      var definition = {
+        room: {
+          timeline: {
+            [FILTER_RELATED_BY_REL_TYPES.name]: [THREAD_RELATION_TYPE.name]
+          }
+        }
+      };
+      if (filterType === ThreadFilterType.My) {
+        definition.room.timeline[FILTER_RELATED_BY_SENDERS.name] = [myUserId];
+      }
+      filter.setDefinition(definition);
+      var filterId = yield _this1.client.getOrCreateFilter("THREAD_PANEL_".concat(_this1.roomId, "_").concat(filterType), filter);
+      filter.filterId = filterId;
+      return filter;
+    })();
+  }
+  createThreadTimelineSet(filterType) {
+    var _this10 = this;
+    return _asyncToGenerator(function* () {
+      var timelineSet;
+      if (Thread.hasServerSideListSupport) {
+        timelineSet = new EventTimelineSet(_this10, _objectSpread(_objectSpread({}, _this10.opts), {}, {
+          pendingEvents: false
+        }), undefined, undefined, filterType !== null && filterType !== void 0 ? filterType : ThreadFilterType.All);
+        _this10.reEmitter.reEmit(timelineSet, [RoomEvent.Timeline, RoomEvent.TimelineReset]);
+      } else if (Thread.hasServerSideSupport) {
+        var filter = yield _this10.getThreadListFilter(filterType);
+        timelineSet = _this10.getOrCreateFilteredTimelineSet(filter, {
+          prepopulateTimeline: false,
+          useSyncEvents: false,
+          pendingEvents: false
+        });
+      } else {
+        timelineSet = new EventTimelineSet(_this10, {
+          pendingEvents: false
+        });
+        Array.from(_this10.threads).forEach(_ref3 => {
+          var [, thread] = _ref3;
+          if (thread.length === 0) return;
+          var currentUserParticipated = thread.timeline.some(event => {
+            return event.getSender() === _this10.client.getUserId();
+          });
+          if (filterType !== ThreadFilterType.My || currentUserParticipated) {
+            timelineSet.getLiveTimeline().addEvent(thread.rootEvent, {
+              toStartOfTimeline: false,
+              addToState: false
+            });
+          }
+        });
+      }
+      return timelineSet;
+    })();
+  }
+  /**
+   * Takes the given thread root events and creates threads for them.
+   */
+  processThreadRoots(events, toStartOfTimeline) {
+    if (!this.client.supportsThreads()) return;
+    for (var rootEvent of events) {
+      EventTimeline.setEventMetadata(rootEvent, this.currentState, toStartOfTimeline);
+      if (!this.getThread(rootEvent.getId())) {
+        this.createThread(rootEvent.getId(), rootEvent, [], toStartOfTimeline);
+      }
+    }
+  }
+
+  /**
+   * Fetch the bare minimum of room threads required for the thread list to work reliably.
+   * With server support that means fetching one page.
+   * Without server support that means fetching as much at once as the server allows us to.
+   */
+  fetchRoomThreads() {
+    var _this11 = this;
+    return _asyncToGenerator(function* () {
+      if (_this11.threadsReady || !_this11.client.supportsThreads()) {
+        return;
+      }
+      if (Thread.hasServerSideListSupport) {
+        yield Promise.all([_this11.fetchRoomThreadList(ThreadFilterType.All), _this11.fetchRoomThreadList(ThreadFilterType.My)]);
+      } else {
+        var allThreadsFilter = yield _this11.getThreadListFilter();
+        var {
+          chunk: events
+        } = yield _this11.client.createMessagesRequest(_this11.roomId, "", Number.MAX_SAFE_INTEGER, Direction.Backward, allThreadsFilter);
+        if (!events.length) return;
+
+        // Sorted by last_reply origin_server_ts
+        var threadRoots = events.map(_this11.client.getEventMapper()).sort((eventA, eventB) => {
+          /**
+           * `origin_server_ts` in a decentralised world is far from ideal
+           * but for lack of any better, we will have to use this
+           * Long term the sorting should be handled by homeservers and this
+           * is only meant as a short term patch
+           */
+          var threadAMetadata = eventA.getServerAggregatedRelation(THREAD_RELATION_TYPE.name);
+          var threadBMetadata = eventB.getServerAggregatedRelation(THREAD_RELATION_TYPE.name);
+          return threadAMetadata.latest_event.origin_server_ts - threadBMetadata.latest_event.origin_server_ts;
+        });
+        var latestMyThreadsRootEvent;
+        var roomState = _this11.getLiveTimeline().getState(EventTimeline.FORWARDS);
+        for (var rootEvent of threadRoots) {
+          var _this11$threadsTimeli;
+          var _opts = {
+            duplicateStrategy: DuplicateStrategy.Ignore,
+            fromCache: false,
+            addToState: false,
+            roomState
+          };
+          (_this11$threadsTimeli = _this11.threadsTimelineSets[0]) === null || _this11$threadsTimeli === void 0 || _this11$threadsTimeli.addLiveEvent(rootEvent, _opts);
+          var threadRelationship = rootEvent.getServerAggregatedRelation(THREAD_RELATION_TYPE.name);
+          if (threadRelationship !== null && threadRelationship !== void 0 && threadRelationship.current_user_participated) {
+            var _this11$threadsTimeli2;
+            (_this11$threadsTimeli2 = _this11.threadsTimelineSets[1]) === null || _this11$threadsTimeli2 === void 0 || _this11$threadsTimeli2.addLiveEvent(rootEvent, _opts);
+            latestMyThreadsRootEvent = rootEvent;
+          }
+        }
+        _this11.processThreadRoots(threadRoots, true);
+        _this11.client.decryptEventIfNeeded(threadRoots[threadRoots.length - 1]);
+        if (latestMyThreadsRootEvent) {
+          _this11.client.decryptEventIfNeeded(latestMyThreadsRootEvent);
+        }
+      }
+      _this11.on(ThreadEvent.NewReply, _this11.onThreadReply);
+      _this11.on(ThreadEvent.Update, _this11.onThreadUpdate);
+      _this11.on(ThreadEvent.Delete, _this11.onThreadDelete);
+      _this11.threadsReady = true;
+    })();
+  }
+
+  /**
+   * Process a list of poll events.
+   *
+   * @param events - List of events
+   */
+  processPollEvents(events) {
+    var _this12 = this;
+    return _asyncToGenerator(function* () {
+      for (var event of events) {
+        try {
+          // Continue if the event is a clear text, non-poll event.
+          if (!event.isEncrypted() && !isPollEvent(event)) continue;
+
+          /**
+           * Try to decrypt the event. Promise resolution does not guarantee a successful decryption.
+           * Retry is handled in {@link processPollEvent}.
+           */
+          yield _this12.client.decryptEventIfNeeded(event);
+          _this12.processPollEvent(event);
+        } catch (err) {
+          logger.warn("Error processing poll event", event.getId(), err);
+        }
+      }
+    })();
+  }
+
+  /**
+   * Processes poll events:
+   * If the event has a decryption failure, it will listen for decryption and tries again.
+   * If it is a poll start event (`m.poll.start`),
+   * it creates and stores a Poll model and emits a PollEvent.New event.
+   * If the event is related to a poll, it will add it to the poll.
+   * Noop for other cases.
+   *
+   * @param event - Event that could be a poll event
+   */
+  processPollEvent(event) {
+    var _this13 = this;
+    return _asyncToGenerator(function* () {
+      if (event.isDecryptionFailure()) {
+        event.once(BriijEventEvent.Decrypted, maybeDecryptedEvent => {
+          _this13.processPollEvent(maybeDecryptedEvent);
+        });
+        return;
+      }
+      if (M_POLL_START.matches(event.getType())) {
+        try {
+          var poll = new Poll(event, _this13.client, _this13);
+          _this13.polls.set(event.getId(), poll);
+          _this13.emit(PollEvent.New, poll);
+
+          // remove the poll when redacted
+          event.once(BriijEventEvent.BeforeRedaction, redactedEvent => {
+            _this13.polls.delete(redactedEvent.getId());
+          });
+        } catch (_unused3) {}
+        // poll creation can fail for malformed poll start events
+        return;
+      }
+      var relationEventId = event.relationEventId;
+      if (relationEventId && _this13.polls.has(relationEventId)) {
+        var _poll = _this13.polls.get(relationEventId);
+        _poll === null || _poll === void 0 || _poll.onNewRelation(event);
+      }
+    })();
+  }
+
+  /**
+   * Fetch a single page of threadlist messages for the specific thread filter
+   * @internal
+   */
+  fetchRoomThreadList(filter) {
+    var _this14 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this14.client.supportsThreads()) return;
+      if (_this14.threadsTimelineSets.length === 0) return;
+      var timelineSet = filter === ThreadFilterType.My ? _this14.threadsTimelineSets[1] : _this14.threadsTimelineSets[0];
+      var {
+        chunk: events,
+        end
+      } = yield _this14.client.createThreadListMessagesRequest(_this14.roomId, null, undefined, Direction.Backward, timelineSet.threadListType, timelineSet.getFilter());
+      timelineSet.getLiveTimeline().setPaginationToken(end !== null && end !== void 0 ? end : null, Direction.Backward);
+      if (!events.length) return;
+      var matrixEvents = events.map(_this14.client.getEventMapper());
+      _this14.processThreadRoots(matrixEvents, true);
+      var roomState = _this14.getLiveTimeline().getState(EventTimeline.FORWARDS);
+      for (var rootEvent of matrixEvents) {
+        timelineSet.addLiveEvent(rootEvent, {
+          duplicateStrategy: DuplicateStrategy.Replace,
+          fromCache: false,
+          roomState,
+          addToState: false
+        });
+      }
+    })();
+  }
+  onThreadUpdate(thread) {
+    this.updateThreadRootEvents(thread, false, false);
+  }
+  onThreadReply(thread) {
+    this.updateThreadRootEvents(thread, false, true);
+  }
+  onThreadDelete(thread) {
+    var _timeline$getEvents;
+    this.threads.delete(thread.id);
+    var timeline = this.getTimelineForEvent(thread.id);
+    var roomEvent = timeline === null || timeline === void 0 || (_timeline$getEvents = timeline.getEvents()) === null || _timeline$getEvents === void 0 ? void 0 : _timeline$getEvents.find(it => it.getId() === thread.id);
+    if (roomEvent) {
+      thread.clearEventMetadata(roomEvent);
+    } else {
+      logger.debug("onThreadDelete: Could not find root event in room timeline");
+    }
+    for (var timelineSet of this.threadsTimelineSets) {
+      timelineSet.removeEvent(thread.id);
+    }
+  }
+
+  /**
+   * Forget the timelineSet for this room with the given filter
+   *
+   * @param filter - the filter whose timelineSet is to be forgotten
+   */
+  removeFilteredTimelineSet(filter) {
+    var timelineSet = this.filteredTimelineSets[filter.filterId];
+    delete this.filteredTimelineSets[filter.filterId];
+    var i = this.timelineSets.indexOf(timelineSet);
+    if (i > -1) {
+      this.timelineSets.splice(i, 1);
+    }
+  }
+
+  /**
+   * Determine which timeline(s) a given event should live in
+   * Thread roots live in both the main timeline and their corresponding thread timeline
+   * Relations, redactions, replies to thread relation events live only in the thread timeline
+   * Relations (other than m.thread), redactions, replies to a thread root live only in the main timeline
+   * Relations, redactions, replies where the parent cannot be found live in no timelines but should be aggregated regardless.
+   * Otherwise, the event lives in the main timeline only.
+   *
+   * Note: when a redaction is applied, the redacted event, events relating
+   * to it, and the redaction event itself, will all move to the main thread.
+   * This method classifies them as inside the thread of the redacted event.
+   * They are moved later as part of makeRedacted.
+   * This will change if MSC3389 is merged.
+   */
+  eventShouldLiveIn(event, events, roots) {
+    var _this$client;
+    if (!((_this$client = this.client) !== null && _this$client !== void 0 && _this$client.supportsThreads())) {
+      return {
+        shouldLiveInRoom: true,
+        shouldLiveInThread: false
+      };
+    }
+
+    // A thread root is the only event shown in both timelines
+    if (event.isThreadRoot || roots !== null && roots !== void 0 && roots.has(event.getId())) {
+      return {
+        shouldLiveInRoom: true,
+        shouldLiveInThread: true,
+        threadId: event.getId()
+      };
+    }
+    var isThreadRelation = event.isRelation(THREAD_RELATION_TYPE.name);
+    var parentEventId = event.getAssociatedId();
+    var threadRootId = event.threadRootId;
+
+    // Where the parent is the thread root and this is a non-thread relation this should live only in the main timeline
+    if (!!parentEventId && !isThreadRelation && (threadRootId === parentEventId || roots !== null && roots !== void 0 && roots.has(parentEventId))) {
+      return {
+        shouldLiveInRoom: true,
+        shouldLiveInThread: false
+      };
+    }
+    var parentEvent;
+    if (parentEventId) {
+      var _this$findEventById;
+      parentEvent = (_this$findEventById = this.findEventById(parentEventId)) !== null && _this$findEventById !== void 0 ? _this$findEventById : events === null || events === void 0 ? void 0 : events.find(e => e.getId() === parentEventId);
+    }
+
+    // Treat non-thread-relations, redactions, and replies as extensions of their parents so evaluate parentEvent instead
+    if (parentEvent && !isThreadRelation) {
+      return this.eventShouldLiveIn(parentEvent, events, roots);
+    }
+
+    // A thread relation (1st and 2nd order) is always only shown in a thread
+    if (threadRootId != undefined) {
+      return {
+        shouldLiveInRoom: false,
+        shouldLiveInThread: true,
+        threadId: threadRootId
+      };
+    }
+
+    // Due to replies not being typical relations and being used as fallbacks for threads relations
+    // If we bypass the if case above then we know we are not a thread, so if we are still a reply
+    // then we know that we must be in the main timeline. Same goes if we have no associated parent event.
+    if (!parentEventId || !!event.replyEventId) {
+      return {
+        shouldLiveInRoom: true,
+        shouldLiveInThread: false
+      };
+    }
+
+    // We've exhausted all scenarios,
+    // we cannot assume that it lives in the main timeline as this may be a relation for an unknown thread
+    // adding the event in the wrong timeline causes stuck notifications and can break ability to send read receipts
+    return {
+      shouldLiveInRoom: false,
+      shouldLiveInThread: false
+    };
+  }
+  findThreadForEvent(event) {
+    if (!event) return null;
+    var {
+      threadId
+    } = this.eventShouldLiveIn(event);
+    return threadId ? this.getThread(threadId) : null;
+  }
+  addThreadedEvents(threadId, events) {
+    var toStartOfTimeline = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    var thread = this.getThread(threadId);
+    if (thread) {
+      thread.addEvents(events, toStartOfTimeline);
+    } else {
+      var _this$findEventById2;
+      var rootEvent = (_this$findEventById2 = this.findEventById(threadId)) !== null && _this$findEventById2 !== void 0 ? _this$findEventById2 : events.find(e => e.getId() === threadId);
+      this.createThread(threadId, rootEvent, events, toStartOfTimeline);
+    }
+  }
+
+  /**
+   * Adds events to a thread's timeline. Will fire "Thread.update"
+   */
+  processThreadedEvents(events, toStartOfTimeline) {
+    events.forEach(this.tryApplyRedaction);
+    var eventsByThread = {};
+    for (var event of events) {
+      var _eventsByThread;
+      var {
+        threadId,
+        shouldLiveInThread
+      } = this.eventShouldLiveIn(event);
+      if (shouldLiveInThread && !eventsByThread[threadId]) {
+        eventsByThread[threadId] = [];
+      }
+      (_eventsByThread = eventsByThread[threadId]) === null || _eventsByThread === void 0 || _eventsByThread.push(event);
+    }
+    Object.entries(eventsByThread).map(_ref4 => {
+      var [threadId, threadEvents] = _ref4;
+      return this.addThreadedEvents(threadId, threadEvents, toStartOfTimeline);
+    });
+  }
+  createThread(threadId, rootEvent) {
+    var _this$cachedThreadRea;
+    var events = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+    var toStartOfTimeline = arguments.length > 3 ? arguments[3] : undefined;
+    if (this.threads.has(threadId)) {
+      return this.threads.get(threadId);
+    }
+    if (rootEvent) {
+      var relatedEvents = this.relations.getAllChildEventsForEvent(rootEvent.getId());
+      if (relatedEvents !== null && relatedEvents !== void 0 && relatedEvents.length) {
+        // Include all relations of the root event, given it'll be visible in both timelines,
+        // except `m.replace` as that will already be applied atop the event using `BriijEvent::makeReplaced`
+        events = events.concat(relatedEvents.filter(e => !e.isRelation(RelationType.Replace)));
+      }
+    }
+    var thread = new Thread(threadId, rootEvent, {
+      room: this,
+      client: this.client,
+      pendingEventOrdering: this.opts.pendingEventOrdering,
+      receipts: (_this$cachedThreadRea = this.cachedThreadReadReceipts.get(threadId)) !== null && _this$cachedThreadRea !== void 0 ? _this$cachedThreadRea : []
+    });
+
+    // Add the re-emitter before we start adding events to the thread so we don't miss events
+    this.reEmitter.reEmit(thread, [ThreadEvent.Delete, ThreadEvent.Update, ThreadEvent.NewReply, RoomEvent.Timeline, RoomEvent.TimelineReset]);
+
+    // All read receipts should now come down from sync, we do not need to keep
+    // a reference to the cached receipts anymore.
+    this.cachedThreadReadReceipts.delete(threadId);
+
+    // If we managed to create a thread and figure out its `id` then we can use it
+    // This has to happen before thread.addEvents, because that adds events to the eventtimeline, and the
+    // eventtimeline sometimes looks up thread information via the room.
+    this.threads.set(thread.id, thread);
+
+    // This is necessary to be able to jump to events in threads:
+    // If we jump to an event in a thread where neither the event, nor the root,
+    // nor any thread event are loaded yet, we'll load the event as well as the thread root, create the thread,
+    // and pass the event through this.
+    thread.addEvents(events, false);
+
+    // We need to update the thread root events, but the thread may not be ready yet.
+    // If it isn't, it will fire ThreadEvent.Update when it is and we'll call updateThreadRootEvents then.
+    if (this.threadsReady && thread.initialEventsFetched) {
+      this.updateThreadRootEvents(thread, toStartOfTimeline, false);
+    }
+    this.emit(ThreadEvent.New, thread, toStartOfTimeline);
+    return thread;
+  }
+
+  /**
+   * Applies an event as a redaction of another event, regardless of whether the redacting
+   * event is actually a redaction.
+   *
+   * Callers should use tryApplyRedaction instead.
+   *
+   * @param redactionEvent The event which redacts an event.
+   * @param redactedEvent The event being redacted.
+   * @private
+   */
+  applyEventAsRedaction(redactionEvent, redactedEvent) {
+    var threadRootId = redactedEvent.threadRootId;
+    redactedEvent.makeRedacted(redactionEvent, this);
+
+    // If this is in the current state, replace it with the redacted version
+    if (redactedEvent.isState()) {
+      var currentStateEvent = this.currentState.getStateEvents(redactedEvent.getType(), redactedEvent.getStateKey());
+      if ((currentStateEvent === null || currentStateEvent === void 0 ? void 0 : currentStateEvent.getId()) === redactedEvent.getId()) {
+        this.currentState.setStateEvents([redactedEvent]);
+      }
+    }
+    this.emit(RoomEvent.Redaction, redactionEvent, this, threadRootId);
+
+    // TODO: we stash user displaynames (among other things) in
+    // RoomMember objects which are then attached to other events
+    // (in the sender and target fields). We should get those
+    // RoomMember objects to update themselves when the events that
+    // they are based on are changed.
+
+    // Remove any visibility change on this event.
+    this.visibilityEvents.delete(redactedEvent.getId());
+
+    // If this event is a visibility change event, remove it from the
+    // list of visibility changes and update any event affected by it.
+    if (redactedEvent.isVisibilityEvent()) {
+      this.redactVisibilityChangeEvent(redactionEvent);
+    }
+  }
+  processLiveEvent(event) {
+    this.tryApplyRedaction(event);
+
+    // Implement MSC3531: hiding messages.
+    if (event.isVisibilityEvent()) {
+      // This event changes the visibility of another event, record
+      // the visibility change, inform clients if necessary.
+      this.applyNewVisibilityEvent(event);
+    }
+    // If any pending visibility change is waiting for this (older) event,
+    this.applyPendingVisibilityEvents(event);
+
+    // Sliding Sync modifications:
+    // The proxy cannot guarantee every sent event will have a transaction_id field, so we need
+    // to check the event ID against the list of pending events if there is no transaction ID
+    // field. Only do this for events sent by us though as it's potentially expensive to loop
+    // the pending events map.
+    var txnId = event.getUnsigned().transaction_id;
+    if (!txnId && event.getSender() === this.myUserId) {
+      // check the txn map for a matching event ID
+      for (var [tid, localEvent] of this.txnToEvent) {
+        if (localEvent.getId() === event.getId()) {
+          logger.debug("processLiveEvent: found sent event without txn ID: ", tid, event.getId());
+          // update the unsigned field so we can re-use the same codepaths
+          var unsigned = event.getUnsigned();
+          unsigned.transaction_id = tid;
+          event.setUnsigned(unsigned);
+          break;
+        }
+      }
+    }
+  }
+
+  /**
+   * Add an event to the end of this room's live timelines. Will fire
+   * "Room.timeline".
+   *
+   * @param event - Event to be added
+   * @param addLiveEventOptions - addLiveEvent options
+   * @internal
+   *
+   * @remarks
+   * Fires {@link RoomEvent.Timeline}
+   */
+  addLiveEvent(event, addLiveEventOptions) {
+    var {
+      duplicateStrategy,
+      timelineWasEmpty,
+      fromCache,
+      addToState
+    } = addLiveEventOptions;
+
+    // add to our timeline sets
+    for (var timelineSet of this.timelineSets) {
+      timelineSet.addLiveEvent(event, {
+        duplicateStrategy,
+        fromCache,
+        timelineWasEmpty,
+        addToState
+      });
+    }
+
+    // synthesize and inject implicit read receipts
+    // Done after adding the event because otherwise the app would get a read receipt
+    // pointing to an event that wasn't yet in the timeline
+    // Don't synthesize RR for m.room.redaction as this causes the RR to go missing.
+    if (event.sender && event.getType() !== EventType.RoomRedaction) {
+      this.addReceipt(synthesizeReceipt(event.sender.userId, event, ReceiptType.Read), true);
+
+      // Any live events from a user could be taken as implicit
+      // presence information: evidence that they are currently active.
+      // ...except in a world where we use 'user.currentlyActive' to reduce
+      // presence spam, this isn't very useful - we'll get a transition when
+      // they are no longer currently active anyway. So don't bother to
+      // reset the lastActiveAgo and lastPresenceTs from the RoomState's user.
+    }
+  }
+
+  /**
+   * Add a pending outgoing event to this room.
+   *
+   * <p>The event is added to either the pendingEventList, or the live timeline,
+   * depending on the setting of opts.pendingEventOrdering.
+   *
+   * <p>This is an internal method, intended for use by BriijClient.
+   *
+   * @param event - The event to add.
+   *
+   * @param txnId - Transaction id for this outgoing event
+   *
+   * @throws if the event doesn't have status SENDING, or we aren't given a
+   * unique transaction id.
+   *
+   * @remarks
+   * Fires {@link RoomEvent.LocalEchoUpdated}
+   */
+  addPendingEvent(event, txnId) {
+    if (event.status !== EventStatus.SENDING && event.status !== EventStatus.NOT_SENT) {
+      throw new Error("addPendingEvent called on an event with status " + event.status);
+    }
+    if (this.txnToEvent.get(txnId)) {
+      throw new Error("addPendingEvent called on an event with known txnId " + txnId);
+    }
+
+    // call setEventMetadata to set up event.sender etc
+    // as event is shared over all timelineSets, we set up its metadata based
+    // on the unfiltered timelineSet.
+    EventTimeline.setEventMetadata(event, this.getLiveTimeline().getState(EventTimeline.FORWARDS), false);
+    this.txnToEvent.set(txnId, event);
+    if (this.pendingEventList) {
+      if (this.pendingEventList.some(e => e.status === EventStatus.NOT_SENT)) {
+        logger.warn("Setting event as NOT_SENT due to messages in the same state");
+        event.setStatus(EventStatus.NOT_SENT);
+      }
+      this.pendingEventList.push(event);
+      this.savePendingEvents();
+      if (event.isRelation()) {
+        // For pending events, add them to the relations collection immediately.
+        // (The alternate case below already covers this as part of adding to
+        // the timeline set.)
+        this.aggregateNonLiveRelation(event);
+      }
+      if (event.isRedaction()) {
+        var redactId = event.event.redacts;
+        var redactedEvent = this.pendingEventList.find(e => e.getId() === redactId);
+        if (!redactedEvent && redactId) {
+          redactedEvent = this.findEventById(redactId);
+        }
+        if (redactedEvent) {
+          redactedEvent.markLocallyRedacted(event);
+          this.emit(RoomEvent.Redaction, event, this, redactedEvent.threadRootId);
+        }
+      }
+    } else {
+      for (var timelineSet of this.timelineSets) {
+        if (timelineSet.getFilter()) {
+          if (timelineSet.getFilter().filterRoomTimeline([event]).length) {
+            timelineSet.addEventToTimeline(event, timelineSet.getLiveTimeline(), {
+              toStartOfTimeline: false,
+              addToState: false // We don't support localEcho of state events yet
+            });
+          }
+        } else {
+          timelineSet.addEventToTimeline(event, timelineSet.getLiveTimeline(), {
+            toStartOfTimeline: false,
+            addToState: false // We don't support localEcho of state events yet
+          });
+        }
+      }
+    }
+    this.emit(RoomEvent.LocalEchoUpdated, event, this);
+  }
+
+  /**
+   * Persists all pending events to local storage
+   *
+   * If the current room is encrypted only encrypted events will be persisted
+   * all messages that are not yet encrypted will be discarded
+   *
+   * This is because the flow of EVENT_STATUS transition is
+   * `queued => sending => encrypting => sending => sent`
+   *
+   * Steps 3 and 4 are skipped for unencrypted room.
+   * It is better to discard an unencrypted message rather than persisting
+   * it locally for everyone to read
+   */
+  savePendingEvents() {
+    if (this.pendingEventList) {
+      var pendingEvents = this.pendingEventList.map(event => {
+        return _objectSpread(_objectSpread({}, event.event), {}, {
+          txn_id: event.getTxnId()
+        });
+      }).filter(event => {
+        // Filter out the unencrypted messages if the room is encrypted
+        var isEventEncrypted = event.type === EventType.RoomMessageEncrypted;
+        var isRoomEncrypted = this.hasEncryptionStateEvent();
+        return isEventEncrypted || !isRoomEncrypted;
+      });
+      this.client.store.setPendingEvents(this.roomId, pendingEvents);
+    }
+  }
+
+  /**
+   * Used to aggregate the local echo for a relation, and also
+   * for re-applying a relation after it's redaction has been cancelled,
+   * as the local echo for the redaction of the relation would have
+   * un-aggregated the relation. Note that this is different from regular messages,
+   * which are just kept detached for their local echo.
+   *
+   * Also note that live events are aggregated in the live EventTimelineSet.
+   * @param event - the relation event that needs to be aggregated.
+   */
+  aggregateNonLiveRelation(event) {
+    this.relations.aggregateChildEvent(event);
+  }
+  getEventForTxnId(txnId) {
+    return this.txnToEvent.get(txnId);
+  }
+
+  /**
+   * Deal with the echo of a message we sent.
+   *
+   * <p>We move the event to the live timeline if it isn't there already, and
+   * update it.
+   *
+   * @param remoteEvent -   The event received from
+   *    /sync
+   * @param localEvent -    The local echo, which
+   *    should be either in the pendingEventList or the timeline.
+   *
+   * @internal
+   *
+   * @remarks
+   * Fires {@link RoomEvent.LocalEchoUpdated}
+   */
+  handleRemoteEcho(remoteEvent, localEvent) {
+    var oldEventId = localEvent.getId();
+    var newEventId = remoteEvent.getId();
+    var oldStatus = localEvent.status;
+    logger.debug("Got remote echo for event ".concat(oldEventId, " -> ").concat(newEventId, " old status ").concat(oldStatus));
+
+    // no longer pending
+    this.txnToEvent.delete(remoteEvent.getUnsigned().transaction_id);
+
+    // if it's in the pending list, remove it
+    if (this.pendingEventList) {
+      this.removePendingEvent(oldEventId);
+    }
+
+    // replace the event source (this will preserve the plaintext payload if
+    // any, which is good, because we don't want to try decoding it again).
+    localEvent.handleRemoteEcho(remoteEvent.event);
+    var {
+      shouldLiveInRoom,
+      threadId
+    } = this.eventShouldLiveIn(remoteEvent);
+    var thread = threadId ? this.getThread(threadId) : null;
+    thread === null || thread === void 0 || thread.setEventMetadata(localEvent);
+    thread === null || thread === void 0 || thread.timelineSet.handleRemoteEcho(localEvent, oldEventId, newEventId);
+    if (shouldLiveInRoom) {
+      for (var timelineSet of this.timelineSets) {
+        // if it's already in the timeline, update the timeline map. If it's not, add it.
+        timelineSet.handleRemoteEcho(localEvent, oldEventId, newEventId);
+      }
+    }
+    this.emit(RoomEvent.LocalEchoUpdated, localEvent, this, oldEventId, oldStatus);
+  }
+
+  /**
+   * Update the status / event id on a pending event, to reflect its transmission
+   * progress.
+   *
+   * <p>This is an internal method.
+   *
+   * @param event -      local echo event
+   * @param newStatus -  status to assign
+   * @param newEventId -      new event id to assign. Ignored unless newStatus == EventStatus.SENT.
+   *
+   * @remarks
+   * Fires {@link RoomEvent.LocalEchoUpdated}
+   */
+  updatePendingEvent(event, newStatus, newEventId) {
+    logger.log("setting pendingEvent status to ".concat(newStatus, " in ").concat(event.getRoomId(), " ") + "event ID ".concat(event.getId(), " -> ").concat(newEventId));
+
+    // if the message was sent, we expect an event id
+    if (newStatus == EventStatus.SENT && !newEventId) {
+      throw new Error("updatePendingEvent called with status=SENT, but no new event id");
+    }
+
+    // SENT races against /sync, so we have to special-case it.
+    if (newStatus == EventStatus.SENT) {
+      var timeline = this.getTimelineForEvent(newEventId);
+      if (timeline) {
+        // we've already received the event via the event stream.
+        // nothing more to do here, assuming the transaction ID was correctly matched.
+        // Let's check that.
+        var remoteEvent = this.findEventById(newEventId);
+        var remoteTxnId = remoteEvent === null || remoteEvent === void 0 ? void 0 : remoteEvent.getUnsigned().transaction_id;
+        if (!remoteTxnId && remoteEvent) {
+          // This code path is mostly relevant for the Sliding Sync proxy.
+          // The remote event did not contain a transaction ID, so we did not handle
+          // the remote echo yet. Handle it now.
+          var unsigned = remoteEvent.getUnsigned();
+          unsigned.transaction_id = event.getTxnId();
+          remoteEvent.setUnsigned(unsigned);
+          // the remote event is _already_ in the timeline, so we need to remove it so
+          // we can convert the local event into the final event.
+          this.removeEvent(remoteEvent.getId());
+          this.handleRemoteEcho(remoteEvent, event);
+        }
+        return;
+      }
+    }
+    var oldStatus = event.status;
+    var oldEventId = event.getId();
+    if (!oldStatus) {
+      throw new Error("updatePendingEventStatus called on an event which is not a local echo.");
+    }
+    var allowed = ALLOWED_TRANSITIONS[oldStatus];
+    if (!(allowed !== null && allowed !== void 0 && allowed.includes(newStatus))) {
+      throw new Error("Invalid EventStatus transition ".concat(oldStatus, "->").concat(newStatus));
+    }
+    event.setStatus(newStatus);
+    if (newStatus == EventStatus.SENT) {
+      // update the event id
+      event.replaceLocalEventId(newEventId);
+      var {
+        shouldLiveInRoom,
+        threadId
+      } = this.eventShouldLiveIn(event);
+      var thread = threadId ? this.getThread(threadId) : undefined;
+      thread === null || thread === void 0 || thread.setEventMetadata(event);
+      thread === null || thread === void 0 || thread.timelineSet.replaceEventId(oldEventId, newEventId);
+      if (shouldLiveInRoom) {
+        // if the event was already in the timeline (which will be the case if
+        // opts.pendingEventOrdering==chronological), we need to update the
+        // timeline map.
+        for (var timelineSet of this.timelineSets) {
+          timelineSet.replaceEventId(oldEventId, newEventId);
+        }
+      }
+    } else if (newStatus == EventStatus.CANCELLED) {
+      // remove it from the pending event list, or the timeline.
+      if (this.pendingEventList) {
+        var removedEvent = this.getPendingEvent(oldEventId);
+        this.removePendingEvent(oldEventId);
+        if (removedEvent !== null && removedEvent !== void 0 && removedEvent.isRedaction()) {
+          this.revertRedactionLocalEcho(removedEvent);
+        }
+      }
+      this.removeEvent(oldEventId);
+    }
+    this.savePendingEvents();
+    this.emit(RoomEvent.LocalEchoUpdated, event, this, oldEventId, oldStatus);
+  }
+  revertRedactionLocalEcho(redactionEvent) {
+    var redactId = redactionEvent.event.redacts;
+    if (!redactId) {
+      return;
+    }
+    var redactedEvent = this.getUnfilteredTimelineSet().findEventById(redactId);
+    if (redactedEvent) {
+      redactedEvent.unmarkLocallyRedacted();
+      // re-render after undoing redaction
+      this.emit(RoomEvent.RedactionCancelled, redactionEvent, this);
+      // reapply relation now redaction failed
+      if (redactedEvent.isRelation()) {
+        this.aggregateNonLiveRelation(redactedEvent);
+      }
+    }
+  }
+  assertTimelineSetsAreLive() {
+    for (var i = 0; i < this.timelineSets.length; i++) {
+      var liveTimeline = this.timelineSets[i].getLiveTimeline();
+      if (liveTimeline.getPaginationToken(EventTimeline.FORWARDS)) {
+        throw new Error("live timeline " + i + " is no longer live - it has a pagination token " + "(" + liveTimeline.getPaginationToken(EventTimeline.FORWARDS) + ")");
+      }
+      if (liveTimeline.getNeighbouringTimeline(EventTimeline.FORWARDS)) {
+        throw new Error("live timeline ".concat(i, " is no longer live - it has a neighbouring timeline"));
+      }
+    }
+  }
+
+  /**
+   * Add some events to this room. This can include state events, message
+   * events and typing notifications. These events are treated as "live" so
+   * they will go to the end of the timeline.
+   *
+   * @param events - A list of events to add.
+   * @param addLiveEventOptions - addLiveEvent options
+   * @throws If `duplicateStrategy` is not falsey, 'replace' or 'ignore'.
+   */
+  addLiveEvents(events, addLiveEventOptions) {
+    var _this15 = this;
+    return _asyncToGenerator(function* () {
+      var {
+        duplicateStrategy,
+        fromCache,
+        timelineWasEmpty = false,
+        addToState
+      } = addLiveEventOptions;
+      if (duplicateStrategy && ["replace", "ignore"].indexOf(duplicateStrategy) === -1) {
+        throw new Error("duplicateStrategy MUST be either 'replace' or 'ignore'");
+      }
+
+      // sanity check that the live timeline is still live
+      _this15.assertTimelineSetsAreLive();
+      var threadRoots = _this15.findThreadRoots(events);
+      var eventsByThread = {};
+      var options = {
+        duplicateStrategy,
+        fromCache,
+        timelineWasEmpty,
+        addToState
+      };
+
+      // List of extra events to check for being parents of any relations encountered
+      var neighbouringEvents = [...events];
+      for (var event of events) {
+        var _eventsByThread$threa;
+        // TODO: We should have a filter to say "only add state event types X Y Z to the timeline".
+        _this15.processLiveEvent(event);
+        if (event.getUnsigned().transaction_id) {
+          var existingEvent = _this15.txnToEvent.get(event.getUnsigned().transaction_id);
+          if (existingEvent) {
+            // remote echo of an event we sent earlier
+            _this15.handleRemoteEcho(event, existingEvent);
+            continue; // we can skip adding the event to the timeline sets, it is already there
+          }
+        }
+        var {
+          shouldLiveInRoom,
+          shouldLiveInThread,
+          threadId = ""
+        } = _this15.eventShouldLiveIn(event, neighbouringEvents, threadRoots);
+        if (!shouldLiveInThread && !shouldLiveInRoom && event.isRelation()) {
+          try {
+            var parentEvent = new BriijEvent(yield _this15.client.fetchRoomEvent(_this15.roomId, event.relationEventId));
+            neighbouringEvents.push(parentEvent);
+            if (parentEvent.threadRootId) {
+              threadRoots.add(parentEvent.threadRootId);
+              var unsigned = event.getUnsigned();
+              unsigned[UNSIGNED_THREAD_ID_FIELD.name] = parentEvent.threadRootId;
+              event.setUnsigned(unsigned);
+            }
+            ({
+              shouldLiveInRoom,
+              shouldLiveInThread,
+              threadId = ""
+            } = _this15.eventShouldLiveIn(event, neighbouringEvents, threadRoots));
+          } catch (e) {
+            logger.error("Failed to load parent event of unhandled relation", e);
+          }
+        }
+        if (shouldLiveInThread && !eventsByThread[threadId]) {
+          eventsByThread[threadId] = [];
+        }
+        (_eventsByThread$threa = eventsByThread[threadId]) === null || _eventsByThread$threa === void 0 || _eventsByThread$threa.push(event);
+        if (shouldLiveInRoom) {
+          _this15.addLiveEvent(event, options);
+        } else if (!shouldLiveInThread && event.isRelation()) {
+          _this15.relations.aggregateChildEvent(event);
+        }
+      }
+      Object.entries(eventsByThread).forEach(_ref5 => {
+        var [threadId, threadEvents] = _ref5;
+        _this15.addThreadedEvents(threadId, threadEvents, false);
+      });
+    })();
+  }
+  partitionThreadedEvents(events) {
+    // Indices to the events array, for readability
+    var ROOM = 0;
+    var THREAD = 1;
+    var UNKNOWN_RELATION = 2;
+    if (this.client.supportsThreads()) {
+      var threadRoots = this.findThreadRoots(events);
+      return events.reduce((memo, event) => {
+        var {
+          shouldLiveInRoom,
+          shouldLiveInThread,
+          threadId
+        } = this.eventShouldLiveIn(event, events, threadRoots);
+        if (shouldLiveInRoom) {
+          memo[ROOM].push(event);
+        }
+        if (shouldLiveInThread) {
+          event.setThreadId(threadId !== null && threadId !== void 0 ? threadId : "");
+          memo[THREAD].push(event);
+        }
+        if (!shouldLiveInThread && !shouldLiveInRoom) {
+          memo[UNKNOWN_RELATION].push(event);
+        }
+        return memo;
+      }, [[], [], []]);
+    } else {
+      // When `threadSupport` is disabled treat all events as timelineEvents
+      return [events, [], []];
+    }
+  }
+
+  /**
+   * Given some events, find the IDs of all the thread roots that are referred to by them.
+   */
+  findThreadRoots(events) {
+    var threadRoots = new Set();
+    for (var event of events) {
+      var threadRootId = event.threadRootId;
+      if (threadRootId != undefined) {
+        threadRoots.add(threadRootId);
+      }
+    }
+    return threadRoots;
+  }
+
+  /**
+   * Add a receipt event to the room.
+   * @param event - The m.receipt event.
+   * @param synthetic - True if this event is implicit.
+   */
+  addReceipt(event) {
+    var synthetic = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    var content = event.getContent();
+    this.roomReceipts.add(content, synthetic);
+
+    // TODO: delete the following code when it has been replaced by RoomReceipts
+    Object.keys(content).forEach(eventId => {
+      Object.keys(content[eventId]).forEach(receiptType => {
+        Object.keys(content[eventId][receiptType]).forEach(userId => {
+          var _receipt$thread_id, _this$unthreadedRecei, _this$unthreadedRecei2;
+          var receipt = content[eventId][receiptType][userId];
+          var receiptForMainTimeline = !receipt.thread_id || receipt.thread_id === MAIN_ROOM_TIMELINE;
+          var receiptDestination = receiptForMainTimeline ? this : this.threads.get((_receipt$thread_id = receipt.thread_id) !== null && _receipt$thread_id !== void 0 ? _receipt$thread_id : "");
+          if (receiptDestination) {
+            receiptDestination.addReceiptToStructure(eventId, receiptType, userId, receipt, synthetic);
+
+            // If the read receipt sent for the logged in user matches
+            // the last event of the live timeline, then we know for a fact
+            // that the user has read that message, so we can mark the room
+            // as read and not wait for the remote echo from synapse.
+            //
+            // This needs to be done after the initial sync as we do not want this
+            // logic to run whilst the room is being initialised
+            //
+            // We only do this for non-synthetic receipts, because
+            // our intention is to do this when the user really did
+            // just read a message, not when we are e.g. receiving
+            // an event during the sync. More explanation at:
+            // https://github.com/matrix-org/matrix-js-sdk/issues/3684
+            if (!synthetic && this.client.isInitialSyncComplete() && userId === this.client.getUserId()) {
+              var lastEvent = receiptDestination.timeline[receiptDestination.timeline.length - 1];
+              if (lastEvent && eventId === lastEvent.getId() && userId === lastEvent.getSender()) {
+                receiptDestination.setUnread(NotificationCountType.Total, 0);
+                receiptDestination.setUnread(NotificationCountType.Highlight, 0);
+              }
+            }
+          } else {
+            var _this$cachedThreadRea2;
+            // The thread does not exist locally, keep the read receipt
+            // in a cache locally, and re-apply  the `addReceipt` logic
+            // when the thread is created
+            this.cachedThreadReadReceipts.set(receipt.thread_id, [...((_this$cachedThreadRea2 = this.cachedThreadReadReceipts.get(receipt.thread_id)) !== null && _this$cachedThreadRea2 !== void 0 ? _this$cachedThreadRea2 : []), {
+              eventId,
+              receiptType,
+              userId,
+              receipt,
+              synthetic
+            }]);
+          }
+          var me = this.client.getUserId();
+          // Track the time of the current user's oldest threaded receipt in the room.
+          if (userId === me && !receiptForMainTimeline && receipt.ts < this.oldestThreadedReceiptTs) {
+            this.oldestThreadedReceiptTs = receipt.ts;
+          }
+
+          // Track each user's unthreaded read receipt.
+          if (!receipt.thread_id && receipt.ts > ((_this$unthreadedRecei = (_this$unthreadedRecei2 = this.unthreadedReceipts.get(userId)) === null || _this$unthreadedRecei2 === void 0 ? void 0 : _this$unthreadedRecei2.ts) !== null && _this$unthreadedRecei !== void 0 ? _this$unthreadedRecei : 0)) {
+            this.unthreadedReceipts.set(userId, receipt);
+          }
+        });
+      });
+    });
+    // End of code to delete when replaced by RoomReceipts
+
+    // send events after we've regenerated the structure & cache, otherwise things that
+    // listened for the event would read stale data.
+    this.emit(RoomEvent.Receipt, event, this);
+  }
+
+  /**
+   * Adds/handles ephemeral events such as typing notifications and read receipts.
+   * @param events - A list of events to process
+   */
+  addEphemeralEvents(events) {
+    for (var event of events) {
+      if (event.getType() === EventType.Typing) {
+        this.currentState.setTypingEvent(event);
+      } else if (event.getType() === EventType.Receipt) {
+        this.addReceipt(event);
+      } // else ignore - life is too short for us to care about these events
+    }
+  }
+
+  /**
+   * Removes events from this room.
+   * @param eventIds - A list of eventIds to remove.
+   */
+  removeEvents(eventIds) {
+    for (var eventId of eventIds) {
+      this.removeEvent(eventId);
+    }
+  }
+
+  /**
+   * Removes a single event from this room.
+   *
+   * @param eventId -  The id of the event to remove
+   *
+   * @returns true if the event was removed from any of the room's timeline sets
+   */
+  removeEvent(eventId) {
+    var removedAny = false;
+    for (var timelineSet of this.timelineSets) {
+      var removed = timelineSet.removeEvent(eventId);
+      if (removed) {
+        if (removed.isRedaction()) {
+          this.revertRedactionLocalEcho(removed);
+        }
+        removedAny = true;
+      }
+    }
+    return removedAny;
+  }
+
+  /**
+   * Recalculate various aspects of the room, including the room name and
+   * room summary. Call this any time the room's current state is modified.
+   * May fire "Room.name" if the room name is updated.
+   *
+   * @remarks
+   * Fires {@link RoomEvent.Name}
+   */
+  recalculate() {
+    // set fake stripped state events if this is an invite room so logic remains
+    // consistent elsewhere.
+    var membershipEvent = this.currentState.getStateEvents(EventType.RoomMember, this.myUserId);
+    if (membershipEvent) {
+      var membership = membershipEvent.getContent().membership;
+      this.updateMyMembership(membership);
+      if (membership === KnownMembership.Invite) {
+        var strippedStateEvents = membershipEvent.getUnsigned().invite_room_state || [];
+        strippedStateEvents.forEach(strippedEvent => {
+          var existingEvent = this.currentState.getStateEvents(strippedEvent.type, strippedEvent.state_key);
+          if (!existingEvent) {
+            // set the fake stripped event instead
+            this.currentState.setStateEvents([new BriijEvent({
+              type: strippedEvent.type,
+              state_key: strippedEvent.state_key,
+              content: strippedEvent.content,
+              event_id: "$fake" + Date.now(),
+              room_id: this.roomId,
+              sender: this.myUserId // technically a lie
+            })]);
+          }
+        });
+      }
+    }
+    var oldName = this.name;
+    this.name = this.calculateRoomName(this.myUserId);
+    this.normalizedName = normalize(this.name);
+    this.summary = new RoomSummary(this.roomId, {
+      title: this.name
+    });
+    if (oldName !== this.name) {
+      this.emit(RoomEvent.Name, this);
+    }
+  }
+
+  /**
+   * Update the room-tag event for the room.  The previous one is overwritten.
+   * @param event - the m.tag event
+   */
+  addTags(event) {
+    // event content looks like:
+    // content: {
+    //    tags: {
+    //       $tagName: { $metadata: $value },
+    //       $tagName: { $metadata: $value },
+    //    }
+    // }
+
+    // XXX: do we need to deep copy here?
+    this.tags = event.getContent().tags || {};
+
+    // XXX: we could do a deep-comparison to see if the tags have really
+    // changed - but do we want to bother?
+    this.emit(RoomEvent.Tags, event, this);
+  }
+
+  /**
+   * Update the account_data events for this room, overwriting events of the same type.
+   * @param events - an array of account_data events to add
+   */
+  addAccountData(events) {
+    for (var event of events) {
+      if (event.getType() === "m.tag") {
+        this.addTags(event);
+      }
+      var eventType = event.getType();
+      var lastEvent = this.accountData.get(eventType);
+      this.accountData.set(eventType, event);
+      this.emit(RoomEvent.AccountData, event, this, lastEvent);
+    }
+  }
+
+  /**
+   * Access account_data event of given event type for this room
+   * @param type - the type of account_data event to be accessed
+   * @returns the account_data event in question
+   */
+  getAccountData(type) {
+    return this.accountData.get(type);
+  }
+
+  /**
+   * Get an iterator of currently active sticky events.
+   */
+  // eslint-disable-next-line
+  _unstable_getStickyEvents() {
+    return this.stickyEvents.getStickyEvents();
+  }
+
+  /**
+   * Get a sticky event that match the given `type`, `sender`, and `stickyKey`
+   * @param type The event `type`.
+   * @param sender The sender of the sticky event.
+   * @param stickyKey The sticky key used by the event.
+   * @returns A matching active sticky event, or undefined.
+   */
+  // eslint-disable-next-line
+  _unstable_getKeyedStickyEvent(sender, type, stickyKey) {
+    return this.stickyEvents.getKeyedStickyEvent(sender, type, stickyKey);
+  }
+
+  /**
+   * Get active sticky events without a sticky key that match the given `type` and `sender`.
+   * @param type The event `type`.
+   * @param sender The sender of the sticky event.
+   * @returns An array of matching sticky events.
+   */
+  // eslint-disable-next-line
+  _unstable_getUnkeyedStickyEvent(sender, type) {
+    return this.stickyEvents.getUnkeyedStickyEvent(sender, type);
+  }
+
+  /**
+   * Add a series of sticky events, emitting `RoomEvent.StickyEvents` if any
+   * changes were made.
+   * @param events A set of new sticky events.
+   * @internal
+   */
+  // eslint-disable-next-line
+  _unstable_addStickyEvents(events) {
+    return this.stickyEvents.addStickyEvents(events);
+  }
+
+  /**
+   * Returns whether the syncing user has permission to send a message in the room
+   * @returns true if the user should be permitted to send
+   *                   message events into the room.
+   */
+  maySendMessage() {
+    return this.getMyMembership() === KnownMembership.Join && (this.hasEncryptionStateEvent() ? this.currentState.maySendEvent(EventType.RoomMessageEncrypted, this.myUserId) : this.currentState.maySendEvent(EventType.RoomMessage, this.myUserId));
+  }
+
+  /**
+   * Returns whether the given user has permissions to issue an invite for this room.
+   * @param userId - the ID of the Matrix user to check permissions for
+   * @returns true if the user should be permitted to issue invites for this room.
+   */
+  canInvite(userId) {
+    var canInvite = this.getMyMembership() === KnownMembership.Join;
+    var powerLevelsEvent = this.currentState.getStateEvents(EventType.RoomPowerLevels, "");
+    var powerLevels = powerLevelsEvent && powerLevelsEvent.getContent();
+    var me = this.getMember(userId);
+    if (powerLevels && me && powerLevels.invite > me.powerLevel) {
+      canInvite = false;
+    }
+    return canInvite;
+  }
+
+  /**
+   * Returns the join rule based on the m.room.join_rule state event, defaulting to `invite`.
+   * @returns the join_rule applied to this room
+   */
+  getJoinRule() {
+    return this.currentState.getJoinRule();
+  }
+
+  /**
+   * Returns the history visibility based on the m.room.history_visibility state event, defaulting to `shared`.
+   * @returns the history_visibility applied to this room
+   */
+  getHistoryVisibility() {
+    return this.currentState.getHistoryVisibility();
+  }
+
+  /**
+   * Returns the history visibility based on the m.room.history_visibility state event, defaulting to `shared`.
+   * @returns the history_visibility applied to this room
+   */
+  getGuestAccess() {
+    return this.currentState.getGuestAccess();
+  }
+
+  /**
+   * Returns the type of the room from the `m.room.create` event content or undefined if none is set
+   * @returns the type of the room.
+   */
+  getType() {
+    var createEvent = this.currentState.getStateEvents(EventType.RoomCreate, "");
+    if (!createEvent) {
+      if (!this.getTypeWarning) {
+        logger.warn("[getType] Room " + this.roomId + " does not have an m.room.create event");
+        this.getTypeWarning = true;
+      }
+      return undefined;
+    }
+    return createEvent.getContent()[RoomCreateTypeField];
+  }
+
+  /**
+   * Returns whether the room is a space-room as defined by MSC1772.
+   * @returns true if the room's type is RoomType.Space
+   */
+  isSpaceRoom() {
+    return this.getType() === RoomType.Space;
+  }
+
+  /**
+   * Returns whether the room is a call-room as defined by MSC3417.
+   * @returns true if the room's type is RoomType.UnstableCall
+   */
+  isCallRoom() {
+    return this.getType() === RoomType.UnstableCall;
+  }
+
+  /**
+   * Returns whether the room is a video room.
+   * @returns true if the room's type is RoomType.ElementVideo
+   */
+  isElementVideoRoom() {
+    return this.getType() === RoomType.ElementVideo;
+  }
+
+  /**
+   * Find the predecessor of this room.
+   *
+   * @param msc3946ProcessDynamicPredecessor - if true, look for an
+   * m.room.predecessor state event and use it if found (MSC3946).
+   * @returns null if this room has no predecessor. Otherwise, returns
+   * the roomId, last eventId and viaServers of the predecessor room.
+   *
+   * If msc3946ProcessDynamicPredecessor is true, use m.predecessor events
+   * as well as m.room.create events to find predecessors.
+   *
+   * Note: if an m.predecessor event is used, eventId may be undefined
+   * since last_known_event_id is optional.
+   *
+   * Note: viaServers may be undefined, and will definitely be undefined if
+   * this predecessor comes from a RoomCreate event (rather than a
+   * RoomPredecessor, which has the optional via_servers property).
+   */
+  findPredecessor() {
+    var msc3946ProcessDynamicPredecessor = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    var currentState = this.getLiveTimeline().getState(EventTimeline.FORWARDS);
+    if (!currentState) {
+      return null;
+    }
+    return currentState.findPredecessor(msc3946ProcessDynamicPredecessor);
+  }
+  roomNameGenerator(state) {
+    if (this.client.roomNameGenerator) {
+      var name = this.client.roomNameGenerator(this.roomId, state);
+      if (name !== null) {
+        return name;
+      }
+    }
+    switch (state.type) {
+      case RoomNameType.Actual:
+        return state.name;
+      case RoomNameType.Generated:
+        switch (state.subtype) {
+          case "Inviting":
+            return "Inviting ".concat(memberNamesToRoomName(state.names, state.count));
+          default:
+            return memberNamesToRoomName(state.names, state.count);
+        }
+      case RoomNameType.EmptyRoom:
+        if (state.oldName) {
+          return "Empty room (was ".concat(state.oldName, ")");
+        } else {
+          return "Empty room";
+        }
+    }
+  }
+
+  /**
+   * This is an internal method. Calculates the name of the room from the current
+   * room state.
+   * @param userId - The client's user ID. Used to filter room members
+   * correctly.
+   * @param ignoreRoomNameEvent - Return the implicit room name that we'd see if there
+   * was no m.room.name event.
+   * @returns The calculated room name.
+   */
+  calculateRoomName(userId) {
+    var ignoreRoomNameEvent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    if (!ignoreRoomNameEvent) {
+      var _this$currentState$ge4;
+      var name = (_this$currentState$ge4 = this.currentState.getStateEvents(EventType.RoomName, "")) === null || _this$currentState$ge4 === void 0 ? void 0 : _this$currentState$ge4.getContent().name;
+      if (name && typeof name === "string") {
+        return this.roomNameGenerator({
+          type: RoomNameType.Actual,
+          name
+        });
+      }
+    }
+    var alias = this.getCanonicalAlias();
+    if (alias) {
+      return this.roomNameGenerator({
+        type: RoomNameType.Actual,
+        name: alias
+      });
+    }
+    var joinedMemberCount = this.currentState.getJoinedMemberCount();
+    var invitedMemberCount = this.currentState.getInvitedMemberCount();
+    // -1 because these numbers include the syncing user
+    var inviteJoinCount = joinedMemberCount + invitedMemberCount - 1;
+
+    // get service members (e.g. helper bots) for exclusion
+    var excludedUserIds = this.getFunctionalMembers();
+
+    // get members from heroes that are NOT ourselves
+    var otherNames = [];
+    if (this.heroes) {
+      // if we have heroes, use those as the names
+      this.heroes.forEach(hero => {
+        // filter service members
+        if (excludedUserIds.includes(hero.userId)) {
+          inviteJoinCount--;
+          return;
+        }
+        // If the hero has a display name, use that.
+        // Otherwise, look their user ID up in the membership and use
+        // the name from there, or the user ID as a last resort.
+        if (hero.displayName) {
+          otherNames.push(hero.displayName);
+        } else {
+          var member = this.getMember(hero.userId);
+          otherNames.push(member ? member.name : hero.userId);
+        }
+      });
+    } else {
+      var otherMembers = this.currentState.getMembers().filter(m => {
+        return m.userId !== userId && (m.membership === KnownMembership.Invite || m.membership === KnownMembership.Join);
+      });
+      otherMembers = otherMembers.filter(_ref6 => {
+        var {
+          userId
+        } = _ref6;
+        // filter service members
+        if (excludedUserIds.includes(userId)) {
+          inviteJoinCount--;
+          return false;
+        }
+        return true;
+      });
+      // make sure members have stable order
+      var collator = new Intl.Collator();
+      otherMembers.sort((a, b) => collator.compare(a.userId, b.userId));
+      // only 5 first members, immitate summaryHeroes
+      otherMembers = otherMembers.slice(0, 5);
+      otherNames = otherMembers.map(m => m.name);
+    }
+    if (inviteJoinCount) {
+      return this.roomNameGenerator({
+        type: RoomNameType.Generated,
+        names: otherNames,
+        count: inviteJoinCount
+      });
+    }
+    var myMembership = this.getMyMembership();
+    // if I have created a room and invited people through
+    // 3rd party invites
+    if (myMembership == KnownMembership.Join) {
+      var thirdPartyInvites = this.currentState.getStateEvents(EventType.RoomThirdPartyInvite);
+      if (thirdPartyInvites !== null && thirdPartyInvites !== void 0 && thirdPartyInvites.length) {
+        var thirdPartyNames = thirdPartyInvites.map(i => {
+          return i.getContent().display_name;
+        });
+        return this.roomNameGenerator({
+          type: RoomNameType.Generated,
+          subtype: "Inviting",
+          names: thirdPartyNames,
+          count: thirdPartyNames.length + 1
+        });
+      }
+    }
+
+    // let's try to figure out who was here before
+    var leftNames = otherNames;
+    // if we didn't have heroes, try finding them in the room state
+    if (!leftNames.length) {
+      leftNames = this.currentState.getMembers().filter(m => {
+        return m.userId !== userId && m.membership !== KnownMembership.Invite && m.membership !== KnownMembership.Join;
+      }).map(m => m.name);
+    }
+    var oldName;
+    if (leftNames.length) {
+      oldName = this.roomNameGenerator({
+        type: RoomNameType.Generated,
+        names: leftNames,
+        count: leftNames.length + 1
+      });
+    }
+    return this.roomNameGenerator({
+      type: RoomNameType.EmptyRoom,
+      oldName
+    });
+  }
+
+  /**
+   * When we receive a new visibility change event:
+   *
+   * - store this visibility change alongside the timeline, in case we
+   *   later need to apply it to an event that we haven't received yet;
+   * - if we have already received the event whose visibility has changed,
+   *   patch it to reflect the visibility change and inform listeners.
+   */
+  applyNewVisibilityEvent(event) {
+    var visibilityChange = event.asVisibilityChange();
+    if (!visibilityChange) {
+      // The event is ill-formed.
+      return;
+    }
+
+    // Ignore visibility change events that are not emitted by moderators.
+    var userId = event.getSender();
+    if (!userId) {
+      return;
+    }
+    var isPowerSufficient = EVENT_VISIBILITY_CHANGE_TYPE.name && this.currentState.maySendStateEvent(EVENT_VISIBILITY_CHANGE_TYPE.name, userId) || EVENT_VISIBILITY_CHANGE_TYPE.altName && this.currentState.maySendStateEvent(EVENT_VISIBILITY_CHANGE_TYPE.altName, userId);
+    if (!isPowerSufficient) {
+      // Powerlevel is insufficient.
+      return;
+    }
+
+    // Record this change in visibility.
+    // If the event is not in our timeline and we only receive it later,
+    // we may need to apply the visibility change at a later date.
+
+    var visibilityEventsOnOriginalEvent = this.visibilityEvents.get(visibilityChange.eventId);
+    if (visibilityEventsOnOriginalEvent) {
+      // It would be tempting to simply erase the latest visibility change
+      // but we need to record all of the changes in case the latest change
+      // is ever redacted.
+      //
+      // In practice, linear scans through `visibilityEvents` should be fast.
+      // However, to protect against a potential DoS attack, we limit the
+      // number of iterations in this loop.
+      var index = visibilityEventsOnOriginalEvent.length - 1;
+      var min = Math.max(0, visibilityEventsOnOriginalEvent.length - MAX_NUMBER_OF_VISIBILITY_EVENTS_TO_SCAN_THROUGH);
+      for (; index >= min; --index) {
+        var target = visibilityEventsOnOriginalEvent[index];
+        if (target.getTs() < event.getTs()) {
+          break;
+        }
+      }
+      if (index === -1) {
+        visibilityEventsOnOriginalEvent.unshift(event);
+      } else {
+        visibilityEventsOnOriginalEvent.splice(index + 1, 0, event);
+      }
+    } else {
+      this.visibilityEvents.set(visibilityChange.eventId, [event]);
+    }
+
+    // Finally, let's check if the event is already in our timeline.
+    // If so, we need to patch it and inform listeners.
+
+    var originalEvent = this.findEventById(visibilityChange.eventId);
+    if (!originalEvent) {
+      return;
+    }
+    originalEvent.applyVisibilityEvent(visibilityChange);
+  }
+  redactVisibilityChangeEvent(event) {
+    // Sanity checks.
+    if (!event.isVisibilityEvent) {
+      throw new Error("expected a visibility change event");
+    }
+    var relation = event.getRelation();
+    var originalEventId = relation === null || relation === void 0 ? void 0 : relation.event_id;
+    var visibilityEventsOnOriginalEvent = this.visibilityEvents.get(originalEventId);
+    if (!visibilityEventsOnOriginalEvent) {
+      // No visibility changes on the original event.
+      // In particular, this change event was not recorded,
+      // most likely because it was ill-formed.
+      return;
+    }
+    var index = visibilityEventsOnOriginalEvent.findIndex(change => change.getId() === event.getId());
+    if (index === -1) {
+      // This change event was not recorded, most likely because
+      // it was ill-formed.
+      return;
+    }
+    // Remove visibility change.
+    visibilityEventsOnOriginalEvent.splice(index, 1);
+
+    // If we removed the latest visibility change event, propagate changes.
+    if (index === visibilityEventsOnOriginalEvent.length) {
+      var originalEvent = this.findEventById(originalEventId);
+      if (!originalEvent) {
+        return;
+      }
+      if (index === 0) {
+        // We have just removed the only visibility change event.
+        this.visibilityEvents.delete(originalEventId);
+        originalEvent.applyVisibilityEvent();
+      } else {
+        var newEvent = visibilityEventsOnOriginalEvent[visibilityEventsOnOriginalEvent.length - 1];
+        var newVisibility = newEvent.asVisibilityChange();
+        if (!newVisibility) {
+          // Event is ill-formed.
+          // This breaks our invariant.
+          throw new Error("at this stage, visibility changes should be well-formed");
+        }
+        originalEvent.applyVisibilityEvent(newVisibility);
+      }
+    }
+  }
+
+  /**
+   * When we receive an event whose visibility has been altered by
+   * a (more recent) visibility change event, patch the event in
+   * place so that clients now not to display it.
+   *
+   * @param event - Any matrix event. If this event has at least one a
+   * pending visibility change event, apply the latest visibility
+   * change event.
+   */
+  applyPendingVisibilityEvents(event) {
+    var visibilityEvents = this.visibilityEvents.get(event.getId());
+    if (!visibilityEvents || visibilityEvents.length == 0) {
+      // No pending visibility change in store.
+      return;
+    }
+    var visibilityEvent = visibilityEvents[visibilityEvents.length - 1];
+    var visibilityChange = visibilityEvent.asVisibilityChange();
+    if (!visibilityChange) {
+      return;
+    }
+    if (visibilityChange.visible) {
+      // Events are visible by default, no need to apply a visibility change.
+      // Note that we need to keep the visibility changes in `visibilityEvents`,
+      // in case we later fetch an older visibility change event that is superseded
+      // by `visibilityChange`.
+    }
+    if (visibilityEvent.getTs() < event.getTs()) {
+      // Something is wrong, the visibility change cannot happen before the
+      // event. Presumably an ill-formed event.
+      return;
+    }
+    event.applyVisibilityEvent(visibilityChange);
+  }
+
+  /**
+   * Find when a client has gained thread capabilities by inspecting the oldest
+   * threaded receipt
+   * @returns the timestamp of the oldest threaded receipt
+   */
+  getOldestThreadedReceiptTs() {
+    return this.oldestThreadedReceiptTs;
+  }
+
+  /**
+   * Determines if the given user has read a particular event ID with the known
+   * history of the room. This is not a definitive check as it relies only on
+   * what is available to the room at the time of execution.
+   *
+   * @param userId - The user ID to check the read state of.
+   * @param eventId - The event ID to check if the user read.
+   * @returns true if the user has read the event, false otherwise.
+   */
+  hasUserReadEvent(userId, eventId) {
+    return this.roomReceipts.hasUserReadEvent(userId, eventId);
+  }
+
+  /**
+   * Returns the most recent unthreaded receipt for a given user
+   * @param userId - the MxID of the User
+   * @returns an unthreaded Receipt. Can be undefined if receipts have been disabled
+   * or a user chooses to use private read receipts (or we have simply not received
+   * a receipt from this user yet).
+   */
+  getLastUnthreadedReceiptFor(userId) {
+    return this.unthreadedReceipts.get(userId);
+  }
+
+  /**
+   * This issue should also be addressed on synapse's side and is tracked as part
+   * of https://github.com/matrix-org/synapse/issues/14837
+   *
+   *
+   * We consider a room  fully read if the current user has sent
+   * the last event in the live timeline of that context and if the read receipt
+   * we have on record matches.
+   * This also detects all unread threads and applies the same logic to those
+   * contexts
+   */
+  fixupNotifications(userId) {
+    super.fixupNotifications(userId);
+    var unreadThreads = this.getThreads().filter(thread => this.getThreadUnreadNotificationCount(thread.id, NotificationCountType.Total) > 0);
+    for (var thread of unreadThreads) {
+      thread.fixupNotifications(userId);
+    }
+  }
+
+  /**
+   * Determine the order of two events in this room.
+   *
+   * In principle this should use the same order as the server, but in practice
+   * this is difficult for events that were not received over the Sync API. See
+   * MSC4033 for details.
+   *
+   * This implementation leans on the order of events within their timelines, and
+   * falls back to comparing event timestamps when they are in different
+   * timelines.
+   *
+   * See https://github.com/matrix-org/matrix-js-sdk/issues/3325 for where we are
+   * tracking the work to fix this.
+   *
+   * @param leftEventId - the id of the first event
+   * @param rightEventId - the id of the second event
+    * @returns -1 if left \< right, 1 if left \> right, 0 if left == right, null if
+   *          we can't tell (because we can't find the events).
+   */
+  compareEventOrdering(leftEventId, rightEventId) {
+    return compareEventOrdering(this, leftEventId, rightEventId);
+  }
+
+  /**
+   * Return true if this room has an `m.room.encryption` state event.
+   *
+   * If this returns `true`, events sent to this room should be encrypted (and `BriijClient.sendEvent` and friends
+   * will encrypt outgoing events).
+   */
+  hasEncryptionStateEvent() {
+    var _this$getLiveTimeline;
+    return Boolean((_this$getLiveTimeline = this.getLiveTimeline().getState(EventTimeline.FORWARDS)) === null || _this$getLiveTimeline === void 0 ? void 0 : _this$getLiveTimeline.getStateEvents(EventType.RoomEncryption, ""));
+  }
+}
+
+// a map from current event status to a list of allowed next statuses
+var ALLOWED_TRANSITIONS = {
+  [EventStatus.ENCRYPTING]: [EventStatus.SENDING, EventStatus.NOT_SENT, EventStatus.CANCELLED],
+  [EventStatus.SENDING]: [EventStatus.ENCRYPTING, EventStatus.QUEUED, EventStatus.NOT_SENT, EventStatus.SENT],
+  [EventStatus.QUEUED]: [EventStatus.SENDING, EventStatus.NOT_SENT, EventStatus.CANCELLED],
+  [EventStatus.SENT]: [],
+  [EventStatus.NOT_SENT]: [EventStatus.SENDING, EventStatus.QUEUED, EventStatus.CANCELLED],
+  [EventStatus.CANCELLED]: []
+};
+export var RoomNameType = /*#__PURE__*/function (RoomNameType) {
+  RoomNameType[RoomNameType["EmptyRoom"] = 0] = "EmptyRoom";
+  RoomNameType[RoomNameType["Generated"] = 1] = "Generated";
+  RoomNameType[RoomNameType["Actual"] = 2] = "Actual";
+  return RoomNameType;
+}({});
+// Can be overriden by IBriijClientCreateOpts::memberNamesToRoomNameFn
+function memberNamesToRoomName(names, count) {
+  var countWithoutMe = count - 1;
+  if (!names.length) {
+    return "Empty room";
+  } else if (names.length === 1 && countWithoutMe <= 1) {
+    return names[0];
+  } else if (names.length === 2 && countWithoutMe <= 2) {
+    return "".concat(names[0], " and ").concat(names[1]);
+  } else {
+    var plural = countWithoutMe > 1;
+    if (plural) {
+      return "".concat(names[0], " and ").concat(countWithoutMe, " others");
+    } else {
+      return "".concat(names[0], " and 1 other");
+    }
+  }
+}
+//# sourceMappingURL=room.js.map