npm - @xmachines/docs - Versions diffs - 1.0.0-beta.52 → 1.0.0-beta.54 - Mend

@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (442) hide show

package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: PlayUIProviderProps
-Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/types.ts#L25)
+Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/types.ts#L25)
 Props for the ActorProvider component.
 Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
@@ -15,10 +15,10 @@ Extracted to types.ts so TypeScript can re-export without the vue-shim limitatio
 | Property                                                         | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                 | Inherited from                                                                                                  | Defined in                                                                                                                                                       |
 | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                              | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L154) |
-| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, (`args?`, `state?`) => `unknown`\>                                                                                                                                                                                                           | Named functions for $computed expressions in props                                                                                                                                                                          | -                                                                                                               | [packages/play-vue/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/types.ts#L34)                         |
-| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                                                                                                                                                                               | Navigate function forwarded to JSONUIProvider for link resolution                                                                                                                                                           | -                                                                                                               | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/types.ts#L27)                         |
-| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L167) |
-| <a id="property-registryresult"></a> `registryResult`            | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L156) |
-| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L162) |
-| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Validation functions forwarded to JSONUIProvider                                                                                                                                                                            | -                                                                                                               | [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/types.ts#L29)                         |
+| <a id="property-actor"></a> `actor`                              | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L154) |
+| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, (`args?`, `state?`) => `unknown`\>                                                                                                                                                                                                           | Named functions for $computed expressions in props                                                                                                                                                                          | -                                                                                                               | [packages/play-vue/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/types.ts#L34)                         |
+| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                                                                                                                                                                               | Navigate function forwarded to JSONUIProvider for link resolution                                                                                                                                                           | -                                                                                                               | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/types.ts#L27)                         |
+| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L167) |
+| <a id="property-registryresult"></a> `registryResult`            | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L156) |
+| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L162) |
+| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Validation functions forwarded to JSONUIProvider                                                                                                                                                                            | -                                                                                                               | [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/types.ts#L29)                         |

package/api/@xmachines/play-vue/interfaces/RendererProps.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RendererProps
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Props for the Renderer component

package/api/@xmachines/play-vue/interfaces/StateProviderProps.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: StateProviderProps
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Props for StateProvider

package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: ValidationProviderProps
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 ## Properties

package/api/@xmachines/play-vue/interfaces/ViewContextValue.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: ViewContextValue
-Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/actor-provider-context.ts#L21)
+Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/actor-provider-context.ts#L21)
 Context value provided by ActorProvider and consumed by PlayRenderer (zero-prop leaf).
 Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree.
@@ -15,7 +15,7 @@ Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree
 | Property                                  | Type                                                  | Description                                                                                               | Inherited from                                                                                                                                                    | Defined in                                                                                                                                                       |
 | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\>                 | Action handlers resolved against the live StateStore.                                                     | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L122) |
-| <a id="property-registry"></a> `registry` | `ComponentRegistry`                                   | Component registry from registryResult.registry.                                                          | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L124) |
-| <a id="property-spec"></a> `spec`         | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render.                                                                           | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec)         | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L120) |
-| <a id="property-store"></a> `store`       | `StateStore`                                          | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store)       | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L126) |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\>                 | Action handlers resolved against the live StateStore.                                                     | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L122) |
+| <a id="property-registry"></a> `registry` | `ComponentRegistry`                                   | Component registry from registryResult.registry.                                                          | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L124) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render.                                                                           | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec)         | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L120) |
+| <a id="property-store"></a> `store`       | `StateStore`                                          | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store)       | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L126) |

package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md CHANGED Viewed

@@ -2,4 +2,4 @@
 # Interface: VisibilityProviderProps
-Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/types.ts#L23)
+Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/types.ts#L23)

package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md CHANGED Viewed

@@ -6,6 +6,6 @@
 type AnyPlayActor = AbstractActor<AnyActorLogic>;
 ```
-Defined in: [packages/play-vue/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/useActor.ts#L27)
+Defined in: [packages/play-vue/src/useActor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/useActor.ts#L41)
 Bare actor type accepted by Vue context providers. For the full routing + view shape, use `PlayActor` from `@xmachines/play-router`.

package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
 ```
-Defined in: [packages/play-vue/src/define-registry.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/define-registry.ts#L105)
+Defined in: [packages/play-vue/src/define-registry.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/define-registry.ts#L105)
 ## Type Parameters

package/api/@xmachines/play-vue/type-aliases/ComponentFn.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type ComponentFn<C, K> = (ctx) => VNode | VNode[] | null | string;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Component render function type for Vue

package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
 ```
-Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/define-registry.ts#L109)
+Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/define-registry.ts#L109)
 ## Type Parameters

package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md CHANGED Viewed

@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
 	object;
 ```
-Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/define-registry.ts#L113)
+Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/define-registry.ts#L113)
 ## Type Declaration
 | Name          | Type                                       | Defined in                                                                                                                                                     |
 | ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/define-registry.ts#L117) |
+| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/define-registry.ts#L117) |
 ## Type Parameters

package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type RenderErrorHandler = (error, elementType) => void;
 ```
-Defined in: `@json-render/core`
+Defined in: `.pnpm`
 Callback invoked when an individual catalog component throws during render.
 Implemented by each framework renderer's error boundary / error capture mechanism.

package/api/@xmachines/play-vue/variables/ActionProvider.md CHANGED Viewed

@@ -59,6 +59,6 @@ const ActionProvider: vue.DefineComponent<
 >;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Provider for action execution

package/api/@xmachines/play-vue/variables/JSONUIProvider.md CHANGED Viewed

@@ -91,6 +91,6 @@ const JSONUIProvider: vue.DefineComponent<vue.ExtractPropTypes<{
 }, any>;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Combined provider for all JSONUI contexts

package/api/@xmachines/play-vue/variables/PlayRenderer.md CHANGED Viewed

@@ -6,4 +6,4 @@
 const PlayRenderer: DefineComponent<{}, {}, unknown>;
 ```
-Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/src/vue-shim.d.ts#L3)
+Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-vue/src/vue-shim.d.ts#L3)

package/api/@xmachines/play-vue/variables/Renderer.md CHANGED Viewed

@@ -74,6 +74,6 @@ const Renderer: vue.DefineComponent<
 >;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Main renderer component

package/api/@xmachines/play-vue/variables/StateProvider.md CHANGED Viewed

@@ -68,7 +68,7 @@ const StateProvider: vue.DefineComponent<
 >;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Provider for state model context.

package/api/@xmachines/play-vue/variables/ValidationProvider.md CHANGED Viewed

@@ -50,6 +50,6 @@ const ValidationProvider: vue.DefineComponent<
 >;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Provider for validation

package/api/@xmachines/play-vue/variables/VisibilityProvider.md CHANGED Viewed

@@ -35,6 +35,6 @@ const VisibilityProvider: vue.DefineComponent<
 >;
 ```
-Defined in: `@json-render/vue`
+Defined in: `.pnpm`
 Provider for visibility evaluation

package/api/@xmachines/play-vue-router/classes/RouteMap.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Class: RouteMap
-Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L100)
+Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L101)
 Shared bidirectional route map base class.
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
 - Results are cached after the first match in an LRU cache (default 500 entries,
   configurable via the `cacheSize` constructor option)
-**Pattern syntax** (`:param` / `:param?`):
+**Pattern syntax** (`:param` / `:param?` / `*`):
 - `:param` — required segment, matches exactly one non-`/` segment
 - `:param?` — optional segment, matches zero or one non-`/` segment
+- `*` — wildcard, matches any number of segments (URLPattern semantics)
+**StateId forms:** stateIds may be registered and looked up in either
+`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
+`getStateIdByPath` returns the stateId exactly as registered;
+`getPathByStateId` accepts both forms. Registering the same stateId in both
+forms refers to one entry (the later registration wins for reverse lookup).
 ## Example
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L127)
 Build a route map from an array of state ID ↔ path mappings.
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L218)
 Look up the path pattern registered for a state ID.
+Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
+which form was used at registration — lookups are canonicalized internally,
+so consumers never need to try both forms.
 #### Parameters
 | Parameter | Type     | Description                                               |
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
 ```typescript
 map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
 map.getPathByStateId("missing"); // null
 ```
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L178)
 Resolve a URL path to its mapped state ID.