@textrp/briij-js-sdk 41.0.0

package/lib/http-api/errors.js

@@ -0,0 +1,245 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2022 - 2024 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { NamespacedValue } from "../NamespacedValue.js";
+/**
+ * Construct a generic HTTP error. This is a JavaScript Error with additional information
+ * specific to HTTP responses.
+ * @param msg - The error message to include.
+ * @param httpStatus - The HTTP response status code.
+ * @param httpHeaders - The HTTP response headers.
+ */
+export class HTTPError extends Error {
+  constructor(msg, httpStatus, httpHeaders) {
+    super(msg);
+    this.httpStatus = httpStatus;
+    this.httpHeaders = httpHeaders;
+  }
+
+  /**
+   * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).
+   *
+   * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side
+   * recommendation for the retry period.
+   *
+   * @returns Whether this error is due to rate-limiting.
+   */
+  isRateLimitError() {
+    return this.httpStatus === 429;
+  }
+
+  /**
+   * @returns The recommended delay in milliseconds to wait before retrying
+   * the request that triggered this error, or null if no delay is recommended.
+   * @throws Error if the recommended delay is an invalid value.
+   * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.
+   */
+  getRetryAfterMs() {
+    var _this$httpHeaders;
+    var retryAfter = (_this$httpHeaders = this.httpHeaders) === null || _this$httpHeaders === void 0 ? void 0 : _this$httpHeaders.get("Retry-After");
+    if (retryAfter != null) {
+      if (/^\d+$/.test(retryAfter)) {
+        var ms = Number.parseInt(retryAfter) * 1000;
+        if (!Number.isFinite(ms)) {
+          throw new Error("Retry-After header integer value is too large");
+        }
+        return ms;
+      }
+      var date = new Date(retryAfter);
+      if (date.toUTCString() !== retryAfter) {
+        throw new Error("Retry-After header value is not a valid HTTP-date or non-negative decimal integer");
+      }
+      return date.getTime() - Date.now();
+    }
+    return null;
+  }
+}
+export class BriijError extends HTTPError {
+  /**
+   * Construct a Matrix error. This is a JavaScript Error with additional
+   * information specific to the standard Matrix error response.
+   * @param errorJson - The Matrix error JSON returned from the homeserver.
+   * @param httpStatus - The numeric HTTP status code given
+   * @param httpHeaders - The HTTP response headers given
+   */
+  constructor() {
+    var errorJson = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    var httpStatus = arguments.length > 1 ? arguments[1] : undefined;
+    var url = arguments.length > 2 ? arguments[2] : undefined;
+    var event = arguments.length > 3 ? arguments[3] : undefined;
+    var httpHeaders = arguments.length > 4 ? arguments[4] : undefined;
+    var message = errorJson.error || "Unknown message";
+    if (httpStatus) {
+      message = "[".concat(httpStatus, "] ").concat(message);
+    }
+    if (url) {
+      message = "".concat(message, " (").concat(url, ")");
+    }
+    super("BriijError: ".concat(message), httpStatus, httpHeaders);
+    this.url = url;
+    this.event = event;
+    // The Matrix 'errcode' value, e.g. "M_FORBIDDEN".
+    _defineProperty(this, "errcode", void 0);
+    // The Matrix 'error' value.
+    _defineProperty(this, "error", void 0);
+    // The raw Matrix error JSON used to construct this object.
+    _defineProperty(this, "data", void 0);
+    this.errcode = errorJson.errcode;
+    this.error = errorJson.error;
+    this.name = errorJson.errcode || "Unknown error code";
+    this.data = errorJson;
+  }
+  isRateLimitError() {
+    return this.errcode === "M_LIMIT_EXCEEDED" || (this.errcode === "M_UNKNOWN" || this.errcode === undefined) && super.isRateLimitError();
+  }
+  getRetryAfterMs() {
+    var headerValue = super.getRetryAfterMs();
+    if (headerValue !== null) {
+      return headerValue;
+    }
+    // Note: retry_after_ms is deprecated as of spec version v1.10
+    if (this.errcode === "M_LIMIT_EXCEEDED" && "retry_after_ms" in this.data) {
+      if (!Number.isInteger(this.data.retry_after_ms)) {
+        throw new Error("retry_after_ms is not an integer");
+      }
+      return this.data.retry_after_ms;
+    }
+    return null;
+  }
+
+  /**
+   * @returns this error expressed as a JSON payload
+   * for use by Widget API error responses.
+   */
+  asWidgetApiErrorData() {
+    var _this$httpStatus, _this$url, _this$errcode, _this$data$error;
+    var headers = {};
+    if (this.httpHeaders) {
+      for (var [name, value] of this.httpHeaders) {
+        headers[name] = value;
+      }
+    }
+    return {
+      http_status: (_this$httpStatus = this.httpStatus) !== null && _this$httpStatus !== void 0 ? _this$httpStatus : 400,
+      http_headers: headers,
+      url: (_this$url = this.url) !== null && _this$url !== void 0 ? _this$url : "",
+      response: _objectSpread({
+        errcode: (_this$errcode = this.errcode) !== null && _this$errcode !== void 0 ? _this$errcode : "M_UNKNOWN",
+        error: (_this$data$error = this.data.error) !== null && _this$data$error !== void 0 ? _this$data$error : "Unknown message"
+      }, this.data)
+    };
+  }
+
+  /**
+   * @returns a new {@link BriijError} from a JSON payload
+   * received from Widget API error responses.
+   */
+  static fromWidgetApiErrorData(data) {
+    return new BriijError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));
+  }
+}
+
+/**
+ * @returns The recommended delay in milliseconds to wait before retrying the request.
+ * @param error - The error to check for a retry delay.
+ * @param defaultMs - The delay to use if the error was not due to rate-limiting or if no valid delay is recommended.
+ */
+export function safeGetRetryAfterMs(error, defaultMs) {
+  if (!(error instanceof HTTPError) || !error.isRateLimitError()) {
+    return defaultMs;
+  }
+  try {
+    var _error$getRetryAfterM;
+    return (_error$getRetryAfterM = error.getRetryAfterMs()) !== null && _error$getRetryAfterM !== void 0 ? _error$getRetryAfterM : defaultMs;
+  } catch (_unused) {
+    return defaultMs;
+  }
+}
+
+/**
+ * Construct a ConnectionError. This is a JavaScript Error indicating
+ * that a request failed because of some error with the connection, either
+ * CORS was not correctly configured on the server, the server didn't response,
+ * the request timed out, or the internet connection on the client side went down.
+ */
+export class ConnectionError extends Error {
+  constructor(message, cause) {
+    super(message + (cause ? ": ".concat(cause.message) : ""));
+  }
+  get name() {
+    return "ConnectionError";
+  }
+}
+
+/**
+ * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,
+ * and attempting to refresh said token also failed but in a way which was not indicative of token invalidation.
+ * Assumed to be a temporary failure.
+ */
+export class TokenRefreshError extends Error {
+  constructor(cause) {
+    var _cause$message;
+    super((_cause$message = cause === null || cause === void 0 ? void 0 : cause.message) !== null && _cause$message !== void 0 ? _cause$message : "");
+  }
+  get name() {
+    return "TokenRefreshError";
+  }
+}
+
+/**
+ * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,
+ * and attempting to refresh said token failed in a way indicative of token invalidation.
+ */
+export class TokenRefreshLogoutError extends Error {
+  constructor(cause) {
+    var _cause$message2;
+    super((_cause$message2 = cause === null || cause === void 0 ? void 0 : cause.message) !== null && _cause$message2 !== void 0 ? _cause$message2 : "");
+  }
+  get name() {
+    return "TokenRefreshLogoutError";
+  }
+}
+export var BriijSafetyErrorCode = new NamespacedValue(null, "ORG.MATRIX.MSC4387_SAFETY");
+
+/***
+ * This error is thrown when the homeserver refuses to handle an action due to a
+ * safety concern.
+ * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387
+ */
+export class BriijSafetyError extends BriijError {
+  constructor() {
+    super(...arguments);
+    /**
+     * The kinds of harms detected by the server.
+     * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.
+     */
+    _defineProperty(this, "harms", void 0);
+    /**
+     * The date at which a request can be reattempted.
+     */
+    _defineProperty(this, "expiry", void 0);
+    var body = arguments.length <= 0 ? undefined : arguments[0];
+    this.harms = new Set(body && "harms" in body && Array.isArray(body.harms) ? body.harms : []);
+    this.message = "".concat(super.message, " (").concat([...this.harms].join(", "), ")");
+    if (body && "expiry" in body && typeof body.expiry === "number") {
+      this.expiry = new Date(body.expiry);
+    }
+  }
+}
+//# sourceMappingURL=errors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":["NamespacedValue","HTTPError","Error","constructor","msg","httpStatus","httpHeaders","isRateLimitError","getRetryAfterMs","_this$httpHeaders","retryAfter","get","test","ms","Number","parseInt","isFinite","date","Date","toUTCString","getTime","now","BriijError","errorJson","arguments","length","undefined","url","event","message","error","concat","_defineProperty","errcode","name","data","headerValue","isInteger","retry_after_ms","asWidgetApiErrorData","_this$httpStatus","_this$url","_this$errcode","_this$data$error","headers","value","http_status","http_headers","response","_objectSpread","fromWidgetApiErrorData","Headers","safeGetRetryAfterMs","defaultMs","_error$getRetryAfterM","_unused","ConnectionError","cause","TokenRefreshError","_cause$message","TokenRefreshLogoutError","_cause$message2","BriijSafetyErrorCode","BriijSafetyError","body","harms","Set","Array","isArray","join","expiry"],"sources":["../../src/http-api/errors.ts"],"sourcesContent":["/*\nCopyright 2022 - 2024 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 IMatrixApiError as IWidgetBriijError } from \"matrix-widget-api\";\n\nimport { type IUsageLimit } from \"../@types/partials.ts\";\nimport { type BriijEvent } from \"../models/event.ts\";\nimport { NamespacedValue } from \"../NamespacedValue.ts\";\n\ninterface IErrorJson extends Partial<IUsageLimit> {\n    [key: string]: any; // extensible\n    errcode?: string;\n    error?: string;\n}\n\n/**\n * Construct a generic HTTP error. This is a JavaScript Error with additional information\n * specific to HTTP responses.\n * @param msg - The error message to include.\n * @param httpStatus - The HTTP response status code.\n * @param httpHeaders - The HTTP response headers.\n */\nexport class HTTPError extends Error {\n    public constructor(\n        msg: string,\n        public readonly httpStatus?: number,\n        public readonly httpHeaders?: Headers,\n    ) {\n        super(msg);\n    }\n\n    /**\n     * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).\n     *\n     * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side\n     * recommendation for the retry period.\n     *\n     * @returns Whether this error is due to rate-limiting.\n     */\n    public isRateLimitError(): boolean {\n        return this.httpStatus === 429;\n    }\n\n    /**\n     * @returns The recommended delay in milliseconds to wait before retrying\n     * the request that triggered this error, or null if no delay is recommended.\n     * @throws Error if the recommended delay is an invalid value.\n     * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.\n     */\n    public getRetryAfterMs(): number | null {\n        const retryAfter = this.httpHeaders?.get(\"Retry-After\");\n        if (retryAfter != null) {\n            if (/^\\d+$/.test(retryAfter)) {\n                const ms = Number.parseInt(retryAfter) * 1000;\n                if (!Number.isFinite(ms)) {\n                    throw new Error(\"Retry-After header integer value is too large\");\n                }\n                return ms;\n            }\n            const date = new Date(retryAfter);\n            if (date.toUTCString() !== retryAfter) {\n                throw new Error(\"Retry-After header value is not a valid HTTP-date or non-negative decimal integer\");\n            }\n            return date.getTime() - Date.now();\n        }\n        return null;\n    }\n}\n\nexport class BriijError extends HTTPError {\n    // The Matrix 'errcode' value, e.g. \"M_FORBIDDEN\".\n    public readonly errcode?: string;\n    // The Matrix 'error' value.\n    public readonly error?: string;\n    // The raw Matrix error JSON used to construct this object.\n    public data: IErrorJson;\n\n    /**\n     * Construct a Matrix error. This is a JavaScript Error with additional\n     * information specific to the standard Matrix error response.\n     * @param errorJson - The Matrix error JSON returned from the homeserver.\n     * @param httpStatus - The numeric HTTP status code given\n     * @param httpHeaders - The HTTP response headers given\n     */\n    public constructor(\n        errorJson: IErrorJson = {},\n        httpStatus?: number,\n        public url?: string,\n        public event?: BriijEvent,\n        httpHeaders?: Headers,\n    ) {\n        let message = errorJson.error || \"Unknown message\";\n        if (httpStatus) {\n            message = `[${httpStatus}] ${message}`;\n        }\n        if (url) {\n            message = `${message} (${url})`;\n        }\n        super(`BriijError: ${message}`, httpStatus, httpHeaders);\n        this.errcode = errorJson.errcode;\n        this.error = errorJson.error;\n        this.name = errorJson.errcode || \"Unknown error code\";\n        this.data = errorJson;\n    }\n\n    public isRateLimitError(): boolean {\n        return (\n            this.errcode === \"M_LIMIT_EXCEEDED\" ||\n            ((this.errcode === \"M_UNKNOWN\" || this.errcode === undefined) && super.isRateLimitError())\n        );\n    }\n\n    public getRetryAfterMs(): number | null {\n        const headerValue = super.getRetryAfterMs();\n        if (headerValue !== null) {\n            return headerValue;\n        }\n        // Note: retry_after_ms is deprecated as of spec version v1.10\n        if (this.errcode === \"M_LIMIT_EXCEEDED\" && \"retry_after_ms\" in this.data) {\n            if (!Number.isInteger(this.data.retry_after_ms)) {\n                throw new Error(\"retry_after_ms is not an integer\");\n            }\n            return this.data.retry_after_ms;\n        }\n        return null;\n    }\n\n    /**\n     * @returns this error expressed as a JSON payload\n     * for use by Widget API error responses.\n     */\n    public asWidgetApiErrorData(): IWidgetBriijError {\n        const headers: Record<string, string> = {};\n        if (this.httpHeaders) {\n            for (const [name, value] of this.httpHeaders) {\n                headers[name] = value;\n            }\n        }\n        return {\n            http_status: this.httpStatus ?? 400,\n            http_headers: headers,\n            url: this.url ?? \"\",\n            response: {\n                errcode: this.errcode ?? \"M_UNKNOWN\",\n                error: this.data.error ?? \"Unknown message\",\n                ...this.data,\n            },\n        };\n    }\n\n    /**\n     * @returns a new {@link BriijError} from a JSON payload\n     * received from Widget API error responses.\n     */\n    public static fromWidgetApiErrorData(data: IWidgetBriijError): BriijError {\n        return new BriijError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));\n    }\n}\n\n/**\n * @returns The recommended delay in milliseconds to wait before retrying the request.\n * @param error - The error to check for a retry delay.\n * @param defaultMs - The delay to use if the error was not due to rate-limiting or if no valid delay is recommended.\n */\nexport function safeGetRetryAfterMs(error: unknown, defaultMs: number): number {\n    if (!(error instanceof HTTPError) || !error.isRateLimitError()) {\n        return defaultMs;\n    }\n    try {\n        return error.getRetryAfterMs() ?? defaultMs;\n    } catch {\n        return defaultMs;\n    }\n}\n\n/**\n * Construct a ConnectionError. This is a JavaScript Error indicating\n * that a request failed because of some error with the connection, either\n * CORS was not correctly configured on the server, the server didn't response,\n * the request timed out, or the internet connection on the client side went down.\n */\nexport class ConnectionError extends Error {\n    public constructor(message: string, cause?: Error) {\n        super(message + (cause ? `: ${cause.message}` : \"\"));\n    }\n\n    public get name(): string {\n        return \"ConnectionError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token also failed but in a way which was not indicative of token invalidation.\n * Assumed to be a temporary failure.\n */\nexport class TokenRefreshError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token failed in a way indicative of token invalidation.\n */\nexport class TokenRefreshLogoutError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshLogoutError\";\n    }\n}\n\nexport const BriijSafetyErrorCode = new NamespacedValue(null, \"ORG.MATRIX.MSC4387_SAFETY\");\n\n/***\n * This error is thrown when the homeserver refuses to handle an action due to a\n * safety concern.\n * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387\n */\nexport class BriijSafetyError extends BriijError {\n    /**\n     * The kinds of harms detected by the server.\n     * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.\n     */\n    public readonly harms: Set<string>;\n    /**\n     * The date at which a request can be reattempted.\n     */\n    public readonly expiry?: Date;\n    public constructor(...props: ConstructorParameters<typeof BriijError>) {\n        super(...props);\n        const body = props[0];\n\n        this.harms = new Set(body && \"harms\" in body && Array.isArray(body.harms) ? body.harms : []);\n        this.message = `${super.message} (${[...this.harms].join(\", \")})`;\n        if (body && \"expiry\" in body && typeof body.expiry === \"number\") {\n            this.expiry = new Date(body.expiry);\n        }\n    }\n}\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA,SAASA,eAAe,QAAQ,uBAAuB;AAQvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,SAASC,KAAK,CAAC;EAC1BC,WAAWA,CACdC,GAAW,EACKC,UAAmB,EACnBC,WAAqB,EACvC;IACE,KAAK,CAACF,GAAG,CAAC;IAAC,KAHKC,UAAmB,GAAnBA,UAAmB;IAAA,KACnBC,WAAqB,GAArBA,WAAqB;EAGzC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,gBAAgBA,CAAA,EAAY;IAC/B,OAAO,IAAI,CAACF,UAAU,KAAK,GAAG;EAClC;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWG,eAAeA,CAAA,EAAkB;IAAA,IAAAC,iBAAA;IACpC,IAAMC,UAAU,IAAAD,iBAAA,GAAG,IAAI,CAACH,WAAW,cAAAG,iBAAA,uBAAhBA,iBAAA,CAAkBE,GAAG,CAAC,aAAa,CAAC;IACvD,IAAID,UAAU,IAAI,IAAI,EAAE;MACpB,IAAI,OAAO,CAACE,IAAI,CAACF,UAAU,CAAC,EAAE;QAC1B,IAAMG,EAAE,GAAGC,MAAM,CAACC,QAAQ,CAACL,UAAU,CAAC,GAAG,IAAI;QAC7C,IAAI,CAACI,MAAM,CAACE,QAAQ,CAACH,EAAE,CAAC,EAAE;UACtB,MAAM,IAAIX,KAAK,CAAC,+CAA+C,CAAC;QACpE;QACA,OAAOW,EAAE;MACb;MACA,IAAMI,IAAI,GAAG,IAAIC,IAAI,CAACR,UAAU,CAAC;MACjC,IAAIO,IAAI,CAACE,WAAW,CAAC,CAAC,KAAKT,UAAU,EAAE;QACnC,MAAM,IAAIR,KAAK,CAAC,mFAAmF,CAAC;MACxG;MACA,OAAOe,IAAI,CAACG,OAAO,CAAC,CAAC,GAAGF,IAAI,CAACG,GAAG,CAAC,CAAC;IACtC;IACA,OAAO,IAAI;EACf;AACJ;AAEA,OAAO,MAAMC,UAAU,SAASrB,SAAS,CAAC;EAQtC;AACJ;AACA;AACA;AACA;AACA;AACA;EACWE,WAAWA,CAAA,EAMhB;IAAA,IALEoB,SAAqB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAA,IAC1BnB,UAAmB,GAAAmB,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IACZC,GAAY,GAAAH,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IACZE,KAAkB,GAAAJ,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IACzBpB,WAAqB,GAAAkB,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAErB,IAAIG,OAAO,GAAGN,SAAS,CAACO,KAAK,IAAI,iBAAiB;IAClD,IAAIzB,UAAU,EAAE;MACZwB,OAAO,OAAAE,MAAA,CAAO1B,UAAU,QAAA0B,MAAA,CAAKF,OAAO,CAAE;IAC1C;IACA,IAAIF,GAAG,EAAE;MACLE,OAAO,MAAAE,MAAA,CAAMF,OAAO,QAAAE,MAAA,CAAKJ,GAAG,MAAG;IACnC;IACA,KAAK,gBAAAI,MAAA,CAAgBF,OAAO,GAAIxB,UAAU,EAAEC,WAAW,CAAC;IAAC,KAXlDqB,GAAY,GAAZA,GAAY;IAAA,KACZC,KAAkB,GAAlBA,KAAkB;IAlB7B;IAAAI,eAAA;IAEA;IAAAA,eAAA;IAEA;IAAAA,eAAA;IAyBI,IAAI,CAACC,OAAO,GAAGV,SAAS,CAACU,OAAO;IAChC,IAAI,CAACH,KAAK,GAAGP,SAAS,CAACO,KAAK;IAC5B,IAAI,CAACI,IAAI,GAAGX,SAAS,CAACU,OAAO,IAAI,oBAAoB;IACrD,IAAI,CAACE,IAAI,GAAGZ,SAAS;EACzB;EAEOhB,gBAAgBA,CAAA,EAAY;IAC/B,OACI,IAAI,CAAC0B,OAAO,KAAK,kBAAkB,IAClC,CAAC,IAAI,CAACA,OAAO,KAAK,WAAW,IAAI,IAAI,CAACA,OAAO,KAAKP,SAAS,KAAK,KAAK,CAACnB,gBAAgB,CAAC,CAAE;EAElG;EAEOC,eAAeA,CAAA,EAAkB;IACpC,IAAM4B,WAAW,GAAG,KAAK,CAAC5B,eAAe,CAAC,CAAC;IAC3C,IAAI4B,WAAW,KAAK,IAAI,EAAE;MACtB,OAAOA,WAAW;IACtB;IACA;IACA,IAAI,IAAI,CAACH,OAAO,KAAK,kBAAkB,IAAI,gBAAgB,IAAI,IAAI,CAACE,IAAI,EAAE;MACtE,IAAI,CAACrB,MAAM,CAACuB,SAAS,CAAC,IAAI,CAACF,IAAI,CAACG,cAAc,CAAC,EAAE;QAC7C,MAAM,IAAIpC,KAAK,CAAC,kCAAkC,CAAC;MACvD;MACA,OAAO,IAAI,CAACiC,IAAI,CAACG,cAAc;IACnC;IACA,OAAO,IAAI;EACf;;EAEA;AACJ;AACA;AACA;EACWC,oBAAoBA,CAAA,EAAsB;IAAA,IAAAC,gBAAA,EAAAC,SAAA,EAAAC,aAAA,EAAAC,gBAAA;IAC7C,IAAMC,OAA+B,GAAG,CAAC,CAAC;IAC1C,IAAI,IAAI,CAACtC,WAAW,EAAE;MAClB,KAAK,IAAM,CAAC4B,IAAI,EAAEW,KAAK,CAAC,IAAI,IAAI,CAACvC,WAAW,EAAE;QAC1CsC,OAAO,CAACV,IAAI,CAAC,GAAGW,KAAK;MACzB;IACJ;IACA,OAAO;MACHC,WAAW,GAAAN,gBAAA,GAAE,IAAI,CAACnC,UAAU,cAAAmC,gBAAA,cAAAA,gBAAA,GAAI,GAAG;MACnCO,YAAY,EAAEH,OAAO;MACrBjB,GAAG,GAAAc,SAAA,GAAE,IAAI,CAACd,GAAG,cAAAc,SAAA,cAAAA,SAAA,GAAI,EAAE;MACnBO,QAAQ,EAAAC,aAAA;QACJhB,OAAO,GAAAS,aAAA,GAAE,IAAI,CAACT,OAAO,cAAAS,aAAA,cAAAA,aAAA,GAAI,WAAW;QACpCZ,KAAK,GAAAa,gBAAA,GAAE,IAAI,CAACR,IAAI,CAACL,KAAK,cAAAa,gBAAA,cAAAA,gBAAA,GAAI;MAAiB,GACxC,IAAI,CAACR,IAAI;IAEpB,CAAC;EACL;;EAEA;AACJ;AACA;AACA;EACI,OAAce,sBAAsBA,CAACf,IAAuB,EAAc;IACtE,OAAO,IAAIb,UAAU,CAACa,IAAI,CAACa,QAAQ,EAAEb,IAAI,CAACW,WAAW,EAAEX,IAAI,CAACR,GAAG,EAAED,SAAS,EAAE,IAAIyB,OAAO,CAAChB,IAAI,CAACY,YAAY,CAAC,CAAC;EAC/G;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,mBAAmBA,CAACtB,KAAc,EAAEuB,SAAiB,EAAU;EAC3E,IAAI,EAAEvB,KAAK,YAAY7B,SAAS,CAAC,IAAI,CAAC6B,KAAK,CAACvB,gBAAgB,CAAC,CAAC,EAAE;IAC5D,OAAO8C,SAAS;EACpB;EACA,IAAI;IAAA,IAAAC,qBAAA;IACA,QAAAA,qBAAA,GAAOxB,KAAK,CAACtB,eAAe,CAAC,CAAC,cAAA8C,qBAAA,cAAAA,qBAAA,GAAID,SAAS;EAC/C,CAAC,CAAC,OAAAE,OAAA,EAAM;IACJ,OAAOF,SAAS;EACpB;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMG,eAAe,SAAStD,KAAK,CAAC;EAChCC,WAAWA,CAAC0B,OAAe,EAAE4B,KAAa,EAAE;IAC/C,KAAK,CAAC5B,OAAO,IAAI4B,KAAK,QAAA1B,MAAA,CAAQ0B,KAAK,CAAC5B,OAAO,IAAK,EAAE,CAAC,CAAC;EACxD;EAEA,IAAWK,IAAIA,CAAA,EAAW;IACtB,OAAO,iBAAiB;EAC5B;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMwB,iBAAiB,SAASxD,KAAK,CAAC;EAClCC,WAAWA,CAACsD,KAAa,EAAE;IAAA,IAAAE,cAAA;IAC9B,KAAK,EAAAA,cAAA,GAACF,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAE5B,OAAO,cAAA8B,cAAA,cAAAA,cAAA,GAAI,EAAE,CAAC;EAC/B;EAEA,IAAWzB,IAAIA,CAAA,EAAW;IACtB,OAAO,mBAAmB;EAC9B;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAM0B,uBAAuB,SAAS1D,KAAK,CAAC;EACxCC,WAAWA,CAACsD,KAAa,EAAE;IAAA,IAAAI,eAAA;IAC9B,KAAK,EAAAA,eAAA,GAACJ,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAE5B,OAAO,cAAAgC,eAAA,cAAAA,eAAA,GAAI,EAAE,CAAC;EAC/B;EAEA,IAAW3B,IAAIA,CAAA,EAAW;IACtB,OAAO,yBAAyB;EACpC;AACJ;AAEA,OAAO,IAAM4B,oBAAoB,GAAG,IAAI9D,eAAe,CAAC,IAAI,EAAE,2BAA2B,CAAC;;AAE1F;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM+D,gBAAgB,SAASzC,UAAU,CAAC;EAUtCnB,WAAWA,CAAA,EAAqD;IACnE,KAAK,CAAC,GAAAqB,SAAQ,CAAC;IAVnB;AACJ;AACA;AACA;IAHIQ,eAAA;IAKA;AACJ;AACA;IAFIA,eAAA;IAMI,IAAMgC,IAAI,GAAAxC,SAAA,CAAAC,MAAA,QAAAC,SAAA,GAAAF,SAAA,GAAW;IAErB,IAAI,CAACyC,KAAK,GAAG,IAAIC,GAAG,CAACF,IAAI,IAAI,OAAO,IAAIA,IAAI,IAAIG,KAAK,CAACC,OAAO,CAACJ,IAAI,CAACC,KAAK,CAAC,GAAGD,IAAI,CAACC,KAAK,GAAG,EAAE,CAAC;IAC5F,IAAI,CAACpC,OAAO,MAAAE,MAAA,CAAM,KAAK,CAACF,OAAO,QAAAE,MAAA,CAAK,CAAC,GAAG,IAAI,CAACkC,KAAK,CAAC,CAACI,IAAI,CAAC,IAAI,CAAC,MAAG;IACjE,IAAIL,IAAI,IAAI,QAAQ,IAAIA,IAAI,IAAI,OAAOA,IAAI,CAACM,MAAM,KAAK,QAAQ,EAAE;MAC7D,IAAI,CAACA,MAAM,GAAG,IAAIpD,IAAI,CAAC8C,IAAI,CAACM,MAAM,CAAC;IACvC;EACJ;AACJ","ignoreList":[]}

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

@@ -0,0 +1,80 @@
+import { type TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { Method } from "./method.ts";
+import { type BaseRequestOpts, HttpApiEvent, type HttpApiEventHandlerMap, type IHttpOpts, type IRequestOpts, type Body } from "./interface.ts";
+import { type QueryDict } from "../utils.ts";
+export declare class FetchHttpApi<O extends IHttpOpts> {
+    private eventEmitter;
+    readonly opts: O;
+    private abortController;
+    private readonly tokenRefresher;
+    constructor(eventEmitter: TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>, opts: O);
+    abort(): void;
+    fetch(resource: URL | string, options?: RequestInit): ReturnType<typeof globalThis.fetch>;
+    /**
+     * Sets the base URL for the identity server
+     * @param url - The new base url
+     */
+    setIdBaseUrl(url?: string): void;
+    idServerRequest<T extends object = Record<string, unknown>>(method: Method, path: string, params: Record<string, string | string[]> | undefined, prefix: string, accessToken?: string): Promise<T>;
+    /**
+     * Perform an authorised request to the homeserver.
+     * @param method - The HTTP method e.g. "GET".
+     * @param path - The HTTP path <b>after</b> the supplied prefix e.g.
+     * "/createRoom".
+     *
+     * @param queryParams - A dict of query params (these will NOT be
+     * urlencoded). If unspecified, there will be no query params.
+     *
+     * @param body - The HTTP JSON body.
+     *
+     * @param paramOpts - additional options.
+     * When `paramOpts.doNotAttemptTokenRefresh` is true, token refresh will not be attempted
+     * when an expired token is encountered. Used to only attempt token refresh once.
+     *
+     * @returns The parsed response.
+     * @throws Error if a problem occurred. This includes network problems and Matrix-specific error JSON.
+     */
+    authedRequest<T>(method: Method, path: string, queryParams?: QueryDict, body?: Body, paramOpts?: IRequestOpts): Promise<T>;
+    private doAuthedRequest;
+    /**
+     * Perform a request to the homeserver without any credentials.
+     * @param method - The HTTP method e.g. "GET".
+     * @param path - The HTTP path <b>after</b> the supplied prefix e.g.
+     * "/createRoom".
+     *
+     * @param queryParams - A dict of query params (these will NOT be
+     * urlencoded). If unspecified, there will be no query params.
+     *
+     * @param body - The HTTP JSON body.
+     *
+     * @param opts - additional options
+     *
+     * @returns The parsed response.
+     * @throws Error if a problem occurred. This includes network problems and Matrix-specific error JSON.
+     */
+    request<T>(method: Method, path: string, queryParams?: QueryDict, body?: Body, opts?: IRequestOpts): Promise<T>;
+    /**
+     * Perform a request to an arbitrary URL.
+     * @param method - The HTTP method e.g. "GET".
+     * @param url - The HTTP URL object.
+     *
+     * @param body - The HTTP JSON body.
+     *
+     * @param opts - additional options
+     *
+     * @returns The parsed response.
+     * @throws Error if a problem occurred. This includes network problems and Matrix-specific error JSON.
+     */
+    requestOtherUrl<T>(method: Method, url: URL | string, body?: Body, opts?: BaseRequestOpts): Promise<T>;
+    private sanitizeUrlForLogs;
+    /**
+     * Form and return a homeserver request URL based on the given path params and prefix.
+     * @param path - The HTTP path <b>after</b> the supplied prefix e.g. "/createRoom".
+     * @param queryParams - A dict of query params (these will NOT be urlencoded).
+     * @param prefix - The full prefix to use e.g. "/_matrix/client/v2_alpha", defaulting to this.opts.prefix.
+     * @param baseUrl - The baseUrl to use e.g. "https://matrix.org", defaulting to this.opts.baseUrl.
+     * @returns URL
+     */
+    getUrl(path: string, queryParams?: QueryDict, prefix?: string, baseUrl?: string): URL;
+}
+//# sourceMappingURL=fetch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/http-api/fetch.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EACH,KAAK,eAAe,EACpB,YAAY,EACZ,KAAK,sBAAsB,EAC3B,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,IAAI,EACZ,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,qBAAa,YAAY,CAAC,CAAC,SAAS,SAAS;IAKrC,OAAO,CAAC,YAAY;aACJ,IAAI,EAAE,CAAC;IAL3B,OAAO,CAAC,eAAe,CAAyB;IAChD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;gBAGpC,YAAY,EAAE,iBAAiB,CAAC,YAAY,EAAE,sBAAsB,CAAC,EAC7D,IAAI,EAAE,CAAC;IAWpB,KAAK,IAAI,IAAI;IAKb,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC;IAOhG;;;OAGG;IACI,YAAY,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAIhC,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EACrD,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,CAAC,CAAC;IA0Bb;;;;;;;;;;;;;;;;;OAiBG;IACI,aAAa,CAAC,CAAC,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,WAAW,GAAE,SAAc,EAC3B,IAAI,CAAC,EAAE,IAAI,EACX,SAAS,GAAE,YAAiB,GAC7B,OAAO,CAAC,CAAC,CAAC;YAKC,eAAe;IA4D7B;;;;;;;;;;;;;;;OAeG;IACI,OAAO,CAAC,CAAC,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,SAAS,EACvB,IAAI,CAAC,EAAE,IAAI,EACX,IAAI,CAAC,EAAE,YAAY,GACpB,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;;;;;;;OAWG;IACU,eAAe,CAAC,CAAC,EAC1B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,GAAG,GAAG,MAAM,EACjB,IAAI,CAAC,EAAE,IAAI,EACX,IAAI,GAAE,eAAoB,GAC3B,OAAO,CAAC,CAAC,CAAC;IA8Fb,OAAO,CAAC,kBAAkB;IAsB1B;;;;;;;OAOG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG;CAc/F"}