@ametie/vue-muza-use 0.8.0 → 0.9.0

package/dist/index.cjs

@@ -31,8 +31,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   AuthEventType: () => AuthEventType,
+  clearAllCache: () => clearAllCache,
   createApi: () => createApi,
   createApiClient: () => createApiClient,
+  invalidateCache: () => invalidateCache,
   setAuthMonitor: () => setAuthMonitor,
   setupInterceptors: () => setupInterceptors,
   tokenManager: () => tokenManager,
@@ -212,8 +214,39 @@ function useAbortController() {
   };
 }
 
+// src/features/cacheManager.ts
+var DEFAULT_STALE_TIME = 3e5;
+var cacheStore = /* @__PURE__ */ new Map();
+function readCache(id) {
+  const entry = cacheStore.get(id);
+  if (!entry) return null;
+  const isValid = Date.now() - entry.cachedAt < entry.staleTime;
+  if (!isValid) {
+    cacheStore.delete(id);
+    return null;
+  }
+  return entry.data;
+}
+function writeCache(id, data, staleTime) {
+  cacheStore.set(id, { data, cachedAt: Date.now(), staleTime });
+}
+function invalidateCache(id) {
+  const ids = Array.isArray(id) ? id : [id];
+  ids.forEach((key) => cacheStore.delete(key));
+}
+function clearAllCache() {
+  cacheStore.clear();
+}
+
 // src/useApi.ts
 var DEFAULT_RETRY_STATUS_CODES = [408, 429, 500, 502, 503, 504];
+function normalizeCacheOptions(cache) {
+  if (!cache) return null;
+  if (typeof cache === "string") {
+    return { id: cache, staleTime: DEFAULT_STALE_TIME };
+  }
+  return { id: cache.id, staleTime: cache.staleTime ?? DEFAULT_STALE_TIME };
+}
 function cancellableSleep(ms, signal) {
   return new Promise((resolve) => {
     if (signal.aborted) {
@@ -272,6 +305,14 @@ function useApi(url, options = {}) {
     return { interval: 0, whenHidden: false };
   };
   const executeRequest = async (config) => {
+    const cacheOpts = normalizeCacheOptions(options.cache);
+    if (cacheOpts) {
+      const cached = readCache(cacheOpts.id);
+      if (cached !== null) {
+        state.mutate(cached);
+        return cached;
+      }
+    }
     if (pollTimer) clearTimeout(pollTimer);
     const requestUrl = (0, import_vue4.toValue)(url);
     if (abortController2.value) abortController2.value.abort("Cancelled by new request");
@@ -317,6 +358,12 @@ function useApi(url, options = {}) {
           });
           state.mutate(response.data, response);
           state.setStatusCode(response.status);
+          if (cacheOpts) {
+            writeCache(cacheOpts.id, response.data, cacheOpts.staleTime);
+          }
+          if (options.invalidateCache) {
+            invalidateCache(options.invalidateCache);
+          }
           onSuccess?.(response);
           return response.data;
         } catch (err) {
@@ -1015,8 +1062,10 @@ function createApiClient(options = {}) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthEventType,
+  clearAllCache,
   createApi,
   createApiClient,
+  invalidateCache,
   setAuthMonitor,
   setupInterceptors,
   tokenManager,

package/dist/index.d.cts

@@ -10,6 +10,14 @@ interface ApiError {
     details?: unknown;
 }
 type AuthMode = "default" | "public" | "optional";
+interface CacheOptions {
+    id: string;
+    /**
+     * How long the cached entry is valid in milliseconds.
+     * Default: 300_000 (5 minutes)
+     */
+    staleTime?: number;
+}
 interface ApiState<T = unknown> {
     data: T | null;
     loading: boolean;
@@ -47,6 +55,22 @@ interface UseApiOptions<T = unknown, D = unknown> extends ApiRequestConfig<D> {
      * - Pass an **object** `{ interval: number, whenHidden?: boolean }` for advanced control.
      * Properties inside the object can also be Refs.
      */
+    /**
+     * Cache the response data by a string id.
+     * - String shorthand: `cache: 'key'` uses DEFAULT_STALE_TIME (5 min)
+     * - Object form: `cache: { id: 'key', staleTime: 10_000 }` for custom TTL
+     *
+     * On cache hit: mutate() is called with cached data, loading stays false,
+     * onBefore/onSuccess/onFinish are NOT called, axios request is NOT made.
+     * Cache is written only on HTTP 2xx success.
+     */
+    cache?: string | CacheOptions;
+    /**
+     * Invalidate one or more cache entries on HTTP 2xx success.
+     * Fires only after a confirmed successful response — never in catch/finally.
+     * Useful for POST/PUT/DELETE that should bust related GET caches.
+     */
+    invalidateCache?: string | string[];
     poll?: MaybeRefOrGetter<number | {
         interval: MaybeRefOrGetter<number>;
         whenHidden?: MaybeRefOrGetter<boolean>;
@@ -595,4 +619,13 @@ interface AuthEventPayload {
 type AuthMonitorFn = (type: AuthEventType, payload: AuthEventPayload) => void;
 declare function setAuthMonitor(fn: AuthMonitorFn): void;
 
-export { type ApiError, type ApiPluginOptions, type ApiRequestConfig, type ApiState, type AuthEventPayload, AuthEventType, type AuthMode, type AuthMonitorFn, type AuthTokens$1 as AuthTokens, type BatchProgress, type BatchRequestConfig, type BatchResultItem, type SetDataInput, type UseApiBatchOptions, type UseApiBatchReturn, type UseApiOptions, type UseApiReturn, createApi, createApiClient, setAuthMonitor, setupInterceptors, tokenManager, useAbortController, useApi, useApiBatch, useApiConfig, useApiDelete, useApiGet, useApiPatch, useApiPost, useApiPut, useApiState };
+/**
+ * Invalidate one or multiple cache entries by id.
+ */
+declare function invalidateCache(id: string | string[]): void;
+/**
+ * Clear all cache entries. Call on logout to prevent data leaks between users.
+ */
+declare function clearAllCache(): void;
+
+export { type ApiError, type ApiPluginOptions, type ApiRequestConfig, type ApiState, type AuthEventPayload, AuthEventType, type AuthMode, type AuthMonitorFn, type AuthTokens$1 as AuthTokens, type BatchProgress, type BatchRequestConfig, type BatchResultItem, type CacheOptions, type SetDataInput, type UseApiBatchOptions, type UseApiBatchReturn, type UseApiOptions, type UseApiReturn, clearAllCache, createApi, createApiClient, invalidateCache, setAuthMonitor, setupInterceptors, tokenManager, useAbortController, useApi, useApiBatch, useApiConfig, useApiDelete, useApiGet, useApiPatch, useApiPost, useApiPut, useApiState };

package/dist/index.d.ts

@@ -10,6 +10,14 @@ interface ApiError {
     details?: unknown;
 }
 type AuthMode = "default" | "public" | "optional";
+interface CacheOptions {
+    id: string;
+    /**
+     * How long the cached entry is valid in milliseconds.
+     * Default: 300_000 (5 minutes)
+     */
+    staleTime?: number;
+}
 interface ApiState<T = unknown> {
     data: T | null;
     loading: boolean;
@@ -47,6 +55,22 @@ interface UseApiOptions<T = unknown, D = unknown> extends ApiRequestConfig<D> {
      * - Pass an **object** `{ interval: number, whenHidden?: boolean }` for advanced control.
      * Properties inside the object can also be Refs.
      */
+    /**
+     * Cache the response data by a string id.
+     * - String shorthand: `cache: 'key'` uses DEFAULT_STALE_TIME (5 min)
+     * - Object form: `cache: { id: 'key', staleTime: 10_000 }` for custom TTL
+     *
+     * On cache hit: mutate() is called with cached data, loading stays false,
+     * onBefore/onSuccess/onFinish are NOT called, axios request is NOT made.
+     * Cache is written only on HTTP 2xx success.
+     */
+    cache?: string | CacheOptions;
+    /**
+     * Invalidate one or more cache entries on HTTP 2xx success.
+     * Fires only after a confirmed successful response — never in catch/finally.
+     * Useful for POST/PUT/DELETE that should bust related GET caches.
+     */
+    invalidateCache?: string | string[];
     poll?: MaybeRefOrGetter<number | {
         interval: MaybeRefOrGetter<number>;
         whenHidden?: MaybeRefOrGetter<boolean>;
@@ -595,4 +619,13 @@ interface AuthEventPayload {
 type AuthMonitorFn = (type: AuthEventType, payload: AuthEventPayload) => void;
 declare function setAuthMonitor(fn: AuthMonitorFn): void;
 
-export { type ApiError, type ApiPluginOptions, type ApiRequestConfig, type ApiState, type AuthEventPayload, AuthEventType, type AuthMode, type AuthMonitorFn, type AuthTokens$1 as AuthTokens, type BatchProgress, type BatchRequestConfig, type BatchResultItem, type SetDataInput, type UseApiBatchOptions, type UseApiBatchReturn, type UseApiOptions, type UseApiReturn, createApi, createApiClient, setAuthMonitor, setupInterceptors, tokenManager, useAbortController, useApi, useApiBatch, useApiConfig, useApiDelete, useApiGet, useApiPatch, useApiPost, useApiPut, useApiState };
+/**
+ * Invalidate one or multiple cache entries by id.
+ */
+declare function invalidateCache(id: string | string[]): void;
+/**
+ * Clear all cache entries. Call on logout to prevent data leaks between users.
+ */
+declare function clearAllCache(): void;
+
+export { type ApiError, type ApiPluginOptions, type ApiRequestConfig, type ApiState, type AuthEventPayload, AuthEventType, type AuthMode, type AuthMonitorFn, type AuthTokens$1 as AuthTokens, type BatchProgress, type BatchRequestConfig, type BatchResultItem, type CacheOptions, type SetDataInput, type UseApiBatchOptions, type UseApiBatchReturn, type UseApiOptions, type UseApiReturn, clearAllCache, createApi, createApiClient, invalidateCache, setAuthMonitor, setupInterceptors, tokenManager, useAbortController, useApi, useApiBatch, useApiConfig, useApiDelete, useApiGet, useApiPatch, useApiPost, useApiPut, useApiState };

package/dist/index.mjs

@@ -161,8 +161,39 @@ function useAbortController() {
   };
 }
 
+// src/features/cacheManager.ts
+var DEFAULT_STALE_TIME = 3e5;
+var cacheStore = /* @__PURE__ */ new Map();
+function readCache(id) {
+  const entry = cacheStore.get(id);
+  if (!entry) return null;
+  const isValid = Date.now() - entry.cachedAt < entry.staleTime;
+  if (!isValid) {
+    cacheStore.delete(id);
+    return null;
+  }
+  return entry.data;
+}
+function writeCache(id, data, staleTime) {
+  cacheStore.set(id, { data, cachedAt: Date.now(), staleTime });
+}
+function invalidateCache(id) {
+  const ids = Array.isArray(id) ? id : [id];
+  ids.forEach((key) => cacheStore.delete(key));
+}
+function clearAllCache() {
+  cacheStore.clear();
+}
+
 // src/useApi.ts
 var DEFAULT_RETRY_STATUS_CODES = [408, 429, 500, 502, 503, 504];
+function normalizeCacheOptions(cache) {
+  if (!cache) return null;
+  if (typeof cache === "string") {
+    return { id: cache, staleTime: DEFAULT_STALE_TIME };
+  }
+  return { id: cache.id, staleTime: cache.staleTime ?? DEFAULT_STALE_TIME };
+}
 function cancellableSleep(ms, signal) {
   return new Promise((resolve) => {
     if (signal.aborted) {
@@ -221,6 +252,14 @@ function useApi(url, options = {}) {
     return { interval: 0, whenHidden: false };
   };
   const executeRequest = async (config) => {
+    const cacheOpts = normalizeCacheOptions(options.cache);
+    if (cacheOpts) {
+      const cached = readCache(cacheOpts.id);
+      if (cached !== null) {
+        state.mutate(cached);
+        return cached;
+      }
+    }
     if (pollTimer) clearTimeout(pollTimer);
     const requestUrl = toValue(url);
     if (abortController2.value) abortController2.value.abort("Cancelled by new request");
@@ -266,6 +305,12 @@ function useApi(url, options = {}) {
           });
           state.mutate(response.data, response);
           state.setStatusCode(response.status);
+          if (cacheOpts) {
+            writeCache(cacheOpts.id, response.data, cacheOpts.staleTime);
+          }
+          if (options.invalidateCache) {
+            invalidateCache(options.invalidateCache);
+          }
           onSuccess?.(response);
           return response.data;
         } catch (err) {
@@ -963,8 +1008,10 @@ function createApiClient(options = {}) {
 }
 export {
   AuthEventType,
+  clearAllCache,
   createApi,
   createApiClient,
+  invalidateCache,
   setAuthMonitor,
   setupInterceptors,
   tokenManager,

package/package.json

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