matrix-js-sdk 41.8.0 → 41.9.0

package/lib/utils.js

@@ -1,8 +1,4 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-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; }
+import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 /*
 Copyright 2015, 2016, 2019, 2023 The Matrix.org Foundation C.I.C.
 
@@ -27,7 +23,7 @@ import unhomoglyph from "unhomoglyph";
 import promiseRetry from "p-retry";
 import { M_TIMESTAMP } from "./@types/location.js";
 import { ReceiptType } from "./@types/read_receipts.js";
-var interns = new Map();
+const interns = new Map();
 
 /**
  * Internalises a string, reusing a known pointer or storing the pointer
@@ -59,24 +55,17 @@ export function internaliseString(str) {
  * @returns The encoded string e.g. foo=bar&baz=taz
  */
 export function encodeParams(params, urlSearchParams) {
-  var searchParams = urlSearchParams !== null && urlSearchParams !== void 0 ? urlSearchParams : new URLSearchParams();
-  var _loop = function _loop() {
-      _ref2 = _slicedToArray(_ref3, 2);
-      var key = _ref2[0];
-      var val = _ref2[1];
-      if (val !== undefined && val !== null) {
-        if (Array.isArray(val)) {
-          val.forEach(v => {
-            searchParams.append(key, String(v));
-          });
-        } else {
-          searchParams.append(key, String(val));
-        }
+  const searchParams = urlSearchParams ?? new URLSearchParams();
+  for (const [key, val] of Object.entries(params)) {
+    if (val !== undefined && val !== null) {
+      if (Array.isArray(val)) {
+        val.forEach(v => {
+          searchParams.append(key, String(v));
+        });
+      } else {
+        searchParams.append(key, String(val));
       }
-    },
-    _ref2;
-  for (var _ref3 of Object.entries(params)) {
-    _loop();
+    }
   }
   return searchParams;
 }
@@ -84,7 +73,7 @@ export function encodeParams(params, urlSearchParams) {
  * Replace a stable parameter with the unstable naming for params
  */
 export function replaceParam(stable, unstable, dict) {
-  var result = _objectSpread(_objectSpread({}, dict), {}, {
+  const result = _objectSpread(_objectSpread({}, dict), {}, {
     [unstable]: dict[stable]
   });
   delete result[stable];
@@ -101,10 +90,10 @@ export function replaceParam(stable, unstable, dict) {
  * for native web compatibility
  */
 export function decodeParams(query) {
-  var o = {};
-  var params = new URLSearchParams(query);
-  for (var key of params.keys()) {
-    var val = params.getAll(key);
+  const o = {};
+  const params = new URLSearchParams(query);
+  for (const key of params.keys()) {
+    const val = params.getAll(key);
     o[key] = val.length === 1 ? val[0] : val;
   }
   return o;
@@ -119,11 +108,11 @@ export function decodeParams(query) {
  * @returns The result of replacing all template variables e.g. '/foo/baz'.
  */
 export function encodeUri(pathTemplate, variables) {
-  for (var key in variables) {
+  for (const key in variables) {
     if (!variables.hasOwnProperty(key)) {
       continue;
     }
-    var value = variables[key];
+    const value = variables[key];
     if (value === undefined || value === null) {
       continue;
     }
@@ -143,7 +132,7 @@ export function encodeUri(pathTemplate, variables) {
  * @returns True if an element was removed.
  */
 export function removeElement(array, fn, reverse) {
-  var i;
+  let i;
   if (reverse) {
     for (i = array.length - 1; i >= 0; i--) {
       if (fn(array[i], i, array)) {
@@ -179,7 +168,7 @@ export function isFunction(value) {
  */
 // note using 'keys' here would shadow the 'keys' function defined above
 export function checkObjectHasKeys(obj, keys) {
-  for (var key of keys) {
+  for (const key of keys) {
     if (!obj.hasOwnProperty(key)) {
       throw new Error("Missing required key: " + key);
     }
@@ -252,22 +241,22 @@ export function deepCompare(x, y) {
     if (x.length !== y.length) {
       return false;
     }
-    for (var i = 0; i < x.length; i++) {
+    for (let i = 0; i < x.length; i++) {
       if (!deepCompare(x[i], y[i])) {
         return false;
       }
     }
   } else {
     // check that all of y's direct keys are in x
-    for (var p in y) {
+    for (const p in y) {
       if (y.hasOwnProperty(p) !== x.hasOwnProperty(p)) {
         return false;
       }
     }
 
     // finally, compare each of x's keys with y
-    for (var _p in x) {
-      if (y.hasOwnProperty(_p) !== x.hasOwnProperty(_p) || !deepCompare(x[_p], y[_p])) {
+    for (const p in x) {
+      if (y.hasOwnProperty(p) !== x.hasOwnProperty(p) || !deepCompare(x[p], y[p])) {
         return false;
       }
     }
@@ -289,11 +278,8 @@ export function deepSortedObjectEntries(obj) {
 
   // Apparently these are object types...
   if (obj === null || obj === undefined || Array.isArray(obj)) return obj;
-  var pairs = [];
-  for (var _ref6 of Object.entries(obj)) {
-    var _ref5 = _slicedToArray(_ref6, 2);
-    var k = _ref5[0];
-    var v = _ref5[1];
+  const pairs = [];
+  for (const [k, v] of Object.entries(obj)) {
     pairs.push([k, deepSortedObjectEntries(v)]);
   }
 
@@ -355,7 +341,7 @@ export function normalize(str) {
 // Zero width no-break space (BOM) U+FEFF
 // Blank/invisible characters (U2800, U2062-U2063)
 // eslint-disable-next-line no-misleading-character-class
-var removeHiddenCharsRegex = /[\u2000-\u200F\u202A-\u202F\u0300-\u036F\uFEFF\u061C\u2800\u2062-\u2063\s]/g;
+const removeHiddenCharsRegex = /[\u2000-\u200F\u202A-\u202F\u0300-\u036F\uFEFF\u061C\u2800\u2062-\u2063\s]/g;
 export function escapeRegExp(string) {
   return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
@@ -370,7 +356,7 @@ export function globToRegexp(glob) {
   return escapeRegExp(glob).replace(/\\\*/g, ".*").replace(/\?/g, ".");
 }
 export function ensureNoTrailingSlash(url) {
-  if (url !== null && url !== void 0 && url.endsWith("/")) {
+  if (url?.endsWith("/")) {
     return url.slice(0, -1);
   } else {
     return url;
@@ -393,8 +379,14 @@ export function sleep(ms, value) {
  * @param name - The name of the operation.
  * @param block - The block to execute.
  */
-export function logDuration(_x, _x2, _x3) {
-  return _logDuration.apply(this, arguments);
+export async function logDuration(logger, name, block) {
+  const start = Date.now();
+  try {
+    return await block();
+  } finally {
+    const end = Date.now();
+    logger.debug(`[Perf]: ${name} took ${end - start}ms`);
+  }
 }
 
 /**
@@ -404,25 +396,13 @@ export function logDuration(_x, _x2, _x3) {
  * @param name - The name of the operation.
  * @param block - The block to execute.
  */
-function _logDuration() {
-  _logDuration = _asyncToGenerator(function* (logger, name, block) {
-    var start = Date.now();
-    try {
-      return yield block();
-    } finally {
-      var end = Date.now();
-      logger.debug("[Perf]: ".concat(name, " took ").concat(end - start, "ms"));
-    }
-  });
-  return _logDuration.apply(this, arguments);
-}
 export function logDurationSync(logger, name, block) {
-  var start = Date.now();
+  const start = Date.now();
   try {
     return block();
   } finally {
-    var end = Date.now();
-    logger.debug("[Perf]: ".concat(name, " took ").concat(end - start, "ms"));
+    const end = Date.now();
+    logger.debug(`[Perf]: ${name} took ${end - start}ms`);
   }
 }
 
@@ -438,25 +418,23 @@ export function immediate() {
 export function isNullOrUndefined(val) {
   return val === null || val === undefined;
 }
-export function promiseMapSeries(_x4, _x5) {
-  return _promiseMapSeries.apply(this, arguments);
-}
-function _promiseMapSeries() {
-  _promiseMapSeries = _asyncToGenerator(function* (promises, fn // if async we don't care about the type as we only await resolution
-  ) {
-    for (var o of promises) {
-      yield fn(yield o);
-    }
-  });
-  return _promiseMapSeries.apply(this, arguments);
+export async function promiseMapSeries(promises, fn // if async we don't care about the type as we only await resolution
+) {
+  for (const o of promises) {
+    await fn(await o);
+  }
 }
 export function promiseTry(fn) {
   return Promise.resolve(fn());
 }
 
 // Creates and awaits all promises, running no more than `chunkSize` at the same time
-export function chunkPromises(_x6, _x7) {
-  return _chunkPromises.apply(this, arguments);
+export async function chunkPromises(fns, chunkSize) {
+  const results = [];
+  for (let i = 0; i < fns.length; i += chunkSize) {
+    results.push(...(await Promise.all(fns.slice(i, i + chunkSize).map(fn => fn()))));
+  }
+  return results;
 }
 
 /**
@@ -470,25 +448,14 @@ export function chunkPromises(_x6, _x7) {
  * retrying will ba aborted if this return false.
  * @returns The promise for the retried operation.
  */
-function _chunkPromises() {
-  _chunkPromises = _asyncToGenerator(function* (fns, chunkSize) {
-    var results = [];
-    for (var i = 0; i < fns.length; i += chunkSize) {
-      results.push(...(yield Promise.all(fns.slice(i, i + chunkSize).map(fn => fn()))));
-    }
-    return results;
-  });
-  return _chunkPromises.apply(this, arguments);
-}
 export function simpleRetryOperation(promiseFn, shouldRetry) {
   return promiseRetry(attempt => {
     return promiseFn(attempt);
   }, {
     retries: Infinity,
-    shouldRetry: shouldRetry ? _ref7 => {
-      var error = _ref7.error;
-      return shouldRetry(error);
-    } : undefined,
+    shouldRetry: shouldRetry ? ({
+      error
+    }) => shouldRetry(error) : undefined,
     factor: 2,
     minTimeout: 3000,
     // ms
@@ -505,9 +472,9 @@ export function simpleRetryOperation(promiseFn, shouldRetry) {
  * The default alphabet used by string averaging in this SDK. This matches
  * all usefully printable ASCII characters (0x20-0x7E, inclusive).
  */
-export var DEFAULT_ALPHABET = (() => {
-  var str = "";
-  for (var c = 0x20; c <= 0x7e; c++) {
+export const DEFAULT_ALPHABET = (() => {
+  let str = "";
+  for (let c = 0x20; c <= 0x7e; c++) {
     str += String.fromCharCode(c);
   }
   return str;
@@ -523,8 +490,7 @@ export var DEFAULT_ALPHABET = (() => {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The padded string.
  */
-export function alphabetPad(s, n) {
-  var alphabet = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_ALPHABET;
+export function alphabetPad(s, n, alphabet = DEFAULT_ALPHABET) {
   return s.padEnd(n, alphabet[0]);
 }
 
@@ -536,21 +502,19 @@ export function alphabetPad(s, n) {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The baseN number encoded as a string from the alphabet.
  */
-export function baseToString(n) {
-  var alphabet = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_ALPHABET;
+export function baseToString(n, alphabet = DEFAULT_ALPHABET) {
   // Developer note: the stringToBase() function offsets the character set by 1 so that repeated
   // characters (ie: "aaaaaa" in a..z) don't come out as zero. We have to reverse this here as
   // otherwise we'll be wrong in our conversion. Undoing a +1 before an exponent isn't very fun
   // though, so we rely on a lengthy amount of `x - 1` and integer division rules to reach a
   // sane state. This also means we have to do rollover detection: see below.
 
-  var len = BigInt(alphabet.length);
+  const len = BigInt(alphabet.length);
   if (n <= len) {
-    var _alphabet;
-    return (_alphabet = alphabet[Number(n) - 1]) !== null && _alphabet !== void 0 ? _alphabet : "";
+    return alphabet[Number(n) - 1] ?? "";
   }
-  var d = n / len;
-  var r = Number(n % len) - 1;
+  let d = n / len;
+  let r = Number(n % len) - 1;
 
   // Rollover detection: if the remainder is negative, it means that the string needs
   // to roll over by 1 character downwards (ie: in a..z, the previous to "aaa" would be
@@ -570,9 +534,8 @@ export function baseToString(n) {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The baseN number.
  */
-export function stringToBase(s) {
-  var alphabet = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_ALPHABET;
-  var len = BigInt(alphabet.length);
+export function stringToBase(s, alphabet = DEFAULT_ALPHABET) {
+  const len = BigInt(alphabet.length);
 
   // In our conversion to baseN we do a couple performance optimizations to avoid using
   // excess CPU and such. To create baseN numbers, the input string needs to be reversed
@@ -586,9 +549,9 @@ export function stringToBase(s) {
   // Developer caution: we carefully cast to BigInt here to avoid losing precision. We cannot
   // rely on Math.pow() (for example) to be capable of handling our insane numbers.
 
-  var result = BigInt(0);
-  for (var i = s.length - 1, j = BigInt(0); i >= 0; i--, j++) {
-    var charIndex = s.charCodeAt(i) - alphabet.charCodeAt(0);
+  let result = BigInt(0);
+  for (let i = s.length - 1, j = BigInt(0); i >= 0; i--, j++) {
+    const charIndex = s.charCodeAt(i) - alphabet.charCodeAt(0);
 
     // We add 1 to the char index to offset the whole numbering scheme. We unpack this in
     // the baseToString() function.
@@ -606,12 +569,11 @@ export function stringToBase(s) {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The midpoint between the strings, as a string.
  */
-export function averageBetweenStrings(a, b) {
-  var alphabet = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_ALPHABET;
-  var padN = Math.max(a.length, b.length);
-  var baseA = stringToBase(alphabetPad(a, padN, alphabet), alphabet);
-  var baseB = stringToBase(alphabetPad(b, padN, alphabet), alphabet);
-  var avg = (baseA + baseB) / BigInt(2);
+export function averageBetweenStrings(a, b, alphabet = DEFAULT_ALPHABET) {
+  const padN = Math.max(a.length, b.length);
+  const baseA = stringToBase(alphabetPad(a, padN, alphabet), alphabet);
+  const baseB = stringToBase(alphabetPad(b, padN, alphabet), alphabet);
+  const avg = (baseA + baseB) / BigInt(2);
 
   // Detect integer division conflicts. This happens when two numbers are divided too close so
   // we lose a .5 precision. We need to add a padding character in these cases.
@@ -629,8 +591,7 @@ export function averageBetweenStrings(a, b) {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The string which follows the input string.
  */
-export function nextString(s) {
-  var alphabet = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_ALPHABET;
+export function nextString(s, alphabet = DEFAULT_ALPHABET) {
   return baseToString(stringToBase(s, alphabet) + BigInt(1), alphabet);
 }
 
@@ -642,8 +603,7 @@ export function nextString(s) {
  * @param alphabet - The alphabet to use as a single string.
  * @returns The string which precedes the input string.
  */
-export function prevString(s) {
-  var alphabet = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_ALPHABET;
+export function prevString(s, alphabet = DEFAULT_ALPHABET) {
   return baseToString(stringToBase(s, alphabet) - BigInt(1), alphabet);
 }
 
@@ -672,12 +632,8 @@ export function lexicographicCompare(a, b) {
  *
  * @returns the target object
  */
-export function recursivelyAssign(target, source) {
-  var ignoreNullish = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-  for (var _ref0 of Object.entries(source)) {
-    var _ref9 = _slicedToArray(_ref0, 2);
-    var sourceKey = _ref9[0];
-    var sourceValue = _ref9[1];
+export function recursivelyAssign(target, source, ignoreNullish = false) {
+  for (const [sourceKey, sourceValue] of Object.entries(source)) {
     if (target[sourceKey] instanceof Object && sourceValue) {
       recursivelyAssign(target[sourceKey], sourceValue);
       continue;
@@ -690,8 +646,7 @@ export function recursivelyAssign(target, source) {
   return target;
 }
 function getContentTimestampWithFallback(event) {
-  var _M_TIMESTAMP$findIn;
-  return (_M_TIMESTAMP$findIn = M_TIMESTAMP.findIn(event.getContent())) !== null && _M_TIMESTAMP$findIn !== void 0 ? _M_TIMESTAMP$findIn : -1;
+  return M_TIMESTAMP.findIn(event.getContent()) ?? -1;
 }
 
 /**
@@ -709,14 +664,10 @@ export function isSupportedReceiptType(receiptType) {
  * Determines whether two maps are equal.
  * @param eq - The equivalence relation to compare values by. Defaults to strict equality.
  */
-export function mapsEqual(x, y) {
-  var eq = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : (v1, v2) => v1 === v2;
+export function mapsEqual(x, y, eq = (v1, v2) => v1 === v2) {
   if (x.size !== y.size) return false;
-  for (var _ref11 of x) {
-    var _ref10 = _slicedToArray(_ref11, 2);
-    var k = _ref10[0];
-    var v1 = _ref10[1];
-    var v2 = y.get(k);
+  for (const [k, v1] of x) {
+    const v2 = y.get(k);
     if (v2 === undefined || !eq(v1, v2)) return false;
   }
   return true;
@@ -738,11 +689,8 @@ function processMapToObjectValue(value) {
  * Also supports sub-lists of Maps.
  */
 export function recursiveMapToObject(map) {
-  var targetMap = new Map();
-  for (var _ref14 of map) {
-    var _ref13 = _slicedToArray(_ref14, 2);
-    var key = _ref13[0];
-    var value = _ref13[1];
+  const targetMap = new Map();
+  for (const [key, value] of map) {
     targetMap.set(key, processMapToObjectValue(value));
   }
   return Object.fromEntries(targetMap.entries());