@xmachines/play-sveltekit-router 3.0.0 → 4.0.0

package/README.md

@@ -2,36 +2,37 @@
 
 SvelteKit router adapter for the XMachines Universal Player Architecture. It keeps the state machine routes of a `RoutableActor` and the browser URL in step, in both directions, through the `$app/navigation` module of SvelteKit.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-3.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-4.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
 
 ## Installation
 
 ```bash
-pnpm add @xmachines/play-sveltekit-router
+pnpm add @xmachines/play-sveltekit-router @xmachines/play-router
 ```
 
 **Peer dependencies.** Install them separately:
 
 ```bash
-pnpm add @sveltejs/kit svelte xstate
+pnpm add @sveltejs/kit svelte
 ```
 
 | Peer dependency | Required version |
 | --------------- | ---------------- |
 | `@sveltejs/kit` | `^2.0.0`         |
 | `svelte`        | `^5.0.0`         |
-| `xstate`        | `^5.31.0`        |
 
 ## Quick Start
 
 ```typescript
 import { onDestroy } from "svelte";
-import { connectRouter, createRouteMap } from "@xmachines/play-sveltekit-router";
-import { definePlayer } from "@xmachines/play-xstate";
+import { connectRouter } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
+import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
 import { myMachine } from "./machine.js";
 
-// 1. Create the actor
-const createPlayer = definePlayer({ machine: myMachine });
+// 1. Create the actor — `connectRouter` needs the routing capability
+const createPlayer = definePlayer({ machine: myMachine, actor: compose(PlayerActor, withRouting) });
 const actor = createPlayer();
 actor.start();
 
@@ -58,8 +59,8 @@ This function is the primary integration point. It creates a `SvelteKitRouterBri
 
 ```typescript
 import { onDestroy } from "svelte";
-import { connectRouter, createRouteMap } from "@xmachines/play-sveltekit-router";
-
+import { connectRouter } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 // machine and actor as in the Quick Start above
 const routeMap = createRouteMap(machine);
 
@@ -90,8 +91,8 @@ onDestroy(() => disconnect());
 This class extends `RouterBridgeBase` from `@xmachines/play-router`. Use it directly when you need more control over the connection lifecycle.
 
 ```typescript
-import { SvelteKitRouterBridge, createRouteMap } from "@xmachines/play-sveltekit-router";
-
+import { SvelteKitRouterBridge } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 // machine and actor as in the Quick Start above
 const routeMap = createRouteMap(machine);
 const bridge = new SvelteKitRouterBridge(actor, routeMap, location);
@@ -107,12 +108,12 @@ bridge.disconnect();
 - `watchRouterChanges` → registers an `afterNavigate` callback through an indirection cell, which prevents a direct capture of `this`
 - `unwatchRouterChanges` → sets the indirection cell to null, which releases the bridge reference before the component unmounts (SvelteKit has no API to cancel `afterNavigate`)
 
-### `createRouteMap(machine)`
+### `createRouteMap(machine)` — from `@xmachines/play-router/xstate`
 
-This factory builds a `RouteMap` from an XState machine definition. It reads each route pattern from `state.meta.route`.
+This factory builds a `RouteMap` from an XState machine definition. It reads each route pattern from `state.meta.route`. This package re-exports it never: the barrel names no state machine, so import the function from `@xmachines/play-router/xstate`.
 
 ```typescript
-import { createRouteMap } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 import { createMachine } from "xstate";
 
 const machine = createMachine({
@@ -151,7 +152,6 @@ const routeMap = new RouteMap([
 | `connectRouter`         | function | High-level factory — connects the SvelteKit router to an actor, returns a cleanup function                     |
 | `SvelteKitRouterBridge` | class    | The low-level bridge class. It extends `RouterBridgeBase`. Use it directly for full lifecycle control          |
 | `ConnectRouterOptions`  | type     | The options object for `connectRouter`                                                                         |
-| `createRouteMap`        | function | Builds a `RouteMap` from an XState machine definition                                                          |
 | `RouteMap`              | class    | Bidirectional state ID ↔ URL path mapping (re-exported from `@xmachines/play-router`)                          |
 | `RouteMapping`          | type     | Single `{ stateId, path }` entry for `RouteMap` construction                                                   |
 | `RouteMapOptions`       | type     | Options for `RouteMap` construction                                                                            |
@@ -171,20 +171,6 @@ pnpm --filter @xmachines/play-sveltekit-router-demo run dev
 
 Then open `http://localhost:5173`.
 
-## Testing
-
-Run tests for this package in isolation:
-
-```bash
-# From the monorepo root
-pnpm --filter @xmachines/play-sveltekit-router test
-
-# Or from this package directory
-pnpm test
-```
-
-Coverage thresholds: **80%** lines, functions, branches, and statements.
-
 ## License
 
 MIT — see [LICENSE](LICENSE).

package/dist/connect-router.d.ts

@@ -17,7 +17,8 @@ export interface ConnectRouterOptions extends BasePathOptions {
  *
  * @example
  * ```typescript
- * import { connectRouter, createRouteMap } from '@xmachines/play-sveltekit-router';
+ * import { connectRouter } from '@xmachines/play-sveltekit-router';
+ * import { createRouteMap } from '@xmachines/play-router/xstate';
  * const routeMap = createRouteMap(machine);
  * const disconnect = connectRouter({ actor, routeMap });
  * onDestroy(() => disconnect());

package/dist/connect-router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connect-router.d.ts","sourceRoot":"","sources":["../src/connect-router.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACvF,OAAO,KAAK,EACX,eAAe,EACf,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC5D,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CACxC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,gBAAgB,CAO7E"}
+{"version":3,"file":"connect-router.d.ts","sourceRoot":"","sources":["../src/connect-router.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACvF,OAAO,KAAK,EACX,eAAe,EACf,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC5D,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CACxC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,gBAAgB,CAO7E"}

package/dist/connect-router.js

@@ -7,7 +7,8 @@ import { SvelteKitRouterBridge } from "./sveltekit-router-bridge.js";
  *
  * @example
  * ```typescript
- * import { connectRouter, createRouteMap } from '@xmachines/play-sveltekit-router';
+ * import { connectRouter } from '@xmachines/play-sveltekit-router';
+ * import { createRouteMap } from '@xmachines/play-router/xstate';
  * const routeMap = createRouteMap(machine);
  * const disconnect = connectRouter({ actor, routeMap });
  * onDestroy(() => disconnect());

package/dist/connect-router.js.map

@@ -1 +1 @@
-{"version":3,"file":"connect-router.js","sourceRoot":"","sources":["../src/connect-router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAyB,MAAM,wBAAwB,CAAC;AAOvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAarE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IAC1D,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE;QAC3F,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;KACtC,CAAC,CAAC;IACH,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC"}
+{"version":3,"file":"connect-router.js","sourceRoot":"","sources":["../src/connect-router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAyB,MAAM,wBAAwB,CAAC;AAOvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAarE;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IAC1D,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE;QAC3F,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;KACtC,CAAC,CAAC;IACH,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC"}

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * @xmachines/play-sveltekit-router - SvelteKit router adapter for XMachines Play
  */
-export { RouteMap, createRouteMap, type RouteMapping, type RouteMapOptions, } from "@xmachines/play-router";
+export { RouteMap, type RouteMapping, type RouteMapOptions } from "@xmachines/play-router";
 export { SvelteKitRouterBridge } from "./sveltekit-router-bridge.js";
 export { connectRouter } from "./connect-router.js";
 export type { BasePathOptions, RouterConnection } from "@xmachines/play-router";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACN,QAAQ,EACR,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,eAAe,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAChF,YAAY,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAQH,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAChF,YAAY,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -1,7 +1,12 @@
 /**
  * @xmachines/play-sveltekit-router - SvelteKit router adapter for XMachines Play
  */
-export { RouteMap, createRouteMap, } from "@xmachines/play-router";
+// This barrel names NO state machine. `createRouteMap` and `extractMachineRoutes`
+// read an XState machine, and they live in `@xmachines/play-router/xstate`, where
+// `xstate` is an OPTIONAL peer. A re-export here loads that module for every
+// consumer of this package, and the import fails when the consumer installed no
+// `xstate`. Import those two from `@xmachines/play-router/xstate` directly.
+export { RouteMap } from "@xmachines/play-router";
 export { SvelteKitRouterBridge } from "./sveltekit-router-bridge.js";
 export { connectRouter } from "./connect-router.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACN,QAAQ,EACR,cAAc,GAGd,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,kFAAkF;AAClF,kFAAkF;AAClF,6EAA6E;AAC7E,gFAAgF;AAChF,4EAA4E;AAE5E,OAAO,EAAE,QAAQ,EAA2C,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/types.d.ts

@@ -1,8 +1,6 @@
 /**
  * The type definitions of @xmachines/play-sveltekit-router
  */
-import type { AbstractActor, Routable } from "@xmachines/play-actor";
-import type { AnyActorLogic } from "xstate";
 export type { PlayRouteEvent, RouterBridge } from "@xmachines/play-router";
-export type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
+export type { RoutableActor } from "@xmachines/play-router";
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3E,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAG3E,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/play-sveltekit-router",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "SvelteKit router adapter for XMachines Universal Player Architecture",
   "keywords": [
     "adapter",
@@ -40,38 +40,38 @@
   "scripts": {
     "build": "vite build && tsc --build",
     "lint": "oxlint .",
+    "lint:security": "node ../../scripts/semgrep-scan.mjs",
     "format": "oxfmt .",
     "test": "vitest",
     "test:coverage": "vitest run --coverage",
     "clean": "rm -rf dist *.tsbuildinfo coverage .vitest-attachments node_modules/.svelte2tsx-* node_modules/.vite*"
   },
   "dependencies": {
-    "@xmachines/play": "3.0.0",
-    "@xmachines/play-actor": "3.0.0",
-    "@xmachines/play-router": "3.0.0",
-    "@xmachines/play-signals": "3.0.0"
+    "@xmachines/play-router": "4.0.0"
   },
   "devDependencies": {
-    "@sveltejs/kit": "^2.70.2",
-    "@sveltejs/vite-plugin-svelte": "^7.0.0",
-    "@testing-library/jest-dom": "^6.9.1",
-    "@types/node": "^26.2.0",
-    "@vitest/browser-playwright": "^4.1.11",
-    "@xmachines/play-svelte": "3.0.0",
-    "oxfmt": "^0.64.0",
-    "oxlint": "^1.79.0",
-    "svelte": "^5.55.5",
+    "@sveltejs/kit": "^2.70.3",
+    "@sveltejs/vite-plugin-svelte": "^7.3.0",
+    "@testing-library/jest-dom": "^7.0.1",
+    "@types/node": "^26.6.2",
+    "@vitest/browser-playwright": "^5.0.1",
+    "@xmachines/play": "4.0.0",
+    "@xmachines/play-actor": "4.0.0",
+    "@xmachines/play-signals": "4.0.0",
+    "@xmachines/play-svelte": "4.0.0",
+    "oxfmt": "^0.68.0",
+    "oxlint": "^1.83.0",
+    "svelte": "^5.57.0",
     "typescript": "^5.9.3 || ^6.0.3",
-    "vite": "^8.0.10",
-    "vitest": "^4.1.11",
-    "xstate": "^5.31.0"
+    "vite": "^8.3.0",
+    "vitest": "^5.0.1",
+    "xstate": "^5.33.0"
   },
   "peerDependencies": {
     "@sveltejs/kit": "^2.0.0",
-    "svelte": "^5.0.0",
-    "xstate": "^5.31.0"
+    "svelte": "^5.0.0"
   },
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=24.0.0"
   }
 }