@textrp/briij-js-sdk 41.0.0

package/lib/http-api/interface.d.ts

@@ -0,0 +1,186 @@
+import { type BriijError } from "./errors.ts";
+import { type Logger } from "../logger.ts";
+import { type QueryDict } from "../utils.ts";
+export type Body = Record<string, any> | BodyInit;
+/**
+ * @experimental
+ * Unencrypted access and (optional) refresh token
+ */
+export type AccessTokens = {
+    /**
+     * The new access token to use for authenticated requests
+     */
+    accessToken: string;
+    /**
+     * The new refresh token to use for refreshing tokens, optional
+     */
+    refreshToken?: string;
+    /**
+     * Approximate date when the access token will expire, optional
+     */
+    expiry?: Date;
+};
+/**
+ * @experimental
+ * Function that performs token refresh using the given refreshToken.
+ * Returns a promise that resolves to the refreshed access and (optional) refresh tokens.
+ *
+ * Can be passed to HttpApi instance as {@link IHttpOpts.tokenRefreshFunction} during client creation {@link ICreateClientOpts}
+ */
+export type TokenRefreshFunction = (refreshToken: string) => Promise<AccessTokens>;
+/** Options object for `FetchHttpApi` and {@link BriijHttpApi}. */
+export interface IHttpOpts {
+    fetchFn?: typeof globalThis.fetch;
+    baseUrl: string;
+    idBaseUrl?: string;
+    prefix: string;
+    extraParams?: QueryDict;
+    accessToken?: string;
+    /**
+     * Used in conjunction with tokenRefreshFunction to attempt token refresh
+     */
+    refreshToken?: string;
+    /**
+     * Function to attempt token refresh when a possibly expired token is encountered
+     * Optional, only called when a refreshToken is present
+     */
+    tokenRefreshFunction?: TokenRefreshFunction;
+    /**
+     * Whether to use the HTTP Authorization header over the `access_token` query parameter
+     * @deprecated as of v1.11 in https://spec.matrix.org/v1.17/client-server-api/#using-access-tokens
+     */
+    useAuthorizationHeader?: boolean;
+    /** For historical reasons, must be set to `true`. Will eventually be removed. */
+    onlyData?: boolean;
+    localTimeoutMs?: number;
+    /** Optional logger instance. If provided, requests and responses will be logged. */
+    logger?: Logger;
+}
+/** Options object for `FetchHttpApi.requestOtherUrl`. */
+export interface BaseRequestOpts extends Pick<RequestInit, "priority"> {
+    /**
+     * map of additional request headers
+     */
+    headers?: Record<string, string>;
+    abortSignal?: AbortSignal;
+    /**
+     * The maximum amount of time to wait before
+     * timing out the request. If not specified, there is no timeout.
+     */
+    localTimeoutMs?: number;
+    keepAlive?: boolean;
+    /**
+     * By default, we will:
+     *
+     *  *  If the `body` is an object, JSON-encode it and set `Content-Type: application/json` in the
+     *     request headers (unless overridden by {@link headers}).
+     *
+     *  * Set `Accept: application/json` in the request headers (again, unless overridden by {@link headers}).
+     *
+     *  * Parse the response as JSON and return the parsed response.
+     *
+     * Setting this to `false` inhibits all three behaviors, and the response is instead parsed as a UTF-8 string. It
+     * defaults to `true`, unless {@link rawResponseBody} is set.
+     *
+     * @deprecated Instead of setting this to `false`, set {@link rawResponseBody} to `true`.
+     */
+    json?: boolean;
+    /**
+     * Setting this to `true` does two things:
+     *
+     *  * Inhibits the automatic addition of `Accept: application/json` in the request headers.
+     *
+     *  * Causes the raw response to be returned as a {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob}
+     *    instead of parsing it as JSON.
+     */
+    rawResponseBody?: boolean;
+}
+export interface IRequestOpts extends BaseRequestOpts {
+    /**
+     * The alternative base url to use.
+     * If not specified, uses this.opts.baseUrl
+     */
+    baseUrl?: string;
+    /**
+     * The full prefix to use e.g.
+     * "/_matrix/client/v2_alpha". If not specified, uses this.opts.prefix.
+     */
+    prefix?: string;
+    inhibitLogoutEmit?: boolean;
+}
+export interface IContentUri {
+    base: string;
+    path: string;
+    params: {
+        access_token: string;
+    };
+}
+export declare enum HttpApiEvent {
+    SessionLoggedOut = "Session.logged_out",
+    NoConsent = "no_consent"
+}
+export type HttpApiEventHandlerMap = {
+    /**
+     * Fires whenever the login session the JS SDK is using is no
+     * longer valid and the user must log in again.
+     * NB. This only fires when action is required from the user, not
+     * when then login session can be renewed by using a refresh token.
+     * @example
+     * ```
+     * matrixClient.on("Session.logged_out", function(errorObj){
+     *   // show the login screen
+     * });
+     * ```
+     */
+    [HttpApiEvent.SessionLoggedOut]: (err: BriijError) => void;
+    /**
+     * Fires when the JS SDK receives a M_CONSENT_NOT_GIVEN error in response
+     * to a HTTP request.
+     * @example
+     * ```
+     * matrixClient.on("no_consent", function(message, contentUri) {
+     *     console.info(message + ' Go to ' + contentUri);
+     * });
+     * ```
+     */
+    [HttpApiEvent.NoConsent]: (message: string, consentUri: string) => void;
+};
+export interface UploadProgress {
+    loaded: number;
+    total: number;
+}
+export interface UploadOpts {
+    /**
+     * Name to give the file on the server. Defaults to <tt>file.name</tt>.
+     */
+    name?: string;
+    /**
+     * Content-type for the upload. Defaults to
+     *   <tt>file.type</tt>, or <tt>applicaton/octet-stream</tt>.
+     */
+    type?: string;
+    /**
+     * if false will not send the filename,
+     *   e.g for encrypted file uploads where filename leaks are undesirable.
+     *   Defaults to true.
+     */
+    includeFilename?: boolean;
+    /**
+     * Optional. Called when a chunk of
+     *    data has been uploaded, with an object containing the fields `loaded`
+     *    (number of bytes transferred) and `total` (total size, if known).
+     */
+    progressHandler?(progress: UploadProgress): void;
+    abortController?: AbortController;
+}
+export interface Upload {
+    loaded: number;
+    total: number;
+    promise: Promise<UploadResponse>;
+    abortController: AbortController;
+}
+export interface UploadResponse {
+    content_uri: string;
+}
+export type FileType = XMLHttpRequestBodyInit;
+//# sourceMappingURL=interface.d.ts.map

package/lib/http-api/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/http-api/interface.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;AAEnF,kEAAkE;AAClE,MAAM,WAAW,SAAS;IACtB,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAElC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,oFAAoF;IACpF,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yDAAyD;AACzD,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;IAClE;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,YAAa,SAAQ,eAAe;IACjD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QAEJ,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC;CACL;AAED,oBAAY,YAAY;IACpB,gBAAgB,uBAAuB;IACvC,SAAS,eAAe;CAC3B;AAED,MAAM,MAAM,sBAAsB,GAAG;IACjC;;;;;;;;;;;OAWG;IACH,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAC;IAC3D;;;;;;;;;OASG;IACH,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3E,CAAC;AAEF,MAAM,WAAW,cAAc;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,eAAe,CAAC,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC;AAED,MAAM,WAAW,MAAM;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IACjC,eAAe,EAAE,eAAe,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAE3B,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,QAAQ,GAAG,sBAAsB,CAAC"}

package/lib/http-api/interface.js

@@ -0,0 +1,39 @@
+/*
+Copyright 2022 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.
+*/
+
+/**
+ * @experimental
+ * Unencrypted access and (optional) refresh token
+ */
+
+/**
+ * @experimental
+ * Function that performs token refresh using the given refreshToken.
+ * Returns a promise that resolves to the refreshed access and (optional) refresh tokens.
+ *
+ * Can be passed to HttpApi instance as {@link IHttpOpts.tokenRefreshFunction} during client creation {@link ICreateClientOpts}
+ */
+
+/** Options object for `FetchHttpApi` and {@link BriijHttpApi}. */
+
+/** Options object for `FetchHttpApi.requestOtherUrl`. */
+
+export var HttpApiEvent = /*#__PURE__*/function (HttpApiEvent) {
+  HttpApiEvent["SessionLoggedOut"] = "Session.logged_out";
+  HttpApiEvent["NoConsent"] = "no_consent";
+  return HttpApiEvent;
+}({});
+//# sourceMappingURL=interface.js.map

package/lib/http-api/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","names":["HttpApiEvent"],"sources":["../../src/http-api/interface.ts"],"sourcesContent":["/*\nCopyright 2022 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 BriijError } from \"./errors.ts\";\nimport { type Logger } from \"../logger.ts\";\nimport { type QueryDict } from \"../utils.ts\";\n\nexport type Body = Record<string, any> | BodyInit;\n\n/**\n * @experimental\n * Unencrypted access and (optional) refresh token\n */\nexport type AccessTokens = {\n    /**\n     * The new access token to use for authenticated requests\n     */\n    accessToken: string;\n    /**\n     * The new refresh token to use for refreshing tokens, optional\n     */\n    refreshToken?: string;\n    /**\n     * Approximate date when the access token will expire, optional\n     */\n    expiry?: Date;\n};\n\n/**\n * @experimental\n * Function that performs token refresh using the given refreshToken.\n * Returns a promise that resolves to the refreshed access and (optional) refresh tokens.\n *\n * Can be passed to HttpApi instance as {@link IHttpOpts.tokenRefreshFunction} during client creation {@link ICreateClientOpts}\n */\nexport type TokenRefreshFunction = (refreshToken: string) => Promise<AccessTokens>;\n\n/** Options object for `FetchHttpApi` and {@link BriijHttpApi}. */\nexport interface IHttpOpts {\n    fetchFn?: typeof globalThis.fetch;\n\n    baseUrl: string;\n    idBaseUrl?: string;\n    prefix: string;\n    extraParams?: QueryDict;\n\n    accessToken?: string;\n    /**\n     * Used in conjunction with tokenRefreshFunction to attempt token refresh\n     */\n    refreshToken?: string;\n    /**\n     * Function to attempt token refresh when a possibly expired token is encountered\n     * Optional, only called when a refreshToken is present\n     */\n    tokenRefreshFunction?: TokenRefreshFunction;\n\n    /**\n     * Whether to use the HTTP Authorization header over the `access_token` query parameter\n     * @deprecated as of v1.11 in https://spec.matrix.org/v1.17/client-server-api/#using-access-tokens\n     */\n    useAuthorizationHeader?: boolean; // defaults to true\n\n    /** For historical reasons, must be set to `true`. Will eventually be removed. */\n    onlyData?: boolean;\n\n    localTimeoutMs?: number;\n\n    /** Optional logger instance. If provided, requests and responses will be logged. */\n    logger?: Logger;\n}\n\n/** Options object for `FetchHttpApi.requestOtherUrl`. */\nexport interface BaseRequestOpts extends Pick<RequestInit, \"priority\"> {\n    /**\n     * map of additional request headers\n     */\n    headers?: Record<string, string>;\n    abortSignal?: AbortSignal;\n    /**\n     * The maximum amount of time to wait before\n     * timing out the request. If not specified, there is no timeout.\n     */\n    localTimeoutMs?: number;\n    keepAlive?: boolean; // defaults to false\n\n    /**\n     * By default, we will:\n     *\n     *  *  If the `body` is an object, JSON-encode it and set `Content-Type: application/json` in the\n     *     request headers (unless overridden by {@link headers}).\n     *\n     *  * Set `Accept: application/json` in the request headers (again, unless overridden by {@link headers}).\n     *\n     *  * Parse the response as JSON and return the parsed response.\n     *\n     * Setting this to `false` inhibits all three behaviors, and the response is instead parsed as a UTF-8 string. It\n     * defaults to `true`, unless {@link rawResponseBody} is set.\n     *\n     * @deprecated Instead of setting this to `false`, set {@link rawResponseBody} to `true`.\n     */\n    json?: boolean;\n\n    /**\n     * Setting this to `true` does two things:\n     *\n     *  * Inhibits the automatic addition of `Accept: application/json` in the request headers.\n     *\n     *  * Causes the raw response to be returned as a {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob}\n     *    instead of parsing it as JSON.\n     */\n    rawResponseBody?: boolean;\n}\n\nexport interface IRequestOpts extends BaseRequestOpts {\n    /**\n     * The alternative base url to use.\n     * If not specified, uses this.opts.baseUrl\n     */\n    baseUrl?: string;\n    /**\n     * The full prefix to use e.g.\n     * \"/_matrix/client/v2_alpha\". If not specified, uses this.opts.prefix.\n     */\n    prefix?: string;\n\n    // Set to true to prevent the request function from emitting a Session.logged_out event.\n    // This is intended for use on endpoints where M_UNKNOWN_TOKEN is a valid/notable error response,\n    // such as with token refreshes.\n    inhibitLogoutEmit?: boolean;\n}\n\nexport interface IContentUri {\n    base: string;\n    path: string;\n    params: {\n        // eslint-disable-next-line camelcase\n        access_token: string;\n    };\n}\n\nexport enum HttpApiEvent {\n    SessionLoggedOut = \"Session.logged_out\",\n    NoConsent = \"no_consent\",\n}\n\nexport type HttpApiEventHandlerMap = {\n    /**\n     * Fires whenever the login session the JS SDK is using is no\n     * longer valid and the user must log in again.\n     * NB. This only fires when action is required from the user, not\n     * when then login session can be renewed by using a refresh token.\n     * @example\n     * ```\n     * matrixClient.on(\"Session.logged_out\", function(errorObj){\n     *   // show the login screen\n     * });\n     * ```\n     */\n    [HttpApiEvent.SessionLoggedOut]: (err: BriijError) => void;\n    /**\n     * Fires when the JS SDK receives a M_CONSENT_NOT_GIVEN error in response\n     * to a HTTP request.\n     * @example\n     * ```\n     * matrixClient.on(\"no_consent\", function(message, contentUri) {\n     *     console.info(message + ' Go to ' + contentUri);\n     * });\n     * ```\n     */\n    [HttpApiEvent.NoConsent]: (message: string, consentUri: string) => void;\n};\n\nexport interface UploadProgress {\n    loaded: number;\n    total: number;\n}\n\nexport interface UploadOpts {\n    /**\n     * Name to give the file on the server. Defaults to <tt>file.name</tt>.\n     */\n    name?: string;\n    /**\n     * Content-type for the upload. Defaults to\n     *   <tt>file.type</tt>, or <tt>applicaton/octet-stream</tt>.\n     */\n    type?: string;\n    /**\n     * if false will not send the filename,\n     *   e.g for encrypted file uploads where filename leaks are undesirable.\n     *   Defaults to true.\n     */\n    includeFilename?: boolean;\n    /**\n     * Optional. Called when a chunk of\n     *    data has been uploaded, with an object containing the fields `loaded`\n     *    (number of bytes transferred) and `total` (total size, if known).\n     */\n    progressHandler?(progress: UploadProgress): void;\n    abortController?: AbortController;\n}\n\nexport interface Upload {\n    loaded: number;\n    total: number;\n    promise: Promise<UploadResponse>;\n    abortController: AbortController;\n}\n\nexport interface UploadResponse {\n    // eslint-disable-next-line camelcase\n    content_uri: string;\n}\n\nexport type FileType = XMLHttpRequestBodyInit;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;;AAmCA;;AAqEA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA","ignoreList":[]}

package/lib/http-api/method.d.ts

@@ -0,0 +1,10 @@
+export declare enum Method {
+    Get = "GET",
+    Put = "PUT",
+    Post = "POST",
+    Delete = "DELETE",
+    Options = "OPTIONS",
+    Head = "HEAD",
+    Patch = "PATCH"
+}
+//# sourceMappingURL=method.d.ts.map

package/lib/http-api/method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method.d.ts","sourceRoot":"","sources":["../../src/http-api/method.ts"],"names":[],"mappings":"AAgBA,oBAAY,MAAM;IACd,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;CAClB"}

package/lib/http-api/method.js

@@ -0,0 +1,27 @@
+/*
+Copyright 2022 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 Method = /*#__PURE__*/function (Method) {
+  Method["Get"] = "GET";
+  Method["Put"] = "PUT";
+  Method["Post"] = "POST";
+  Method["Delete"] = "DELETE";
+  Method["Options"] = "OPTIONS";
+  Method["Head"] = "HEAD";
+  Method["Patch"] = "PATCH";
+  return Method;
+}({});
+//# sourceMappingURL=method.js.map

package/lib/http-api/method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"method.js","names":["Method"],"sources":["../../src/http-api/method.ts"],"sourcesContent":["/*\r\nCopyright 2022 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 Method {\r\n    Get = \"GET\",\r\n    Put = \"PUT\",\r\n    Post = \"POST\",\r\n    Delete = \"DELETE\",\r\n    Options = \"OPTIONS\",\r\n    Head = \"HEAD\",\r\n    Patch = \"PATCH\",\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,WAAYA,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA","ignoreList":[]}

package/lib/http-api/prefix.d.ts

@@ -0,0 +1,31 @@
+export declare enum ClientPrefix {
+    /**
+     * A constant representing the URI path for Client-Server API endpoints versioned at v1.
+     */
+    V1 = "/_matrix/client/v1",
+    /**
+     * A constant representing the URI path for Client-Server API endpoints versioned at v3.
+     */
+    V3 = "/_matrix/client/v3",
+    /**
+     * A constant representing the URI path for as-yet unspecified Client-Server HTTP APIs.
+     */
+    Unstable = "/_matrix/client/unstable"
+}
+export declare enum IdentityPrefix {
+    /**
+     * URI path for the v2 identity API
+     */
+    V2 = "/_matrix/identity/v2"
+}
+export declare enum MediaPrefix {
+    /**
+     * A constant representing the URI path for Client-Server API Media endpoints versioned at v1.
+     */
+    V1 = "/_matrix/media/v1",
+    /**
+     * A constant representing the URI path for Client-Server API Media endpoints versioned at v3.
+     */
+    V3 = "/_matrix/media/v3"
+}
+//# sourceMappingURL=prefix.d.ts.map

package/lib/http-api/prefix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix.d.ts","sourceRoot":"","sources":["../../src/http-api/prefix.ts"],"names":[],"mappings":"AAgBA,oBAAY,YAAY;IACpB;;OAEG;IACH,EAAE,uBAAuB;IACzB;;OAEG;IACH,EAAE,uBAAuB;IACzB;;OAEG;IACH,QAAQ,6BAA6B;CACxC;AAED,oBAAY,cAAc;IACtB;;OAEG;IACH,EAAE,yBAAyB;CAC9B;AAED,oBAAY,WAAW;IACnB;;OAEG;IACH,EAAE,sBAAsB;IACxB;;OAEG;IACH,EAAE,sBAAsB;CAC3B"}

package/lib/http-api/prefix.js

@@ -0,0 +1,50 @@
+/*
+Copyright 2022 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 ClientPrefix = /*#__PURE__*/function (ClientPrefix) {
+  /**
+   * A constant representing the URI path for Client-Server API endpoints versioned at v1.
+   */
+  ClientPrefix["V1"] = "/_matrix/client/v1";
+  /**
+   * A constant representing the URI path for Client-Server API endpoints versioned at v3.
+   */
+  ClientPrefix["V3"] = "/_matrix/client/v3";
+  /**
+   * A constant representing the URI path for as-yet unspecified Client-Server HTTP APIs.
+   */
+  ClientPrefix["Unstable"] = "/_matrix/client/unstable";
+  return ClientPrefix;
+}({});
+export var IdentityPrefix = /*#__PURE__*/function (IdentityPrefix) {
+  /**
+   * URI path for the v2 identity API
+   */
+  IdentityPrefix["V2"] = "/_matrix/identity/v2";
+  return IdentityPrefix;
+}({});
+export var MediaPrefix = /*#__PURE__*/function (MediaPrefix) {
+  /**
+   * A constant representing the URI path for Client-Server API Media endpoints versioned at v1.
+   */
+  MediaPrefix["V1"] = "/_matrix/media/v1";
+  /**
+   * A constant representing the URI path for Client-Server API Media endpoints versioned at v3.
+   */
+  MediaPrefix["V3"] = "/_matrix/media/v3";
+  return MediaPrefix;
+}({});
+//# sourceMappingURL=prefix.js.map

package/lib/http-api/prefix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix.js","names":["ClientPrefix","IdentityPrefix","MediaPrefix"],"sources":["../../src/http-api/prefix.ts"],"sourcesContent":["/*\r\nCopyright 2022 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 ClientPrefix {\r\n    /**\r\n     * A constant representing the URI path for Client-Server API endpoints versioned at v1.\r\n     */\r\n    V1 = \"/_matrix/client/v1\",\r\n    /**\r\n     * A constant representing the URI path for Client-Server API endpoints versioned at v3.\r\n     */\r\n    V3 = \"/_matrix/client/v3\",\r\n    /**\r\n     * A constant representing the URI path for as-yet unspecified Client-Server HTTP APIs.\r\n     */\r\n    Unstable = \"/_matrix/client/unstable\",\r\n}\r\n\r\nexport enum IdentityPrefix {\r\n    /**\r\n     * URI path for the v2 identity API\r\n     */\r\n    V2 = \"/_matrix/identity/v2\",\r\n}\r\n\r\nexport enum MediaPrefix {\r\n    /**\r\n     * A constant representing the URI path for Client-Server API Media endpoints versioned at v1.\r\n     */\r\n    V1 = \"/_matrix/media/v1\",\r\n    /**\r\n     * A constant representing the URI path for Client-Server API Media endpoints versioned at v3.\r\n     */\r\n    V3 = \"/_matrix/media/v3\",\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,WAAYA,YAAY,0BAAZA,YAAY;EACpB;AACJ;AACA;EAHYA,YAAY;EAKpB;AACJ;AACA;EAPYA,YAAY;EASpB;AACJ;AACA;EAXYA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAexB,WAAYC,cAAc,0BAAdA,cAAc;EACtB;AACJ;AACA;EAHYA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAO1B,WAAYC,WAAW,0BAAXA,WAAW;EACnB;AACJ;AACA;EAHYA,WAAW;EAKnB;AACJ;AACA;EAPYA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}

package/lib/http-api/refresh.d.ts

@@ -0,0 +1,53 @@
+import { type IHttpOpts } from "./interface.ts";
+/**
+ * This is an internal module. See {@link BriijHttpApi} for the public class.
+ */
+export declare const enum TokenRefreshOutcome {
+    Success = "success",
+    Failure = "failure",
+    Logout = "logout"
+}
+interface Snapshot {
+    accessToken: string;
+    refreshToken?: string;
+    expiry?: Date;
+}
+type Opts = Pick<IHttpOpts, "tokenRefreshFunction" | "logger" | "refreshToken" | "accessToken">;
+/**
+ * This class is responsible for managing the access token and refresh token for authenticated requests.
+ * It will automatically refresh the access token when it is about to expire, and will handle unknown token errors.
+ */
+export declare class TokenRefresher {
+    private readonly opts;
+    constructor(opts: Opts);
+    /**
+     * Promise used to block authenticated requests during a token refresh to avoid repeated expected errors.
+     * @private
+     */
+    private tokenRefreshPromise?;
+    private latestTokenRefreshExpiry?;
+    /**
+     * This function is called before every request to ensure that the access token is valid.
+     * @returns a snapshot containing the access token and other properties which must be passed to the handleUnknownToken
+     *     handler if an M_UNKNOWN_TOKEN error is encountered.
+     */
+    prepareForRequest(): Promise<Snapshot>;
+    private refreshIfNeeded;
+    /**
+     * This function is called when an M_UNKNOWN_TOKEN error is encountered.
+     * It will attempt to refresh the access token if it is unknown, and will return a TokenRefreshOutcome.
+     * @param snapshot - the snapshot returned by prepareForRequest
+     * @param attempt - the number of attempts made for this request so far
+     * @returns a TokenRefreshOutcome indicating the result of the refresh attempt
+     */
+    handleUnknownToken(snapshot: Snapshot, attempt: number): Promise<TokenRefreshOutcome>;
+    private _handleUnknownToken;
+    /**
+     * Attempt to refresh access tokens.
+     * On success, sets new access and refresh tokens in opts.
+     * @returns Promise that resolves to a boolean - true when token was refreshed successfully
+     */
+    private doTokenRefresh;
+}
+export {};
+//# sourceMappingURL=refresh.d.ts.map

package/lib/http-api/refresh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.d.ts","sourceRoot":"","sources":["../../src/http-api/refresh.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD;;GAEG;AAEH,0BAAkB,mBAAmB;IACjC,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;CACpB;AAED,UAAU,QAAQ;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,IAAI,CAAC;CACjB;AAQD,KAAK,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,sBAAsB,GAAG,QAAQ,GAAG,cAAc,GAAG,aAAa,CAAC,CAAC;AAEhG;;;GAGG;AACH,qBAAa,cAAc;IACJ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,IAAI;IAE9C;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAC,CAA+B;IAE3D,OAAO,CAAC,wBAAwB,CAAC,CAAO;IAExC;;;;OAIG;IACU,iBAAiB,IAAI,OAAO,CAAC,QAAQ,CAAC;YAWrC,eAAe;IAa7B;;;;;;OAMG;IACU,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAKpF,mBAAmB;IA6BjC;;;;OAIG;YACW,cAAc;CAgC/B"}

package/lib/http-api/refresh.js

@@ -0,0 +1,174 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2025 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 { BriijError, TokenRefreshLogoutError } from "./errors.js";
+import { sleep } from "../utils.js";
+
+/**
+ * This is an internal module. See {@link BriijHttpApi} for the public class.
+ */
+
+export var TokenRefreshOutcome = /*#__PURE__*/function (TokenRefreshOutcome) {
+  TokenRefreshOutcome["Success"] = "success";
+  TokenRefreshOutcome["Failure"] = "failure";
+  TokenRefreshOutcome["Logout"] = "logout";
+  return TokenRefreshOutcome;
+}({});
+// If the token expires in less than this time amount of time, we will eagerly refresh it before making the intended request.
+var REFRESH_IF_TOKEN_EXPIRES_WITHIN_MS = 500;
+// If we get an unknown token error and the token expires in less than this time amount of time, we will refresh it before making the intended request.
+// Otherwise, we will error as the token should not have expired yet and we need to avoid retrying indefinitely.
+var REFRESH_ON_ERROR_IF_TOKEN_EXPIRES_WITHIN_MS = 60 * 1000;
+/**
+ * This class is responsible for managing the access token and refresh token for authenticated requests.
+ * It will automatically refresh the access token when it is about to expire, and will handle unknown token errors.
+ */
+export class TokenRefresher {
+  constructor(opts) {
+    this.opts = opts;
+    /**
+     * Promise used to block authenticated requests during a token refresh to avoid repeated expected errors.
+     * @private
+     */
+    _defineProperty(this, "tokenRefreshPromise", void 0);
+    _defineProperty(this, "latestTokenRefreshExpiry", void 0);
+  }
+  /**
+   * This function is called before every request to ensure that the access token is valid.
+   * @returns a snapshot containing the access token and other properties which must be passed to the handleUnknownToken
+   *     handler if an M_UNKNOWN_TOKEN error is encountered.
+   */
+  prepareForRequest() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      // Ensure our token is refreshed before we build the headers/params
+      yield _this.refreshIfNeeded();
+      return {
+        accessToken: _this.opts.accessToken,
+        refreshToken: _this.opts.refreshToken,
+        expiry: _this.latestTokenRefreshExpiry
+      };
+    })();
+  }
+  refreshIfNeeded() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      if (_this2.tokenRefreshPromise) {
+        return _this2.tokenRefreshPromise;
+      }
+      // If we don't know the token expiry, we can't eagerly refresh
+      if (!_this2.latestTokenRefreshExpiry) return;
+      var expiresIn = _this2.latestTokenRefreshExpiry.getTime() - Date.now();
+      if (expiresIn <= REFRESH_IF_TOKEN_EXPIRES_WITHIN_MS) {
+        yield _this2._handleUnknownToken();
+      }
+    })();
+  }
+
+  /**
+   * This function is called when an M_UNKNOWN_TOKEN error is encountered.
+   * It will attempt to refresh the access token if it is unknown, and will return a TokenRefreshOutcome.
+   * @param snapshot - the snapshot returned by prepareForRequest
+   * @param attempt - the number of attempts made for this request so far
+   * @returns a TokenRefreshOutcome indicating the result of the refresh attempt
+   */
+  handleUnknownToken(snapshot, attempt) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      return _this3._handleUnknownToken(snapshot, attempt);
+    })();
+  }
+
+  /* eslint-disable @typescript-eslint/naming-convention */
+
+  _handleUnknownToken(snapshot, attempt) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      if (snapshot !== null && snapshot !== void 0 && snapshot.expiry) {
+        // If our token is unknown, but it should not have expired yet, then we should not refresh
+        var expiresIn = snapshot.expiry.getTime() - Date.now();
+        // If it still has plenty of time left on the clock, we assume something else must be wrong and
+        // do not refresh. Otherwise if it's expired, or will soon, we try refreshing.
+        if (expiresIn >= REFRESH_ON_ERROR_IF_TOKEN_EXPIRES_WITHIN_MS) {
+          return TokenRefreshOutcome.Logout;
+        }
+      }
+      if (!snapshot || (snapshot === null || snapshot === void 0 ? void 0 : snapshot.accessToken) === _this4.opts.accessToken) {
+        var _this4$tokenRefreshPr;
+        // If we have a snapshot, but the access token is the same as the current one then a refresh
+        // did not happen behind us but one may be ongoing anyway
+        (_this4$tokenRefreshPr = _this4.tokenRefreshPromise) !== null && _this4$tokenRefreshPr !== void 0 ? _this4$tokenRefreshPr : _this4.tokenRefreshPromise = _this4.doTokenRefresh(attempt);
+        try {
+          return yield _this4.tokenRefreshPromise;
+        } finally {
+          _this4.tokenRefreshPromise = undefined;
+        }
+      }
+
+      // We may end up here if the token was refreshed in the background due to another request
+      return TokenRefreshOutcome.Success;
+    })();
+  }
+
+  /**
+   * Attempt to refresh access tokens.
+   * On success, sets new access and refresh tokens in opts.
+   * @returns Promise that resolves to a boolean - true when token was refreshed successfully
+   */
+  doTokenRefresh(attempt) {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this5.opts.refreshToken || !_this5.opts.tokenRefreshFunction) {
+        var _this5$opts$logger;
+        (_this5$opts$logger = _this5.opts.logger) === null || _this5$opts$logger === void 0 || _this5$opts$logger.error("Unable to refresh token - no refresh token or refresh function");
+        return TokenRefreshOutcome.Logout;
+      }
+      if (attempt && attempt > 1) {
+        // Exponential backoff to ensure we don't trash the server, up to 2^5 seconds
+        yield sleep(1000 * Math.min(32, 2 ** attempt));
+      }
+      try {
+        var _this5$opts$logger2, _this5$opts$logger3;
+        (_this5$opts$logger2 = _this5.opts.logger) === null || _this5$opts$logger2 === void 0 || _this5$opts$logger2.debug("Attempting to refresh token");
+        var {
+          accessToken,
+          refreshToken,
+          expiry
+        } = yield _this5.opts.tokenRefreshFunction(_this5.opts.refreshToken);
+        _this5.opts.accessToken = accessToken;
+        _this5.opts.refreshToken = refreshToken;
+        _this5.latestTokenRefreshExpiry = expiry;
+        (_this5$opts$logger3 = _this5.opts.logger) === null || _this5$opts$logger3 === void 0 || _this5$opts$logger3.debug("... token refresh complete, new token expiry:", expiry);
+
+        // successfully got new tokens
+        return TokenRefreshOutcome.Success;
+      } catch (error) {
+        var _this5$opts$logger5;
+        // If we get a TokenError or BriijError, we should log out, otherwise assume transient
+        if (error instanceof TokenRefreshLogoutError || error instanceof BriijError) {
+          var _this5$opts$logger4;
+          (_this5$opts$logger4 = _this5.opts.logger) === null || _this5$opts$logger4 === void 0 || _this5$opts$logger4.error("Failed to refresh token", error);
+          return TokenRefreshOutcome.Logout;
+        }
+        (_this5$opts$logger5 = _this5.opts.logger) === null || _this5$opts$logger5 === void 0 || _this5$opts$logger5.warn("Failed to refresh token", error);
+        return TokenRefreshOutcome.Failure;
+      }
+    })();
+  }
+}
+//# sourceMappingURL=refresh.js.map

package/lib/http-api/refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.js","names":["BriijError","TokenRefreshLogoutError","sleep","TokenRefreshOutcome","REFRESH_IF_TOKEN_EXPIRES_WITHIN_MS","REFRESH_ON_ERROR_IF_TOKEN_EXPIRES_WITHIN_MS","TokenRefresher","constructor","opts","_defineProperty","prepareForRequest","_this","_asyncToGenerator","refreshIfNeeded","accessToken","refreshToken","expiry","latestTokenRefreshExpiry","_this2","tokenRefreshPromise","expiresIn","getTime","Date","now","_handleUnknownToken","handleUnknownToken","snapshot","attempt","_this3","_this4","Logout","_this4$tokenRefreshPr","doTokenRefresh","undefined","Success","_this5","tokenRefreshFunction","_this5$opts$logger","logger","error","Math","min","_this5$opts$logger2","_this5$opts$logger3","debug","_this5$opts$logger5","_this5$opts$logger4","warn","Failure"],"sources":["../../src/http-api/refresh.ts"],"sourcesContent":["/*\nCopyright 2025 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 { BriijError, TokenRefreshLogoutError } from \"./errors.ts\";\nimport { type IHttpOpts } from \"./interface.ts\";\nimport { sleep } from \"../utils.ts\";\n\n/**\n * This is an internal module. See {@link BriijHttpApi} for the public class.\n */\n\nexport const enum TokenRefreshOutcome {\n    Success = \"success\",\n    Failure = \"failure\",\n    Logout = \"logout\",\n}\n\ninterface Snapshot {\n    accessToken: string;\n    refreshToken?: string;\n    expiry?: Date;\n}\n\n// If the token expires in less than this time amount of time, we will eagerly refresh it before making the intended request.\nconst REFRESH_IF_TOKEN_EXPIRES_WITHIN_MS = 500;\n// If we get an unknown token error and the token expires in less than this time amount of time, we will refresh it before making the intended request.\n// Otherwise, we will error as the token should not have expired yet and we need to avoid retrying indefinitely.\nconst REFRESH_ON_ERROR_IF_TOKEN_EXPIRES_WITHIN_MS = 60 * 1000;\n\ntype Opts = Pick<IHttpOpts, \"tokenRefreshFunction\" | \"logger\" | \"refreshToken\" | \"accessToken\">;\n\n/**\n * This class is responsible for managing the access token and refresh token for authenticated requests.\n * It will automatically refresh the access token when it is about to expire, and will handle unknown token errors.\n */\nexport class TokenRefresher {\n    public constructor(private readonly opts: Opts) {}\n\n    /**\n     * Promise used to block authenticated requests during a token refresh to avoid repeated expected errors.\n     * @private\n     */\n    private tokenRefreshPromise?: Promise<TokenRefreshOutcome>;\n\n    private latestTokenRefreshExpiry?: Date;\n\n    /**\n     * This function is called before every request to ensure that the access token is valid.\n     * @returns a snapshot containing the access token and other properties which must be passed to the handleUnknownToken\n     *     handler if an M_UNKNOWN_TOKEN error is encountered.\n     */\n    public async prepareForRequest(): Promise<Snapshot> {\n        // Ensure our token is refreshed before we build the headers/params\n        await this.refreshIfNeeded();\n\n        return {\n            accessToken: this.opts.accessToken!,\n            refreshToken: this.opts.refreshToken,\n            expiry: this.latestTokenRefreshExpiry,\n        };\n    }\n\n    private async refreshIfNeeded(): Promise<unknown> {\n        if (this.tokenRefreshPromise) {\n            return this.tokenRefreshPromise;\n        }\n        // If we don't know the token expiry, we can't eagerly refresh\n        if (!this.latestTokenRefreshExpiry) return;\n\n        const expiresIn = this.latestTokenRefreshExpiry.getTime() - Date.now();\n        if (expiresIn <= REFRESH_IF_TOKEN_EXPIRES_WITHIN_MS) {\n            await this._handleUnknownToken();\n        }\n    }\n\n    /**\n     * This function is called when an M_UNKNOWN_TOKEN error is encountered.\n     * It will attempt to refresh the access token if it is unknown, and will return a TokenRefreshOutcome.\n     * @param snapshot - the snapshot returned by prepareForRequest\n     * @param attempt - the number of attempts made for this request so far\n     * @returns a TokenRefreshOutcome indicating the result of the refresh attempt\n     */\n    public async handleUnknownToken(snapshot: Snapshot, attempt: number): Promise<TokenRefreshOutcome> {\n        return this._handleUnknownToken(snapshot, attempt);\n    }\n\n    /* eslint-disable @typescript-eslint/naming-convention */\n    private async _handleUnknownToken(): Promise<TokenRefreshOutcome>;\n    private async _handleUnknownToken(snapshot: Snapshot, attempt: number): Promise<TokenRefreshOutcome>;\n    private async _handleUnknownToken(snapshot?: Snapshot, attempt?: number): Promise<TokenRefreshOutcome> {\n        if (snapshot?.expiry) {\n            // If our token is unknown, but it should not have expired yet, then we should not refresh\n            const expiresIn = snapshot.expiry.getTime() - Date.now();\n            // If it still has plenty of time left on the clock, we assume something else must be wrong and\n            // do not refresh. Otherwise if it's expired, or will soon, we try refreshing.\n            if (expiresIn >= REFRESH_ON_ERROR_IF_TOKEN_EXPIRES_WITHIN_MS) {\n                return TokenRefreshOutcome.Logout;\n            }\n        }\n\n        if (!snapshot || snapshot?.accessToken === this.opts.accessToken) {\n            // If we have a snapshot, but the access token is the same as the current one then a refresh\n            // did not happen behind us but one may be ongoing anyway\n            this.tokenRefreshPromise ??= this.doTokenRefresh(attempt);\n\n            try {\n                return await this.tokenRefreshPromise;\n            } finally {\n                this.tokenRefreshPromise = undefined;\n            }\n        }\n\n        // We may end up here if the token was refreshed in the background due to another request\n        return TokenRefreshOutcome.Success;\n    }\n\n    /**\n     * Attempt to refresh access tokens.\n     * On success, sets new access and refresh tokens in opts.\n     * @returns Promise that resolves to a boolean - true when token was refreshed successfully\n     */\n    private async doTokenRefresh(attempt?: number): Promise<TokenRefreshOutcome> {\n        if (!this.opts.refreshToken || !this.opts.tokenRefreshFunction) {\n            this.opts.logger?.error(\"Unable to refresh token - no refresh token or refresh function\");\n            return TokenRefreshOutcome.Logout;\n        }\n\n        if (attempt && attempt > 1) {\n            // Exponential backoff to ensure we don't trash the server, up to 2^5 seconds\n            await sleep(1000 * Math.min(32, 2 ** attempt));\n        }\n\n        try {\n            this.opts.logger?.debug(\"Attempting to refresh token\");\n            const { accessToken, refreshToken, expiry } = await this.opts.tokenRefreshFunction(this.opts.refreshToken);\n            this.opts.accessToken = accessToken;\n            this.opts.refreshToken = refreshToken;\n            this.latestTokenRefreshExpiry = expiry;\n            this.opts.logger?.debug(\"... token refresh complete, new token expiry:\", expiry);\n\n            // successfully got new tokens\n            return TokenRefreshOutcome.Success;\n        } catch (error) {\n            // If we get a TokenError or BriijError, we should log out, otherwise assume transient\n            if (error instanceof TokenRefreshLogoutError || error instanceof BriijError) {\n                this.opts.logger?.error(\"Failed to refresh token\", error);\n                return TokenRefreshOutcome.Logout;\n            }\n\n            this.opts.logger?.warn(\"Failed to refresh token\", error);\n            return TokenRefreshOutcome.Failure;\n        }\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,UAAU,EAAEC,uBAAuB,QAAQ,aAAa;AAEjE,SAASC,KAAK,QAAQ,aAAa;;AAEnC;AACA;AACA;;AAEA,WAAkBC,mBAAmB,0BAAnBA,mBAAmB;EAAnBA,mBAAmB;EAAnBA,mBAAmB;EAAnBA,mBAAmB;EAAA,OAAnBA,mBAAmB;AAAA;AAYrC;AACA,IAAMC,kCAAkC,GAAG,GAAG;AAC9C;AACA;AACA,IAAMC,2CAA2C,GAAG,EAAE,GAAG,IAAI;AAI7D;AACA;AACA;AACA;AACA,OAAO,MAAMC,cAAc,CAAC;EACjBC,WAAWA,CAAkBC,IAAU,EAAE;IAAA,KAAZA,IAAU,GAAVA,IAAU;IAE9C;AACJ;AACA;AACA;IAHIC,eAAA;IAAAA,eAAA;EAFiD;EAUjD;AACJ;AACA;AACA;AACA;EACiBC,iBAAiBA,CAAA,EAAsB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAChD;MACA,MAAMD,KAAI,CAACE,eAAe,CAAC,CAAC;MAE5B,OAAO;QACHC,WAAW,EAAEH,KAAI,CAACH,IAAI,CAACM,WAAY;QACnCC,YAAY,EAAEJ,KAAI,CAACH,IAAI,CAACO,YAAY;QACpCC,MAAM,EAAEL,KAAI,CAACM;MACjB,CAAC;IAAC;EACN;EAEcJ,eAAeA,CAAA,EAAqB;IAAA,IAAAK,MAAA;IAAA,OAAAN,iBAAA;MAC9C,IAAIM,MAAI,CAACC,mBAAmB,EAAE;QAC1B,OAAOD,MAAI,CAACC,mBAAmB;MACnC;MACA;MACA,IAAI,CAACD,MAAI,CAACD,wBAAwB,EAAE;MAEpC,IAAMG,SAAS,GAAGF,MAAI,CAACD,wBAAwB,CAACI,OAAO,CAAC,CAAC,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;MACtE,IAAIH,SAAS,IAAIhB,kCAAkC,EAAE;QACjD,MAAMc,MAAI,CAACM,mBAAmB,CAAC,CAAC;MACpC;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBC,kBAAkBA,CAACC,QAAkB,EAAEC,OAAe,EAAgC;IAAA,IAAAC,MAAA;IAAA,OAAAhB,iBAAA;MAC/F,OAAOgB,MAAI,CAACJ,mBAAmB,CAACE,QAAQ,EAAEC,OAAO,CAAC;IAAC;EACvD;;EAEA;;EAGcH,mBAAmBA,CAACE,QAAmB,EAAEC,OAAgB,EAAgC;IAAA,IAAAE,MAAA;IAAA,OAAAjB,iBAAA;MACnG,IAAIc,QAAQ,aAARA,QAAQ,eAARA,QAAQ,CAAEV,MAAM,EAAE;QAClB;QACA,IAAMI,SAAS,GAAGM,QAAQ,CAACV,MAAM,CAACK,OAAO,CAAC,CAAC,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;QACxD;QACA;QACA,IAAIH,SAAS,IAAIf,2CAA2C,EAAE;UAC1D,OAAOF,mBAAmB,CAAC2B,MAAM;QACrC;MACJ;MAEA,IAAI,CAACJ,QAAQ,IAAI,CAAAA,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEZ,WAAW,MAAKe,MAAI,CAACrB,IAAI,CAACM,WAAW,EAAE;QAAA,IAAAiB,qBAAA;QAC9D;QACA;QACA,CAAAA,qBAAA,GAAAF,MAAI,CAACV,mBAAmB,cAAAY,qBAAA,cAAAA,qBAAA,GAAxBF,MAAI,CAACV,mBAAmB,GAAKU,MAAI,CAACG,cAAc,CAACL,OAAO,CAAC;QAEzD,IAAI;UACA,aAAaE,MAAI,CAACV,mBAAmB;QACzC,CAAC,SAAS;UACNU,MAAI,CAACV,mBAAmB,GAAGc,SAAS;QACxC;MACJ;;MAEA;MACA,OAAO9B,mBAAmB,CAAC+B,OAAO;IAAC;EACvC;;EAEA;AACJ;AACA;AACA;AACA;EACkBF,cAAcA,CAACL,OAAgB,EAAgC;IAAA,IAAAQ,MAAA;IAAA,OAAAvB,iBAAA;MACzE,IAAI,CAACuB,MAAI,CAAC3B,IAAI,CAACO,YAAY,IAAI,CAACoB,MAAI,CAAC3B,IAAI,CAAC4B,oBAAoB,EAAE;QAAA,IAAAC,kBAAA;QAC5D,CAAAA,kBAAA,GAAAF,MAAI,CAAC3B,IAAI,CAAC8B,MAAM,cAAAD,kBAAA,eAAhBA,kBAAA,CAAkBE,KAAK,CAAC,gEAAgE,CAAC;QACzF,OAAOpC,mBAAmB,CAAC2B,MAAM;MACrC;MAEA,IAAIH,OAAO,IAAIA,OAAO,GAAG,CAAC,EAAE;QACxB;QACA,MAAMzB,KAAK,CAAC,IAAI,GAAGsC,IAAI,CAACC,GAAG,CAAC,EAAE,EAAE,CAAC,IAAId,OAAO,CAAC,CAAC;MAClD;MAEA,IAAI;QAAA,IAAAe,mBAAA,EAAAC,mBAAA;QACA,CAAAD,mBAAA,GAAAP,MAAI,CAAC3B,IAAI,CAAC8B,MAAM,cAAAI,mBAAA,eAAhBA,mBAAA,CAAkBE,KAAK,CAAC,6BAA6B,CAAC;QACtD,IAAM;UAAE9B,WAAW;UAAEC,YAAY;UAAEC;QAAO,CAAC,SAASmB,MAAI,CAAC3B,IAAI,CAAC4B,oBAAoB,CAACD,MAAI,CAAC3B,IAAI,CAACO,YAAY,CAAC;QAC1GoB,MAAI,CAAC3B,IAAI,CAACM,WAAW,GAAGA,WAAW;QACnCqB,MAAI,CAAC3B,IAAI,CAACO,YAAY,GAAGA,YAAY;QACrCoB,MAAI,CAAClB,wBAAwB,GAAGD,MAAM;QACtC,CAAA2B,mBAAA,GAAAR,MAAI,CAAC3B,IAAI,CAAC8B,MAAM,cAAAK,mBAAA,eAAhBA,mBAAA,CAAkBC,KAAK,CAAC,+CAA+C,EAAE5B,MAAM,CAAC;;QAEhF;QACA,OAAOb,mBAAmB,CAAC+B,OAAO;MACtC,CAAC,CAAC,OAAOK,KAAK,EAAE;QAAA,IAAAM,mBAAA;QACZ;QACA,IAAIN,KAAK,YAAYtC,uBAAuB,IAAIsC,KAAK,YAAYvC,UAAU,EAAE;UAAA,IAAA8C,mBAAA;UACzE,CAAAA,mBAAA,GAAAX,MAAI,CAAC3B,IAAI,CAAC8B,MAAM,cAAAQ,mBAAA,eAAhBA,mBAAA,CAAkBP,KAAK,CAAC,yBAAyB,EAAEA,KAAK,CAAC;UACzD,OAAOpC,mBAAmB,CAAC2B,MAAM;QACrC;QAEA,CAAAe,mBAAA,GAAAV,MAAI,CAAC3B,IAAI,CAAC8B,MAAM,cAAAO,mBAAA,eAAhBA,mBAAA,CAAkBE,IAAI,CAAC,yBAAyB,EAAER,KAAK,CAAC;QACxD,OAAOpC,mBAAmB,CAAC6C,OAAO;MACtC;IAAC;EACL;AACJ","ignoreList":[]}