@textrp/briij-js-sdk 41.0.1 → 42.0.0

package/src/@types/registration.ts

@@ -1,102 +1,102 @@
-/*
-Copyright 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 { 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;
-}
+/*
+Copyright 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 { 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;
+}

package/src/@types/search.ts

@@ -1,119 +1,119 @@
-/*
-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.
-*/
-
-// Types relating to the /search API
-
-import { type IRoomEvent, type IStateEvent } from "../sync-accumulator.ts";
-import { type IRoomEventFilter } from "../filter.ts";
-import { type SearchResult } from "../models/search-result.ts";
-
-/* eslint-disable camelcase */
-export interface IEventWithRoomId extends IRoomEvent {
-    room_id: string;
-}
-
-export interface IStateEventWithRoomId extends IStateEvent {
-    room_id: string;
-}
-
-export interface IMatrixProfile {
-    avatar_url?: string;
-    displayname?: string;
-}
-
-export interface IResultContext {
-    events_before: IEventWithRoomId[];
-    events_after: IEventWithRoomId[];
-    profile_info: Record<string, IMatrixProfile>;
-    start?: string;
-    end?: string;
-}
-
-export interface ISearchResult {
-    rank: number;
-    result: IEventWithRoomId;
-    context: IResultContext;
-}
-
-enum GroupKey {
-    RoomId = "room_id",
-    Sender = "sender",
-}
-
-export interface IResultRoomEvents {
-    count?: number;
-    highlights?: string[];
-    results?: ISearchResult[];
-    state?: { [roomId: string]: IStateEventWithRoomId[] };
-    groups?: {
-        [groupKey in GroupKey]: {
-            [value: string]: {
-                next_batch?: string;
-                order: number;
-                results: string[];
-            };
-        };
-    };
-    next_batch?: string;
-}
-
-interface IResultCategories {
-    room_events: IResultRoomEvents;
-}
-
-export type SearchKey = "content.body" | "content.name" | "content.topic";
-
-export enum SearchOrderBy {
-    Recent = "recent",
-    Rank = "rank",
-}
-
-export interface ISearchRequestBody {
-    search_categories: {
-        room_events: {
-            search_term: string;
-            keys?: SearchKey[];
-            filter?: IRoomEventFilter;
-            order_by?: SearchOrderBy;
-            event_context?: {
-                before_limit?: number;
-                after_limit?: number;
-                include_profile?: boolean;
-            };
-            include_state?: boolean;
-            groupings?: {
-                group_by: {
-                    key: GroupKey;
-                }[];
-            };
-        };
-    };
-}
-
-export interface ISearchResponse {
-    search_categories: IResultCategories;
-}
-
-export interface ISearchResults {
-    _query?: ISearchRequestBody;
-    results: SearchResult[];
-    highlights: string[];
-    count?: number;
-    next_batch?: string;
-    pendingRequest?: Promise<ISearchResults>;
-    abortSignal?: AbortSignal;
-}
-/* eslint-enable camelcase */
+/*
+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.
+*/
+
+// Types relating to the /search API
+
+import { type IRoomEvent, type IStateEvent } from "../sync-accumulator.ts";
+import { type IRoomEventFilter } from "../filter.ts";
+import { type SearchResult } from "../models/search-result.ts";
+
+/* eslint-disable camelcase */
+export interface IEventWithRoomId extends IRoomEvent {
+    room_id: string;
+}
+
+export interface IStateEventWithRoomId extends IStateEvent {
+    room_id: string;
+}
+
+export interface IMatrixProfile {
+    avatar_url?: string;
+    displayname?: string;
+}
+
+export interface IResultContext {
+    events_before: IEventWithRoomId[];
+    events_after: IEventWithRoomId[];
+    profile_info: Record<string, IMatrixProfile>;
+    start?: string;
+    end?: string;
+}
+
+export interface ISearchResult {
+    rank: number;
+    result: IEventWithRoomId;
+    context: IResultContext;
+}
+
+enum GroupKey {
+    RoomId = "room_id",
+    Sender = "sender",
+}
+
+export interface IResultRoomEvents {
+    count?: number;
+    highlights?: string[];
+    results?: ISearchResult[];
+    state?: { [roomId: string]: IStateEventWithRoomId[] };
+    groups?: {
+        [groupKey in GroupKey]: {
+            [value: string]: {
+                next_batch?: string;
+                order: number;
+                results: string[];
+            };
+        };
+    };
+    next_batch?: string;
+}
+
+interface IResultCategories {
+    room_events: IResultRoomEvents;
+}
+
+export type SearchKey = "content.body" | "content.name" | "content.topic";
+
+export enum SearchOrderBy {
+    Recent = "recent",
+    Rank = "rank",
+}
+
+export interface ISearchRequestBody {
+    search_categories: {
+        room_events: {
+            search_term: string;
+            keys?: SearchKey[];
+            filter?: IRoomEventFilter;
+            order_by?: SearchOrderBy;
+            event_context?: {
+                before_limit?: number;
+                after_limit?: number;
+                include_profile?: boolean;
+            };
+            include_state?: boolean;
+            groupings?: {
+                group_by: {
+                    key: GroupKey;
+                }[];
+            };
+        };
+    };
+}
+
+export interface ISearchResponse {
+    search_categories: IResultCategories;
+}
+
+export interface ISearchResults {
+    _query?: ISearchRequestBody;
+    results: SearchResult[];
+    highlights: string[];
+    count?: number;
+    next_batch?: string;
+    pendingRequest?: Promise<ISearchResults>;
+    abortSignal?: AbortSignal;
+}
+/* eslint-enable camelcase */

package/src/@types/signed.ts

@@ -1,25 +1,25 @@
-/*
-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 interface ISignatures {
-    [entity: string]: {
-        [keyId: string]: string;
-    };
-}
-
-export interface ISigned {
-    signatures?: ISignatures;
-}
+/*
+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 interface ISignatures {
+    [entity: string]: {
+        [keyId: string]: string;
+    };
+}
+
+export interface ISigned {
+    signatures?: ISignatures;
+}

package/src/@types/spaces.ts

@@ -1,37 +1,37 @@
-/*
-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.
-*/
-
-import { type IPublicRoomsChunkRoom } from "../client.ts";
-import { type RoomType } from "./event.ts";
-import { type IStrippedState } from "../sync-accumulator.ts";
-
-// Types relating to Rooms of type `m.space` and related APIs
-
-/* eslint-disable camelcase */
-export interface IHierarchyRelation extends IStrippedState {
-    origin_server_ts: number;
-    content: {
-        order?: string;
-        suggested?: boolean;
-        via?: string[];
-    };
-}
-
-export interface IHierarchyRoom extends IPublicRoomsChunkRoom {
-    room_type?: RoomType | string;
-    children_state: IHierarchyRelation[];
-}
-/* eslint-enable camelcase */
+/*
+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.
+*/
+
+import { type IPublicRoomsChunkRoom } from "../client.ts";
+import { type RoomType } from "./event.ts";
+import { type IStrippedState } from "../sync-accumulator.ts";
+
+// Types relating to Rooms of type `m.space` and related APIs
+
+/* eslint-disable camelcase */
+export interface IHierarchyRelation extends IStrippedState {
+    origin_server_ts: number;
+    content: {
+        order?: string;
+        suggested?: boolean;
+        via?: string[];
+    };
+}
+
+export interface IHierarchyRoom extends IPublicRoomsChunkRoom {
+    room_type?: RoomType | string;
+    children_state: IHierarchyRelation[];
+}
+/* eslint-enable camelcase */