@textrp/briij-js-sdk 41.0.0

package/lib/@types/media.d.ts

@@ -0,0 +1,220 @@
+import { type MsgType } from "../@types/event.ts";
+/**
+ * Information on encrypted media attachments.
+ *
+ * Used within `m.room.message` events that reference files, such as `m.file` and `m.image`.
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#extensions-to-mroommessage-msgtypes
+ */
+export interface EncryptedFile {
+    /**
+     * The URL to the file.
+     */
+    url: string;
+    /**
+     * A JSON Web Key object.
+     */
+    key: {
+        alg: string;
+        key_ops: string[];
+        kty: string;
+        k: string;
+        ext: boolean;
+    };
+    /**
+     * The 128-bit unique counter block used by AES-CTR, encoded as unpadded base64.
+     */
+    iv: string;
+    /**
+     * A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64.
+     * Clients should support the SHA-256 hash, which uses the key `sha256`.
+     */
+    hashes: {
+        [alg: string]: string;
+    };
+    /**
+     * Version of the encrypted attachment's protocol. Must be `v2`.
+     */
+    v: string;
+}
+interface ThumbnailInfo {
+    /**
+     * The mimetype of the image, e.g. image/jpeg.
+     */
+    mimetype?: string;
+    /**
+     * The intended display width of the image in pixels.
+     * This may differ from the intrinsic dimensions of the image file.
+     */
+    w?: number;
+    /**
+     * The intended display height of the image in pixels.
+     * This may differ from the intrinsic dimensions of the image file.
+     */
+    h?: number;
+    /**
+     * Size of the image in bytes.
+     */
+    size?: number;
+}
+interface BaseInfo {
+    mimetype?: string;
+    size?: number;
+}
+/**
+ * Information on media attachments of msgtype `m.file`
+ *
+ * Used within `m.room.message` events that reference files.
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mfile
+ */
+export interface FileInfo extends BaseInfo {
+    /**
+     * Information on the encrypted thumbnail file, as specified in End-to-end encryption.
+     * Only present if the thumbnail is encrypted.
+     * @see https://spec.matrix.org/v1.11/client-server-api/#sending-encrypted-attachments
+     */
+    thumbnail_file?: EncryptedFile;
+    /**
+     * Metadata about the image referred to in thumbnail_url.
+     */
+    thumbnail_info?: ThumbnailInfo;
+    /**
+     * The URL to the thumbnail of the file. Only present if the thumbnail is unencrypted.
+     */
+    thumbnail_url?: string;
+}
+/**
+ * Information on media attachments of msgtype `m.image`
+ *
+ * Used within `m.room.message` events that reference images.
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mimage
+ */
+export interface ImageInfo extends FileInfo, ThumbnailInfo {
+}
+/**
+ * Information on media attachments of msgtype `m.audio`
+ *
+ * Used within `m.room.message` events that reference audio files.
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#maudio
+ */
+export interface AudioInfo extends BaseInfo {
+    /**
+     * The duration of the audio in milliseconds.
+     */
+    duration?: number;
+}
+/**
+ * Information on media attachments of msgtype `m.video`
+ *
+ * Used within `m.room.message` events that reference video files.
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mvideo
+ */
+export interface VideoInfo extends AudioInfo, ImageInfo {
+    /**
+     * The duration of the video in milliseconds.
+     */
+    duration?: number;
+}
+/**
+ * Union type representing the `content.info` field of all specified media events.
+ */
+export type MediaEventInfo = FileInfo | ImageInfo | AudioInfo | VideoInfo;
+interface BaseContent {
+    /**
+     * Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.
+     * @see https://spec.matrix.org/v1.11/client-server-api/#sending-encrypted-attachments
+     */
+    file?: EncryptedFile;
+    /**
+     * Required if the file is unencrypted. The URL (typically mxc:// URI) to the file.
+     */
+    url?: string;
+    /**
+     * If filename is not set or the value of both properties are identical,
+     * this is the filename of the original upload. Otherwise, this is a
+     * caption for the file.
+     */
+    body: string;
+    /**
+     * The original filename of the uploaded file.
+     */
+    filename?: string;
+    /**
+     * The format used in the `formatted_body`.
+     */
+    format?: "org.matrix.custom.html";
+    /**
+     * The formatted version of the `body`, when it acts as a caption. This is required if `format` is specified.
+     */
+    formatted_body?: string;
+}
+/**
+ * Content format of media events with msgtype `m.file`
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mfile
+ */
+export interface FileContent extends BaseContent {
+    /**
+     * Information about the file referred to in url.
+     */
+    info?: FileInfo;
+    /**
+     * One of: [m.file].
+     */
+    msgtype: MsgType.File;
+}
+/**
+ * Content format of media events with msgtype `m.image`
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mimage
+ */
+export interface ImageContent extends BaseContent {
+    /**
+     * Metadata about the image referred to in url.
+     */
+    info?: ImageInfo;
+    /**
+     * One of: [m.image].
+     */
+    msgtype: MsgType.Image;
+}
+/**
+ * Content format of media events with msgtype `m.audio`
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#maudio
+ */
+export interface AudioContent extends BaseContent {
+    /**
+     * Metadata for the audio clip referred to in url.
+     */
+    info?: AudioInfo;
+    /**
+     * One of: [m.audio].
+     */
+    msgtype: MsgType.Audio;
+}
+/**
+ * Content format of media events with msgtype `m.video`
+ *
+ * @see https://spec.matrix.org/v1.11/client-server-api/#mvideo
+ */
+export interface VideoContent extends BaseContent {
+    /**
+     * Metadata about the video clip referred to in url.
+     */
+    info?: VideoInfo;
+    /**
+     * One of: [m.video].
+     */
+    msgtype: MsgType.Video;
+}
+/**
+ * Type representing media event contents for `m.room.message` events listed in the Matrix specification
+ */
+export type MediaEventContent = FileContent | ImageContent | AudioContent | VideoContent;
+export {};
+//# sourceMappingURL=media.d.ts.map

package/lib/@types/media.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.d.ts","sourceRoot":"","sources":["../../src/@types/media.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE;QACD,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,CAAC,EAAE,MAAM,CAAC;QACV,GAAG,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;CACb;AAED,UAAU,aAAa;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,QAAQ;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACtC;;;;OAIG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAU,SAAQ,QAAQ,EAAE,aAAa;CAAG;AAE7D;;;;;;GAMG;AACH,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS,EAAE,SAAS;IACnD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AAE1E,UAAU,WAAW;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAC"}

package/lib/@types/media.js

@@ -0,0 +1 @@
+export {};

package/lib/@types/media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.js","names":[],"sources":["../../src/@types/media.ts"],"sourcesContent":["/*\r\nCopyright 2024 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type MsgType } from \"../@types/event.ts\";\r\n\r\n/**\r\n * Information on encrypted media attachments.\r\n *\r\n * Used within `m.room.message` events that reference files, such as `m.file` and `m.image`.\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#extensions-to-mroommessage-msgtypes\r\n */\r\nexport interface EncryptedFile {\r\n    /**\r\n     * The URL to the file.\r\n     */\r\n    url: string;\r\n    /**\r\n     * A JSON Web Key object.\r\n     */\r\n    key: {\r\n        alg: string;\r\n        key_ops: string[]; // eslint-disable-line camelcase\r\n        kty: string;\r\n        k: string;\r\n        ext: boolean;\r\n    };\r\n    /**\r\n     * The 128-bit unique counter block used by AES-CTR, encoded as unpadded base64.\r\n     */\r\n    iv: string;\r\n    /**\r\n     * A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64.\r\n     * Clients should support the SHA-256 hash, which uses the key `sha256`.\r\n     */\r\n    hashes: { [alg: string]: string };\r\n    /**\r\n     * Version of the encrypted attachment's protocol. Must be `v2`.\r\n     */\r\n    v: string;\r\n}\r\n\r\ninterface ThumbnailInfo {\r\n    /**\r\n     * The mimetype of the image, e.g. image/jpeg.\r\n     */\r\n    mimetype?: string;\r\n    /**\r\n     * The intended display width of the image in pixels.\r\n     * This may differ from the intrinsic dimensions of the image file.\r\n     */\r\n    w?: number;\r\n    /**\r\n     * The intended display height of the image in pixels.\r\n     * This may differ from the intrinsic dimensions of the image file.\r\n     */\r\n    h?: number;\r\n    /**\r\n     * Size of the image in bytes.\r\n     */\r\n    size?: number;\r\n}\r\n\r\ninterface BaseInfo {\r\n    mimetype?: string;\r\n    size?: number;\r\n}\r\n\r\n/**\r\n * Information on media attachments of msgtype `m.file`\r\n *\r\n * Used within `m.room.message` events that reference files.\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mfile\r\n */\r\nexport interface FileInfo extends BaseInfo {\r\n    /**\r\n     * Information on the encrypted thumbnail file, as specified in End-to-end encryption.\r\n     * Only present if the thumbnail is encrypted.\r\n     * @see https://spec.matrix.org/v1.11/client-server-api/#sending-encrypted-attachments\r\n     */\r\n    thumbnail_file?: EncryptedFile;\r\n    /**\r\n     * Metadata about the image referred to in thumbnail_url.\r\n     */\r\n    thumbnail_info?: ThumbnailInfo;\r\n    /**\r\n     * The URL to the thumbnail of the file. Only present if the thumbnail is unencrypted.\r\n     */\r\n    thumbnail_url?: string;\r\n}\r\n\r\n/**\r\n * Information on media attachments of msgtype `m.image`\r\n *\r\n * Used within `m.room.message` events that reference images.\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mimage\r\n */\r\nexport interface ImageInfo extends FileInfo, ThumbnailInfo {}\r\n\r\n/**\r\n * Information on media attachments of msgtype `m.audio`\r\n *\r\n * Used within `m.room.message` events that reference audio files.\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#maudio\r\n */\r\nexport interface AudioInfo extends BaseInfo {\r\n    /**\r\n     * The duration of the audio in milliseconds.\r\n     */\r\n    duration?: number;\r\n}\r\n\r\n/**\r\n * Information on media attachments of msgtype `m.video`\r\n *\r\n * Used within `m.room.message` events that reference video files.\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mvideo\r\n */\r\nexport interface VideoInfo extends AudioInfo, ImageInfo {\r\n    /**\r\n     * The duration of the video in milliseconds.\r\n     */\r\n    duration?: number;\r\n}\r\n\r\n/**\r\n * Union type representing the `content.info` field of all specified media events.\r\n */\r\nexport type MediaEventInfo = FileInfo | ImageInfo | AudioInfo | VideoInfo;\r\n\r\ninterface BaseContent {\r\n    /**\r\n     * Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.\r\n     * @see https://spec.matrix.org/v1.11/client-server-api/#sending-encrypted-attachments\r\n     */\r\n    file?: EncryptedFile;\r\n    /**\r\n     * Required if the file is unencrypted. The URL (typically mxc:// URI) to the file.\r\n     */\r\n    url?: string;\r\n    /**\r\n     * If filename is not set or the value of both properties are identical,\r\n     * this is the filename of the original upload. Otherwise, this is a\r\n     * caption for the file.\r\n     */\r\n    body: string;\r\n    /**\r\n     * The original filename of the uploaded file.\r\n     */\r\n    filename?: string;\r\n    /**\r\n     * The format used in the `formatted_body`.\r\n     */\r\n    format?: \"org.matrix.custom.html\";\r\n    /**\r\n     * The formatted version of the `body`, when it acts as a caption. This is required if `format` is specified.\r\n     */\r\n    formatted_body?: string;\r\n}\r\n\r\n/**\r\n * Content format of media events with msgtype `m.file`\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mfile\r\n */\r\nexport interface FileContent extends BaseContent {\r\n    /**\r\n     * Information about the file referred to in url.\r\n     */\r\n    info?: FileInfo;\r\n    /**\r\n     * One of: [m.file].\r\n     */\r\n    msgtype: MsgType.File;\r\n}\r\n\r\n/**\r\n * Content format of media events with msgtype `m.image`\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mimage\r\n */\r\nexport interface ImageContent extends BaseContent {\r\n    /**\r\n     * Metadata about the image referred to in url.\r\n     */\r\n    info?: ImageInfo;\r\n    /**\r\n     * One of: [m.image].\r\n     */\r\n    msgtype: MsgType.Image;\r\n}\r\n\r\n/**\r\n * Content format of media events with msgtype `m.audio`\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#maudio\r\n */\r\nexport interface AudioContent extends BaseContent {\r\n    /**\r\n     * Metadata for the audio clip referred to in url.\r\n     */\r\n    info?: AudioInfo;\r\n    /**\r\n     * One of: [m.audio].\r\n     */\r\n    msgtype: MsgType.Audio;\r\n}\r\n\r\n/**\r\n * Content format of media events with msgtype `m.video`\r\n *\r\n * @see https://spec.matrix.org/v1.11/client-server-api/#mvideo\r\n */\r\nexport interface VideoContent extends BaseContent {\r\n    /**\r\n     * Metadata about the video clip referred to in url.\r\n     */\r\n    info?: VideoInfo;\r\n    /**\r\n     * One of: [m.video].\r\n     */\r\n    msgtype: MsgType.Video;\r\n}\r\n\r\n/**\r\n * Type representing media event contents for `m.room.message` events listed in the Matrix specification\r\n */\r\nexport type MediaEventContent = FileContent | ImageContent | AudioContent | VideoContent;\r\n"],"mappings":"","ignoreList":[]}

package/lib/@types/membership.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Well-known values (from the spec or MSCs) that are allowed in the
+ * {@link Membership} type.
+ */
+export declare enum KnownMembership {
+    /**
+     * The user has been banned from the room, and is no longer allowed to join
+     * it until they are un-banned from the room (by having their membership
+     * state set to a value other than ban).
+     */
+    Ban = "ban",
+    /**
+     * The user has been invited to join a room, but has not yet joined it.
+     * They may not participate in the room until they join.
+     * */
+    Invite = "invite",
+    /**
+     * The user has joined the room (possibly after accepting an invite), and
+     * may participate in it.
+     */
+    Join = "join",
+    /**
+     * The user has knocked on the room, requesting permission to participate.
+     * They may not participate in the room until they join.
+     */
+    Knock = "knock",
+    /**
+     * The user was once joined to the room, but has since left (possibly by
+     * choice, or possibly by being kicked).
+     */
+    Leave = "leave"
+}
+/**
+ * The membership state for a user in a room [1]. A value from
+ * {@link KnownMembership} should be used where available, but all string values
+ * are allowed to provide flexibility for upcoming spec changes or proposals.
+ *
+ * [1] https://spec.matrix.org/latest/client-server-api/#mroommember
+ */
+export type Membership = KnownMembership | string;
+//# sourceMappingURL=membership.d.ts.map

package/lib/@types/membership.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"membership.d.ts","sourceRoot":"","sources":["../../src/@types/membership.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,oBAAY,eAAe;IACvB;;;;OAIG;IACH,GAAG,QAAQ;IACX;;;SAGK;IACL,MAAM,WAAW;IACjB;;;OAGG;IACH,IAAI,SAAS;IACb;;;OAGG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,KAAK,UAAU;CAClB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,MAAM,CAAC"}

package/lib/@types/membership.js

@@ -0,0 +1,58 @@
+/*
+Copyright 2024 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.
+*/
+
+/**
+ * Well-known values (from the spec or MSCs) that are allowed in the
+ * {@link Membership} type.
+ */
+export var KnownMembership = /*#__PURE__*/function (KnownMembership) {
+  /**
+   * The user has been banned from the room, and is no longer allowed to join
+   * it until they are un-banned from the room (by having their membership
+   * state set to a value other than ban).
+   */
+  KnownMembership["Ban"] = "ban";
+  /**
+   * The user has been invited to join a room, but has not yet joined it.
+   * They may not participate in the room until they join.
+   * */
+  KnownMembership["Invite"] = "invite";
+  /**
+   * The user has joined the room (possibly after accepting an invite), and
+   * may participate in it.
+   */
+  KnownMembership["Join"] = "join";
+  /**
+   * The user has knocked on the room, requesting permission to participate.
+   * They may not participate in the room until they join.
+   */
+  KnownMembership["Knock"] = "knock";
+  /**
+   * The user was once joined to the room, but has since left (possibly by
+   * choice, or possibly by being kicked).
+   */
+  KnownMembership["Leave"] = "leave";
+  return KnownMembership;
+}({});
+
+/**
+ * The membership state for a user in a room [1]. A value from
+ * {@link KnownMembership} should be used where available, but all string values
+ * are allowed to provide flexibility for upcoming spec changes or proposals.
+ *
+ * [1] https://spec.matrix.org/latest/client-server-api/#mroommember
+ */
+//# sourceMappingURL=membership.js.map

package/lib/@types/membership.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"membership.js","names":["KnownMembership"],"sources":["../../src/@types/membership.ts"],"sourcesContent":["/*\r\nCopyright 2024 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\n/**\r\n * Well-known values (from the spec or MSCs) that are allowed in the\r\n * {@link Membership} type.\r\n */\r\nexport enum KnownMembership {\r\n    /**\r\n     * The user has been banned from the room, and is no longer allowed to join\r\n     * it until they are un-banned from the room (by having their membership\r\n     * state set to a value other than ban).\r\n     */\r\n    Ban = \"ban\",\r\n    /**\r\n     * The user has been invited to join a room, but has not yet joined it.\r\n     * They may not participate in the room until they join.\r\n     * */\r\n    Invite = \"invite\",\r\n    /**\r\n     * The user has joined the room (possibly after accepting an invite), and\r\n     * may participate in it.\r\n     */\r\n    Join = \"join\",\r\n    /**\r\n     * The user has knocked on the room, requesting permission to participate.\r\n     * They may not participate in the room until they join.\r\n     */\r\n    Knock = \"knock\",\r\n    /**\r\n     * The user was once joined to the room, but has since left (possibly by\r\n     * choice, or possibly by being kicked).\r\n     */\r\n    Leave = \"leave\",\r\n}\r\n\r\n/**\r\n * The membership state for a user in a room [1]. A value from\r\n * {@link KnownMembership} should be used where available, but all string values\r\n * are allowed to provide flexibility for upcoming spec changes or proposals.\r\n *\r\n * [1] https://spec.matrix.org/latest/client-server-api/#mroommember\r\n */\r\nexport type Membership = KnownMembership | string;\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,WAAYA,eAAe,0BAAfA,eAAe;EACvB;AACJ;AACA;AACA;AACA;EALYA,eAAe;EAOvB;AACJ;AACA;AACA;EAVYA,eAAe;EAYvB;AACJ;AACA;AACA;EAfYA,eAAe;EAiBvB;AACJ;AACA;AACA;EApBYA,eAAe;EAsBvB;AACJ;AACA;AACA;EAzBYA,eAAe;EAAA,OAAfA,eAAe;AAAA;;AA6B3B;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/lib/@types/partials.d.ts

@@ -0,0 +1,72 @@
+export declare enum Visibility {
+    Public = "public",
+    Private = "private"
+}
+export declare enum Preset {
+    PrivateChat = "private_chat",
+    TrustedPrivateChat = "trusted_private_chat",
+    PublicChat = "public_chat"
+}
+export type ResizeMethod = "crop" | "scale";
+export type IdServerUnbindResult = "no-support" | "success";
+export declare enum JoinRule {
+    Public = "public",
+    Invite = "invite",
+    /**
+     * @deprecated Reserved keyword. Should not be used. Not yet implemented.
+     */
+    Private = "private",
+    Knock = "knock",
+    Restricted = "restricted"
+}
+export declare enum RestrictedAllowType {
+    RoomMembership = "m.room_membership"
+}
+export declare enum GuestAccess {
+    CanJoin = "can_join",
+    Forbidden = "forbidden"
+}
+export declare enum HistoryVisibility {
+    Invited = "invited",
+    Joined = "joined",
+    Shared = "shared",
+    WorldReadable = "world_readable"
+}
+export interface IUsageLimit {
+    limit_type: "monthly_active_user" | "hs_disabled" | string;
+    admin_contact?: string;
+}
+/**
+ * A policy name & url in a specific internationalisation
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_internationalised-policy
+ */
+export interface InternationalisedPolicy {
+    name: string;
+    url: string;
+}
+/**
+ * A versioned policy with internationalised variants
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_policy-object
+ */
+export interface Policy {
+    /**
+     * The version for the policy.
+     * There are no requirements on what this might be and could be “alpha”, semantically versioned, or arbitrary.
+     */
+    version: string;
+    /**
+     * The policy information for the specified language.
+     * @remarks the type has to include a union with string due to limitations in the type system.
+     */
+    [lang: string]: InternationalisedPolicy | string;
+}
+/**
+ * Response from the Terms API for Identity servers
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms
+ */
+export interface Terms {
+    policies: {
+        [policyName: string]: Policy;
+    };
+}
+//# sourceMappingURL=partials.d.ts.map

package/lib/@types/partials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partials.d.ts","sourceRoot":"","sources":["../../src/@types/partials.ts"],"names":[],"mappings":"AAgBA,oBAAY,UAAU;IAClB,MAAM,WAAW;IACjB,OAAO,YAAY;CACtB;AAED,oBAAY,MAAM;IACd,WAAW,iBAAiB;IAC5B,kBAAkB,yBAAyB;IAC3C,UAAU,gBAAgB;CAC7B;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,SAAS,CAAC;AAG5D,oBAAY,QAAQ;IAChB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,UAAU,eAAe;CAC5B;AAED,oBAAY,mBAAmB;IAC3B,cAAc,sBAAsB;CACvC;AAED,oBAAY,WAAW;IACnB,OAAO,aAAa;IACpB,SAAS,cAAc;CAC1B;AAED,oBAAY,iBAAiB;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,aAAa,mBAAmB;CACnC;AAED,MAAM,WAAW,WAAW;IAIxB,UAAU,EAAE,qBAAqB,GAAG,aAAa,GAAG,MAAM,CAAC;IAE3D,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,GAAG,MAAM,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IAClB,QAAQ,EAAE;QACN,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;CACL"}

package/lib/@types/partials.js

@@ -0,0 +1,71 @@
+/*
+Copyright 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.
+*/
+
+export var Visibility = /*#__PURE__*/function (Visibility) {
+  Visibility["Public"] = "public";
+  Visibility["Private"] = "private";
+  return Visibility;
+}({});
+export var Preset = /*#__PURE__*/function (Preset) {
+  Preset["PrivateChat"] = "private_chat";
+  Preset["TrustedPrivateChat"] = "trusted_private_chat";
+  Preset["PublicChat"] = "public_chat";
+  return Preset;
+}({});
+// Knock and private are reserved keywords which are not yet implemented.
+export var JoinRule = /*#__PURE__*/function (JoinRule) {
+  JoinRule["Public"] = "public";
+  JoinRule["Invite"] = "invite";
+  /**
+   * @deprecated Reserved keyword. Should not be used. Not yet implemented.
+   */
+  JoinRule["Private"] = "private";
+  JoinRule["Knock"] = "knock";
+  JoinRule["Restricted"] = "restricted";
+  return JoinRule;
+}({});
+export var RestrictedAllowType = /*#__PURE__*/function (RestrictedAllowType) {
+  RestrictedAllowType["RoomMembership"] = "m.room_membership";
+  return RestrictedAllowType;
+}({});
+export var GuestAccess = /*#__PURE__*/function (GuestAccess) {
+  GuestAccess["CanJoin"] = "can_join";
+  GuestAccess["Forbidden"] = "forbidden";
+  return GuestAccess;
+}({});
+export var HistoryVisibility = /*#__PURE__*/function (HistoryVisibility) {
+  HistoryVisibility["Invited"] = "invited";
+  HistoryVisibility["Joined"] = "joined";
+  HistoryVisibility["Shared"] = "shared";
+  HistoryVisibility["WorldReadable"] = "world_readable";
+  return HistoryVisibility;
+}({});
+
+/**
+ * A policy name & url in a specific internationalisation
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_internationalised-policy
+ */
+
+/**
+ * A versioned policy with internationalised variants
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_policy-object
+ */
+
+/**
+ * Response from the Terms API for Identity servers
+ * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms
+ */
+//# sourceMappingURL=partials.js.map

package/lib/@types/partials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partials.js","names":["Visibility","Preset","JoinRule","RestrictedAllowType","GuestAccess","HistoryVisibility"],"sources":["../../src/@types/partials.ts"],"sourcesContent":["/*\r\nCopyright 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nexport enum Visibility {\r\n    Public = \"public\",\r\n    Private = \"private\",\r\n}\r\n\r\nexport enum Preset {\r\n    PrivateChat = \"private_chat\",\r\n    TrustedPrivateChat = \"trusted_private_chat\",\r\n    PublicChat = \"public_chat\",\r\n}\r\n\r\nexport type ResizeMethod = \"crop\" | \"scale\";\r\n\r\nexport type IdServerUnbindResult = \"no-support\" | \"success\";\r\n\r\n// Knock and private are reserved keywords which are not yet implemented.\r\nexport enum JoinRule {\r\n    Public = \"public\",\r\n    Invite = \"invite\",\r\n    /**\r\n     * @deprecated Reserved keyword. Should not be used. Not yet implemented.\r\n     */\r\n    Private = \"private\",\r\n    Knock = \"knock\",\r\n    Restricted = \"restricted\",\r\n}\r\n\r\nexport enum RestrictedAllowType {\r\n    RoomMembership = \"m.room_membership\",\r\n}\r\n\r\nexport enum GuestAccess {\r\n    CanJoin = \"can_join\",\r\n    Forbidden = \"forbidden\",\r\n}\r\n\r\nexport enum HistoryVisibility {\r\n    Invited = \"invited\",\r\n    Joined = \"joined\",\r\n    Shared = \"shared\",\r\n    WorldReadable = \"world_readable\",\r\n}\r\n\r\nexport interface IUsageLimit {\r\n    // \"hs_disabled\" is NOT a specced string, but is used in Synapse\r\n    // This is tracked over at https://github.com/matrix-org/synapse/issues/9237\r\n    // eslint-disable-next-line camelcase\r\n    limit_type: \"monthly_active_user\" | \"hs_disabled\" | string;\r\n    // eslint-disable-next-line camelcase\r\n    admin_contact?: string;\r\n}\r\n\r\n/**\r\n * A policy name & url in a specific internationalisation\r\n * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_internationalised-policy\r\n */\r\nexport interface InternationalisedPolicy {\r\n    name: string;\r\n    url: string;\r\n}\r\n\r\n/**\r\n * A versioned policy with internationalised variants\r\n * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms_response-200_policy-object\r\n */\r\nexport interface Policy {\r\n    /**\r\n     * The version for the policy.\r\n     * There are no requirements on what this might be and could be “alpha”, semantically versioned, or arbitrary.\r\n     */\r\n    version: string;\r\n    /**\r\n     * The policy information for the specified language.\r\n     * @remarks the type has to include a union with string due to limitations in the type system.\r\n     */\r\n    [lang: string]: InternationalisedPolicy | string;\r\n}\r\n\r\n/**\r\n * Response from the Terms API for Identity servers\r\n * @see https://spec.matrix.org/v1.13/identity-service-api/#get_matrixidentityv2terms\r\n */\r\nexport interface Terms {\r\n    policies: {\r\n        [policyName: string]: Policy;\r\n    };\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAKtB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAUlB;AACA,WAAYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAGhB;AACJ;AACA;EALYA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AAWpB,WAAYC,mBAAmB,0BAAnBA,mBAAmB;EAAnBA,mBAAmB;EAAA,OAAnBA,mBAAmB;AAAA;AAI/B,WAAYC,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAKvB,WAAYC,iBAAiB,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;;AAgB7B;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA","ignoreList":[]}

package/lib/@types/polls.d.ts

@@ -0,0 +1,89 @@
+import { type EitherAnd, UnstableValue } from "matrix-events-sdk";
+import { type ExtensibleAnyMessageEventContent, type REFERENCE_RELATION, type RelatesToRelationship, type TSNamespace } from "./extensible_events.ts";
+import { type EmptyObject } from "./common.ts";
+/**
+ * Identifier for a disclosed poll.
+ */
+export declare const M_POLL_KIND_DISCLOSED: UnstableValue<"m.poll.disclosed", "org.matrix.msc3381.poll.disclosed">;
+/**
+ * Identifier for an undisclosed poll.
+ */
+export declare const M_POLL_KIND_UNDISCLOSED: UnstableValue<"m.poll.undisclosed", "org.matrix.msc3381.poll.undisclosed">;
+/**
+ * Any poll kind.
+ */
+export type PollKind = TSNamespace<typeof M_POLL_KIND_DISCLOSED> | TSNamespace<typeof M_POLL_KIND_UNDISCLOSED> | string;
+/**
+ * Known poll kind namespaces.
+ */
+export type KnownPollKind = typeof M_POLL_KIND_DISCLOSED | typeof M_POLL_KIND_UNDISCLOSED;
+/**
+ * The namespaced value for m.poll.start
+ */
+export declare const M_POLL_START: UnstableValue<"m.poll.start", "org.matrix.msc3381.poll.start">;
+/**
+ * The m.poll.start type within event content
+ */
+export type PollStartSubtype = {
+    question: ExtensibleAnyMessageEventContent;
+    kind: PollKind;
+    max_selections?: number;
+    answers: PollAnswer[];
+};
+/**
+ * A poll answer.
+ */
+export type PollAnswer = ExtensibleAnyMessageEventContent & {
+    id: string;
+};
+/**
+ * The event definition for an m.poll.start event (in content)
+ */
+export type PollStartEvent = EitherAnd<{
+    [M_POLL_START.name]: PollStartSubtype;
+}, {
+    [M_POLL_START.altName]: PollStartSubtype;
+}>;
+/**
+ * The content for an m.poll.start event
+ */
+export type PollStartEventContent = PollStartEvent & ExtensibleAnyMessageEventContent;
+/**
+ * The namespaced value for m.poll.response
+ */
+export declare const M_POLL_RESPONSE: UnstableValue<"m.poll.response", "org.matrix.msc3381.poll.response">;
+/**
+ * The m.poll.response type within event content
+ */
+export type PollResponseSubtype = {
+    answers: string[];
+};
+/**
+ * The event definition for an m.poll.response event (in content)
+ */
+export type PollResponseEvent = EitherAnd<{
+    [M_POLL_RESPONSE.name]: PollResponseSubtype;
+}, {
+    [M_POLL_RESPONSE.altName]: PollResponseSubtype;
+}>;
+/**
+ * The content for an m.poll.response event
+ */
+export type PollResponseEventContent = PollResponseEvent & RelatesToRelationship<typeof REFERENCE_RELATION>;
+/**
+ * The namespaced value for m.poll.end
+ */
+export declare const M_POLL_END: UnstableValue<"m.poll.end", "org.matrix.msc3381.poll.end">;
+/**
+ * The event definition for an m.poll.end event (in content)
+ */
+export type PollEndEvent = EitherAnd<{
+    [M_POLL_END.name]: EmptyObject;
+}, {
+    [M_POLL_END.altName]: EmptyObject;
+}>;
+/**
+ * The content for an m.poll.end event
+ */
+export type PollEndEventContent = PollEndEvent & RelatesToRelationship<typeof REFERENCE_RELATION> & ExtensibleAnyMessageEventContent;
+//# sourceMappingURL=polls.d.ts.map

package/lib/@types/polls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polls.d.ts","sourceRoot":"","sources":["../../src/@types/polls.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,SAAS,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElE,OAAO,EACH,KAAK,gCAAgC,EACrC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EACnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,qBAAqB,wEAA6E,CAAC;AAEhH;;GAEG;AACH,eAAO,MAAM,uBAAuB,4EAAiF,CAAC;AAEtH;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,qBAAqB,CAAC,GAAG,WAAW,CAAC,OAAO,uBAAuB,CAAC,GAAG,MAAM,CAAC;AAExH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,qBAAqB,GAAG,OAAO,uBAAuB,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,YAAY,gEAAqE,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,QAAQ,EAAE,gCAAgC,CAAC;IAC3C,IAAI,EAAE,QAAQ,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,UAAU,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,gCAAgC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,CAClC;IAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAAE,EACzC;IAAE,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG,gCAAgC,CAAC;AAEtF;;GAEG;AACH,eAAO,MAAM,eAAe,sEAA2E,CAAC;AAExG;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CACrC;IAAE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAA;CAAE,EAC/C;IAAE,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAAE,CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG,qBAAqB,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE5G;;GAEG;AACH,eAAO,MAAM,UAAU,4DAAiE,CAAC;AAEzF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC;IAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,CAAA;CAAE,EAAE;IAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AAEhH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAC1C,qBAAqB,CAAC,OAAO,kBAAkB,CAAC,GAChD,gCAAgC,CAAC"}