refactor: don't record state history by default

Recording state history by default destroys the forward history if you rewind and click on something
measuredco · Oct 16, 2023 · 28920a2 · 28920a2
1 parent bb4b386
commit 28920a2
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/packages/core/components/Puck/index.tsx b/packages/core/components/Puck/index.tsx
@@ -109,7 +109,10 @@ export function Puck({
 
   const setItemSelector = useCallback(
     (newItemSelector: ItemSelector | null) => {
-      dispatch({ type: "setState", state: { itemSelector: newItemSelector } });
+      dispatch({
+        type: "setState",
+        state: { itemSelector: newItemSelector },
+      });
     },
     []
   );

diff --git a/packages/core/reducer/actions.tsx b/packages/core/reducer/actions.tsx
@@ -66,7 +66,7 @@ export type UnregisterZoneAction = {
   zone: string;
 };
 
-export type PuckAction =
+export type PuckAction = { recordHistory?: boolean } & (
   | ReorderAction
   | InsertAction
   | MoveAction
@@ -77,4 +77,5 @@ export type PuckAction =
   | SetDataAction
   | SetStateAction
   | RegisterZoneAction
-  | UnregisterZoneAction;
+  | UnregisterZoneAction
+);
diff --git a/packages/core/reducer/index.ts b/packages/core/reducer/index.ts
@@ -13,13 +13,21 @@ export type ActionType = "insert" | "reorder";
 export type StateReducer = Reducer<AppData, PuckAction>;
 
 const storeInterceptor = (reducer: StateReducer) => {
-  return (data, action) => {
-    const newAppData = reducer(data, action);
+  return (appData: AppData, action: PuckAction) => {
+    const newAppData = reducer(appData, action);
+
+    const isValidType = ![
+      "registerZone",
+      "unregisterZone",
+      "setData",
+      "setState",
+      "set",
+    ].includes(action.type);
 
     if (
-      !["registerZone", "unregisterZone", "setData", "set"].includes(
-        action.type
-      )
+      typeof action.recordHistory !== "undefined"
+        ? action.recordHistory
+        : isValidType
     ) {
       recordDiff(newAppData);
     }