@xmachines/docs 1.0.0-beta.9 → 1.1.0

package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md

@@ -1,201 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueBaseRouteMap
-
-# Class: VueBaseRouteMap
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L28)
-
-VueBaseRouteMap — intermediate base class for Vue Router adapters.
-
-Extends `BaseRouteMap` (bucket-indexed O(k) pattern matching + QuickLRU 500-entry
-cache) and adds the Vue-specific adapter layer: `routeName` ↔ `stateId` bidirectional
-lookup and optional URL pattern access.
-
-**Why a separate base class?** Vue Router uses named routes (`routeName`) rather than
-URL paths for navigation. `BaseRouteMap` operates on path strings; `VueBaseRouteMap`
-bridges the two by translating `RouteMapping` entries at construction time — only
-mappings with a `pattern` field participate in URL path resolution via `BaseRouteMap`.
-
-Exported from `@xmachines/play-vue-router` for consumers who need to extend or test
-the Vue routing layer directly. Most consumers use `RouteMap` instead.
-
-## Example
-
-```typescript
-import { VueBaseRouteMap } from "@xmachines/play-vue-router";
-
-class MyVueRouteMap extends VueBaseRouteMap {
-	// add custom resolution logic
-}
-```
-
-## Extends
-
-- [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md)
-
-## Extended by
-
-- [`RouteMap`](RouteMap.md)
-
-## Constructors
-
-### Constructor
-
-```ts
-new VueBaseRouteMap(mappings): VueBaseRouteMap;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L32)
-
-#### Parameters
-
-| Parameter  | Type                                              |
-| ---------- | ------------------------------------------------- |
-| `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[] |
-
-#### Returns
-
-`VueBaseRouteMap`
-
-#### Overrides
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`constructor`](../../play-router/classes/BaseRouteMap.md#constructor)
-
-## Methods
-
-### getPathByStateId()
-
-```ts
-getPathByStateId(stateId): string | null;
-```
-
-Defined in: play-router/dist/base-route-map.d.ts:111
-
-Look up the path pattern registered for a state ID.
-
-#### Parameters
-
-| Parameter | Type     | Description                                               |
-| --------- | -------- | --------------------------------------------------------- |
-| `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
-
-#### Returns
-
-`string` \| `null`
-
-The registered path pattern, or `null` if the state ID is unknown
-
-#### Example
-
-```typescript
-map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("missing"); // null
-```
-
-#### Inherited from
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getPathByStateId`](../../play-router/classes/BaseRouteMap.md#getpathbystateid)
-
----
-
-### getPattern()
-
-```ts
-getPattern(stateId): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L58)
-
-Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `stateId` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
----
-
-### getRouteName()
-
-```ts
-getRouteName(stateId): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L48)
-
-Get the Vue Router route name for a given state ID.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `stateId` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
----
-
-### getStateId()
-
-```ts
-getStateId(routeName): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L53)
-
-Get the state ID for a given Vue Router route name.
-
-#### Parameters
-
-| Parameter   | Type     |
-| ----------- | -------- |
-| `routeName` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
----
-
-### getStateIdByPath()
-
-```ts
-getStateIdByPath(path): string | null;
-```
-
-Defined in: play-router/dist/base-route-map.d.ts:98
-
-Resolve a URL path to its mapped state ID.
-
-Strips query strings and hash fragments before matching. Tries an O(1) exact
-lookup first, then falls back to bucket-indexed pattern matching. Results are
-cached after the first pattern match.
-
-#### Parameters
-
-| Parameter | Type     | Description                                                                    |
-| --------- | -------- | ------------------------------------------------------------------------------ |
-| `path`    | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
-
-#### Returns
-
-`string` \| `null`
-
-The mapped state ID, or `null` if no route matches
-
-#### Example
-
-```typescript
-map.getStateIdByPath("/profile/123"); // "profile"
-map.getStateIdByPath("/unknown"); // null
-```
-
-#### Inherited from
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getStateIdByPath`](../../play-router/classes/BaseRouteMap.md#getstateidbypath)

package/api/@xmachines/play-vue-router-demo/README.md

@@ -1,133 +0,0 @@
-[Documentation](../../README.md) / @xmachines/play-vue-router-demo
-
-# Vue Router Demo
-
-Vue Router integration demonstrating Play Architecture with Vue Composition API.
-
-## What This Demonstrates
-
-- Shared auth machine reused without framework-specific business logic
-- `PlayVueRouterProvider` renderer-based integration with Vue Router
-- Shell-driven rendering via `PlayRenderer` with actor-authoritative navigation
-- Vue Composition API mapping to TC39 Signals lifecycle
-- Non-browser invariant tests plus browser E2E coverage
-
-## Running the Demo
-
-From the repository root:
-
-```bash
-npm install
-npm run dev -w packages/play-vue-router/examples/demo
-```
-
-Visit `http://localhost:5173`.
-
-## Step-by-Step Code Flow
-
-Use this order to understand how the demo is wired:
-
-1. `src/main.ts` creates the actor via `definePlayer({ machine: authMachine, catalog })`.
-2. `src/router.ts` installs one catch-all route; `PlayRenderer` selects the actual view from actor state.
-3. `src/App.vue` uses `PlayVueRouterProvider` + `createRouteMap(authMachine)` with a renderer function to connect router navigation and actor routing events.
-4. Provider waits for `router.isReady()` so direct URL loads are handled correctly.
-5. `src/Shell.vue` renders actor-projected state (`PlayRenderer`) and sends events back to the actor.
-6. Browser tests in `test/browser/` validate startup and auth route transitions.
-
-```ts
-// src/main.ts (shape)
-const createPlayer = definePlayer({ machine: authMachine, catalog });
-const actor = createPlayer();
-actor.start();
-
-const app = createApp(App);
-app.provide("actor", actor);
-app.use(router);
-app.mount("#app");
-```
-
-```ts
-// src/router.ts (shape)
-export const routes = [{ path: "/:pathMatch(.*)*", name: "xmachines-play", component: RouteHost }];
-```
-
-```ts
-// src/App.vue (renderer shape)
-const renderShell = (currentActor, currentRouter) =>
-	h(Shell, {
-		actor: currentActor,
-		router: currentRouter,
-	});
-```
-
-```vue
-<!-- src/components/Login.vue (shape) -->
-<script setup lang="ts">
-const actor = inject("actor")!;
-const login = () => actor.send({ type: "auth.login", username: "demo" });
-</script>
-```
-
-## Key Files
-
-- `src/main.ts` - actor creation/start and app mount
-- `src/router.ts` - single catch-all route record
-- `src/App.vue` - provider wiring and renderer composition
-- `src/Shell.vue` - actor-driven demo shell with nav, renderer, and debug panel
-- `src/components/` - route and page view components
-- `test/browser/startup.browser.test.ts` - startup check for home + login link rendering
-- `test/browser/auth-flow.browser.test.ts` - login -> dashboard -> profile -> logout browser flow
-- `test/reactivity.test.ts` - reactive integration assertions
-
-## State Machine & Architecture Details
-
-The demo utilizes XMachines architectural invariants:
-
-1. **Actor Authority:** When a user navigates to a protected route via a link, Vue Router updates the location. The `PlayVueRouterProvider` intercepts this, translates it to a `play.route` event, and sends it to the actor. The actor evaluates guards (e.g. `isAuthenticated`) and transitions.
-2. **Passive Infrastructure:** The router does not execute Vue route guards for business logic. The actor dictates whether navigation is permitted. The Vue application only renders the state.
-3. **Signal-Only Reactivity:** The bridge leverages Vue's `watch` and `triggerRef` internally to react precisely when signals update, without polluting the Vue component tree with reactive refs that hold business state.
-
-## Watcher Lifecycle and Cleanup Contract
-
-This demo uses the canonical watcher lifecycle:
-
-1. `notify`
-2. `queueMicrotask`
-3. `getPending()`
-4. Read actor signals and sync Vue-local render state
-5. Re-arm with `watch()`/`watch(...signals)`
-
-Notifications are one-shot, so re-arm is required. Teardown is explicit: provider/bridge cleanup must flow through `disconnect` and watcher `unwatch`, not GC-only assumptions. The `PlayVueRouterProvider` wires this seamlessly into the component's `onUnmounted` hook.
-
-## Adapter Boundaries
-
-Vue Router integration remains passive infrastructure. `RouterBridgeBase` owns shared synchronization policy and the Vue adapter is a thin framework port. Route extraction override strategies remain supported when teams need custom route-name mapping.
-
-## Available Scripts
-
-```bash
-npm run dev           # Start Vite dev server (default: http://localhost:5173)
-npm run build         # Build production assets
-npm run preview       # Preview production build locally
-npm run test          # Run unit/integration tests via Vitest
-npm run test:browser  # Run browser-mode tests via vitest.browser.config.ts
-```
-
-## Verification
-
-Use these checks from this directory:
-
-```bash
-npm run test
-npm run test:browser
-```
-
-Manual sanity check:
-
-1. Start with `npm run dev`.
-2. Open `http://localhost:5173`.
-3. Confirm login/logout transitions update both view and URL, and that accessing protected routes while logged out redirects properly.
-
-## Learn More
-
-- **[Vue Router Adapter README](../play-vue-router/README.md)** - Package-level API and bridge docs

package/api/@xmachines/play-xstate/functions/mergeViewProps.md

@@ -1,26 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / mergeViewProps
-
-# Function: mergeViewProps()
-
-```ts
-function mergeViewProps(view, context): Record<string, unknown>;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L115)
-
-Merge view metadata with context for props
-
-Per CONTEXT.md: "Merge meta.view with relevant context data for component props"
-
-## Parameters
-
-| Parameter | Type                                                                                  | Description                  |
-| --------- | ------------------------------------------------------------------------------------- | ---------------------------- |
-| `view`    | [`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md)                         | View metadata from meta.view |
-| `context` | \| [`ViewMergeContext`](../type-aliases/ViewMergeContext.md) \| `null` \| `undefined` | Machine context              |
-
-## Returns
-
-`Record`\<`string`, `unknown`\>
-
-Merged props object

package/api/@xmachines/play-xstate/functions/stateMatches.md

@@ -1,25 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / stateMatches
-
-# Function: stateMatches()
-
-```ts
-function stateMatches<TContext>(stateValue): Guard<TContext, PlayEvent>;
-```
-
-Defined in: [packages/play-xstate/src/guards/helpers.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/guards/helpers.ts#L75)
-
-## Type Parameters
-
-| Type Parameter | Default type                    |
-| -------------- | ------------------------------- |
-| `TContext`     | `Record`\<`string`, `unknown`\> |
-
-## Parameters
-
-| Parameter    | Type     |
-| ------------ | -------- |
-| `stateValue` | `string` |
-
-## Returns
-
-[`Guard`](../type-aliases/Guard.md)\<`TContext`, [`PlayEvent`](../../play/type-aliases/PlayEvent.md)\>

package/api/@xmachines/play-xstate/functions/validateComponentBinding.md

@@ -1,39 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / validateComponentBinding
-
-# Function: validateComponentBinding()
-
-```ts
-function validateComponentBinding(view, catalog): void;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-binding.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-binding.ts#L22)
-
-Validate component binding against catalog
-
-Per CONTEXT.md:
-
-- "Component references: String keys"
-- "Mismatch detection: Both compile-time (TypeScript) and runtime validation"
-
-## Parameters
-
-| Parameter | Type                                                          | Description                  |
-| --------- | ------------------------------------------------------------- | ---------------------------- |
-| `view`    | [`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md) | View metadata from meta.view |
-| `catalog` | [`Catalog`](../type-aliases/Catalog.md)                       | Component catalog            |
-
-## Returns
-
-`void`
-
-## Example
-
-```typescript
-const view = { component: "Dashboard", userId: "123" };
-validateComponentBinding(view, catalog);
-// Throws if 'Dashboard' not in catalog
-```
-
-## Throws
-
-Error if component not found in catalog

package/api/@xmachines/play-xstate/functions/validateViewProps.md

@@ -1,80 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / validateViewProps
-
-# Function: validateViewProps()
-
-Implementation — shared by both overloads
-
-## Call Signature
-
-```ts
-function validateViewProps<TCatalog>(componentName, props, catalog): ValidationResult;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L35)
-
-Validate view props against Zod schema — generic overload for typed catalogs
-
-When called with a typed catalog, `componentName` is constrained to `keyof TCatalog`.
-Malformed catalog entries or unknown component names produce compile-time errors
-rather than runtime failures.
-
-### Type Parameters
-
-| Type Parameter                                               | Description                        |
-| ------------------------------------------------------------ | ---------------------------------- |
-| `TCatalog` _extends_ [`Catalog`](../type-aliases/Catalog.md) | Catalog type (must extend Catalog) |
-
-### Parameters
-
-| Parameter       | Type                        | Description                                           |
-| --------------- | --------------------------- | ----------------------------------------------------- |
-| `componentName` | keyof `TCatalog` & `string` | Component name constrained to string keys of TCatalog |
-| `props`         | `unknown`                   | Props to validate                                     |
-| `catalog`       | `TCatalog`                  | Typed component catalog                               |
-
-### Returns
-
-[`ValidationResult`](../type-aliases/ValidationResult.md)
-
-Zod parse result
-
-## Call Signature
-
-```ts
-function validateViewProps(componentName, props, catalog): ValidationResult;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L64)
-
-Validate view props against Zod schema — base overload for untyped catalogs
-
-Per CONTEXT.md:
-
-- "Prop validation: At state entry"
-- "currentView derivation: Merge meta.view with relevant context data"
-
-Per RESEARCH.md Pattern 4: Use safeParse() for validation
-
-### Parameters
-
-| Parameter       | Type                                    | Description                    |
-| --------------- | --------------------------------------- | ------------------------------ |
-| `componentName` | `string`                                | Component name from catalog    |
-| `props`         | `unknown`                               | Props to validate              |
-| `catalog`       | [`Catalog`](../type-aliases/Catalog.md) | Component catalog with schemas |
-
-### Returns
-
-[`ValidationResult`](../type-aliases/ValidationResult.md)
-
-Zod parse result
-
-### Example
-
-```typescript
-const props = { userId: "123", stats: { logins: 5 } };
-const result = validateViewProps("Dashboard", props, catalog);
-if (!result.success) {
-	console.error(result.error);
-}
-```

package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md

@@ -1,16 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / CatalogEntry
-
-# Interface: CatalogEntry
-
-Defined in: [packages/play-xstate/src/catalog/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/types.ts#L9)
-
-UI component catalog entry with schema and component reference
-
-Per CONTEXT.md: String keys reference components, Zod schemas validate props
-
-## Properties
-
-| Property                                    | Type                   | Description                                    | Defined in                                                                                                                                                                               |
-| ------------------------------------------- | ---------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-component"></a> `component` | `unknown`              | React component (or other framework component) | [packages/play-xstate/src/catalog/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/types.ts#L13) |
-| <a id="property-schema"></a> `schema`       | `ZodType`\<`unknown`\> | Zod schema for component props                 | [packages/play-xstate/src/catalog/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/types.ts#L11) |

package/api/@xmachines/play-xstate/type-aliases/Catalog.md

@@ -1,21 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / Catalog
-
-# Type Alias: Catalog
-
-```ts
-type Catalog = Catalog | Record<string, CatalogEntry>;
-```
-
-Defined in: [packages/play-xstate/src/catalog/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/types.ts#L28)
-
-Component catalog mapping
-
-Re-export from @xmachines/play-catalog for consistent API.
-
-Supports two formats:
-
-- Direct Zod schemas: `Record<string, z.ZodType>` via defineCatalog()
-- CatalogEntry objects: `Record<string, CatalogEntry>` with { schema, component }
-
-PlayerActor accepts either format - if entry has 'schema' property, uses CatalogEntry pattern,
-otherwise treats as direct Zod schema.

package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md

@@ -1,17 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / ValidationResult
-
-# Type Alias: ValidationResult
-
-```ts
-type ValidationResult =
-	| {
-			data: Record<string, unknown>;
-			success: true;
-	  }
-	| {
-			error: z.ZodError | Error;
-			success: false;
-	  };
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L11)

package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md

@@ -1,35 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / ViewMergeContext
-
-# Type Alias: ViewMergeContext
-
-```ts
-type ViewMergeContext = object;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L5)
-
-## Indexable
-
-```ts
-[key: string]: unknown
-```
-
-## Properties
-
-### queryParams?
-
-```ts
-optional queryParams?: Record<string, unknown>;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L7)
-
----
-
-### routeParams?
-
-```ts
-optional routeParams?: Record<string, unknown>;
-```
-
-Defined in: [packages/play-xstate/src/catalog/validate-props.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/catalog/validate-props.ts#L6)

package/api/@xmachines/shared/functions/defineXmVitestConfig.md

@@ -1,29 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/shared](../README.md) / defineXmVitestConfig
-
-# Function: defineXmVitestConfig()
-
-```ts
-function defineXmVitestConfig(importMetaUrl, overrides): object;
-```
-
-Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/shared/src/index.ts#L10)
-
-Create a Vitest config with XMachines workspace defaults.
-
-This wrapper exposes the helper at the package top-level so API docs
-render it under `@xmachines/shared` instead of nested module pages.
-
-## Parameters
-
-| Parameter       | Type                            |
-| --------------- | ------------------------------- |
-| `importMetaUrl` | `string`                        |
-| `overrides`     | `Record`\<`string`, `unknown`\> |
-
-## Returns
-
-`object`
-
-| Name   | Type  | Defined in                                                                                                                                             |
-| ------ | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/shared/config/vitest.ts#L82) |

package/api/@xmachines/shared/functions/xmAliases.md

@@ -1,24 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/shared](../README.md) / xmAliases
-
-# Function: xmAliases()
-
-```ts
-function xmAliases(importMetaUrl): Record<string, string>;
-```
-
-Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/shared/src/index.ts#L20)
-
-Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
-
-This wrapper exposes the helper at the package top-level so API docs
-render it under `@xmachines/shared` instead of nested module pages.
-
-## Parameters
-
-| Parameter       | Type     |
-| --------------- | -------- |
-| `importMetaUrl` | `string` |
-
-## Returns
-
-`Record`\<`string`, `string`\>