@rabbitio/ui-kit 1.0.0-beta.37 → 1.0.0-beta.38

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rabbitio/ui-kit",
-    "version": "1.0.0-beta.37",
+    "version": "1.0.0-beta.38",
     "description": "Rabbit.io react.js components kit",
     "type": "module",
     "main": "./dist/index.cjs",

package/src/common/errorUtils.js

@@ -1,3 +1,6 @@
+import { Logger } from "./utils/logging/logger.js";
+import { safeStringify } from "./utils/safeStringify.js";
+
 /**
  * This function improves the passed error object (its message) by adding the passed function name
  * and additional message to it.
@@ -25,3 +28,15 @@ function improvedErrorMessage(e, settingFunction, additionalMessage) {
 
     return message;
 }
+
+export function logErrorOrOutputToConsole(e) {
+    try {
+        // TODO: [dev] remove this after few weeks of testing output in real life
+        // eslint-disable-next-line no-console
+        console.log("BEFORE SAFE", e);
+        Logger.log("logErrorOrOutputToConsole", safeStringify(e));
+    } catch (e) {
+        // eslint-disable-next-line no-console
+        console.log("logErrorOrOutputToConsole", e);
+    }
+}

package/src/components/utils/uiUtils.js

@@ -0,0 +1,14 @@
+export const handleClickOutside = (exceptionsRefs, callback) => {
+    function handleClick(event) {
+        const isExceptionClicked = exceptionsRefs.find(
+            (ref) => ref?.current && ref.current.contains(event.target)
+        );
+        if (!isExceptionClicked) {
+            callback();
+        }
+    }
+
+    document.addEventListener("click", handleClick);
+
+    return () => document.removeEventListener("click", handleClick);
+};

package/src/components/utils/urlQueryUtils.js

@@ -0,0 +1,87 @@
+const PARAMETER_VALUES_SEPARATOR = "|*|"; // Sting that with high probability will not be in the user's data
+
+/**
+ * Adds specified parameter with values to the URL query string
+ *
+ * @param parameterName - String - name of the parameter
+ * @param values - Array of String values
+ * @param updateURLCallback - callback that will be called with the updated query string. Can be used to save it to URL
+ */
+export function saveQueryParameterAndValues(
+    parameterName,
+    values,
+    updateURLCallback = (newQueryString) => {}
+) {
+    let parametersAndValues = parseSearchString();
+    parametersAndValues = parametersAndValues.filter(
+        (parameterAndValues) => parameterAndValues[0] !== parameterName
+    );
+    const parameterValuesForURL = encodeURIComponent(
+        values.join(PARAMETER_VALUES_SEPARATOR)
+    );
+    parametersAndValues.push([parameterName, parameterValuesForURL]);
+    const newQueryString = `?${parametersAndValues
+        .map((parameterAndValues) => parameterAndValues.join("="))
+        .join("&")}`;
+    updateURLCallback(newQueryString);
+
+    return newQueryString;
+}
+
+/**
+ * Removes specified parameter with values from the URL query string
+ *
+ * @param parameterName - String - name of the parameter
+ * @param updateURLCallback - callback that will be called with the updated query string. Can be used to save it to URL
+ */
+// TODO: [tests, moderate] units required the same as or other functions in this module
+export function removeQueryParameterAndValues(
+    parameterName,
+    updateURLCallback = (newQueryString) => {}
+) {
+    let parametersAndValues = parseSearchString();
+    parametersAndValues = parametersAndValues.filter(
+        (parameterAndValues) => parameterAndValues[0] !== parameterName
+    );
+    const newQueryString = `?${parametersAndValues
+        .map((parameterAndValues) => parameterAndValues.join("="))
+        .join("&")}`;
+    updateURLCallback(newQueryString);
+
+    return newQueryString;
+}
+
+/**
+ * Retrieves parameter values from the URL query string.
+ *
+ * If there are several parameters with the same name in the URL then all their values are returned
+ *
+ * @param name {string} - parameter name
+ * @return {string[]} [] - if the parameter is not present in URL. [""] - if parameter present but has empty value
+ */
+export function getQueryParameterValues(name) {
+    return parseSearchString()
+        .filter((parameterAndValue) => parameterAndValue[0] === name)
+        .reduce((allValues, parameterAndValue) => {
+            const values = decodeURIComponent(parameterAndValue[1] || "").split(
+                PARAMETER_VALUES_SEPARATOR
+            );
+            return [...allValues, ...values];
+        }, []);
+}
+
+function parseSearchString() {
+    const trimmed = (window.location.search?.slice(1) || "").trim();
+
+    return (
+        (trimmed &&
+            trimmed
+                .split("&")
+                .map((parameterAndValue) => parameterAndValue.split("="))) ||
+        []
+    );
+}
+
+export function getQueryParameterSingleValue(name) {
+    return (getQueryParameterValues(name) || [])[0];
+}

package/src/index.js

@@ -6,9 +6,16 @@ export { AssetIcon } from "./components/atoms/AssetIcon/AssetIcon.jsx";
 
 export { useCallHandlingErrors } from "./components/hooks/useCallHandlingErrors.js";
 export { useReferredState } from "./components/hooks/useReferredState.js";
+export { handleClickOutside } from "./components/utils/uiUtils.js";
+
+export { saveQueryParameterAndValues } from "./components/utils/urlQueryUtils.js";
+export { removeQueryParameterAndValues } from "./components/utils/urlQueryUtils.js";
+export { getQueryParameterSingleValue } from "./components/utils/urlQueryUtils.js";
+export { getQueryParameterValues } from "./components/utils/urlQueryUtils.js";
 
 // Common code lib (to be extracted later to dedicated lib)
 export { improveAndRethrow } from "./common/errorUtils.js";
+export { logErrorOrOutputToConsole } from "./common/errorUtils.js";
 export { FiatCurrenciesService } from "./common/fiatCurrenciesService.js";
 export { AmountUtils } from "./common/amountUtils.js";