@hvakr/firestate 0.1.6 → 0.1.7

package/README.md

@@ -340,9 +340,14 @@ This distinction is important for collaborative applications where multiple user
 
 ### Undo/Redo
 
-Every undoable update automatically creates an undo action. Actions with the same `undoGroupId` are merged:
+Undo tracking is opt-in per resource. Enable it on the hook, then each update
+automatically creates an undo action. Actions with the same `undoGroupId` are
+merged:
 
 ```tsx
+const project = useProject({ projectId }, { undoable: true })
+const spaces = useSpaces({ projectId }, { undoable: true })
+
 const groupId = crypto.randomUUID()
 
 // These two updates become a single undo action
@@ -353,7 +358,7 @@ spaces.update({ space1: { name: 'Updated' } }, { undoGroupId: groupId })
 Grouped actions undo newest-first and redo oldest-first, so one undo/redo
 always applies the complete group in write order.
 
-To skip undo tracking:
+After opting in, exclude an individual write from undo tracking with:
 
 ```tsx
 project.update({ lastViewed: Date.now() }, { undoable: false })
@@ -683,7 +688,7 @@ const {
     definition: projectDoc,
     params: { projectId: '123' },
     readOnly: false, // Optional: override read-only
-    undoable: true, // Optional: enable undo (default: true)
+    undoable: true, // Optional: enable undo (default: false)
     enabled: true, // Optional: set false until required params exist
 })
 

package/dist/index.d.mts

@@ -674,7 +674,7 @@ interface UseDocumentOptions<TData extends FirestoreObject> {
   params?: Record<string, string>;
   /** Override read-only setting */
   readOnly?: boolean;
-  /** Enable undo/redo for this document (default: true) */
+  /** Enable undo/redo for this document (default: false) */
   undoable?: boolean;
   /**
        * If false, no subscription is created and a no-op handle is returned
@@ -764,7 +764,7 @@ interface UseCollectionOptions<TData extends FirestoreObject> {
   readOnly?: boolean;
   /** Additional query constraints */
   queryConstraints?: QueryConstraint[];
-  /** Enable undo/redo for this collection (default: true) */
+  /** Enable undo/redo for this collection (default: false) */
   undoable?: boolean;
   /**
        * If false, no subscription is created and a no-op handle is returned

package/dist/index.mjs

@@ -1279,14 +1279,14 @@ const getDocumentShared = ({ store, definition, collectionPath, docId, readOnly
 		const entry = {
 			sub: null,
 			refCount: 0,
-			undoableEnabled: true,
+			undoableEnabled: false,
 			live: true
 		};
 		entry.sub = buildSub(entry);
 		return entry;
 	};
 	let ent = map.get(key) ?? buildEntry();
-	let desiredUndoable = true;
+	let desiredUndoable = false;
 	let readOnlySource = null;
 	let readOnlyHandle = null;
 	return {
@@ -1361,7 +1361,7 @@ const getCollectionShared = ({ store, definition, collectionPath, readOnly, quer
 		const entry = {
 			sub: null,
 			refCount: 0,
-			undoableEnabled: true,
+			undoableEnabled: false,
 			live: true,
 			query: query$1
 		};
@@ -1369,7 +1369,7 @@ const getCollectionShared = ({ store, definition, collectionPath, readOnly, quer
 		return entry;
 	};
 	let ent = bucket.find((e) => sameQuery(e.query, query$1)) ?? buildEntry();
-	let desiredUndoable = true;
+	let desiredUndoable = false;
 	let readOnlySource = null;
 	let readOnlyHandle = null;
 	return {
@@ -1571,7 +1571,7 @@ const useIsSynced = () => {
 	return useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
 };
 function useDocument(options) {
-	const { definition, params = {}, readOnly, undoable = true, enabled = true, selector, isEqual } = options;
+	const { definition, params = {}, readOnly, undoable = false, enabled = true, selector, isEqual } = options;
 	const store = useStore();
 	const docId = enabled ? typeof definition.id === "function" ? definition.id(params) : definition.id : void 0;
 	const collectionPath = enabled ? typeof definition.collection === "function" ? definition.collection(params) : definition.collection : void 0;
@@ -1640,7 +1640,7 @@ function useDocument(options) {
 	]);
 }
 function useCollection(options) {
-	const { definition, params = {}, readOnly, queryConstraints, undoable = true, enabled = true, selector, isEqual } = options;
+	const { definition, params = {}, readOnly, queryConstraints, undoable = false, enabled = true, selector, isEqual } = options;
 	const store = useStore();
 	const collectionPath = enabled ? typeof definition.path === "function" ? definition.path(params) : definition.path : void 0;
 	const stableConstraintsRef = useRef(queryConstraints);