deepspace 0.2.6 → 0.2.8

package/dist/index.d.ts

@@ -5656,25 +5656,32 @@ declare function useQuery<T = unknown>(collection: string, options?: {
 /**
  * Get mutation functions for a collection.
  *
+ * Type contract:
+ *   - `create(data)` requires the **full** record shape `T`. New records
+ *     have no existing data to merge with, so all fields the schema
+ *     considers required must be present.
+ *   - `put(recordId, patch)` accepts a **`Partial<T>`**. The server
+ *     merges the patch into the existing row (`{...existing, ...patch}`),
+ *     so callers should send only the fields they want to change.
+ *
  * @example
  * ```tsx
- * const { create, put, remove, createConfirmed, putConfirmed, removeConfirmed } = useMutations('tasks')
+ * const { create, put, remove } = useMutations<Task>('tasks')
  *
- * // Fire-and-forget
- * const id = await create({ title: 'New task' })
- * await put(id, { title: 'Updated task' })
- * await remove(id)
+ * // create needs the full Task shape
+ * const id = await create({ title: 'New task', completed: false, priority: 1 })
  *
- * // Server-acknowledged
- * const id2 = await createConfirmed({ title: 'New task' })
+ * // put is a partial update — only the fields you want to change
+ * await put(id, { completed: true })
+ * await remove(id)
  * ```
  */
 declare function useMutations<T = unknown>(collection: string): {
     create: (data: T) => Promise<string>;
-    put: (recordId: string, data: T) => Promise<void>;
+    put: (recordId: string, data: Partial<T>) => Promise<void>;
     remove: (recordId: string) => Promise<void>;
     createConfirmed: (data: T) => Promise<string>;
-    putConfirmed: (recordId: string, data: T) => Promise<void>;
+    putConfirmed: (recordId: string, data: Partial<T>) => Promise<void>;
     removeConfirmed: (recordId: string) => Promise<void>;
 };