@ametie/vue-muza-use 0.6.0 → 0.6.1

package/README.md

@@ -378,9 +378,9 @@ const { execute } = useApi('/analytics', {
 
 ### Manual Data Updates
 
-Use `setData` to manually update the data ref. Supports direct values or updater functions (like React's `setState`).
+Use `mutate` to manually update the data ref. Supports direct values or updater functions (like React's `setState`).
 
-> 🎓 **When to use `setData`:**  
+> 🎓 **When to use `mutate`:**  
 > ✅ Adding/removing/updating items in arrays  
 > ✅ Local sorting/filtering (without refetching)  
 > ✅ Transform data in `onSuccess` (adding computed fields)
@@ -392,21 +392,21 @@ Use `setData` to manually update the data ref. Supports direct values or updater
 
 #### Add/Remove/Update Items
 ```typescript
-const { data, setData } = useApi<Todo[]>('/todos', { immediate: true })
+const { data, mutate } = useApi<Todo[]>('/todos', { immediate: true })
 
 // Add item
 const addTodo = (newTodo: Todo) => {
-  setData(prev => prev ? [...prev, newTodo] : [newTodo])
+  mutate(prev => prev ? [...prev, newTodo] : [newTodo])
 }
 
 // Remove item
 const removeTodo = (id: number) => {
-  setData(prev => prev?.filter(t => t.id !== id) ?? null)
+  mutate(prev => prev?.filter(t => t.id !== id) ?? null)
 }
 
 // Update item
 const updateTodo = (id: number, updates: Partial<Todo>) => {
-  setData(prev => 
+  mutate(prev => 
     prev?.map(t => t.id === id ? { ...t, ...updates } : t) ?? null
   )
 }
@@ -414,14 +414,14 @@ const updateTodo = (id: number, updates: Partial<Todo>) => {
 
 #### Sort/Filter Locally
 ```typescript
-const { data, setData } = useApi<Product[]>('/products', { immediate: true })
+const { data, mutate } = useApi<Product[]>('/products', { immediate: true })
 
 const sortByPrice = () => {
-  setData(prev => prev ? [...prev].sort((a, b) => a.price - b.price) : null)
+  mutate(prev => prev ? [...prev].sort((a, b) => a.price - b.price) : null)
 }
 
 const filterActive = () => {
-  setData(prev => prev?.filter(p => p.active) ?? null)
+  mutate(prev => prev?.filter(p => p.active) ?? null)
 }
 
 // Reset to original
@@ -430,7 +430,7 @@ const resetFilters = () => execute()
 
 #### Transform in `onSuccess`
 
-Use `setData` in `onSuccess` to transform data right after fetching. Two approaches:
+Use `mutate` in `onSuccess` to transform data right after fetching. Two approaches:
 
 **Approach 1: Same type (recommended)**
 ```typescript
@@ -441,11 +441,11 @@ interface User {
   fullName?: string  // Optional field
 }
 
-const { data, setData } = useApi<User[]>('/users', {
+const { data, mutate } = useApi<User[]>('/users', {
   immediate: true,
   onSuccess: ({ data: users }) => {
     // Add computed field - still User[] type
-    setData(users.map(u => ({
+    mutate(users.map(u => ({
       ...u,
       fullName: `${u.firstName} ${u.lastName}`
     })))
@@ -473,7 +473,7 @@ const users = computed(() =>
 ```
 
 > 💡 **Rule of thumb:**  
-> - ✅ **Use `setData` in `onSuccess`** if you're adding/modifying fields but keeping the same base type  
+> - ✅ **Use `mutate` in `onSuccess`** if you're adding/modifying fields but keeping the same base type  
 > - ✅ **Use `computed`** if you're completely changing the data structure (e.g., snake_case → camelCase)
 
 ---
@@ -1089,7 +1089,7 @@ The main composable for making HTTP requests.
   
   // Methods
   execute: (config?: AxiosRequestConfig) => Promise<T | null>
-  setData: (data: T | null | ((prev: T | null) => T | null)) => void
+  mutate: (data: T | null | ((prev: T | null) => T | null)) => void
   abort: (reason?: string) => void
   reset: () => void
 }
@@ -1108,23 +1108,23 @@ await execute()
 await execute({ params: { page: 2 } })
 ```
 
-#### `setData(newData)`
+#### `mutate(newData)`
 Manually update the `data` ref. Supports direct values or updater functions:
 
 ```typescript
-const { data, setData } = useApi<User[]>('/users')
+const { data, mutate } = useApi<User[]>('/users')
 
 // Direct value
-setData([{ id: 1, name: 'John' }])
+mutate([{ id: 1, name: 'John' }])
 
 // Updater function (like React's setState)
-setData(prev => prev ? [...prev, newUser] : [newUser])
+mutate(prev => prev ? [...prev, newUser] : [newUser])
 
 // Remove item
-setData(prev => prev?.filter(u => u.id !== userId) ?? null)
+mutate(prev => prev?.filter(u => u.id !== userId) ?? null)
 ```
 
-> **Note:** `setData` automatically clears any existing error.
+> **Note:** `mutate` automatically clears any existing error.
 
 #### `abort(reason?)`
 Cancel the current request:

package/dist/index.cjs

@@ -127,7 +127,7 @@ function useApiState(initialData = null, options = {}) {
   const error = (0, import_vue2.ref)(null);
   const statusCode = (0, import_vue2.ref)(null);
   const response = (0, import_vue2.ref)(null);
-  const setData = (newDataOrUpdater, fullResponse) => {
+  const mutate = (newDataOrUpdater, fullResponse) => {
     if (typeof newDataOrUpdater === "function") {
       const updater = newDataOrUpdater;
       data.value = updater(data.value);
@@ -161,7 +161,7 @@ function useApiState(initialData = null, options = {}) {
     error,
     statusCode,
     response,
-    setData,
+    mutate,
     setError,
     setLoading,
     setStatusCode,
@@ -273,7 +273,7 @@ function useApi(url, options = {}) {
         signal: controller.signal,
         ...{ authMode: config?.authMode || authMode }
       });
-      state.setData(response.data, response);
+      state.mutate(response.data, response);
       state.setStatusCode(response.status);
       onSuccess?.(response);
       return response.data;

package/dist/index.d.cts

@@ -56,24 +56,24 @@ interface UseApiReturn<T = unknown, D = unknown> {
     abort: (message?: string) => void;
     reset: () => void;
     /**
-     * Manually update data. Supports direct value or updater function.
+     * Manually mutate data. Supports direct value or updater function.
      * Clears any existing error when called.
      *
      * @example
      * // Direct value
-     * setData(newUsers)
+     * mutate(newUsers)
      *
      * // Updater function (like React's setState)
-     * setData(prev => prev?.filter(u => u.active) ?? null)
+     * mutate(prev => prev?.filter(u => u.active) ?? null)
      *
      * // Transform data after fetch
-     * const { data, setData } = useApi('/users', {
+     * const { data, mutate } = useApi('/users', {
      *   onSuccess: ({ data }) => {
-     *     setData(data.map(user => ({ ...user, fullName: `${user.first} ${user.last}` })))
+     *     mutate(data.map(user => ({ ...user, fullName: `${user.first} ${user.last}` })))
      *   }
      * })
      */
-    setData: (newData: T | null | ((prev: T | null) => T | null)) => void;
+    mutate: (newData: T | null | ((prev: T | null) => T | null)) => void;
 }
 interface ApiPluginOptions {
     axios: AxiosInstance;
@@ -304,7 +304,7 @@ declare function useApiBatch<T = unknown>(urls: MaybeRefOrGetter<string[]>, opti
  * - !data && !error && !loading → idle
  */
 
-/** Input type for setData - supports direct value or updater function */
+/** Input type for mutate - supports direct value or updater function */
 type SetDataInput<T> = T | null | ((prev: T | null) => T | null);
 interface UseApiStateReturn<T = unknown> {
     /** Response data */
@@ -318,15 +318,15 @@ interface UseApiStateReturn<T = unknown> {
     /** Full Axios response - includes headers, status, config, etc (optional, for advanced use cases) */
     response: Ref<AxiosResponse<T> | null>;
     /**
-     * Set data and clear error. Supports direct value or updater function.
+     * Mutate data and clear error. Supports direct value or updater function.
      * @example
      * // Direct value
-     * setData(newUsers)
+     * mutate(newUsers)
      *
      * // Updater function (like React's setState)
-     * setData(prev => prev?.filter(u => u.active) ?? null)
+     * mutate(prev => prev?.filter(u => u.active) ?? null)
      */
-    setData: (newData: SetDataInput<T>, fullResponse?: AxiosResponse<T> | null) => void;
+    mutate: (newData: SetDataInput<T>, fullResponse?: AxiosResponse<T> | null) => void;
     /** Set error */
     setError: (newError: ApiError | null) => void;
     /** Set loading state */

package/dist/index.d.ts

@@ -56,24 +56,24 @@ interface UseApiReturn<T = unknown, D = unknown> {
     abort: (message?: string) => void;
     reset: () => void;
     /**
-     * Manually update data. Supports direct value or updater function.
+     * Manually mutate data. Supports direct value or updater function.
      * Clears any existing error when called.
      *
      * @example
      * // Direct value
-     * setData(newUsers)
+     * mutate(newUsers)
      *
      * // Updater function (like React's setState)
-     * setData(prev => prev?.filter(u => u.active) ?? null)
+     * mutate(prev => prev?.filter(u => u.active) ?? null)
      *
      * // Transform data after fetch
-     * const { data, setData } = useApi('/users', {
+     * const { data, mutate } = useApi('/users', {
      *   onSuccess: ({ data }) => {
-     *     setData(data.map(user => ({ ...user, fullName: `${user.first} ${user.last}` })))
+     *     mutate(data.map(user => ({ ...user, fullName: `${user.first} ${user.last}` })))
      *   }
      * })
      */
-    setData: (newData: T | null | ((prev: T | null) => T | null)) => void;
+    mutate: (newData: T | null | ((prev: T | null) => T | null)) => void;
 }
 interface ApiPluginOptions {
     axios: AxiosInstance;
@@ -304,7 +304,7 @@ declare function useApiBatch<T = unknown>(urls: MaybeRefOrGetter<string[]>, opti
  * - !data && !error && !loading → idle
  */
 
-/** Input type for setData - supports direct value or updater function */
+/** Input type for mutate - supports direct value or updater function */
 type SetDataInput<T> = T | null | ((prev: T | null) => T | null);
 interface UseApiStateReturn<T = unknown> {
     /** Response data */
@@ -318,15 +318,15 @@ interface UseApiStateReturn<T = unknown> {
     /** Full Axios response - includes headers, status, config, etc (optional, for advanced use cases) */
     response: Ref<AxiosResponse<T> | null>;
     /**
-     * Set data and clear error. Supports direct value or updater function.
+     * Mutate data and clear error. Supports direct value or updater function.
      * @example
      * // Direct value
-     * setData(newUsers)
+     * mutate(newUsers)
      *
      * // Updater function (like React's setState)
-     * setData(prev => prev?.filter(u => u.active) ?? null)
+     * mutate(prev => prev?.filter(u => u.active) ?? null)
      */
-    setData: (newData: SetDataInput<T>, fullResponse?: AxiosResponse<T> | null) => void;
+    mutate: (newData: SetDataInput<T>, fullResponse?: AxiosResponse<T> | null) => void;
     /** Set error */
     setError: (newError: ApiError | null) => void;
     /** Set loading state */

package/dist/index.mjs

@@ -76,7 +76,7 @@ function useApiState(initialData = null, options = {}) {
   const error = ref(null);
   const statusCode = ref(null);
   const response = ref(null);
-  const setData = (newDataOrUpdater, fullResponse) => {
+  const mutate = (newDataOrUpdater, fullResponse) => {
     if (typeof newDataOrUpdater === "function") {
       const updater = newDataOrUpdater;
       data.value = updater(data.value);
@@ -110,7 +110,7 @@ function useApiState(initialData = null, options = {}) {
     error,
     statusCode,
     response,
-    setData,
+    mutate,
     setError,
     setLoading,
     setStatusCode,
@@ -222,7 +222,7 @@ function useApi(url, options = {}) {
         signal: controller.signal,
         ...{ authMode: config?.authMode || authMode }
       });
-      state.setData(response.data, response);
+      state.mutate(response.data, response);
       state.setStatusCode(response.status);
       onSuccess?.(response);
       return response.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ametie/vue-muza-use",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Powerful Vue 3 API composable (Muza Kit) with Axios, Auto-Refresh & TypeScript",
   "author": "MortyQ",
   "license": "MIT",