@rsc-kit/core 0.1.0

package/dist/js/navigate.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Core SPA navigation engine for RSC.
+ *
+ * Uses module-level state (singleton in the browser bundle).
+ * The Flight deserializer is injected by createViteRscApp to avoid
+ * duplicate bundling of react-server-dom-webpack.
+ */
+import type { Href } from '../routes.js';
+import type { ManifestRoute } from "../manifest";
+type ReactNode = unknown;
+type Deserializer = (stream: ReadableStream, options: Record<string, unknown>) => Promise<ReactNode>;
+type CallServerFn = (id: string, args: unknown[]) => Promise<unknown>;
+interface InterceptEntry {
+    urlPattern: string;
+    slot: string;
+}
+export declare function setStaticRoutes(routes: ManifestRoute[]): void;
+/**
+ * The layout chain of the page loaded from a file, since no header said.
+ *
+ * Without this the client believes it holds nothing, every navigation asks
+ * for a whole document, and the depth variants sitting beside it are never
+ * requested — the export looks correct and retention silently never happens.
+ */
+export declare function seedStaticChain(url: string): boolean;
+export declare function setStaticPayloads(suffix: string | null): void;
+/** The url to request a payload from, which is the page's own unless exported. */
+export declare function payloadUrl(url: string, held?: string[]): string;
+export declare function setVersion(v: string): void;
+/**
+ * The layout chain the client is holding.
+ *
+ * Seeded from the initial page's response and updated on every navigation, so
+ * the next request can say what is already mounted.
+ */
+export declare function setHeldLayouts(chain: string[]): void;
+export declare function getHeldLayouts(): string[];
+export declare function setNavigateHandler(fn: (tree: ReactNode, key: string, segmentDepth: number) => void): void;
+/**
+ * How the router reveals a page that is still mounted behind the current one.
+ *
+ * Returning true means the page was restored with its client state intact and
+ * no request was made.
+ */
+export declare function setRestoreHandler(fn: (key: string) => boolean): void;
+export declare function setDeserializer(fn: Deserializer): void;
+export declare function setCallServer(fn: CallServerFn): void;
+export declare function setInterceptManifest(entries: InterceptEntry[]): void;
+export declare function renderTree(tree: ReactNode): void;
+/**
+ * Identity of a page for retention purposes.
+ *
+ * Path and query only: a hash is a position within the same page, and an
+ * intercepted route is a different rendering of the same URL, so it retains
+ * separately from the full page.
+ */
+export declare function retentionKey(url: string, interceptSlot: string | null): string;
+export declare function getCallServer(): CallServerFn;
+/**
+ * Whether a navigation to this url would be served from the prefetch cache.
+ *
+ * Lets a caller decide whether showing an already-fetched page is free. A form
+ * uses it to put its target route's shell on screen while the real query runs:
+ * worth doing when the shell is in hand, never worth an extra request.
+ */
+export declare function isPrefetched(url: string): boolean;
+/**
+ * Go to a url, the way a Link does.
+ *
+ * `url` is typed to the routes the build found; cast with `as Href` when the
+ * destination is computed rather than written.
+ */
+export declare function navigate(url: Href, opts?: {
+    replace?: boolean;
+    preserveScroll?: boolean;
+    restore?: boolean;
+    /** Internal: how many redirects led here. */
+    redirectsFollowed?: number;
+}): Promise<void>;
+/**
+ * Put something the server re-rendered on screen.
+ *
+ * The trees arrive with an action's answer rather than being fetched, so this
+ * is the same apply path a navigation uses — without a request, a url change
+ * or a history entry.
+ */
+export declare function applyRevalidated(target: string, tree: ReactNode): void;
+/**
+ * Ask the server for part of this page again.
+ *
+ *   refresh()          the page, leaving the layouts mounted
+ *   refresh('all')     the whole document, layouts included
+ *   refresh('orders')  one parallel slot, by the name its directory gave it
+ *
+ * The same words an action uses, so a thing can be invalidated from either
+ * side. This is the path for a refresh nobody mutated anything to earn — a
+ * button, a poll, a message saying that table has moved; what an action
+ * invalidated travels back inside the action's own answer instead.
+ *
+ * A slot is the only region smaller than a page the server can name, so two
+ * tables refresh apart from each other only if they are two slots. The page
+ * form leaves the layouts alone, which is what makes it cheap and also why a
+ * count living in a layout will not move until you ask for 'all'.
+ */
+export declare function refresh(target?: string): Promise<void>;
+export declare function prefetch(url: string, cacheForMs?: number): void;
+/**
+ * Drop a prefetch that is still in flight — the pointer left the link.
+ *
+ * The cache entry goes synchronously rather than in the abort's catch: the
+ * rejection lands a tick later, and a click in between would find an entry
+ * whose tree resolves to null and navigate to a blank page. A prefetch that
+ * has already completed is kept; there is no request left to cancel and the
+ * payload is still good.
+ */
+export declare function cancelPrefetch(url: string): void;
+export {};
+//# sourceMappingURL=navigate.d.ts.map

package/dist/js/navigate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigate.d.ts","sourceRoot":"","sources":["../../src/js/navigate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAMxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,KAAK,SAAS,GAAG,OAAO,CAAC;AACzB,KAAK,YAAY,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;AACrG,KAAK,YAAY,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AA8BtE,UAAU,cAAc;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AA+DD,wBAAgB,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAE7D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAQpD;AA8BD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAE7D;AAED,kFAAkF;AAClF,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,EAAgB,GAAG,MAAM,CAgB5E;AAYD,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAEpD;AAED,wBAAgB,cAAc,IAAI,MAAM,EAAE,CAEzC;AAED,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAEzG;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAAG,IAAI,CAEpE;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAEtD;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAEpD;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAEpE;AAkCD,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAW9E;AAED,wBAAgB,aAAa,IAAI,YAAY,CAK5C;AA8GD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAOjD;AA2BD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,IAAI,EACT,IAAI,CAAC,EAAE;IACL,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6CAA6C;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,GACA,OAAO,CAAC,IAAI,CAAC,CA8Of;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAkBtE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,OAAO,CAAC,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CA2C5D;AA8ED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAc/D;AA8ED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAYhD"}