ui-router-effect 0.0.0-stage → 0.1.0-rc.0

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2026-present Lit UI-Router Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# ui-router-effect
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Effect](https://effect.website) bindings for [UI-Router](https://ui-router.github.io): a framework-agnostic `SubscriptionRef` of the router's current state. It imports only `effect` and `@uirouter/core`.
+
+[`lit-ui-router-effect`](../lit-ui-router-effect/) holds the Lit controllers.
+
+## Features
+
+- **`routeRef(router)`**: a `SubscriptionRef<RouteSnapshot>` of the current state, params and transition. There is one ref, and one `onSuccess` hook, per router, attached lazily on first use. Every value it holds is a settled route.
+- **`RouteSnapshot`** and **`snapshotRoute(router, transition?)`**: the value the ref holds. Its `includes()` evaluates `StateService.includes` against the snapshot, not the live router.
+
+## Usage
+
+```typescript
+import { Effect, Stream } from 'effect';
+import { routeRef } from 'ui-router-effect';
+
+const names = routeRef(router).changes.pipe(
+  Stream.map((route) => route.current?.name),
+  Stream.changes,
+);
+
+Effect.runFork(Stream.runForEach(names, (name) => Effect.log(name)));
+```
+
+## Dependencies
+
+`@uirouter/core` and `effect` are peer dependencies. `lit` and `lit-ui-router` are not, and the `bundleProbe` claim in `package.json` holds the entry free of them.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { routeRef } from "./route-ref.js";
+export { type RouteSnapshot, snapshotRoute } from "./shared/route-snapshot.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","mappings":"AAAA,SAAS,gBAAgB;AAEzB,cAAc,eAAe,qBAAqB","names":[],"ignoreList":[],"sources":["../src/index.ts"]}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { routeRef } from "./route-ref.js";
+export { snapshotRoute } from "./shared/route-snapshot.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","mappings":"AAAA,SAAS,gBAAgB;AAEzB,SAA6B,qBAAqB","names":[],"ignoreList":[],"sources":["../src/index.ts"]}

package/dist/route-ref.d.ts

@@ -0,0 +1,13 @@
+import { SubscriptionRef } from "effect";
+import { UIRouter } from "@uirouter/core";
+import { RouteSnapshot } from "./shared/route-snapshot.js";
+/**
+* The route ref for a router — one per router instance, attached lazily.
+*
+* No plugin and no router-configuration wiring: the first caller creates the
+* ref and registers the single `onSuccess` hook that feeds it, and both live
+* as long as the router does. `onSuccess` is the only hook a later transition
+* cannot supersede, so every value the ref ever holds is a settled route.
+*/
+export declare function routeRef(router: UIRouter): SubscriptionRef.SubscriptionRef<RouteSnapshot>;
+//# sourceMappingURL=route-ref.d.ts.map

package/dist/route-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-ref.d.ts","mappings":"AAAA,SAAiB,uBAAuB;AACxC,SAAS,gBAAgB;AAEzB,SAAS,qBAAoC;;;;;;;;;AAe7C,OAAO,iBAAS,SACd,QAAQ,WACP,gBAAgB,gBAAgB","names":[],"ignoreList":[],"sources":["../src/route-ref.ts"]}

package/dist/route-ref.js

@@ -0,0 +1,14 @@
+import { Effect, SubscriptionRef } from "effect";
+import { snapshotRoute } from "./shared/route-snapshot.js";
+const routeRefs = new WeakMap();
+export function routeRef(router) {
+	const existing = routeRefs.get(router);
+	if (existing) return existing;
+	const ref = Effect.runSync(SubscriptionRef.make(snapshotRoute(router)));
+	routeRefs.set(router, ref);
+	router.transitionService.onSuccess({}, (transition) => {
+		Effect.runSync(SubscriptionRef.set(ref, snapshotRoute(router, transition)));
+	});
+	return ref;
+}
+//# sourceMappingURL=route-ref.js.map

package/dist/route-ref.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-ref.js","mappings":"AAAA,SAAS,QAAQ,uBAAuB;AAGxC,SAAwB,qBAAqB;AAE7C,MAAM,YAAY,IAAI,QAGpB;AAUF,OAAO,SAAS,SACd,QACgD;CAChD,MAAM,WAAW,UAAU,IAAI,MAAM;CAErC,IAAI,UAAU,OAAO;CACrB,MAAM,MAAM,OAAO,QAAQ,gBAAgB,KAAK,cAAc,MAAM,CAAC,CAAC;CACtE,UAAU,IAAI,QAAQ,GAAG;CACzB,OAAO,kBAAkB,UAAU,CAAC,IAAI,eAAe;EACrD,OAAO,QAAQ,gBAAgB,IAAI,KAAK,cAAc,QAAQ,UAAU,CAAC,CAAC;CAC5E,CAAC;CAED,OAAO;AACT","names":[],"ignoreList":[],"sources":["../src/route-ref.ts"]}

package/dist/shared/route-snapshot.d.ts

@@ -0,0 +1,25 @@
+import { RawParams, StateDeclaration, StateOrName, Transition, UIRouter } from "@uirouter/core";
+/**
+* The router's current state as one immutable value, for a reactive cell to hold.
+*
+* Taken once per successful transition; every field, `includes()` included,
+* answers for that moment. A selector asking during a later transition gets
+* the settled answer, not the in-flight one.
+*/
+export interface RouteSnapshot {
+	/** The current state declaration (`globals.current`). */
+	readonly current: StateDeclaration | undefined;
+	/** The current parameter values (`globals.params`), replaced per transition. */
+	readonly params: RawParams;
+	/** The transition that produced this snapshot; `undefined` before the first. */
+	readonly transition: Transition | undefined;
+	/**
+	* `StateService.includes` evaluated against this snapshot: is the state (or
+	* glob pattern, e.g. `'admin.**'`) included in the snapshot's active state,
+	* with these parameter values?
+	*/
+	includes(stateOrName: StateOrName, params?: RawParams): boolean;
+}
+/** The snapshot of a router right now; `StateService.includes` minus the live reads. */
+export declare function snapshotRoute(router: UIRouter, transition?: Transition | undefined): RouteSnapshot;
+//# sourceMappingURL=route-snapshot.d.ts.map

package/dist/shared/route-snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-snapshot.d.ts","mappings":"AAAA,SAIE,WACA,kBACA,aACA,YACA,gBACK;;;;;;;;AASP,iBAAiB,cAAc;;UAEpB,SAAS;;UAGT,QAAQ;;UAGR,YAAY;;;;;;CAOrB,SAAS,aAAa,aAAa,SAAS;AAC9C;;AAGA,OAAO,iBAAS,cACd,QAAQ,UACR,aACI,yBAEH","names":[],"ignoreList":[],"sources":["../../../shared/route-snapshot/src/route-snapshot.ts"],"sourcesContent":["import {\n  Glob,\n  isString,\n  Param,\n  RawParams,\n  StateDeclaration,\n  StateOrName,\n  Transition,\n  UIRouter,\n} from '@uirouter/core';\n\n/**\n * The router's current state as one immutable value, for a reactive cell to hold.\n *\n * Taken once per successful transition; every field, `includes()` included,\n * answers for that moment. A selector asking during a later transition gets\n * the settled answer, not the in-flight one.\n */\nexport interface RouteSnapshot {\n  /** The current state declaration (`globals.current`). */\n  readonly current: StateDeclaration | undefined;\n\n  /** The current parameter values (`globals.params`), replaced per transition. */\n  readonly params: RawParams;\n\n  /** The transition that produced this snapshot; `undefined` before the first. */\n  readonly transition: Transition | undefined;\n\n  /**\n   * `StateService.includes` evaluated against this snapshot: is the state (or\n   * glob pattern, e.g. `'admin.**'`) included in the snapshot's active state,\n   * with these parameter values?\n   */\n  includes(stateOrName: StateOrName, params?: RawParams): boolean;\n}\n\n/** The snapshot of a router right now; `StateService.includes` minus the live reads. */\nexport function snapshotRoute(\n  router: UIRouter,\n  transition:\n    | Transition\n    | undefined = router.globals.successfulTransitions.peekTail(),\n): RouteSnapshot {\n  const { $current, current } = router.globals;\n  // eslint-disable-next-line typescript/no-misused-spread -- snapshot StateParams' own props as a fresh plain object per transition\n  const params: RawParams = { ...router.globals.params };\n  const { matcher } = router.stateRegistry;\n\n  return {\n    current,\n    params,\n    transition,\n    includes(stateOrName, values) {\n      let target = stateOrName;\n\n      if (isString(stateOrName) && Glob.is(stateOrName)) {\n        if (!Glob.fromString(stateOrName).matches($current.name)) return false;\n        target = $current.name;\n      }\n\n      // SAFETY: `find` returns undefined for an unregistered state, which its signature omits.\n      const state = matcher.find(target, $current) as\n        | ReturnType<typeof matcher.find>\n        | undefined;\n\n      if (!state || !$current.includes[state.name]) return false;\n\n      if (!values) return true;\n      const schema = state.parameters({ inherit: true, matchingKeys: values });\n\n      return Param.equals(schema, Param.values(schema, params), values);\n    },\n  };\n}\n"]}

package/dist/shared/route-snapshot.js

@@ -0,0 +1,27 @@
+import { Glob, isString, Param } from "@uirouter/core";
+export function snapshotRoute(router, transition = router.globals.successfulTransitions.peekTail()) {
+	const { $current, current } = router.globals;
+	const params = { ...router.globals.params };
+	const { matcher } = router.stateRegistry;
+	return {
+		current,
+		params,
+		transition,
+		includes(stateOrName, values) {
+			let target = stateOrName;
+			if (isString(stateOrName) && Glob.is(stateOrName)) {
+				if (!Glob.fromString(stateOrName).matches($current.name)) return false;
+				target = $current.name;
+			}
+			const state = matcher.find(target, $current);
+			if (!state || !$current.includes[state.name]) return false;
+			if (!values) return true;
+			const schema = state.parameters({
+				inherit: true,
+				matchingKeys: values
+			});
+			return Param.equals(schema, Param.values(schema, params), values);
+		}
+	};
+}
+//# sourceMappingURL=route-snapshot.js.map

package/dist/shared/route-snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-snapshot.js","mappings":"AAAA,SACE,MACA,UACA,aAMK;AA4BP,OAAO,SAAS,cACd,QACA,aAEgB,OAAO,QAAQ,sBAAsB,SAAS,GAC/C;CACf,MAAM,EAAE,UAAU,YAAY,OAAO;CAErC,MAAM,SAAoB,EAAE,GAAG,OAAO,QAAQ,OAAO;CACrD,MAAM,EAAE,YAAY,OAAO;CAE3B,OAAO;EACL;EACA;EACA;EACA,SAAS,aAAa,QAAQ;GAC5B,IAAI,SAAS;GAEb,IAAI,SAAS,WAAW,KAAK,KAAK,GAAG,WAAW,GAAG;IACjD,IAAI,CAAC,KAAK,WAAW,WAAW,CAAC,CAAC,QAAQ,SAAS,IAAI,GAAG,OAAO;IACjE,SAAS,SAAS;GACpB;GAGA,MAAM,QAAQ,QAAQ,KAAK,QAAQ,QAAQ;GAI3C,IAAI,CAAC,SAAS,CAAC,SAAS,SAAS,MAAM,OAAO,OAAO;GAErD,IAAI,CAAC,QAAQ,OAAO;GACpB,MAAM,SAAS,MAAM,WAAW;IAAE,SAAS;IAAM,cAAc;GAAO,CAAC;GAEvE,OAAO,MAAM,OAAO,QAAQ,MAAM,OAAO,QAAQ,MAAM,GAAG,MAAM;EAClE;CACF;AACF","names":[],"ignoreList":[],"sources":["../../../shared/route-snapshot/src/route-snapshot.ts"],"sourcesContent":["import {\n  Glob,\n  isString,\n  Param,\n  RawParams,\n  StateDeclaration,\n  StateOrName,\n  Transition,\n  UIRouter,\n} from '@uirouter/core';\n\n/**\n * The router's current state as one immutable value, for a reactive cell to hold.\n *\n * Taken once per successful transition; every field, `includes()` included,\n * answers for that moment. A selector asking during a later transition gets\n * the settled answer, not the in-flight one.\n */\nexport interface RouteSnapshot {\n  /** The current state declaration (`globals.current`). */\n  readonly current: StateDeclaration | undefined;\n\n  /** The current parameter values (`globals.params`), replaced per transition. */\n  readonly params: RawParams;\n\n  /** The transition that produced this snapshot; `undefined` before the first. */\n  readonly transition: Transition | undefined;\n\n  /**\n   * `StateService.includes` evaluated against this snapshot: is the state (or\n   * glob pattern, e.g. `'admin.**'`) included in the snapshot's active state,\n   * with these parameter values?\n   */\n  includes(stateOrName: StateOrName, params?: RawParams): boolean;\n}\n\n/** The snapshot of a router right now; `StateService.includes` minus the live reads. */\nexport function snapshotRoute(\n  router: UIRouter,\n  transition:\n    | Transition\n    | undefined = router.globals.successfulTransitions.peekTail(),\n): RouteSnapshot {\n  const { $current, current } = router.globals;\n  // eslint-disable-next-line typescript/no-misused-spread -- snapshot StateParams' own props as a fresh plain object per transition\n  const params: RawParams = { ...router.globals.params };\n  const { matcher } = router.stateRegistry;\n\n  return {\n    current,\n    params,\n    transition,\n    includes(stateOrName, values) {\n      let target = stateOrName;\n\n      if (isString(stateOrName) && Glob.is(stateOrName)) {\n        if (!Glob.fromString(stateOrName).matches($current.name)) return false;\n        target = $current.name;\n      }\n\n      // SAFETY: `find` returns undefined for an unregistered state, which its signature omits.\n      const state = matcher.find(target, $current) as\n        | ReturnType<typeof matcher.find>\n        | undefined;\n\n      if (!state || !$current.includes[state.name]) return false;\n\n      if (!values) return true;\n      const schema = state.parameters({ inherit: true, matchingKeys: values });\n\n      return Param.equals(schema, Param.values(schema, params), values);\n    },\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "ui-router-effect",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0-rc.0",
+  "description": "Effect bindings for UI-Router: a framework-agnostic SubscriptionRef of the router's current state",
+  "homepage": "https://lit-ui-router.dev/packages/ui-router-effect",
+  "bugs": {
+    "url": "https://github.com/simshanith/lit-ui-router/issues"
+  },
+  "license": "MIT",
+  "author": "Shane Daniel",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/simshanith/lit-ui-router.git",
+    "directory": "packages/ui-router-effect"
+  },
+  "files": [
+    "dist/**",
+    "!dist/.*/**",
+    "src/*.ts"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@uirouter/core": "^6.0.8",
+    "effect": "^3.22.0 || ^4.0.2"
+  },
+  "bundleProbe": {
+    ".": {
+      "free": [
+        "lit",
+        "lit-ui-router"
+      ]
+    }
+  }
 }

package/src/index.ts

@@ -0,0 +1,3 @@
+export { routeRef } from './route-ref.js';
+
+export { type RouteSnapshot, snapshotRoute } from '@repo/route-snapshot';

package/src/route-ref.ts

@@ -0,0 +1,32 @@
+import { Effect, SubscriptionRef } from 'effect';
+import { UIRouter } from '@uirouter/core';
+
+import { RouteSnapshot, snapshotRoute } from '@repo/route-snapshot';
+
+const routeRefs = new WeakMap<
+  UIRouter,
+  SubscriptionRef.SubscriptionRef<RouteSnapshot>
+>();
+
+/**
+ * The route ref for a router — one per router instance, attached lazily.
+ *
+ * No plugin and no router-configuration wiring: the first caller creates the
+ * ref and registers the single `onSuccess` hook that feeds it, and both live
+ * as long as the router does. `onSuccess` is the only hook a later transition
+ * cannot supersede, so every value the ref ever holds is a settled route.
+ */
+export function routeRef(
+  router: UIRouter,
+): SubscriptionRef.SubscriptionRef<RouteSnapshot> {
+  const existing = routeRefs.get(router);
+
+  if (existing) return existing;
+  const ref = Effect.runSync(SubscriptionRef.make(snapshotRoute(router)));
+  routeRefs.set(router, ref);
+  router.transitionService.onSuccess({}, (transition) => {
+    Effect.runSync(SubscriptionRef.set(ref, snapshotRoute(router, transition)));
+  });
+
+  return ref;
+}