@cleya/contributor-react-navigation 0.0.0-stage → 1.0.0-next.0

package/dist/payload.d.ts

@@ -0,0 +1,21 @@
+import type { Domain } from "@cleya/domain";
+import type { regionNavigation } from "@cleya/region-navigation";
+import type { NavigationModel } from "./collect";
+/** The rows the engine loads into the navigation region's tables. */
+export type NavigationPayload = Domain.Region.Payload<typeof regionNavigation>;
+/**
+ * Turn a {@link NavigationModel} into the navigation region's payload. The
+ * engine stages and loads it, nodes before edges, so no ordering is needed
+ * here, and a `RENDERS` edge whose `Symbol` the code indexer never declared is
+ * dropped with a diagnostic rather than pointing at a placeholder.
+ *
+ * `SERVES` is derived rather than carried in the model: a screen already knows
+ * its route, so a separate list could only disagree with it.
+ *
+ * @example
+ * toPayload(model);
+ * // { nodes: [{ _label: "Route", id: "app|Home", … }, { _label: "Screen", id: "app|root|Home", … }],
+ * //   edges: [{ _label: "SERVES", fromId: "app|Home", toId: "app|root|Home", … }, …] }
+ * toPayload(emptyModel); // { nodes: [], edges: [] }
+ */
+export declare const toPayload: (model: NavigationModel) => NavigationPayload;

package/dist/react-navigation.contributor.d.ts

@@ -0,0 +1,49 @@
+/**
+ * React Navigation indexer.
+ *
+ * DOMAIN MODEL (the navigation region's tables, `@cleya/region-navigation`)
+ *
+ *   Route    — an addressable destination name. Pure identity: a route is
+ *              *named* at each registration site, never declared.
+ *   Screen   — one registration: this route, in this navigator, rendered by this
+ *              component, under these options/guards, at this source position.
+ *   Component — the code symbol rendering it. Declared by the TS indexer.
+ *
+ *   (Route)-[:SERVES]->(Screen)-[:RENDERS]->(Symbol)
+ *   (Screen)-[:NAVIGATES_TO]->(Route)
+ *
+ * Route and Screen are separate because a route can be registered more than once
+ * (two navigators, or a deeplink alias): collapsing Screen into an edge would
+ * lose the options, the guard and the position, and make the registrations
+ * indistinguishable.
+ *
+ * `NAVIGATES_TO` starts at Screen, not Route: you navigate *from the screen you
+ * are on*. Traversal is (Route)-[:SERVES]->(Screen)-[:NAVIGATES_TO]->(Route).
+ *
+ * ASSUMPTION: route names are globally unique. React Navigation scopes them per
+ * navigator; when two registrations share a name they become two Screens under
+ * one Route and the contributor emits a diagnostic.
+ *
+ * This module orchestrates and reports; it decides nothing. `collect` works out
+ * the navigation graph as a value, `toPayload` shapes it for the engine to load.
+ */
+import type { Contributor } from "@cleya/config";
+import { regionNavigation } from "@cleya/region-navigation";
+import type { ReactNavigationDialect } from "./react-navigation.types";
+/**
+ * Build the React Navigation contributor.
+ *
+ * The dialect is resolved and validated here, so a regex with no capture group
+ * throws when `cleya.config.ts` loads rather than midway through an indexing run.
+ *
+ * The contributor must run **after** a code indexer in the same workspace:
+ * routes link to the symbols it declares, and with no `Symbol` tagged with its
+ * workspace it returns an `error` diagnostic and no payload rather than an
+ * empty graph.
+ *
+ * @example
+ * reactNavigationContributor();                                   // core dialect only
+ * reactNavigationContributor().region.id;                         // "navigation"
+ * reactNavigationContributor({ routeAliasFiles: ["linking.ts"] }); // project navigating by URL
+ */
+export declare const reactNavigationContributor: (dialect?: ReactNavigationDialect) => Contributor<typeof regionNavigation>;

package/dist/react-navigation.index.d.ts

@@ -0,0 +1,2 @@
+export { reactNavigationContributor } from "./react-navigation.contributor";
+export type { ReactNavigationDialect } from "./react-navigation.types";