@swoff/cli 0.4.1 → 0.4.4

package/templates/vue/useSwoffAuth.ts

@@ -0,0 +1,118 @@
+import { ref, onMounted, onUnmounted } from "vue";
+import { getAuthState } from "../auth/state";
+import { setAuth, clearAuth, ensureValidAuth } from "../auth/store";
+import type { AuthData } from "../auth/adapter";
+
+/**
+ * Reactive auth state with actions: setAuth, clearAuth, ensureValid.
+ *
+ * Listens for sw-auth-state-change events (dispatched by clearAuth(),
+ * setAuth(), or the SW's AUTH_CLEARED broadcast).
+ *
+ * Usage:
+ *   const { authenticated, auth, online, isLoading, error, setAuth, clearAuth, ensureValid } = useSwoffAuth();
+ *
+ *   // Login:
+ *   const res = await fetch("/api/login", { method: "POST" });
+ *   const data = await res.json();
+ *   await setAuth({ token: data.token, user: data.user, expiresAt: data.expiresAt });
+ *
+ *   // Access user data (typed via AuthData):
+ *   const userName = auth?.user?.name;
+ *
+ *   // Logout — clears tokens from memory and user cache from IndexedDB:
+ *   await clearAuth();
+ *
+ *   // Silently refresh the session (page restore):
+ *   const authData = await ensureValid();
+ *
+ * @returns {{ authenticated, auth, online, isLoading, error, setAuth, clearAuth, ensureValid }}
+ */
+export function useSwoffAuth() {
+  const authenticated = ref(false);
+  const auth = ref<AuthData | null>(null);
+  const online = ref(typeof navigator !== "undefined" ? navigator.onLine : true);
+  const isLoading = ref(false);
+  const error = ref<Error | null>(null);
+
+  async function refreshState() {
+    try {
+      const authState = await getAuthState();
+      authenticated.value = authState.authenticated;
+      auth.value = authState.auth;
+      error.value = null;
+    } catch {
+      // ignore — auth not initialized
+    }
+  }
+
+  onMounted(() => {
+    refreshState();
+
+    function onOnline() { online.value = true; }
+    function onOffline() { online.value = false; }
+    function onAuthChange() { refreshState(); }
+
+    window.addEventListener("online", onOnline);
+    window.addEventListener("offline", onOffline);
+    window.addEventListener("sw-auth-state-change", onAuthChange);
+
+    onUnmounted(() => {
+      window.removeEventListener("online", onOnline);
+      window.removeEventListener("offline", onOffline);
+      window.removeEventListener("sw-auth-state-change", onAuthChange);
+    });
+  });
+
+  async function doSetAuth(authData: AuthData) {
+    isLoading.value = true;
+    error.value = null;
+    try {
+      await setAuth(authData);
+      await refreshState();
+    } catch (err) {
+      error.value = err instanceof Error ? err : new Error(String(err));
+    } finally {
+      isLoading.value = false;
+    }
+  }
+
+  async function doClearAuth() {
+    isLoading.value = true;
+    error.value = null;
+    try {
+      await clearAuth();
+      await refreshState();
+    } catch (err) {
+      error.value = err instanceof Error ? err : new Error(String(err));
+    } finally {
+      isLoading.value = false;
+    }
+  }
+
+  async function doEnsureValid(): Promise<AuthData | null> {
+    isLoading.value = true;
+    error.value = null;
+    try {
+      const result = await ensureValidAuth();
+      await refreshState();
+      return result;
+    } catch (err) {
+      error.value = err instanceof Error ? err : new Error(String(err));
+      return null;
+    } finally {
+      isLoading.value = false;
+    }
+  }
+
+  return {
+    authenticated,
+    auth,
+    online,
+    isLoading,
+    error,
+    setAuth: doSetAuth,
+    clearAuth: doClearAuth,
+    ensureValid: doEnsureValid,
+  };
+}

package/templates/vue/useSwoffFetch.js

@@ -0,0 +1,127 @@
+import { ref, onMounted, onUnmounted, watch } from "vue";
+import { fetchWithCache } from "../fetch/core.js";
+import { generateTags } from "../cache/tags.js";
+
+/**
+ * Fetch and cache data with automatic invalidation, revalidation, and offline support.
+ *
+ * Usage:
+ *   const { data, error, loading, refetch } = useSwoffFetch("/api/todos");
+ *
+ *   // Select/transform data
+ *   const { data: names } = useSwoffFetch("/api/users", {
+ *     select: (users) => users.map(u => u.name),
+ *   });
+ *
+ *   // Keep previous data while fetching the next page
+ *   const { data } = useSwoffFetch(`/api/items?page=${page}`, {
+ *     keepPreviousData: true,
+ *   });
+ */
+export function useSwoffFetch(url, options = {}) {
+  const {
+    select,
+    retry: retryOpt,
+    placeholderData,
+    onSuccess,
+    onError,
+    ...fetchOptions
+  } = options;
+
+  const data = ref(placeholderData ?? null);
+  const error = ref(null);
+  const loading = ref(url != null && options.enabled !== false);
+  const refetchCount = ref(0);
+
+  let cachedData = placeholderData ?? null;
+
+  const isEnabled = options.enabled !== false && url != null;
+
+  function refetch() {
+    refetchCount.value++;
+  }
+
+  watch(
+    () => url,
+    () => {
+      if (isEnabled) refetch();
+    },
+  );
+
+  watch(
+    [() => url, () => refetchCount.value],
+    () => {
+      if (!isEnabled) return;
+
+      let cancelled = false;
+      let retriesLeft =
+        retryOpt === true
+          ? Infinity
+          : typeof retryOpt === "number"
+            ? retryOpt
+            : 0;
+
+      const doFetch = async () => {
+        loading.value = true;
+        try {
+          const { response } = await fetchWithCache(url, fetchOptions);
+          if (cancelled) return;
+          if (response) {
+            if (!response.ok) {
+              let errorMessage = `HTTP ${response.status}`;
+              try {
+                const errBody = await response.json();
+                errorMessage = errBody?.message || errBody?.error || errorMessage;
+              } catch {}
+              throw new Error(errorMessage);
+            }
+            const raw = await response.json();
+            const selected = select ? select(raw) : raw;
+            data.value = selected;
+            cachedData = selected;
+            if (!cancelled) onSuccess?.(selected);
+          } else {
+            data.value = null;
+            cachedData = null;
+          }
+          if (!cancelled) error.value = null;
+        } catch (err) {
+          if (!cancelled && retriesLeft > 0) {
+            retriesLeft--;
+            await new Promise((r) => setTimeout(r, 1000));
+            return doFetch();
+          }
+          if (!cancelled) {
+            const e = err instanceof Error ? err : new Error(String(err));
+            error.value = e;
+            onError?.(e);
+          }
+        } finally {
+          if (!cancelled) loading.value = false;
+        }
+      };
+
+      doFetch();
+    },
+  );
+
+  if (isEnabled && url) {
+    onMounted(() => {
+      function onInvalidated(e) {
+        const detail = e.detail;
+        const tags = detail?.tags;
+        if (!tags || !Array.isArray(tags)) return;
+        const urlTags = generateTags(url);
+        if (tags.some((t) => urlTags.includes(t))) {
+          refetch();
+        }
+      }
+      window.addEventListener("cache-invalidated", onInvalidated);
+      onUnmounted(() => {
+        window.removeEventListener("cache-invalidated", onInvalidated);
+      });
+    });
+  }
+
+  return { data, error, loading, refetch };
+}

package/templates/vue/useSwoffFetch.ts

@@ -0,0 +1,143 @@
+import { ref, onMounted, onUnmounted, watch } from "vue";
+import { fetchWithCache } from "../fetch/core";
+import { generateTags } from "../cache/tags";
+import type { FetchWithCacheOptions } from "../fetch/core";
+
+/**
+ * Fetch and cache data with automatic invalidation, revalidation, and offline support.
+ *
+ * Usage:
+ *   const { data, error, loading, refetch } = useSwoffFetch("/api/todos");
+ *
+ *   // Select/transform data
+ *   const { data: names } = useSwoffFetch("/api/users", {
+ *     select: (users) => users.map(u => u.name),
+ *   });
+ *
+ *   // Keep previous data while fetching the next page
+ *   const { data } = useSwoffFetch(`/api/items?page=${page}`, {
+ *     keepPreviousData: true,
+ *   });
+ *
+ *   @param url - URL to fetch. Pass null to skip fetching.
+ *   @param options - Fetch options plus: select, keepPreviousData, retry, placeholderData, onSuccess, onError
+ */
+export function useSwoffFetch<T = unknown, R = T>(
+  url: string | null,
+  options: FetchWithCacheOptions & {
+    enabled?: boolean;
+    select?: (data: T) => R;
+    keepPreviousData?: boolean;
+    retry?: number | boolean;
+    placeholderData?: R;
+    onSuccess?: (data: R) => void;
+    onError?: (error: Error) => void;
+  } = {},
+) {
+  const {
+    select,
+    retry: retryOpt,
+    placeholderData,
+    onSuccess,
+    onError,
+    ...fetchOptions
+  } = options;
+
+  const data = ref<R | null>(placeholderData ?? null);
+  const error = ref<Error | null>(null);
+  const loading = ref(url != null && options.enabled !== false);
+  const refetchCount = ref(0);
+
+  let cachedData: R | null = placeholderData ?? null;
+
+  const isEnabled = options.enabled !== false && url != null;
+
+  function refetch() {
+    refetchCount.value++;
+  }
+
+  watch(
+    () => url,
+    () => {
+      if (isEnabled) refetch();
+    },
+  );
+
+  watch(
+    [() => url, () => refetchCount.value],
+    () => {
+      if (!isEnabled) return;
+
+      let cancelled = false;
+      let retriesLeft: number =
+        retryOpt === true
+          ? Infinity
+          : typeof retryOpt === "number"
+            ? retryOpt
+            : 0;
+
+      const doFetch = async () => {
+        loading.value = true;
+        try {
+          const { response } = await fetchWithCache(url, fetchOptions);
+          if (cancelled) return;
+          if (response) {
+            if (!response.ok) {
+              let errorMessage = `HTTP ${response.status}`;
+              try {
+                const errBody = await response.json();
+                errorMessage = errBody?.message || errBody?.error || errorMessage;
+              } catch {}
+              throw new Error(errorMessage);
+            }
+            const raw: T = await response.json();
+            const selected = select ? select(raw) : (raw as unknown as R);
+            data.value = selected;
+            cachedData = selected;
+            if (!cancelled) onSuccess?.(selected);
+          } else {
+            data.value = null;
+            cachedData = null;
+          }
+          if (!cancelled) error.value = null;
+        } catch (err) {
+          if (!cancelled && retriesLeft > 0) {
+            retriesLeft--;
+            await new Promise((r) => setTimeout(r, 1000));
+            return doFetch();
+          }
+          if (!cancelled) {
+            const e = err instanceof Error ? err : new Error(String(err));
+            error.value = e;
+            onError?.(e);
+          }
+        } finally {
+          if (!cancelled) loading.value = false;
+        }
+      };
+
+      doFetch();
+    },
+  );
+
+  // Auto-refetch on cache invalidation
+  if (isEnabled && url) {
+    onMounted(() => {
+      function onInvalidated(e: Event) {
+        const detail = (e as CustomEvent).detail;
+        const tags = detail?.tags;
+        if (!tags || !Array.isArray(tags)) return;
+        const urlTags = generateTags(url!);
+        if (tags.some((t: string) => urlTags.includes(t))) {
+          refetch();
+        }
+      }
+      window.addEventListener("cache-invalidated", onInvalidated);
+      onUnmounted(() => {
+        window.removeEventListener("cache-invalidated", onInvalidated);
+      });
+    });
+  }
+
+  return { data, error, loading, refetch };
+}

package/templates/vue/useSwoffMutation.js

@@ -0,0 +1,124 @@
+import { ref } from "vue";
+import { fetchWithCache } from "../fetch/core.js";
+import {
+  trackMutation,
+  resolveMutation,
+  rejectMutation,
+} from "../mutation/state.js";
+
+/**
+ * Composable for mutations (POST, PUT, PATCH, DELETE) with auto-invalidation, offline queuing,
+ * optimistic updates, and dual-level callbacks.
+ *
+ * Usage:
+ *   const { mutate, isLoading, error, data } = useSwoffMutation("/api/todos", {
+ *     method: "POST",
+ *     onSuccess: (data) => navigate(`/item/${data.id}`),
+ *   });
+ *
+ *   // Check result status after mutate:
+ *   const result = await mutate(body);
+ *   if (result.status === "success") navigate(`/item/${result.data.id}`);
+ */
+export function useSwoffMutation(url, options = {}) {
+  const lastResult = ref(null);
+  const isLoading = ref(false);
+  const mutationId = ref(null);
+
+  const inFlightKeys = new Set();
+
+  async function mutate(body, callbacks) {
+    const key = options.mutationKey;
+    if (key && inFlightKeys.has(key)) return { status: "skipped" };
+    if (key) inFlightKeys.add(key);
+
+    let retriesLeft =
+      options.retry === true
+        ? Infinity
+        : typeof options.retry === "number"
+          ? options.retry
+          : 0;
+
+    const mid = "mut-" + crypto.randomUUID();
+    mutationId.value = mid;
+    trackMutation(mid, "pending");
+    isLoading.value = true;
+
+    options.onMutate?.();
+
+    const attempt = async () => {
+      try {
+        const {
+          mutationKey,
+          onMutate,
+          onSuccess,
+          onError,
+          onSettled,
+          retry,
+          ...fetchOnlyOptions
+        } = options;
+        const fetchOptions = { ...fetchOnlyOptions, body };
+        const { response, queued } = await fetchWithCache(url, fetchOptions);
+        if (queued) {
+          resolveMutation(mid, null);
+          isLoading.value = false;
+          const r = { status: "queued" };
+          lastResult.value = r;
+          options.onSettled?.();
+          callbacks?.onSettled?.();
+          if (key) inFlightKeys.delete(key);
+          return r;
+        }
+        const data = await response.json();
+        resolveMutation(mid, data);
+        isLoading.value = false;
+        const r = { status: "success", data };
+        lastResult.value = r;
+        options.onSuccess?.(data);
+        callbacks?.onSuccess?.(data);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      } catch (err) {
+        if (retriesLeft > 0) {
+          retriesLeft--;
+          await new Promise((r) => setTimeout(r, 1000));
+          return attempt();
+        }
+        const error = err instanceof Error ? err : new Error(String(err));
+        rejectMutation(mid, error);
+        isLoading.value = false;
+        const r = { status: "error", error };
+        lastResult.value = r;
+        options.onError?.(error);
+        callbacks?.onError?.(error);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      }
+    };
+
+    return attempt();
+  }
+
+  function reset() {
+    lastResult.value = null;
+    isLoading.value = false;
+  }
+
+  return {
+    mutate,
+    isLoading,
+    isIdle: lastResult.value === null,
+    isQueued: lastResult.value?.status === "queued",
+    isSuccess: lastResult.value?.status === "success",
+    isError: lastResult.value?.status === "error",
+    data: lastResult.value?.status === "success" ? (lastResult.value.data ?? null) : null,
+    error: lastResult.value?.status === "error" ? (lastResult.value.error ?? null) : null,
+    lastResult,
+    reset,
+    mutationId,
+  };
+}

package/templates/vue/useSwoffMutation.ts

@@ -0,0 +1,155 @@
+import { ref } from "vue";
+import { fetchWithCache } from "../fetch/core";
+import {
+  trackMutation,
+  resolveMutation,
+  rejectMutation,
+} from "../mutation/state";
+import type { FetchWithCacheOptions } from "../fetch/core";
+
+export interface MutateCallbacks<TData> {
+  onSuccess?: (data: TData) => void;
+  onError?: (error: Error) => void;
+  onSettled?: () => void;
+}
+
+export interface UseMutationOptions<TData> extends FetchWithCacheOptions {
+  onMutate?: () => void;
+  onSuccess?: (data: TData) => void;
+  onError?: (error: Error) => void;
+  onSettled?: () => void;
+  mutationKey?: string;
+  retry?: number | boolean;
+}
+
+export type MutateResult<T> =
+  | { status: "skipped" }
+  | { status: "queued" }
+  | { status: "success"; data: T }
+  | { status: "error"; error: Error };
+
+/**
+ * Composable for mutations (POST, PUT, PATCH, DELETE) with auto-invalidation, offline queuing,
+ * optimistic updates, and dual-level callbacks.
+ *
+ * Usage:
+ *   const { mutate, isLoading, error, data } = useSwoffMutation("/api/todos", {
+ *     method: "POST",
+ *     onSuccess: (data) => navigate(`/item/${data.id}`),
+ *   });
+ *
+ *   // Check result status after mutate:
+ *   const result = await mutate(body);
+ *   if (result.status === "success") navigate(`/item/${result.data.id}`);
+ */
+export function useSwoffMutation<TData = unknown>(
+  url: string,
+  options: UseMutationOptions<TData> = {},
+) {
+  const lastResult = ref<MutateResult<TData> | null>(null);
+  const isLoading = ref(false);
+  const mutationId = ref<string | null>(null);
+
+  const inFlightKeys = new Set<string>();
+
+  async function mutate(
+    body?: unknown,
+    callbacks?: MutateCallbacks<TData>,
+  ): Promise<MutateResult<TData>> {
+    const key = options.mutationKey;
+    if (key && inFlightKeys.has(key)) return { status: "skipped" };
+    if (key) inFlightKeys.add(key);
+
+    let retriesLeft: number =
+      options.retry === true
+        ? Infinity
+        : typeof options.retry === "number"
+          ? options.retry
+          : 0;
+
+    const mid = "mut-" + crypto.randomUUID();
+    mutationId.value = mid;
+    trackMutation(mid, "pending");
+    isLoading.value = true;
+
+    options.onMutate?.();
+
+    const attempt = async (): Promise<MutateResult<TData>> => {
+      try {
+        const {
+          mutationKey,
+          onMutate,
+          onSuccess,
+          onError,
+          onSettled,
+          retry,
+          ...fetchOnlyOptions
+        } = options;
+        const fetchOptions = { ...fetchOnlyOptions, body };
+        const { response, queued } = await fetchWithCache<TData>(
+          url,
+          fetchOptions as FetchWithCacheOptions,
+        );
+        if (queued) {
+          resolveMutation(mid, null);
+          isLoading.value = false;
+          const r: MutateResult<TData> = { status: "queued" };
+          lastResult.value = r;
+          options.onSettled?.();
+          callbacks?.onSettled?.();
+          if (key) inFlightKeys.delete(key);
+          return r;
+        }
+        const data: TData = await response.json();
+        resolveMutation(mid, data);
+        isLoading.value = false;
+        const r: MutateResult<TData> = { status: "success", data };
+        lastResult.value = r;
+        options.onSuccess?.(data);
+        callbacks?.onSuccess?.(data);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      } catch (err) {
+        if (retriesLeft > 0) {
+          retriesLeft--;
+          await new Promise((r) => setTimeout(r, 1000));
+          return attempt();
+        }
+        const error = err instanceof Error ? err : new Error(String(err));
+        rejectMutation(mid, error);
+        isLoading.value = false;
+        const r: MutateResult<TData> = { status: "error", error };
+        lastResult.value = r;
+        options.onError?.(error);
+        callbacks?.onError?.(error);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      }
+    };
+
+    return attempt();
+  }
+
+  function reset() {
+    lastResult.value = null;
+    isLoading.value = false;
+  }
+
+  return {
+    mutate,
+    isLoading,
+    isIdle: lastResult.value === null,
+    isQueued: lastResult.value?.status === "queued",
+    isSuccess: lastResult.value?.status === "success",
+    isError: lastResult.value?.status === "error",
+    data: lastResult.value?.status === "success" ? (lastResult.value.data ?? null) : null,
+    error: lastResult.value?.status === "error" ? (lastResult.value.error ?? null) : null,
+    lastResult,
+    reset,
+    mutationId,
+  };
+}

package/templates/vue/useSwoffMutationState.js

@@ -0,0 +1,35 @@
+import { ref, onMounted, onUnmounted } from "vue";
+import { getMutationState, onMutationStateChange } from "../mutation/state.js";
+
+/**
+ * Composable that subscribes to a specific mutation's state changes.
+ * Useful for showing per-mutation loading spinners, error states, etc.
+ *
+ * Usage:
+ *   const mutation = useSwoffMutationState(mutationId);
+ *   <div v-if="mutation?.status === 'error'">{{ mutation?.error?.message }}</div>
+ */
+export function useSwoffMutationState(id) {
+  const state = ref(null);
+
+  function update() {
+    state.value = id ? (getMutationState(id) ?? null) : null;
+  }
+
+  onMounted(update);
+
+  let cleanup;
+
+  onMounted(() => {
+    const unsub = onMutationStateChange(update);
+    if (typeof unsub === "function") {
+      cleanup = unsub;
+    }
+
+    onUnmounted(() => {
+      cleanup?.();
+    });
+  });
+
+  return state;
+}