@trackunit/react-components 0.1.177-alpha-5bf259599b.0 → 0.1.178

package/index.cjs.js

@@ -21647,55 +21647,42 @@ const setLocalStorage = (key, value) => {
 /**
  * Validates the state object using a Zod schema.
  *
- * @template State - The type of the state.
- * @param {ValidateStateOptions<State>} params - The parameters for the validateState function.
- * @returns {boolean} - `true` if the state is valid according to the schema, `false` otherwise.
+ * @template TState - The type of the state.
+ * @param {ValidateStateOptions<TState>} params - The parameters for the validateState function.
  */
-const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, }) => {
+const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, defaultState, }) => {
     try {
-        schema.parse(state);
-        if (onValidationSuccessful) {
-            onValidationSuccessful();
-        }
-        return true;
+        const parsedState = schema.parse(state);
+        onValidationSuccessful === null || onValidationSuccessful === void 0 ? void 0 : onValidationSuccessful();
+        return parsedState;
     }
     catch (error) {
         // eslint-disable-next-line no-console
-        console.error("State validation failed.", error);
-        if (onValidationFailed) {
-            onValidationFailed(error);
-        }
-        return false;
+        console.error("Failed to parse and validate the state from local storage.", error);
+        onValidationFailed === null || onValidationFailed === void 0 ? void 0 : onValidationFailed(error);
+        return defaultState;
     }
 };
 
 /**
  * Initializes the state from local storage, parsing and validating it if a Zod schema is provided.
  *
- * @template State - The type of the state stored in local storage.
- * @param {Omit<LocalStorageParams<State>, "state">} params - The parameters for initializing the local storage state.
- * @returns {State} - The initialized state.
+ * @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) {
-        try {
-            const parsedState = JSON.parse(localStorageItem);
-            if (schema) {
-                if (validateState({ state: parsedState, schema })) {
-                    return parsedState;
-                }
-            }
-            else {
-                return parsedState;
-            }
-        }
-        catch (error) {
-            // eslint-disable-next-line no-console
-            console.error("Failed to parse and validate the state from local storage.", error);
-        }
+    if (!localStorageItem) {
+        return defaultState;
+    }
+    const parsedState = JSON.parse(localStorageItem);
+    if (schema) {
+        return validateState({ state: parsedState, defaultState, schema });
+    }
+    else {
+        return parsedState;
     }
-    return defaultState;
 };
 
 var lodash = {exports: {}};
@@ -38903,8 +38890,8 @@ var lodash = {exports: {}};
  * Custom hook for synchronizing a state variable with local storage,
  * with optional schema validation and callbacks.
  *
- * @template State - The type of the state variable.
- * @param {LocalStorageParams<State> & LocalStorageCallbacks & { state: State }} params - The parameters for the useLocalStorageEffect hook.
+ * @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);
@@ -38916,6 +38903,7 @@ const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationF
             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);
@@ -38938,9 +38926,9 @@ const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationF
 /**
  * Works like a normal useState, but saves to local storage and has optional schema validation.
  *
- * @template State - The type of the value stored in local storage.
- * @param {Omit<LocalStorageParams<State>, "state"> & LocalStorageCallbacks} options - The options for useLocalStorage.
- * @returns {[State, Dispatch<SetStateAction<State>>, () => void]} - A tuple containing the current value, a function to update the value, and a function to remove the value from local storage.
+ * @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) {
@@ -38957,10 +38945,10 @@ const useLocalStorage = ({ key, defaultState, schema, onValidationFailed, onVali
 /**
  * Works like a normal useReducer, but saves to local storage and has optional schema validation.
  *
- * @template State - The type of the state.
- * @template Action - The type of the action.
- * @param {LocalStorageParams<State> & LocalStorageCallbacks} params - The parameters for the useLocalStorageReducer function.
- * @returns {[State, Dispatch<Action>]} - A tuple containing the state and the dispatch function.
+ * @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) {

package/index.esm.js

@@ -21618,55 +21618,42 @@ const setLocalStorage = (key, value) => {
 /**
  * Validates the state object using a Zod schema.
  *
- * @template State - The type of the state.
- * @param {ValidateStateOptions<State>} params - The parameters for the validateState function.
- * @returns {boolean} - `true` if the state is valid according to the schema, `false` otherwise.
+ * @template TState - The type of the state.
+ * @param {ValidateStateOptions<TState>} params - The parameters for the validateState function.
  */
-const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, }) => {
+const validateState = ({ state, schema, onValidationFailed, onValidationSuccessful, defaultState, }) => {
     try {
-        schema.parse(state);
-        if (onValidationSuccessful) {
-            onValidationSuccessful();
-        }
-        return true;
+        const parsedState = schema.parse(state);
+        onValidationSuccessful === null || onValidationSuccessful === void 0 ? void 0 : onValidationSuccessful();
+        return parsedState;
     }
     catch (error) {
         // eslint-disable-next-line no-console
-        console.error("State validation failed.", error);
-        if (onValidationFailed) {
-            onValidationFailed(error);
-        }
-        return false;
+        console.error("Failed to parse and validate the state from local storage.", error);
+        onValidationFailed === null || onValidationFailed === void 0 ? void 0 : onValidationFailed(error);
+        return defaultState;
     }
 };
 
 /**
  * Initializes the state from local storage, parsing and validating it if a Zod schema is provided.
  *
- * @template State - The type of the state stored in local storage.
- * @param {Omit<LocalStorageParams<State>, "state">} params - The parameters for initializing the local storage state.
- * @returns {State} - The initialized state.
+ * @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) {
-        try {
-            const parsedState = JSON.parse(localStorageItem);
-            if (schema) {
-                if (validateState({ state: parsedState, schema })) {
-                    return parsedState;
-                }
-            }
-            else {
-                return parsedState;
-            }
-        }
-        catch (error) {
-            // eslint-disable-next-line no-console
-            console.error("Failed to parse and validate the state from local storage.", error);
-        }
+    if (!localStorageItem) {
+        return defaultState;
+    }
+    const parsedState = JSON.parse(localStorageItem);
+    if (schema) {
+        return validateState({ state: parsedState, defaultState, schema });
+    }
+    else {
+        return parsedState;
     }
-    return defaultState;
 };
 
 var lodash = {exports: {}};
@@ -38874,8 +38861,8 @@ var lodash = {exports: {}};
  * Custom hook for synchronizing a state variable with local storage,
  * with optional schema validation and callbacks.
  *
- * @template State - The type of the state variable.
- * @param {LocalStorageParams<State> & LocalStorageCallbacks & { state: State }} params - The parameters for the useLocalStorageEffect hook.
+ * @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);
@@ -38887,6 +38874,7 @@ const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationF
             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);
@@ -38909,9 +38897,9 @@ const useLocalStorageEffect = ({ key, state, defaultState, schema, onValidationF
 /**
  * Works like a normal useState, but saves to local storage and has optional schema validation.
  *
- * @template State - The type of the value stored in local storage.
- * @param {Omit<LocalStorageParams<State>, "state"> & LocalStorageCallbacks} options - The options for useLocalStorage.
- * @returns {[State, Dispatch<SetStateAction<State>>, () => void]} - A tuple containing the current value, a function to update the value, and a function to remove the value from local storage.
+ * @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) {
@@ -38928,10 +38916,10 @@ const useLocalStorage = ({ key, defaultState, schema, onValidationFailed, onVali
 /**
  * Works like a normal useReducer, but saves to local storage and has optional schema validation.
  *
- * @template State - The type of the state.
- * @template Action - The type of the action.
- * @param {LocalStorageParams<State> & LocalStorageCallbacks} params - The parameters for the useLocalStorageReducer function.
- * @returns {[State, Dispatch<Action>]} - A tuple containing the state and the dispatch function.
+ * @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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-components",
-  "version": "0.1.177-alpha-5bf259599b.0",
+  "version": "0.1.178",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,11 +8,11 @@
   },
   "dependencies": {
     "@floating-ui/react": "0.25.4",
-    "@trackunit/css-class-variance-utilities": "0.0.15-alpha-5bf259599b.0",
-    "@trackunit/css-core": "0.0.98-alpha-5bf259599b.0",
-    "@trackunit/shared-utils": "0.0.12-alpha-5bf259599b.0",
-    "@trackunit/ui-design-tokens": "0.0.79-alpha-5bf259599b.0",
-    "@trackunit/ui-icons": "0.0.79-alpha-5bf259599b.0",
+    "@trackunit/css-class-variance-utilities": "0.0.14",
+    "@trackunit/css-core": "0.0.97",
+    "@trackunit/shared-utils": "0.0.11",
+    "@trackunit/ui-design-tokens": "0.0.78",
+    "@trackunit/ui-icons": "0.0.78",
     "date-fns": "2.29.3",
     "lodash": "4.17.21",
     "react": "18.2.0",

package/src/hooks/localStorage/initLocalStorageState.d.ts

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

package/src/hooks/localStorage/useLocalStorage.d.ts

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

package/src/hooks/localStorage/useLocalStorageEffect.d.ts

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

package/src/hooks/localStorage/useLocalStorageReducer.d.ts

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

package/src/hooks/localStorage/validateState.d.ts

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