zustand-iten 0.4.1 → 0.5.0

package/README.md

@@ -1,5 +1,84 @@
 # zustand-iten
 
-Reserved package for the upcoming Zustand adapter for `iten`.
+Zustand bindings for `iten`, an ultralight typed in-memory router for embedded JavaScript apps.
 
-Use `iten-core` today for framework-agnostic routing.
+This package exposes a scoped vanilla Zustand store backed by `iten-core`. Use it when routing should live in a Zustand store, or when you want a framework-light adapter surface that can be consumed by Zustand selectors.
+
+## Install
+
+```bash
+npm install zustand-iten zustand
+```
+
+`zustand-iten` depends on `iten-core`. Install `@tanstack/react-query` only when route loaders call `queryClient.ensureQueryData`.
+
+## Quick Start
+
+```ts
+import {
+  createRouter,
+  defineRoutes,
+  route,
+} from 'zustand-iten'
+
+const routes = defineRoutes({
+  home: route(),
+  project: route<{ id: string }>(),
+  settings: route(),
+})
+
+const router = createRouter({
+  routes,
+  initial: { name: 'home' },
+})
+
+await router.navigate({ target: router.to({ name: 'project', params: { id: 'alpha' } }) })
+
+router.store.getState().route
+router.store.getState().canGoBack
+```
+
+## Store Shape
+
+The Zustand store state is the core router state plus router actions:
+
+- `route`
+- `pendingRoute`
+- `history`
+- `error`
+- `isNavigating`
+- `canGoBack`
+- `navigate(input)`
+- `goBack()`
+- `dispose()`
+
+```ts
+const unsub = router.store.subscribe((state) => {
+  console.log(state.route)
+})
+
+unsub()
+```
+
+## URL Sync
+
+`zustand-iten/url` keeps URL support explicit and optional.
+
+```ts
+import { createUrlSync } from 'zustand-iten/url'
+
+const sync = createUrlSync({
+  router,
+  parse: ({ url }) => parseRoute(url),
+  format: ({ route, url }) => formatRoute({ route, url }),
+})
+
+await sync.hydrate()
+sync.start()
+```
+
+## Entry Points
+
+- `zustand-iten`: scoped Zustand store, route utilities, and types
+- `zustand-iten/url`: optional URL sync adapter
+- `zustand-iten/utils`: route factories, guards, matching, and type utilities

package/dist/create-router.cjs

@@ -0,0 +1,65 @@
+let iten_core = require("iten-core");
+let zustand_vanilla = require("zustand/vanilla");
+//#region src/create-router.ts
+function createRouter(config) {
+	const getCtx = () => {
+		if (typeof config.context === "function") return config.context();
+		return config.context ?? {};
+	};
+	const core = (0, iten_core.createItenCore)({
+		initial: config.initial,
+		routes: config.routes,
+		routeConfig: config.routeConfig,
+		maxHistoryLength: config.maxHistoryLength,
+		queryClient: config.queryClient,
+		getCtx
+	});
+	let stopCoreSubscription;
+	function makeState({ state, actions }) {
+		return {
+			...state,
+			...actions
+		};
+	}
+	const actions = {
+		navigate: async (input) => {
+			await core.navigate(input);
+			store.setState(makeState({
+				state: core.getState(),
+				actions
+			}), true);
+		},
+		goBack: () => {
+			core.goBack();
+			store.setState(makeState({
+				state: core.getState(),
+				actions
+			}), true);
+		},
+		dispose: () => {
+			stopCoreSubscription?.();
+			stopCoreSubscription = void 0;
+			core.dispose();
+		}
+	};
+	const store = (0, zustand_vanilla.createStore)(() => makeState({
+		state: core.getState(),
+		actions
+	}));
+	stopCoreSubscription = core.subscribe({ listener: (state) => {
+		store.setState(makeState({
+			state,
+			actions
+		}), true);
+	} });
+	return {
+		store,
+		core,
+		to: core.to,
+		navigate: actions.navigate,
+		goBack: actions.goBack,
+		dispose: actions.dispose
+	};
+}
+//#endregion
+exports.createRouter = createRouter;

package/dist/create-router.d.cts

@@ -0,0 +1,18 @@
+import { ZustandRouterActions, ZustandRouterConfig, ZustandRouterStore } from "./types.cjs";
+import { InferRoutes, ItenCore, RouteDefinitions, RouteFactory, RouteMapDef } from "iten-core";
+
+//#region src/create-router.d.ts
+type ZustandRouter<M extends RouteMapDef, _Ctx = unknown> = {
+  store: ZustandRouterStore<M>;
+  core: ItenCore<M>;
+  to: RouteFactory<M>;
+  navigate: ZustandRouterActions<M>["navigate"];
+  goBack: ZustandRouterActions<M>["goBack"];
+  dispose: ZustandRouterActions<M>["dispose"];
+};
+declare function createRouter<const Defs extends RouteDefinitions, Ctx = unknown>(config: ZustandRouterConfig<InferRoutes<Defs>, Ctx> & {
+  routes: Defs;
+}): ZustandRouter<InferRoutes<Defs>, Ctx>;
+declare function createRouter<M extends RouteMapDef, Ctx = unknown>(config: ZustandRouterConfig<M, Ctx>): ZustandRouter<M, Ctx>;
+//#endregion
+export { ZustandRouter, createRouter };

package/dist/create-router.d.ts

@@ -0,0 +1,18 @@
+import { ZustandRouterActions, ZustandRouterConfig, ZustandRouterStore } from "./types.js";
+import { InferRoutes, ItenCore, RouteDefinitions, RouteFactory, RouteMapDef } from "iten-core";
+
+//#region src/create-router.d.ts
+type ZustandRouter<M extends RouteMapDef, _Ctx = unknown> = {
+  store: ZustandRouterStore<M>;
+  core: ItenCore<M>;
+  to: RouteFactory<M>;
+  navigate: ZustandRouterActions<M>["navigate"];
+  goBack: ZustandRouterActions<M>["goBack"];
+  dispose: ZustandRouterActions<M>["dispose"];
+};
+declare function createRouter<const Defs extends RouteDefinitions, Ctx = unknown>(config: ZustandRouterConfig<InferRoutes<Defs>, Ctx> & {
+  routes: Defs;
+}): ZustandRouter<InferRoutes<Defs>, Ctx>;
+declare function createRouter<M extends RouteMapDef, Ctx = unknown>(config: ZustandRouterConfig<M, Ctx>): ZustandRouter<M, Ctx>;
+//#endregion
+export { ZustandRouter, createRouter };

package/dist/create-router.mjs

@@ -0,0 +1,65 @@
+import { createItenCore } from "iten-core";
+import { createStore } from "zustand/vanilla";
+//#region src/create-router.ts
+function createRouter(config) {
+	const getCtx = () => {
+		if (typeof config.context === "function") return config.context();
+		return config.context ?? {};
+	};
+	const core = createItenCore({
+		initial: config.initial,
+		routes: config.routes,
+		routeConfig: config.routeConfig,
+		maxHistoryLength: config.maxHistoryLength,
+		queryClient: config.queryClient,
+		getCtx
+	});
+	let stopCoreSubscription;
+	function makeState({ state, actions }) {
+		return {
+			...state,
+			...actions
+		};
+	}
+	const actions = {
+		navigate: async (input) => {
+			await core.navigate(input);
+			store.setState(makeState({
+				state: core.getState(),
+				actions
+			}), true);
+		},
+		goBack: () => {
+			core.goBack();
+			store.setState(makeState({
+				state: core.getState(),
+				actions
+			}), true);
+		},
+		dispose: () => {
+			stopCoreSubscription?.();
+			stopCoreSubscription = void 0;
+			core.dispose();
+		}
+	};
+	const store = createStore(() => makeState({
+		state: core.getState(),
+		actions
+	}));
+	stopCoreSubscription = core.subscribe({ listener: (state) => {
+		store.setState(makeState({
+			state,
+			actions
+		}), true);
+	} });
+	return {
+		store,
+		core,
+		to: core.to,
+		navigate: actions.navigate,
+		goBack: actions.goBack,
+		dispose: actions.dispose
+	};
+}
+//#endregion
+export { createRouter };

package/dist/index.cjs

@@ -0,0 +1,46 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_create_router = require("./create-router.cjs");
+let iten_core = require("iten-core");
+Object.defineProperty(exports, "createRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core.createRoute;
+	}
+});
+exports.createRouter = require_create_router.createRouter;
+Object.defineProperty(exports, "defineRouteConfig", {
+	enumerable: true,
+	get: function() {
+		return iten_core.defineRouteConfig;
+	}
+});
+Object.defineProperty(exports, "defineRoutes", {
+	enumerable: true,
+	get: function() {
+		return iten_core.defineRoutes;
+	}
+});
+Object.defineProperty(exports, "isRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core.isRoute;
+	}
+});
+Object.defineProperty(exports, "isRouteName", {
+	enumerable: true,
+	get: function() {
+		return iten_core.isRouteName;
+	}
+});
+Object.defineProperty(exports, "matchRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core.matchRoute;
+	}
+});
+Object.defineProperty(exports, "route", {
+	enumerable: true,
+	get: function() {
+		return iten_core.route;
+	}
+});

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+import { InferRoutes, NoParams, QueryClientLike, RouteConfigMap, RouteDefinition, RouteDefinitions, RouteMap, RouteMapDef, RouteMatcher, RouteName, RouteOf, RouteParams, RouteUnion, RouterError, RouterState, ZustandRouterActions, ZustandRouterConfig, ZustandRouterState, ZustandRouterStore } from "./types.cjs";
+import { ZustandRouter, createRouter } from "./create-router.cjs";
+import { createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core";
+export { type InferRoutes, type NoParams, type QueryClientLike, type RouteConfigMap, type RouteDefinition, type RouteDefinitions, type RouteMap, type RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, type RouterError, type RouterState, type ZustandRouter, type ZustandRouterActions, type ZustandRouterConfig, type ZustandRouterState, type ZustandRouterStore, createRoute, createRouter, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { InferRoutes, NoParams, QueryClientLike, RouteConfigMap, RouteDefinition, RouteDefinitions, RouteMap, RouteMapDef, RouteMatcher, RouteName, RouteOf, RouteParams, RouteUnion, RouterError, RouterState, ZustandRouterActions, ZustandRouterConfig, ZustandRouterState, ZustandRouterStore } from "./types.js";
+import { ZustandRouter, createRouter } from "./create-router.js";
+import { createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core";
+export { type InferRoutes, type NoParams, type QueryClientLike, type RouteConfigMap, type RouteDefinition, type RouteDefinitions, type RouteMap, type RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, type RouterError, type RouterState, type ZustandRouter, type ZustandRouterActions, type ZustandRouterConfig, type ZustandRouterState, type ZustandRouterStore, createRoute, createRouter, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { createRouter } from "./create-router.mjs";
+import { createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core";
+export { createRoute, createRouter, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/dist/types.d.cts

@@ -0,0 +1,21 @@
+import { InferRoutes as InferRoutes$1, NavigateInput, NoParams, QueryClientLike, RouteConfigMap, RouteDefinition, RouteDefinitions as RouteDefinitions$1, RouteMap, RouteMapDef as RouteMapDef$1, RouteMatcher, RouteName, RouteOf, RouteParams, RouteUnion, RouterError, RouterState } from "iten-core";
+import { StoreApi } from "zustand/vanilla";
+
+//#region src/types.d.ts
+type ZustandRouterConfig<M extends RouteMapDef$1, Ctx = unknown> = {
+  initial: RouteUnion<M> | null;
+  routes?: RouteDefinitions$1 | undefined;
+  routeConfig?: RouteConfigMap<M, Ctx> | undefined;
+  maxHistoryLength?: number | undefined;
+  context?: Ctx | (() => Ctx) | undefined;
+  queryClient?: QueryClientLike | null | undefined;
+};
+type ZustandRouterActions<M extends RouteMapDef$1> = {
+  navigate: (input: NavigateInput<M>) => Promise<void>;
+  goBack: () => void;
+  dispose: () => void;
+};
+type ZustandRouterState<M extends RouteMapDef$1> = RouterState<M> & ZustandRouterActions<M>;
+type ZustandRouterStore<M extends RouteMapDef$1> = StoreApi<ZustandRouterState<M>>;
+//#endregion
+export { type InferRoutes$1 as InferRoutes, type NoParams, type QueryClientLike, type RouteConfigMap, type RouteDefinition, type RouteDefinitions$1 as RouteDefinitions, type RouteMap, type RouteMapDef$1 as RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, type RouterError, type RouterState, ZustandRouterActions, ZustandRouterConfig, ZustandRouterState, ZustandRouterStore };

package/dist/types.d.ts

@@ -0,0 +1,21 @@
+import { InferRoutes as InferRoutes$1, NavigateInput, NoParams, QueryClientLike, RouteConfigMap, RouteDefinition, RouteDefinitions as RouteDefinitions$1, RouteMap, RouteMapDef as RouteMapDef$1, RouteMatcher, RouteName, RouteOf, RouteParams, RouteUnion, RouterError, RouterState } from "iten-core";
+import { StoreApi } from "zustand/vanilla";
+
+//#region src/types.d.ts
+type ZustandRouterConfig<M extends RouteMapDef$1, Ctx = unknown> = {
+  initial: RouteUnion<M> | null;
+  routes?: RouteDefinitions$1 | undefined;
+  routeConfig?: RouteConfigMap<M, Ctx> | undefined;
+  maxHistoryLength?: number | undefined;
+  context?: Ctx | (() => Ctx) | undefined;
+  queryClient?: QueryClientLike | null | undefined;
+};
+type ZustandRouterActions<M extends RouteMapDef$1> = {
+  navigate: (input: NavigateInput<M>) => Promise<void>;
+  goBack: () => void;
+  dispose: () => void;
+};
+type ZustandRouterState<M extends RouteMapDef$1> = RouterState<M> & ZustandRouterActions<M>;
+type ZustandRouterStore<M extends RouteMapDef$1> = StoreApi<ZustandRouterState<M>>;
+//#endregion
+export { type InferRoutes$1 as InferRoutes, type NoParams, type QueryClientLike, type RouteConfigMap, type RouteDefinition, type RouteDefinitions$1 as RouteDefinitions, type RouteMap, type RouteMapDef$1 as RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, type RouterError, type RouterState, ZustandRouterActions, ZustandRouterConfig, ZustandRouterState, ZustandRouterStore };

package/dist/url.cjs

@@ -0,0 +1,21 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let iten_core_url = require("iten-core/url");
+//#region src/url.ts
+function createUrlSync({ router, ...input }) {
+	const coreLike = {
+		getState: () => router.store.getState(),
+		to: router.to,
+		navigate: (navigateInput) => router.navigate(navigateInput),
+		goBack: () => router.goBack(),
+		subscribe: ({ listener }) => router.store.subscribe((state) => {
+			listener(state);
+		}),
+		dispose: () => {}
+	};
+	return (0, iten_core_url.createUrlSync)({
+		...input,
+		router: coreLike
+	});
+}
+//#endregion
+exports.createUrlSync = createUrlSync;

package/dist/url.d.cts

@@ -0,0 +1,14 @@
+import { ZustandRouter } from "./create-router.cjs";
+import { RouteMapDef } from "iten-core";
+import { CreateUrlSyncInput as CreateUrlSyncInput$1, FormatUrlInput, ParseUrlInput, UrlHydrateInput, UrlParseErrorInput, UrlStartInput, UrlSubscribeInput, UrlSync, UrlSync as UrlSync$1, UrlWriteInput, UrlWriteMode } from "iten-core/url";
+
+//#region src/url.d.ts
+type CreateUrlSyncInput<M extends RouteMapDef> = Omit<CreateUrlSyncInput$1<M>, "router"> & {
+  router: ZustandRouter<M>;
+};
+declare function createUrlSync<M extends RouteMapDef>({
+  router,
+  ...input
+}: CreateUrlSyncInput<M>): UrlSync$1<M>;
+//#endregion
+export { CreateUrlSyncInput, type FormatUrlInput, type ParseUrlInput, type UrlHydrateInput, type UrlParseErrorInput, type UrlStartInput, type UrlSubscribeInput, type UrlSync, type UrlWriteInput, type UrlWriteMode, createUrlSync };

package/dist/url.d.ts

@@ -0,0 +1,14 @@
+import { ZustandRouter } from "./create-router.js";
+import { RouteMapDef } from "iten-core";
+import { CreateUrlSyncInput as CreateUrlSyncInput$1, FormatUrlInput, ParseUrlInput, UrlHydrateInput, UrlParseErrorInput, UrlStartInput, UrlSubscribeInput, UrlSync, UrlSync as UrlSync$1, UrlWriteInput, UrlWriteMode } from "iten-core/url";
+
+//#region src/url.d.ts
+type CreateUrlSyncInput<M extends RouteMapDef> = Omit<CreateUrlSyncInput$1<M>, "router"> & {
+  router: ZustandRouter<M>;
+};
+declare function createUrlSync<M extends RouteMapDef>({
+  router,
+  ...input
+}: CreateUrlSyncInput<M>): UrlSync$1<M>;
+//#endregion
+export { CreateUrlSyncInput, type FormatUrlInput, type ParseUrlInput, type UrlHydrateInput, type UrlParseErrorInput, type UrlStartInput, type UrlSubscribeInput, type UrlSync, type UrlWriteInput, type UrlWriteMode, createUrlSync };

package/dist/url.mjs

@@ -0,0 +1,20 @@
+import { createUrlSync as createUrlSync$1 } from "iten-core/url";
+//#region src/url.ts
+function createUrlSync({ router, ...input }) {
+	const coreLike = {
+		getState: () => router.store.getState(),
+		to: router.to,
+		navigate: (navigateInput) => router.navigate(navigateInput),
+		goBack: () => router.goBack(),
+		subscribe: ({ listener }) => router.store.subscribe((state) => {
+			listener(state);
+		}),
+		dispose: () => {}
+	};
+	return createUrlSync$1({
+		...input,
+		router: coreLike
+	});
+}
+//#endregion
+export { createUrlSync };

package/dist/utils.cjs

@@ -0,0 +1,44 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let iten_core_utils = require("iten-core/utils");
+Object.defineProperty(exports, "createRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.createRoute;
+	}
+});
+Object.defineProperty(exports, "defineRouteConfig", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.defineRouteConfig;
+	}
+});
+Object.defineProperty(exports, "defineRoutes", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.defineRoutes;
+	}
+});
+Object.defineProperty(exports, "isRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.isRoute;
+	}
+});
+Object.defineProperty(exports, "isRouteName", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.isRouteName;
+	}
+});
+Object.defineProperty(exports, "matchRoute", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.matchRoute;
+	}
+});
+Object.defineProperty(exports, "route", {
+	enumerable: true,
+	get: function() {
+		return iten_core_utils.route;
+	}
+});

package/dist/utils.d.cts

@@ -0,0 +1,3 @@
+import { InferRoutes, NoParams, RouteConfigMap, RouteMap, RouteMapDef, RouteUnion } from "iten-core";
+import { RouteMatcher, RouteName, RouteOf, RouteParams, createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core/utils";
+export { type InferRoutes, type NoParams, type RouteConfigMap, type RouteMap, type RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { InferRoutes, NoParams, RouteConfigMap, RouteMap, RouteMapDef, RouteUnion } from "iten-core";
+import { RouteMatcher, RouteName, RouteOf, RouteParams, createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core/utils";
+export { type InferRoutes, type NoParams, type RouteConfigMap, type RouteMap, type RouteMapDef, type RouteMatcher, type RouteName, type RouteOf, type RouteParams, type RouteUnion, createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/dist/utils.mjs

@@ -0,0 +1,2 @@
+import { createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route } from "iten-core/utils";
+export { createRoute, defineRouteConfig, defineRoutes, isRoute, isRouteName, matchRoute, route };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zustand-iten",
-  "version": "0.4.1",
-  "description": "Zustand adapter for iten — ultralight in-memory router for embedded JS apps. Coming soon.",
+  "version": "0.5.0",
+  "description": "Zustand adapter for iten — ultralight in-memory router for embedded JS apps",
   "keywords": [
     "zustand",
     "router",
@@ -18,13 +18,69 @@
     "url": "https://github.com/andrew-bierman/iten/issues"
   },
   "homepage": "https://github.com/andrew-bierman/iten#readme",
-  "main": "index.js",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./utils": {
+      "bun": "./src/utils.ts",
+      "import": {
+        "types": "./dist/utils.d.ts",
+        "default": "./dist/utils.mjs"
+      },
+      "require": {
+        "types": "./dist/utils.d.cts",
+        "default": "./dist/utils.cjs"
+      }
+    },
+    "./url": {
+      "bun": "./src/url.ts",
+      "import": {
+        "types": "./dist/url.d.ts",
+        "default": "./dist/url.mjs"
+      },
+      "require": {
+        "types": "./dist/url.d.cts",
+        "default": "./dist/url.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "index.js",
-    "README.md"
+    "dist",
+    "src"
   ],
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "typecheck:types": "bun run build && tsc -p tsconfig.type-tests.json",
+    "test": "bun test ./test"
+  },
+  "peerDependencies": {
+    "zustand": "^5.0.0"
+  },
+  "dependencies": {
+    "iten-core": "^0.5.0"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "tsdown": "0.21.9",
+    "typescript": "^5.7.0",
+    "zustand": "^5.0.0"
   }
 }

package/src/create-router.ts

@@ -0,0 +1,101 @@
+import type {
+  InferRoutes,
+  ItenCore,
+  RouteDefinitions,
+  RouteFactory,
+  RouteMapDef,
+  RouterState,
+} from 'iten-core'
+import { createItenCore } from 'iten-core'
+import { createStore } from 'zustand/vanilla'
+import type {
+  ZustandRouterActions,
+  ZustandRouterConfig,
+  ZustandRouterState,
+  ZustandRouterStore,
+} from './types.ts'
+
+export type ZustandRouter<M extends RouteMapDef, _Ctx = unknown> = {
+  store: ZustandRouterStore<M>
+  core: ItenCore<M>
+  to: RouteFactory<M>
+  navigate: ZustandRouterActions<M>['navigate']
+  goBack: ZustandRouterActions<M>['goBack']
+  dispose: ZustandRouterActions<M>['dispose']
+}
+
+export function createRouter<const Defs extends RouteDefinitions, Ctx = unknown>(
+  config: ZustandRouterConfig<InferRoutes<Defs>, Ctx> & { routes: Defs },
+): ZustandRouter<InferRoutes<Defs>, Ctx>
+export function createRouter<M extends RouteMapDef, Ctx = unknown>(
+  config: ZustandRouterConfig<M, Ctx>,
+): ZustandRouter<M, Ctx>
+export function createRouter<M extends RouteMapDef, Ctx = unknown>(
+  config: ZustandRouterConfig<M, Ctx>,
+): ZustandRouter<M, Ctx> {
+  const getCtx = (): Ctx => {
+    if (typeof config.context === 'function') {
+      return (config.context as () => Ctx)()
+    }
+    return (config.context ?? {}) as Ctx
+  }
+
+  const core = createItenCore<M, Ctx>({
+    initial: config.initial,
+    routes: config.routes,
+    routeConfig: config.routeConfig,
+    maxHistoryLength: config.maxHistoryLength,
+    queryClient: config.queryClient,
+    getCtx,
+  })
+
+  let stopCoreSubscription: (() => void) | undefined
+
+  function makeState({
+    state,
+    actions,
+  }: {
+    state: RouterState<M>
+    actions: ZustandRouterActions<M>
+  }): ZustandRouterState<M> {
+    return {
+      ...state,
+      ...actions,
+    }
+  }
+
+  const actions: ZustandRouterActions<M> = {
+    navigate: async (input) => {
+      await core.navigate(input)
+      store.setState(makeState({ state: core.getState(), actions }), true)
+    },
+    goBack: () => {
+      core.goBack()
+      store.setState(makeState({ state: core.getState(), actions }), true)
+    },
+    dispose: () => {
+      stopCoreSubscription?.()
+      stopCoreSubscription = undefined
+      core.dispose()
+    },
+  }
+
+  const store = createStore<ZustandRouterState<M>>(() =>
+    makeState({ state: core.getState(), actions }),
+  )
+
+  stopCoreSubscription = core.subscribe({
+    listener: (state) => {
+      store.setState(makeState({ state, actions }), true)
+    },
+  })
+
+  return {
+    store,
+    core,
+    to: core.to,
+    navigate: actions.navigate,
+    goBack: actions.goBack,
+    dispose: actions.dispose,
+  }
+}

package/src/index.ts

@@ -0,0 +1,32 @@
+export {
+  createRoute,
+  defineRouteConfig,
+  defineRoutes,
+  isRoute,
+  isRouteName,
+  matchRoute,
+  route,
+} from 'iten-core'
+export type { ZustandRouter } from './create-router.ts'
+export { createRouter } from './create-router.ts'
+export type {
+  InferRoutes,
+  NoParams,
+  QueryClientLike,
+  RouteConfigMap,
+  RouteDefinition,
+  RouteDefinitions,
+  RouteMap,
+  RouteMapDef,
+  RouteMatcher,
+  RouteName,
+  RouteOf,
+  RouteParams,
+  RouterError,
+  RouterState,
+  RouteUnion,
+  ZustandRouterActions,
+  ZustandRouterConfig,
+  ZustandRouterState,
+  ZustandRouterStore,
+} from './types.ts'

package/src/types.ts

@@ -0,0 +1,58 @@
+import type {
+  InferRoutes,
+  NavigateInput,
+  NoParams,
+  QueryClientLike,
+  RouteConfigMap,
+  RouteDefinition,
+  RouteDefinitions,
+  RouteFactory,
+  RouteMap,
+  RouteMapDef,
+  RouteMatcher,
+  RouteName,
+  RouteOf,
+  RouteParams,
+  RouterError,
+  RouterState,
+  RouteUnion,
+} from 'iten-core'
+import type { StoreApi } from 'zustand/vanilla'
+
+export type {
+  InferRoutes,
+  NoParams,
+  QueryClientLike,
+  RouteConfigMap,
+  RouteDefinition,
+  RouteDefinitions,
+  RouteFactory,
+  RouteMap,
+  RouteMapDef,
+  RouteMatcher,
+  RouteName,
+  RouteOf,
+  RouteParams,
+  RouterError,
+  RouterState,
+  RouteUnion,
+}
+
+export type ZustandRouterConfig<M extends RouteMapDef, Ctx = unknown> = {
+  initial: RouteUnion<M> | null
+  routes?: RouteDefinitions | undefined
+  routeConfig?: RouteConfigMap<M, Ctx> | undefined
+  maxHistoryLength?: number | undefined
+  context?: Ctx | (() => Ctx) | undefined
+  queryClient?: QueryClientLike | null | undefined
+}
+
+export type ZustandRouterActions<M extends RouteMapDef> = {
+  navigate: (input: NavigateInput<M>) => Promise<void>
+  goBack: () => void
+  dispose: () => void
+}
+
+export type ZustandRouterState<M extends RouteMapDef> = RouterState<M> & ZustandRouterActions<M>
+
+export type ZustandRouterStore<M extends RouteMapDef> = StoreApi<ZustandRouterState<M>>

package/src/url.ts

@@ -0,0 +1,48 @@
+import type { ItenCore, NavigateInput, RouteMapDef, RouterState } from 'iten-core'
+import {
+  type CreateUrlSyncInput as CoreCreateUrlSyncInput,
+  createUrlSync as createCoreUrlSync,
+  type UrlSync,
+} from 'iten-core/url'
+import type { ZustandRouter } from './create-router.ts'
+
+export type {
+  FormatUrlInput,
+  ParseUrlInput,
+  UrlHydrateInput,
+  UrlParseErrorInput,
+  UrlStartInput,
+  UrlSubscribeInput,
+  UrlSync,
+  UrlWriteInput,
+  UrlWriteMode,
+} from 'iten-core/url'
+
+export type CreateUrlSyncInput<M extends RouteMapDef> = Omit<
+  CoreCreateUrlSyncInput<M>,
+  'router'
+> & {
+  router: ZustandRouter<M>
+}
+
+export function createUrlSync<M extends RouteMapDef>({
+  router,
+  ...input
+}: CreateUrlSyncInput<M>): UrlSync<M> {
+  const coreLike: ItenCore<M> = {
+    getState: () => router.store.getState() as RouterState<M>,
+    to: router.to,
+    navigate: (navigateInput: NavigateInput<M>) => router.navigate(navigateInput),
+    goBack: () => router.goBack(),
+    subscribe: ({ listener }) =>
+      router.store.subscribe((state) => {
+        listener(state as RouterState<M>)
+      }),
+    dispose: () => {},
+  }
+
+  return createCoreUrlSync<M>({
+    ...input,
+    router: coreLike,
+  })
+}

package/src/utils.ts

@@ -0,0 +1,23 @@
+export type {
+  InferRoutes,
+  NoParams,
+  RouteConfigMap,
+  RouteMap,
+  RouteMapDef,
+  RouteUnion,
+} from 'iten-core'
+export type {
+  RouteMatcher,
+  RouteName,
+  RouteOf,
+  RouteParams,
+} from 'iten-core/utils'
+export {
+  createRoute,
+  defineRouteConfig,
+  defineRoutes,
+  isRoute,
+  isRouteName,
+  matchRoute,
+  route,
+} from 'iten-core/utils'

package/index.js

@@ -1 +0,0 @@
-throw new Error('zustand-iten is reserved for the upcoming Zustand adapter. Use iten-core today.')