@kestack/kabuki 0.0.1 → 0.0.2

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

@@ -0,0 +1,7 @@
+export { app } from './router.tsx';
+export type { PendingMove, RouterInput, RouterMessage, RouterModel, RoutesLike, } from './router.tsx';
+export { define } from './define.ts';
+export type { AnyRouterDefinition, Preload, RouterDefinition, RouterOptions, } from './define.ts';
+export { Link, Retry, useRouter } from './context.tsx';
+export type { Entry, LinkProps, Pending, RouterState } from './context.tsx';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/routing/router/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,YAAY,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACb,WAAW,EACX,UAAU,GACX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EACV,mBAAmB,EACnB,OAAO,EACP,gBAAgB,EAChB,aAAa,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACvD,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/routing/router/index.js

@@ -0,0 +1,3 @@
+export { app } from './router.js';
+export { define } from './define.js';
+export { Link, Retry, useRouter } from './context.js';

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

@@ -0,0 +1,165 @@
+import type { ActorType, AnyActor, Types } from '../../core/index.ts';
+import type { ViewOf } from '../../react/index.ts';
+import { Navigation } from '../capability/index.ts';
+import type { AnyRoute, MoveOptions } from '../capability/index.ts';
+import type { AnyPageDefinition, Known } from '../page/index.ts';
+import type { Codec, How, Metadata, Place, PlaceData, PlaceSchema, Read } from '../route/index.ts';
+import type { Holding, PlaceMessage } from './data.ts';
+import type { Rooted } from './define.ts';
+/** What the router needs of its definition. */
+export interface RoutesLike<Route> extends Rooted<AnyPageDefinition> {
+    readonly route: Codec<Route>;
+    /** Every place with data, by dotted name, with its data's Schema. */
+    readonly data: ReadonlyArray<readonly [string, Codec<unknown>]>;
+    readonly read: (url: string) => Read<Route>;
+    readonly path: (route: Route) => string;
+    readonly metadata: (of: Route | string, data?: PlaceData) => Metadata;
+    readonly places: (of: Route | string) => ReadonlyArray<Place>;
+    /** Every place of the tree, as Schemas: what a Loader RPC is made from. */
+    readonly every: ReadonlyArray<PlaceSchema>;
+}
+/** How a pending move lands: `arrive` is a push the address already shows; `back` and `forward` go to an entry. */
+declare const LANDS: readonly ['push', 'replace', 'load', 'arrive', 'back', 'forward'];
+type Lands = (typeof LANDS)[number];
+/** A move the Router holds while it loads the data of the places it brings. */
+export interface PendingMove<Route> {
+    /** Which load this is: an answer for any other is dropped. */
+    readonly id: number;
+    readonly to: Route;
+    readonly how: Lands;
+    /** The places being loaded, by dotted name. */
+    readonly wanted: ReadonlyArray<string>;
+    /** How many Redirects led here. */
+    readonly hops: number;
+    /** When the move began: it lands without its data `delay` after. */
+    readonly since: number;
+    /** The key the address already holds for where it goes, from before the page loaded, else `null`: a new entry gets a new one. */
+    readonly key: string | null;
+    /** What the push or replace said besides where it goes. */
+    readonly said?: MoveOptions;
+}
+/** One entry of the history: its key, its Route, and the element on the page it goes to, if any. */
+interface Entry<Route> {
+    readonly key: string;
+    readonly route: Route;
+    readonly hash?: string;
+}
+/** The router's Model: the history as entries and where it is in them, the last move, and the one it holds. */
+export interface RouterModel<Route> {
+    readonly entries: ReadonlyArray<Entry<Route>>;
+    readonly at: number;
+    /** What every key this page load gives starts with, so no key is given twice across reloads: `m` in memory. */
+    readonly session: string;
+    /** The number the next entry's key ends with. */
+    readonly next: number;
+    readonly move: {
+        readonly from: Route | null;
+        readonly to: Route;
+        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: PendingMove<Route> | null;
+    /**
+     * The Route still drawn while a held Back or Forward loads: the history,
+     * like the address, is already at the entry it goes to.
+     */
+    readonly holding: Route | null;
+    /** The id the next pending move gets. */
+    readonly loads: number;
+    /** The data of each place with data on the Route drawn, by dotted name: each page is handed its own. */
+    readonly data: Holding;
+    /** How many times the app was reloaded: every place on screen loads its data again when it goes up. */
+    readonly reload: number;
+    /** Whether an Adapter holds the address. */
+    readonly attached: boolean;
+    /** Whether the Adapter has said which URL the app opened at. */
+    readonly loaded: boolean;
+}
+export type RouterMessage<Route> = ({
+    readonly _tag: 'Pushed';
+    readonly route: Route;
+} & MoveOptions) | ({
+    readonly _tag: 'Replaced';
+    readonly route: Route;
+} & MoveOptions) | {
+    readonly _tag: 'Went';
+    readonly by: number;
+} | {
+    readonly _tag: 'WentBackTo';
+    readonly route: Route;
+} | {
+    readonly _tag: 'Arrived';
+    readonly route: Route;
+    readonly key: string | null;
+    readonly url: string;
+    /** The element on the page the address names, after its `#`. */
+    readonly hash: string;
+} | {
+    readonly _tag: 'Attached';
+    readonly session: string;
+} | {
+    readonly _tag: 'Left';
+    readonly url: string;
+} | {
+    readonly _tag: 'Waited';
+    readonly id: number;
+} | {
+    readonly _tag: 'Loaded';
+    readonly id: number;
+    readonly known: Readonly<Record<string, Known>>;
+} | {
+    readonly _tag: 'Redirected';
+    readonly id: number;
+    readonly route: Route;
+} | {
+    readonly _tag: 'Reloaded';
+} | {
+    readonly _tag: 'Preloading';
+    readonly route: Route;
+} | PlaceMessage;
+/** The router's Input: the Route it starts at and what its places already start from. */
+export interface RouterInput<Route> {
+    readonly route: Route;
+    readonly known?: Readonly<Record<string, Known>>;
+}
+type Single = {
+    readonly _tag: 'Single';
+};
+/**
+ * The router of an app: one Actor, above the build of the app's root page,
+ * drawn with the root page's View. It holds the history, as entries and
+ * where it is in them, and hands the root page the current Route. Every
+ * move is one Message to it: a link click, a Request on Navigation, the
+ * Adapter's Back and Forward. A move to places whose data is not there yet
+ * waits up to its delay while a Worker loads it through `Loading`, so a
+ * quick answer, or a copy the Data cache kept, shows no loading screen;
+ * after that the move lands and each new place loads its own. It holds the
+ * data of every place on screen, `data.ts`, and hands each page its own as
+ * `status`, down through the pages above it. It draws the app, catches
+ * plain clicks on links inside it, preloads for links, and writes the
+ * Metadata. With no Adapter in the Layer it routes in memory; with one, it
+ * writes each move to the address with a Command, and hears the address
+ * with a Worker.
+ */
+export declare const app: <Route extends AnyRoute, A extends AnyActor>(routes: RoutesLike<Route>, view: ViewOf<A>) => {
+    actor: ActorType<"Router", RouterInput<Route> | undefined, void, RouterModel<Route>, Single, RouterMessage<Route>, {
+        readonly Single: {
+            readonly page: A;
+        };
+    }, Exclude<Types<A>["open"], Navigation>>;
+    view: ViewOf<ActorType<"Router", RouterInput<Route> | undefined, void, RouterModel<Route>, Single, RouterMessage<Route>, {
+        readonly Single: {
+            readonly page: A;
+        };
+    }, Exclude<Types<A>["open"], Navigation>>>;
+    startAt: (url?: string, known?: Readonly<Record<string, Known>>) => RouterInput<Route> | undefined;
+    href: (route: Route) => string;
+    restoreScroll: (route: Route) => string | null;
+    /** The Routes it serves: what Start reads a URL and serves the Loaders with. */
+    routes: RoutesLike<Route>;
+};
+export {};
+//# sourceMappingURL=router.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../../src/routing/router/router.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,EAAW,UAAU,EAAe,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAEpE,OAAO,KAAK,EAAgB,iBAAiB,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,KAAK,EACV,KAAK,EACL,GAAG,EACH,QAAQ,EACR,KAAK,EACL,SAAS,EACT,WAAW,EACX,IAAI,EAEL,MAAM,mBAAmB,CAAC;AAa3B,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,+CAA+C;AAC/C,MAAM,WAAW,UAAU,CAAC,KAAK,CAAE,SAAQ,MAAM,CAAC,iBAAiB,CAAC;IAClE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,KAAK,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,KAAK,QAAQ,CAAC;IACtE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,KAAK,GAAG,MAAM,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9D,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAC5C;AAGD,mHAAmH;AACnH,QAAA,MAAM,KAAK,YAAI,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAU,CAAC;AAChF,KAAK,KAAK,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;AAIpC,+EAA+E;AAC/E,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IACpB,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iIAAiI;IACjI,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;CAC7B;AAWD,oGAAoG;AACpG,UAAU,KAAK,CAAC,KAAK;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAyBD,+GAA+G;AAC/G,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,+GAA+G;IAC/G,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,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,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,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC5C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wGAAwG;IACxG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,uGAAuG;IACvG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,MAAM,aAAa,CAAC,KAAK,IAC3B,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,WAAW,CAAC,GAClE,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,WAAW,CAAC,GACpE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GACtD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAChD;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;CACjD,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAC3E;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GAC7B;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GACtD,YAAY,CAAC;AAEjB,yFAAyF;AACzF,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;CAClD;AAED,KAAK,MAAM,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AA4D1C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,GAAI,KAAK,SAAS,QAAQ,EAAE,CAAC,SAAS,QAAQ,UACpD,UAAU,CAAC,KAAK,CAAC,QACnB,MAAM,CAAC,CAAC,CAAC;;yBAw3BM;YAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;SAAE;;UAuBR,MAAM;;;;8CAAa;oBA7C5C,MAAM,UACJ,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,KACtC,WAAW,CAAC,KAAK,CAAC,GAAG,SAAS;kBAv1BZ,KAAK;2BAs3BI,KAAK,KAAG,MAAM,GAAG,IAAI;IAgBjD,gFAAgF;;CAGnF,CAAC"}