@kasperrt/smolter 0.2.0 → 0.3.0

package/dist/core.d.ts

@@ -1,2 +0,0 @@
-/** Core entry point. @module */
-export * from "./internal/core/index.ts";

package/dist/core.js

@@ -1,2 +0,0 @@
-/** Core entry point. @module */
-export * from "./internal/core/index.js";

package/dist/files.d.ts

@@ -1,2 +0,0 @@
-/** Files entry point. @module */
-export * from "./internal/files/index.ts";

package/dist/files.js

@@ -1,2 +0,0 @@
-/** Files entry point. @module */
-export * from "./internal/files/index.js";

package/dist/internal/client/deserialize.js

@@ -1,11 +0,0 @@
-/** Restore a trusted snapshot produced by @kasperrt/smolter/server serialize, including its route error. */
-export function deserialize(json) {
-    const snapshot = JSON.parse(json);
-    const error = snapshot.error;
-    if (error) {
-        snapshot.error = Object.assign(new Error(error.message), {
-            name: error.name,
-        });
-    }
-    return snapshot;
-}

package/dist/internal/client/index.js

@@ -1,44 +0,0 @@
-/**
- * Optional browser transport for server loaders and actions.
- * @module
- */
-export { deserialize } from "./deserialize.js";
-/** Browser transport for server routes. File-router builds generate this call. */
-export function serverRoute(path, module, handlers = { loader: true, action: true }) {
-    const remote = async ({ request, signal }) => {
-        const url = new URL(request.url);
-        const response = await fetch(`/_smolter?url=${encodeURIComponent(url.pathname + url.search)}`, {
-            method: request.method,
-            signal,
-            ...(request.method !== "GET" && { body: await request.formData() }),
-        });
-        const location = response.headers.get("X-Smolter-Redirect");
-        if (location)
-            return new Response(null, {
-                status: 303,
-                headers: { Location: location },
-            });
-        const data = await response.json();
-        if (!response.ok)
-            return new Error(data.error ?? "Route request failed");
-        return data;
-    };
-    return {
-        ...module,
-        path,
-        ...(handlers.loader && { loader: remote }),
-        ...(handlers.action && { action: remote }),
-        ...(module.clientLoader && {
-            clientLoader: (args) => module.clientLoader({ ...args, serverLoader: () => remote(args) }),
-        }),
-        ...(module.clientAction && {
-            clientAction: (args) => {
-                const request = args.request.clone();
-                return module.clientAction({
-                    ...args,
-                    serverAction: () => remote({ ...args, request: request.clone() }),
-                });
-            },
-        }),
-    };
-}

package/dist/internal/core/errors.js

@@ -1,6 +0,0 @@
-/** Resolve returned or rejected errors into Error values without losing their cause. */
-export function safeWrapAsync(work) {
-    return Promise.resolve()
-        .then(work)
-        .then((data) => (data instanceof Error ? { error: data } : { data }), (cause) => ({ error: new Error(String(cause), { cause }) }));
-}

package/dist/internal/core/index.js

@@ -1,7 +0,0 @@
-/** Framework-independent data routing. @module */
-export * from "./errors.js";
-export * from "./match.js";
-export * from "./router.js";
-export * from "./serialize.js";
-export * from "./types.js";
-export * from "./url.js";

package/dist/internal/core/match.js

@@ -1,27 +0,0 @@
-/** Associate a URL pattern with a module while retaining its inferred handler types. */
-export function defineRoute(path, module) {
-    return { ...module, path };
-}
-/** Static segments, :params and a terminal * wildcard; first match wins. */
-export function matchRoutes(routes, pathname) {
-    const segments = pathname.replace(/\/$/, "").split("/");
-    for (const route of routes) {
-        const parts = route.path.replace(/\/$/, "").split("/");
-        const params = {};
-        const matched = (parts.length === segments.length || parts.at(-1) === "*") &&
-            parts.every((part, index) => {
-                const value = segments[index];
-                if (part === "*") {
-                    params["*"] = segments.slice(index).join("/");
-                    return true;
-                }
-                if (part[0] === ":" && value) {
-                    params[part.slice(1)] = new URLSearchParams(`=${value.replace(/[+&]/g, encodeURIComponent)}`).get("");
-                    return true;
-                }
-                return part === value;
-            });
-        if (matched)
-            return { route, params };
-    }
-}

package/dist/internal/core/router.js

@@ -1,189 +0,0 @@
-import { safeWrapAsync } from "./errors.js";
-import { matchRoutes } from "./match.js";
-import { internalURL } from "./url.js";
-/** Create an isolated router. Use browser: true for browser history, or loadRouter for SSR. */
-export function createRouter(routes, options = {}) {
-    const browser = options.browser && typeof window !== "undefined";
-    let initialized = options.hydrationData?.state === "idle";
-    const initial = {
-        loaded: initialized,
-        ...(options.hydrationData ?? {
-            url: new URL(options.url ?? (browser ? location.href : "/"), "http://localhost").href,
-            params: {},
-            state: "idle",
-        }),
-    };
-    const disposers = new Set();
-    const channel = (initial, local = false) => {
-        let snapshot = initial;
-        let controller;
-        const listeners = new Set();
-        const dispose = () => {
-            disposers.delete(dispose);
-            controller?.abort();
-            listeners.clear();
-        };
-        const emit = (next) => {
-            snapshot = { ...snapshot, ...next };
-            for (const listener of listeners)
-                listener();
-        };
-        const run = async (href, body, operation = {}, 
-        // true pushes history; false handles popstate; undefined is a data request.
-        navigation) => {
-            controller?.abort();
-            controller = new AbortController();
-            const { signal } = controller;
-            disposers.add(dispose);
-            const previous = snapshot;
-            const url = internalURL(main.getSnapshot().url, href);
-            const match = url && matchRoutes(routes, url.pathname);
-            const commit = () => {
-                if (local || !url)
-                    return;
-                const changed = snapshot.url !== url.href;
-                if (!changed && snapshot.path !== undefined)
-                    return;
-                if (browser && (navigation || body) && changed)
-                    history[operation.replace ? "replaceState" : "pushState"](null, "", url);
-                const sameRoute = snapshot.path === match?.route.path;
-                snapshot = {
-                    ...snapshot,
-                    url: url.href,
-                    path: match?.route.path,
-                    params: match?.params ?? {},
-                    actionData: undefined,
-                    data: sameRoute ? snapshot.data : undefined,
-                    loaded: sameRoute && snapshot.loaded,
-                };
-            };
-            if (!body)
-                commit();
-            emit({ state: body ? "submitting" : "loading", error: undefined });
-            const result = await safeWrapAsync(() => {
-                if (!match)
-                    return new Error(url ? "No route" : "External URL");
-                if (navigation !== undefined &&
-                    !body &&
-                    previous.loaded &&
-                    !previous.error &&
-                    previous.path === match.route.path &&
-                    match.route.shouldRevalidate?.({
-                        url,
-                        currentUrl: new URL(previous.url),
-                        nextUrl: url,
-                        defaultShouldRevalidate: true,
-                        reason: "navigation",
-                    }) === false)
-                    return previous.data;
-                const fn = match.route[body ? "clientAction" : "clientLoader"] ||
-                    match.route[body ? "action" : "loader"];
-                if (!fn)
-                    return body && new Error("No action");
-                return fn({
-                    request: new Request(url, {
-                        signal,
-                        method: body && (operation.method ?? "POST"),
-                        body,
-                    }),
-                    params: match.params,
-                    signal,
-                });
-            });
-            if (signal.aborted)
-                return result;
-            const redirectTo = result.data instanceof Response && result.data.headers.get("Location");
-            if (redirectTo && (operation.hops ?? 0) < 10) {
-                await main.load(new URL(redirectTo, url).href, undefined, {
-                    replace: true,
-                    hops: (operation.hops ?? 0) + 1,
-                }, true);
-                if (!signal.aborted)
-                    emit({ state: "idle" });
-                return result;
-            }
-            if (redirectTo)
-                result.error = new Error("Redirect loop");
-            if (body && !result.error)
-                commit();
-            emit({
-                [body && !local ? "actionData" : "data"]: result.data,
-                error: result.error,
-                loaded: body ? snapshot.loaded : !result.error,
-                state: body && !result.error ? "loading" : "idle",
-            });
-            if (body && !result.error) {
-                await router.revalidate("action", {
-                    formMethod: operation.method ?? "POST",
-                    formAction: url.href,
-                    formData: body,
-                    actionResult: result.data,
-                });
-                if (!signal.aborted)
-                    emit({ state: "idle" });
-            }
-            return result;
-        };
-        return {
-            getSnapshot: () => snapshot,
-            subscribe(listener) {
-                listeners.add(listener);
-                return () => {
-                    listeners.delete(listener);
-                };
-            },
-            load: run,
-            submit: run,
-            dispose,
-        };
-    };
-    const main = channel(initial);
-    let started = 0;
-    const pop = () => {
-        void main.load(location.href, undefined, undefined, false);
-    };
-    const router = {
-        ...main,
-        routes,
-        start() {
-            if (!started++ && browser)
-                addEventListener("popstate", pop);
-            if (!initialized) {
-                initialized = true;
-                void main.load(initial.url);
-            }
-            return () => {
-                if (!--started && browser)
-                    removeEventListener("popstate", pop);
-            };
-        },
-        async navigate(url, operation) {
-            initialized = true;
-            await main.load(url, undefined, operation, true);
-        },
-        async revalidate(reason = "manual", context = {}) {
-            const url = new URL(main.getSnapshot().url);
-            if (matchRoutes(routes, url.pathname)?.route.shouldRevalidate?.({
-                ...context,
-                url,
-                currentUrl: url,
-                nextUrl: url,
-                defaultShouldRevalidate: true,
-                reason,
-            }) === false)
-                return;
-            await main.load(url.href);
-        },
-        createFetcher() {
-            return channel({ state: "idle" }, true);
-        },
-        dispose() {
-            main.dispose();
-            for (const dispose of disposers)
-                dispose();
-            if (browser)
-                removeEventListener("popstate", pop);
-        },
-    };
-    return router;
-}

package/dist/internal/core/serialize.js

@@ -1,13 +0,0 @@
-/** Safe inside a script element. Data must be JSON serializable; error stacks and causes are omitted. */
-export function serialize(snapshot) {
-    return JSON.stringify({
-        ...snapshot,
-        error: snapshot.error && {
-            name: snapshot.error.name,
-            message: snapshot.error.message,
-        },
-    })
-        .replace(/</g, "\\u003c")
-        .replace(/\u2028/g, "\\u2028")
-        .replace(/\u2029/g, "\\u2029");
-}

package/dist/internal/core/types.js

@@ -1,5 +0,0 @@
-/**
- * Framework-independent route matching, data requests, and state.
- * @module
- */
-export {};

package/dist/internal/core/url.d.ts

@@ -1,2 +0,0 @@
-/** Resolve an internal URL; external links remain the browser's responsibility. */
-export declare function internalURL(base: string, href?: string): URL | undefined;

package/dist/internal/core/url.js

@@ -1,6 +0,0 @@
-/** Resolve an internal URL; external links remain the browser's responsibility. */
-export function internalURL(base, href = base) {
-    const url = new URL(href, base);
-    if (url.origin === new URL(base).origin)
-        return url;
-}

package/dist/internal/files/index.js

@@ -1,77 +0,0 @@
-/**
- * Build-time discovery of flat file routes.
- * @module
- */
-import { readdir } from "node:fs/promises";
-import { resolve } from "node:path";
-import { safeWrapAsync } from "../core/index.js";
-const routeFile = /^route\.[jt]sx?$/;
-const flatFile = /\.[jt]sx?$/;
-/** Read only flat files and immediate route folders. Colocated helpers are ignored. */
-export async function flatRoutes(directory) {
-    const result = await safeWrapAsync(async () => {
-        const entries = await readdir(directory, { withFileTypes: true });
-        const routes = [];
-        const patterns = new Set();
-        for (const entry of entries) {
-            let name = entry.name;
-            let file = resolve(directory, name);
-            if (entry.isDirectory()) {
-                const candidates = (await readdir(file)).filter((name) => routeFile.test(name));
-                if (candidates.length > 1)
-                    return new Error(`Multiple route files in ${file}`);
-                if (!candidates.length)
-                    continue;
-                file = resolve(file, candidates[0]);
-            }
-            else {
-                if (!entry.isFile() || !flatFile.test(name) || name.endsWith(".d.ts"))
-                    continue;
-                name = name.replace(flatFile, "");
-            }
-            if (/[()[\]:*?]/.test(name))
-                return new Error(`Unsupported flat route name: ${name}`);
-            const segments = name.split(".");
-            const parts = [];
-            for (const [index, segment] of segments.entries()) {
-                if (!segment)
-                    return new Error(`Empty route segment: ${name}`);
-                if (segment === "_index" && index !== segments.length - 1)
-                    return new Error(`_index must be last: ${name}`);
-                if (segment === "$" && index !== segments.length - 1)
-                    return new Error(`Splat must be last: ${name}`);
-                if (segment.startsWith("_"))
-                    continue;
-                const part = segment.replace(/_$/, "");
-                parts.push(part === "$" ? "*" : part.replace(/^\$/, ":"));
-            }
-            // Pathless grouping modules are not nested layouts in a flat router.
-            if (segments.at(-1)?.startsWith("_") && segments.at(-1) !== "_index")
-                continue;
-            const path = `/${parts.join("/")}`;
-            const pattern = path.replace(/:[^/]+/g, ":");
-            if (patterns.has(pattern))
-                return new Error(`Conflicting flat route: ${path}`);
-            patterns.add(pattern);
-            routes.push({ path, file });
-        }
-        return routes.sort((a, b) => {
-            const left = a.path.split("/");
-            const right = b.path.split("/");
-            const rank = (part) => part === "*"
-                ? 0
-                : part?.startsWith(":")
-                    ? 1
-                    : part === undefined
-                        ? 2
-                        : 3;
-            for (let index = 0; index < Math.max(left.length, right.length); index++) {
-                const difference = rank(right[index]) - rank(left[index]);
-                if (difference)
-                    return difference;
-            }
-            return a.path.localeCompare(b.path);
-        });
-    });
-    return result.error ?? result.data;
-}

package/dist/internal/preact/context.d.ts

@@ -1,18 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import type { Router, Snapshot } from "../core/index.ts";
-import type { ReactNode } from "./runtime.ts";
-/** Router instance and children rendered within its context. */
-export interface RouterProviderProps {
-    router: Router;
-    children?: ReactNode;
-}
-/** Provide a router to descendant hooks and connect its browser lifecycle. */
-export declare function RouterProvider({ router, children, }: RouterProviderProps): ReactNode;
-/** Hooks require a RouterProvider. */
-export declare function useRouter(): Router;
-type SnapshotSelector<T> = (snapshot: Snapshot) => T;
-export declare function useSnapshot<T>(select: SnapshotSelector<T>): T;
-export {};

package/dist/internal/preact/context.js

@@ -1,20 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { createContext, createElement, useContext, useEffect, useSyncExternalStore, } from "./runtime.js";
-const RouterContext = createContext(undefined);
-/** Provide a router to descendant hooks and connect its browser lifecycle. */
-export function RouterProvider({ router, children, }) {
-    useEffect(router.start, [router]);
-    return createElement(RouterContext.Provider, { value: router }, children);
-}
-/** Hooks require a RouterProvider. */
-export function useRouter() {
-    return useContext(RouterContext);
-}
-export function useSnapshot(select) {
-    const router = useRouter();
-    const getSnapshot = () => select(router.getSnapshot());
-    return useSyncExternalStore(router.subscribe, getSnapshot, getSnapshot);
-}

package/dist/internal/preact/fetcher.js

@@ -1,28 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { useRouter } from "./context.js";
-import { Form } from "./form.js";
-import { createElement, useEffect, useMemo, useSyncExternalStore, } from "./runtime.js";
-/** Create a fetcher for independent route reads and mutations; its data stays local. */
-export function useFetcher(route) {
-    const router = useRouter();
-    const path = route?.path;
-    const fetcher = useMemo(() => {
-        const store = router.createFetcher();
-        const target = () => {
-            const snapshot = router.getSnapshot();
-            return path === undefined || path === snapshot.path ? snapshot.url : path;
-        };
-        return {
-            ...store,
-            Form: (props) => createElement(Form, { action: target(), ...props, fetcher: store }),
-            load: (url) => store.load(url ?? target()),
-            submit: (body, options) => store.submit(options?.action ?? target(), body, options),
-        };
-    }, [router, path]);
-    useEffect(() => fetcher.dispose, [fetcher]);
-    const state = useSyncExternalStore(fetcher.subscribe, fetcher.getSnapshot, fetcher.getSnapshot);
-    return { ...fetcher, ...state };
-}

package/dist/internal/preact/form.js

@@ -1,41 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { internalURL } from "../core/index.js";
-import { useRouter } from "./context.js";
-import { createElement } from "./runtime.js";
-/** Submit form data to a registered route without a document reload. */
-export function Form({ action, method = "post", fetcher, onSubmit, ...props }) {
-    const router = useRouter();
-    const submit = (event) => {
-        onSubmit?.(event);
-        if (event.defaultPrevented)
-            return;
-        const submitter = event.submitter;
-        const target = internalURL(router.getSnapshot().url, submitter?.getAttribute("formaction") ?? action);
-        if (!target)
-            return;
-        event.preventDefault();
-        const data = new FormData(event.currentTarget, submitter);
-        const verb = (submitter?.getAttribute("formmethod") ?? method).toUpperCase();
-        if (verb === "GET") {
-            const search = new URLSearchParams();
-            for (const [key, value] of data)
-                search.append(key, typeof value === "string" ? value : value.name);
-            target.search = String(search);
-            void (fetcher ? fetcher.load : router.navigate)(target.href);
-            return;
-        }
-        const options = {
-            method: verb,
-        };
-        void (fetcher ?? router).submit(target.href, data, options);
-    };
-    return createElement("form", {
-        ...props,
-        action,
-        method: method === "get" ? "get" : "post",
-        onSubmit: submit,
-    });
-}

package/dist/internal/preact/hooks.js

@@ -1,35 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { useRouter, useSnapshot } from "./context.js";
-function useData(key, route) {
-    const path = route?.path;
-    return useSnapshot((snapshot) => {
-        if (path !== undefined && path !== snapshot.path)
-            return undefined;
-        return snapshot[key];
-    });
-}
-/** Pass a route for inference, or use useLoaderData<typeof loader>() in its module. */
-export function useLoaderData(route) {
-    return useData("data", route);
-}
-/** Read the last page action result, optionally inferring its type from a route. */
-export function useActionData(route) {
-    return useData("actionData", route);
-}
-/** Read path parameters for the active route. */
-export function useParams() {
-    return useSnapshot((snapshot) => snapshot.params);
-}
-/** Read the current path, search, and hash together with the navigate function. */
-export function useLocation() {
-    const router = useRouter();
-    const url = useSnapshot((snapshot) => snapshot.url);
-    return [url.replace(/^\w+:\/\/[^/]+/, ""), router.navigate];
-}
-/** Get the function that revalidates the current loader subject to shouldRevalidate. */
-export function useRevalidator() {
-    return useRouter().revalidate;
-}

package/dist/internal/preact/index.d.ts

@@ -1,9 +0,0 @@
-/** Framework components and typed data hooks. @module */
-export type * from "../core/index.ts";
-export { createRouter, defineRoute } from "../core/index.ts";
-export { RouterProvider, type RouterProviderProps, useRouter, } from "./context.ts";
-export * from "./fetcher.ts";
-export * from "./form.ts";
-export * from "./hooks.ts";
-export * from "./link.ts";
-export * from "./routes.ts";

package/dist/internal/preact/index.js

@@ -1,7 +0,0 @@
-export { createRouter, defineRoute } from "../core/index.js";
-export { RouterProvider, useRouter, } from "./context.js";
-export * from "./fetcher.js";
-export * from "./form.js";
-export * from "./hooks.js";
-export * from "./link.js";
-export * from "./routes.js";

package/dist/internal/preact/link.d.ts

@@ -1,12 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import type { AnchorHTMLAttributes, ReactNode } from "./runtime.ts";
-/** Anchor attributes with internal navigation and optional history replacement. */
-export interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
-    href: string;
-    replace?: boolean;
-}
-/** Render an anchor that handles internal navigation and preserves native modified clicks. */
-export declare function Link({ href, replace, onClick, ...props }: LinkProps): ReactNode;

package/dist/internal/preact/link.js

@@ -1,28 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { internalURL } from "../core/index.js";
-import { useRouter } from "./context.js";
-import { createElement } from "./runtime.js";
-/** Render an anchor that handles internal navigation and preserves native modified clicks. */
-export function Link({ href, replace, onClick, ...props }) {
-    const router = useRouter();
-    const click = (event) => {
-        onClick?.(event);
-        if (event.defaultPrevented ||
-            event.button ||
-            event.metaKey ||
-            event.ctrlKey ||
-            event.altKey ||
-            event.shiftKey ||
-            props.download !== undefined ||
-            (props.target && props.target !== "_self"))
-            return;
-        if (!internalURL(router.getSnapshot().url, href))
-            return;
-        event.preventDefault();
-        void router.navigate(href, { replace });
-    };
-    return createElement("a", { ...props, href, onClick: click });
-}

package/dist/internal/preact/routes.js

@@ -1,22 +0,0 @@
-/**
- * Preact components and typed data hooks. Import from @kasperrt/smolter/preact.
- * @module
- */
-import { useRouter, useSnapshot } from "./context.js";
-import { createElement, useMemo } from "./runtime.js";
-/** Renders the first matching registered module. */
-export function Routes({ fallback = null }) {
-    const router = useRouter();
-    const state = useSnapshot((snapshot) => snapshot);
-    const module = router.routes.find((route) => route.path === state.path);
-    const component = state.error
-        ? module?.ErrorBoundary
-        : state.state === "loading" && !state.loaded
-            ? module?.HydrateFallback
-            : module?.default;
-    const element = useMemo(() => component &&
-        createElement(component, {
-            error: state.error,
-        }), [component, state.error]);
-    return element ?? state.error?.message ?? fallback;
-}