@subako-ai/react-router 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Kikuvi, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,98 @@
+# @subako-ai/react-router
+
+[React Router](https://reactrouter.com) as a `navigateTool` spec for
+`@subako-ai/tools`: the app names the routes, `useNavigate()` is the move, and
+`useLocation()` is the read back.
+
+Requires **React Router 6.4 or newer** and **Node 22 or newer** for the build.
+The package is **ESM only**.
+
+```sh
+pnpm add @subako-ai/react-router @subako-ai/tools
+```
+
+## `fromReactRouter`
+
+```tsx
+import { useTool } from "@subako-ai/react";
+import { fromReactRouter } from "@subako-ai/react-router";
+import { navigateTool } from "@subako-ai/tools";
+import { useRef } from "react";
+import { useLocation, useNavigate } from "react-router";
+
+function App() {
+	const navigate = useNavigate();
+	const { pathname } = useLocation();
+
+	// Where the app is now, read when the model asks rather than when the tool was built.
+	const here = useRef(pathname);
+	here.current = pathname;
+
+	useTool(
+		client,
+		"navigate",
+		navigateTool(
+			fromReactRouter({
+				navigate,
+				location: () => here.current,
+				routes: [
+					{ to: "/documents", description: "Every document" },
+					{ to: "/documents/:id", description: "One document" },
+				],
+			}),
+		),
+	);
+
+	return null;
+}
+```
+
+**The app names its own routes.** Neither the `<Routes>` style nor the
+file-based one keeps a registry to read at runtime, so there is nothing to
+enumerate — and naming them is worth doing anyway, because it is the allowlist:
+the model can only reach a page you listed, with the description you gave it.
+
+A route's path parameters come from its path, so `/documents/:id` needs no
+`params` of its own. Declare them only to say one is a number.
+
+The binding builds the path it navigates to: React Router's `navigate()` takes
+`/documents/7`, not `/documents/:id` and `{ id: "7" }`. Values are escaped on the
+way in. A splat is not a destination a model can name, and neither is an
+optional segment (`:id?`) — the binding does not elide it, so both are refused
+when the binding is built; list the concrete variants as separate routes
+instead.
+
+`location` is optional. Without it the answer is the path the binding just
+built, which is still a place — unlike the pattern `navigateTool` would
+otherwise report.
+
+**Read it live.** `location` is called when the model asks, which can be many
+renders after the tool was built, and `useLocation()` answers with a new object
+every render. Close over one — `location: () => location.pathname` — and the
+binding reports the page the app was on when the tool was declared: the model
+navigates, is told it is still where it started, and navigates again. The ref
+above always holds the current render's path, so the read is live whether or not
+the tool is memoised. `window.location.pathname` works too, minus the router's
+`basename` if it has one.
+
+## `routesOf`
+
+For a data router, where the route objects do exist:
+
+```ts
+import { createBrowserRouter } from "react-router";
+import { fromReactRouter, routesOf } from "@subako-ai/react-router";
+
+const router = createBrowserRouter(routeObjects);
+fromReactRouter({
+	navigate: (to) => router.navigate(to),
+	routes: routesOf(routeObjects),
+});
+```
+
+It flattens the tree, joining a child's path onto its parent's unless the child
+opens with a slash. A pathless layout route is not a destination, and neither
+is a splat or an optional segment: all three are dropped, and what sits under
+them is kept. An `index: true` route has no path of its own either, and needs
+none — the parent's path already reaches it. Descriptions are yours to add
+afterwards — the route objects carry none.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import type { NavigateSource, RouteSpec } from "@subako-ai/tools";
+/** The shape of a data router's route objects, as much of it as this needs. */
+export interface RouteObjectLike {
+    readonly path?: string;
+    readonly index?: boolean;
+    readonly children?: readonly RouteObjectLike[];
+}
+/** What an app hands the binding: how to go, where it may go, and where it is. */
+export interface ReactRouterSource {
+    /** What `useNavigate()` answers with. */
+    navigate(to: string): void | Promise<unknown>;
+    /** The routes the model may name, as the app spells them: `/documents/:id`. */
+    readonly routes: readonly RouteSpec[];
+    /**
+     * Where the app is now. It is called when the model asks, not when the tool is
+     * built, so it has to read the live value: `useLocation()` answers with a new
+     * object every render, and closing over one leaves the binding reporting the
+     * page the app was on when the tool was declared.
+     */
+    location?(): string;
+}
+/**
+ * React Router as a `navigateTool` spec. Neither the `<Routes>` style nor the file-based one
+ * keeps a route registry to read at runtime, so the routes are the ones the app names here.
+ */
+export declare function fromReactRouter(source: ReactRouterSource): NavigateSource;
+/**
+ * A `createBrowserRouter` route tree, flattened into the specs `navigateTool` takes. A pathless
+ * layout is not a destination, and neither is a splat or an optional segment, so all three are
+ * dropped and what is under them is kept. An `index: true` route has no `path` of its own
+ * either, and needs none: the parent's path already reaches it.
+ */
+export declare function routesOf(routes: readonly RouteObjectLike[]): RouteSpec[];
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAkB,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAyBlF,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;CAC/C;AAED,kFAAkF;AAClF,MAAM,WAAW,iBAAiB;IACjC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,cAAc,CA4BzE;AAMD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,GAAG,SAAS,EAAE,CAgBxE"}

package/dist/index.js

@@ -0,0 +1,77 @@
+/** React Router spells a path parameter `:name`, and every one of them is a string. */
+const PARAM = /:([A-Za-z0-9_]+)/g;
+/** What a path says it takes; a route that declared its own parameters keeps them. */
+function paramsOf(path) {
+    const params = {};
+    for (const match of path.matchAll(PARAM)) {
+        const name = match[1];
+        if (name !== undefined) {
+            params[name] = "string";
+        }
+    }
+    return Object.keys(params).length === 0 ? undefined : params;
+}
+/** `/documents/:id` and `{ id: "7" }` make `/documents/7`; React Router navigates to a built path. */
+function pathOf(to, params) {
+    return to.replace(PARAM, (whole, name) => {
+        const value = params[name];
+        return value === undefined ? whole : encodeURIComponent(String(value));
+    });
+}
+/**
+ * React Router as a `navigateTool` spec. Neither the `<Routes>` style nor the file-based one
+ * keeps a route registry to read at runtime, so the routes are the ones the app names here.
+ */
+export function fromReactRouter(source) {
+    for (const route of source.routes) {
+        if (route.to.includes("*")) {
+            throw new TypeError(`fromReactRouter: ${route.to} is a splat, which is not a destination a model can name`);
+        }
+        if (route.to.includes("?")) {
+            throw new TypeError(`fromReactRouter: ${route.to} has an optional segment, which is not a destination this binding builds; list the concrete variants instead`);
+        }
+    }
+    const routes = source.routes.map((route) => {
+        if (route.params !== undefined) {
+            return route;
+        }
+        const params = paramsOf(route.to);
+        return params === undefined ? route : { ...route, params };
+    });
+    // Where the last navigation went, so the answer is a path even when the app reads nothing back.
+    let went = "";
+    return {
+        routes,
+        navigate: async (to, params) => {
+            went = pathOf(to, params ?? {});
+            await source.navigate(went);
+        },
+        read: () => ({ location: source.location?.() ?? went }),
+    };
+}
+/** A child's path is relative unless it opens with a slash, which is React Router's own rule. */
+const join = (base, path) => path.startsWith("/") ? path : `${base.endsWith("/") ? base.slice(0, -1) : base}/${path}`;
+/**
+ * A `createBrowserRouter` route tree, flattened into the specs `navigateTool` takes. A pathless
+ * layout is not a destination, and neither is a splat or an optional segment, so all three are
+ * dropped and what is under them is kept. An `index: true` route has no `path` of its own
+ * either, and needs none: the parent's path already reaches it.
+ */
+export function routesOf(routes) {
+    const found = new Map();
+    const walk = (list, base) => {
+        for (const route of list) {
+            const here = route.path === undefined ? base : join(base, route.path);
+            if (route.path !== undefined && !here.includes("*") && !here.includes("?")) {
+                const params = paramsOf(here);
+                found.set(here, params === undefined ? { to: here } : { to: here, params });
+            }
+            if (route.children !== undefined) {
+                walk(route.children, here);
+            }
+        }
+    };
+    walk(routes, "");
+    return [...found.values()].sort((left, right) => left.to.localeCompare(right.to));
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,uFAAuF;AACvF,MAAM,KAAK,GAAG,mBAAmB,CAAC;AAElC,sFAAsF;AACtF,SAAS,QAAQ,CAAC,IAAY;IAC7B,MAAM,MAAM,GAAmC,EAAE,CAAC;IAClD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QACzB,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAC9D,CAAC;AAED,sGAAsG;AACtG,SAAS,MAAM,CAAC,EAAU,EAAE,MAAuC;IAClE,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,IAAY,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;AACJ,CAAC;AAwBD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAyB;IACxD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,SAAS,CAAC,oBAAoB,KAAK,CAAC,EAAE,0DAA0D,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,SAAS,CAClB,oBAAoB,KAAK,CAAC,EAAE,8GAA8G,CAC1I,CAAC;QACH,CAAC;IACF,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,gGAAgG;IAChG,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,OAAO;QACN,MAAM;QACN,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;YAC9B,IAAI,GAAG,MAAM,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;YAChC,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;KACvD,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,IAAY,EAAU,EAAE,CACnD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;AAE1F;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAkC;IAC1D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC3C,MAAM,IAAI,GAAG,CAAC,IAAgC,EAAE,IAAY,EAAQ,EAAE;QACrE,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACtE,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5E,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9B,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5B,CAAC;QACF,CAAC;IACF,CAAC,CAAC;IACF,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACjB,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AACnF,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@subako-ai/react-router",
+  "version": "0.1.0",
+  "description": "React Router as a navigate tool for Subako sessions",
+  "homepage": "https://github.com/Kikuvi-Inc/subako-sdk-typescript/tree/main/packages/react-router#readme",
+  "bugs": {
+    "url": "https://github.com/Kikuvi-Inc/subako-sdk-typescript/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "Kikuvi, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Kikuvi-Inc/subako-sdk-typescript.git",
+    "directory": "packages/react-router"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "react-router": "^7.12.0",
+    "typescript": "^5.9.3",
+    "@subako-ai/sdk": "0.1.0",
+    "@subako-ai/tools": "0.1.0"
+  },
+  "peerDependencies": {
+    "react-router": ">=6.4.0",
+    "@subako-ai/tools": "^0.1.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {}
+}

package/src/index.ts

@@ -0,0 +1,108 @@
+import type { NavigateSource, RouteParamType, RouteSpec } from "@subako-ai/tools";
+
+/** React Router spells a path parameter `:name`, and every one of them is a string. */
+const PARAM = /:([A-Za-z0-9_]+)/g;
+
+/** What a path says it takes; a route that declared its own parameters keeps them. */
+function paramsOf(path: string): Readonly<Record<string, RouteParamType>> | undefined {
+	const params: Record<string, RouteParamType> = {};
+	for (const match of path.matchAll(PARAM)) {
+		const name = match[1];
+		if (name !== undefined) {
+			params[name] = "string";
+		}
+	}
+	return Object.keys(params).length === 0 ? undefined : params;
+}
+
+/** `/documents/:id` and `{ id: "7" }` make `/documents/7`; React Router navigates to a built path. */
+function pathOf(to: string, params: Record<string, string | number>): string {
+	return to.replace(PARAM, (whole, name: string) => {
+		const value = params[name];
+		return value === undefined ? whole : encodeURIComponent(String(value));
+	});
+}
+
+/** The shape of a data router's route objects, as much of it as this needs. */
+export interface RouteObjectLike {
+	readonly path?: string;
+	readonly index?: boolean;
+	readonly children?: readonly RouteObjectLike[];
+}
+
+/** What an app hands the binding: how to go, where it may go, and where it is. */
+export interface ReactRouterSource {
+	/** What `useNavigate()` answers with. */
+	navigate(to: string): void | Promise<unknown>;
+	/** The routes the model may name, as the app spells them: `/documents/:id`. */
+	readonly routes: readonly RouteSpec[];
+	/**
+	 * Where the app is now. It is called when the model asks, not when the tool is
+	 * built, so it has to read the live value: `useLocation()` answers with a new
+	 * object every render, and closing over one leaves the binding reporting the
+	 * page the app was on when the tool was declared.
+	 */
+	location?(): string;
+}
+
+/**
+ * React Router as a `navigateTool` spec. Neither the `<Routes>` style nor the file-based one
+ * keeps a route registry to read at runtime, so the routes are the ones the app names here.
+ */
+export function fromReactRouter(source: ReactRouterSource): NavigateSource {
+	for (const route of source.routes) {
+		if (route.to.includes("*")) {
+			throw new TypeError(`fromReactRouter: ${route.to} is a splat, which is not a destination a model can name`);
+		}
+		if (route.to.includes("?")) {
+			throw new TypeError(
+				`fromReactRouter: ${route.to} has an optional segment, which is not a destination this binding builds; list the concrete variants instead`,
+			);
+		}
+	}
+	const routes = source.routes.map((route) => {
+		if (route.params !== undefined) {
+			return route;
+		}
+		const params = paramsOf(route.to);
+		return params === undefined ? route : { ...route, params };
+	});
+	// Where the last navigation went, so the answer is a path even when the app reads nothing back.
+	let went = "";
+	return {
+		routes,
+		navigate: async (to, params) => {
+			went = pathOf(to, params ?? {});
+			await source.navigate(went);
+		},
+		read: () => ({ location: source.location?.() ?? went }),
+	};
+}
+
+/** A child's path is relative unless it opens with a slash, which is React Router's own rule. */
+const join = (base: string, path: string): string =>
+	path.startsWith("/") ? path : `${base.endsWith("/") ? base.slice(0, -1) : base}/${path}`;
+
+/**
+ * A `createBrowserRouter` route tree, flattened into the specs `navigateTool` takes. A pathless
+ * layout is not a destination, and neither is a splat or an optional segment, so all three are
+ * dropped and what is under them is kept. An `index: true` route has no `path` of its own
+ * either, and needs none: the parent's path already reaches it.
+ */
+export function routesOf(routes: readonly RouteObjectLike[]): RouteSpec[] {
+	const found = new Map<string, RouteSpec>();
+	const walk = (list: readonly RouteObjectLike[], base: string): void => {
+		for (const route of list) {
+			const here = route.path === undefined ? base : join(base, route.path);
+			if (route.path !== undefined && !here.includes("*") && !here.includes("?")) {
+				const params = paramsOf(here);
+				found.set(here, params === undefined ? { to: here } : { to: here, params });
+			}
+			if (route.children !== undefined) {
+				walk(route.children, here);
+			}
+		}
+	};
+	walk(routes, "");
+	return [...found.values()].sort((left, right) => left.to.localeCompare(right.to));
+}