@trackunit/react-core-hooks 1.6.58 → 1.6.60

package/index.cjs.js

@@ -2,6 +2,7 @@
 
 var react = require('react');
 var jsxRuntime = require('react/jsx-runtime');
+var fflate = require('fflate');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
 var sharedUtils = require('@trackunit/shared-utils');
 var reactRouter = require('@tanstack/react-router');
@@ -113,6 +114,106 @@ const useConfirmationDialog = () => {
     return confirmationDialogContext;
 };
 
+/**
+ * Base64URL encode bytes to a URL-safe string
+ */
+const b64urlEncode = (bytes) => {
+    let bin = "";
+    for (let i = 0; i < bytes.length; i++) {
+        bin += String.fromCharCode(bytes[i] ?? 0);
+    }
+    return btoa(bin).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
+};
+/**
+ * Base64URL decode a URL-safe string to bytes
+ */
+const b64urlDecode = (s) => {
+    s = s.replace(/-/g, "+").replace(/_/g, "/");
+    s += "===".slice((s.length + 3) % 4);
+    const bin = atob(s);
+    const out = new Uint8Array(bin.length);
+    for (let i = 0; i < bin.length; i++) {
+        out[i] = bin.charCodeAt(i);
+    }
+    return out;
+};
+/**
+ * React hook for safe base64 encoding/decoding with UTF-8 support and compression
+ *
+ * This hook provides callbacks for safely encoding and decoding objects/strings to/from base64
+ * with proper Unicode character support (including Japanese, Chinese, etc.) and automatic
+ * compression for better performance with large objects.
+ *
+ * @returns Object containing encode and decode callback functions
+ */
+const useCustomEncoding = () => {
+    /**
+     * Safely encode an object or string with compression and UTF-8 support
+     *
+     * This function compresses objects before encoding for better performance,
+     * and properly handles Unicode characters (including Japanese, Chinese, etc.).
+     *
+     * @param input - The object or string to encode
+     * @returns The compressed and encoded string
+     */
+    const encode = react.useCallback((input) => {
+        try {
+            // If it's already a string, use it directly; otherwise stringify the object
+            const json = typeof input === "string" ? input : JSON.stringify(input);
+            const textInput = new TextEncoder().encode(json);
+            // Use fflate for synchronous gzip compression
+            const compressed = fflate.gzipSync(textInput);
+            return b64urlEncode(compressed);
+        }
+        catch (error) {
+            return "";
+        }
+    }, []);
+    /**
+     * Safely decode a compressed and encoded string back to its original form
+     *
+     * This function decompresses and decodes strings, properly handling Unicode characters
+     * and returning the original object or string.
+     *
+     * @param str - The compressed and encoded string to decode
+     * @returns The decoded object or string, or null if decoding fails
+     */
+    const decode = react.useCallback((str) => {
+        try {
+            // Try to decode as compressed data first
+            try {
+                const bytes = b64urlDecode(str);
+                const decompressed = fflate.gunzipSync(bytes);
+                const json = new TextDecoder().decode(decompressed);
+                // Try to parse as JSON first (for objects)
+                try {
+                    return JSON.parse(json);
+                }
+                catch (_) {
+                    // If JSON parsing fails, return the string as-is
+                    return json;
+                }
+            }
+            catch (_) {
+                // If compression decoding fails, fall back to regular decoding
+            }
+            // Fallback: use regular base64 decoding
+            const decoded = decodeURIComponent(escape(atob(str)));
+            try {
+                return JSON.parse(decoded);
+            }
+            catch (_) {
+                // If JSON parsing fails, return the string as-is
+                return decoded;
+            }
+        }
+        catch (error) {
+            return "";
+        }
+    }, []);
+    return react.useMemo(() => ({ encode, decode }), [encode, decode]);
+};
+
 const EnvironmentContext = react.createContext(null);
 /**
  * This is a provider for the EnvironmentContext.
@@ -1205,6 +1306,7 @@ exports.useCurrentUser = useCurrentUser;
 exports.useCurrentUserLanguage = useCurrentUserLanguage;
 exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
+exports.useCustomEncoding = useCustomEncoding;
 exports.useCustomerRuntime = useCustomerRuntime;
 exports.useEnvironment = useEnvironment;
 exports.useErrorHandler = useErrorHandler;

package/index.esm.js

@@ -1,5 +1,6 @@
-import { createContext, useContext, useMemo, useState, useCallback, useRef, useEffect, useReducer } from 'react';
+import { createContext, useContext, useMemo, useCallback, useState, useRef, useEffect, useReducer } from 'react';
 import { jsx } from 'react/jsx-runtime';
+import { gzipSync, gunzipSync } from 'fflate';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
 import { useLocation } from '@tanstack/react-router';
@@ -111,6 +112,106 @@ const useConfirmationDialog = () => {
     return confirmationDialogContext;
 };
 
+/**
+ * Base64URL encode bytes to a URL-safe string
+ */
+const b64urlEncode = (bytes) => {
+    let bin = "";
+    for (let i = 0; i < bytes.length; i++) {
+        bin += String.fromCharCode(bytes[i] ?? 0);
+    }
+    return btoa(bin).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
+};
+/**
+ * Base64URL decode a URL-safe string to bytes
+ */
+const b64urlDecode = (s) => {
+    s = s.replace(/-/g, "+").replace(/_/g, "/");
+    s += "===".slice((s.length + 3) % 4);
+    const bin = atob(s);
+    const out = new Uint8Array(bin.length);
+    for (let i = 0; i < bin.length; i++) {
+        out[i] = bin.charCodeAt(i);
+    }
+    return out;
+};
+/**
+ * React hook for safe base64 encoding/decoding with UTF-8 support and compression
+ *
+ * This hook provides callbacks for safely encoding and decoding objects/strings to/from base64
+ * with proper Unicode character support (including Japanese, Chinese, etc.) and automatic
+ * compression for better performance with large objects.
+ *
+ * @returns Object containing encode and decode callback functions
+ */
+const useCustomEncoding = () => {
+    /**
+     * Safely encode an object or string with compression and UTF-8 support
+     *
+     * This function compresses objects before encoding for better performance,
+     * and properly handles Unicode characters (including Japanese, Chinese, etc.).
+     *
+     * @param input - The object or string to encode
+     * @returns The compressed and encoded string
+     */
+    const encode = useCallback((input) => {
+        try {
+            // If it's already a string, use it directly; otherwise stringify the object
+            const json = typeof input === "string" ? input : JSON.stringify(input);
+            const textInput = new TextEncoder().encode(json);
+            // Use fflate for synchronous gzip compression
+            const compressed = gzipSync(textInput);
+            return b64urlEncode(compressed);
+        }
+        catch (error) {
+            return "";
+        }
+    }, []);
+    /**
+     * Safely decode a compressed and encoded string back to its original form
+     *
+     * This function decompresses and decodes strings, properly handling Unicode characters
+     * and returning the original object or string.
+     *
+     * @param str - The compressed and encoded string to decode
+     * @returns The decoded object or string, or null if decoding fails
+     */
+    const decode = useCallback((str) => {
+        try {
+            // Try to decode as compressed data first
+            try {
+                const bytes = b64urlDecode(str);
+                const decompressed = gunzipSync(bytes);
+                const json = new TextDecoder().decode(decompressed);
+                // Try to parse as JSON first (for objects)
+                try {
+                    return JSON.parse(json);
+                }
+                catch (_) {
+                    // If JSON parsing fails, return the string as-is
+                    return json;
+                }
+            }
+            catch (_) {
+                // If compression decoding fails, fall back to regular decoding
+            }
+            // Fallback: use regular base64 decoding
+            const decoded = decodeURIComponent(escape(atob(str)));
+            try {
+                return JSON.parse(decoded);
+            }
+            catch (_) {
+                // If JSON parsing fails, return the string as-is
+                return decoded;
+            }
+        }
+        catch (error) {
+            return "";
+        }
+    }, []);
+    return useMemo(() => ({ encode, decode }), [encode, decode]);
+};
+
 const EnvironmentContext = createContext(null);
 /**
  * This is a provider for the EnvironmentContext.
@@ -1176,4 +1277,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomEncoding, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.6.58",
+  "version": "1.6.60",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,11 +10,12 @@
     "react": "19.0.0",
     "jest-fetch-mock": "^3.0.3",
     "zod": "^3.23.8",
-    "@trackunit/react-core-contexts-api": "1.7.56",
-    "@trackunit/iris-app-runtime-core": "1.7.57",
-    "@trackunit/shared-utils": "1.8.55",
+    "@trackunit/react-core-contexts-api": "1.7.58",
+    "@trackunit/iris-app-runtime-core": "1.7.59",
+    "@trackunit/shared-utils": "1.8.57",
     "@tanstack/react-router": "1.114.29",
-    "@trackunit/react-test-setup": "1.3.54"
+    "@trackunit/react-test-setup": "1.3.56",
+    "fflate": "^0.8.2"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/encoding/useCustomEncoding.d.ts

@@ -0,0 +1,13 @@
+/**
+ * React hook for safe base64 encoding/decoding with UTF-8 support and compression
+ *
+ * This hook provides callbacks for safely encoding and decoding objects/strings to/from base64
+ * with proper Unicode character support (including Japanese, Chinese, etc.) and automatic
+ * compression for better performance with large objects.
+ *
+ * @returns Object containing encode and decode callback functions
+ */
+export declare const useCustomEncoding: () => {
+    encode: (input: unknown) => string;
+    decode: (str: string) => JSON | string;
+};

package/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./analytics/AnalyticsProvider";
 export * from "./assetSorting/AssetSortingProvider";
 export * from "./confirmationDialog/ConfirmationDialogProvider";
+export * from "./encoding/useCustomEncoding";
 export * from "./environment/EnvironmentContextProvider";
 export * from "./errorHandling/ErrorHandlingProvider";
 export * from "./fetchAssetBlobUrl";