@fluixi/core 1.0.0-alpha.100

package/dist/src/lib/router/data.js

@@ -0,0 +1,258 @@
+/**
+ * @module @fluixi/core/router/data
+ */
+import { createResource, createSignal } from '@fluixi/reactive/signal';
+import { currentResourceCache } from '@fluixi/reactive/signal';
+import { useContext, createContext } from '../context/context.js';
+// Mounted route layers: each refetches its data when something is revalidated.
+const revalidationListeners = new Set();
+/** @internal: the router registers each layer's refetch here. */
+export function onRevalidate(listener) {
+    revalidationListeners.add(listener);
+    return () => void revalidationListeners.delete(listener);
+}
+const reloadMounted = () => {
+    for (const listener of [...revalidationListeners])
+        listener();
+};
+/**
+ * A function whose results are kept by name and arguments: route data that should not be
+ * fetched again on every visit.
+ *
+ * Readers of the same key share one request in flight. Entries live in the request's cache on
+ * the server, so visitors never share one, and in the page's cache in a browser.
+ *
+ * @example
+ * ```ts
+ * const organisations = cache(() => api.get('/api/v1/organizations'), 'orgs', { ttl: 30_000 });
+ * export const routeData = () => organisations();
+ * // after a change:
+ * revalidate('orgs');
+ * ```
+ */
+export function cache(fn, name, options = {}) {
+    const { ttl = Infinity, staleWhileRevalidate = true } = options;
+    return (...args) => {
+        const store = options.cache ?? currentResourceCache();
+        const key = name + ':' + JSON.stringify(args);
+        const fetchFresh = () => {
+            const running = store.inflight.get(key);
+            if (running)
+                return running;
+            const promise = Promise.resolve(fn(...args)).then((value) => {
+                store.set(key, { value, timestamp: Date.now() });
+                store.inflight.delete(key);
+                return value;
+            }, (error) => {
+                store.inflight.delete(key);
+                throw error;
+            });
+            store.inflight.set(key, promise);
+            return promise;
+        };
+        const hit = store.get(key);
+        if (hit && (ttl === Infinity || Date.now() - hit.timestamp <= ttl))
+            return Promise.resolve(hit.value);
+        if (hit && staleWhileRevalidate) {
+            // The page gets the old value now; when the new one lands, the routes load again from it.
+            fetchFresh().then(reloadMounted, () => undefined);
+            return Promise.resolve(hit.value);
+        }
+        return fetchFresh();
+    };
+}
+/**
+ * Drops cached entries, by name (`'orgs'` matches every `orgs:` key), several names, or a
+ * predicate, then loads the data of the routes on screen again. What is still cached is
+ * served from the cache, so only the dropped entries are fetched.
+ */
+export function revalidate(key, store) {
+    const names = typeof key === 'string' ? [key] : Array.isArray(key) ? key : null;
+    drop(names ?? key, store ?? currentResourceCache());
+    // The other tabs of this site cache the same data in their own pages. A predicate cannot
+    // travel, and a cache passed in by hand is not theirs, so only names on the page cache go.
+    if (names && !store)
+        tellOtherTabs(names);
+}
+function drop(what, store) {
+    const matches = Array.isArray(what) ? (k) => what.some((n) => k === n || k.startsWith(n + ':')) : what;
+    for (const k of [...store.keys()])
+        if (matches(k))
+            store.delete(k);
+    reloadMounted();
+}
+// Other tabs hear a write to this key through the `storage` event, which a browser fires in
+// every other tab of the origin and never in the one that wrote. The value changes each time
+// (`at`), or a repeat of the same names would not fire.
+const TABS_KEY = 'fluixi:revalidate';
+function tellOtherTabs(names) {
+    try {
+        localStorage.setItem(TABS_KEY, JSON.stringify({ names, at: Date.now() + Math.random() }));
+    }
+    catch {
+        /* no storage here (server, private mode): the other tabs refresh on their own schedule */
+    }
+}
+if (typeof window !== 'undefined') {
+    window.addEventListener('storage', (event) => {
+        if (event.key !== TABS_KEY || !event.newValue)
+            return;
+        try {
+            const names = JSON.parse(event.newValue).names;
+            if (Array.isArray(names) && names.every((n) => typeof n === 'string'))
+                drop(names, currentResourceCache());
+        }
+        catch {
+            /* not ours */
+        }
+    });
+}
+// `@fluixi/api/client` applies `x-fx-revalidate` through this, without importing the router.
+globalThis[Symbol.for('fluixi.revalidate')] = (names) => revalidate(names);
+// ============================================================================
+// ASYNC DATA PRIMITIVES
+// ============================================================================
+/**
+ * Create an async resource from a promise or cache function
+ */
+export function createAsync(fetcher, source) {
+    const [data] = createResource(source || (() => true), fetcher);
+    return data;
+    // return () => '' as any;
+}
+// ============================================================================
+// ACTIONS
+// ============================================================================
+const submissionState = new Map();
+function getSubmissionSignal(url) {
+    if (!submissionState.has(url)) {
+        submissionState.set(url, createSignal(undefined));
+    }
+    return submissionState.get(url);
+}
+/**
+ * Every call of an action, by action name: the ones in flight and the ones that failed.
+ * `submissionState` above keeps only the latest call, so two calls at once overwrote each
+ * other; this list is what an optimistic UI renders from.
+ */
+const submissionsState = new Map();
+function getSubmissionsSignal(url) {
+    if (!submissionsState.has(url))
+        submissionsState.set(url, createSignal([]));
+    return submissionsState.get(url);
+}
+export function action(fn, name, options = {}) {
+    const actionUrl = name || fn.name || 'action';
+    const submit = async (...args) => {
+        // What the submission shows as its input: the argument, or all of them when there are
+        // several. Every argument reaches `fn` either way.
+        const input = (args.length > 1 ? args : args[0]);
+        const [, setSubmission] = getSubmissionSignal(actionUrl);
+        const [, setSubmissions] = getSubmissionsSignal(actionUrl);
+        // This call's entry in the list: replaced, never mutated, so readers see each change.
+        let entry;
+        const drop = () => setSubmissions((list) => list.filter((s) => s !== entry));
+        const settle = (next) => {
+            setSubmissions((list) => list.map((s) => (s === entry ? next : s)));
+            entry = next;
+        };
+        // Reset state
+        const clear = () => {
+            setSubmission(undefined);
+            drop();
+        };
+        const retry = () => {
+            drop();
+            return submit(...args);
+        };
+        entry = {
+            input,
+            pending: true,
+            clear,
+            retry,
+        };
+        setSubmission(entry);
+        setSubmissions((list) => [...list, entry]);
+        try {
+            const result = await fn(...args);
+            setSubmission({
+                input,
+                result,
+                pending: false,
+                clear,
+                retry,
+            });
+            // Done: the result is in whatever the page reads now, so the call leaves the list.
+            drop();
+            const stale = typeof options.invalidates === 'function' ? options.invalidates(result) : options.invalidates;
+            for (const key of stale ?? [])
+                revalidate(key);
+            return result;
+        }
+        catch (error) {
+            const failed = {
+                input,
+                error,
+                pending: false,
+                clear,
+                retry,
+            };
+            setSubmission(failed);
+            // Failed: it stays, with its error, until retried or cleared.
+            settle(failed);
+            throw error;
+        }
+    };
+    submit.url = actionUrl;
+    submit.with = (args) => action((...a) => fn(args, ...a), name, options);
+    return submit;
+}
+/**
+ * Hook to track action submission state
+ */
+export function useSubmission(actionFn) {
+    const [submission] = getSubmissionSignal(actionFn.url);
+    return submission;
+}
+/**
+ * Every call of `actionFn` still in flight, and the ones that failed, oldest first. One entry
+ * per call, so concurrent calls do not overwrite each other. A call that succeeds leaves the
+ * list; one that fails stays with its `error` until `retry()` or `clear()`.
+ *
+ * The optimistic pattern: render the server's rows, then the pending entries mapped to the
+ * same shape. When a call succeeds its entry goes and the server row takes its place; when it
+ * fails it stops being pending, so it leaves the optimistic rows by itself.
+ *
+ * @example
+ * ```tsx
+ * const moves = useSubmissions(moveDeal);
+ * const rows = $memo(() => [
+ *   ...deals(),
+ *   ...moves().filter((s) => s.pending).map((s) => ({ ...s.input, pending: true })),
+ * ]);
+ * ```
+ */
+export function useSubmissions(actionFn) {
+    const [submissions] = getSubmissionsSignal(actionFn.url);
+    return submissions;
+}
+/**
+ * Hook to get action executor
+ */
+export function useAction(actionFn) {
+    return actionFn;
+}
+export const RouteDataContext = createContext(undefined, 'route-data');
+export const RouteDataProvider = RouteDataContext.Provider;
+/**
+ * Access the data returned by the nearest ancestor route's `routeData` export.
+ *
+ * Returns a stable accessor function. Call it to get the current route data:
+ *
+ *   const data = useRouteData<WorkspaceRouteData>();
+ *   createEffect(() => console.log(data()?.workspace()));
+ */
+export function useRouteData() {
+    const ctx = useContext(RouteDataContext);
+    return typeof ctx === 'function' ? ctx : () => ctx;
+}

package/dist/src/lib/router/data.mjs

@@ -0,0 +1,214 @@
+// src/lib/router/data.ts
+import {
+  createResource,
+  createSignal
+} from "@fluixi/reactive/signal";
+import { currentResourceCache } from "@fluixi/reactive/signal";
+
+// src/lib/context/context.ts
+import { asProvider } from "@fluixi/dom";
+import {
+  createContext as createReactiveContext,
+  getOwner,
+  useContext as useReactiveContext
+} from "@fluixi/reactive/signal";
+function createContext(defaultValue, name) {
+  const context = createReactiveContext(defaultValue, name);
+  const Provider = (props) => (
+    // Children stay a getter: the reactive Provider reads them after stamping the value on
+    // its owner. Reading `props.children` here would render them, and any <Outlet/> in them,
+    // before the context exists.
+    context.Provider({
+      value: props.value,
+      get children() {
+        return props.children;
+      },
+      debug: props.debug
+    })
+  );
+  return {
+    id: context.id,
+    Provider: asProvider(Provider),
+    defaultValue
+  };
+}
+function useContext(context) {
+  const value = useReactiveContext(context);
+  return value !== void 0 ? value : context.defaultValue;
+}
+
+// src/lib/router/data.ts
+var revalidationListeners = /* @__PURE__ */ new Set();
+function onRevalidate(listener) {
+  revalidationListeners.add(listener);
+  return () => void revalidationListeners.delete(listener);
+}
+var reloadMounted = () => {
+  for (const listener of [...revalidationListeners]) listener();
+};
+function cache(fn, name, options = {}) {
+  const { ttl = Infinity, staleWhileRevalidate = true } = options;
+  return (...args) => {
+    const store = options.cache ?? currentResourceCache();
+    const key = name + ":" + JSON.stringify(args);
+    const fetchFresh = () => {
+      const running = store.inflight.get(key);
+      if (running) return running;
+      const promise = Promise.resolve(fn(...args)).then(
+        (value) => {
+          store.set(key, { value, timestamp: Date.now() });
+          store.inflight.delete(key);
+          return value;
+        },
+        (error) => {
+          store.inflight.delete(key);
+          throw error;
+        }
+      );
+      store.inflight.set(key, promise);
+      return promise;
+    };
+    const hit = store.get(key);
+    if (hit && (ttl === Infinity || Date.now() - hit.timestamp <= ttl)) return Promise.resolve(hit.value);
+    if (hit && staleWhileRevalidate) {
+      fetchFresh().then(reloadMounted, () => void 0);
+      return Promise.resolve(hit.value);
+    }
+    return fetchFresh();
+  };
+}
+function revalidate(key, store) {
+  const names = typeof key === "string" ? [key] : Array.isArray(key) ? key : null;
+  drop(names ?? key, store ?? currentResourceCache());
+  if (names && !store) tellOtherTabs(names);
+}
+function drop(what, store) {
+  const matches = Array.isArray(what) ? (k) => what.some((n) => k === n || k.startsWith(n + ":")) : what;
+  for (const k of [...store.keys()]) if (matches(k)) store.delete(k);
+  reloadMounted();
+}
+var TABS_KEY = "fluixi:revalidate";
+function tellOtherTabs(names) {
+  try {
+    localStorage.setItem(TABS_KEY, JSON.stringify({ names, at: Date.now() + Math.random() }));
+  } catch {
+  }
+}
+if (typeof window !== "undefined") {
+  window.addEventListener("storage", (event) => {
+    if (event.key !== TABS_KEY || !event.newValue) return;
+    try {
+      const names = JSON.parse(event.newValue).names;
+      if (Array.isArray(names) && names.every((n) => typeof n === "string")) drop(names, currentResourceCache());
+    } catch {
+    }
+  });
+}
+globalThis[/* @__PURE__ */ Symbol.for("fluixi.revalidate")] = (names) => revalidate(names);
+function createAsync(fetcher, source) {
+  const [data] = createResource(source || (() => true), fetcher);
+  return data;
+}
+var submissionState = /* @__PURE__ */ new Map();
+function getSubmissionSignal(url) {
+  if (!submissionState.has(url)) {
+    submissionState.set(
+      url,
+      createSignal(void 0)
+    );
+  }
+  return submissionState.get(url);
+}
+var submissionsState = /* @__PURE__ */ new Map();
+function getSubmissionsSignal(url) {
+  if (!submissionsState.has(url)) submissionsState.set(url, createSignal([]));
+  return submissionsState.get(url);
+}
+function action(fn, name, options = {}) {
+  const actionUrl = name || fn.name || "action";
+  const submit = async (...args) => {
+    const input = args.length > 1 ? args : args[0];
+    const [, setSubmission] = getSubmissionSignal(actionUrl);
+    const [, setSubmissions] = getSubmissionsSignal(actionUrl);
+    let entry;
+    const drop2 = () => setSubmissions((list) => list.filter((s) => s !== entry));
+    const settle = (next) => {
+      setSubmissions((list) => list.map((s) => s === entry ? next : s));
+      entry = next;
+    };
+    const clear = () => {
+      setSubmission(void 0);
+      drop2();
+    };
+    const retry = () => {
+      drop2();
+      return submit(...args);
+    };
+    entry = {
+      input,
+      pending: true,
+      clear,
+      retry
+    };
+    setSubmission(entry);
+    setSubmissions((list) => [...list, entry]);
+    try {
+      const result = await fn(...args);
+      setSubmission({
+        input,
+        result,
+        pending: false,
+        clear,
+        retry
+      });
+      drop2();
+      const stale = typeof options.invalidates === "function" ? options.invalidates(result) : options.invalidates;
+      for (const key of stale ?? []) revalidate(key);
+      return result;
+    } catch (error) {
+      const failed = {
+        input,
+        error,
+        pending: false,
+        clear,
+        retry
+      };
+      setSubmission(failed);
+      settle(failed);
+      throw error;
+    }
+  };
+  submit.url = actionUrl;
+  submit.with = (args) => action((...a) => fn(args, ...a), name, options);
+  return submit;
+}
+function useSubmission(actionFn) {
+  const [submission] = getSubmissionSignal(actionFn.url);
+  return submission;
+}
+function useSubmissions(actionFn) {
+  const [submissions] = getSubmissionsSignal(actionFn.url);
+  return submissions;
+}
+function useAction(actionFn) {
+  return actionFn;
+}
+var RouteDataContext = createContext(void 0, "route-data");
+var RouteDataProvider = RouteDataContext.Provider;
+function useRouteData() {
+  const ctx = useContext(RouteDataContext);
+  return typeof ctx === "function" ? ctx : () => ctx;
+}
+export {
+  RouteDataContext,
+  RouteDataProvider,
+  action,
+  cache,
+  createAsync,
+  onRevalidate,
+  revalidate,
+  useAction,
+  useRouteData,
+  useSubmission,
+  useSubmissions
+};