@swoff/cli 0.4.1 → 0.4.4

package/templates/svelte/useSwoffMutation.js

@@ -0,0 +1,110 @@
+import { writable } from "svelte/store";
+import { fetchWithCache } from "../fetch/core.js";
+import {
+  trackMutation,
+  resolveMutation,
+  rejectMutation,
+} from "../mutation/state.js";
+
+export function useSwoffMutation(url, options = {}) {
+  const lastResult = writable(null);
+  const isLoading = writable(false);
+  const mutationId = writable(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.set(mid);
+    trackMutation(mid, "pending");
+    isLoading.set(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.set(false);
+          const r = { status: "queued" };
+          lastResult.set(r);
+          options.onSettled?.();
+          callbacks?.onSettled?.();
+          if (key) inFlightKeys.delete(key);
+          return r;
+        }
+        const data = await response.json();
+        resolveMutation(mid, data);
+        isLoading.set(false);
+        const r = { status: "success", data };
+        lastResult.set(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.set(false);
+        const r = { status: "error", error };
+        lastResult.set(r);
+        options.onError?.(error);
+        callbacks?.onError?.(error);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      }
+    };
+
+    return attempt();
+  }
+
+  function reset() {
+    lastResult.set(null);
+    isLoading.set(false);
+  }
+
+  return {
+    mutate,
+    isLoading,
+    isIdle: lastResult,
+    isQueued: lastResult,
+    isSuccess: lastResult,
+    isError: lastResult,
+    data: lastResult,
+    error: lastResult,
+    lastResult,
+    reset,
+    mutationId,
+  };
+}

package/templates/svelte/useSwoffMutation.ts

@@ -0,0 +1,141 @@
+import { writable } from "svelte/store";
+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 };
+
+export function useSwoffMutation<TData = unknown>(
+  url: string,
+  options: UseMutationOptions<TData> = {},
+) {
+  const lastResult = writable<MutateResult<TData> | null>(null);
+  const isLoading = writable(false);
+  const mutationId = writable<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.set(mid);
+    trackMutation(mid, "pending");
+    isLoading.set(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.set(false);
+          const r: MutateResult<TData> = { status: "queued" };
+          lastResult.set(r);
+          options.onSettled?.();
+          callbacks?.onSettled?.();
+          if (key) inFlightKeys.delete(key);
+          return r;
+        }
+        const data: TData = await response.json();
+        resolveMutation(mid, data);
+        isLoading.set(false);
+        const r: MutateResult<TData> = { status: "success", data };
+        lastResult.set(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.set(false);
+        const r: MutateResult<TData> = { status: "error", error };
+        lastResult.set(r);
+        options.onError?.(error);
+        callbacks?.onError?.(error);
+        options.onSettled?.();
+        callbacks?.onSettled?.();
+        if (key) inFlightKeys.delete(key);
+        return r;
+      }
+    };
+
+    return attempt();
+  }
+
+  function reset() {
+    lastResult.set(null);
+    isLoading.set(false);
+  }
+
+  return {
+    mutate,
+    isLoading,
+    isIdle: lastResult,
+    isQueued: lastResult,
+    isSuccess: lastResult,
+    isError: lastResult,
+    data: lastResult,
+    error: lastResult,
+    lastResult,
+    reset,
+    mutationId,
+  };
+}

package/templates/svelte/useSwoffMutationState.js

@@ -0,0 +1,27 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import { getMutationState, onMutationStateChange } from "../mutation/state.js";
+
+export function useSwoffMutationState(id) {
+  const state = writable(null);
+
+  function update() {
+    state.set(id ? (getMutationState(id) ?? null) : null);
+  }
+
+  onMount(update);
+
+  let cleanup;
+
+  onMount(() => {
+    const unsub = onMutationStateChange(update);
+    if (typeof unsub === "function") {
+      cleanup = unsub;
+    }
+    return () => {
+      cleanup?.();
+    };
+  });
+
+  return state;
+}

package/templates/svelte/useSwoffMutationState.ts

@@ -0,0 +1,28 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import { getMutationState, onMutationStateChange } from "../mutation/state";
+import type { MutationState } from "../mutation/state";
+
+export function useSwoffMutationState(id: string | null) {
+  const state = writable<MutationState | null>(null);
+
+  function update() {
+    state.set(id ? (getMutationState(id) ?? null) : null);
+  }
+
+  onMount(update);
+
+  let cleanup: (() => void) | undefined;
+
+  onMount(() => {
+    const unsub = onMutationStateChange(update);
+    if (typeof unsub === "function") {
+      cleanup = unsub;
+    }
+    return () => {
+      cleanup?.();
+    };
+  });
+
+  return state;
+}

package/templates/svelte/useSwoffNetwork.js

@@ -0,0 +1,75 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import {
+  CONNECTIVITY_EVENT,
+  forceRetry,
+  getCurrentOnlineStatus,
+} from "../connectivity.js";
+
+export function useSwoffNetwork() {
+  const online = writable(true);
+  const wasOffline = writable(false);
+  const lastChangedAt = writable(null);
+  const effectiveType = writable(null);
+  const downlink = writable(null);
+  const isRetrying = writable(false);
+
+  let wasOfflineFlag = false;
+
+  onMount(() => {
+    if (!getCurrentOnlineStatus()) {
+      wasOfflineFlag = true;
+      online.set(false);
+      wasOffline.set(true);
+      lastChangedAt.set(Date.now());
+    }
+
+    const connection = navigator.connection;
+
+    function handleConnectivityChange(e) {
+      const isTrulyOnline = e.detail.online;
+      if (!isTrulyOnline) {
+        wasOfflineFlag = true;
+      } else {
+        wasOfflineFlag = false;
+      }
+      online.set(isTrulyOnline);
+      wasOffline.set(wasOfflineFlag);
+      lastChangedAt.set(Date.now());
+    }
+
+    function onTypeChange() {
+      if (!connection) return;
+      effectiveType.set(connection.effectiveType);
+      downlink.set(connection.downlink);
+    }
+
+    window.addEventListener(CONNECTIVITY_EVENT, handleConnectivityChange);
+    if (connection) {
+      connection.addEventListener("change", onTypeChange);
+    }
+
+    return () => {
+      window.removeEventListener(CONNECTIVITY_EVENT, handleConnectivityChange);
+      if (connection) {
+        connection.removeEventListener("change", onTypeChange);
+      }
+    };
+  });
+
+  async function retry() {
+    isRetrying.set(true);
+    await forceRetry();
+    isRetrying.set(false);
+  }
+
+  return {
+    online,
+    wasOffline,
+    lastChangedAt,
+    effectiveType,
+    downlink,
+    isRetrying,
+    retry,
+  };
+}

package/templates/svelte/useSwoffNetwork.ts

@@ -0,0 +1,75 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import {
+  CONNECTIVITY_EVENT,
+  forceRetry,
+  getCurrentOnlineStatus,
+} from "../connectivity";
+
+export function useSwoffNetwork() {
+  const online = writable(true);
+  const wasOffline = writable(false);
+  const lastChangedAt = writable<number | null>(null);
+  const effectiveType = writable<string | null>(null);
+  const downlink = writable<number | null>(null);
+  const isRetrying = writable(false);
+
+  let wasOfflineFlag = false;
+
+  onMount(() => {
+    if (!getCurrentOnlineStatus()) {
+      wasOfflineFlag = true;
+      online.set(false);
+      wasOffline.set(true);
+      lastChangedAt.set(Date.now());
+    }
+
+    const connection = navigator.connection;
+
+    function handleConnectivityChange(e: Event) {
+      const isTrulyOnline = (e as CustomEvent).detail.online;
+      if (!isTrulyOnline) {
+        wasOfflineFlag = true;
+      } else {
+        wasOfflineFlag = false;
+      }
+      online.set(isTrulyOnline);
+      wasOffline.set(wasOfflineFlag);
+      lastChangedAt.set(Date.now());
+    }
+
+    function onTypeChange() {
+      if (!connection) return;
+      effectiveType.set(connection.effectiveType);
+      downlink.set(connection.downlink);
+    }
+
+    window.addEventListener(CONNECTIVITY_EVENT, handleConnectivityChange);
+    if (connection) {
+      connection.addEventListener("change", onTypeChange);
+    }
+
+    return () => {
+      window.removeEventListener(CONNECTIVITY_EVENT, handleConnectivityChange);
+      if (connection) {
+        connection.removeEventListener("change", onTypeChange);
+      }
+    };
+  });
+
+  async function retry() {
+    isRetrying.set(true);
+    await forceRetry();
+    isRetrying.set(false);
+  }
+
+  return {
+    online,
+    wasOffline,
+    lastChangedAt,
+    effectiveType,
+    downlink,
+    isRetrying,
+    retry,
+  };
+}

package/templates/svelte/useSwoffPrecache.js

@@ -0,0 +1,19 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+
+export function useSwoffPrecache() {
+  const progress = writable(0);
+
+  function onProgress(e) {
+    progress.set(e.detail.percent);
+  }
+
+  onMount(() => {
+    window.addEventListener("sw-progress", onProgress);
+    return () => {
+      window.removeEventListener("sw-progress", onProgress);
+    };
+  });
+
+  return { progress };
+}

package/templates/svelte/useSwoffPrecache.ts

@@ -0,0 +1,19 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+
+export function useSwoffPrecache() {
+  const progress = writable(0);
+
+  function onProgress(e: WindowEventMap["sw-progress"]) {
+    progress.set(e.detail.percent);
+  }
+
+  onMount(() => {
+    window.addEventListener("sw-progress", onProgress);
+    return () => {
+      window.removeEventListener("sw-progress", onProgress);
+    };
+  });
+
+  return { progress };
+}

package/templates/svelte/useSwoffPrefetch.js

@@ -0,0 +1,19 @@
+import { writable } from "svelte/store";
+import { prefetchCache } from "../fetch/core.js";
+
+export function useSwoffPrefetch() {
+  const prefetchList = writable([]);
+
+  function prefetch(url, options) {
+    prefetchCache(url, options);
+    prefetchList.update((list) =>
+      list.includes(url) ? list : [...list, url],
+    );
+  }
+
+  function clear() {
+    prefetchList.set([]);
+  }
+
+  return { prefetch, prefetchList, clear };
+}

package/templates/svelte/useSwoffPrefetch.ts

@@ -0,0 +1,20 @@
+import { writable } from "svelte/store";
+import { prefetchCache } from "../fetch/core";
+import type { FetchWithCacheOptions } from "../fetch/core";
+
+export function useSwoffPrefetch() {
+  const prefetchList = writable<string[]>([]);
+
+  function prefetch(url: string, options?: FetchWithCacheOptions) {
+    prefetchCache(url, options);
+    prefetchList.update((list) =>
+      list.includes(url) ? list : [...list, url],
+    );
+  }
+
+  function clear() {
+    prefetchList.set([]);
+  }
+
+  return { prefetch, prefetchList, clear };
+}

package/templates/svelte/useSwoffPush.js

@@ -0,0 +1,82 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import {
+  subscribeToPush,
+  unsubscribeFromPush,
+  isSubscribed,
+  getPushSubscription,
+} from "../realtime/notifications.js";
+
+export function useSwoffPush() {
+  const subscribed = writable(false);
+  const subscription = writable(null);
+  const permission = writable(
+    typeof Notification !== "undefined" ? Notification.permission : "denied",
+  );
+  const loading = writable(true);
+
+  onMount(() => {
+    let cancelled = false;
+
+    isSubscribed().then((subd) => {
+      if (cancelled) return;
+      if (subd) {
+        getPushSubscription().then((sub) => {
+          if (cancelled) return;
+          subscribed.set(true);
+          subscription.set(sub);
+          permission.set(Notification.permission);
+          loading.set(false);
+        });
+      } else {
+        subscribed.set(false);
+        subscription.set(null);
+        permission.set(Notification.permission);
+        loading.set(false);
+      }
+    });
+
+    function onSubChanged(e) {
+      if (cancelled) return;
+      if (!e.detail.subscribed) {
+        subscribed.set(false);
+        subscription.set(null);
+        permission.set(Notification.permission);
+        loading.set(false);
+      } else {
+        getPushSubscription().then((sub) => {
+          if (cancelled) return;
+          subscribed.set(true);
+          subscription.set(sub);
+          permission.set(Notification.permission);
+          loading.set(false);
+        });
+      }
+    }
+
+    function onPermissionChanged(e) {
+      if (cancelled) return;
+      permission.set(e.detail.permission);
+    }
+
+    window.addEventListener("push-subscription-changed", onSubChanged);
+    window.addEventListener("push-permission-changed", onPermissionChanged);
+
+    return () => {
+      cancelled = true;
+      window.removeEventListener("push-subscription-changed", onSubChanged);
+      window.removeEventListener("push-permission-changed", onPermissionChanged);
+    };
+  });
+
+  async function subscribe() {
+    const sub = await subscribeToPush();
+    return sub !== null;
+  }
+
+  async function unsubscribe() {
+    await unsubscribeFromPush();
+  }
+
+  return { subscribed, subscription, permission, loading, subscribe, unsubscribe };
+}

package/templates/svelte/useSwoffPush.ts

@@ -0,0 +1,82 @@
+import { writable } from "svelte/store";
+import { onMount } from "svelte";
+import {
+  subscribeToPush,
+  unsubscribeFromPush,
+  isSubscribed,
+  getPushSubscription,
+} from "../realtime/notifications";
+
+export function useSwoffPush() {
+  const subscribed = writable(false);
+  const subscription = writable<PushSubscription | null>(null);
+  const permission = writable(
+    typeof Notification !== "undefined" ? Notification.permission : "denied",
+  );
+  const loading = writable(true);
+
+  onMount(() => {
+    let cancelled = false;
+
+    isSubscribed().then((subd) => {
+      if (cancelled) return;
+      if (subd) {
+        getPushSubscription().then((sub) => {
+          if (cancelled) return;
+          subscribed.set(true);
+          subscription.set(sub);
+          permission.set(Notification.permission);
+          loading.set(false);
+        });
+      } else {
+        subscribed.set(false);
+        subscription.set(null);
+        permission.set(Notification.permission);
+        loading.set(false);
+      }
+    });
+
+    function onSubChanged(e: CustomEvent) {
+      if (cancelled) return;
+      if (!e.detail.subscribed) {
+        subscribed.set(false);
+        subscription.set(null);
+        permission.set(Notification.permission);
+        loading.set(false);
+      } else {
+        getPushSubscription().then((sub) => {
+          if (cancelled) return;
+          subscribed.set(true);
+          subscription.set(sub);
+          permission.set(Notification.permission);
+          loading.set(false);
+        });
+      }
+    }
+
+    function onPermissionChanged(e: CustomEvent) {
+      if (cancelled) return;
+      permission.set(e.detail.permission);
+    }
+
+    window.addEventListener("push-subscription-changed", onSubChanged);
+    window.addEventListener("push-permission-changed", onPermissionChanged);
+
+    return () => {
+      cancelled = true;
+      window.removeEventListener("push-subscription-changed", onSubChanged);
+      window.removeEventListener("push-permission-changed", onPermissionChanged);
+    };
+  });
+
+  async function subscribe() {
+    const sub = await subscribeToPush();
+    return sub !== null;
+  }
+
+  async function unsubscribe() {
+    await unsubscribeFromPush();
+  }
+
+  return { subscribed, subscription, permission, loading, subscribe, unsubscribe };
+}