mv element-web-module-api module-api

2026-04-13 09:18:23 +01:00
parent ec8b7bf109
commit ad2e6d37bc
34 changed files with 546 additions and 546 deletions
@@ -0,0 +1,28 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { type Watchable } from "../api/watchable";
+
+/**
+ * Represents a room from element-web.
+ * @public
+ */
+export interface Room {
+    /**
+     * Id of this room.
+     */
+    id: string;
+    /**
+     * {@link Watchable} holding the name for this room.
+     */
+    name: Watchable<string>;
+    /**
+     * Get the timestamp of the last message in this room.
+     * @returns last active timestamp
+     */
+    getLastActiveTimestamp: () => number;
+}
@@ -0,0 +1,48 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+/**
+ * Representation of a Matrix event, as specified by the client server specification.
+ * @alpha Subject to change.
+ * @see https://spec.matrix.org/v1.14/client-server-api/#room-event-format
+ */
+export interface MatrixEvent {
+    /**
+     * The event ID of this event.
+     */
+    eventId: string;
+    /**
+     * The room ID which contains this event.
+     */
+    roomId: string;
+    /**
+     * The Matrix ID of the user who sent this event.
+     */
+    sender: string;
+    /**
+     * The content of the event.
+     * If the event was encrypted, this is the decrypted content.
+     */
+    content: Record<string, unknown>;
+    /**
+     * Contains optional extra information about the event.
+     */
+    unsigned: Record<string, unknown>;
+    /**
+     * The type of the event.
+     */
+    type: string;
+    /**
+     * The state key of the event.
+     * If this key is set, including `""` then the event is a state event.
+     */
+    stateKey?: string;
+    /**
+     * Timestamp (in milliseconds since the unix epoch) on originating homeserver when this event was sent.
+     */
+    originServerTs: number;
+}