@jeongsu816/matrix-bot-sdk 0.0.0-stage → 0.8.1

package/src/models/events/AliasesEvent.ts

@@ -0,0 +1,37 @@
+import { StateEvent } from "./RoomEvent";
+
+/**
+ * The content definition for m.room.aliases events
+ * @category Matrix event contents
+ * @see AliasesEvent
+ */
+export interface AliasesEventContent {
+    /**
+     * The aliases this domain has published to the room.
+     */
+    aliases: string[];
+}
+
+/**
+ * Represents an m.room.aliases state event
+ * @category Matrix events
+ */
+export class AliasesEvent extends StateEvent<AliasesEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The domain the aliases belong to.
+     */
+    public get forDomain(): string {
+        return this.stateKey;
+    }
+
+    /**
+     * The aliases the domain has published to the room.
+     */
+    public get aliases(): string[] {
+        return this.content.aliases || [];
+    }
+}

package/src/models/events/CanonicalAliasEvent.ts

@@ -0,0 +1,30 @@
+import { StateEvent } from "./RoomEvent";
+
+/**
+ * The content definition for m.room.canonical_alias events
+ * @category Matrix event contents
+ * @see CanonicalAliasEvent
+ */
+export interface CanonicalAliasEventContent {
+    /**
+     * The canonical alias for the room.
+     */
+    alias: string;
+}
+
+/**
+ * Represents an m.room.canonical_alias state event
+ * @category Matrix events
+ */
+export class CanonicalAliasEvent extends StateEvent<CanonicalAliasEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The alias the room is considering canonical
+     */
+    public get aliases(): string {
+        return this.content.alias;
+    }
+}

package/src/models/events/CreateEvent.ts

@@ -0,0 +1,82 @@
+import { StateEvent } from "./RoomEvent";
+
+/**
+ * Information about the previous room.
+ * @category Matrix event info
+ * @see CreateEventContent
+ */
+export interface PreviousRoomInfo {
+    /**
+     * The old room ID.
+     */
+    room_id: string;
+
+    /**
+     * The last known event ID in the old room.
+     * Optional only for room versions >=12.
+     */
+    event_id?: string;
+}
+
+/**
+ * The content definition for m.room.create events
+ * @category Matrix event contents
+ * @see CreateEvent
+ */
+export interface CreateEventContent extends Record<string, unknown> {
+    /**
+     * The user ID who created the room.
+     */
+    creator: string;
+
+    /**
+     * Whether or not this room is federated. Default true.
+     */
+    "m.federate"?: boolean;
+
+    /**
+     * The version of the room. Default "1".
+     */
+    room_version?: string;
+
+    /**
+     * Information about the old room.
+     */
+    predecessor?: PreviousRoomInfo;
+
+    /**
+     * The type of the room, if applicable. For example, `m.space`.
+     */
+    type?: string;
+}
+
+/**
+ * Represents an m.room.create state event
+ * @category Matrix events
+ */
+export class CreateEvent extends StateEvent<CreateEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The user ID who created the room.
+     */
+    public get creator(): string {
+        return this.content.creator || this.sender;
+    }
+
+    /**
+     * The version of the room. Defaults to "1".
+     */
+    public get version(): string {
+        return this.content.room_version || "1";
+    }
+
+    /**
+     * Whether or not the room is federated. Default true (federated).
+     */
+    public get federated(): boolean {
+        return this.content['m.federate'] !== false;
+    }
+}

package/src/models/events/EncryptedRoomEvent.ts

@@ -0,0 +1,58 @@
+import { RoomEvent } from "./RoomEvent";
+import { EncryptionAlgorithm, IMegolmEncrypted } from "../Crypto";
+
+/**
+ * The content definition for m.room.encrypted events
+ * @category Matrix event contents
+ * @see EncryptedRoomEvent
+ */
+export interface EncryptedRoomEventContent {
+    algorithm: EncryptionAlgorithm;
+
+    /**
+     * For m.megolm.v1.aes-sha2 messages. The sender's Curve25519 key.
+     */
+    sender_key?: string;
+
+    /**
+     * For m.megolm.v1.aes-sha2 messages. The session ID established by the sender.
+     */
+    session_id?: string;
+
+    /**
+     * For m.megolm.v1.aes-sha2 messages. The encrypted payload.
+     */
+    ciphertext?: string;
+
+    /**
+     * For m.megolm.v1.aes-sha2 messages. The sender's device ID.
+     */
+    device_id?: string;
+
+    // Other algorithms not supported at the moment
+}
+
+/**
+ * Represents an m.room.encrypted room event
+ * @category Matrix events
+ */
+export class EncryptedRoomEvent extends RoomEvent<EncryptedRoomEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The encryption algorithm used on the event. Should match the m.room.encryption
+     * state config.
+     */
+    public get algorithm(): EncryptionAlgorithm {
+        return this.content.algorithm;
+    }
+
+    /**
+     * The Megolm encrypted payload information.
+     */
+    public get megolmProperties(): IMegolmEncrypted {
+        return this.content as IMegolmEncrypted;
+    }
+}

package/src/models/events/EncryptionEvent.ts

@@ -0,0 +1,63 @@
+import { StateEvent } from "./RoomEvent";
+
+/**
+ * The kinds of room encryption algorithms allowed by the spec.
+ * @category Models
+ * @see EncryptionEvent
+ */
+export enum RoomEncryptionAlgorithm {
+    MegolmV1AesSha2 = "m.megolm.v1.aes-sha2",
+}
+
+/**
+ * The content definition for m.room.encryption events
+ * @category Matrix event contents
+ * @see EncryptionEvent
+ */
+export interface EncryptionEventContent {
+    /**
+     * The encryption algorithm for the room.
+     */
+    algorithm: string | RoomEncryptionAlgorithm;
+
+    /**
+     * How long a session should be used before changing it.
+     */
+    rotation_period_ms?: number;
+
+    /**
+     * How many messages should be sent before changing the session.
+     */
+    rotation_period_msgs?: number;
+}
+
+/**
+ * Represents an m.room.encryption state event
+ * @category Matrix events
+ */
+export class EncryptionEvent extends StateEvent<EncryptionEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The encryption algorithm for the room.
+     */
+    public get algorithm(): string | RoomEncryptionAlgorithm {
+        return this.content.algorithm;
+    }
+
+    /**
+     * How long a session should be used before changing it. Defaults to a week.
+     */
+    public get rotationPeriodMs(): number {
+        return this.content.rotation_period_ms ?? 604800000; // 1 week
+    }
+
+    /**
+     * How many messages should be sent before a session changes. Defaults to 100.
+     */
+    public get rotationPeriodMessages(): number {
+        return this.content.rotation_period_msgs ?? 100;
+    }
+}

package/src/models/events/Event.ts

@@ -0,0 +1,38 @@
+/**
+ * A Matrix event.
+ * @category Matrix events
+ */
+export class MatrixEvent<T extends (Object | unknown) = unknown> {
+    constructor(protected event: any) {
+    }
+
+    /**
+     * The user ID who sent this event.
+     */
+    public get sender(): string {
+        return this.event['sender'];
+    }
+
+    /**
+     * The type of this event.
+     */
+    public get type(): string {
+        return this.event['type'];
+    }
+
+    /**
+     * The content for this event. May have no properties.
+     */
+    public get content(): T {
+        return this.event['content'] || {};
+    }
+
+    /**
+     * Gets the raw event that this MatrixEvent is using.
+     * Note that there's no guarantees on formats here - it is the exact
+     * same input to the constructor.
+     */
+    public get raw(): any {
+        return this.event;
+    }
+}

package/src/models/events/EventKind.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents the different kinds of events a bot/appservice might see.
+ * @category Matrix events
+ */
+export enum EventKind {
+    /**
+     * A room event. This could be a message event or a state event, and is associated with
+     * a room.
+     */
+    RoomEvent = "room",
+
+    /**
+     * An ephemeral event, such as typing notifications or presence.
+     */
+    EphemeralEvent = "ephemeral",
+}

package/src/models/events/InvalidEventError.ts

@@ -0,0 +1,19 @@
+/**
+ * Thrown when an event is invalid.
+ * @category Matrix events
+ */
+export class InvalidEventError extends Error {
+    constructor(message: string = null) {
+        super(message);
+    }
+}
+
+/**
+ * Thrown when an event is redacted.
+ * @category Matrix events
+ */
+export class EventRedactedError extends InvalidEventError {
+    constructor(message: string = null) {
+        super(message);
+    }
+}

package/src/models/events/JoinRulesEvent.ts

@@ -0,0 +1,37 @@
+import { StateEvent } from "./RoomEvent";
+
+/**
+ * The types of join rules that are valid in Matrix.
+ * @category Matrix event info
+ * @see JoinRulesEventContent
+ */
+export type JoinRule = "public" | "knock" | "invite" | "private";
+
+/**
+ * The content definition for m.room.join_rules events
+ * @category Matrix event contents
+ * @see JoinRulesEvent
+ */
+export interface JoinRulesEventContent {
+    /**
+     * The join rule for the room.
+     */
+    join_rule: JoinRule;
+}
+
+/**
+ * Represents an m.room.join_rules state event
+ * @category Matrix events
+ */
+export class JoinRulesEvent extends StateEvent<JoinRulesEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * The join rule for the room.
+     */
+    public get rule(): JoinRule {
+        return this.content.join_rule;
+    }
+}

package/src/models/events/MembershipEvent.ts

@@ -0,0 +1,77 @@
+import { StateEvent } from "./RoomEvent";
+import { InvalidEventError } from "./InvalidEventError";
+
+/**
+ * The types of membership that are valid in Matrix.
+ * @category Matrix event info
+ * @see MembershipEventContent
+ */
+export type Membership = "join" | "leave" | "ban" | "invite";
+
+/**
+ * The effective membership states a user can be in.
+ * @category Matrix event info
+ * @see MembershipEventContent
+ */
+export type EffectiveMembership = "join" | "leave" | "invite";
+
+/**
+ * The content definition for m.room.member events
+ * @category Matrix event contents
+ * @see MembershipEvent
+ */
+export interface MembershipEventContent {
+    avatar_url?: string;
+    displayname?: string;
+    membership: Membership;
+    is_direct?: boolean;
+    unsigned?: any;
+    third_party_invite?: {
+        display_name: string;
+        signed: any;
+    };
+}
+
+/**
+ * Represents an m.room.member state event
+ * @category Matrix events
+ */
+export class MembershipEvent extends StateEvent<MembershipEventContent> {
+    constructor(event: any) {
+        super(event);
+    }
+
+    /**
+     * True if the membership event targets the sender. False otherwise.
+     *
+     * This will typically by false for kicks and bans.
+     */
+    public get ownMembership(): boolean {
+        return this.membershipFor === this.sender;
+    }
+
+    /**
+     * The user ID the membership affects.
+     */
+    public get membershipFor(): string {
+        return this.stateKey;
+    }
+
+    /**
+     * The user's membership.
+     */
+    public get membership(): Membership {
+        const membership = this.content.membership;
+        if (!membership) throw new InvalidEventError("no membership field in content");
+        return membership;
+    }
+
+    /**
+     * The user's effective membership.
+     */
+    public get effectiveMembership(): EffectiveMembership {
+        if (this.membership === "join") return "join";
+        if (this.membership === "invite") return "invite";
+        return "leave";
+    }
+}