@solidjs/router 1.0.0 → 2.0.0-next.13

package/dist/data/action.js

@@ -1,9 +1,125 @@
-import { $TRACK, createMemo, createSignal, onCleanup, getOwner } from "solid-js";
-import { isServer } from "solid-js/web";
-import { useRouter } from "../routing.js";
+import { $TRACK, action as createSolidAction, createMemo, onCleanup, getOwner } from "solid-js";
+import { isResponseEnvelope, isServer, REVALIDATE_HEADER } from "@solidjs/web";
+import { createServerReference, decodeResponsePayload, subscribeFlightData } from "@solidjs/web/server-functions";
+// The explicit /server specifier is safe here: the only call site is
+// server-guarded, so client builds tree-shake the codec away.
+import { decodeFlashCookie } from "@solidjs/web/server-functions/server";
+import { provideFlashDecoder, provideFlightConsumer, useRouter } from "../routing.js";
+import { setRouterFormHandler } from "./events.js";
 import { mockBase, setFunctionName } from "../utils.js";
 import { cacheKeyOp, hashKey, revalidate, query } from "./query.js";
+const submitHooksSymbol = Symbol("routerActionSubmitHooks");
+const settledHooksSymbol = Symbol("routerActionSettledHooks");
+const invokeSymbol = Symbol("routerActionInvoke");
+// Forms submitted through delegation are marked `aria-busy` while their
+// action is in flight — the form half of the attribute vocabulary links get
+// (`data-active`/`data-pending`). Style with `form[aria-busy] button { ... }`.
+// A counter (not a boolean) keeps the attribute through overlapping
+// submissions from the same form.
+const busyForms = /* #__PURE__ */ new WeakMap();
+function setFormBusy(form, delta) {
+    const count = (busyForms.get(form) || 0) + delta;
+    busyForms.set(form, count);
+    count > 0 ? form.setAttribute("aria-busy", "true") : form.removeAttribute("aria-busy");
+}
 export const actions = /* #__PURE__ */ new Map();
+/**
+ * The document-delegation submit handler for router actions. Lives here —
+ * not in events.ts — so the router's event wiring holds no static reference
+ * to the action module; `installRouterIntegrations` slots it in when the
+ * first action is created on the client.
+ */
+export function handleFormAction(evt, router, actionBase) {
+    if (evt.defaultPrevented)
+        return;
+    let actionRef = evt.submitter && evt.submitter.hasAttribute("formaction")
+        ? evt.submitter.getAttribute("formaction")
+        : evt.target.getAttribute("action");
+    if (!actionRef)
+        return;
+    const serverAction = !actionRef.startsWith("https://action/");
+    if (serverAction) {
+        // normalize server actions
+        const url = new URL(actionRef, mockBase);
+        actionRef = router.parsePath(url.pathname + url.search);
+        if (!actionRef.startsWith(actionBase))
+            return;
+    }
+    if (evt.target.method.toUpperCase() !== "POST")
+        throw new Error("Only POST forms are supported for Actions");
+    // A registry miss on a server-action url is a direct bind whose module
+    // never loaded client-side (server components): the url is self-describing
+    // (`?id`, bound `?args`), so a generic invocation is synthesized from it —
+    // delegation alone is sufficient, the no-JS path stays a no-JS fallback.
+    // Client-only actions (`https://action/`) are their module's JS by
+    // definition, so a miss there falls through to native submission.
+    const handler = actions.get(actionRef) || (serverAction && createServerFormAction(actionRef));
+    if (handler) {
+        evt.preventDefault();
+        const data = new FormData(evt.target, evt.submitter);
+        handler.call({ r: router, f: evt.target }, evt.target.enctype === "multipart/form-data"
+            ? data
+            : new URLSearchParams(data));
+    }
+}
+/**
+ * Synthesizes a router action for a server-rendered action url. The url
+ * carries everything an invocation needs — the function id and any bound
+ * `.with()` arguments (plain JSON in `?args`, which the server prepends for
+ * natural-encoding bodies exactly as it does for no-JS posts) — so the
+ * FormData is posted to it verbatim through the server-function transport:
+ * submissions, `aria-busy`, redirects, revalidation, and single-flight all
+ * flow through the normal action machinery. Registered under the url, so
+ * repeat submits reuse it (and a later real registration overrides it).
+ */
+function createServerFormAction(url) {
+    const id = new URL(url, mockBase).searchParams.get("id");
+    if (!id)
+        return undefined;
+    // typecheck resolves the server half of the dual module; this path only
+    // runs in the browser, where the client transport's signature applies
+    const stub = createServerReference(id, undefined, url);
+    const caller = Object.assign((form) => stub(form), { url });
+    return actionImpl(caller);
+}
+/**
+ * Entry point for delegation's lazy fallback (data/events.ts): when no form
+ * handler was ever installed — no action module in the client graph at all —
+ * the router intercepts posts to server-action urls synchronously and loads
+ * this module to run them. The FormData was captured at submit time; only
+ * the enctype conversion and the generic invocation happen here.
+ */
+export function submitServerForm(router, url, form, data) {
+    const handler = actions.get(url) || createServerFormAction(url);
+    // no `?id` — not the server function convention; nothing can run it,
+    // resubmit natively (submit() bypasses the delegated handler)
+    if (!handler)
+        return form.submit();
+    handler.call({ r: router, f: form }, form.enctype === "multipart/form-data" ? data : new URLSearchParams(data));
+}
+// Wires the action layer into the router's slots exactly once, triggered by
+// the first action creation. Not an import side effect — with
+// `sideEffects: false`, module evaluation only happens when action() is
+// actually used, which is precisely when the wiring is wanted: no action in
+// the graph means no form interception, no single-flight subscription (the
+// server is never asked to collect), and no flash cookies to decode. On the
+// server, actions are created at module scope, so the flash decoder is
+// always installed before useSubmission can read the submissions signal.
+let integrationsInstalled = false;
+function installRouterIntegrations() {
+    if (integrationsInstalled)
+        return;
+    integrationsInstalled = true;
+    if (isServer) {
+        // Server-only: initSubmissions only decodes during SSR, so client builds
+        // tree-shake the codec (which now lives behind the runtime's server entry).
+        provideFlashDecoder(decodeFlashCookie);
+    }
+    else {
+        setRouterFormHandler(handleFormAction);
+        provideFlightConsumer(setupFlightDataConsumer);
+    }
+}
 export function useSubmissions(fn, filter) {
     const router = useRouter();
     const subs = createMemo(() => router.submissions[0]().filter(s => s.url === fn.base && (!filter || filter(s.input))));
@@ -11,8 +127,6 @@ export function useSubmissions(fn, filter) {
         get(_, property) {
             if (property === $TRACK)
                 return subs();
-            if (property === "pending")
-                return subs().some(sub => !sub.result);
             return subs()[property];
         },
         has(_, property) {
@@ -20,130 +134,190 @@ export function useSubmissions(fn, filter) {
         }
     });
 }
-export function useSubmission(fn, filter) {
-    const submissions = useSubmissions(fn, filter);
-    return new Proxy({}, {
-        get(_, property) {
-            if (submissions.length === 0 && (property === "clear" || property === "retry"))
-                return () => { };
-            return submissions[submissions.length - 1]?.[property];
-        }
-    });
-}
 export function useAction(action) {
     const r = useRouter();
     return (...args) => action.apply({ r }, args);
 }
-export function action(fn, options = {}) {
-    function mutate(...variables) {
+function actionImpl(fn, options = {}) {
+    async function invoke(variables, current) {
         const router = this.r;
         const form = this.f;
-        const p = (router.singleFlight && fn.withOptions
-            ? fn.withOptions({ headers: { "X-Single-Flight": "true" } })
-            : fn)(...variables);
-        const [result, setResult] = createSignal();
-        let submission;
-        function handler(error) {
-            return async (res) => {
-                const result = await handleResponse(res, error, router.navigatorFactory());
-                let retry = null;
-                o.onComplete?.({
-                    ...submission,
-                    result: result?.data,
-                    error: result?.error,
-                    pending: false,
-                    retry() {
-                        return (retry = submission.retry());
+        const submitHooks = current[submitHooksSymbol];
+        const settledHooks = current[settledHooksSymbol];
+        // Single-flight opt-in is no longer per call: the router's registered
+        // flight-data consumer (see setupFlightDataConsumer) makes the transport
+        // send the request header itself, so the mutation is just called.
+        const runMutation = () => fn(...variables);
+        const run = createSolidAction(async function* (context) {
+            context.optimistic?.();
+            try {
+                const value = await context.call();
+                yield;
+                return { error: false, value };
+            }
+            catch (error) {
+                yield;
+                return { error: true, value: error };
+            }
+        });
+        form && setFormBusy(form, 1);
+        let settled;
+        let response;
+        // The transport consumer is awaited before a single-flight mutation
+        // resolves, so a counter delta over the call tells whether this action's
+        // metadata was already applied. Overlapping mutations can cross-attribute
+        // a run (skipping one default revalidation another pass just covered) —
+        // a far smaller window than predicting from the function's identity,
+        // which misses every response the server returned without flight data.
+        const flightApplicationsBefore = flightApplications;
+        try {
+            settled = await settleActionResult(run({
+                call: runMutation,
+                optimistic: submitHooks.size
+                    ? () => {
+                        for (const hook of submitHooks.values())
+                            hook(...variables);
                     }
-                });
-                if (retry)
-                    return retry;
-                if (!result)
-                    return submission.clear();
-                setResult(result);
-                if (result.error && !form)
-                    throw result.error;
-                return result.data;
-            };
+                    : undefined
+            }));
+            response = await handleResponse(settled.value, settled.error, router.navigatorFactory(), flightApplications !== flightApplicationsBefore);
+        }
+        finally {
+            form && setFormBusy(form, -1);
         }
-        router.submissions[1](s => [
-            ...s,
-            (submission = {
-                input: variables,
-                url,
-                get result() {
-                    return result()?.data;
-                },
-                get error() {
-                    return result()?.error;
-                },
-                get pending() {
-                    return !result();
-                },
-                clear() {
-                    router.submissions[1](v => v.filter(i => i !== submission));
-                },
-                retry() {
-                    setResult(undefined);
-                    const p = fn(...variables);
-                    return p.then(handler(), handler(true));
-                }
-            })
-        ]);
-        return p.then(handler(), handler(true));
+        let submission;
+        submission = {
+            input: variables,
+            url,
+            result: response && response.data,
+            error: response && response.error,
+            clear() {
+                router.submissions[1](entries => entries.filter(entry => entry !== submission));
+            },
+            retry() {
+                submission.clear();
+                return current[invokeSymbol].call({ r: router, f: form }, variables, current);
+            }
+        };
+        // Book-keeping is intentional: only outcomes worth showing or retrying
+        // (a result or an error) enter the submissions list, so the typical void
+        // mutation leaves nothing behind. Settled hooks still see every
+        // completion — void, metadata-only, and redirects included — one
+        // `onSettled` per invocation (#580).
+        response && router.submissions[1](entries => [...entries, submission]);
+        for (const hook of settledHooks.values())
+            hook(submission);
+        if (response) {
+            if (response.error && !form)
+                throw response.error;
+            return response.data;
+        }
+        return undefined;
     }
     const o = typeof options === "string" ? { name: options } : options;
     const name = o.name || (!isServer ? String(hashString(fn.toString())) : undefined);
     const url = fn.url || (name && `https://action/${name}`) || "";
-    mutate.base = url;
+    const wrapped = toAction(invoke, url);
     if (name)
-        setFunctionName(mutate, name);
-    return toAction(mutate, url);
+        setFunctionName(wrapped, name);
+    return wrapped;
 }
-function toAction(fn, url) {
+export const action = actionImpl;
+function toAction(invoke, url, boundArgs = [], base = url, submitHooks = new Map(), settledHooks = new Map()) {
+    const fn = function (...args) {
+        return invoke.call(this, [...boundArgs, ...args], fn);
+    };
     fn.toString = () => {
         if (!url)
             throw new Error("Client Actions need explicit names if server rendered");
         return url;
     };
     fn.with = function (...args) {
-        const newFn = function (...passedArgs) {
-            return fn.call(this, ...args, ...passedArgs);
-        };
-        newFn.base = fn.base;
         const uri = new URL(url, mockBase);
         uri.searchParams.set("args", hashKey(args));
-        return toAction(newFn, (uri.origin === "https://action" ? uri.origin : "") + uri.pathname + uri.search);
+        const next = toAction(invoke, (uri.origin === "https://action" ? uri.origin : "") + uri.pathname + uri.search, [...boundArgs, ...args], base, submitHooks, settledHooks);
+        return next;
+    };
+    fn.onSubmit = function (hook) {
+        const id = Symbol("actionOnSubmitHook");
+        submitHooks.set(id, hook);
+        getOwner() && onCleanup(() => submitHooks.delete(id));
+        return this;
+    };
+    fn.onSettled = function (hook) {
+        const id = Symbol("actionOnSettledHook");
+        settledHooks.set(id, hook);
+        getOwner() && onCleanup(() => settledHooks.delete(id));
+        return this;
     };
     fn.url = url;
+    fn.base = base;
+    fn[submitHooksSymbol] = submitHooks;
+    fn[settledHooksSymbol] = settledHooks;
+    fn[invokeSymbol] = invoke;
+    installRouterIntegrations();
     if (!isServer) {
         actions.set(url, fn);
         // Only remove the registration if it still belongs to this instance —
         // a re-created action (e.g. a new `.with()` binding after revalidation)
         // may have registered itself under the same URL since.
-        getOwner() && onCleanup(() => actions.get(url) === fn && actions.delete(url));
+        getOwner() &&
+            onCleanup(() => actions.get(url) === fn && actions.delete(url));
     }
     return fn;
 }
 const hashString = (s) => s.split("").reduce((a, b) => ((a << 5) - a + b.charCodeAt(0)) | 0, 0);
-async function handleResponse(response, error, navigate) {
-    let data;
-    let custom;
-    let keys;
-    let flightKeys;
-    if (response instanceof Response) {
-        if (response.headers.has("X-Revalidate"))
-            keys = response.headers.get("X-Revalidate").split(",");
-        if (response.customBody) {
-            data = custom = await response.customBody();
-            if (response.headers.has("X-Single-Flight")) {
-                data = data._$value;
-                delete custom._$value;
-                flightKeys = Object.keys(custom);
-            }
+async function settleActionResult(result) {
+    const value = result;
+    if (value && typeof value.then === "function") {
+        return result.then(value => value);
+    }
+    if (value && typeof value.next === "function") {
+        const iterator = value;
+        let next = await iterator.next();
+        while (!next.done) {
+            next = await iterator.next();
         }
-        if (response.headers.has("Location")) {
-            const locationUrl = response.headers.get("Location") || "/";
+        return next.value;
+    }
+    return result;
+}
+// Invocation count of the flight-data consumer. An action compares it across
+// its mutation call to learn whether the transport already applied this
+// response's metadata (and so the default revalidation pass must not run
+// again and wipe the freshly seeded cache).
+let flightApplications = 0;
+/**
+ * Registers the router as the single-flight consumer of the server function
+ * transport. Subscribing is the opt-in: while registered, the transport
+ * sends the `X-Single-Flight` request header on mutations and delivers the
+ * folded payload here — fresh route data is seeded into the `query` cache
+ * and the envelope metadata (redirect `Location`, `X-Revalidate` keys) is
+ * applied, all before the action sees its plain return value. Called by the
+ * Router component on the client unless `singleFlight={false}`, which now
+ * simply means "never subscribe" — no consumer, no request header, no
+ * collection work on the server. Returns the unsubscribe function.
+ */
+export function setupFlightDataConsumer(router) {
+    return subscribeFlightData((data, { response }) => {
+        flightApplications++;
+        return applyResponseMetadata(response, router.navigatorFactory(), data);
+    });
+}
+/**
+ * Applies a server function response's integration metadata: `X-Revalidate`
+ * keys invalidate, `Location` navigates (hard for absolute urls), flight
+ * data seeds the query cache, and matching entries revalidate. Shared by
+ * the flight-data consumer and the action response path (which still sees
+ * metadata-bearing responses when no flight data was collected).
+ */
+function applyResponseMetadata(metadata, navigate, flightData) {
+    let keys;
+    if (metadata) {
+        if (metadata.headers.has(REVALIDATE_HEADER))
+            keys = metadata.headers.get(REVALIDATE_HEADER).split(",");
+        if (metadata.headers.has("Location")) {
+            const locationUrl = metadata.headers.get("Location") || "/";
             if (locationUrl.startsWith("http")) {
                 window.location.href = locationUrl;
             }
@@ -152,15 +326,47 @@ async function handleResponse(response, error, navigate) {
             }
         }
     }
+    // invalidate
+    cacheKeyOp(keys, entry => (entry[0] = 0));
+    // set cache
+    flightData && Object.keys(flightData).forEach(k => query.set(k, flightData[k]));
+    // trigger revalidation inside the same transition as the navigation, so
+    // the redirect commits atomically with fresh data: surviving consumers
+    // (shared layouts) the flight payload didn't seed refetch and hold the
+    // commit rather than painting stale and updating after. Seeded entries
+    // are fresh again by now, so the sweep re-reads them from cache.
+    revalidate(keys, false);
+}
+async function handleResponse(response, error, navigate, metadataHandled) {
+    let data;
+    let flightData;
+    let metadata;
+    if (isResponseEnvelope(response)) {
+        // client-only respond(): the value rides in memory beside the metadata
+        data = response.value;
+        metadata = response.response;
+    }
+    else if (response instanceof Response) {
+        metadata = response;
+        // responses the transport hands over whole (redirects, revalidation)
+        // carry a codec-encoded body the router decodes itself. With the
+        // flight-data consumer registered single-flight payloads never reach
+        // this path, but a manually opted-in call (no consumer) still can —
+        // the runtime splits its own envelope shape.
+        if (response.body) {
+            const payload = await decodeResponsePayload(response);
+            data = payload.value;
+            flightData = payload.flightData;
+        }
+    }
     else if (error)
         return { error: response };
     else
         data = response;
-    // invalidate
-    cacheKeyOp(keys, entry => (entry[0] = 0));
-    // set cache
-    flightKeys && flightKeys.forEach(k => query.set(k, custom[k]));
-    // trigger revalidation
-    await revalidate(keys, false);
+    // The transport consumer applies metadata before returning a server
+    // function's unwrapped value. Do not treat that value as a second plain
+    // action response and invalidate the freshly seeded query cache again.
+    if (!metadataHandled || metadata || flightData)
+        applyResponseMetadata(metadata, navigate, flightData);
     return data != null ? { data } : undefined;
 }

package/dist/data/events.d.ts

@@ -1,4 +1,12 @@
 import type { RouterContext } from "../types.js";
+/**
+ * The submit delegation consults this slot instead of importing the action
+ * module: the action side installs its handler on first action creation
+ * (see data/action.ts), so an app that never creates an action never pulls
+ * the data layer into its bundle through the router's event wiring.
+ */
+export type RouterFormHandler = (evt: SubmitEvent, router: RouterContext, actionBase: string) => void;
+export declare function setRouterFormHandler(handler: RouterFormHandler | undefined): void;
 type NativeEventConfig = {
     preload?: boolean;
     explicitLinks?: boolean;

package/dist/data/events.js

@@ -1,7 +1,9 @@
-import { delegateEvents } from "solid-js/web";
+import { delegateEvents } from "@solidjs/web";
 import { onCleanup } from "solid-js";
-import { actions } from "./action.js";
-import { mockBase } from "../utils.js";
+let formHandler;
+export function setRouterFormHandler(handler) {
+    formHandler = handler;
+}
 export function setupNativeEvents({ preload = true, explicitLinks = false, actionBase = "/_server", transformUrl } = {}) {
     return (router) => {
         const basePath = router.base.path();
@@ -76,30 +78,29 @@ export function setupNativeEvents({ preload = true, explicitLinks = false, actio
             }, 20);
         }
         function handleFormSubmit(evt) {
+            if (formHandler)
+                return formHandler(evt, router, actionBase);
+            // No form handler means no action module in the client graph at all
+            // (e.g. server components binding forms straight to server functions).
+            // A POST to a url under actionBase is self-describing, so delegation
+            // is still sufficient: intercept synchronously — the no-JS treatment
+            // is reserved for clients with no JS — capture the FormData, and load
+            // the handler lazily. Apps that never submit one never load it.
             if (evt.defaultPrevented)
                 return;
-            let actionRef = evt.submitter && evt.submitter.hasAttribute("formaction")
+            const form = evt.target;
+            const ref = evt.submitter && evt.submitter.hasAttribute("formaction")
                 ? evt.submitter.getAttribute("formaction")
-                : evt.target.getAttribute("action");
-            if (!actionRef)
+                : form.getAttribute("action");
+            if (!ref || ref.startsWith("https://action/"))
                 return;
-            if (!actionRef.startsWith("https://action/")) {
-                // normalize server actions
-                const url = new URL(actionRef, mockBase);
-                actionRef = router.parsePath(url.pathname + url.search);
-                if (!actionRef.startsWith(actionBase))
-                    return;
-            }
-            if (evt.target.method.toUpperCase() !== "POST")
-                throw new Error("Only POST forms are supported for Actions");
-            const handler = actions.get(actionRef);
-            if (handler) {
-                evt.preventDefault();
-                const data = new FormData(evt.target, evt.submitter);
-                handler.call({ r: router, f: evt.target }, evt.target.enctype === "multipart/form-data"
-                    ? data
-                    : new URLSearchParams(data));
-            }
+            const url = new URL(ref, document.baseURI);
+            const path = router.parsePath(url.pathname + url.search);
+            if (!path.startsWith(actionBase) || form.method.toUpperCase() !== "POST")
+                return;
+            evt.preventDefault();
+            const data = new FormData(form, evt.submitter);
+            import("./serverForms.js").then(m => m.submitServerForm(router, path, form, data));
         }
         // ensure delegated event run first
         delegateEvents(["click", "submit"]);

package/dist/data/index.d.ts

@@ -1,4 +1,2 @@
-export { createAsync, createAsyncStore, type AccessorWithLatest } from "./createAsync.js";
-export { action, useSubmission, useSubmissions, useAction, type Action } from "./action.js";
-export { query, revalidate, cache, type CachedFunction } from "./query.js";
-export { redirect, reload, json } from "./response.js";
+export { action, useSubmissions, useAction, type Action } from "./action.js";
+export { query, revalidate, type CachedFunction } from "./query.js";

package/dist/data/index.js

@@ -1,4 +1,2 @@
-export { createAsync, createAsyncStore } from "./createAsync.js";
-export { action, useSubmission, useSubmissions, useAction } from "./action.js";
-export { query, revalidate, cache } from "./query.js";
-export { redirect, reload, json } from "./response.js";
+export { action, useSubmissions, useAction } from "./action.js";
+export { query, revalidate } from "./query.js";

package/dist/data/query.d.ts

@@ -2,7 +2,7 @@ import type { CacheEntry, NarrowResponse } from "../types.js";
 /**
  * Revalidates the given cache entry/entries.
  */
-export declare function revalidate(key?: string | string[] | void, force?: boolean): Promise<void>;
+export declare function revalidate(key?: string | string[] | void, force?: boolean): void;
 export declare function cacheKeyOp(key: string | string[] | void, fn: (cacheEntry: CacheEntry) => void): void;
 export type CachedFunction<T extends (...args: any) => any> = T extends (...args: infer A) => infer R ? ([] extends {
     [K in keyof A]-?: A[K];
@@ -18,6 +18,4 @@ export declare namespace query {
     export var clear: () => void;
     export { _a as delete };
 }
-/** @deprecated use query instead */
-export declare const cache: typeof query;
 export declare function hashKey<T extends Array<any>>(args: T): string;