bruce-models 7.1.117 → 7.1.118

package/dist/bruce-models.umd.js

@@ -23997,6 +23997,8 @@
     })(exports.EncryptUtils || (exports.EncryptUtils = {}));
 
     (function (UrlUtils) {
+        // The "S:{expires}.{signature}/" segment the API puts in the path of URLs it signs.
+        const SIGNED_SEGMENT = /\/S:(\d+)\.[A-Za-z0-9_-]+\//;
         /**
          * Returns a url-safe string that is human readable.
          * Eg: 'My Project View!' into 'My-Project-View'.
@@ -24026,6 +24028,52 @@
             return urlObj.toString();
         }
         UrlUtils.AddQueryParam = AddQueryParam;
+        /**
+         * Removes every occurrence of a query parameter from a url.
+         * Eg: RemoveQueryParam('http://example.com/?key=value&other=1', 'key') => 'http://example.com/?other=1'
+         * @param url absolute or relative url.
+         * @param key decoded name of the parameter to remove.
+         * @returns
+         */
+        function RemoveQueryParam(url, key) {
+            if (!url) {
+                return url;
+            }
+            const hashStart = url.indexOf("#");
+            const hash = hashStart === -1 ? "" : url.substring(hashStart);
+            const beforeHash = hashStart === -1 ? url : url.substring(0, hashStart);
+            const queryStart = beforeHash.indexOf("?");
+            if (queryStart === -1) {
+                return url;
+            }
+            // Works on the raw string so the parameters that stay keep their exact encoding, which a signed query depends on.
+            const kept = beforeHash.substring(queryStart + 1).split("&").filter(pair => {
+                return decodeQueryName(pair.split("=")[0]) !== key;
+            });
+            const query = kept.length ? "?" + kept.join("&") : "";
+            return beforeHash.substring(0, queryStart) + query + hash;
+        }
+        UrlUtils.RemoveQueryParam = RemoveQueryParam;
+        /**
+         * Returns true when the url carries an API signature that has not expired, so it authorises itself.
+         * @param url
+         * @returns
+         */
+        function IsSignedUrl(url) {
+            const match = url === null || url === void 0 ? void 0 : url.match(SIGNED_SEGMENT);
+            return !!match && Number(match[1]) * 1000 > Date.now();
+        }
+        UrlUtils.IsSignedUrl = IsSignedUrl;
+        /**
+         * Removes the API signature from a url.
+         * Eg: comparing two urls for the same file that were signed at different times, or a link leaving the app that should grant no more than the reader's own access.
+         * @param url
+         * @returns
+         */
+        function RemoveSignature(url) {
+            return url ? url.replace(SIGNED_SEGMENT, "/") : url;
+        }
+        UrlUtils.RemoveSignature = RemoveSignature;
         /**
          * Returns a url with the provided url appended to the provided existing url.
          * @param params
@@ -24078,6 +24126,17 @@
             return full;
         }
         UrlUtils.ConstructUrl = ConstructUrl;
+        /**
+         * Decodes a query parameter name the way URLSearchParams does, keeping the raw name when it is malformed.
+         */
+        function decodeQueryName(name) {
+            try {
+                return decodeURIComponent(name.replace(/\+/g, " "));
+            }
+            catch (_a) {
+                return name;
+            }
+        }
     })(exports.UrlUtils || (exports.UrlUtils = {}));
 
     (function (WorkflowItem) {
@@ -24909,7 +24968,7 @@
     }
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.117";
+    const VERSION = "7.1.118";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;