@textrp/briij-js-sdk 41.0.0

package/lib/@types/polls.js

@@ -0,0 +1,86 @@
+/*
+Copyright 2022 - 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 { UnstableValue } from "matrix-events-sdk";
+/**
+ * Identifier for a disclosed poll.
+ */
+export var M_POLL_KIND_DISCLOSED = new UnstableValue("m.poll.disclosed", "org.matrix.msc3381.poll.disclosed");
+
+/**
+ * Identifier for an undisclosed poll.
+ */
+export var M_POLL_KIND_UNDISCLOSED = new UnstableValue("m.poll.undisclosed", "org.matrix.msc3381.poll.undisclosed");
+
+/**
+ * Any poll kind.
+ */
+
+/**
+ * Known poll kind namespaces.
+ */
+
+/**
+ * The namespaced value for m.poll.start
+ */
+export var M_POLL_START = new UnstableValue("m.poll.start", "org.matrix.msc3381.poll.start");
+
+/**
+ * The m.poll.start type within event content
+ */
+
+/**
+ * A poll answer.
+ */
+
+/**
+ * The event definition for an m.poll.start event (in content)
+ */
+
+/**
+ * The content for an m.poll.start event
+ */
+
+/**
+ * The namespaced value for m.poll.response
+ */
+export var M_POLL_RESPONSE = new UnstableValue("m.poll.response", "org.matrix.msc3381.poll.response");
+
+/**
+ * The m.poll.response type within event content
+ */
+
+/**
+ * The event definition for an m.poll.response event (in content)
+ */
+
+/**
+ * The content for an m.poll.response event
+ */
+
+/**
+ * The namespaced value for m.poll.end
+ */
+export var M_POLL_END = new UnstableValue("m.poll.end", "org.matrix.msc3381.poll.end");
+
+/**
+ * The event definition for an m.poll.end event (in content)
+ */
+
+/**
+ * The content for an m.poll.end event
+ */
+//# sourceMappingURL=polls.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"polls.js","names":["UnstableValue","M_POLL_KIND_DISCLOSED","M_POLL_KIND_UNDISCLOSED","M_POLL_START","M_POLL_RESPONSE","M_POLL_END"],"sources":["../../src/@types/polls.ts"],"sourcesContent":["/*\r\nCopyright 2022 - 2023 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 EitherAnd, UnstableValue } from \"matrix-events-sdk\";\r\n\r\nimport {\r\n    type ExtensibleAnyMessageEventContent,\r\n    type REFERENCE_RELATION,\r\n    type RelatesToRelationship,\r\n    type TSNamespace,\r\n} from \"./extensible_events.ts\";\r\nimport { type EmptyObject } from \"./common.ts\";\r\n\r\n/**\r\n * Identifier for a disclosed poll.\r\n */\r\nexport const M_POLL_KIND_DISCLOSED = new UnstableValue(\"m.poll.disclosed\", \"org.matrix.msc3381.poll.disclosed\");\r\n\r\n/**\r\n * Identifier for an undisclosed poll.\r\n */\r\nexport const M_POLL_KIND_UNDISCLOSED = new UnstableValue(\"m.poll.undisclosed\", \"org.matrix.msc3381.poll.undisclosed\");\r\n\r\n/**\r\n * Any poll kind.\r\n */\r\nexport type PollKind = TSNamespace<typeof M_POLL_KIND_DISCLOSED> | TSNamespace<typeof M_POLL_KIND_UNDISCLOSED> | string;\r\n\r\n/**\r\n * Known poll kind namespaces.\r\n */\r\nexport type KnownPollKind = typeof M_POLL_KIND_DISCLOSED | typeof M_POLL_KIND_UNDISCLOSED;\r\n\r\n/**\r\n * The namespaced value for m.poll.start\r\n */\r\nexport const M_POLL_START = new UnstableValue(\"m.poll.start\", \"org.matrix.msc3381.poll.start\");\r\n\r\n/**\r\n * The m.poll.start type within event content\r\n */\r\nexport type PollStartSubtype = {\r\n    question: ExtensibleAnyMessageEventContent;\r\n    kind: PollKind;\r\n    max_selections?: number; // default 1, always positive\r\n    answers: PollAnswer[];\r\n};\r\n\r\n/**\r\n * A poll answer.\r\n */\r\nexport type PollAnswer = ExtensibleAnyMessageEventContent & { id: string };\r\n\r\n/**\r\n * The event definition for an m.poll.start event (in content)\r\n */\r\nexport type PollStartEvent = EitherAnd<\r\n    { [M_POLL_START.name]: PollStartSubtype },\r\n    { [M_POLL_START.altName]: PollStartSubtype }\r\n>;\r\n\r\n/**\r\n * The content for an m.poll.start event\r\n */\r\nexport type PollStartEventContent = PollStartEvent & ExtensibleAnyMessageEventContent;\r\n\r\n/**\r\n * The namespaced value for m.poll.response\r\n */\r\nexport const M_POLL_RESPONSE = new UnstableValue(\"m.poll.response\", \"org.matrix.msc3381.poll.response\");\r\n\r\n/**\r\n * The m.poll.response type within event content\r\n */\r\nexport type PollResponseSubtype = {\r\n    answers: string[];\r\n};\r\n\r\n/**\r\n * The event definition for an m.poll.response event (in content)\r\n */\r\nexport type PollResponseEvent = EitherAnd<\r\n    { [M_POLL_RESPONSE.name]: PollResponseSubtype },\r\n    { [M_POLL_RESPONSE.altName]: PollResponseSubtype }\r\n>;\r\n\r\n/**\r\n * The content for an m.poll.response event\r\n */\r\nexport type PollResponseEventContent = PollResponseEvent & RelatesToRelationship<typeof REFERENCE_RELATION>;\r\n\r\n/**\r\n * The namespaced value for m.poll.end\r\n */\r\nexport const M_POLL_END = new UnstableValue(\"m.poll.end\", \"org.matrix.msc3381.poll.end\");\r\n\r\n/**\r\n * The event definition for an m.poll.end event (in content)\r\n */\r\nexport type PollEndEvent = EitherAnd<{ [M_POLL_END.name]: EmptyObject }, { [M_POLL_END.altName]: EmptyObject }>;\r\n\r\n/**\r\n * The content for an m.poll.end event\r\n */\r\nexport type PollEndEventContent = PollEndEvent &\r\n    RelatesToRelationship<typeof REFERENCE_RELATION> &\r\n    ExtensibleAnyMessageEventContent;\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAyBA,aAAa,QAAQ,mBAAmB;AAUjE;AACA;AACA;AACA,OAAO,IAAMC,qBAAqB,GAAG,IAAID,aAAa,CAAC,kBAAkB,EAAE,mCAAmC,CAAC;;AAE/G;AACA;AACA;AACA,OAAO,IAAME,uBAAuB,GAAG,IAAIF,aAAa,CAAC,oBAAoB,EAAE,qCAAqC,CAAC;;AAErH;AACA;AACA;;AAGA;AACA;AACA;;AAGA;AACA;AACA;AACA,OAAO,IAAMG,YAAY,GAAG,IAAIH,aAAa,CAAC,cAAc,EAAE,+BAA+B,CAAC;;AAE9F;AACA;AACA;;AAQA;AACA;AACA;;AAGA;AACA;AACA;;AAMA;AACA;AACA;;AAGA;AACA;AACA;AACA,OAAO,IAAMI,eAAe,GAAG,IAAIJ,aAAa,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;;AAEvG;AACA;AACA;;AAKA;AACA;AACA;;AAMA;AACA;AACA;;AAGA;AACA;AACA;AACA,OAAO,IAAMK,UAAU,GAAG,IAAIL,aAAa,CAAC,YAAY,EAAE,6BAA6B,CAAC;;AAExF;AACA;AACA;;AAGA;AACA;AACA","ignoreList":[]}

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

@@ -0,0 +1,36 @@
+export declare enum ReceiptType {
+    Read = "m.read",
+    FullyRead = "m.fully_read",
+    ReadPrivate = "m.read.private"
+}
+export declare const MAIN_ROOM_TIMELINE = "main";
+export interface Receipt {
+    ts: number;
+    thread_id?: string;
+}
+export interface WrappedReceipt {
+    eventId: string;
+    data: Receipt;
+}
+export interface CachedReceipt {
+    type: ReceiptType;
+    userId: string;
+    data: Receipt;
+}
+export type ReceiptCache = Map<string, CachedReceipt[]>;
+export interface ReceiptContent {
+    [eventId: string]: {
+        [key in ReceiptType | string]: {
+            [userId: string]: Receipt;
+        };
+    };
+}
+export type Receipts = Map<string, Map<string, [real: WrappedReceipt | null, synthetic: WrappedReceipt | null]>>;
+export type CachedReceiptStructure = {
+    eventId: string;
+    receiptType: string | ReceiptType;
+    userId: string;
+    receipt: Receipt;
+    synthetic: boolean;
+};
+//# sourceMappingURL=read_receipts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read_receipts.d.ts","sourceRoot":"","sources":["../../src/@types/read_receipts.ts"],"names":[],"mappings":"AAgBA,oBAAY,WAAW;IACnB,IAAI,WAAW;IACf,SAAS,iBAAiB;IAC1B,WAAW,mBAAmB;CACjC;AAED,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAEzC,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;AAExD,MAAM,WAAW,cAAc;IAC3B,CAAC,OAAO,EAAE,MAAM,GAAG;SACd,GAAG,IAAI,WAAW,GAAG,MAAM,GAAG;YAC3B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;SAC7B;KACJ,CAAC;CACL;AAID,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AAEjH,MAAM,MAAM,sBAAsB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,GAAG,WAAW,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACtB,CAAC"}

package/lib/@types/read_receipts.js

@@ -0,0 +1,27 @@
+/*
+Copyright 2022 Šimon Brandner <simon.bra.ag@gmail.com>
+
+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 ReceiptType = /*#__PURE__*/function (ReceiptType) {
+  ReceiptType["Read"] = "m.read";
+  ReceiptType["FullyRead"] = "m.fully_read";
+  ReceiptType["ReadPrivate"] = "m.read.private";
+  return ReceiptType;
+}({});
+export var MAIN_ROOM_TIMELINE = "main";
+
+// We will only hold a synthetic receipt if we do not have a real receipt or the synthetic is newer.
+// map: receipt type → user Id → receipt
+//# sourceMappingURL=read_receipts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read_receipts.js","names":["ReceiptType","MAIN_ROOM_TIMELINE"],"sources":["../../src/@types/read_receipts.ts"],"sourcesContent":["/*\r\nCopyright 2022 Šimon Brandner <simon.bra.ag@gmail.com>\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 ReceiptType {\r\n    Read = \"m.read\",\r\n    FullyRead = \"m.fully_read\",\r\n    ReadPrivate = \"m.read.private\",\r\n}\r\n\r\nexport const MAIN_ROOM_TIMELINE = \"main\";\r\n\r\nexport interface Receipt {\r\n    ts: number;\r\n    thread_id?: string;\r\n}\r\n\r\nexport interface WrappedReceipt {\r\n    eventId: string;\r\n    data: Receipt;\r\n}\r\n\r\nexport interface CachedReceipt {\r\n    type: ReceiptType;\r\n    userId: string;\r\n    data: Receipt;\r\n}\r\n\r\nexport type ReceiptCache = Map<string, CachedReceipt[]>;\r\n\r\nexport interface ReceiptContent {\r\n    [eventId: string]: {\r\n        [key in ReceiptType | string]: {\r\n            [userId: string]: Receipt;\r\n        };\r\n    };\r\n}\r\n\r\n// We will only hold a synthetic receipt if we do not have a real receipt or the synthetic is newer.\r\n// map: receipt type → user Id → receipt\r\nexport type Receipts = Map<string, Map<string, [real: WrappedReceipt | null, synthetic: WrappedReceipt | null]>>;\r\n\r\nexport type CachedReceiptStructure = {\r\n    eventId: string;\r\n    receiptType: string | ReceiptType;\r\n    userId: string;\r\n    receipt: Receipt;\r\n    synthetic: boolean;\r\n};\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,WAAYA,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAMvB,OAAO,IAAMC,kBAAkB,GAAG,MAAM;;AA4BxC;AACA","ignoreList":[]}

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

@@ -0,0 +1,85 @@
+import { type AuthDict } from "../interactive-auth.ts";
+/**
+ * The request body of a call to `POST /_matrix/client/v3/register`.
+ *
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register
+ */
+export interface RegisterRequest {
+    /**
+     * Additional authentication information for the user-interactive authentication API.
+     * Note that this information is not used to define how the registered user should be authenticated,
+     * but is instead used to authenticate the register call itself.
+     */
+    auth?: AuthDict;
+    /**
+     * The basis for the localpart of the desired Matrix ID.
+     * If omitted, the homeserver MUST generate a Matrix ID local part.
+     */
+    username?: string;
+    /**
+     * The desired password for the account.
+     */
+    password?: string;
+    /**
+     * If true, the client supports refresh tokens.
+     */
+    refresh_token?: boolean;
+    /**
+     * If true, an access_token and device_id should not be returned from this call, therefore preventing an automatic login.
+     * Defaults to false.
+     */
+    inhibit_login?: boolean;
+    /**
+     * A display name to assign to the newly-created device.
+     * Ignored if device_id corresponds to a known device.
+     */
+    initial_device_display_name?: string;
+    /**
+     * Guest users can also upgrade their account by going through the ordinary register flow,
+     * but specifying the additional POST parameter guest_access_token containing the guest’s access token.
+     * They are also required to specify the username parameter to the value of the local part of their username,
+     * which is otherwise optional.
+     * @see https://spec.matrix.org/v1.10/client-server-api/#guest-access
+     */
+    guest_access_token?: string;
+}
+/**
+ * The result of a successful call to `POST /_matrix/client/v3/register`.
+ *
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register
+ */
+export interface RegisterResponse {
+    /**
+     * The fully-qualified Matrix user ID (MXID) that has been registered.
+     */
+    user_id: string;
+    /**
+     * An access token for the account.
+     * This access token can then be used to authorize other requests.
+     * Required if the inhibit_login option is false.
+     */
+    access_token?: string;
+    /**
+     * ID of the registered device.
+     * Will be the same as the corresponding parameter in the request, if one was specified.
+     * Required if the inhibit_login option is false.
+     */
+    device_id?: string;
+    /**
+     * The lifetime of the access token, in milliseconds.
+     * Once the access token has expired a new access token can be obtained by using the provided refresh token.
+     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.
+     * If not given, the client can assume that the access token will not expire.
+     *
+     * Omitted if the inhibit_login option is true.
+     */
+    expires_in_ms?: number;
+    /**
+     * A refresh token for the account.
+     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.
+     *
+     * Omitted if the inhibit_login option is true.
+     */
+    refresh_token?: string;
+}
+//# sourceMappingURL=registration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../../src/@types/registration.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}

package/lib/@types/registration.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"registration.js","names":[],"sources":["../../src/@types/registration.ts"],"sourcesContent":["/*\r\nCopyright 2023 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 AuthDict } from \"../interactive-auth.ts\";\r\n\r\n/**\r\n * The request body of a call to `POST /_matrix/client/v3/register`.\r\n *\r\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register\r\n */\r\nexport interface RegisterRequest {\r\n    /**\r\n     * Additional authentication information for the user-interactive authentication API.\r\n     * Note that this information is not used to define how the registered user should be authenticated,\r\n     * but is instead used to authenticate the register call itself.\r\n     */\r\n    auth?: AuthDict;\r\n    /**\r\n     * The basis for the localpart of the desired Matrix ID.\r\n     * If omitted, the homeserver MUST generate a Matrix ID local part.\r\n     */\r\n    username?: string;\r\n    /**\r\n     * The desired password for the account.\r\n     */\r\n    password?: string;\r\n    /**\r\n     * If true, the client supports refresh tokens.\r\n     */\r\n    refresh_token?: boolean;\r\n    /**\r\n     * If true, an access_token and device_id should not be returned from this call, therefore preventing an automatic login.\r\n     * Defaults to false.\r\n     */\r\n    inhibit_login?: boolean;\r\n    /**\r\n     * A display name to assign to the newly-created device.\r\n     * Ignored if device_id corresponds to a known device.\r\n     */\r\n    initial_device_display_name?: string;\r\n    /**\r\n     * Guest users can also upgrade their account by going through the ordinary register flow,\r\n     * but specifying the additional POST parameter guest_access_token containing the guest’s access token.\r\n     * They are also required to specify the username parameter to the value of the local part of their username,\r\n     * which is otherwise optional.\r\n     * @see https://spec.matrix.org/v1.10/client-server-api/#guest-access\r\n     */\r\n    guest_access_token?: string;\r\n}\r\n\r\n/**\r\n * The result of a successful call to `POST /_matrix/client/v3/register`.\r\n *\r\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register\r\n */\r\nexport interface RegisterResponse {\r\n    /**\r\n     * The fully-qualified Matrix user ID (MXID) that has been registered.\r\n     */\r\n    user_id: string;\r\n    /**\r\n     * An access token for the account.\r\n     * This access token can then be used to authorize other requests.\r\n     * Required if the inhibit_login option is false.\r\n     */\r\n    access_token?: string;\r\n    /**\r\n     * ID of the registered device.\r\n     * Will be the same as the corresponding parameter in the request, if one was specified.\r\n     * Required if the inhibit_login option is false.\r\n     */\r\n    device_id?: string;\r\n    /**\r\n     * The lifetime of the access token, in milliseconds.\r\n     * Once the access token has expired a new access token can be obtained by using the provided refresh token.\r\n     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.\r\n     * If not given, the client can assume that the access token will not expire.\r\n     *\r\n     * Omitted if the inhibit_login option is true.\r\n     */\r\n    expires_in_ms?: number;\r\n    /**\r\n     * A refresh token for the account.\r\n     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.\r\n     *\r\n     * Omitted if the inhibit_login option is true.\r\n     */\r\n    refresh_token?: string;\r\n}\r\n"],"mappings":"","ignoreList":[]}

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

@@ -0,0 +1,267 @@
+import { type IContent, type IEvent } from "../models/event.ts";
+import { type Preset, type Visibility } from "./partials.ts";
+import { type IEventWithRoomId, type SearchKey } from "./search.ts";
+import { type IRoomEventFilter } from "../filter.ts";
+import { type Direction } from "../models/event-timeline.ts";
+import { type PushRuleAction } from "./PushRules.ts";
+import { type BriijError } from "../http-api/errors.ts";
+import { type IRoomEvent } from "../sync-accumulator.ts";
+import { type EventType, type RelationType, type RoomType } from "./event.ts";
+export interface IJoinRoomOpts {
+    /**
+     * If the caller has a keypair 3pid invite, the signing URL is passed in this parameter.
+     */
+    inviteSignUrl?: string;
+    /**
+     * The server names to try and join through in addition to those that are automatically chosen.
+     * Only the first 3 are actually used in the request, to avoid HTTP 414 Request-URI Too Long responses.
+     */
+    viaServers?: string[];
+    /**
+     * When accepting an invite, whether to accept encrypted history shared by the inviter via the experimental
+     * support for [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268).
+     *
+     * @experimental
+     */
+    acceptSharedHistory?: boolean;
+}
+/** Options object for {@link BriijClient.invite}. */
+export interface InviteOpts {
+    /**
+     * The reason for the invite.
+     */
+    reason?: string;
+    /**
+     * Before sending the invite, if the room is encrypted, share the keys for any messages sent while the history
+     * visibility was `shared`, via the experimental
+     * support for [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268).
+     *
+     * @experimental
+     */
+    shareEncryptedHistory?: boolean;
+}
+export interface KnockRoomOpts {
+    /**
+     * The reason for the knock.
+     */
+    reason?: string;
+    /**
+     * The server names to try and knock through in addition to those that are automatically chosen.
+     * Only the first 3 are actually used in the request, to avoid HTTP 414 Request-URI Too Long responses.
+     */
+    viaServers?: string | string[];
+}
+export interface IRedactOpts {
+    reason?: string;
+    /**
+     * If specified, then any events which relate to the event being redacted with
+     * any of the relationship types listed will also be redacted.
+     * Provide a "*" list item to tell the server to redact relations of any type.
+     *
+     * <b>Raises an Error if the server does not support it.</b>
+     * Check for server-side support before using this param with
+     * <code>client.canSupport.get(Feature.RelationBasedRedactions)</code>.
+     * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/3912}
+     */
+    with_rel_types?: Array<RelationType | "*">;
+}
+export interface ISendEventResponse {
+    event_id: string;
+}
+export type SendDelayedEventRequestOpts = {
+    parent_delay_id: string;
+} | {
+    delay: number;
+    parent_delay_id?: string;
+};
+export declare function isSendDelayedEventRequestOpts(opts: object): opts is SendDelayedEventRequestOpts;
+export type SendDelayedEventResponse = {
+    delay_id: string;
+};
+export declare enum UpdateDelayedEventAction {
+    Cancel = "cancel",
+    Restart = "restart",
+    Send = "send"
+}
+export type UpdateDelayedEventRequestOpts = SendDelayedEventResponse & {
+    action: UpdateDelayedEventAction;
+};
+type DelayedPartialTimelineEvent = {
+    room_id: string;
+    type: string;
+    content: IContent;
+};
+type DelayedPartialStateEvent = DelayedPartialTimelineEvent & {
+    state_key: string;
+};
+type DelayedPartialEvent = DelayedPartialTimelineEvent | DelayedPartialStateEvent;
+export type DelayedEventInfoItem = DelayedPartialEvent & SendDelayedEventResponse & SendDelayedEventRequestOpts & {
+    running_since: number;
+};
+export type DelayedEventInfo = {
+    scheduled?: DelayedEventInfoItem[];
+    finalised?: {
+        delayed_event: DelayedEventInfoItem;
+        outcome: "send" | "cancel";
+        reason: "error" | "action" | "delay";
+        error?: BriijError["data"];
+        event_id?: string;
+        origin_server_ts?: number;
+    }[];
+    next_batch?: string;
+};
+export interface IPresenceOpts {
+    presence: "online" | "offline" | "unavailable";
+    status_msg?: string;
+}
+export interface IPaginateOpts {
+    backwards?: boolean;
+    limit?: number;
+}
+export interface IGuestAccessOpts {
+    /**
+     * True to allow guests to join this room. This
+     * implicitly gives guests write access. If false or not given, guests are
+     * explicitly forbidden from joining the room.
+     */
+    allowJoin: boolean;
+    /**
+     * True to set history visibility to
+     * be world_readable. This gives guests read access *from this point forward*.
+     * If false or not given, history visibility is not modified.
+     */
+    allowRead: boolean;
+}
+export interface ISearchOpts {
+    keys?: SearchKey[];
+    query: string;
+}
+export interface IEventSearchOpts {
+    filter?: IRoomEventFilter;
+    term: string;
+}
+export interface IInvite3PID {
+    id_server: string;
+    id_access_token?: string;
+    medium: string;
+    address: string;
+}
+export interface ICreateRoomStateEvent {
+    type: string;
+    state_key?: string;
+    content: IContent;
+}
+export interface ICreateRoomOpts {
+    room_alias_name?: string;
+    visibility?: Visibility;
+    name?: string;
+    topic?: string;
+    preset?: Preset;
+    power_level_content_override?: {
+        ban?: number;
+        events?: Record<EventType | string, number>;
+        events_default?: number;
+        invite?: number;
+        kick?: number;
+        notifications?: Record<string, number>;
+        redact?: number;
+        state_default?: number;
+        users?: Record<string, number>;
+        users_default?: number;
+    };
+    creation_content?: object;
+    initial_state?: ICreateRoomStateEvent[];
+    invite?: string[];
+    invite_3pid?: IInvite3PID[];
+    is_direct?: boolean;
+    room_version?: string;
+}
+export interface IRoomDirectoryOptions {
+    /**
+     * The remote server to query for the room list.
+     * Optional. If unspecified, get the local homeserver's public room list.
+     */
+    server?: string;
+    /**
+     * Maximum number of entries to return
+     */
+    limit?: number;
+    /**
+     * Token to paginate from
+     */
+    since?: string;
+    /** Filter parameters */
+    filter?: {
+        generic_search_term?: string;
+        room_types?: Array<RoomType | null>;
+    };
+    include_all_networks?: boolean;
+    third_party_instance_id?: string;
+}
+export interface IAddThreePidOnlyBody {
+    auth?: {
+        type: string;
+        session?: string;
+    };
+    client_secret: string;
+    sid: string;
+}
+export interface IBindThreePidBody {
+    client_secret: string;
+    id_server: string;
+    id_access_token: string | null;
+    sid: string;
+}
+export interface IRelationsRequestOpts {
+    from?: string;
+    to?: string;
+    limit?: number;
+    dir?: Direction;
+    recurse?: boolean;
+}
+export interface IRelationsResponse {
+    chunk: IEvent[];
+    next_batch?: string;
+    prev_batch?: string;
+}
+export interface IContextResponse {
+    end?: string;
+    start?: string;
+    state?: IEventWithRoomId[];
+    events_before?: IEventWithRoomId[];
+    events_after?: IEventWithRoomId[];
+    event?: IEventWithRoomId;
+}
+export interface IEventsResponse {
+    chunk: IEventWithRoomId[];
+    end: string;
+    start: string;
+}
+export interface INotification {
+    actions: PushRuleAction[];
+    event: IRoomEvent;
+    profile_tag?: string;
+    read: boolean;
+    room_id: string;
+    ts: number;
+}
+export interface INotificationsResponse {
+    next_token: string;
+    notifications: INotification[];
+}
+export interface IFilterResponse {
+    filter_id: string;
+}
+export interface ITagsResponse {
+    tags: {
+        [tagId: string]: {
+            order: number;
+        };
+    };
+}
+export interface IStatusResponse extends IPresenceOpts {
+    currently_active?: boolean;
+    last_active_ago?: number;
+}
+export {};
+//# sourceMappingURL=requests.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../src/@types/requests.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAK9E,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,qDAAqD;AACrD,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,WAAW;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,2BAA2B,GAAG;IAAE,eAAe,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,eAAe,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,2BAA2B,CAW/F;AACD,MAAM,MAAM,wBAAwB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,wBAAwB;IAChC,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;CAChB;AAED,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,GAAG;IACnE,MAAM,EAAE,wBAAwB,CAAC;CACpC,CAAC;AAEF,KAAK,2BAA2B,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,KAAK,wBAAwB,GAAG,2BAA2B,GAAG;IAC1D,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,GAAG,2BAA2B,GAAG,wBAAwB,CAAC;AAElF,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAClD,wBAAwB,GACxB,2BAA2B,GAAG;IAC1B,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AAEN,MAAM,MAAM,gBAAgB,GAAG;IAC3B,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC,SAAS,CAAC,EAAE;QACR,aAAa,EAAE,oBAAoB,CAAC;QACpC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC;QAC3B,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;QACrC,KAAK,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC7B,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,aAAa;IAE1B,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;IAE/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAE1B,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAE7B,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAE5B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B,CAAC,EAAE;QAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5C,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAExC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,wBAAwB;IACxB,MAAM,CAAC,EAAE;QAEL,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;KACvC,CAAC;IACF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,CAAC,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAElB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACnC,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,KAAK,EAAE,UAAU,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,aAAa,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE;QACF,CAAC,KAAK,EAAE,MAAM,GAAG;YACb,KAAK,EAAE,MAAM,CAAC;SACjB,CAAC;KACL,CAAC;CACL;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/lib/@types/requests.js

@@ -0,0 +1,42 @@
+/*
+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.
+*/
+
+// allow camelcase as these are things that go onto the wire
+/* eslint-disable camelcase */
+
+/** Options object for {@link BriijClient.invite}. */
+
+export function isSendDelayedEventRequestOpts(opts) {
+  if ("parent_delay_id" in opts && typeof opts.parent_delay_id !== "string") {
+    // Invalid type, reject
+    return false;
+  }
+  if ("delay" in opts && typeof opts.delay !== "number") {
+    // Invalid type, reject.
+    return true;
+  }
+  // At least one of these fields must be specified.
+  return "delay" in opts || "parent_delay_id" in opts;
+}
+export var UpdateDelayedEventAction = /*#__PURE__*/function (UpdateDelayedEventAction) {
+  UpdateDelayedEventAction["Cancel"] = "cancel";
+  UpdateDelayedEventAction["Restart"] = "restart";
+  UpdateDelayedEventAction["Send"] = "send";
+  return UpdateDelayedEventAction;
+}({});
+
+/* eslint-enable camelcase */
+//# sourceMappingURL=requests.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","names":["isSendDelayedEventRequestOpts","opts","parent_delay_id","delay","UpdateDelayedEventAction"],"sources":["../../src/@types/requests.ts"],"sourcesContent":["/*\nCopyright 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 { type IContent, type IEvent } from \"../models/event.ts\";\nimport { type Preset, type Visibility } from \"./partials.ts\";\nimport { type IEventWithRoomId, type SearchKey } from \"./search.ts\";\nimport { type IRoomEventFilter } from \"../filter.ts\";\nimport { type Direction } from \"../models/event-timeline.ts\";\nimport { type PushRuleAction } from \"./PushRules.ts\";\nimport { type BriijError } from \"../http-api/errors.ts\";\nimport { type IRoomEvent } from \"../sync-accumulator.ts\";\nimport { type EventType, type RelationType, type RoomType } from \"./event.ts\";\n\n// allow camelcase as these are things that go onto the wire\n/* eslint-disable camelcase */\n\nexport interface IJoinRoomOpts {\n    /**\n     * If the caller has a keypair 3pid invite, the signing URL is passed in this parameter.\n     */\n    inviteSignUrl?: string;\n\n    /**\n     * The server names to try and join through in addition to those that are automatically chosen.\n     * Only the first 3 are actually used in the request, to avoid HTTP 414 Request-URI Too Long responses.\n     */\n    viaServers?: string[];\n\n    /**\n     * When accepting an invite, whether to accept encrypted history shared by the inviter via the experimental\n     * support for [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268).\n     *\n     * @experimental\n     */\n    acceptSharedHistory?: boolean;\n}\n\n/** Options object for {@link BriijClient.invite}. */\nexport interface InviteOpts {\n    /**\n     * The reason for the invite.\n     */\n    reason?: string;\n\n    /**\n     * Before sending the invite, if the room is encrypted, share the keys for any messages sent while the history\n     * visibility was `shared`, via the experimental\n     * support for [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268).\n     *\n     * @experimental\n     */\n    shareEncryptedHistory?: boolean;\n}\n\nexport interface KnockRoomOpts {\n    /**\n     * The reason for the knock.\n     */\n    reason?: string;\n\n    /**\n     * The server names to try and knock through in addition to those that are automatically chosen.\n     * Only the first 3 are actually used in the request, to avoid HTTP 414 Request-URI Too Long responses.\n     */\n    viaServers?: string | string[];\n}\n\nexport interface IRedactOpts {\n    reason?: string;\n    /**\n     * If specified, then any events which relate to the event being redacted with\n     * any of the relationship types listed will also be redacted.\n     * Provide a \"*\" list item to tell the server to redact relations of any type.\n     *\n     * <b>Raises an Error if the server does not support it.</b>\n     * Check for server-side support before using this param with\n     * <code>client.canSupport.get(Feature.RelationBasedRedactions)</code>.\n     * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/3912}\n     */\n    with_rel_types?: Array<RelationType | \"*\">;\n}\n\nexport interface ISendEventResponse {\n    event_id: string;\n}\n\nexport type SendDelayedEventRequestOpts = { parent_delay_id: string } | { delay: number; parent_delay_id?: string };\n\nexport function isSendDelayedEventRequestOpts(opts: object): opts is SendDelayedEventRequestOpts {\n    if (\"parent_delay_id\" in opts && typeof opts.parent_delay_id !== \"string\") {\n        // Invalid type, reject\n        return false;\n    }\n    if (\"delay\" in opts && typeof opts.delay !== \"number\") {\n        // Invalid type, reject.\n        return true;\n    }\n    // At least one of these fields must be specified.\n    return \"delay\" in opts || \"parent_delay_id\" in opts;\n}\nexport type SendDelayedEventResponse = {\n    delay_id: string;\n};\n\nexport enum UpdateDelayedEventAction {\n    Cancel = \"cancel\",\n    Restart = \"restart\",\n    Send = \"send\",\n}\n\nexport type UpdateDelayedEventRequestOpts = SendDelayedEventResponse & {\n    action: UpdateDelayedEventAction;\n};\n\ntype DelayedPartialTimelineEvent = {\n    room_id: string;\n    type: string;\n    content: IContent;\n};\n\ntype DelayedPartialStateEvent = DelayedPartialTimelineEvent & {\n    state_key: string;\n};\n\ntype DelayedPartialEvent = DelayedPartialTimelineEvent | DelayedPartialStateEvent;\n\nexport type DelayedEventInfoItem = DelayedPartialEvent &\n    SendDelayedEventResponse &\n    SendDelayedEventRequestOpts & {\n        running_since: number;\n    };\n\nexport type DelayedEventInfo = {\n    scheduled?: DelayedEventInfoItem[];\n    finalised?: {\n        delayed_event: DelayedEventInfoItem;\n        outcome: \"send\" | \"cancel\";\n        reason: \"error\" | \"action\" | \"delay\";\n        error?: BriijError[\"data\"];\n        event_id?: string;\n        origin_server_ts?: number;\n    }[];\n    next_batch?: string;\n};\n\nexport interface IPresenceOpts {\n    // One of \"online\", \"offline\" or \"unavailable\"\n    presence: \"online\" | \"offline\" | \"unavailable\";\n    // The status message to attach.\n    status_msg?: string;\n}\n\nexport interface IPaginateOpts {\n    // true to fill backwards, false to go forwards\n    backwards?: boolean;\n    // number of events to request\n    limit?: number;\n}\n\nexport interface IGuestAccessOpts {\n    /**\n     * True to allow guests to join this room. This\n     * implicitly gives guests write access. If false or not given, guests are\n     * explicitly forbidden from joining the room.\n     */\n    allowJoin: boolean;\n    /**\n     * True to set history visibility to\n     * be world_readable. This gives guests read access *from this point forward*.\n     * If false or not given, history visibility is not modified.\n     */\n    allowRead: boolean;\n}\n\nexport interface ISearchOpts {\n    keys?: SearchKey[];\n    query: string;\n}\n\nexport interface IEventSearchOpts {\n    // a JSON filter object to pass in the request\n    filter?: IRoomEventFilter;\n    // the term to search for\n    term: string;\n}\n\nexport interface IInvite3PID {\n    id_server: string;\n    id_access_token?: string; // this gets injected by the js-sdk\n    medium: string;\n    address: string;\n}\n\nexport interface ICreateRoomStateEvent {\n    type: string;\n    state_key?: string; // defaults to an empty string\n    content: IContent;\n}\n\nexport interface ICreateRoomOpts {\n    // The alias localpart to assign to this room.\n    room_alias_name?: string;\n    // Either 'public' or 'private'.\n    visibility?: Visibility;\n    // The name to give this room.\n    name?: string;\n    // The topic to give this room.\n    topic?: string;\n    preset?: Preset;\n    power_level_content_override?: {\n        ban?: number;\n        events?: Record<EventType | string, number>;\n        events_default?: number;\n        invite?: number;\n        kick?: number;\n        notifications?: Record<string, number>;\n        redact?: number;\n        state_default?: number;\n        users?: Record<string, number>;\n        users_default?: number;\n    };\n    creation_content?: object;\n    initial_state?: ICreateRoomStateEvent[];\n    // A list of user IDs to invite to this room.\n    invite?: string[];\n    invite_3pid?: IInvite3PID[];\n    is_direct?: boolean;\n    room_version?: string;\n}\n\nexport interface IRoomDirectoryOptions {\n    /**\n     * The remote server to query for the room list.\n     * Optional. If unspecified, get the local homeserver's public room list.\n     */\n    server?: string;\n    /**\n     * Maximum number of entries to return\n     */\n    limit?: number;\n    /**\n     * Token to paginate from\n     */\n    since?: string;\n\n    /** Filter parameters */\n    filter?: {\n        // String to search for\n        generic_search_term?: string;\n        room_types?: Array<RoomType | null>;\n    };\n    include_all_networks?: boolean;\n    third_party_instance_id?: string;\n}\n\nexport interface IAddThreePidOnlyBody {\n    auth?: {\n        type: string;\n        session?: string;\n    };\n    client_secret: string;\n    sid: string;\n}\n\nexport interface IBindThreePidBody {\n    client_secret: string;\n    id_server: string;\n    // Some older identity servers have no auth enabled\n    id_access_token: string | null;\n    sid: string;\n}\n\nexport interface IRelationsRequestOpts {\n    from?: string;\n    to?: string;\n    limit?: number;\n    dir?: Direction;\n    recurse?: boolean; // MSC3981 Relations Recursion https://github.com/matrix-org/matrix-spec-proposals/pull/3981\n}\n\nexport interface IRelationsResponse {\n    chunk: IEvent[];\n    next_batch?: string;\n    prev_batch?: string;\n}\n\nexport interface IContextResponse {\n    end?: string;\n    start?: string;\n    state?: IEventWithRoomId[];\n    events_before?: IEventWithRoomId[];\n    events_after?: IEventWithRoomId[];\n    event?: IEventWithRoomId;\n}\n\nexport interface IEventsResponse {\n    chunk: IEventWithRoomId[];\n    end: string;\n    start: string;\n}\n\nexport interface INotification {\n    actions: PushRuleAction[];\n    event: IRoomEvent;\n    profile_tag?: string;\n    read: boolean;\n    room_id: string;\n    ts: number;\n}\n\nexport interface INotificationsResponse {\n    next_token: string;\n    notifications: INotification[];\n}\n\nexport interface IFilterResponse {\n    filter_id: string;\n}\n\nexport interface ITagsResponse {\n    tags: {\n        [tagId: string]: {\n            order: number;\n        };\n    };\n}\n\nexport interface IStatusResponse extends IPresenceOpts {\n    currently_active?: boolean;\n    last_active_ago?: number;\n}\n\n/* eslint-enable camelcase */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;;AAuBA;;AAmDA,OAAO,SAASA,6BAA6BA,CAACC,IAAY,EAAuC;EAC7F,IAAI,iBAAiB,IAAIA,IAAI,IAAI,OAAOA,IAAI,CAACC,eAAe,KAAK,QAAQ,EAAE;IACvE;IACA,OAAO,KAAK;EAChB;EACA,IAAI,OAAO,IAAID,IAAI,IAAI,OAAOA,IAAI,CAACE,KAAK,KAAK,QAAQ,EAAE;IACnD;IACA,OAAO,IAAI;EACf;EACA;EACA,OAAO,OAAO,IAAIF,IAAI,IAAI,iBAAiB,IAAIA,IAAI;AACvD;AAKA,WAAYG,wBAAwB,0BAAxBA,wBAAwB;EAAxBA,wBAAwB;EAAxBA,wBAAwB;EAAxBA,wBAAwB;EAAA,OAAxBA,wBAAwB;AAAA;;AAoOpC","ignoreList":[]}