@trackunit/react-core-hooks 1.7.94 → 1.7.96

package/index.cjs.js

@@ -2,10 +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 esToolkit = require('es-toolkit');
 
 const AnalyticsContext = react.createContext(null);
 const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
@@ -114,106 +111,6 @@ 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 { { encode: (input: unknown) => string, decode: (str: string) => JSON | string } } 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.
@@ -512,174 +409,6 @@ const useIrisAppImage = () => {
     };
 };
 
-/**
- * The usePrevious hook is a useful tool for tracking the previous value of a variable in a functional component. This can be particularly handy in scenarios where it is necessary to compare the current value with the previous one, such as triggering actions or rendering based on changes.
- *
- * @example
- * const [color, setColor] = React.useState(getRandomColor());
-  const previousColor = usePrevious(color);
- */
-const usePrevious = (value) => {
-    const ref = react.useRef(undefined);
-    react.useEffect(() => {
-        ref.current = value;
-    }, [value]);
-    const wrapper = react.useMemo(() => ({
-        get previous() {
-            return ref.current;
-        },
-    }), []);
-    return wrapper.previous;
-};
-
-/**
- * Validates the state object using a Zod schema.
- *
- * @template TState - The type of the state.
- * @param {ValidateStateOptions<TState>} params - The parameters for the validateState function.
- */
-const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, defaultState, }) => {
-    try {
-        const parsedState = schema.parse(state);
-        onValidationSuccessful?.(parsedState);
-        return parsedState;
-    }
-    catch (error) {
-        // eslint-disable-next-line no-console
-        console.error("Failed to parse and validate the state from local storage.", error);
-        onValidationFailed?.(error);
-        return defaultState;
-    }
-};
-
-/**
- * Initializes the state from local storage, parsing and validating it if a Zod schema is provided.
- *
- * @template TState - The type of the state stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state">} params - The parameters for initializing the local storage state.
- * @returns {TState} - The initialized state.
- */
-const initLocalStorageState = ({ key, defaultState, schema, }) => {
-    const localStorageItem = localStorage.getItem(key);
-    if (!localStorageItem) {
-        return defaultState;
-    }
-    const localStorageItemJSON = JSON.parse(localStorageItem);
-    if (!schema) {
-        return localStorageItemJSON;
-    }
-    return validateState({ state: localStorageItemJSON, defaultState, schema });
-};
-
-/**
- * Sets a value in the local storage with the specified key.
- * Thin wrapper around localStorage.setItem() that is slightly more type safe
- * Stringifies value automatically.
- * Useful if you for some reason can't use the useLocalStorage hook for React lifecycle reasons
- *
- * @template TValue - The type of value to be stored.
- * @param {string} key - The key under which to store the value.
- * @param {TValue} value - The value to store in the local storage.
- */
-const setLocalStorage = (key, value) => {
-    localStorage.setItem(key, JSON.stringify(value));
-};
-
-/**
- * Custom hook for synchronizing a state variable with local storage,
- * with optional schema validation and callbacks.
- *
- * @template TState - The type of the state variable.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks & { state: TState }} params - The parameters for the useLocalStorageEffect hook.
- */
-const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationFailed, onValidationSuccessful, }) => {
-    const prevState = usePrevious(state);
-    react.useEffect(() => {
-        if (JSON.stringify(prevState) === JSON.stringify(state)) {
-            return;
-        }
-        if (schema) {
-            validateState({
-                state,
-                schema,
-                defaultState,
-                onValidationFailed: error => {
-                    // eslint-disable-next-line no-console
-                    console.error(`State validation failed. Resetting local storage to default state: ${defaultState}.`, error);
-                    localStorage.removeItem(key);
-                    onValidationFailed?.(error);
-                },
-                onValidationSuccessful: data => {
-                    setLocalStorage(key, data);
-                    onValidationSuccessful?.(data);
-                },
-            });
-        }
-        else {
-            const stringifiedState = JSON.stringify(state);
-            localStorage.setItem(key, stringifiedState);
-        }
-    }, [state, key, schema, defaultState, prevState, onValidationFailed, onValidationSuccessful]);
-};
-
-/**
- * Works like a normal useState, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the value stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state"> & LocalStorageCallbacks} options - The options for useLocalStorage.
- * @returns {[TState, Dispatch<SetStateAction<TState>>, () => void]} - A tuple containing the current value, a function to update the value, and a function to remove the value from local storage.
- */
-const useLocalStorage = ({ key, defaultState, schema, onValidationFailed, onValidationSuccessful, }) => {
-    if (!key) {
-        throw new Error("useLocalStorage key must be defined");
-    }
-    const defaultStateRef = react.useRef(defaultState);
-    react.useEffect(() => {
-        defaultStateRef.current = defaultState;
-    }, [defaultState]);
-    const schemaRef = react.useRef(schema);
-    react.useEffect(() => {
-        schemaRef.current = schema;
-    }, [schema]);
-    const [state, setState] = react.useState(initLocalStorageState({ key, defaultState: defaultStateRef.current, schema: schemaRef.current }));
-    const prevKey = usePrevious(key);
-    react.useEffect(() => {
-        if (key !== prevKey) {
-            setState(initLocalStorageState({ key, defaultState: defaultStateRef.current, schema: schemaRef.current }));
-        }
-    }, [key, prevKey, schema]);
-    const localStorageProps = react.useMemo(() => ({
-        key,
-        state,
-        defaultState: defaultStateRef.current,
-        schema: schemaRef.current,
-        onValidationFailed,
-        onValidationSuccessful,
-    }), [key, state, onValidationFailed, onValidationSuccessful]);
-    useLocalStorageEffect(localStorageProps);
-    const reset = react.useCallback(() => {
-        setState(defaultStateRef.current);
-    }, []);
-    return react.useMemo(() => [state, setState, reset], [state, setState, reset]);
-};
-
-/**
- * Works like a normal useReducer, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the state.
- * @template TAction - The type of the action.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks} params - The parameters for the useLocalStorageReducer function.
- * @returns {[TState, Dispatch<TAction>]} - A tuple containing the state and the dispatch function.
- */
-const useLocalStorageReducer = ({ key, defaultState, reducer, schema, onValidationFailed, onValidationSuccessful, }) => {
-    if (!key) {
-        throw new Error("useLocalStorage key may not be falsy");
-    }
-    const [state, dispatch] = react.useReducer(reducer, defaultState, () => initLocalStorageState({ key, defaultState, schema }));
-    useLocalStorageEffect({ key, state, defaultState, schema, onValidationFailed, onValidationSuccessful });
-    return [state, dispatch];
-};
-
 const ModalDialogContext = react.createContext(null);
 /**
  * This is a provider for the ModalDialogContext.
@@ -810,7 +539,7 @@ const useAssetRuntime = () => {
                 setError(new Error("Failed to get asset info"));
             }
         };
-        getAssetInfo();
+        void getAssetInfo();
     }, []);
     return { assetInfo, loading, error };
 };
@@ -849,7 +578,7 @@ const useCustomerRuntime = () => {
                 setError(new Error("Failed to get customer info"));
             }
         };
-        getCustomerInfo();
+        void getCustomerInfo();
     }, []);
     return { customerInfo, loading, error };
 };
@@ -888,7 +617,7 @@ const useEventRuntime = () => {
                 setError(new Error("Failed to get event info"));
             }
         };
-        getEventInfo();
+        void getEventInfo();
     }, []);
     return { eventInfo, loading, error };
 };
@@ -926,7 +655,7 @@ const useIrisAppName = () => {
                 setError(new Error("Failed to get iris app name"));
             }
         };
-        getAppName();
+        void getAppName();
     }, []);
     return { appName, loading, error };
 };
@@ -951,7 +680,7 @@ const useIrisAppId = () => {
     const [loading, setLoading] = react.useState(true);
     const [error, setError] = react.useState();
     react.useEffect(() => {
-        const getAppName = async () => {
+        const getData = async () => {
             setLoading(true);
             try {
                 const updatedAppName = await irisAppRuntimeCore.ParamsRuntime.getAppName();
@@ -964,7 +693,7 @@ const useIrisAppId = () => {
                 setError(new Error("Failed to get iris app name"));
             }
         };
-        getAppName();
+        void getData();
     }, []);
     return { irisAppId, loading, error };
 };
@@ -1003,7 +732,7 @@ const useSiteRuntime = () => {
                 setError(new Error("Failed to get site info"));
             }
         };
-        getSiteInfo();
+        void getSiteInfo();
     }, []);
     return { siteInfo, loading, error };
 };
@@ -1024,7 +753,7 @@ const UserSubscriptionProvider = (props) => {
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
  * // use it for something
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
- * @see { IUserSubscriptionContext}
+ * @see { UserSubscription}
  */
 const useUserSubscription = () => {
     const context = react.useContext(UserSubscriptionContext);
@@ -1213,61 +942,6 @@ const useCurrentUser = () => {
     return context;
 };
 
-/**
- * Hook for filtering a list of items by text search, client side search in a list.
- *
- * @template TSearchableItem
- * @param items The list of items to filter.
- * @param props The properties to search in each item.
- * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
- * @example
- * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
- */
-function useTextSearch(items, props) {
-    const [searchText, setSearchText] = react.useState("");
-    const result = react.useMemo(() => {
-        if (!searchText) {
-            return items;
-        }
-        return sharedUtils.filterByMultiple(items, props, searchText);
-    }, [items, props, searchText]);
-    return react.useMemo(() => [result, searchText, setSearchText], [result, searchText, setSearchText]);
-}
-
-const UNINITIALIZED = Symbol("UNINITIALIZED");
-/**
- * Hook to watch for changes in a value and react to them.
- * Uses deep equality comparison via es-toolkit's isEqual.
- *
- * @param props - The hook properties
- * @param props.value - The value to watch for changes
- * @param props.onChange - Function to call when the value changes
- * @param props.immediate - Whether to run the callback immediately on mount (default: false)
- * @param props.skip - Whether to skip watching for changes (default: false)
- */
-const useWatch = ({ value, onChange, immediate = false, skip = false }) => {
-    const prevValue = react.useRef(UNINITIALIZED);
-    const onChangeRef = react.useRef(onChange);
-    // Update the ref whenever onChange changes
-    react.useEffect(() => {
-        onChangeRef.current = onChange;
-    }, [onChange]);
-    react.useEffect(() => {
-        if (skip) {
-            return;
-        }
-        const prev = prevValue.current;
-        const hasChanged = prev === UNINITIALIZED ? false : !esToolkit.isEqual(value, prev);
-        if (immediate && prev === UNINITIALIZED) {
-            onChangeRef.current(value, null);
-        }
-        else if (hasChanged && prev !== UNINITIALIZED) {
-            onChangeRef.current(value, prev);
-        }
-        prevValue.current = value;
-    }, [value, immediate, skip]);
-};
-
 const WidgetConfigContext = react.createContext(null);
 /**
  * This is a hook to use the WidgetConfigProvider.
@@ -1401,7 +1075,6 @@ exports.useCurrentUser = useCurrentUser;
 exports.useCurrentUserLanguage = useCurrentUserLanguage;
 exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
-exports.useCustomEncoding = useCustomEncoding;
 exports.useCustomerRuntime = useCustomerRuntime;
 exports.useEnvironment = useEnvironment;
 exports.useErrorHandler = useErrorHandler;
@@ -1416,18 +1089,13 @@ exports.useImageUploader = useImageUploader;
 exports.useIrisAppId = useIrisAppId;
 exports.useIrisAppImage = useIrisAppImage;
 exports.useIrisAppName = useIrisAppName;
-exports.useLocalStorage = useLocalStorage;
-exports.useLocalStorageReducer = useLocalStorageReducer;
 exports.useModalDialogContext = useModalDialogContext;
 exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;
-exports.usePrevious = usePrevious;
 exports.useSiteRuntime = useSiteRuntime;
-exports.useTextSearch = useTextSearch;
 exports.useTimeRange = useTimeRange;
 exports.useToast = useToast;
 exports.useToken = useToken;
 exports.useUserSubscription = useUserSubscription;
-exports.useWatch = useWatch;
 exports.useWidgetConfig = useWidgetConfig;
 exports.useWidgetConfigAsync = useWidgetConfigAsync;

package/index.esm.js

@@ -1,9 +1,6 @@
-import { createContext, useContext, useMemo, useCallback, useState, useRef, useEffect, useReducer } from 'react';
+import { createContext, useContext, useMemo, useState, useCallback, useEffect, useRef } 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 { isEqual } from 'es-toolkit';
 
 const AnalyticsContext = createContext(null);
 const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
@@ -112,106 +109,6 @@ 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 { { encode: (input: unknown) => string, decode: (str: string) => JSON | string } } 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.
@@ -510,174 +407,6 @@ const useIrisAppImage = () => {
     };
 };
 
-/**
- * The usePrevious hook is a useful tool for tracking the previous value of a variable in a functional component. This can be particularly handy in scenarios where it is necessary to compare the current value with the previous one, such as triggering actions or rendering based on changes.
- *
- * @example
- * const [color, setColor] = React.useState(getRandomColor());
-  const previousColor = usePrevious(color);
- */
-const usePrevious = (value) => {
-    const ref = useRef(undefined);
-    useEffect(() => {
-        ref.current = value;
-    }, [value]);
-    const wrapper = useMemo(() => ({
-        get previous() {
-            return ref.current;
-        },
-    }), []);
-    return wrapper.previous;
-};
-
-/**
- * Validates the state object using a Zod schema.
- *
- * @template TState - The type of the state.
- * @param {ValidateStateOptions<TState>} params - The parameters for the validateState function.
- */
-const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, defaultState, }) => {
-    try {
-        const parsedState = schema.parse(state);
-        onValidationSuccessful?.(parsedState);
-        return parsedState;
-    }
-    catch (error) {
-        // eslint-disable-next-line no-console
-        console.error("Failed to parse and validate the state from local storage.", error);
-        onValidationFailed?.(error);
-        return defaultState;
-    }
-};
-
-/**
- * Initializes the state from local storage, parsing and validating it if a Zod schema is provided.
- *
- * @template TState - The type of the state stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state">} params - The parameters for initializing the local storage state.
- * @returns {TState} - The initialized state.
- */
-const initLocalStorageState = ({ key, defaultState, schema, }) => {
-    const localStorageItem = localStorage.getItem(key);
-    if (!localStorageItem) {
-        return defaultState;
-    }
-    const localStorageItemJSON = JSON.parse(localStorageItem);
-    if (!schema) {
-        return localStorageItemJSON;
-    }
-    return validateState({ state: localStorageItemJSON, defaultState, schema });
-};
-
-/**
- * Sets a value in the local storage with the specified key.
- * Thin wrapper around localStorage.setItem() that is slightly more type safe
- * Stringifies value automatically.
- * Useful if you for some reason can't use the useLocalStorage hook for React lifecycle reasons
- *
- * @template TValue - The type of value to be stored.
- * @param {string} key - The key under which to store the value.
- * @param {TValue} value - The value to store in the local storage.
- */
-const setLocalStorage = (key, value) => {
-    localStorage.setItem(key, JSON.stringify(value));
-};
-
-/**
- * Custom hook for synchronizing a state variable with local storage,
- * with optional schema validation and callbacks.
- *
- * @template TState - The type of the state variable.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks & { state: TState }} params - The parameters for the useLocalStorageEffect hook.
- */
-const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationFailed, onValidationSuccessful, }) => {
-    const prevState = usePrevious(state);
-    useEffect(() => {
-        if (JSON.stringify(prevState) === JSON.stringify(state)) {
-            return;
-        }
-        if (schema) {
-            validateState({
-                state,
-                schema,
-                defaultState,
-                onValidationFailed: error => {
-                    // eslint-disable-next-line no-console
-                    console.error(`State validation failed. Resetting local storage to default state: ${defaultState}.`, error);
-                    localStorage.removeItem(key);
-                    onValidationFailed?.(error);
-                },
-                onValidationSuccessful: data => {
-                    setLocalStorage(key, data);
-                    onValidationSuccessful?.(data);
-                },
-            });
-        }
-        else {
-            const stringifiedState = JSON.stringify(state);
-            localStorage.setItem(key, stringifiedState);
-        }
-    }, [state, key, schema, defaultState, prevState, onValidationFailed, onValidationSuccessful]);
-};
-
-/**
- * Works like a normal useState, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the value stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state"> & LocalStorageCallbacks} options - The options for useLocalStorage.
- * @returns {[TState, Dispatch<SetStateAction<TState>>, () => void]} - A tuple containing the current value, a function to update the value, and a function to remove the value from local storage.
- */
-const useLocalStorage = ({ key, defaultState, schema, onValidationFailed, onValidationSuccessful, }) => {
-    if (!key) {
-        throw new Error("useLocalStorage key must be defined");
-    }
-    const defaultStateRef = useRef(defaultState);
-    useEffect(() => {
-        defaultStateRef.current = defaultState;
-    }, [defaultState]);
-    const schemaRef = useRef(schema);
-    useEffect(() => {
-        schemaRef.current = schema;
-    }, [schema]);
-    const [state, setState] = useState(initLocalStorageState({ key, defaultState: defaultStateRef.current, schema: schemaRef.current }));
-    const prevKey = usePrevious(key);
-    useEffect(() => {
-        if (key !== prevKey) {
-            setState(initLocalStorageState({ key, defaultState: defaultStateRef.current, schema: schemaRef.current }));
-        }
-    }, [key, prevKey, schema]);
-    const localStorageProps = useMemo(() => ({
-        key,
-        state,
-        defaultState: defaultStateRef.current,
-        schema: schemaRef.current,
-        onValidationFailed,
-        onValidationSuccessful,
-    }), [key, state, onValidationFailed, onValidationSuccessful]);
-    useLocalStorageEffect(localStorageProps);
-    const reset = useCallback(() => {
-        setState(defaultStateRef.current);
-    }, []);
-    return useMemo(() => [state, setState, reset], [state, setState, reset]);
-};
-
-/**
- * Works like a normal useReducer, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the state.
- * @template TAction - The type of the action.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks} params - The parameters for the useLocalStorageReducer function.
- * @returns {[TState, Dispatch<TAction>]} - A tuple containing the state and the dispatch function.
- */
-const useLocalStorageReducer = ({ key, defaultState, reducer, schema, onValidationFailed, onValidationSuccessful, }) => {
-    if (!key) {
-        throw new Error("useLocalStorage key may not be falsy");
-    }
-    const [state, dispatch] = useReducer(reducer, defaultState, () => initLocalStorageState({ key, defaultState, schema }));
-    useLocalStorageEffect({ key, state, defaultState, schema, onValidationFailed, onValidationSuccessful });
-    return [state, dispatch];
-};
-
 const ModalDialogContext = createContext(null);
 /**
  * This is a provider for the ModalDialogContext.
@@ -808,7 +537,7 @@ const useAssetRuntime = () => {
                 setError(new Error("Failed to get asset info"));
             }
         };
-        getAssetInfo();
+        void getAssetInfo();
     }, []);
     return { assetInfo, loading, error };
 };
@@ -847,7 +576,7 @@ const useCustomerRuntime = () => {
                 setError(new Error("Failed to get customer info"));
             }
         };
-        getCustomerInfo();
+        void getCustomerInfo();
     }, []);
     return { customerInfo, loading, error };
 };
@@ -886,7 +615,7 @@ const useEventRuntime = () => {
                 setError(new Error("Failed to get event info"));
             }
         };
-        getEventInfo();
+        void getEventInfo();
     }, []);
     return { eventInfo, loading, error };
 };
@@ -924,7 +653,7 @@ const useIrisAppName = () => {
                 setError(new Error("Failed to get iris app name"));
             }
         };
-        getAppName();
+        void getAppName();
     }, []);
     return { appName, loading, error };
 };
@@ -949,7 +678,7 @@ const useIrisAppId = () => {
     const [loading, setLoading] = useState(true);
     const [error, setError] = useState();
     useEffect(() => {
-        const getAppName = async () => {
+        const getData = async () => {
             setLoading(true);
             try {
                 const updatedAppName = await ParamsRuntime.getAppName();
@@ -962,7 +691,7 @@ const useIrisAppId = () => {
                 setError(new Error("Failed to get iris app name"));
             }
         };
-        getAppName();
+        void getData();
     }, []);
     return { irisAppId, loading, error };
 };
@@ -1001,7 +730,7 @@ const useSiteRuntime = () => {
                 setError(new Error("Failed to get site info"));
             }
         };
-        getSiteInfo();
+        void getSiteInfo();
     }, []);
     return { siteInfo, loading, error };
 };
@@ -1022,7 +751,7 @@ const UserSubscriptionProvider = (props) => {
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
  * // use it for something
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
- * @see { IUserSubscriptionContext}
+ * @see { UserSubscription}
  */
 const useUserSubscription = () => {
     const context = useContext(UserSubscriptionContext);
@@ -1211,61 +940,6 @@ const useCurrentUser = () => {
     return context;
 };
 
-/**
- * Hook for filtering a list of items by text search, client side search in a list.
- *
- * @template TSearchableItem
- * @param items The list of items to filter.
- * @param props The properties to search in each item.
- * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
- * @example
- * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
- */
-function useTextSearch(items, props) {
-    const [searchText, setSearchText] = useState("");
-    const result = useMemo(() => {
-        if (!searchText) {
-            return items;
-        }
-        return filterByMultiple(items, props, searchText);
-    }, [items, props, searchText]);
-    return useMemo(() => [result, searchText, setSearchText], [result, searchText, setSearchText]);
-}
-
-const UNINITIALIZED = Symbol("UNINITIALIZED");
-/**
- * Hook to watch for changes in a value and react to them.
- * Uses deep equality comparison via es-toolkit's isEqual.
- *
- * @param props - The hook properties
- * @param props.value - The value to watch for changes
- * @param props.onChange - Function to call when the value changes
- * @param props.immediate - Whether to run the callback immediately on mount (default: false)
- * @param props.skip - Whether to skip watching for changes (default: false)
- */
-const useWatch = ({ value, onChange, immediate = false, skip = false }) => {
-    const prevValue = useRef(UNINITIALIZED);
-    const onChangeRef = useRef(onChange);
-    // Update the ref whenever onChange changes
-    useEffect(() => {
-        onChangeRef.current = onChange;
-    }, [onChange]);
-    useEffect(() => {
-        if (skip) {
-            return;
-        }
-        const prev = prevValue.current;
-        const hasChanged = prev === UNINITIALIZED ? false : !isEqual(value, prev);
-        if (immediate && prev === UNINITIALIZED) {
-            onChangeRef.current(value, null);
-        }
-        else if (hasChanged && prev !== UNINITIALIZED) {
-            onChangeRef.current(value, prev);
-        }
-        prevValue.current = value;
-    }, [value, immediate, skip]);
-};
-
 const WidgetConfigContext = createContext(null);
 /**
  * This is a hook to use the WidgetConfigProvider.
@@ -1369,4 +1043,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, ExportDataContext, FeatureFlagContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigContext, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomEncoding, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWatch, useWidgetConfig, useWidgetConfigAsync };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, ExportDataContext, FeatureFlagContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigContext, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.7.94",
+  "version": "1.7.96",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,12 +8,8 @@
   },
   "dependencies": {
     "react": "19.0.0",
-    "zod": "^3.23.8",
-    "@trackunit/iris-app-runtime-core": "1.8.90",
-    "@trackunit/shared-utils": "1.9.80",
-    "fflate": "^0.8.2",
-    "es-toolkit": "^1.39.10",
-    "@trackunit/iris-app-runtime-core-api": "1.7.90"
+    "@trackunit/iris-app-runtime-core": "1.8.92",
+    "@trackunit/iris-app-runtime-core-api": "1.7.92"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -1,17 +1,14 @@
 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 "./exportData/ExportDataContextState";
 export * from "./featureFlags/FeatureFlagContextProvider";
 export * from "./fetchAssetBlobUrl";
-export * from "./filter-bar/FilterBarProvider";
+export * from "./filterBar/FilterBarProvider";
 export * from "./images/useImageUploader";
 export * from "./images/useIrisAppImage";
-export * from "./localStorage/useLocalStorage";
-export * from "./localStorage/useLocalStorageReducer";
 export * from "./modalDialog/ModalDialogProvider";
 export * from "./navigation/NavigationContextProvider";
 export * from "./oemBranding/OemBrandingContextProvider";
@@ -25,9 +22,6 @@ export * from "./timeRange/TimeRangeProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";
 export * from "./useFeatureBranchQueryString";
-export * from "./usePrevious";
 export * from "./user/CurrentUserPreferenceProvider";
 export * from "./user/CurrentUserProvider";
-export * from "./useTextSearch";
-export * from "./useWatch";
 export * from "./widgetConfig/WidgetConfigProvider";

package/src/subscription/UserSubscriptionProvider.d.ts

@@ -1,7 +1,7 @@
-import { IUserSubscriptionContext } from "@trackunit/iris-app-runtime-core-api";
+import { UserSubscription } from "@trackunit/iris-app-runtime-core-api";
 import { ReactNode } from "react";
 interface UserSubscriptionProviderProps {
-    value: IUserSubscriptionContext;
+    value: UserSubscription;
     children?: ReactNode;
 }
 /**
@@ -17,7 +17,7 @@ export declare const UserSubscriptionProvider: (props: UserSubscriptionProviderP
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
  * // use it for something
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
- * @see { IUserSubscriptionContext}
+ * @see { UserSubscription}
  */
-export declare const useUserSubscription: () => IUserSubscriptionContext;
+export declare const useUserSubscription: () => UserSubscription;
 export {};

package/src/encoding/useCustomEncoding.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 { { encode: (input: unknown) => string, decode: (str: string) => JSON | string } } Object containing encode and decode callback functions
- */
-export declare const useCustomEncoding: () => {
-    encode: (input: unknown) => string;
-    decode: (str: string) => JSON | string;
-};

package/src/localStorage/initLocalStorageState.d.ts

@@ -1,9 +0,0 @@
-import { LocalStorageParams } from "./types";
-/**
- * Initializes the state from local storage, parsing and validating it if a Zod schema is provided.
- *
- * @template TState - The type of the state stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state">} params - The parameters for initializing the local storage state.
- * @returns {TState} - The initialized state.
- */
-export declare const initLocalStorageState: <TState>({ key, defaultState, schema, }: Omit<LocalStorageParams<TState>, "state">) => any;

package/src/localStorage/setLocalStorage.d.ts

@@ -1,11 +0,0 @@
-/**
- * Sets a value in the local storage with the specified key.
- * Thin wrapper around localStorage.setItem() that is slightly more type safe
- * Stringifies value automatically.
- * Useful if you for some reason can't use the useLocalStorage hook for React lifecycle reasons
- *
- * @template TValue - The type of value to be stored.
- * @param {string} key - The key under which to store the value.
- * @param {TValue} value - The value to store in the local storage.
- */
-export declare const setLocalStorage: <TValue>(key: string, value: TValue) => void;

package/src/localStorage/types.d.ts

@@ -1,27 +0,0 @@
-import { z } from "zod";
-export interface LocalStorageParams<TState> {
-    /**
-     * The key used to store the value in local storage.
-     */
-    key: string;
-    /**
-     * The default state value.
-     */
-    defaultState: TState;
-    /**
-     * Optional schema for validating the state.
-     */
-    schema?: z.Schema<TState>;
-}
-export interface LocalStorageCallbacks<TState> {
-    /**
-     * Optional callback function called when validation fails.
-     *
-     * @param error - The validation error object.
-     */
-    onValidationFailed?: (error: unknown) => void;
-    /**
-     * Optional callback function called when validation succeeds.
-     */
-    onValidationSuccessful?: (data: TState) => void;
-}

package/src/localStorage/useLocalStorage.d.ts

@@ -1,10 +0,0 @@
-import { Dispatch, SetStateAction } from "react";
-import { LocalStorageCallbacks, LocalStorageParams } from "./types";
-/**
- * Works like a normal useState, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the value stored in local storage.
- * @param {Omit<LocalStorageParams<TState>, "state"> & LocalStorageCallbacks} options - The options for useLocalStorage.
- * @returns {[TState, Dispatch<SetStateAction<TState>>, () => void]} - A tuple containing the current value, a function to update the value, and a function to remove the value from local storage.
- */
-export declare const useLocalStorage: <TState>({ key, defaultState, schema, onValidationFailed, onValidationSuccessful, }: LocalStorageParams<TState> & LocalStorageCallbacks<TState>) => readonly [TState, Dispatch<SetStateAction<TState>>, () => void];

package/src/localStorage/useLocalStorageEffect.d.ts

@@ -1,11 +0,0 @@
-import { LocalStorageCallbacks, LocalStorageParams } from "./types";
-/**
- * Custom hook for synchronizing a state variable with local storage,
- * with optional schema validation and callbacks.
- *
- * @template TState - The type of the state variable.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks & { state: TState }} params - The parameters for the useLocalStorageEffect hook.
- */
-export declare const useLocalStorageEffect: <TState>({ key, state, defaultState, schema, onValidationFailed, onValidationSuccessful, }: LocalStorageParams<TState> & LocalStorageCallbacks<TState> & {
-    state: TState;
-}) => void;

package/src/localStorage/useLocalStorageReducer.d.ts

@@ -1,12 +0,0 @@
-import { LocalStorageCallbacks, LocalStorageParams } from "./types";
-/**
- * Works like a normal useReducer, but saves to local storage and has optional schema validation.
- *
- * @template TState - The type of the state.
- * @template TAction - The type of the action.
- * @param {LocalStorageParams<TState> & LocalStorageCallbacks} params - The parameters for the useLocalStorageReducer function.
- * @returns {[TState, Dispatch<TAction>]} - A tuple containing the state and the dispatch function.
- */
-export declare const useLocalStorageReducer: <TState, TAction>({ key, defaultState, reducer, schema, onValidationFailed, onValidationSuccessful, }: {
-    reducer: (state: TState, action: TAction) => TState;
-} & LocalStorageParams<TState> & LocalStorageCallbacks<TState>) => readonly [TState, import("react").ActionDispatch<[action: TAction]>];

package/src/localStorage/validateState.d.ts

@@ -1,13 +0,0 @@
-import { LocalStorageCallbacks, LocalStorageParams } from "./types";
-type ValidateStateOptions<TState> = Required<Pick<LocalStorageParams<TState>, "schema">> & {
-    state: TState;
-    defaultState: TState;
-} & LocalStorageCallbacks<TState>;
-/**
- * Validates the state object using a Zod schema.
- *
- * @template TState - The type of the state.
- * @param {ValidateStateOptions<TState>} params - The parameters for the validateState function.
- */
-export declare const validateState: <TState>({ state, schema, onValidationFailed, onValidationSuccessful, defaultState, }: ValidateStateOptions<TState>) => TState;
-export {};

package/src/usePrevious.d.ts

@@ -1,8 +0,0 @@
-/**
- * The usePrevious hook is a useful tool for tracking the previous value of a variable in a functional component. This can be particularly handy in scenarios where it is necessary to compare the current value with the previous one, such as triggering actions or rendering based on changes.
- *
- * @example
- * const [color, setColor] = React.useState(getRandomColor());
-  const previousColor = usePrevious(color);
- */
-export declare const usePrevious: <TValue>(value: TValue) => TValue | undefined;

package/src/useTextSearch.d.ts

@@ -1,13 +0,0 @@
-import { Maybe } from "@trackunit/shared-utils";
-import { Dispatch } from "react";
-/**
- * Hook for filtering a list of items by text search, client side search in a list.
- *
- * @template TSearchableItem
- * @param items The list of items to filter.
- * @param props The properties to search in each item.
- * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
- * @example
- * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
- */
-export declare function useTextSearch<TSearchableItem>(items: Array<TSearchableItem>, props: (item: TSearchableItem) => Array<Maybe<string> | undefined>): [Array<TSearchableItem>, string, Dispatch<string>];

package/src/useWatch.d.ts

@@ -1,20 +0,0 @@
-interface UseWatchOptions {
-    immediate?: boolean;
-    skip?: boolean;
-}
-interface UseWatchProps<TValue> extends UseWatchOptions {
-    value: TValue;
-    onChange: (value: TValue, prevValue: TValue | null) => void;
-}
-/**
- * Hook to watch for changes in a value and react to them.
- * Uses deep equality comparison via es-toolkit's isEqual.
- *
- * @param props - The hook properties
- * @param props.value - The value to watch for changes
- * @param props.onChange - Function to call when the value changes
- * @param props.immediate - Whether to run the callback immediately on mount (default: false)
- * @param props.skip - Whether to skip watching for changes (default: false)
- */
-export declare const useWatch: <TValue>({ value, onChange, immediate, skip }: UseWatchProps<TValue>) => void;
-export {};