use-good-hooks 1.0.40 → 1.0.41

package/README.md

@@ -230,7 +230,7 @@ const TextEditor = () => {
         <button onClick={actions.redo} disabled={!state.canRedo}>
           Redo
         </button>
-        <button onClick={actions.clear}>Clear History</button>
+        <button onClick={actions.initial}>Initial State</button>
       </div>
       <p>Past states: {state.past.length}</p>
       <p>Future states: {state.future.length}</p>
@@ -256,7 +256,7 @@ Returns a tuple `[historyState, historyActions]`:
 
 **historyState** (Object): - `canRedo`: Boolean indicating if redo is possible - `canUndo`: Boolean indicating if undo is possible - `future`: Array of future states (for redo) - `past`: Array of past states (for undo) - `paused`: Boolean indicating if the history is paused - `present`: The current state value
 
-**historyActions** (Object): - `clear`: Function to clear the history and reset to initial state - `pause`: Function to pause history tracking (updates won't be recorded) - `redo`: Function to move to the next state (redo) - `replace`: Function to replace the state without adding to history - `resume`: Function to resume history tracking - `set`: Function to update the state and record history (debounced by default) - `setDirect`: Function to update the state immediately, bypassing debounce - `undo`: Function to move to the previous state (undo)
+**historyActions** (Object): - `initial`: Function to reset to initial state - `pause`: Function to pause history tracking (updates won't be recorded) - `redo`: Function to move to the next state (redo) - `replace`: Function to replace the state without adding to history - `resume`: Function to resume history tracking - `set`: Function to update the state and record history (debounced by default) - `setDirect`: Function to update the state immediately, bypassing debounce - `undo`: Function to move to the previous state (undo)
 
 #### Example with onChange callback
 
@@ -265,7 +265,7 @@ const Editor = () => {
   const [state, actions] = useHistoryState('', {
     onChange: ({ action, state }) => {
       console.log(`Action: ${action}, State: ${state}`);
-      // Action can be: 'SET', 'UNDO', 'REDO', 'CLEAR', 'REPLACE'
+      // Action can be: 'SET', 'UNDO', 'REDO', 'INITIAL', 'REPLACE'
     }
   });
 

package/dist/use-history-state.d.ts

@@ -3,7 +3,7 @@ import { DebounceSettings } from 'lodash';
 export { DebounceSettings }
 
 export declare type HistoryAction<T> = {
-    type: 'CLEAR';
+    type: 'INITIAL';
     initialState: T;
 } | {
     type: 'PAUSE';
@@ -50,7 +50,7 @@ declare const useHistoryState: <T>(initialState: T, options?: HistoryOptions<T>)
     paused: boolean;
     present: T;
 }, {
-    clear: () => void;
+    initial: () => void;
     pause: () => void;
     redo: () => void;
     replace: (newPresent: T) => void;

package/dist/use-history-state.js

@@ -1,25 +1,25 @@
-import { useRef as A, useReducer as O, useMemo as D, useEffect as b } from "react";
-import h from "lodash/cloneDeep";
-import g from "lodash/debounce";
-import i from "lodash/size";
-const L = {
+import { useRef as A, useReducer as N, useMemo as D, useEffect as O } from "react";
+import T from "lodash/cloneDeep";
+import b from "lodash/debounce";
+import c from "lodash/size";
+const h = {
   future: [],
   past: [],
   present: null
-}, c = (f, p) => p ? f : h(f), M = (f, p, w) => w ? f === p : JSON.stringify(f) === JSON.stringify(p), H = (f, p) => {
-  const w = A(f), E = A(p ?? {}), [l, a] = O(
+}, i = (f, p) => p ? f : T(f), g = (f, p, w) => w ? f === p : JSON.stringify(f) === JSON.stringify(p), F = (f, p) => {
+  const w = A(f), d = A(p ?? {}), [l, a] = N(
     (n, e) => {
       const {
         immutable: u = !0,
         maxCapacity: r = 10,
         onChange: S = () => null
-      } = E.current, { future: R, past: y, paused: d, present: m } = n;
-      if (e.type === "CLEAR") {
+      } = d.current, { future: R, past: y, paused: E, present: m } = n;
+      if (e.type === "INITIAL") {
         const s = {
           future: [],
           past: [],
-          paused: d,
-          present: c(e.initialState, u)
+          paused: E,
+          present: i(e.initialState, u)
         };
         return S({
           action: e.type,
@@ -32,13 +32,13 @@ const L = {
             paused: !0
           };
         if (e.type === "REDO") {
-          if (i(R) === 0)
+          if (c(R) === 0)
             return n;
           const s = R[0], o = {
             future: R.slice(1),
-            past: [...y, c(m, u)],
-            paused: d,
-            present: c(s, u)
+            past: [...y, i(m, u)],
+            paused: E,
+            present: i(s, u)
           };
           return S({
             action: e.type,
@@ -63,12 +63,12 @@ const L = {
             }), t;
           } else if (e.type === "SET") {
             const { newPresent: s } = e;
-            if (M(s, m, u))
+            if (g(s, m, u))
               return n;
-            if (d) {
+            if (E) {
               const U = {
                 ...n,
-                present: c(s, u)
+                present: i(s, u)
               };
               return S({
                 action: e.type,
@@ -76,25 +76,25 @@ const L = {
               }), U;
             }
             let t = [...y];
-            m !== null && (t = [...t, c(m, u)]), r > 0 && i(t) > r && (t = t.slice(i(t) - r));
+            m !== null && (t = [...t, i(m, u)]), r > 0 && c(t) > r && (t = t.slice(c(t) - r));
             const o = {
               future: [],
               past: t,
-              paused: d,
-              present: c(s, u)
+              paused: E,
+              present: i(s, u)
             };
             return S({
               action: e.type,
               state: o.present
             }), o;
           } else if (e.type === "UNDO") {
-            if (i(y) === 0)
+            if (c(y) === 0)
               return n;
-            const s = y[i(y) - 1], t = y.slice(0, i(y) - 1), o = {
-              future: [c(m, u), ...R],
+            const s = y[c(y) - 1], t = y.slice(0, c(y) - 1), o = {
+              future: [i(m, u), ...R],
               past: t,
-              paused: d,
-              present: c(s, u)
+              paused: E,
+              present: i(s, u)
             };
             return S({
               action: e.type,
@@ -106,30 +106,30 @@ const L = {
       }
     },
     {
-      ...L,
-      paused: E.current.paused ?? !1,
-      present: c(
+      ...h,
+      paused: d.current.paused ?? !1,
+      present: i(
         w.current,
-        E.current.immutable
+        d.current.immutable
       )
     }
   ), P = D(() => ({
-    canRedo: i(l.future) !== 0,
-    canUndo: i(l.past) !== 0,
+    canRedo: c(l.future) !== 0,
+    canUndo: c(l.past) !== 0,
     future: l.future,
     past: l.past,
     paused: l.paused,
     present: l.present
-  }), [l]), C = D(() => {
-    const { debounceMs: n = 250, debounceSettings: e } = E.current, u = g(
+  }), [l]), I = D(() => {
+    const { debounceMs: n = 250, debounceSettings: e } = d.current, u = b(
       (r) => a({ type: "SET", newPresent: r }),
       n,
       e
     );
     return {
-      clear: () => {
+      initial: () => {
         a({
-          type: "CLEAR",
+          type: "INITIAL",
           initialState: w.current
         });
       },
@@ -156,10 +156,10 @@ const L = {
       }
     };
   }, []);
-  return b(() => {
-    p && (E.current = p);
-  }, [p]), [P, C];
+  return O(() => {
+    p && (d.current = p);
+  }, [p]), [P, I];
 };
 export {
-  H as default
+  F as default
 };

package/package.json

@@ -50,5 +50,5 @@
 		"test:coverage": "vitest --coverage --run",
 		"test:watch": "vitest"
 	},
-	"version": "1.0.40"
+	"version": "1.0.41"
 }