@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/models/event-context.js

@@ -0,0 +1,113 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2015 - 2021 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 { Direction } from "./event-timeline.js";
+export class EventContext {
+  /**
+   * Construct a new EventContext
+   *
+   * An eventcontext is used for circumstances such as search results, when we
+   * have a particular event of interest, and a bunch of events before and after
+   * it.
+   *
+   * It also stores pagination tokens for going backwards and forwards in the
+   * timeline.
+   *
+   * @param ourEvent - the event at the centre of this context
+   */
+  constructor(ourEvent) {
+    this.ourEvent = ourEvent;
+    _defineProperty(this, "timeline", void 0);
+    _defineProperty(this, "ourEventIndex", 0);
+    _defineProperty(this, "paginateTokens", {
+      [Direction.Backward]: null,
+      [Direction.Forward]: null
+    });
+    this.timeline = [ourEvent];
+  }
+
+  /**
+   * Get the main event of interest
+   *
+   * This is a convenience function for getTimeline()[getOurEventIndex()].
+   *
+   * @returns The event at the centre of this context.
+   */
+  getEvent() {
+    return this.timeline[this.ourEventIndex];
+  }
+
+  /**
+   * Get the list of events in this context
+   *
+   * @returns An array of MatrixEvents
+   */
+  getTimeline() {
+    return this.timeline;
+  }
+
+  /**
+   * Get the index in the timeline of our event
+   */
+  getOurEventIndex() {
+    return this.ourEventIndex;
+  }
+
+  /**
+   * Get a pagination token.
+   *
+   * @param backwards -   true to get the pagination token for going
+   */
+  getPaginateToken() {
+    var backwards = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    return this.paginateTokens[backwards ? Direction.Backward : Direction.Forward];
+  }
+
+  /**
+   * Set a pagination token.
+   *
+   * Generally this will be used only by the matrix js sdk.
+   *
+   * @param token -        pagination token
+   * @param backwards -   true to set the pagination token for going
+   *                                   backwards in time
+   */
+  setPaginateToken(token) {
+    var backwards = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    this.paginateTokens[backwards ? Direction.Backward : Direction.Forward] = token !== null && token !== void 0 ? token : null;
+  }
+
+  /**
+   * Add more events to the timeline
+   *
+   * @param events -      new events, in timeline order
+   * @param atStart -   true to insert new events at the start
+   */
+  addEvents(events) {
+    var atStart = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    // TODO: should we share logic with Room.addEventsToTimeline?
+    // Should Room even use EventContext?
+
+    if (atStart) {
+      this.timeline = events.concat(this.timeline);
+      this.ourEventIndex += events.length;
+    } else {
+      this.timeline = this.timeline.concat(events);
+    }
+  }
+}
+//# sourceMappingURL=event-context.js.map

package/lib/models/event-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-context.js","names":["Direction","EventContext","constructor","ourEvent","_defineProperty","Backward","Forward","timeline","getEvent","ourEventIndex","getTimeline","getOurEventIndex","getPaginateToken","backwards","arguments","length","undefined","paginateTokens","setPaginateToken","token","addEvents","events","atStart","concat"],"sources":["../../src/models/event-context.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { MatrixEvent } from \"./event.ts\";\nimport { Direction } from \"./event-timeline.ts\";\n\nexport class EventContext {\n    private timeline: MatrixEvent[];\n    private ourEventIndex = 0;\n    private paginateTokens: Record<Direction, string | null> = {\n        [Direction.Backward]: null,\n        [Direction.Forward]: null,\n    };\n\n    /**\n     * Construct a new EventContext\n     *\n     * An eventcontext is used for circumstances such as search results, when we\n     * have a particular event of interest, and a bunch of events before and after\n     * it.\n     *\n     * It also stores pagination tokens for going backwards and forwards in the\n     * timeline.\n     *\n     * @param ourEvent - the event at the centre of this context\n     */\n    public constructor(public readonly ourEvent: MatrixEvent) {\n        this.timeline = [ourEvent];\n    }\n\n    /**\n     * Get the main event of interest\n     *\n     * This is a convenience function for getTimeline()[getOurEventIndex()].\n     *\n     * @returns The event at the centre of this context.\n     */\n    public getEvent(): MatrixEvent {\n        return this.timeline[this.ourEventIndex];\n    }\n\n    /**\n     * Get the list of events in this context\n     *\n     * @returns An array of MatrixEvents\n     */\n    public getTimeline(): MatrixEvent[] {\n        return this.timeline;\n    }\n\n    /**\n     * Get the index in the timeline of our event\n     */\n    public getOurEventIndex(): number {\n        return this.ourEventIndex;\n    }\n\n    /**\n     * Get a pagination token.\n     *\n     * @param backwards -   true to get the pagination token for going\n     */\n    public getPaginateToken(backwards = false): string | null {\n        return this.paginateTokens[backwards ? Direction.Backward : Direction.Forward];\n    }\n\n    /**\n     * Set a pagination token.\n     *\n     * Generally this will be used only by the matrix js sdk.\n     *\n     * @param token -        pagination token\n     * @param backwards -   true to set the pagination token for going\n     *                                   backwards in time\n     */\n    public setPaginateToken(token?: string, backwards = false): void {\n        this.paginateTokens[backwards ? Direction.Backward : Direction.Forward] = token ?? null;\n    }\n\n    /**\n     * Add more events to the timeline\n     *\n     * @param events -      new events, in timeline order\n     * @param atStart -   true to insert new events at the start\n     */\n    public addEvents(events: MatrixEvent[], atStart = false): void {\n        // TODO: should we share logic with Room.addEventsToTimeline?\n        // Should Room even use EventContext?\n\n        if (atStart) {\n            this.timeline = events.concat(this.timeline);\n            this.ourEventIndex += events.length;\n        } else {\n            this.timeline = this.timeline.concat(events);\n        }\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,SAAS,QAAQ,qBAAqB;AAE/C,OAAO,MAAMC,YAAY,CAAC;EAQtB;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,WAAWA,CAAiBC,QAAqB,EAAE;IAAA,KAAvBA,QAAqB,GAArBA,QAAqB;IAAAC,eAAA;IAAAA,eAAA,wBAlBhC,CAAC;IAAAA,eAAA,yBACkC;MACvD,CAACJ,SAAS,CAACK,QAAQ,GAAG,IAAI;MAC1B,CAACL,SAAS,CAACM,OAAO,GAAG;IACzB,CAAC;IAeG,IAAI,CAACC,QAAQ,GAAG,CAACJ,QAAQ,CAAC;EAC9B;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACWK,QAAQA,CAAA,EAAgB;IAC3B,OAAO,IAAI,CAACD,QAAQ,CAAC,IAAI,CAACE,aAAa,CAAC;EAC5C;;EAEA;AACJ;AACA;AACA;AACA;EACWC,WAAWA,CAAA,EAAkB;IAChC,OAAO,IAAI,CAACH,QAAQ;EACxB;;EAEA;AACJ;AACA;EACWI,gBAAgBA,CAAA,EAAW;IAC9B,OAAO,IAAI,CAACF,aAAa;EAC7B;;EAEA;AACJ;AACA;AACA;AACA;EACWG,gBAAgBA,CAAA,EAAmC;IAAA,IAAlCC,SAAS,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;IACrC,OAAO,IAAI,CAACG,cAAc,CAACJ,SAAS,GAAGb,SAAS,CAACK,QAAQ,GAAGL,SAAS,CAACM,OAAO,CAAC;EAClF;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWY,gBAAgBA,CAACC,KAAc,EAA2B;IAAA,IAAzBN,SAAS,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;IACrD,IAAI,CAACG,cAAc,CAACJ,SAAS,GAAGb,SAAS,CAACK,QAAQ,GAAGL,SAAS,CAACM,OAAO,CAAC,GAAGa,KAAK,aAALA,KAAK,cAALA,KAAK,GAAI,IAAI;EAC3F;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWC,SAASA,CAACC,MAAqB,EAAyB;IAAA,IAAvBC,OAAO,GAAAR,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;IACnD;IACA;;IAEA,IAAIQ,OAAO,EAAE;MACT,IAAI,CAACf,QAAQ,GAAGc,MAAM,CAACE,MAAM,CAAC,IAAI,CAAChB,QAAQ,CAAC;MAC5C,IAAI,CAACE,aAAa,IAAIY,MAAM,CAACN,MAAM;IACvC,CAAC,MAAM;MACH,IAAI,CAACR,QAAQ,GAAG,IAAI,CAACA,QAAQ,CAACgB,MAAM,CAACF,MAAM,CAAC;IAChD;EACJ;AACJ","ignoreList":[]}

package/lib/models/event-status.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Enum for event statuses.
+ * @readonly
+ */
+export declare enum EventStatus {
+    /** The event was not sent and will no longer be retried. */
+    NOT_SENT = "not_sent",
+    /** The message is being encrypted */
+    ENCRYPTING = "encrypting",
+    /** The event is in the process of being sent. */
+    SENDING = "sending",
+    /** The event is in a queue waiting to be sent. */
+    QUEUED = "queued",
+    /** The event has been sent to the server, but we have not yet received the echo. */
+    SENT = "sent",
+    /** The event was cancelled before it was successfully sent. */
+    CANCELLED = "cancelled"
+}
+//# sourceMappingURL=event-status.d.ts.map

package/lib/models/event-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-status.d.ts","sourceRoot":"","sources":["../../src/models/event-status.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,oBAAY,WAAW;IACnB,4DAA4D;IAC5D,QAAQ,aAAa;IAErB,qCAAqC;IACrC,UAAU,eAAe;IAEzB,iDAAiD;IACjD,OAAO,YAAY;IAEnB,kDAAkD;IAClD,MAAM,WAAW;IAEjB,oFAAoF;IACpF,IAAI,SAAS;IAEb,+DAA+D;IAC/D,SAAS,cAAc;CAC1B"}

package/lib/models/event-status.js

@@ -0,0 +1,30 @@
+/*
+Copyright 2015 - 2022 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.
+*/
+
+/**
+ * Enum for event statuses.
+ * @readonly
+ */
+export var EventStatus = /*#__PURE__*/function (EventStatus) {
+  EventStatus["NOT_SENT"] = "not_sent";
+  EventStatus["ENCRYPTING"] = "encrypting";
+  EventStatus["SENDING"] = "sending";
+  EventStatus["QUEUED"] = "queued";
+  EventStatus["SENT"] = "sent";
+  EventStatus["CANCELLED"] = "cancelled";
+  return EventStatus;
+}({});
+//# sourceMappingURL=event-status.js.map

package/lib/models/event-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-status.js","names":["EventStatus"],"sources":["../../src/models/event-status.ts"],"sourcesContent":["/*\nCopyright 2015 - 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n/**\n * Enum for event statuses.\n * @readonly\n */\nexport enum EventStatus {\n    /** The event was not sent and will no longer be retried. */\n    NOT_SENT = \"not_sent\",\n\n    /** The message is being encrypted */\n    ENCRYPTING = \"encrypting\",\n\n    /** The event is in the process of being sent. */\n    SENDING = \"sending\",\n\n    /** The event is in a queue waiting to be sent. */\n    QUEUED = \"queued\",\n\n    /** The event has been sent to the server, but we have not yet received the echo. */\n    SENT = \"sent\",\n\n    /** The event was cancelled before it was successfully sent. */\n    CANCELLED = \"cancelled\",\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,WAAYA,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}

package/lib/models/event-timeline-set.d.ts

@@ -0,0 +1,312 @@
+import { EventTimeline, IAddEventOptions } from "./event-timeline.ts";
+import { MatrixEvent } from "./event.ts";
+import { Room, RoomEvent } from "./room.ts";
+import { Filter } from "../filter.ts";
+import { RoomState } from "./room-state.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+import { RelationsContainer } from "./relations-container.ts";
+import { MatrixClient } from "../client.ts";
+import { Thread, ThreadFilterType } from "./thread.ts";
+interface IOpts {
+    timelineSupport?: boolean;
+    filter?: Filter;
+    pendingEvents?: boolean;
+}
+export declare enum DuplicateStrategy {
+    Ignore = "ignore",
+    Replace = "replace"
+}
+export interface IRoomTimelineData {
+    timeline: EventTimeline;
+    liveEvent?: boolean;
+}
+export interface IAddEventToTimelineOptions extends Pick<IAddEventOptions, "toStartOfTimeline" | "roomState" | "timelineWasEmpty"> {
+    /** Whether the sync response came from cache */
+    fromCache?: boolean;
+}
+export interface IAddLiveEventOptions extends Pick<IAddEventToTimelineOptions, "fromCache" | "roomState" | "timelineWasEmpty"> {
+    /** Applies to events in the timeline only. If this is 'replace' then if a
+     * duplicate is encountered, the event passed to this function will replace
+     * the existing event in the timeline. If this is not specified, or is
+     * 'ignore', then the event passed to this function will be ignored
+     * entirely, preserving the existing event in the timeline. Events are
+     * identical based on their event ID <b>only</b>. */
+    duplicateStrategy?: DuplicateStrategy;
+}
+type EmittedEvents = RoomEvent.Timeline | RoomEvent.TimelineReset;
+export type EventTimelineSetHandlerMap = {
+    /**
+     * Fires whenever the timeline in a room is updated.
+     * @param event - The matrix event which caused this event to fire.
+     * @param room - The room, if any, whose timeline was updated.
+     * @param toStartOfTimeline - True if this event was added to the start
+     * @param removed - True if this event has just been removed from the timeline
+     * (beginning; oldest) of the timeline e.g. due to pagination.
+     *
+     * @param data - more data about the event
+     *
+     * @example
+     * ```
+     * matrixClient.on("Room.timeline",
+     *                 function(event, room, toStartOfTimeline, removed, data) {
+     *   if (!toStartOfTimeline && data.liveEvent) {
+     *     var messageToAppend = room.timeline.[room.timeline.length - 1];
+     *   }
+     * });
+     * ```
+     */
+    [RoomEvent.Timeline]: (event: MatrixEvent, room: Room | undefined, toStartOfTimeline: boolean | undefined, removed: boolean, data: IRoomTimelineData) => void;
+    /**
+     * Fires whenever the live timeline in a room is reset.
+     *
+     * When we get a 'limited' sync (for example, after a network outage), we reset
+     * the live timeline to be empty before adding the recent events to the new
+     * timeline. This event is fired after the timeline is reset, and before the
+     * new events are added.
+     *
+     * @param room - The room whose live timeline was reset, if any
+     * @param timelineSet - timelineSet room whose live timeline was reset
+     * @param resetAllTimelines - True if all timelines were reset.
+     */
+    [RoomEvent.TimelineReset]: (room: Room | undefined, timelineSet: EventTimelineSet, resetAllTimelines: boolean) => void;
+};
+export declare class EventTimelineSet extends TypedEventEmitter<EmittedEvents, EventTimelineSetHandlerMap> {
+    readonly room: Room | undefined;
+    readonly thread?: Thread | undefined;
+    readonly threadListType: ThreadFilterType | null;
+    readonly relations: RelationsContainer;
+    private readonly timelineSupport;
+    private readonly displayPendingEvents;
+    private liveTimeline;
+    private timelines;
+    private _eventIdToTimeline;
+    private filter?;
+    /**
+     * Construct a set of EventTimeline objects, typically on behalf of a given
+     * room.  A room may have multiple EventTimelineSets for different levels
+     * of filtering.  The global notification list is also an EventTimelineSet, but
+     * lacks a room.
+     *
+     * <p>This is 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 (if appropriate).
+     * 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 room - Room for this timelineSet. May be null for non-room cases, such as the
+     * notification timeline.
+     * @param opts - Options inherited from Room.
+     * @param client - the Matrix client which owns this EventTimelineSet,
+     * can be omitted if room is specified.
+     * @param thread - the thread to which this timeline set relates.
+     * @param threadListType - the type of thread list represented, if any
+     * (e.g., All threads or My threads)
+     */
+    constructor(room: Room | undefined, opts?: IOpts, client?: MatrixClient, thread?: Thread | undefined, threadListType?: ThreadFilterType | null);
+    /**
+     * Get all the timelines in this set
+     * @returns the timelines in this set
+     */
+    getTimelines(): EventTimeline[];
+    /**
+     * Get the filter object this timeline set is filtered on, if any
+     * @returns the optional filter for this timelineSet
+     */
+    getFilter(): Filter | undefined;
+    /**
+     * Set the filter object this timeline set is filtered on
+     * (passed to the server when paginating via /messages).
+     * @param filter - the filter for this timelineSet
+     */
+    setFilter(filter?: Filter): void;
+    /**
+     * Get the list of pending sent events for this timelineSet's room, filtered
+     * by the timelineSet's filter if appropriate.
+     *
+     * @returns A list of the sent events
+     * waiting for remote echo.
+     *
+     * @throws If `opts.pendingEventOrdering` was not 'detached'
+     */
+    getPendingEvents(): MatrixEvent[];
+    /**
+     * Get the live timeline for this room.
+     *
+     * @returns live timeline
+     */
+    getLiveTimeline(): EventTimeline;
+    /**
+     * Set the live timeline for this room.
+     *
+     * @returns live timeline
+     */
+    setLiveTimeline(timeline: EventTimeline): void;
+    /**
+     * Return the timeline (if any) this event is in.
+     * @param eventId - the eventId being sought
+     * @returns timeline
+     */
+    eventIdToTimeline(eventId: string): EventTimeline | undefined;
+    /**
+     * Track a new event as if it were in the same timeline as an old event,
+     * replacing it.
+     * @param oldEventId -  event ID of the original event
+     * @param newEventId -  event ID of the replacement event
+     */
+    replaceEventId(oldEventId: string, newEventId: string): void;
+    /**
+     * Reset the live timeline, and start a new one.
+     *
+     * <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.
+     *
+     * @remarks
+     * Fires {@link RoomEvent.TimelineReset}
+     */
+    resetLiveTimeline(backPaginationToken?: string, forwardPaginationToken?: string): void;
+    /**
+     * Get the timeline which contains the given event, if any
+     *
+     * @param eventId -  event ID to look for
+     * @returns timeline containing
+     * the given event, or null if unknown
+     */
+    getTimelineForEvent(eventId?: string): EventTimeline | null;
+    /**
+     * Get an event which is stored in our timelines
+     *
+     * @param eventId -  event ID to look for
+     * @returns the given event, or undefined if unknown
+     */
+    findEventById(eventId: string): MatrixEvent | undefined;
+    /**
+     * Add a new timeline to this timeline list
+     *
+     * @returns newly-created timeline
+     */
+    addTimeline(): EventTimeline;
+    /**
+     * 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: MatrixEvent[], toStartOfTimeline: boolean, timeline: EventTimeline, paginationToken?: string | null): void;
+    /**
+     * Add an event to the end of this live timeline.
+     *
+     * @param event - Event to be added
+     * @param options - addLiveEvent options
+     */
+    addLiveEvent(event: MatrixEvent, { duplicateStrategy, fromCache, roomState, timelineWasEmpty }?: IAddLiveEventOptions): void;
+    /**
+     * Add event to the given timeline, and emit Room.timeline. Assumes
+     * we have already checked we don't know about this event.
+     *
+     * Will fire "Room.timeline" for each event added.
+     *
+     * @param event - the event to add
+     * @param timeline - the timeline onto which to add it
+     * @param options - addEventToTimeline options
+     *
+     * @remarks
+     * Fires {@link RoomEvent.Timeline}
+     */
+    addEventToTimeline(event: MatrixEvent, timeline: EventTimeline, { toStartOfTimeline, fromCache, roomState, timelineWasEmpty }: IAddEventToTimelineOptions): void;
+    /**
+     * @deprecated In favor of the overload with `IAddEventToTimelineOptions`
+     */
+    addEventToTimeline(event: MatrixEvent, timeline: EventTimeline, toStartOfTimeline: boolean, fromCache?: boolean, roomState?: RoomState): void;
+    /**
+     * Insert event to the given timeline, and emit Room.timeline. Assumes
+     * we have already checked we don't know about this event.
+     *
+     * TEMPORARY: until we have recursive relations, we need this function
+     * to exist to allow us to insert events in timeline order, which is our
+     * best guess for Sync Order.
+     * This is a copy of addEventToTimeline above, modified to insert the event
+     * after the event it relates to, and before any event with a later
+     * timestamp. This is our best guess at Sync Order.
+     *
+     * Will fire "Room.timeline" for each event added.
+     *
+     * @internal
+     *
+     * @remarks
+     * Fires {@link RoomEvent.Timeline}
+     */
+    insertEventIntoTimeline(event: MatrixEvent, timeline: EventTimeline, roomState: RoomState): void;
+    /**
+     * Replaces event with ID oldEventId with one with newEventId, if oldEventId is
+     * recognised.  Otherwise, add to the live timeline.  Used to handle remote echos.
+     *
+     * @param localEvent -     the new event to be added to the timeline
+     * @param oldEventId -          the ID of the original event
+     * @param newEventId -         the ID of the replacement event
+     *
+     * @remarks
+     * Fires {@link RoomEvent.Timeline}
+     */
+    handleRemoteEcho(localEvent: MatrixEvent, oldEventId: string, newEventId: string): void;
+    /**
+     * Removes a single event from this room.
+     *
+     * @param eventId -  The id of the event to remove
+     *
+     * @returns the removed event, or null if the event was not found
+     * in this room.
+     */
+    removeEvent(eventId: string): MatrixEvent | null;
+    /**
+     * Determine where two events appear in the timeline relative to one another
+     *
+     * @param eventId1 -   The id of the first event
+     * @param eventId2 -   The id of the second event
+
+     * @returns -1 if eventId1 precedes eventId2, and +1 eventId1 succeeds
+     * eventId2. 0 if they are the same event; null if we can't tell (either
+     * because we don't know about one of the events, or because they are in
+     * separate timelines which don't join up).
+     */
+    compareEventOrdering(eventId1: string, eventId2: string): number | null;
+    /**
+     * Determine whether a given event can sanely be added to this event timeline set,
+     * for timeline sets relating to a thread, only return true for events in the same
+     * thread timeline, for timeline sets not relating to a thread only return true
+     * for events which should be shown in the main room timeline.
+     * Requires the `room` property to have been set at EventTimelineSet construction time.
+     *
+     * @param event - the event to check whether it belongs to this timeline set.
+     * @throws Error if `room` was not set when constructing this timeline set.
+     * @returns whether the event belongs to this timeline set.
+     */
+    canContain(event: MatrixEvent): boolean;
+}
+export {};
+//# sourceMappingURL=event-timeline-set.d.ts.map

package/lib/models/event-timeline-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-timeline-set.d.ts","sourceRoot":"","sources":["../../src/models/event-timeline-set.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAcvD,UAAU,KAAK;IAEX,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,oBAAY,iBAAiB;IACzB,MAAM,WAAW;IACjB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAE9B,QAAQ,EAAE,aAAa,CAAC;IAExB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,0BACb,SAAQ,IAAI,CAAC,gBAAgB,EAAE,mBAAmB,GAAG,WAAW,GAAG,kBAAkB,CAAC;IACtF,gDAAgD;IAChD,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,oBACb,SAAQ,IAAI,CAAC,0BAA0B,EAAE,WAAW,GAAG,WAAW,GAAG,kBAAkB,CAAC;IACxF;;;;;wDAKoD;IACpD,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACzC;AAED,KAAK,aAAa,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,aAAa,CAAC;AAElE,MAAM,MAAM,0BAA0B,GAAG;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAClB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtB,iBAAiB,EAAE,OAAO,GAAG,SAAS,EACtC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,iBAAiB,KACtB,IAAI,CAAC;IACV;;;;;;;;;;;OAWG;IACH,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CACvB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtB,WAAW,EAAE,gBAAgB,EAC7B,iBAAiB,EAAE,OAAO,KACzB,IAAI,CAAC;CACb,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,aAAa,EAAE,0BAA0B,CAAC;aAwC1E,IAAI,EAAE,IAAI,GAAG,SAAS;aAGtB,MAAM,CAAC,EAAE,MAAM;aACf,cAAc,EAAE,gBAAgB,GAAG,IAAI;IA3C3D,SAAgB,SAAS,EAAE,kBAAkB,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAU;IAC/C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,kBAAkB,CAAoC;IAC9D,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;gBAEiB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtC,IAAI,GAAE,KAAU,EAChB,MAAM,CAAC,EAAE,YAAY,EACL,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,cAAc,GAAE,gBAAgB,GAAG,IAAW;IAiBlE;;;OAGG;IACI,YAAY,IAAI,aAAa,EAAE;IAItC;;;OAGG;IACI,SAAS,IAAI,MAAM,GAAG,SAAS;IAItC;;;;OAIG;IACI,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAIvC;;;;;;;;OAQG;IACI,gBAAgB,IAAI,WAAW,EAAE;IAOxC;;;;OAIG;IACI,eAAe,IAAI,aAAa;IAIvC;;;;OAIG;IACI,eAAe,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIrD;;;;OAIG;IACI,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAIpE;;;;;OAKG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAQnE;;;;;;;;;;;OAWG;IACI,iBAAiB,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI;IAwC7F;;;;;;OAMG;IACI,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI;IAQlE;;;;;OAKG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAU9D;;;;OAIG;IACI,WAAW,IAAI,aAAa;IAcnC;;;;;;;;;;;;;;;;;;;OAmBG;IACI,mBAAmB,CACtB,MAAM,EAAE,WAAW,EAAE,EACrB,iBAAiB,EAAE,OAAO,EAC1B,QAAQ,EAAE,aAAa,EACvB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,GAChC,IAAI;IA+LP;;;;;OAKG;IACI,YAAY,CACf,KAAK,EAAE,WAAW,EAClB,EAAE,iBAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAE,oBAAyB,GACzF,IAAI;IAwCP;;;;;;;;;;;;OAYG;IACI,kBAAkB,CACrB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,aAAa,EACvB,EAAE,iBAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,EAAE,0BAA0B,GAC1F,IAAI;IACP;;OAEG;IACI,kBAAkB,CACrB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,aAAa,EACvB,iBAAiB,EAAE,OAAO,EAC1B,SAAS,CAAC,EAAE,OAAO,EACnB,SAAS,CAAC,EAAE,SAAS,GACtB,IAAI;IA+DP;;;;;;;;;;;;;;;;;OAiBG;IACI,uBAAuB,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI;IAuEvG;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAa9F;;;;;;;OAOG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAiBvD;;;;;;;;;;OAUG;IACI,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAqE9E;;;;;;;;;;OAUG;IACI,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAwBjD"}