matrix-js-sdk 41.8.0 → 41.9.0

package/lib/pushprocessor.js

@@ -1,7 +1,5 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 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 2015 - 2021 The Matrix.org Foundation C.I.C.
 
@@ -21,7 +19,7 @@ limitations under the License.
 import { deepCompare, escapeRegExp, globToRegexp, isNullOrUndefined } from "./utils.js";
 import { ConditionKind, PushRuleActionName, PushRuleKind, RuleId, TweakName } from "./@types/PushRules.js";
 import { EventType } from "./@types/event.js";
-var RULEKINDS_IN_ORDER = [PushRuleKind.Override, PushRuleKind.ContentSpecific, PushRuleKind.RoomSpecific, PushRuleKind.SenderSpecific, PushRuleKind.Underride];
+const RULEKINDS_IN_ORDER = [PushRuleKind.Override, PushRuleKind.ContentSpecific, PushRuleKind.RoomSpecific, PushRuleKind.SenderSpecific, PushRuleKind.Underride];
 
 // The default override rules to apply to the push rules that arrive from the server.
 // We do this for two reasons:
@@ -30,7 +28,7 @@ var RULEKINDS_IN_ORDER = [PushRuleKind.Override, PushRuleKind.ContentSpecific, P
 //      more details.
 //   2. We often want to start using push rules ahead of the server supporting them,
 //      and so we can put them here.
-var DEFAULT_OVERRIDE_RULES = {
+const DEFAULT_OVERRIDE_RULES = {
   ".m.rule.is_room_mention": {
     // Matrix v1.7
     rule_id: ".m.rule.is_room_mention",
@@ -79,9 +77,9 @@ var DEFAULT_OVERRIDE_RULES = {
 };
 
 // A special rule id for `EXPECTED_DEFAULT_OVERRIDE_RULE_IDS` and friends which denotes where user-defined rules live in the order.
-var UserDefinedRules = Symbol("UserDefinedRules");
-var EXPECTED_DEFAULT_OVERRIDE_RULE_IDS = [RuleId.Master, UserDefinedRules, RuleId.SuppressNotices, RuleId.InviteToSelf, RuleId.MemberEvent, RuleId.IsUserMention, RuleId.ContainsDisplayName, RuleId.IsRoomMention, RuleId.AtRoomNotification, RuleId.Tombstone, ".m.rule.reaction", ".m.rule.room.server_acl", ".org.matrix.msc3786.rule.room.server_acl", ".m.rule.suppress_edits"];
-var DEFAULT_UNDERRIDE_RULES = {
+const UserDefinedRules = Symbol("UserDefinedRules");
+const EXPECTED_DEFAULT_OVERRIDE_RULE_IDS = [RuleId.Master, UserDefinedRules, RuleId.SuppressNotices, RuleId.InviteToSelf, RuleId.MemberEvent, RuleId.IsUserMention, RuleId.ContainsDisplayName, RuleId.IsRoomMention, RuleId.AtRoomNotification, RuleId.Tombstone, ".m.rule.reaction", ".m.rule.room.server_acl", ".org.matrix.msc3786.rule.room.server_acl", ".m.rule.suppress_edits"];
+const DEFAULT_UNDERRIDE_RULES = {
   ".org.matrix.msc3914.rule.room.call": {
     // For homeservers which don't support MSC3914 yet
     rule_id: ".org.matrix.msc3914.rule.room.call",
@@ -100,7 +98,7 @@ var DEFAULT_UNDERRIDE_RULES = {
     }]
   }
 };
-var EXPECTED_DEFAULT_UNDERRIDE_RULE_IDS = [UserDefinedRules, RuleId.IncomingCall, ".org.matrix.msc3914.rule.room.call", RuleId.EncryptedDM, RuleId.DM, RuleId.Message, RuleId.EncryptedMessage];
+const EXPECTED_DEFAULT_UNDERRIDE_RULE_IDS = [UserDefinedRules, RuleId.IncomingCall, ".org.matrix.msc3914.rule.room.call", RuleId.EncryptedDM, RuleId.DM, RuleId.Message, RuleId.EncryptedMessage];
 
 /**
  * Make sure that each of the rules listed in `defaultRuleIds` is listed in the given set of push rules.
@@ -115,24 +113,24 @@ var EXPECTED_DEFAULT_UNDERRIDE_RULE_IDS = [UserDefinedRules, RuleId.IncomingCall
  */
 function mergeRulesWithDefaults(logger, kind, incomingRules, defaultRules, orderedRuleIds) {
   // Split the incomingRules into defaults and custom
-  var incomingDefaultRules = incomingRules.filter(rule => rule.default);
-  var incomingCustomRules = incomingRules.filter(rule => !rule.default);
+  const incomingDefaultRules = incomingRules.filter(rule => rule.default);
+  const incomingCustomRules = incomingRules.filter(rule => !rule.default);
   function insertDefaultPushRule(ruleId) {
     if (ruleId === UserDefinedRules) {
       // Re-insert any user-defined rules that were in `incomingRules`
       newRules.push(...incomingCustomRules);
     } else if (ruleId in defaultRules) {
-      logger.warn("Adding default global ".concat(kind, " push rule ").concat(ruleId));
+      logger.warn(`Adding default global ${kind} push rule ${ruleId}`);
       newRules.push(defaultRules[ruleId]);
     } else {
-      logger.warn("Missing default global ".concat(kind, " push rule ").concat(ruleId));
+      logger.warn(`Missing default global ${kind} push rule ${ruleId}`);
     }
   }
-  var nextExpectedRuleIdIndex = 0;
-  var newRules = [];
+  let nextExpectedRuleIdIndex = 0;
+  const newRules = [];
   // Merge our expected rules (including the incoming custom rules) into the incoming default rules.
-  for (var rule of incomingDefaultRules) {
-    var ruleIndex = orderedRuleIds.indexOf(rule.rule_id);
+  for (const rule of incomingDefaultRules) {
+    const ruleIndex = orderedRuleIds.indexOf(rule.rule_id);
     if (ruleIndex === -1) {
       // an unrecognised rule; copy it over
       newRules.push(rule);
@@ -140,7 +138,7 @@ function mergeRulesWithDefaults(logger, kind, incomingRules, defaultRules, order
     }
     while (ruleIndex > nextExpectedRuleIdIndex) {
       // insert new rules
-      var defaultRuleId = orderedRuleIds[nextExpectedRuleIdIndex];
+      const defaultRuleId = orderedRuleIds[nextExpectedRuleIdIndex];
       insertDefaultPushRule(defaultRuleId);
       nextExpectedRuleIdIndex += 1;
     }
@@ -150,7 +148,7 @@ function mergeRulesWithDefaults(logger, kind, incomingRules, defaultRules, order
   }
 
   // Now copy over any remaining default rules
-  for (var ruleId of orderedRuleIds.slice(nextExpectedRuleIdIndex)) {
+  for (const ruleId of orderedRuleIds.slice(nextExpectedRuleIdIndex)) {
     insertDefaultPushRule(ruleId);
   }
   return newRules;
@@ -161,12 +159,12 @@ export class PushProcessor {
    * @param client - The Matrix client object to use
    */
   constructor(client) {
-    this.client = client;
     /**
      * Maps the original key from the push rules to a list of property names
      * after unescaping.
      */
     _defineProperty(this, "parsedKeys", new Map());
+    this.client = client;
   }
   /**
    * Convert a list of actions into a object with the actions as keys and their values
@@ -178,11 +176,11 @@ export class PushProcessor {
    * @returns A object with key 'notify' (true or false) and an object of actions
    */
   static actionListToActionsObject(actionList) {
-    var actionObj = {
+    const actionObj = {
       notify: false,
       tweaks: {}
     };
-    for (var action of actionList) {
+    for (const action of actionList) {
       if (action === PushRuleActionName.Notify) {
         actionObj.notify = true;
       } else if (typeof action === "object") {
@@ -205,9 +203,8 @@ export class PushProcessor {
    * @param userId - The Matrix ID of the client.
    * @returns The rewritten rules
    */
-  static rewriteDefaultRules(logger, incomingRules) {
-    var userId = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
-    var newRules = JSON.parse(JSON.stringify(incomingRules)); // deep clone
+  static rewriteDefaultRules(logger, incomingRules, userId = undefined) {
+    let newRules = JSON.parse(JSON.stringify(incomingRules)); // deep clone
 
     // These lines are mostly to make the tests happy. We shouldn't run into these
     // properties missing in practice.
@@ -231,14 +228,9 @@ export class PushProcessor {
    *     as specified for `content.body` matches, will use lookaround assertions to ensure the match only includes the pattern
    * @param flags - the flags to pass to the RegExp constructor, defaults to case-insensitive
    */
-  static getPushRuleGlobRegex(pattern) {
-    var alignToWordBoundary = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    var flags = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "i";
-    var _ref = alignToWordBoundary ? ["(?<=^|\\W)", "(?=\\W|$)"] : ["^", "$"],
-      _ref2 = _slicedToArray(_ref, 2),
-      prefix = _ref2[0],
-      suffix = _ref2[1];
-    var cacheKey = "".concat(alignToWordBoundary, "-").concat(flags, "-").concat(pattern);
+  static getPushRuleGlobRegex(pattern, alignToWordBoundary = false, flags = "i") {
+    const [prefix, suffix] = alignToWordBoundary ? ["(?<=^|\\W)", "(?=\\W|$)"] : ["^", "$"];
+    const cacheKey = `${alignToWordBoundary}-${flags}-${pattern}`;
     if (!PushProcessor.cachedGlobToRegex[cacheKey]) {
       PushProcessor.cachedGlobToRegex[cacheKey] = new RegExp(prefix + "(" + globToRegexp(pattern) + ")" + suffix, flags);
     }
@@ -262,13 +254,13 @@ export class PushProcessor {
 
     // Process the 'key' property on event_match conditions pre-cache the
     // values and clean-out any unused values.
-    var toRemoveKeys = new Set(this.parsedKeys.keys());
-    for (var ruleset of [newRules.global.override, newRules.global.room, newRules.global.sender, newRules.global.underride]) {
-      for (var rule of ruleset) {
+    const toRemoveKeys = new Set(this.parsedKeys.keys());
+    for (const ruleset of [newRules.global.override, newRules.global.room, newRules.global.sender, newRules.global.underride]) {
+      for (const rule of ruleset) {
         if (!rule.conditions) {
           continue;
         }
-        for (var condition of rule.conditions) {
+        for (const condition of rule.conditions) {
           if (condition.kind !== ConditionKind.EventMatch) {
             continue;
           }
@@ -288,16 +280,16 @@ export class PushProcessor {
   // $glob: RegExp
 
   matchingRuleFromKindSet(ev, kindset) {
-    for (var kind of RULEKINDS_IN_ORDER) {
-      var ruleset = kindset[kind];
+    for (const kind of RULEKINDS_IN_ORDER) {
+      const ruleset = kindset[kind];
       if (!ruleset) {
         continue;
       }
-      for (var rule of ruleset) {
+      for (const rule of ruleset) {
         if (!rule.enabled) {
           continue;
         }
-        var rawrule = this.templateRuleToRaw(kind, rule);
+        const rawrule = this.templateRuleToRaw(kind, rule);
         if (!rawrule) {
           continue;
         }
@@ -311,7 +303,7 @@ export class PushProcessor {
     return null;
   }
   templateRuleToRaw(kind, tprule) {
-    var rawrule = {
+    const rawrule = {
       rule_id: tprule.rule_id,
       actions: tprule.actions,
       conditions: []
@@ -379,12 +371,12 @@ export class PushProcessor {
     return false;
   }
   eventFulfillsSenderNotifPermCondition(cond, ev) {
-    var notifLevelKey = cond["key"];
+    const notifLevelKey = cond["key"];
     if (!notifLevelKey) {
       return false;
     }
-    var room = this.client.getRoom(ev.getRoomId());
-    if (!(room !== null && room !== void 0 && room.currentState)) {
+    const room = this.client.getRoom(ev.getRoomId());
+    if (!room?.currentState) {
       return false;
     }
 
@@ -397,17 +389,17 @@ export class PushProcessor {
     if (!cond.is) {
       return false;
     }
-    var room = this.client.getRoom(ev.getRoomId());
+    const room = this.client.getRoom(ev.getRoomId());
     if (!room || !room.currentState || !room.currentState.members) {
       return false;
     }
-    var memberCount = room.currentState.getJoinedMemberCount();
-    var m = cond.is.match(/^([=<>]*)(\d*)$/);
+    const memberCount = room.currentState.getJoinedMemberCount();
+    const m = cond.is.match(/^([=<>]*)(\d*)$/);
     if (!m) {
       return false;
     }
-    var ineq = m[1];
-    var rhs = parseInt(m[2]);
+    const ineq = m[1];
+    const rhs = parseInt(m[2]);
     if (isNaN(rhs)) {
       return false;
     }
@@ -428,24 +420,23 @@ export class PushProcessor {
     }
   }
   eventFulfillsDisplayNameCondition(cond, ev) {
-    var _room$currentState;
-    var content = ev.getContent();
+    let content = ev.getContent();
     if (ev.isEncrypted() && ev.getClearContent()) {
       content = ev.getClearContent();
     }
     if (!content || !content.body || typeof content.body != "string") {
       return false;
     }
-    var room = this.client.getRoom(ev.getRoomId());
-    var member = room === null || room === void 0 || (_room$currentState = room.currentState) === null || _room$currentState === void 0 ? void 0 : _room$currentState.getMember(this.client.credentials.userId);
+    const room = this.client.getRoom(ev.getRoomId());
+    const member = room?.currentState?.getMember(this.client.credentials.userId);
     if (!member) {
       return false;
     }
-    var displayName = member.name;
+    const displayName = member.name;
 
     // N.B. we can't use \b as it chokes on unicode. however \W seems to be okay
     // as shorthand for [^0-9A-Za-z_].
-    var pat = new RegExp("(^|\\W)" + escapeRegExp(displayName) + "(\\W|$)", "i");
+    const pat = new RegExp("(^|\\W)" + escapeRegExp(displayName) + "(\\W|$)", "i");
     return content.body.search(pat) > -1;
   }
 
@@ -460,7 +451,7 @@ export class PushProcessor {
     if (!cond.key) {
       return false;
     }
-    var val = this.valueForDottedKey(cond.key, ev);
+    const val = this.valueForDottedKey(cond.key, ev);
     if (typeof val !== "string") {
       return false;
     }
@@ -477,7 +468,7 @@ export class PushProcessor {
 
     // Align to word boundary on `content.body` matches, whole string otherwise
     // https://spec.matrix.org/v1.13/client-server-api/#conditions-1
-    var regex = PushProcessor.getPushRuleGlobRegex(cond.pattern, cond.key === "content.body");
+    const regex = PushProcessor.getPushRuleGlobRegex(cond.pattern, cond.key === "content.body");
     return !!val.match(regex);
   }
 
@@ -506,7 +497,7 @@ export class PushProcessor {
     if (!cond.key || cond.value === undefined) {
       return false;
     }
-    var val = this.valueForDottedKey(cond.key, ev);
+    const val = this.valueForDottedKey(cond.key, ev);
     if (!Array.isArray(val)) {
       return false;
     }
@@ -527,17 +518,17 @@ export class PushProcessor {
    * @internal
    */
   static partsForDottedKey(str) {
-    var result = [];
+    const result = [];
 
     // The current field and whether the previous character was the escape
     // character (a backslash).
-    var part = "";
-    var escaped = false;
+    let part = "";
+    let escaped = false;
 
     // Iterate over each character, and decide whether to append to the current
     // part (following the escape rules) or to start a new part (based on the
     // field separator).
-    for (var c of str) {
+    for (const c of str) {
       // If the previous character was the escape character (a backslash)
       // then decide what to append to the current part.
       if (escaped) {
@@ -586,16 +577,16 @@ export class PushProcessor {
     // The key should already have been parsed via updateCachedPushRuleKeys,
     // but if it hasn't (maybe via an old consumer of the SDK which hasn't
     // been updated?) then lazily calculate it here.
-    var parts = this.parsedKeys.get(key);
+    let parts = this.parsedKeys.get(key);
     if (parts === undefined) {
       parts = PushProcessor.partsForDottedKey(key);
       this.parsedKeys.set(key, parts);
     }
-    var val;
+    let val;
 
     // special-case the first component to deal with encrypted messages
-    var firstPart = parts[0];
-    var currentIndex = 0;
+    const firstPart = parts[0];
+    let currentIndex = 0;
     if (firstPart === "content") {
       val = ev.getContent();
       ++currentIndex;
@@ -612,7 +603,7 @@ export class PushProcessor {
       if (isNullOrUndefined(val)) {
         return undefined;
       }
-      var thisPart = parts[currentIndex];
+      const thisPart = parts[currentIndex];
       val = val[thisPart];
     }
     return val;
@@ -627,11 +618,11 @@ export class PushProcessor {
     return this.matchingRuleFromKindSet(ev, rulesets.global);
   }
   pushActionsForEventAndRulesets(ev, rulesets) {
-    var rule = this.matchingRuleForEventWithRulesets(ev, rulesets);
+    const rule = this.matchingRuleForEventWithRulesets(ev, rulesets);
     if (!rule) {
       return {};
     }
-    var actionObj = PushProcessor.actionListToActionsObject(rule.actions);
+    const actionObj = PushProcessor.actionListToActionsObject(rule.actions);
 
     // Some actions are implicit in some situations: we add those here
     if (actionObj.tweaks.highlight === undefined) {
@@ -645,20 +636,20 @@ export class PushProcessor {
     };
   }
   ruleMatchesEvent(rule, ev) {
-    var _rule$conditions;
     // Disable the deprecated mentions push rules if the new mentions property exists.
     if (this.client.supportsIntentionalMentions() && ev.getContent()["m.mentions"] !== undefined && (rule.rule_id === RuleId.ContainsUserName || rule.rule_id === RuleId.ContainsDisplayName || rule.rule_id === RuleId.AtRoomNotification)) {
       return false;
     }
-    return !((_rule$conditions = rule.conditions) !== null && _rule$conditions !== void 0 && _rule$conditions.some(cond => !this.eventFulfillsCondition(cond, ev)));
+    return !rule.conditions?.some(cond => !this.eventFulfillsCondition(cond, ev));
   }
 
   /**
    * Get the user's push actions for the given event
    */
   actionsForEvent(ev) {
-    var _this$pushActionsForE = this.pushActionsForEventAndRulesets(ev, this.client.pushRules),
-      actions = _this$pushActionsForE.actions;
+    const {
+      actions
+    } = this.pushActionsForEventAndRulesets(ev, this.client.pushRules);
     return actions || {};
   }
   actionsAndRuleForEvent(ev) {
@@ -672,9 +663,8 @@ export class PushProcessor {
    * @returns The push rule, or null if no such rule was found
    */
   getPushRuleById(ruleId) {
-    var _result$rule;
-    var result = this.getPushRuleAndKindById(ruleId);
-    return (_result$rule = result === null || result === void 0 ? void 0 : result.rule) !== null && _result$rule !== void 0 ? _result$rule : null;
+    const result = this.getPushRuleAndKindById(ruleId);
+    return result?.rule ?? null;
   }
 
   /**
@@ -685,12 +675,11 @@ export class PushProcessor {
    * @returns kind - The PushRuleKind of the rule to search for
    */
   getPushRuleAndKindById(ruleId) {
-    for (var scope of ["global"]) {
-      var _this$client$pushRule;
-      if (((_this$client$pushRule = this.client.pushRules) === null || _this$client$pushRule === void 0 ? void 0 : _this$client$pushRule[scope]) === undefined) continue;
-      for (var kind of RULEKINDS_IN_ORDER) {
+    for (const scope of ["global"]) {
+      if (this.client.pushRules?.[scope] === undefined) continue;
+      for (const kind of RULEKINDS_IN_ORDER) {
         if (this.client.pushRules[scope][kind] === undefined) continue;
-        for (var rule of this.client.pushRules[scope][kind]) {
+        for (const rule of this.client.pushRules[scope][kind]) {
           if (rule.rule_id === ruleId) return {
             rule,
             kind