@kestack/kabuki 0.0.0 → 0.0.2

package/dist/routing/route/places.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"places.d.ts","sourceRoot":"","sources":["../../../src/routing/route/places.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,KAAK,EACV,OAAO,EACP,QAAQ,EAER,MAAM,EACN,KAAK,EACL,WAAW,EACX,KAAK,EACN,MAAM,WAAW,CAAC;AASnB,sFAAsF;AACtF,eAAO,MAAM,QAAQ,aACT,QAAQ,SACX,KAAK,cACA,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,KACtC,aAAa,CAAC,KAAK,CA0BrB,CAAC;AAEF,kFAAkF;AAClF,eAAO,MAAM,OAAO,aACR,QAAQ,SACX,KAAK,KACX,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAc1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,aACV,QAAQ,2BAEd,aAAa,CAAC,MAAM,CAAC,WACjB,MAAM,WACN,UAAU,KACjB,aAAa,CAAC,WAAW,CAuBxB,CAAC;AAEL,qFAAqF;AACrF,eAAO,MAAM,OAAO,aACR,QAAQ,qBAEjB,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAUtC,CAAC"}

package/dist/routing/route/places.js

@@ -0,0 +1,87 @@
+import { Schema } from 'effect';
+import { dotted } from './node.js';
+import { pick } from './values.js';
+/*
+ * A Route's places: those on its path, each with its key, what its Loader
+ * is handed, its Render Mode and its data; and every place of the tree as
+ * Schemas, with the Stale time each is kept fresh for.
+ */
+/** The places on a Route's path, from the root down. The not-found Route has none. */
+export const placesOn = (children, route, staleTimes) => {
+    const out = [];
+    let layer = children;
+    let value = route;
+    const at = [];
+    let params = {};
+    let render = 'static';
+    while (value) {
+        const node = layer[value._tag];
+        if (!node)
+            break;
+        at.push(value._tag);
+        params = { ...params, ...pick(node.params, value) };
+        render = node.render ?? render;
+        const name = dotted(at);
+        out.push({
+            name,
+            key: JSON.stringify([name, params]),
+            params: { ...params, ...pick(node.query, value) },
+            render,
+            staleTime: staleTimes.get(name) ?? 0,
+            input: node.input,
+        });
+        layer = node.children;
+        value = value.page;
+    }
+    return out;
+};
+/** The nodes on a Route's path, from the root down, each with its dotted name. */
+export const nodesOn = (children, route) => {
+    const nodes = [];
+    let layer = children;
+    let value = route;
+    const at = [];
+    while (value) {
+        const node = layer[value._tag];
+        if (!node)
+            break;
+        at.push(value._tag);
+        nodes.push([dotted(at), node]);
+        layer = node.children;
+        value = value.page;
+    }
+    return nodes;
+};
+/**
+ * Every place of the tree, as Schemas, from the root down. A place's Stale
+ * time is its own, else its parent's, else `staleTime`; a static place's is
+ * `Infinity`, and one that says its own throws.
+ */
+export const allPlaces = (children, staleTime = 0, at = [], params = {}, render = 'static') => Object.entries(children).flatMap(([tag, node]) => {
+    const here = [...at, tag];
+    const name = dotted(here);
+    const fields = { ...params, ...node.params };
+    const mode = node.render ?? render;
+    if (mode === 'static' && node.staleTime !== undefined)
+        throw new Error(`[@kestack/kabuki/routing] ${name} is static: its data is fresh until the next deploy, so it has no staleTime`);
+    const stale = node.staleTime ?? staleTime;
+    return [
+        {
+            name,
+            params: Schema.Struct({ ...fields, ...node.query }),
+            render: mode,
+            staleTime: mode === 'static' ? Infinity : stale,
+            input: node.input,
+        },
+        ...allPlaces(node.children, stale, here, fields, mode),
+    ];
+});
+/** Every path of the tree, as written from the root: `/projects/:id/tasks/:task`. */
+export const pathsOf = (children, above = '') => Object.entries(children).flatMap(([tag, node]) => {
+    const own = node.path.split('/').filter(Boolean).join('/');
+    const path = own ? `${above}/${own}` : above;
+    return [
+        [tag, path || '/'],
+        ...pathsOf(node.children, path).map(([name, written]) => [`${tag}.${name}`, written]),
+    ];
+});

package/dist/routing/route/route.d.ts

@@ -0,0 +1,53 @@
+import type { Exactly, Loaders, LoadersOf } from './loader.ts';
+import type { Metadata } from './metadata.ts';
+import type { Codec, LoaderNames, NameOf, NotFound, Place, PlaceData, PlaceSchema, PlacesOf, Read, Redirects, RouteOf, StaticNames, Tree } from './node.ts';
+export type RoutesOptions<C, D> = {
+    readonly redirect?: Redirects<C, D>;
+    /** The root's Metadata, under every place's: the site's name, its default description. */
+    readonly metadata?: Metadata;
+    /** The not-found Route's Metadata, over the root's. */
+    readonly notFound?: Metadata;
+    /** The Stale time of every dynamic or client place that says none, nor its parent: 0 unless said. */
+    readonly staleTime?: number;
+};
+/** What `routesOf` gives besides a constructor per place. */
+export interface RoutesApi<C> {
+    /** The Schema of every Route. */
+    readonly route: Codec<RouteOf<C>>;
+    /** The Schema of every place's dotted name: `Blog.Post`. */
+    readonly place: Codec<NameOf<C>>;
+    /** The not-found Route, for a path that names no place. */
+    readonly NotFound: (args: {
+        readonly path: string;
+    }) => NotFound;
+    /** A path and query, like `/projects/4?tab=files`, read as a Route. */
+    readonly read: (url: string) => Read<RouteOf<C>>;
+    /** A Route written as its path and query, without any base. */
+    readonly path: (route: RouteOf<C>) => string;
+    /** Every place's path, as written from the root, by dotted name. */
+    readonly paths: () => Readonly<Record<string, string>>;
+    /** The Metadata of a Route, or of a URL, from the data of its places: pure, so a server can call it. */
+    readonly metadata: (of: RouteOf<C> | string, data?: PlaceData) => Metadata;
+    /** The places on a Route's path, from the root down. */
+    readonly places: (of: RouteOf<C> | string) => ReadonlyArray<Place<NameOf<C>>>;
+    /** Every place of the tree, as Schemas, from the root down. */
+    readonly every: ReadonlyArray<PlaceSchema<NameOf<C>>>;
+    /** Every place with data, by dotted name, with its data's Schema. */
+    readonly data: ReadonlyArray<readonly [string, Codec<unknown>]>;
+    /**
+     * The Loaders of every place with data, by dotted name, checked by type:
+     * one for each, and no other. A static place's is given its params and
+     * query; a dynamic or client place's, the request too.
+     */
+    readonly loaders: <const L extends Partial<LoadersOf<PlacesOf<C>, RouteOf<C>>>>(loaders: Exactly<L, LoaderNames<C>> & Partial<LoadersOf<PlacesOf<C>, RouteOf<C>>>) => Loaders<L, StaticNames<C>>;
+    /** The nodes as written. */
+    readonly children: C;
+}
+/**
+ * Every place of an app, from the nodes under the root. `redirect` names
+ * paths that are never a place, each with the Route it is replaced by,
+ * from the params its path names:
+ * `{ '/posts/:slug': (r, { slug }) => r.Blog.Post({ slug }) }`.
+ */
+export declare const routesOf: <C extends object, D>(children: C, options?: RoutesOptions<C, D>) => Tree<C, RouteOf<C>, {}> & RoutesApi<C>;
+//# sourceMappingURL=route.d.ts.map

package/dist/routing/route/route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.d.ts","sourceRoot":"","sources":["../../../src/routing/route/route.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE/D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,KAAK,EAGV,KAAK,EACL,WAAW,EACX,MAAM,EACN,QAAQ,EACR,KAAK,EACL,SAAS,EACT,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,SAAS,EACT,OAAO,EACP,WAAW,EACX,IAAI,EAEL,MAAM,WAAW,CAAC;AAwEnB,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI;IAChC,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,0FAA0F;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,qGAAqG;IACrG,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,6DAA6D;AAC7D,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,QAAQ,CAAC;IACjE,uEAAuE;IACvE,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAC7C,oEAAoE;IACpE,QAAQ,CAAC,KAAK,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD,wGAAwG;IACxG,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,KAAK,QAAQ,CAAC;IAC3E,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,CAChB,KAAK,CAAC,CAAC,SAAS,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAE3D,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAC1C,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;CACtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,YAChC,CAAC,YACF,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,KAC3B,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CA0EvC,CAAC"}

package/dist/routing/route/route.js

@@ -0,0 +1,148 @@
+import { Schema } from 'effect';
+import { merge } from './metadata.js';
+import { dotted } from './node.js';
+import { allPlaces, pathsOf, placesOn } from './places.js';
+import { decodeSegment, fit, match, write } from './url.js';
+import { dataSchemas, levelSchema, pick } from './values.js';
+/*
+ * The Routes, worked out from the pages under the root: a Schema for every
+ * level, a constructor for every place, both directions between a URL and
+ * a Route, each place's data, Render Mode and Metadata, and the type of
+ * every Loader. It holds no state and runs nothing.
+ *
+ * A Route value is one tagged object per level, the one below under `page`
+ * when the URL goes on:
+ *
+ *   router.Settings.Billing()  →  { _tag: 'Settings', page: { _tag: 'Billing' } }
+ *   router.Settings()          →  { _tag: 'Settings' }
+ *
+ * A place is named by its tags from the root, dotted: `Settings.Billing`.
+ * This file makes the Routes from their parts: `node.ts` the types,
+ * `values.ts` each level's Schemas, `places.ts` the places, `url.ts` a URL
+ * both ways, and `metadata.ts` the Metadata.
+ */
+/**
+ * The Metadata of a value: the deepest node that says anything wins, field
+ * by field. A node whose Metadata is a function is handed its data, or
+ * `undefined` until it is there.
+ */
+const metadataOf = (children, value, data, at = []) => {
+    if (!value)
+        return {};
+    const node = children[value._tag];
+    if (!node)
+        return {};
+    const here = [...at, value._tag];
+    const own = typeof node.metadata === 'function'
+        ? node.metadata({ ...pick(node.params, value), ...pick(node.query, value) }, data[dotted(here)])
+        : (node.metadata ?? {});
+    const below = metadataOf(node.children, value.page, data, here);
+    return merge(own, below);
+};
+/** Throws, naming both, if two places are written at the same path and neither holds the other. */
+const checkPaths = (children) => {
+    const seen = new Map();
+    for (const [name, path] of pathsOf(children)) {
+        const shape = path.replace(/:[^/]+/g, ':');
+        const before = seen.get(shape);
+        if (before !== undefined &&
+            !name.startsWith(`${before}.`) &&
+            !before.startsWith(`${name}.`))
+            throw new Error(`[@kestack/kabuki/routing] ${before} and ${name} are both at ${path}: a URL must name one place`);
+        if (before === undefined)
+            seen.set(shape, name);
+    }
+};
+/**
+ * Every place of an app, from the nodes under the root. `redirect` names
+ * paths that are never a place, each with the Route it is replaced by,
+ * from the params its path names:
+ * `{ '/posts/:slug': (r, { slug }) => r.Blog.Post({ slug }) }`.
+ */
+export const routesOf = (children, options = {}) => {
+    const nodes = children;
+    checkPaths(nodes);
+    const ctors = constructors(nodes);
+    const redirects = Object.entries((options.redirect ?? {})).map(([from, to]) => ({ template: from.split('/').filter(Boolean), to }));
+    const read = (url) => {
+        const { pathname, search } = new URL(url, 'http://route');
+        const parts = pathname.split('/').filter(Boolean).map(decodeSegment);
+        const notFound = { _tag: 'NotFound', path: pathname };
+        if (parts.some((part) => part === undefined))
+            return { _tag: 'At', route: notFound };
+        const rest = parts;
+        for (const { template, to } of redirects) {
+            if (template.length !== rest.length)
+                continue;
+            const params = fit(template, rest);
+            if (params)
+                return { _tag: 'Redirect', route: to(ctors, params) };
+        }
+        const found = match(nodes, rest, new URLSearchParams(search));
+        return { _tag: 'At', route: found ?? notFound };
+    };
+    const pathOf = (route) => {
+        const value = route;
+        if (value._tag === 'NotFound')
+            return String(value.path);
+        const out = { segments: [], query: new URLSearchParams() };
+        write(nodes, value, out);
+        const query = out.query.toString();
+        return `/${out.segments.join('/')}${query ? `?${query}` : ''}`;
+    };
+    const routeOf = (of) => (typeof of === 'string' ? read(of).route : of);
+    const every = allPlaces(nodes, options.staleTime);
+    const names = every.map((place) => place.name);
+    const staleTimes = new Map(every.map((place) => [place.name, place.staleTime]));
+    const api = {
+        route: levelSchema(nodes, true),
+        place: (names.length > 0
+            ? Schema.Literals(names)
+            : Schema.Never),
+        NotFound: ({ path }) => ({ _tag: 'NotFound', path }),
+        read,
+        path: pathOf,
+        paths: () => Object.fromEntries(pathsOf(nodes)),
+        metadata: (of, data = {}) => {
+            const value = routeOf(of);
+            return merge(options.metadata ?? {}, value._tag === 'NotFound'
+                ? (options.notFound ?? {})
+                : metadataOf(nodes, value, data));
+        },
+        places: (of) => {
+            const value = routeOf(of);
+            return (value._tag === 'NotFound' ? [] : placesOn(nodes, value, staleTimes));
+        },
+        every: every,
+        data: dataSchemas(nodes),
+        // Typed by `RoutesApi`.
+        loaders: ((loaders) => loaders),
+        children,
+    };
+    return Object.assign(ctors, api);
+};
+/**
+ * A constructor per node, whose value is a whole Route: each nested call
+ * wraps its value in its ancestors'. A node with children is a function
+ * too, for the URL that ends at it.
+ */
+const constructors = (children) => {
+    const build = (layer, at, wrap) => Object.fromEntries(Object.entries(layer).map(([tag, node]) => {
+        const here = [...at, tag];
+        const own = (args) => ({
+            _tag: tag,
+            ...pick(node.params, args),
+            ...pick(node.query, args),
+        });
+        const make = (args = {}) => wrap(own(args), args);
+        return [
+            tag,
+            Object.assign(make, {
+                at: here,
+                ...(node.input ? { data: node.input } : {}),
+                ...build(node.children, here, (value, args) => wrap({ ...own(args), page: value }, args)),
+            }),
+        ];
+    }));
+    return build(children, [], (value) => value);
+};

package/dist/routing/route/url.d.ts

@@ -0,0 +1,13 @@
+import type { Children, Value } from './node.ts';
+/** One segment, decoded; a malformed one names no place. */
+export declare const decodeSegment: (segment: string) => string | undefined;
+/** The raw params a template's segments name, if the segments fit it exactly. */
+export declare const fit: (template: ReadonlyArray<string>, rest: ReadonlyArray<string>) => Record<string, string> | undefined;
+/** The value a URL's segments name under one layer, if any. */
+export declare const match: (children: Children, rest: ReadonlyArray<string>, search: URLSearchParams) => Value | undefined;
+/** A value's segments and query under one layer. */
+export declare const write: (children: Children, value: Value, out: {
+    segments: Array<string>;
+    query: URLSearchParams;
+}) => void;
+//# sourceMappingURL=url.d.ts.map

package/dist/routing/route/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/routing/route/url.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAiB,KAAK,EAAE,MAAM,WAAW,CAAC;AAyBhE,4DAA4D;AAC5D,eAAO,MAAM,aAAa,YAAa,MAAM,KAAG,MAAM,GAAG,SAMxD,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,GAAG,aACJ,aAAa,CAAC,MAAM,CAAC,QACzB,aAAa,CAAC,MAAM,CAAC,KAC1B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAQ3B,CAAC;AAEF,+DAA+D;AAC/D,eAAO,MAAM,KAAK,aACN,QAAQ,QACZ,aAAa,CAAC,MAAM,CAAC,UACnB,eAAe,KACtB,KAAK,GAAG,SA2BV,CAAC;AAEF,oDAAoD;AACpD,eAAO,MAAM,KAAK,aACN,QAAQ,SACX,KAAK,OACP;IAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,SAczD,CAAC"}

package/dist/routing/route/url.js

@@ -0,0 +1,79 @@
+import { Schema } from 'effect';
+import { hasChildren, segments } from './node.js';
+/*
+ * A URL read as a value and a value written as a URL, layer by layer:
+ * path segments by each node's template and params Schema, the query by
+ * its query Schema.
+ */
+const structOf = (fields) => Schema.Struct(fields);
+const decode = (fields, raw) => {
+    const exit = Schema.decodeUnknownExit(structOf(fields))(raw);
+    return exit._tag === 'Success' ? exit.value : undefined;
+};
+const encode = (fields, value) => Schema.encodeUnknownSync(structOf(fields))(Object.fromEntries(Object.keys(fields)
+    .filter((key) => value[key] !== undefined)
+    .map((key) => [key, value[key]])));
+/** One segment, decoded; a malformed one names no place. */
+export const decodeSegment = (segment) => {
+    try {
+        return decodeURIComponent(segment);
+    }
+    catch {
+        return undefined;
+    }
+};
+/** The raw params a template's segments name, if the segments fit it exactly. */
+export const fit = (template, rest) => {
+    const raw = {};
+    const fits = template.every((part, at) => {
+        if (!part.startsWith(':'))
+            return part === rest[at];
+        raw[part.slice(1)] = rest[at];
+        return true;
+    });
+    return fits ? raw : undefined;
+};
+/** The value a URL's segments name under one layer, if any. */
+export const match = (children, rest, search) => {
+    for (const [tag, node] of Object.entries(children)) {
+        const template = segments(node.path);
+        if (template.length > rest.length)
+            continue;
+        const raw = fit(template, rest);
+        if (!raw)
+            continue;
+        const params = decode(node.params, raw);
+        const query = decode(node.query, Object.fromEntries(Object.keys(node.query).flatMap((key) => {
+            const found = search.get(key);
+            return found === null ? [] : [[key, found]];
+        })));
+        if (!params || !query)
+            continue;
+        const own = { _tag: tag, ...params, ...query };
+        const below = rest.slice(template.length);
+        const page = hasChildren(node)
+            ? match(node.children, below, search)
+            : undefined;
+        if (page)
+            return { ...own, page };
+        // A page with pages is a place on its own too, when the URL ends at it.
+        if (below.length === 0)
+            return own;
+    }
+    return undefined;
+};
+/** A value's segments and query under one layer. */
+export const write = (children, value, out) => {
+    const node = children[value._tag];
+    if (!node)
+        return;
+    const params = encode(node.params, value);
+    for (const part of segments(node.path))
+        out.segments.push(part.startsWith(':')
+            ? encodeURIComponent(String(params[part.slice(1)]))
+            : part);
+    for (const [key, found] of Object.entries(encode(node.query, value)))
+        out.query.set(key, String(found));
+    if (value.page)
+        write(node.children, value.page, out);
+};

package/dist/routing/route/values.d.ts

@@ -0,0 +1,12 @@
+import type { AnyNode, Children, Codec, Fields, Value } from './node.ts';
+/** The Schema of one level: a case per child, and at the root the not-found Route. */
+export declare const levelSchema: (children: Children, root: boolean) => Codec<unknown>;
+/** Every place with data, by dotted name, with its data's Schema. */
+export declare const dataSchemas: (children: Children, at?: ReadonlyArray<string>) => ReadonlyArray<readonly [string, Codec<unknown>]>;
+/** The fields of a value that `fields` names. */
+export declare const pick: (fields: Fields, value: Value | undefined) => Record<string, unknown>;
+/** The params of a node's value, as one string: two values with the same params are the same place. */
+export declare const paramsKey: (node: AnyNode, value: Value) => string;
+/** The value one level down a path of tags, if the Route goes that way. */
+export declare const valueAt: (route: Value | null | undefined, at: ReadonlyArray<string>) => Value | undefined;
+//# sourceMappingURL=values.d.ts.map

package/dist/routing/route/values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../../../src/routing/route/values.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAiBzE,sFAAsF;AACtF,eAAO,MAAM,WAAW,aACZ,QAAQ,QACZ,OAAO,KACZ,KAAK,CAAC,OAAO,CAUf,CAAC;AAEF,qEAAqE;AACrE,eAAO,MAAM,WAAW,aACZ,QAAQ,OACd,aAAa,CAAC,MAAM,CAAC,KACxB,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAM9C,CAAC;AAEL,iDAAiD;AACjD,eAAO,MAAM,IAAI,WACP,MAAM,SACP,KAAK,GAAG,SAAS,KACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAKtB,CAAC;AAEJ,uGAAuG;AACvG,eAAO,MAAM,SAAS,SAAU,OAAO,SAAS,KAAK,KAAG,MACW,CAAC;AAEpE,2EAA2E;AAC3E,eAAO,MAAM,OAAO,UACX,KAAK,GAAG,IAAI,GAAG,SAAS,MAC3B,aAAa,CAAC,MAAM,CAAC,KACxB,KAAK,GAAG,SAKV,CAAC"}

package/dist/routing/route/values.js

@@ -0,0 +1,47 @@
+import { Schema } from 'effect';
+import { dotted } from './node.js';
+/*
+ * A Route's values: the Schema of each level, the key of a node's params,
+ * the own params and query of a value, and every place's data Schema.
+ */
+/** The Schema of the fields a node's value holds besides its tag. */
+const fieldsOf = (node) => ({
+    ...node.params,
+    ...node.query,
+    ...(Object.keys(node.children).length > 0
+        ? { page: Schema.optionalKey(levelSchema(node.children, false)) }
+        : {}),
+});
+const cache = new WeakMap();
+/** The Schema of one level: a case per child, and at the root the not-found Route. */
+export const levelSchema = (children, root) => {
+    if (!root && cache.has(children))
+        return cache.get(children);
+    const schema = Schema.TaggedUnion({
+        ...Object.fromEntries(Object.entries(children).map(([tag, node]) => [tag, fieldsOf(node)])),
+        ...(root ? { NotFound: { path: Schema.String } } : {}),
+    });
+    if (!root)
+        cache.set(children, schema);
+    return schema;
+};
+/** Every place with data, by dotted name, with its data's Schema. */
+export const dataSchemas = (children, at = []) => Object.entries(children).flatMap(([tag, node]) => [
+    ...(node.input
+        ? [[dotted([...at, tag]), node.input]]
+        : []),
+    ...dataSchemas(node.children, [...at, tag]),
+]);
+/** The fields of a value that `fields` names. */
+export const pick = (fields, value) => Object.fromEntries(Object.keys(fields)
+    .filter((key) => value?.[key] !== undefined)
+    .map((key) => [key, value[key]]));
+/** The params of a node's value, as one string: two values with the same params are the same place. */
+export const paramsKey = (node, value) => JSON.stringify(Object.keys(node.params).map((key) => value[key]));
+/** The value one level down a path of tags, if the Route goes that way. */
+export const valueAt = (route, at) => {
+    let value = route ?? undefined;
+    for (const tag of at)
+        value = value?._tag === tag ? value.page : undefined;
+    return value;
+};

package/dist/routing/router/context.d.ts

@@ -0,0 +1,123 @@
+import type { AnchorHTMLAttributes, ButtonHTMLAttributes, ReactNode } from 'react';
+import type { AnyRoute, MoveOptions } from '../capability/index.ts';
+import type { Preload } from './define.ts';
+import type { How, Metadata } from '../route/index.ts';
+/** One entry of the router's history: its key and its Route. */
+export interface Entry<Route extends AnyRoute = AnyRoute> {
+    readonly key: string;
+    readonly route: Route;
+    /** The element on the page it goes to, after its `#`. */
+    readonly hash?: string;
+}
+/** A move the Router holds while it loads the data of its places: where to, and how. */
+export interface Pending<Route extends AnyRoute = AnyRoute> {
+    readonly to: Route;
+    readonly how: 'push' | 'replace' | 'load' | 'back' | 'forward';
+}
+/** What the router's View hands everything drawn below it: drawing data, read from the Snapshot shown, and its Sends. */
+export interface Drawing {
+    readonly href: (route: AnyRoute) => string;
+    readonly entries: ReadonlyArray<Entry>;
+    readonly at: number;
+    readonly move: {
+        readonly from: AnyRoute | null;
+        readonly to: AnyRoute;
+        readonly how: How;
+        /** `false`: the push or replace said to leave every scroll as it is. */
+        readonly resetScroll?: boolean;
+        /** How the push or replace said its hash's element is scrolled into view. */
+        readonly hashScrollIntoView?: MoveOptions['hashScrollIntoView'];
+    };
+    readonly pending: Pending | null;
+    /** The Metadata the Routes give the current entry, from its params alone. */
+    readonly metadata: Metadata;
+    readonly go: (by: number) => void;
+    readonly reload: () => void;
+    readonly preload: (route: AnyRoute) => void;
+    /** When a link preloads, unless it says. */
+    readonly linkPreload: {
+        readonly mode: Preload;
+        readonly delay: number;
+    };
+}
+export declare const RouterContext: import("react").Context<Drawing | undefined>;
+/** What a link clicked says besides where it goes: its hash, and what its `Router.Link` said of scroll. */
+export declare const linkOptions: (link: Element, url: URL) => MoveOptions;
+export declare const useDrawing: (what: string) => Drawing;
+/**
+ * Writes the Metadata to the document after every move, and when a page's
+ * data comes: the title, and every tag marked `data-kabuki`, which replace
+ * the ones marked before. Tags nobody marked are left alone, and an app
+ * routing in memory never touches the document.
+ */
+export declare function MetadataWriter({ metadata }: {
+    readonly metadata: Metadata;
+}): null;
+export type LinkProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & {
+    /** Where it goes: a Route, never a string. */
+    readonly to: AnyRoute;
+    /**
+     * When it preloads its Route's data and code: on hover or focus, after
+     * `preloadDelay`; once it scrolls into view; or never. The Routes' default
+     * unless said, `'intent'` unless they say.
+     */
+    readonly preload?: Preload;
+    /** How long, in milliseconds, an `'intent'` link waits before it preloads. */
+    readonly preloadDelay?: number;
+    /** `false`: its move leaves every scroll as it is, as opening a post below its list. */
+    readonly resetScroll?: boolean;
+    /** The element on the page it goes to, by id: `href` ends `#hash`. */
+    readonly hash?: string;
+    /** How that element is scrolled into view; `false` leaves it. */
+    readonly hashScrollIntoView?: MoveOptions['hashScrollIntoView'];
+    readonly children?: ReactNode;
+};
+/**
+ * A link to a Route. It draws a plain `<a href>`, so a new tab, a copied
+ * link and a crawler all see the real URL; the router catches a plain click.
+ * It asks the Router to preload where it goes, as `preload` says: each ask
+ * is one Message, so the Timeline shows it.
+ */
+export declare function Link({ to, preload, preloadDelay, resetScroll, hash, hashScrollIntoView, onMouseEnter, onMouseLeave, onFocus, onBlur, onTouchStart, ...rest }: LinkProps): import("react").JSX.Element;
+/** What a component drawn inside the app can read of the router, and its own Back, Forward and reload. */
+export interface RouterState<Route extends AnyRoute = AnyRoute> {
+    readonly route: Route;
+    readonly href: string;
+    readonly entries: ReadonlyArray<Entry<Route>>;
+    readonly at: number;
+    readonly move: {
+        readonly from: Route | null;
+        readonly to: Route;
+        readonly how: How;
+        readonly resetScroll?: boolean;
+        readonly hashScrollIntoView?: MoveOptions['hashScrollIntoView'];
+    };
+    /** The move the Router holds while it loads, if any. */
+    readonly pending: Pending<Route> | null;
+    readonly metadata: Metadata;
+    readonly title: string | undefined;
+    readonly canGoBack: boolean;
+    readonly canGoForward: boolean;
+    readonly back: () => void;
+    readonly forward: () => void;
+    /** Move to entry `at` of the history. */
+    readonly goTo: (at: number) => void;
+    /** Load every page on screen again, its data shown meanwhile: a failed page retries. */
+    readonly reload: () => void;
+    /** Warm the Data cache for a Route. */
+    readonly preload: (route: Route) => void;
+}
+/**
+ * The router, for a component drawn inside a `Router.app`: an address bar, a
+ * history list, a retry button. Name the app's Route,
+ * `useRouter<Route>()` with `type Route = typeof router.route.Type`, to read
+ * its Routes as that type: every Route the Router holds is one of them.
+ */
+export declare const useRouter: <Route extends AnyRoute = AnyRoute>() => RouterState<Route>;
+/**
+ * A button that loads every page on screen again: for a failed page's
+ * screen, so the page whose Loader broke retries. Any other button props
+ * pass through.
+ */
+export declare function Retry({ onClick, type, ...rest }: ButtonHTMLAttributes<HTMLButtonElement>): import("react").JSX.Element;
+//# sourceMappingURL=context.d.ts.map

package/dist/routing/router/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/routing/router/context.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EAGpB,SAAS,EAEV,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAEvD,gEAAgE;AAChE,MAAM,WAAW,KAAK,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ;IACtD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,yDAAyD;IACzD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,wFAAwF;AACxF,MAAM,WAAW,OAAO,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ;IACxD,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAChE;AAED,yHAAyH;AACzH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC/B,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;QAClB,wEAAwE;QACxE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAC/B,6EAA6E;QAC7E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;KACjE,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC5C,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1E;AAED,eAAO,MAAM,aAAa,8CAAgD,CAAC;AAO3E,2GAA2G;AAC3G,eAAO,MAAM,WAAW,SAAU,OAAO,OAAO,GAAG,KAAG,WAcrD,CAAC;AAEF,eAAO,MAAM,UAAU,SAAU,MAAM,KAAG,OAOzC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,QAgB3E;AAED,MAAM,MAAM,SAAS,GAAG,IAAI,CAC1B,oBAAoB,CAAC,iBAAiB,CAAC,EACvC,MAAM,CACP,GAAG;IACF,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,wFAAwF;IACxF,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,EACnB,EAAE,EACF,OAAO,EACP,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,MAAM,EACN,YAAY,EACZ,GAAG,IAAI,EACR,EAAE,SAAS,+BAoEX;AAED,0GAA0G;AAC1G,MAAM,WAAW,WAAW,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ;IAC5D,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;QAC5B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;QACnB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;QAClB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAC/B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;KACjE,CAAC;IACF,wDAAwD;IACxD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,wFAAwF;IACxF,QAAQ,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC;IAC5B,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC1C;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GACpB,KAAK,SAAS,QAAQ,GAAG,QAAQ,OAC9B,WAAW,CAAC,KAAK,CAsBrB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,EACpB,OAAO,EACP,IAAe,EACf,GAAG,IAAI,EACR,EAAE,oBAAoB,CAAC,iBAAiB,CAAC,+BAYzC"}