@ametie/vue-muza-use 1.0.0 → 1.1.1

package/README.md

@@ -798,13 +798,15 @@ const { data } = useApi('/messages', {
 Apply to all `useApi` instances at once:
 
 ```typescript
-createApiClient({
-  axios,
+const api = createApiClient({ baseURL: 'https://api.example.com' })
+
+app.use(createApi({
+  axios: api,
   globalOptions: {
     refetchOnFocus: true,
     refetchOnReconnect: true,
   },
-})
+}))
 ```
 
 Opt individual requests out with `refetchOnFocus: false`:

package/dist/index.cjs

@@ -374,6 +374,16 @@ function useApi(url, options = {}) {
     if (abortController2.value) abortController2.value.abort("Cancelled by new request");
     const controller = new AbortController();
     abortController2.value = controller;
+    if (config?.signal) {
+      const signal = config.signal;
+      if (signal.aborted) {
+        controller.abort(signal.reason);
+      } else {
+        signal.addEventListener("abort", () => {
+          controller.abort(signal.reason);
+        }, { once: true });
+      }
+    }
     let globalAbortHandler = null;
     let subscribedSignal = null;
     if (globalAbort) {
@@ -608,6 +618,8 @@ function useApiBatch(requests, options = {}) {
     concurrency,
     immediate = false,
     skipErrorNotification = true,
+    lazy = false,
+    poll = 0,
     watch: watchSource,
     onItemSuccess,
     onItemError,
@@ -632,13 +644,21 @@ function useApiBatch(requests, options = {}) {
   );
   const abortControllers = (0, import_vue6.ref)([]);
   let isAborted = false;
-  const updateProgress = (succeeded, failed) => {
-    const currentRequests = getRequests();
+  let pollTimer = null;
+  const getPollConfig = () => {
+    const val = (0, import_vue6.toValue)(poll);
+    if (typeof val === "number") return { interval: val, whenHidden: false };
+    return {
+      interval: (0, import_vue6.toValue)(val.interval),
+      whenHidden: (0, import_vue6.toValue)(val.whenHidden) ?? false
+    };
+  };
+  const updateProgress = (succeeded, failed, total) => {
     const completed = succeeded + failed;
     const newProgress = {
       completed,
-      total: currentRequests.length,
-      percentage: currentRequests.length > 0 ? Math.round(completed / currentRequests.length * 100) : 0,
+      total,
+      percentage: total > 0 ? Math.round(completed / total * 100) : 0,
       succeeded,
       failed
     };
@@ -655,7 +675,8 @@ function useApiBatch(requests, options = {}) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       ...config.headers && { headers: config.headers },
       useGlobalAbort: false,
-      skipErrorNotification
+      skipErrorNotification,
+      lazy: true
     }));
     const { execute: execute2, error: reqError, statusCode, response } = api;
     try {
@@ -710,7 +731,7 @@ function useApiBatch(requests, options = {}) {
       scope.stop();
     }
   };
-  const executeWithConcurrency = async (requests2, limit) => {
+  const executeWithConcurrency = async (requests2, limit, total) => {
     const results = new Array(requests2.length);
     let succeededCount = 0;
     let failedCount = 0;
@@ -728,8 +749,9 @@ function useApiBatch(requests, options = {}) {
               errors.value.push(result.error);
             }
           }
-          updateProgress(succeededCount, failedCount);
+          updateProgress(succeededCount, failedCount, total);
           if (!settled && !result.success && result.error) {
+            abort("First request failed in non-settled mode");
             throw result.error;
           }
           return result;
@@ -758,7 +780,7 @@ function useApiBatch(requests, options = {}) {
               errors.value.push(result.error);
             }
           }
-          updateProgress(succeededCount, failedCount);
+          updateProgress(succeededCount, failedCount, total);
           if (!settled && !result.success && result.error) {
             abort("First request failed in non-settled mode");
             throw result.error;
@@ -775,6 +797,9 @@ function useApiBatch(requests, options = {}) {
     return results;
   };
   const execute = async () => {
+    if (loading.value) {
+      abort("Replaced by new execution");
+    }
     const currentRequests = getRequests();
     isAborted = false;
     loading.value = true;
@@ -782,20 +807,21 @@ function useApiBatch(requests, options = {}) {
     errors.value = [];
     data.value = [];
     abortControllers.value = [];
-    updateProgress(0, 0);
+    const total = currentRequests.length;
+    updateProgress(0, 0, total);
+    let finalResults = [];
     try {
-      const results = await executeWithConcurrency(currentRequests, concurrency);
-      data.value = results;
-      const allFailed = results.every((r) => !r.success);
-      if (allFailed && results.length > 0) {
+      finalResults = await executeWithConcurrency(currentRequests, concurrency, total);
+      data.value = finalResults;
+      const allFailed = finalResults.every((r) => !r.success);
+      if (allFailed && finalResults.length > 0) {
         error.value = {
-          message: `All ${results.length} requests failed`,
+          message: `All ${finalResults.length} requests failed`,
           status: 0,
           code: "BATCH_ALL_FAILED"
         };
       }
-      onFinish?.(results);
-      return results;
+      return finalResults;
     } catch (err) {
       if (!settled) {
         error.value = err;
@@ -804,10 +830,27 @@ function useApiBatch(requests, options = {}) {
     } finally {
       loading.value = false;
       abortControllers.value = [];
+      onFinish?.(finalResults);
+      if (!isAborted) {
+        const { interval, whenHidden } = getPollConfig();
+        if (interval > 0) {
+          const hidden = typeof document !== "undefined" && document.hidden;
+          if (whenHidden || !hidden) {
+            pollTimer = setTimeout(() => {
+              pollTimer = null;
+              execute();
+            }, interval);
+          }
+        }
+      }
     }
   };
   const abort = (message = "Batch aborted") => {
     isAborted = true;
+    if (pollTimer) {
+      clearTimeout(pollTimer);
+      pollTimer = null;
+    }
     for (const controller of abortControllers.value) {
       controller.abort(message);
     }
@@ -830,14 +873,26 @@ function useApiBatch(requests, options = {}) {
   if ((0, import_vue6.getCurrentScope)()) {
     (0, import_vue6.onScopeDispose)(() => abort("Scope disposed"));
   }
+  if (!lazy && typeof requests === "function") {
+    const trackingScope = (0, import_vue6.effectScope)();
+    trackingScope.run(() => {
+      const requestsComputed = (0, import_vue6.computed)(
+        () => requests().map(normalizeRequest)
+      );
+      (0, import_vue6.watch)(requestsComputed, () => {
+        execute();
+      }, { deep: true });
+    });
+    if ((0, import_vue6.getCurrentScope)()) (0, import_vue6.onScopeDispose)(() => trackingScope.stop());
+    execute();
+  } else if (immediate) {
+    execute();
+  }
   if (watchSource) {
     (0, import_vue6.watch)(watchSource, () => {
       execute();
     }, { deep: true });
   }
-  if (immediate) {
-    execute();
-  }
   return {
     data,
     successfulData,

package/dist/index.d.cts

@@ -139,7 +139,7 @@ interface UseApiOptions<T = unknown, D = unknown, TSelected = T> extends ApiRequ
      * Compatible with `lazy: true` — focus is a browser trigger, not a reactive dep.
      * Compatible with `poll` — both register separate listeners; `!loading` guard prevents duplicates.
      *
-     * Can be set globally via `createApiClient({ globalOptions: { refetchOnFocus: true } })`.
+     * Can be set globally via `createApi({ axios, globalOptions: { refetchOnFocus: true } })`.
      * Per-request value takes precedence over global (including `false` to opt-out).
      */
     refetchOnFocus?: boolean | {
@@ -151,7 +151,7 @@ interface UseApiOptions<T = unknown, D = unknown, TSelected = T> extends ApiRequ
      * No throttle is applied — reconnect is already a rare event.
      * No refetch fires if a request is already in-flight (`loading: true`).
      *
-     * Can be set globally via `createApiClient({ globalOptions: { refetchOnReconnect: true } })`.
+     * Can be set globally via `createApi({ axios, globalOptions: { refetchOnReconnect: true } })`.
      * Per-request value takes precedence over global (including `false` to opt-out).
      */
     refetchOnReconnect?: boolean;
@@ -336,7 +336,34 @@ interface UseApiBatchOptions<T = unknown, D = unknown> extends Omit<ApiRequestCo
     immediate?: boolean;
     /** Skip individual error notifications */
     skipErrorNotification?: boolean;
-    /** Watch sources to trigger re-execution */
+    /**
+     * Disable auto-tracking. When true, reactive changes to the `requests` getter
+     * will NOT trigger re-execution. Use when you want full manual control via execute().
+     * Default: false — auto-tracks when `requests` is a function.
+     */
+    lazy?: boolean;
+    /**
+     * Polling interval in ms, or advanced config object.
+     * - Pass a number: `poll: 5000` — re-execute every 5 seconds.
+     * - Pass an object: `poll: { interval: 5000, whenHidden: false }` — skip polling when tab is hidden.
+     * Properties inside the object can also be Refs.
+     */
+    poll?: MaybeRefOrGetter<number | {
+        interval: MaybeRefOrGetter<number>;
+        whenHidden?: MaybeRefOrGetter<boolean>;
+    }>;
+    /**
+     * @deprecated Use a reactive getter for `requests` with `lazy: false` (default).
+     * Auto-tracking will re-execute when the getter's dependencies change.
+     * Will be removed in v2.0.
+     *
+     * @example
+     * // Before (deprecated):
+     * useApiBatch(() => ids.value.map(id => `/items/${id}`), { watch: ids })
+     *
+     * // After (preferred):
+     * useApiBatch(() => ids.value.map(id => `/items/${id}`))
+     */
     watch?: WatchSource | WatchSource[];
     /** Callback when a single request succeeds */
     onItemSuccess?: (item: BatchResultItem<T>, index: number) => void;
@@ -448,7 +475,7 @@ declare function useApiDelete<T = unknown, TSelected = T>(url: MaybeRefOrGetter<
  * - Abort support for all pending requests
  * - Detailed per-request results with URL mapping
  * - Progress tracking
- * - Watch option for auto re-execution
+ * - Auto-tracking for reactive getter requests (lazy: false default)
  *
  * @example
  * ```ts
@@ -466,11 +493,10 @@ declare function useApiDelete<T = unknown, TSelected = T>(url: MaybeRefOrGetter<
  * const ids = [1, 2, 3]
  * useApiBatch(ids.map(id => ({ url: `/users/${id}`, method: 'DELETE' })))
  *
- * // Reactive getter with object configs
+ * // Reactive getter — auto-tracks deps, re-executes when pages changes
  * const pages = ref([1, 2, 3])
  * const { successfulData } = useApiBatch(
- *   () => pages.value.map(page => ({ url: '/users', params: { page } })),
- *   { watch: pages, immediate: true }
+ *   () => pages.value.map(page => ({ url: '/users', params: { page } }))
  * )
  * ```
  */

package/dist/index.d.ts

@@ -139,7 +139,7 @@ interface UseApiOptions<T = unknown, D = unknown, TSelected = T> extends ApiRequ
      * Compatible with `lazy: true` — focus is a browser trigger, not a reactive dep.
      * Compatible with `poll` — both register separate listeners; `!loading` guard prevents duplicates.
      *
-     * Can be set globally via `createApiClient({ globalOptions: { refetchOnFocus: true } })`.
+     * Can be set globally via `createApi({ axios, globalOptions: { refetchOnFocus: true } })`.
      * Per-request value takes precedence over global (including `false` to opt-out).
      */
     refetchOnFocus?: boolean | {
@@ -151,7 +151,7 @@ interface UseApiOptions<T = unknown, D = unknown, TSelected = T> extends ApiRequ
      * No throttle is applied — reconnect is already a rare event.
      * No refetch fires if a request is already in-flight (`loading: true`).
      *
-     * Can be set globally via `createApiClient({ globalOptions: { refetchOnReconnect: true } })`.
+     * Can be set globally via `createApi({ axios, globalOptions: { refetchOnReconnect: true } })`.
      * Per-request value takes precedence over global (including `false` to opt-out).
      */
     refetchOnReconnect?: boolean;
@@ -336,7 +336,34 @@ interface UseApiBatchOptions<T = unknown, D = unknown> extends Omit<ApiRequestCo
     immediate?: boolean;
     /** Skip individual error notifications */
     skipErrorNotification?: boolean;
-    /** Watch sources to trigger re-execution */
+    /**
+     * Disable auto-tracking. When true, reactive changes to the `requests` getter
+     * will NOT trigger re-execution. Use when you want full manual control via execute().
+     * Default: false — auto-tracks when `requests` is a function.
+     */
+    lazy?: boolean;
+    /**
+     * Polling interval in ms, or advanced config object.
+     * - Pass a number: `poll: 5000` — re-execute every 5 seconds.
+     * - Pass an object: `poll: { interval: 5000, whenHidden: false }` — skip polling when tab is hidden.
+     * Properties inside the object can also be Refs.
+     */
+    poll?: MaybeRefOrGetter<number | {
+        interval: MaybeRefOrGetter<number>;
+        whenHidden?: MaybeRefOrGetter<boolean>;
+    }>;
+    /**
+     * @deprecated Use a reactive getter for `requests` with `lazy: false` (default).
+     * Auto-tracking will re-execute when the getter's dependencies change.
+     * Will be removed in v2.0.
+     *
+     * @example
+     * // Before (deprecated):
+     * useApiBatch(() => ids.value.map(id => `/items/${id}`), { watch: ids })
+     *
+     * // After (preferred):
+     * useApiBatch(() => ids.value.map(id => `/items/${id}`))
+     */
     watch?: WatchSource | WatchSource[];
     /** Callback when a single request succeeds */
     onItemSuccess?: (item: BatchResultItem<T>, index: number) => void;
@@ -448,7 +475,7 @@ declare function useApiDelete<T = unknown, TSelected = T>(url: MaybeRefOrGetter<
  * - Abort support for all pending requests
  * - Detailed per-request results with URL mapping
  * - Progress tracking
- * - Watch option for auto re-execution
+ * - Auto-tracking for reactive getter requests (lazy: false default)
  *
  * @example
  * ```ts
@@ -466,11 +493,10 @@ declare function useApiDelete<T = unknown, TSelected = T>(url: MaybeRefOrGetter<
  * const ids = [1, 2, 3]
  * useApiBatch(ids.map(id => ({ url: `/users/${id}`, method: 'DELETE' })))
  *
- * // Reactive getter with object configs
+ * // Reactive getter — auto-tracks deps, re-executes when pages changes
  * const pages = ref([1, 2, 3])
  * const { successfulData } = useApiBatch(
- *   () => pages.value.map(page => ({ url: '/users', params: { page } })),
- *   { watch: pages, immediate: true }
+ *   () => pages.value.map(page => ({ url: '/users', params: { page } }))
  * )
  * ```
  */

package/dist/index.mjs

@@ -321,6 +321,16 @@ function useApi(url, options = {}) {
     if (abortController2.value) abortController2.value.abort("Cancelled by new request");
     const controller = new AbortController();
     abortController2.value = controller;
+    if (config?.signal) {
+      const signal = config.signal;
+      if (signal.aborted) {
+        controller.abort(signal.reason);
+      } else {
+        signal.addEventListener("abort", () => {
+          controller.abort(signal.reason);
+        }, { once: true });
+      }
+    }
     let globalAbortHandler = null;
     let subscribedSignal = null;
     if (globalAbort) {
@@ -555,6 +565,8 @@ function useApiBatch(requests, options = {}) {
     concurrency,
     immediate = false,
     skipErrorNotification = true,
+    lazy = false,
+    poll = 0,
     watch: watchSource,
     onItemSuccess,
     onItemError,
@@ -579,13 +591,21 @@ function useApiBatch(requests, options = {}) {
   );
   const abortControllers = ref4([]);
   let isAborted = false;
-  const updateProgress = (succeeded, failed) => {
-    const currentRequests = getRequests();
+  let pollTimer = null;
+  const getPollConfig = () => {
+    const val = toValue2(poll);
+    if (typeof val === "number") return { interval: val, whenHidden: false };
+    return {
+      interval: toValue2(val.interval),
+      whenHidden: toValue2(val.whenHidden) ?? false
+    };
+  };
+  const updateProgress = (succeeded, failed, total) => {
     const completed = succeeded + failed;
     const newProgress = {
       completed,
-      total: currentRequests.length,
-      percentage: currentRequests.length > 0 ? Math.round(completed / currentRequests.length * 100) : 0,
+      total,
+      percentage: total > 0 ? Math.round(completed / total * 100) : 0,
       succeeded,
       failed
     };
@@ -602,7 +622,8 @@ function useApiBatch(requests, options = {}) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       ...config.headers && { headers: config.headers },
       useGlobalAbort: false,
-      skipErrorNotification
+      skipErrorNotification,
+      lazy: true
     }));
     const { execute: execute2, error: reqError, statusCode, response } = api;
     try {
@@ -657,7 +678,7 @@ function useApiBatch(requests, options = {}) {
       scope.stop();
     }
   };
-  const executeWithConcurrency = async (requests2, limit) => {
+  const executeWithConcurrency = async (requests2, limit, total) => {
     const results = new Array(requests2.length);
     let succeededCount = 0;
     let failedCount = 0;
@@ -675,8 +696,9 @@ function useApiBatch(requests, options = {}) {
               errors.value.push(result.error);
             }
           }
-          updateProgress(succeededCount, failedCount);
+          updateProgress(succeededCount, failedCount, total);
           if (!settled && !result.success && result.error) {
+            abort("First request failed in non-settled mode");
             throw result.error;
           }
           return result;
@@ -705,7 +727,7 @@ function useApiBatch(requests, options = {}) {
               errors.value.push(result.error);
             }
           }
-          updateProgress(succeededCount, failedCount);
+          updateProgress(succeededCount, failedCount, total);
           if (!settled && !result.success && result.error) {
             abort("First request failed in non-settled mode");
             throw result.error;
@@ -722,6 +744,9 @@ function useApiBatch(requests, options = {}) {
     return results;
   };
   const execute = async () => {
+    if (loading.value) {
+      abort("Replaced by new execution");
+    }
     const currentRequests = getRequests();
     isAborted = false;
     loading.value = true;
@@ -729,20 +754,21 @@ function useApiBatch(requests, options = {}) {
     errors.value = [];
     data.value = [];
     abortControllers.value = [];
-    updateProgress(0, 0);
+    const total = currentRequests.length;
+    updateProgress(0, 0, total);
+    let finalResults = [];
     try {
-      const results = await executeWithConcurrency(currentRequests, concurrency);
-      data.value = results;
-      const allFailed = results.every((r) => !r.success);
-      if (allFailed && results.length > 0) {
+      finalResults = await executeWithConcurrency(currentRequests, concurrency, total);
+      data.value = finalResults;
+      const allFailed = finalResults.every((r) => !r.success);
+      if (allFailed && finalResults.length > 0) {
         error.value = {
-          message: `All ${results.length} requests failed`,
+          message: `All ${finalResults.length} requests failed`,
           status: 0,
           code: "BATCH_ALL_FAILED"
         };
       }
-      onFinish?.(results);
-      return results;
+      return finalResults;
     } catch (err) {
       if (!settled) {
         error.value = err;
@@ -751,10 +777,27 @@ function useApiBatch(requests, options = {}) {
     } finally {
       loading.value = false;
       abortControllers.value = [];
+      onFinish?.(finalResults);
+      if (!isAborted) {
+        const { interval, whenHidden } = getPollConfig();
+        if (interval > 0) {
+          const hidden = typeof document !== "undefined" && document.hidden;
+          if (whenHidden || !hidden) {
+            pollTimer = setTimeout(() => {
+              pollTimer = null;
+              execute();
+            }, interval);
+          }
+        }
+      }
     }
   };
   const abort = (message = "Batch aborted") => {
     isAborted = true;
+    if (pollTimer) {
+      clearTimeout(pollTimer);
+      pollTimer = null;
+    }
     for (const controller of abortControllers.value) {
       controller.abort(message);
     }
@@ -777,14 +820,26 @@ function useApiBatch(requests, options = {}) {
   if (getCurrentScope3()) {
     onScopeDispose3(() => abort("Scope disposed"));
   }
+  if (!lazy && typeof requests === "function") {
+    const trackingScope = effectScope2();
+    trackingScope.run(() => {
+      const requestsComputed = computed2(
+        () => requests().map(normalizeRequest)
+      );
+      watch2(requestsComputed, () => {
+        execute();
+      }, { deep: true });
+    });
+    if (getCurrentScope3()) onScopeDispose3(() => trackingScope.stop());
+    execute();
+  } else if (immediate) {
+    execute();
+  }
   if (watchSource) {
     watch2(watchSource, () => {
       execute();
     }, { deep: true });
   }
-  if (immediate) {
-    execute();
-  }
   return {
     data,
     successfulData,

package/package.json

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