@wordpress/route 0.1.1-next.16d95556a.0

package/README.md

@@ -0,0 +1,50 @@
+# Route
+
+Routing utilities for WordPress admin interfaces, providing a shared instance of TanStack Router.
+
+## Installation
+
+Install the module:
+
+```bash
+npm install @wordpress/route --save
+```
+
+## Usage
+
+This package provides a shared instance of TanStack Router to ensure consistent routing across WordPress admin interfaces.
+
+### Public API
+
+The following hooks and components are available for use in routes:
+
+```js
+import { Link, useNavigate, useParams, useRouter, useSearch } from '@wordpress/route';
+
+function MyRoute() {
+	const params = useParams();
+	const navigate = useNavigate();
+	const search = useSearch();
+
+	return (
+		<div>
+			<Link to="/other-route">Go to other route</Link>
+			<button onClick={() => navigate({ to: '/somewhere' })}>
+				Navigate
+			</button>
+		</div>
+	);
+}
+```
+
+### Private API
+
+The boot package uses private APIs for router setup. These should not be used by individual routes.
+
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the [project's main contributor guide](https://github.com/WordPress/gutenberg/blob/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/build/index.js

@@ -0,0 +1,49 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/route/src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Link: () => import_react_router2.Link,
+  privateApis: () => import_private_apis.privateApis,
+  redirect: () => import_react_router2.redirect,
+  useInvalidate: () => useInvalidate,
+  useNavigate: () => import_react_router2.useNavigate,
+  useParams: () => import_react_router2.useParams,
+  useSearch: () => import_react_router2.useSearch
+});
+module.exports = __toCommonJS(index_exports);
+var import_react_router = require("@tanstack/react-router");
+var import_react_router2 = require("@tanstack/react-router");
+var import_private_apis = require("./private-apis");
+function useInvalidate() {
+  const router = (0, import_react_router.useRouter)();
+  return () => router.invalidate();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Link,
+  privateApis,
+  redirect,
+  useInvalidate,
+  useNavigate,
+  useParams,
+  useSearch
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { useRouter } from '@tanstack/react-router';\nexport {\n\tLink,\n\tredirect,\n\tuseNavigate,\n\tuseParams,\n\tuseSearch,\n} from '@tanstack/react-router';\nexport type {\n\tAnyRoute,\n\tLinkProps,\n\tNavigateOptions,\n\tRouteOptions,\n\tRouterOptions,\n\tToOptions,\n\tUseNavigateResult,\n} from '@tanstack/react-router';\n\n/**\n * Internal dependencies\n */\nexport { privateApis } from './private-apis';\n\n/**\n * Hook to invalidate the router cache and trigger a re-render.\n * This is useful when you want to refetch data without changing the URL.\n *\n * @example\n * ```tsx\n * function MyComponent() {\n *   const invalidate = useInvalidate();\n *\n *   const handleRefresh = () => {\n *     invalidate();\n *   };\n *\n *   return <button onClick={handleRefresh}>Refresh</button>;\n * }\n * ```\n *\n * @return A function to invalidate the router.\n */\nexport function useInvalidate() {\n\tconst router = useRouter();\n\treturn () => router.invalidate();\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,0BAA0B;AAC1B,IAAAA,uBAMO;AAcP,0BAA4B;AAqBrB,SAAS,gBAAgB;AAC/B,QAAM,aAAS,+BAAU;AACzB,SAAO,MAAM,OAAO,WAAW;AAChC;",
+  "names": ["import_react_router"]
+}

package/build/lock-unlock.js

@@ -0,0 +1,37 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/route/src/lock-unlock.ts
+var lock_unlock_exports = {};
+__export(lock_unlock_exports, {
+  lock: () => lock,
+  unlock: () => unlock
+});
+module.exports = __toCommonJS(lock_unlock_exports);
+var import_private_apis = require("@wordpress/private-apis");
+var { lock, unlock } = (0, import_private_apis.__dangerousOptInToUnstableAPIsOnlyForCoreModules)(
+  "I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.",
+  "@wordpress/route"
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  lock,
+  unlock
+});
+//# sourceMappingURL=lock-unlock.js.map

package/build/lock-unlock.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/lock-unlock.ts"],
+  "sourcesContent": ["/**\n * WordPress dependencies\n */\nimport { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';\n\nexport const { lock, unlock } =\n\t__dangerousOptInToUnstableAPIsOnlyForCoreModules(\n\t\t'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',\n\t\t'@wordpress/route'\n\t);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,0BAAiE;AAE1D,IAAM,EAAE,MAAM,OAAO,QAC3B;AAAA,EACC;AAAA,EACA;AACD;",
+  "names": []
+}

package/build/private-apis.js

@@ -0,0 +1,51 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/route/src/private-apis.ts
+var private_apis_exports = {};
+__export(private_apis_exports, {
+  privateApis: () => privateApis
+});
+module.exports = __toCommonJS(private_apis_exports);
+var import_history = require("@tanstack/history");
+var import_react_router = require("@tanstack/react-router");
+var import_lock_unlock = require("./lock-unlock");
+var privateApis = {};
+(0, import_lock_unlock.lock)(privateApis, {
+  // Router creation and setup
+  createBrowserHistory: import_react_router.createBrowserHistory,
+  createRouter: import_react_router.createRouter,
+  createRootRoute: import_react_router.createRootRoute,
+  createRoute: import_react_router.createRoute,
+  Outlet: import_react_router.Outlet,
+  RouterProvider: import_react_router.RouterProvider,
+  // Internal routing utilities
+  redirect: import_react_router.redirect,
+  createLink: import_react_router.createLink,
+  useCanGoBack: import_react_router.useCanGoBack,
+  useMatches: import_react_router.useMatches,
+  useRouter: import_react_router.useRouter,
+  // History utilities
+  parseHref: import_history.parseHref
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  privateApis
+});
+//# sourceMappingURL=private-apis.js.map

package/build/private-apis.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/private-apis.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { parseHref } from '@tanstack/history';\nimport {\n\tcreateBrowserHistory,\n\tcreateLink,\n\tcreateRootRoute,\n\tcreateRoute,\n\tcreateRouter,\n\tOutlet,\n\tredirect,\n\tRouterProvider,\n\tuseCanGoBack,\n\tuseMatches,\n\tuseRouter,\n} from '@tanstack/react-router';\n\n/**\n * Internal dependencies\n */\nimport { lock } from './lock-unlock';\n\n/**\n * Private APIs for the boot package only.\n * These are router setup and internal utilities that should not be used\n * by individual routes.\n */\nexport const privateApis = {};\n\n// Lock the private APIs so only authorized modules can access them\nlock( privateApis, {\n\t// Router creation and setup\n\tcreateBrowserHistory,\n\tcreateRouter,\n\tcreateRootRoute,\n\tcreateRoute,\n\tOutlet,\n\tRouterProvider,\n\n\t// Internal routing utilities\n\tredirect,\n\tcreateLink,\n\tuseCanGoBack,\n\tuseMatches,\n\tuseRouter,\n\n\t// History utilities\n\tparseHref,\n} );\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,qBAA0B;AAC1B,0BAYO;AAKP,yBAAqB;AAOd,IAAM,cAAc,CAAC;AAAA,IAG5B,yBAAM,aAAa;AAAA;AAAA,EAElB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AACD,CAAE;",
+  "names": []
+}

package/build-module/index.js

@@ -0,0 +1,24 @@
+// packages/route/src/index.ts
+import { useRouter } from "@tanstack/react-router";
+import {
+  Link,
+  redirect,
+  useNavigate,
+  useParams,
+  useSearch
+} from "@tanstack/react-router";
+import { privateApis } from "./private-apis";
+function useInvalidate() {
+  const router = useRouter();
+  return () => router.invalidate();
+}
+export {
+  Link,
+  privateApis,
+  redirect,
+  useInvalidate,
+  useNavigate,
+  useParams,
+  useSearch
+};
+//# sourceMappingURL=index.js.map

package/build-module/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { useRouter } from '@tanstack/react-router';\nexport {\n\tLink,\n\tredirect,\n\tuseNavigate,\n\tuseParams,\n\tuseSearch,\n} from '@tanstack/react-router';\nexport type {\n\tAnyRoute,\n\tLinkProps,\n\tNavigateOptions,\n\tRouteOptions,\n\tRouterOptions,\n\tToOptions,\n\tUseNavigateResult,\n} from '@tanstack/react-router';\n\n/**\n * Internal dependencies\n */\nexport { privateApis } from './private-apis';\n\n/**\n * Hook to invalidate the router cache and trigger a re-render.\n * This is useful when you want to refetch data without changing the URL.\n *\n * @example\n * ```tsx\n * function MyComponent() {\n *   const invalidate = useInvalidate();\n *\n *   const handleRefresh = () => {\n *     invalidate();\n *   };\n *\n *   return <button onClick={handleRefresh}>Refresh</button>;\n * }\n * ```\n *\n * @return A function to invalidate the router.\n */\nexport function useInvalidate() {\n\tconst router = useRouter();\n\treturn () => router.invalidate();\n}\n"],
+  "mappings": ";AAGA,SAAS,iBAAiB;AAC1B;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAcP,SAAS,mBAAmB;AAqBrB,SAAS,gBAAgB;AAC/B,QAAM,SAAS,UAAU;AACzB,SAAO,MAAM,OAAO,WAAW;AAChC;",
+  "names": []
+}

package/build-module/lock-unlock.js

@@ -0,0 +1,11 @@
+// packages/route/src/lock-unlock.ts
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from "@wordpress/private-apis";
+var { lock, unlock } = __dangerousOptInToUnstableAPIsOnlyForCoreModules(
+  "I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.",
+  "@wordpress/route"
+);
+export {
+  lock,
+  unlock
+};
+//# sourceMappingURL=lock-unlock.js.map

package/build-module/lock-unlock.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/lock-unlock.ts"],
+  "sourcesContent": ["/**\n * WordPress dependencies\n */\nimport { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';\n\nexport const { lock, unlock } =\n\t__dangerousOptInToUnstableAPIsOnlyForCoreModules(\n\t\t'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',\n\t\t'@wordpress/route'\n\t);\n"],
+  "mappings": ";AAGA,SAAS,wDAAwD;AAE1D,IAAM,EAAE,MAAM,OAAO,IAC3B;AAAA,EACC;AAAA,EACA;AACD;",
+  "names": []
+}

package/build-module/private-apis.js

@@ -0,0 +1,38 @@
+// packages/route/src/private-apis.ts
+import { parseHref } from "@tanstack/history";
+import {
+  createBrowserHistory,
+  createLink,
+  createRootRoute,
+  createRoute,
+  createRouter,
+  Outlet,
+  redirect,
+  RouterProvider,
+  useCanGoBack,
+  useMatches,
+  useRouter
+} from "@tanstack/react-router";
+import { lock } from "./lock-unlock";
+var privateApis = {};
+lock(privateApis, {
+  // Router creation and setup
+  createBrowserHistory,
+  createRouter,
+  createRootRoute,
+  createRoute,
+  Outlet,
+  RouterProvider,
+  // Internal routing utilities
+  redirect,
+  createLink,
+  useCanGoBack,
+  useMatches,
+  useRouter,
+  // History utilities
+  parseHref
+});
+export {
+  privateApis
+};
+//# sourceMappingURL=private-apis.js.map

package/build-module/private-apis.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/private-apis.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { parseHref } from '@tanstack/history';\nimport {\n\tcreateBrowserHistory,\n\tcreateLink,\n\tcreateRootRoute,\n\tcreateRoute,\n\tcreateRouter,\n\tOutlet,\n\tredirect,\n\tRouterProvider,\n\tuseCanGoBack,\n\tuseMatches,\n\tuseRouter,\n} from '@tanstack/react-router';\n\n/**\n * Internal dependencies\n */\nimport { lock } from './lock-unlock';\n\n/**\n * Private APIs for the boot package only.\n * These are router setup and internal utilities that should not be used\n * by individual routes.\n */\nexport const privateApis = {};\n\n// Lock the private APIs so only authorized modules can access them\nlock( privateApis, {\n\t// Router creation and setup\n\tcreateBrowserHistory,\n\tcreateRouter,\n\tcreateRootRoute,\n\tcreateRoute,\n\tOutlet,\n\tRouterProvider,\n\n\t// Internal routing utilities\n\tredirect,\n\tcreateLink,\n\tuseCanGoBack,\n\tuseMatches,\n\tuseRouter,\n\n\t// History utilities\n\tparseHref,\n} );\n"],
+  "mappings": ";AAGA,SAAS,iBAAiB;AAC1B;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAKP,SAAS,YAAY;AAOd,IAAM,cAAc,CAAC;AAG5B,KAAM,aAAa;AAAA;AAAA,EAElB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AACD,CAAE;",
+  "names": []
+}

package/build-types/index.d.ts

@@ -0,0 +1,27 @@
+export { Link, redirect, useNavigate, useParams, useSearch, } from '@tanstack/react-router';
+export type { AnyRoute, LinkProps, NavigateOptions, RouteOptions, RouterOptions, ToOptions, UseNavigateResult, } from '@tanstack/react-router';
+/**
+ * Internal dependencies
+ */
+export { privateApis } from './private-apis';
+/**
+ * Hook to invalidate the router cache and trigger a re-render.
+ * This is useful when you want to refetch data without changing the URL.
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const invalidate = useInvalidate();
+ *
+ *   const handleRefresh = () => {
+ *     invalidate();
+ *   };
+ *
+ *   return <button onClick={handleRefresh}>Refresh</button>;
+ * }
+ * ```
+ *
+ * @return A function to invalidate the router.
+ */
+export declare function useInvalidate(): () => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EACN,IAAI,EACJ,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,GACT,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACX,QAAQ,EACR,SAAS,EACT,eAAe,EACf,YAAY,EACZ,aAAa,EACb,SAAS,EACT,iBAAiB,GACjB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,aAAa,wBAG5B"}

package/build-types/lock-unlock.d.ts

@@ -0,0 +1,2 @@
+export declare const lock: (object: unknown, privateData: unknown) => void, unlock: <T = any>(object: unknown) => T;
+//# sourceMappingURL=lock-unlock.d.ts.map

package/build-types/lock-unlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-unlock.d.ts","sourceRoot":"","sources":["../src/lock-unlock.ts"],"names":[],"mappings":"AAKA,eAAO,MAAQ,IAAI,mDAAE,MAAM,iCAIzB,CAAC"}

package/build-types/private-apis.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Private APIs for the boot package only.
+ * These are router setup and internal utilities that should not be used
+ * by individual routes.
+ */
+export declare const privateApis: {};
+//# sourceMappingURL=private-apis.d.ts.map

package/build-types/private-apis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-apis.d.ts","sourceRoot":"","sources":["../src/private-apis.ts"],"names":[],"mappings":"AAuBA;;;;GAIG;AACH,eAAO,MAAM,WAAW,IAAK,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@wordpress/route",
+	"version": "0.1.1-next.16d95556a.0",
+	"description": "Routing utilities for WordPress admin interfaces.",
+	"author": "The WordPress Contributors",
+	"license": "GPL-2.0-or-later",
+	"keywords": [
+		"wordpress",
+		"routing"
+	],
+	"homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/packages/route/README.md",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/gutenberg.git",
+		"directory": "packages/route"
+	},
+	"bugs": {
+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"engines": {
+		"node": ">=18.12.0",
+		"npm": ">=8.19.2"
+	},
+	"main": "build/index.js",
+	"module": "build-module/index.js",
+	"exports": {
+		".": {
+			"types": "./build-types/index.d.ts",
+			"import": "./build-module/index.js",
+			"default": "./build/index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"react-native": "src/index",
+	"wpScriptModuleExports": "./build-module/index.js",
+	"types": "build-types",
+	"sideEffects": false,
+	"dependencies": {
+		"@tanstack/history": "^1.133.28",
+		"@tanstack/react-router": "^1.120.5",
+		"@wordpress/private-apis": "^1.35.1-next.16d95556a.0"
+	},
+	"peerDependencies": {
+		"react": "^18.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "59a9383612bbe16e21af84d13b035bfbca7fe833"
+}

package/src/index.ts

@@ -0,0 +1,49 @@
+/**
+ * External dependencies
+ */
+import { useRouter } from '@tanstack/react-router';
+export {
+	Link,
+	redirect,
+	useNavigate,
+	useParams,
+	useSearch,
+} from '@tanstack/react-router';
+export type {
+	AnyRoute,
+	LinkProps,
+	NavigateOptions,
+	RouteOptions,
+	RouterOptions,
+	ToOptions,
+	UseNavigateResult,
+} from '@tanstack/react-router';
+
+/**
+ * Internal dependencies
+ */
+export { privateApis } from './private-apis';
+
+/**
+ * Hook to invalidate the router cache and trigger a re-render.
+ * This is useful when you want to refetch data without changing the URL.
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const invalidate = useInvalidate();
+ *
+ *   const handleRefresh = () => {
+ *     invalidate();
+ *   };
+ *
+ *   return <button onClick={handleRefresh}>Refresh</button>;
+ * }
+ * ```
+ *
+ * @return A function to invalidate the router.
+ */
+export function useInvalidate() {
+	const router = useRouter();
+	return () => router.invalidate();
+}

package/src/lock-unlock.ts

@@ -0,0 +1,10 @@
+/**
+ * WordPress dependencies
+ */
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
+
+export const { lock, unlock } =
+	__dangerousOptInToUnstableAPIsOnlyForCoreModules(
+		'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',
+		'@wordpress/route'
+	);

package/src/private-apis.ts

@@ -0,0 +1,50 @@
+/**
+ * External dependencies
+ */
+import { parseHref } from '@tanstack/history';
+import {
+	createBrowserHistory,
+	createLink,
+	createRootRoute,
+	createRoute,
+	createRouter,
+	Outlet,
+	redirect,
+	RouterProvider,
+	useCanGoBack,
+	useMatches,
+	useRouter,
+} from '@tanstack/react-router';
+
+/**
+ * Internal dependencies
+ */
+import { lock } from './lock-unlock';
+
+/**
+ * Private APIs for the boot package only.
+ * These are router setup and internal utilities that should not be used
+ * by individual routes.
+ */
+export const privateApis = {};
+
+// Lock the private APIs so only authorized modules can access them
+lock( privateApis, {
+	// Router creation and setup
+	createBrowserHistory,
+	createRouter,
+	createRootRoute,
+	createRoute,
+	Outlet,
+	RouterProvider,
+
+	// Internal routing utilities
+	redirect,
+	createLink,
+	useCanGoBack,
+	useMatches,
+	useRouter,
+
+	// History utilities
+	parseHref,
+} );

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"rootDir": "src",
+		"declarationDir": "build-types"
+	},
+	"references": [
+		{
+			"path": "../private-apis"
+		}
+	],
+	"include": [ "src/**/*" ]
+}