@salsita-ai/sdk 0.50.0-develop.a49722158a → 0.50.0-develop.a8cf9ffd01

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/control-hooks.js

@@ -0,0 +1,44 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A toolbar for a selected base unit on the product, attached as \`htmlHotspot\` \`name: BaseToolbar\` with \`showWhen: [selected]\`. \`drawers\` is an \`attributeSelection\` instance on \`Base\`. A drawer layout or the removal that would break an invariant stays visible but disabled, with the reason as its tooltip.
+
+\`\`\`tsx
+// src/elements/BaseToolbar.tsx
+import { Button, Chip, Stack, Tooltip } from '@mui/material'
+
+const Toolbar = ({ base }: { readonly base: Base }) => {
+  const resolve = phx.frontend.useResolveLocalizable()
+  const drawers = phx.frontend.useAttributeSelection(base.id, 'drawers')
+  const removal = phx.frontend.useDeletedEntity(base.id)
+
+  return (
+    // Keeps presses on the toolbar from reaching the scene
+    <Stack direction="row" spacing={1} onPointerDown={event => event.stopPropagation()}>
+      {drawers.options.map(option => (
+        <Tooltip key={String(option.value)} title={option.hint ?? ''}>
+          <span>
+            <Chip
+              label={resolve(option.title)}
+              color={option.value === drawers.value ? 'primary' : 'default'}
+              disabled={option.disabled}
+              onClick={option.onSelect}
+            />
+          </span>
+        </Tooltip>
+      ))}
+      <Tooltip title={removal.hints ?? ''}>
+        <span>
+          <Button disabled={removal.disabled} onClick={removal.remove}>
+            Remove
+          </Button>
+        </span>
+      </Tooltip>
+    </Stack>
+  )
+}
+
+export default phx.frontend.createCustomPhoenixEntityElement('BaseToolbar', ({ entityId }) => {
+  // Narrow the untyped id to a Base before using the typed hooks
+  const base = phx.frontend.useCommittedState().entities.find(entity => entity.id === entityId)
+
+  return base?.type === 'Base' ? <Toolbar base={base} /> : <></>
+})
+\`\`\``;export const generatePhoenixControlHooksFeature=()=>e({path:"features/domain-controls/control-hooks.md",title:"Control hooks",summary:"The hooks of each control component, recipes and deletion, with arguments, return shapes and the dry-run contract; read when a custom element reads or writes a control.",whenToUse:"Read when a custom element reads or writes a control component: which hook serves which control, its arguments and return shape, and how it previews, commits and dry-runs. [Custom controls](custom-controls.md) covers where the element lives, how the layout mounts it and the write path for other changes.",capabilities:"### The contract\n\n- Call a hook with the entity's id and the instance name of its control component, plus optional `fixableViolations`, which only hides those violation types from hints. The single-instance hooks below throw when that entity has no such instance, a filtered-out one included.\n- Every option is dry-run in advance: `disabled` (or `error`) and `hint` follow [Violations](../state/violations.md), and the current option's `onSelect` does nothing. Each dry run runs every transformer and invariant ([Updates and dry runs](../state/updates.md)), so mount long option lists only while they are open.\n- Titles, descriptions and labels are localizable: resolve them with `phx.frontend.useResolveLocalizable()`.\n- The recipe and deletion hooks are typed with the project's entity ids: pass an id narrowed from the state, such as `base.id`, not an element's untyped `entityId`.\n\n### Pick a value\n\n- `phx.frontend.useAttributeSelection(entityId, name)` returns `{ value, options }`, each option `{ value, title, description, imageSrc, disabled, hint, onSelect }`: the spec's `label` and `img` arrive as `title` and `imageSrc`.\n- `phx.frontend.useSwatchSelection(entityId, name, [])`, whose third argument is required, returns `{ value, options }`, each `{ swatchKey, swatchName, color, thumbnailUrl, selected, disabled, hint, onClick }`.\n- `phx.frontend.useAttributeSwitch(entityId, name)` returns `{ state, onChange, disabled, hint }`: `state.value` is the boolean, and `onChange()` writes its opposite.\n- `phx.frontend.useChildEntitySelection(entityId, name)` returns `{ value, options }`, each `{ value, title, imageSrc, selected, error, hint, onSelect }`. `value` is the current child's id and `error` stands for `disabled`; it also throws when the current child is missing.\n- `phx.frontend.useDistanceDimensionSelection(entityId, name)` returns `{ value, valueWithUnit, unitLabel, options }`, each option `{ value, title, disabled, hint, onSelect }` with `title` formatted in the display unit.\n\n### Set a value continuously\n\n`phx.frontend.useDistanceDimension`, `phx.frontend.useGenericDimension`, `phx.frontend.useAngleDimension` and `phx.frontend.useTextValue` take `(entityId, name)` and return `{ value, hints, hasErrors, update, resolve }`, the numeric ones also `min` and `max`.\n\n- `update(value)` stages a preview that the scene renders; `resolve()` commits it, or rolls it back while it has errors. Call `update` on every change and `resolve` on release or blur, so a drag is one undo step.\n- Show `hints` when `hasErrors`. The numeric hooks always fill it, with the allowed range when nothing is wrong; `useTextValue` gives only the staged preview's hint, else `null`.\n- Distance: `value`, `min`, `max` and `update` use the display unit: the component's `displayUnit`, else the unit configurator users picked. `valueWithUnit`, `unitLabel`, `formatValue`, `parseValue` and `toDisplayUnit` format values and convert data-unit steps; `rollback()` drops the preview. `min` and `max` are `NaN` unless the component declares them.\n- Generic: `value`, `min` and `max` are rounded to the component's `decimalPlaces`, with its `unit` label. Angle: in the component's `unit`, degrees by default, with `unitLabel`.\n- Text: `update(event, text)` takes the text second, as MUI's `onChange` passes it.\n\n### Add, replace and delete\n\n- `phx.frontend.useGroupedRecipeOptions(entityId, instanceNames?)` returns one group per `childEntityRecipes` instance, `{ instanceName, label, description, recipes }`, each recipe `{ title, description, thumbnailUrl, disabled, tooltipTitle, handleClick }`. `phx.frontend.useReplaceEntityRecipeOptions(entityId, instanceNames?)` does the same for `replaceEntityRecipes`. Both return `[]` instead of throwing.\n- Recipes the element builds itself: `phx.frontend.useCookRecipes(parentId)` returns `cook(recipes, collection?)`, which returns `{ disabled, hints, create, recipes }`; `phx.frontend.useCookedRecipes(recipes, parentId, collection?)` cooks one memoized list. [Control components](control-components.md) explains `collection`.\n- Replace: `phx.frontend.useCookedReplaceRecipes(entityId, recipes, keepChildren?)` returns `{ disabled, hints, replace, recipes }` for one memoized list. `phx.frontend.useCookReplaceRecipes(entityId)` returns `cook(recipes, keepChildren?)` with the same result, for several lists.\n- Delete: `phx.frontend.useDeletedEntity(entityId)` returns `{ remove, disabled, hints }`; `phx.frontend.useDeleteEntity()` returns `(entityId) => { remove, disabled, hints }` for a list. Deleting removes the composed children too.",example:t,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- "Read and change the product" and "Put a control on the product" in `docs/layouts/custom-layout.mdx` — `useAttributeSelection` in a layout panel and in a hotspot.\n- `docs/controls/custom.mdx` — `useUpdatedControl` and `useCookedRecipes` in elements.\n- `docs/dimensions/input-controls/distance-slider.mdx`, `docs/dimensions/basic-concepts/dimension-unit-config.mdx` — the unit rules the distance hooks share.\n- "Controls" and "Recipes & Entity Creation" in `docs/phoenix/configurator-interface.mdx` — the main control, recipe and deletion hooks with a sample call each.',phxMembers:["frontend.useAttributeSelection","frontend.useSwatchSelection","frontend.useAttributeSwitch","frontend.useChildEntitySelection","frontend.useDistanceDimensionSelection","frontend.useDistanceDimension","frontend.useGenericDimension","frontend.useAngleDimension","frontend.useTextValue","frontend.useGroupedRecipeOptions","frontend.useReplaceEntityRecipeOptions","frontend.useCookRecipes","frontend.useCookedRecipes","frontend.useCookReplaceRecipes","frontend.useCookedReplaceRecipes","frontend.useDeletedEntity","frontend.useDeleteEntity"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/custom-controls.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Building the project's own control elements: where they live, how the layout mounts them, and the write path. */
+export declare const generatePhoenixCustomControlsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/custom-controls.js

@@ -0,0 +1,74 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A desk panel the layout shows while a desk is selected, over the two control components of [Control components](control-components.md). A frame colour or a width that would break an invariant is disabled or shows its message while dragging, and the width rolls back on release.
+
+\`\`\`yaml
+# spec/controls.yaml
+components:
+  Desk:
+    attributeSelection:
+      frameColor:
+        value:
+          $bind: frameColor
+        options:
+          - { label: Grey, value: Grey }
+          - { label: Black, value: Black }
+    distanceDimension:
+      width:
+        min: 1200
+        max: 2000
+        value:
+          $bind: width
+\`\`\`
+
+\`\`\`tsx
+// src/_shared/DeskControls.tsx
+import { Button, Slider, Stack, Tooltip, Typography } from '@mui/material'
+
+export const DeskControls = ({ deskId }: { readonly deskId: Desk['id'] }) => {
+  const resolve = phx.frontend.useResolveLocalizable()
+  const frame = phx.frontend.useAttributeSelection(deskId, 'frameColor')
+  // value, min and max are in the display unit, not the data unit
+  const width = phx.frontend.useDistanceDimension(deskId, 'width')
+
+  return (
+    <Stack spacing={2}>
+      <Stack direction="row" spacing={1}>
+        {frame.options.map(option => (
+          <Tooltip key={String(option.value)} title={option.hint ?? ''}>
+            <span>
+              <Button
+                variant={option.value === frame.value ? 'contained' : 'outlined'}
+                disabled={option.disabled}
+                onClick={option.onSelect}
+              >
+                {resolve(option.title)}
+              </Button>
+            </span>
+          </Tooltip>
+        ))}
+      </Stack>
+      <Typography>Width {width.valueWithUnit}</Typography>
+      <Slider
+        aria-label="Width"
+        min={width.min}
+        max={width.max}
+        value={width.value}
+        onChange={(_event, value) => typeof value === 'number' && width.update(value)}
+        onChangeCommitted={() => width.resolve()}
+      />
+      {width.hasErrors && <Typography color="error">{width.hints}</Typography>}
+    </Stack>
+  )
+}
+\`\`\`
+
+\`\`\`tsx
+// In src/elements/ConfiguratorLayout.tsx, inside the layout's own panel
+import { DeskControls } from '../_shared/DeskControls.js'
+
+const DeskPanel = () => {
+  const deskId = phx.frontend.useSelectedEntityId(phx.domain.enhancedModel.$Desk)
+  const { accessInfo } = phx.frontend.useAccessService()
+
+  return deskId !== null && !accessInfo.viewMode ? <DeskControls deskId={deskId} /> : null
+}
+\`\`\``;export const generatePhoenixCustomControlsFeature=()=>e({path:"features/domain-controls/custom-controls.md",title:"Custom controls",summary:"The project's own React element per control: where the file lives, registering spec-named elements, mounting it for the selected entity, read mode and the write path; read when rendering a control component.",whenToUse:"Read when a control component needs its UI: a panel in the project layout, a control next to a part on the product, or a change no single control component makes. [Control hooks](control-hooks.md) lists the hooks by job; [Updates and dry runs](../state/updates.md) covers writing the store directly.",capabilities:"### One element per control\n\n- Render each control component with the project's own React element, built from its control hook ([Control hooks](control-hooks.md)): `phx.frontend.useAttributeSelection(entityId, 'frameColor')` for an `attributeSelection` instance named `frameColor`, and so on.\n- Take a typed entity id as a prop, such as `Desk['id']`. Entity types are global in a project, like `phx`.\n- Group the elements of one entity type in a panel component when the layout shows them together.\n\n### Where the file lives\n\n- **Rendered by the layout** — a plain component in an underscore folder, such as `src/_shared/DeskControls.tsx`, with a named export. The layout imports it with a relative `.js` path. It needs no registration: the control hooks work anywhere inside the `ConfiguratorLayout`.\n- **Named by the spec** — an element that an `htmlHotspot`, `sceneEntityObjectHtmlHotspot` or `sceneEntityControl` names ([Scene controls](scene-controls.md)). Default-export `phx.frontend.createCustomPhoenixEntityElement('Name', ({ entityId }) => …)` from `src/elements/`; a file may export an array of registrations instead. It must return an element, `<></>` for nothing.\n- Every file in `src/elements/` outside an underscore folder must default-export a registration, so keep plain components out of it. An unregistered name in the spec renders a red \"not found\" box.\n- A spec-named element receives only `entityId`, untyped: find the entity in `phx.frontend.useCommittedState().entities` and narrow it by `type` before reading fields or calling the typed hooks. An element registered under a built-in kind name, such as the FAB factories of [Scene controls](scene-controls.md), also receives that kind's YAML props.\n\n### Mount it from the layout\n\n- Read the selected entity with `phx.frontend.useSelectedEntityId(phx.domain.enhancedModel.$Desk)`: the id while a desk is selected, else `null`. With nothing selected the root counts as selected.\n- `phx.frontend.useRootEntityId()` gives the root's id for controls that always show.\n- Render the panel only for an id of the right type, and only while `phx.frontend.useAccessService().accessInfo.viewMode` is `false`: no hook enforces read mode.\n- Mirror any `$filter` of the control component in the same condition, since the hook throws while its instance is filtered out ([Control components](control-components.md)).\n- [Scene and safe area](../custom-layout/scene-and-safe-area.md) has the layout skeleton with such a panel.\n\n### Write anything else\n\nWhen no control hook fits, such as a change to several fields or entities, build the updates with `phx.frontend.updates` ([Updates and dry runs](../state/updates.md)) and let a hook dry-run them:\n\n- `phx.frontend.useUpdatedControl(updates)` returns `{ disabled, hints, update }` for one update list. Memoize the list: every new array is a new dry run.\n- `phx.frontend.useUpdateControl()` returns `prepare(updates)`, which returns the same for each candidate, such as one per button.\n- `update()` stages and commits in one step, one undo entry; `disabled` and `hints` follow [Violations](../state/violations.md). Both hooks take `fixableViolations`, which only hides those types from `hints`.\n- Run a domain action the same way: `prepare(phx.frontend.useDomain().actionSystem.prepareAction(name, args, state).updates)`, with `state` from `phx.frontend.useCommittedState()`. `prepareAction` throws on arguments it rejects, so catch it and show its message; [Actions](../domain-model/actions.md) owns them.\n\n```tsx\nconst control = prepare([\n  phx.frontend.updates.DomainEntityModification({\n    entityId: deskId,\n    stateDelta: { width: 1800, depth: 800 },\n    updateTag: 'desk.sizePreset',\n  }),\n])\n// <Button disabled={control.disabled} title={control.hints} onClick={control.update}>Large</Button>\n```\n\n### Look native\n\nThe project's element is the default. Inside it, the SDK's control components from `@salsita-ai/sdk/react`, such as `AttributeCardSelector` with `entityId` and `instanceName`, can render one control in the SDK's look, and `PropertyContainer` from `@salsita-ai/sdk/ui` gives section spacing and headings. None of these is on `phx`.",example:t,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- `docs/layouts/custom-layout.mdx` — "Read and change the product" (a control in the layout\'s panel, from `src/_shared/`) and "Put a control on the product" (a hotspot element).\n- `docs/controls/custom.mdx` — `useUpdatedControl` and `useCookedRecipes` in elements; skip its property-page attachment.\n- `docs/other-features/domain-actions.mdx` — "Run it from the UI": an action behind `useUpdateControl`.\n- "Updates Factory" in `docs/phoenix/configurator-interface.mdx` — `useUpdatedControl` and `useUpdateControl` with a worked element.',phxMembers:["frontend.createCustomPhoenixEntityElement","frontend.useUpdateControl","frontend.useUpdatedControl"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/domain-controls.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The domain controls index followed by its leaves. */
+export declare const generatePhoenixDomainControlsGuides: () => readonly PhoenixGuide[];

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/domain-controls.js

@@ -0,0 +1,8 @@
+import{createPhoenixIndexGuide as o}from"../../guide.js";import{generatePhoenixControlComponentsFeature as t}from"./control-components.js";import{generatePhoenixControlHooksFeature as e}from"./control-hooks.js";import{generatePhoenixCustomControlsFeature as n}from"./custom-controls.js";import{generatePhoenixSceneControlsFeature as s}from"./scene-controls.js";let r=`Domain controls let configurator users change the product. Each control has two halves:
+
+- A **control component** in YAML, such as \`attributeSelection\` or \`distanceDimension\`, attached to an entity under an instance name. It binds the value and its options to the model and defines no UI.
+- The project's own **React element**, which renders that component with a control hook. The project layout mounts it, such as in a panel for the selected entity, or the spec anchors it on the product.
+
+Every control dry-runs its options, so one that would break the configuration is disabled with the reason. The spec does not describe the page: the layout around the controls, its tabs, steps and messages, belongs to [Custom project layout](../custom-layout/index.md).
+
+Declare the component in Control components, build its element in Custom controls with the hooks of Control hooks, and use Scene controls for anchors, FABs and indicators on the product.`;export const generatePhoenixDomainControlsGuides=()=>{let c=[t(),n(),e(),s()];return[o({path:"features/domain-controls/index.md",title:"Domain controls",summary:"Controls that change the product: YAML control components, the project's React elements and their hooks, and in-scene controls; read when adding or changing how configurator users edit the product.",intro:r,guides:c,notes:[]}),...c]};

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/index.d.ts

@@ -0,0 +1 @@
+export * from './domain-controls.js';

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/index.js

@@ -0,0 +1 @@
+export*from"./domain-controls.js";

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/scene-controls.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** In-scene controls: hotspots, FABs, dimension indicators and 3D entity controls, and replacing the built-in look. */
+export declare const generatePhoenixSceneControlsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-controls/scene-controls.js

@@ -0,0 +1,48 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`Shelves with the SDK's in-scene controls, placed by the spec and restyled once for the brand. The delete FAB keeps its dry run: it is disabled with the reason while removing the shelf would break an invariant.
+
+\`\`\`yaml
+# spec/scene-controls.yaml
+components:
+  Cabinet:
+    sceneEntityAddFab:
+      shelves:
+        $filter:
+          modes: [owner]
+        instanceNames: [shelves]
+        skipMenuWhenOnlyOne: true
+        hideWhenNone: true
+        title: Add a shelf
+        offsetY: 900
+  Shelf:
+    sceneEntityDeleteFab:
+      main:
+        $filter:
+          modes: [owner]
+        title: Remove shelf
+        offsetY:
+          $eval: self.height + 40
+        hideWhileDragging: true
+\`\`\`
+
+\`\`\`tsx
+// src/elements/DeleteEntityFab.tsx
+import { Fab, Tooltip } from '@mui/material'
+
+export default phx.frontend.createDeleteEntityFab(({ onDelete, disabled, disabledHint, title }) => {
+  const resolve = phx.frontend.useResolveLocalizable()
+  const label = resolve(title) ?? 'Remove'
+
+  return (
+    <Tooltip title={disabledHint ?? label}>
+      {/* A disabled button fires no events, so the span carries the tooltip */}
+      <span>
+        <Fab size="small" color="primary" aria-label={label} disabled={disabled} onClick={onDelete}>
+          \xd7
+        </Fab>
+      </span>
+    </Tooltip>
+  )
+})
+\`\`\`
+
+\`onDelete\` already stops the click's propagation and records the built-in analytics event.`;export const generatePhoenixSceneControlsFeature=()=>e({path:"features/domain-controls/scene-controls.md",title:"Scene controls",summary:"Hotspots, FABs, editable dimension indicators and 3D entity controls, their placement, and replacing the built-in look; read when putting a control on the product.",whenToUse:"Read when configurator users should act on the product itself: select a part or go to a step from a hotspot, add or delete from a FAB, edit a dimension in the scene, switch tools, or open a project control next to a part. These controls write the same control components as the project's elements ([Control components](control-components.md)).",capabilities:"### Choose the control\n\n- **Select a part** — `sceneEntitySelectHotspot`. Selection itself belongs to [Selection and hover](../application-states/selection.md).\n- **Go to a navigation state** — `sceneEntityNavigationHotspot` with `navigationState` (required), `pushToStack` and `canStackOnto`; [Navigation states](../application-states/navigation.md) owns the stack.\n- **Add children** — `sceneEntityAddFab` offers the entity's `childEntityRecipes`: `instanceNames` narrows them, `skipMenuWhenOnlyOne` adds a single recipe directly, `hideWhenNone` hides an empty FAB, `label` and `icon` style it, and `hiddenViolations` drops those types from its hints.\n- **Delete the entity** — `sceneEntityDeleteFab` with `icon`, `title` and `label`, and `hiddenViolations` to drop those types from its hints.\n- **Switch tools** — `toolMenuFab` with `title` and `options` of `{ label, icon?, toolState }`; [View and tool states](../application-states/views-and-tools.md) owns tools.\n- **Edit a dimension on the product** — the editable indicators open an input for the component they target. `editableDistanceDimensionIndicator` (`targetDimension`, a `distanceDimension` instance), `listSelectorDimensionIndicator` (`targetDistanceDimensionSelect`) and `editableSizeIndicator` (`targetSize`) draw a dimension line from `startX/Y/Z` to `endX/Y/Z`. `editableAngleIndicator` targets an `angleDimension` and is placed by `positionX/Y/Z`, `startAngle` and `sweepAngle`.\n- `editableOffsetIndicator` has no start and end: it requires `targetOffset`, `targetEntityOffsetAnchors`, `targetReferenceOffsetAnchors` and `directionVector`. `dimensionIndicator`, `angleIndicator` and `offsetIndicator` only show the value.\n- **A project control on the product** — `htmlHotspot` with `name`, a project element ([Custom controls](custom-controls.md)), or `sceneEntityObjectHtmlHotspot` with `target`, a `sceneEntityRemoteObject` instance whose animation it follows, offsets in that object's local space and units.\n- **3D content on an entity** — `sceneEntityControl` with `name`: the element renders inside the WebGL scene, so it returns React Three Fiber objects, such as drei's `Billboard` and `Text`, not DOM. It stays out of camera fitting unless `includeInCameraFit: true`.\n\nPrefer the built-in control for its job and restyle it (below); an `htmlHotspot` is for a control the SDK has none of.\n\n### Place and show\n\n- `offsetX`, `offsetY` and `offsetZ` are measured from the entity's origin in the distance data unit; `screenOffsetHorizontal` and `screenOffsetVertical` shift the control in pixels. `$read` or `$eval` an offset that follows a size.\n- `showWhen` takes `selected` and `unselected`. Defaults: `[selected]` for the add and delete FABs, `[unselected]` for the selection and navigation hotspots and the tool menu; an `htmlHotspot` shows in both.\n- `hideWhileDragging` hides the control while an entity is dragged. `azimuthAngleLimits` and `polarAngleLimits` (radians) and `distanceLimits` fade it outside `{ min, max, smoothZone?, minOpacity? }`.\n- Give an icon-only FAB or hotspot a `title`; `tooltipVisibility` is `on-hover` (default), `forced`, `forced-when-still` or `hidden`.\n- `$filter` decides when the control exists: `modes: [owner]` keeps editing controls from viewers, `navigationStates` ties them to a step. [Components](../domain-model/components.md) owns filters.\n- `controlHotspot: true` on an `htmlHotspot` hides it while a change is previewed, so its dry runs never read a stale state; the add and delete FABs always behave so. It also unmounts an open popover on every change: leave it off for a hotspot whose menu stays open while users compare options. `inert: true` makes an `htmlHotspot` ignore the pointer.\n\n### Elements in the scene\n\n- In-scene elements get the theme and every `phx.frontend` hook; MUI popovers and tooltips work inside them.\n- Stop a click inside a project control from reaching the scene with `event.stopPropagation()`, or it also changes the selection. The `onDelete`, `onSelect` and `onNavigate` props below already do; a recipe's `handleClick` does not.\n- The scene's HTML sits under the layout's panels, so a covered control cannot be clicked.\n\n### Replace a built-in control's look\n\nEach helper registers the element the scene renders for one component, everywhere the spec places it, in the built-in layout and in a project layout. The spec keeps the position, visibility, filters and tooltip settings. Pass a component `(props) => JSX.Element | null` (`null` shows nothing) and default-export the registration, or an array of registrations, from a file in `src/elements/`:\n\n- `phx.frontend.createAddEntityFab(Component)` — replaces `AddEntityFab`, for `sceneEntityAddFab`. Props: `entityId`, `instanceNames`, `fixableViolations` (the spec's `hiddenViolations`), `icon`, `label`, `title`, `tooltipVisibility`, `skipMenuWhenOnlyOne`, `hideWhenNone`. It gets no recipes: read them with `phx.frontend.useGroupedRecipeOptions(entityId, instanceNames, fixableViolations)` in the menu, mounted only while open, since every recipe is a dry run.\n- `phx.frontend.createDeleteEntityFab(Component)` — replaces `DeleteEntityFab`. Props: `entityId`, `onDelete`, `disabled`, `disabledHint`, `trace` (logs the dry run), `icon`, `label`, `title`, `tooltipVisibility`.\n- `phx.frontend.createSelectionHotspot(Component)` — replaces `SelectionHotspot`. Props: `entityId`, `onSelect`, `title`, `tooltipVisibility`.\n- `phx.frontend.createNavigationHotspot(Component)` — replaces `NavigationHotspot`. Props: `entityId`, `navigationState`, `onNavigate`, `title`, `tooltipVisibility`.\n- `phx.frontend.createToolMenuFab(Component)` — replaces `ToolMenuFab`. Props: `entityId`, `options`, `onSelectTool(toolState)`, `icon`, `title`, `tooltipVisibility`.\n\n`title` and `label` are localizable: resolve them with `phx.frontend.useResolveLocalizable()`. Registering these names with `createCustomPhoenixEntityElement` works too, but types only `entityId`. The dimension indicators have no replacement; build a different editor as an `htmlHotspot`.",example:t,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- "In-Scene Controls" in `docs/phoenix/configurator-interface.mdx` — the replaceable elements, their props and a complete replacement.\n- `docs/fabs/basic.mdx`, `docs/fabs/layout.mdx` — FAB settings, visibility and tooltips, and grouping controls with screen offsets.\n- `docs/controls/scene/html-hotspots.mdx`, `docs/controls/scene/object-html-hotspots.mdx`, `docs/controls/scene/custom-controls.mdx` (`sceneEntityControl`).\n- "Put a control on the product" in `docs/layouts/custom-layout.mdx` — a project hotspot with a popover.\n- `docs/dimensions/3d-scene-integration/editable-distance-dimension-indicator.mdx` and its siblings in that folder, one per indicator (`pnpm phoenix docs -l` lists them).',phxMembers:["frontend.createAddEntityFab","frontend.createDeleteEntityFab","frontend.createSelectionHotspot","frontend.createNavigationHotspot","frontend.createToolMenuFab"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/actions.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Named domain operations: declaration, implementation and running them from the UI or the assistant. */
+export declare const generatePhoenixActionsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/actions.js

@@ -0,0 +1,64 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`Moving a drawer among the desk's drawers is a reorder of the desk's \`drawerIds\` that the arrow buttons and the assistant share:
+
+\`\`\`yaml
+# spec/actions.yaml
+actions:
+  moveDrawer:
+    description: Moves a drawer among the desk's drawers by a number of positions
+    params:
+      drawerId:
+        $ref: phx:DomainEntityId
+        references: Drawer
+        description: The drawer to move
+      delta:
+        type: integer
+        description: Positions to move by; negative moves left
+    result:
+      desk:
+        $ref: phx:$DomainEntity
+        references: Desk
+        description: The desk with its drawers in the new order
+\`\`\`
+
+\`\`\`ts
+// src/actions/move-drawer.ts
+export default phx.domain.implementActions({
+  moveDrawer: ({ drawerId, delta }, state, { systems: { domain }, updates }) => {
+    const desk = domain.getRoot$Entity(state)
+    const from = desk.drawerIds.indexOf(drawerId)
+    const to = from + delta
+
+    if (from === -1 || to < 0 || to >= desk.drawerIds.length) {
+      throw new Error(
+        \`Cannot move "\${drawerId}" by \${delta}. Pass the id of one of the desk's drawers and a delta that keeps it among them.\`
+      )
+    }
+
+    const drawerIds = [...desk.drawerIds]
+    drawerIds.splice(to, 0, ...drawerIds.splice(from, 1))
+
+    return {
+      updates: [
+        updates.DomainEntityModification({ entityId: desk.id, stateDelta: { drawerIds }, updateTag: 'moveDrawer' }),
+      ],
+      readResult: ({ state: moved }) => ({ desk: domain.getRoot$Entity(moved) }),
+    }
+  },
+})
+\`\`\`
+
+\`\`\`tsx
+// in the drawer's custom element: one prepared move per button
+const { actionSystem } = phx.frontend.useDomain()
+const state = phx.frontend.useCommittedState()
+const prepare = phx.frontend.useUpdateControl()
+
+const move = (delta: number) => {
+  try {
+    return prepare(actionSystem.prepareAction('moveDrawer', { drawerId: entityId, delta }, state).updates)
+  } catch (error) {
+    return { disabled: true, hints: error instanceof Error ? error.message : String(error), update: () => {} }
+  }
+}
+const left = move(-1) // <Button disabled={left.disabled} title={left.hints} onClick={left.update}>
+\`\`\``;export const generatePhoenixActionsFeature=()=>e({path:"features/domain-model/actions.md",title:"Actions",summary:"Named domain operations declared in YAML, prepared in `src/actions/` and run by controls or the assistant; read when one change touches several entities or the UI and the assistant must share it.",whenToUse:"Read when a change is more than writing one field — a move among siblings, a swap, a change to several entities at once — or when the UI and the assistant must make the same change under the same rule. A single bound field needs no action: bind it in YAML ([Components](components.md)).",capabilities:"### Declare\n\n- Declare actions under the top-level `actions:`, each with a `description`, `params` and `result`. Both maps are required; write `params: {}` for an action without parameters. Names are identifiers.\n- Each param and result member is a JSON schema with the shape syntax: `$ref: phx:...`, `references`, `tsType` and `import`. A param whose schema admits `null` is optional; the others are required.\n- `phx:DomainEntityId` with `references` types an id param; `phx:$DomainEntity` with `references` types a result member as the `$` entity after the change.\n- The descriptions become the doc comments of the generated `ActionParams<'name'>` and `ActionResult<'name'>` types and what the assistant reads about the action, so write them for both readers.\n- Only the configurator domain has actions; the admin domain has none.\n\n### Implement\n\n- Default-export `phx.domain.implementActions({ name: (params, state, ctx) => ... })` from a file in `src/actions/`. A file may implement any subset of the declared actions.\n- `params` arrive validated against the declared schema; `state` is the state the action runs on.\n- `ctx.systems` holds the domain systems and the registered systems for this browser application slot (`systems.domain.get$Entity(id, state)`, `systems.domain.getRoot$Entity(state)`); `ctx.updates` is the typed update factory, `ctx.getIdSequence()` gives ids for created entities, and `ctx.expressionContext` is the expression context.\n- Return `{ updates, readResult }`: the updates to apply, and `readResult({ previousState, state })`, which reads the declared result from the state those updates produced, transformer changes included.\n- An action only prepares. It never stages or commits; its caller does.\n- Throw to reject a call, with a message that says what was wrong and what to send instead: users see it as the control's hint and the assistant as the failed mutation's error.\n- `references` types an id but any entity id passes validation, so check what the id names, for example with `phx.domain.model.Drawer.isId(id)` or by finding it in the parent's list.\n- A declared action without an implementation stops the application at start: `.phoenix/phoenix-dev.log` shows `Missing actions: <names>`, and the editor (`--editor`) the `MISSING_ACTION_IMPLEMENTATIONS` diagnostic; implementing an undeclared name is a type error. Nothing validates what `readResult` returns at runtime.\n- Actions currently execute in the browser, including assistant custom mutations. Built-in extensions such as `ctx.systems.sketchingSystem` are optional: check the value before using it and throw a clear message when the slot does not provide it. For a custom system, check its name with `in` and narrow its value with a local type guard.\n- Action modules are also loaded by the webhook's shared domain assembly. Keep their runtime imports server-safe, including transitive helper imports; browser SDK entry points and browser-only initialization can break the webhook. Type-only browser imports are safe. Use structural guards for registered systems rather than importing a browser class for an `instanceof` check. [Webhook entry](../webhooks/entry-and-environment.md) describes the loading boundary.\n- Read sketching projections from the supplied `state` and call `getLineLengthUpdates`, `getRectangleWidthUpdates`, `getRectangleDepthUpdates`, `getConnectionAngleUpdate` or `getMoveSketchingPointUpdates`. Do not use methods that read committed state, such as `prepareInitialDrawingUpdates`. Never stage, commit, roll back, or change drawing/camera state in an action: assistant operations can use a hypothetical working state.\n\n### Run from the UI\n\n- `phx.frontend.useDomain().actionSystem.prepareAction(name, args, state)` returns the prepared action for the committed state from `phx.frontend.useCommittedState()`.\n- Pass its `updates` to a function from `phx.frontend.useUpdateControl()`: it dry-runs them for `disabled` and `hints` and commits them on `update()`. [Custom controls](../domain-controls/custom-controls.md) owns that hook and the control around it.\n- `prepareAction` throws for an unknown name, arguments that do not fit and every rejection; catch it and show the message as the disabled control's hint.\n- The generated `useDomain()` checks action names and arguments and preserves each action result type.\n\n### Expose to the assistant\n\n- List the action under `assistant.actions` to add it as a custom mutation; `as` renames the field and `description` replaces the action's. The mutation runs the same `prepareAction` and applies its updates with the same validation as every other change.",example:t,documentation:"Read `docs/other-features/domain-actions.mdx` with `pnpm phoenix docs -r docs/other-features/domain-actions.mdx`: declaring, implementing and running an action, with a complete control and the assistant schema. `docs/phoenix/domain-model.mdx` has no actions section.",phxMembers:["domain.implementActions"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/components.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Attaching components in YAML or TypeScript, bindings, filters and the component hooks. */
+export declare const generatePhoenixComponentsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/components.js

@@ -0,0 +1,62 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let n=`A bound control shown only while designing and only to owners, a label that follows the selection, and legs whose number depends on the width:
+
+\`\`\`yaml
+# spec/components.yaml
+components:
+  Desk:
+    attributeSelection:
+      finish:
+        value:
+          $bind: finish
+        options:
+          $read: $finishOptions # an expression implemented in src/expressions/
+        $filter:
+          navigationStates: [design]
+          modes: [owner]
+  Drawer:
+    detail:
+      main:
+        title: Drawer
+        subtitle:
+          $eval: "self.handle + ' handle'"
+        description: ''
+        $filter:
+          selectedEntityIds:
+            $read: id
+\`\`\`
+
+\`\`\`ts
+// src/components/desk-legs.ts
+import { memoEval, sceneEntityRemoteObjectComponent } from '@salsita-ai/sdk/domain'
+
+// One leg per started 800 mm plus one; a sceneEntityObjectProperties attachment
+// with the same instance name and keys places each leg.
+export default phx.domain.attachComponent
+  .withEntity('Desk')
+  .withComponent(sceneEntityRemoteObjectComponent, 'leg')
+  .attachMany(
+    memoEval(
+      self => [Math.ceil(self.width / 800) + 1],
+      count =>
+        Array.from({ length: count }, (_, index) => ({
+          key: \`leg-\${index}\`,
+          fileUrl: '/models/desk.glb',
+          objectName: 'Leg',
+        }))
+    )
+  )
+\`\`\`
+
+\`\`\`tsx
+// in a custom element; attributeSelectionComponent comes from '@salsita-ai/sdk/domain'
+const deskId = phx.frontend.useRootEntityId()
+const finish = phx.frontend.useComponent({
+  entityId: deskId,
+  componentType: attributeSelectionComponent,
+  instanceName: 'finish',
+})
+
+if (finish === null) {
+  return null // filtered out: not designing, or a viewer
+}
+\`\`\``;export const generatePhoenixComponentsFeature=()=>e({path:"features/domain-model/components.md",title:"Components",summary:"Attaching components in YAML or TypeScript, bindings, `$eval`, filters and reading components in React; read when binding data or behavior to entities or reading a component in custom UI.",whenToUse:"Read when attaching a component to an entity or alias, binding its props to the domain, limiting it to some states, or reading one in custom React code. The guide of each job names the kind that does it: [Domain controls](../domain-controls/index.md) for controls, [Custom project layout](../custom-layout/index.md) for page-level UI.",capabilities:"### Attach in YAML first\n\n- Nest `components:` by entity type or alias, component kind, instance name, then props. On an alias the instance applies to every member type.\n- Instance names are yours. One entity can carry several instances of a kind; name each by its job (`finish`, `width`).\n- A prop holds a static value or a binding:\n  - `$read: field` or `$read: $name` — one field, expression, relation or constant of the entity, by name only (no path).\n  - `$bind: field` — reads and writes one shape field, on the props a kind lets users change, such as a selection's `value`.\n  - `$read` or `$eval` together with `$write: field` — read one thing, write a shape field. `$write` never stands alone and never targets an expression.\n  - `$eval: <expression>` — one inline JavaScript expression of `self`, the `$` entity with its relations and expressions (`self.$desk.width / 2`). It sees nothing else: no state, no context, no imports and no TypeScript-only syntax.\n- Whole state from one expression: give the instance `$read: $name` instead of props, with an optional `$filter` beside it.\n- Reading an undeclared `$name` declares an expression that still needs an implementation; see [Expressions](expressions.md).\n- The build checks that a bound value fits its prop (`COMPONENT_BINDING_TYPE_MISMATCH`). An entity id cannot be written in YAML: bind it (`$read: id`).\n\n### Filters\n\n- A `$filter` inside an instance decides when the component is active. An inactive component is absent for every system and hook.\n- Criteria: `navigationStates`, `viewStates`, `toolStates`, `exportStates`, `modes` (`owner`, `read`, `finalize`), `roles`, `selectedEntityIds`, `hoveredEntityIds`, `draggedEntityIds`, `exportedEntityIds`, `viewports`, `fullscreen`, `debug` and `active`.\n- Each criterion is static or a `$read` or `$eval`. An omitted criterion matches everything, an empty list nothing. All stated criteria must match; `$or: [...]` lists alternative filters, any of which may match.\n- `selectedEntityIds: { $read: id }` shows an instance only while its own entity is selected.\n- Criteria run cheapest first and `active` last, so put a computed condition in `active: { $read: $name }` beside the static ones. Never write `$filter: { $read: $name }`: that whole-filter form is the deprecated legacy filter and warns at runtime.\n- `modes` tests the configurator mode; a viewer is in `read` mode, so `modes: [owner]` keeps an editing component from viewers.\n- [Application states](../application-states/index.md) explains the navigation, view and tool states and the selection the criteria test.\n\n### Attach in TypeScript\n\n- Use `phx.domain.attachComponent` in `src/components/` only for what YAML cannot express: a React node or other browser value, or a number of instances that depends on the state. A file default-exports one attachment or an array.\n- Chain `.withEntity('Desk')` or `.withAlias('Top')` (repeatable), `.withComponent(<kind>Component, 'instance')`, optionally `.withGradualFilter({ ... })` (each call is one alternative), then `.attach(read, write?)` or `.attachMany(read)`.\n- `read(self, state, ctx)` returns the state; `write(writableState)` returns the entity fields to change; `attachMany` returns an array of states, each with a stable `key`, one instance per key.\n- Component types are `<kind>Component` exports of `@salsita-ai/sdk/domain`, such as `attributeSelectionComponent`; `phx` does not carry them.\n- Wrap `read` in `memoEval` (from `@salsita-ai/sdk/domain`) so the state keeps its reference while its inputs are unchanged. A fresh object on every state re-renders controls and can reset systems that react to references, such as cameras.\n- Files in `src/components/` stay out of the webhook unless their first statement is `'use webhook'`; [Webhook entry and environment](../webhooks/entry-and-environment.md) says when a component needs it.\n\n### Read components in React\n\n- `phx.frontend.useComponent({ entityId, componentType, instanceName })` returns the component's state, or `null` while it is not attached or filtered out. Leave out `instanceName` only when the kind is attached once; several matches throw.\n- `phx.frontend.useComponents({ componentTypes, entityIds?, instanceNames? })` returns `{ componentInstance, state }` snapshots, empty when nothing matches although its type admits `null`.\n- `phx.frontend.useFirstComponent({ ... })` takes the same filter and returns the first snapshot or `null`.\n- `phx.frontend.useRootComponents(componentType)` and `phx.frontend.useFirstRootComponent(componentType)` read the root entity; both also take an array of types.\n- These read the committed state. The rendered variants follow staged changes too, such as a slider being dragged: `phx.frontend.useRenderedComponent`, `phx.frontend.useRenderedComponents`, `phx.frontend.useFirstRenderedComponent`, `phx.frontend.useRootRenderedComponents` and `phx.frontend.useFirstRootRenderedComponent`. [State slices](../state/slices.md) explains when each fits.\n- Control hooks throw for a component that is not attached: check it with `phx.frontend.useComponent` first and render nothing on `null`.",example:n,documentation:'Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/components.mdx` — bindings, `$eval`, filters and `memoEval`.\n- `docs/other-features/component-filters.mdx` — every criterion combination, `$or` included.\n- `docs/other-features/dynamic-component-attachments.mdx` — `attachMany` from memoized expressions, beside static YAML components.\n- `docs/phoenix/configurator-interface.mdx` — "Components" under "Core Hooks": the component hooks with a sample call each.',phxMembers:["domain.attachComponent","frontend.useComponent","frontend.useRenderedComponent","frontend.useComponents","frontend.useRenderedComponents","frontend.useFirstComponent","frontend.useFirstRenderedComponent","frontend.useRootComponents","frontend.useRootRenderedComponents","frontend.useFirstRootComponent","frontend.useFirstRootRenderedComponent"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/domain-model.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The domain model index followed by its guides. */
+export declare const generatePhoenixDomainModelGuides: () => readonly PhoenixGuide[];

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/domain-model.js

@@ -0,0 +1 @@
+import{createPhoenixIndexGuide as e}from"../../guide.js";import{generatePhoenixActionsFeature as s}from"./actions.js";import{generatePhoenixComponentsFeature as t}from"./components.js";import{generatePhoenixEntitiesAndRelationsFeature as n}from"./entities-and-relations.js";import{generatePhoenixExpressionsFeature as r}from"./expressions.js";import{generatePhoenixTransformersFeature as i}from"./transformers.js";import{generatePhoenixValidationAndRepairFeature as a}from"./validation-and-repair.js";export const generatePhoenixDomainModelGuides=()=>{let o=[n(),t(),r(),a(),i(),s()];return[e({path:"features/domain-model/index.md",title:"Domain model",summary:"Entities, relations, components, expressions, invariants, transformers and actions; read when modeling the product or changing its rules.",intro:"The domain model is the product's saved state and its rules: YAML in `spec/` declares it, and `src/expressions/`, `src/invariants/`, `src/transformers/`, `src/actions/` and `src/components/` implement what YAML cannot. Entities and relations give it its shape; components attach data and behavior to it; expressions derive values from it; invariants reject an invalid change; transformers add the updates a change carries with it, such as a repair; actions are named operations over several entities. Read only the guide the task needs.",guides:o,notes:[]}),...o]};

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/entities-and-relations.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Entities, aliases, relations, recipes and the model reflections. */
+export declare const generatePhoenixEntitiesAndRelationsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/entities-and-relations.js

@@ -0,0 +1,59 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A desk with one plain attribute, a top slot two types can fill, and an ordered list of drawers:
+
+\`\`\`yaml
+# spec/model.yaml
+model:
+  latest:
+    entityTypes: [Desk, RectTop, RoundTop, Drawer]
+    aliases:
+      RootEntity: [Desk]
+      Top: [RectTop, RoundTop]
+    shapes:
+      Desk:
+        finish: # one value per desk: an attribute
+          type: string
+        topId:
+          $ref: phx:DomainEntityId
+          references: Top
+        drawerIds:
+          type: array
+          items:
+            $ref: phx:DomainEntityId
+            references: Drawer
+      RectTop:
+        width: { type: number }
+      RoundTop:
+        diameter: { type: number }
+      Drawer:
+        handle: { type: string }
+relations:
+  Desk:
+    $top: { kind: direct, field: topId, target: Top, cardinality: 1-1, composedOf: true }
+    $drawers: { kind: direct, field: drawerIds, target: Drawer, cardinality: 0-N, composedOf: true }
+  Top:
+    $desk: { kind: indirect, field: topId, target: Desk, cardinality: 1-1, composedOf: false }
+  Drawer:
+    $desk: { kind: indirect, field: drawerIds, target: Desk, cardinality: 1-1, composedOf: false }
+components:
+  Desk:
+    childEntityRecipes:
+      drawers:
+        collection: Desk.$drawers
+        recipes:
+          $read: $drawerRecipes # declared by this read, implemented below
+\`\`\`
+
+\`\`\`ts
+// src/expressions/desk.ts
+export default phx.domain.implementCustomExpressions({
+  Desk: {
+    // A round top takes no drawers; the guard narrows the alias to one member type.
+    $drawerRecipes: self =>
+      phx.domain.enhancedModel.$RoundTop.is(self.$top)
+        ? []
+        : [{ title: 'Drawer', recipes: [phx.domain.createRecipe({ type: 'Drawer', handle: 'bar' })] }],
+  },
+})
+\`\`\`
+
+Deleting a drawer removes its id from \`drawerIds\`, and replacing the top writes the new id into \`topId\`, with no project code. The finish all drawers share stays \`Desk.finish\` rather than a field on each drawer.`;export const generatePhoenixEntitiesAndRelationsFeature=()=>e({path:"features/domain-model/entities-and-relations.md",title:"Entities and relations",summary:"Attribute or entity, aliases, relation kinds and ownership, recipes and the model reflections; read when shaping or changing the domain model.",whenToUse:"Read when deciding the shape of the domain model: which choices stay attributes, which become entities, how they relate and own each other, and how code tells entity types apart. Decide before the first deploy: splitting or merging entities later is a model migration.",capabilities:"### Attribute or entity\n\n- Keep a choice as an attribute of the entity it describes when the product has exactly one value of it and it needs no scene object, selection or page of its own: a finish, a width, a fabric.\n- Split it into an entity when users add, remove or repeat it, when several types with different attributes can fill the same place, or when users select it, see it as its own object or edit it on its own.\n- The split drives what follows: the composition tree is the scene hierarchy and the selection ancestry, deleting an owner deletes what it owns, and the child-entity controls (add, replace, list, delete) work on relations.\n- Start with one root entity and split only what the product needs. After a deploy, adding, removing or splitting entity types or shapes is a model change: follow [Model migration](../../processes/model-migration.md).\n\n### Aliases\n\n- An alias in `model.latest.aliases` is a named union of entity types. `RootEntity` lists the types a configuration can be rooted at.\n- Target an alias for a slot several types can fill (a `Top` that is a `RectTop` or a `RoundTop`), and declare shapes, expressions, invariants, relations and components once on it for all its members.\n\n### Relations\n\n- Declare relations under `relations:`, keyed by entity type or alias and named `$camelCase`. Each states `kind`, `target`, `cardinality` (`0-1`, `1-1`, `0-N`, `1-N`) and `composedOf`; `direct` and `indirect` also state `field`. None has a default.\n- **direct** — the declaring entity stores the ids in `field`: one id for `1-1`, an id or `null` for `0-1`, an ordered array for `0-N` and `1-N`. Use it for slots and ordered lists.\n- **indirect** — the target stores a pointer back in `field`. Use it when membership lives on the child, such as a `parentId`.\n- **allOfType** — every entity of the target type or alias, nothing stored. Use it for a link back to the root or a dynamic group.\n- A `field` is a `phx:DomainEntityId` with `references` (alone, or null, or in an array) that references exactly the related types.\n- Declare both sides. The counterpart on the target points back with the opposite kind (`direct` and `indirect`, or `allOfType` on both) and the same `field`; a missing side fails parsing with `RELATION_MISSING_COUNTERPART`.\n- Mark the owning side `composedOf: true`, at most one side of a pair. Every entity type must be reachable from the root through owning relations (`RELATION_ENTITY_NOT_IN_COMPOSITION_TREE`), and each entity has one owner, without cycles.\n- A cross-reference (`composedOf: false` on both sides) links entities already in the tree; it neither cascades nor nests in the scene.\n- Built-in transformers keep relations consistent: deleting an owner deletes what it owns, deleting a referenced entity removes its id from `direct` fields, and creating or replacing an entity writes the ids. Write no transformer for these.\n- Read relations as `$` fields in code: `desk.$top`, `desk.$drawers` (an array), `drawer.$desk`.\n\n### Create and remove children\n\n- Create children from recipes: `phx.domain.createRecipe({ type: 'Drawer', ... })` returns a whole entity of that type with a placeholder id, and the configurator gives it a real id when it adds it. State every shape property; spec `defaults:` are deprecated.\n- Return recipe groups from an expression and let a recipe control add or replace with them; remove a child with a deletion. [Control components](../domain-controls/control-components.md) owns the add, replace and remove controls.\n- For an `indirect` collection, set the child's pointer field in the recipe.\n\n### Model reflections\n\n- `phx.domain.model` has a reflection per entity type, alias and common type. Entity and alias reflections have `is(entity)`, `isId(id)`, `assert` and `assertId`; an alias also lists its `types`. A string-only enum common type has `values()` and one constant per value (`phx.domain.model.Finish.oak`); other common types validate with `is(value)`.\n- `phx.domain.enhancedModel` has `$<Type>` and `$<Alias>` for `$` entities: `is` and `isId` narrow them, and constants that do not read `self` are members (`phx.domain.enhancedModel.$Desk.$maxWidth`).\n- Hooks that take a reflection take the enhanced one, such as `phx.frontend.useSelectedEntity(phx.domain.enhancedModel.$Drawer)`; a `phx.domain.model` reflection has no `expressions` and does not type-check there. [Selection and hover](../application-states/selection.md) owns the selection hooks.\n- Call guards on the reflection object; a destructured assertion loses its narrowing (TS2775). Narrow ids that arrive untyped, such as action parameters, with `isId`.\n\n### Composition in React\n\n- `phx.frontend.useComposition()` returns the composition tree of the rendered state as `{ root, map }`. Each node has `id`, `parent`, and `children()`, `descendants()` and `ancestors()` iterators; `map` finds a node by id. Use it for outlines and breadcrumbs, and the state hooks for entity data.",example:t,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/domain-model.mdx` — the Relations and Aliases sections, enums and the `phx.domain` reflections.\n- `docs/relations/aliases.mdx`, `docs/relations/hierarchy.mdx`, `docs/relations/collection-direct.mdx`, `docs/relations/collection-indirect.mdx`, `docs/relations/all-of-type.mdx`, `docs/relations/cross-reference.mdx` — one worked relation pattern each.\n- `docs/recipes-and-delete/simple.mdx`, `docs/recipes-and-delete/delete-entity.mdx` — recipes and deletion end to end.",phxMembers:["domain.model","domain.enhancedModel","domain.createRecipe","frontend.useComposition"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/expressions.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Derived values in YAML and TypeScript, memoEval, the expression context and the data hooks. */
+export declare const generatePhoenixExpressionsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/expressions.js

@@ -0,0 +1,46 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`An inline value and a memoized object. The spec declares \`Cabinet.width\` (number) and \`Cabinet.finish\` (string), \`finishes\` (string array) in \`publishedData\` and \`currency\` (string) in \`frontendData\`, each in its schema's \`required\` list, or the implementation does not type-check; and \`customerGroup\` (string) in \`sessionData\`, optional like every session data property.
+
+\`\`\`yaml
+# spec/cabinet.yaml
+expressions:
+  Cabinet:
+    $halfWidth: # reads only self: no TypeScript
+      type: number
+      $eval: self.width / 2
+    $delivery: # reads the data sources: implemented in src/expressions/cabinet.ts
+      type: object
+      properties:
+        available: { type: boolean }
+        currency: { type: string }
+        customerGroup: { type: [string, 'null'] } # session data may lack it
+        days: { type: [number, 'null'] }
+      required: [available, currency, customerGroup, days]
+      additionalProperties: false
+\`\`\`
+
+\`\`\`ts
+// src/expressions/cabinet.ts
+import { memoEval } from '@salsita-ai/sdk/domain'
+
+export default phx.domain.implementCustomExpressions({
+  Cabinet: {
+    $delivery: memoEval(
+      (self, _state, ctx) => [
+        self.finish,
+        ctx.publishedData.finishes,
+        ctx.frontendData.currency,
+        ctx.sessionData.customerGroup,
+        ctx.backendData?.['deliveryDays'],
+      ],
+      (finish, finishes, currency, customerGroup, deliveryDays) => ({
+        available: finishes.includes(finish),
+        currency,
+        customerGroup: customerGroup ?? null,
+        days: typeof deliveryDays === 'number' ? deliveryDays : null,
+      })
+    ),
+  },
+})
+\`\`\`
+
+\`$delivery\` keeps one object while its five inputs are unchanged, so a reader of \`cabinet.$delivery\` re-renders only when one of them changes. \`$halfWidth\` is a number and needs neither TypeScript nor \`memoEval\`.`;export const generatePhoenixExpressionsFeature=()=>e({path:"features/domain-model/expressions.md",title:"Expressions",summary:"Derived values in YAML or TypeScript, `memoEval`, the expression context and the data hooks; read when computing a value from entity state or data sources.",whenToUse:"Read when a value derives from the configuration or its data — a price, a label, a limit, recipe options, a filter condition — or when custom React code needs the published, frontend or backend data.",capabilities:"### Choose the form\n\n- **`constants:`** — a fixed value per entity type or alias, without code (`$maxLegs: 4`). One that does not read `self` is also readable without an entity, as `phx.domain.enhancedModel.$Chair.$maxLegs`.\n- **`$eval` under `expressions:`** — one inline JavaScript expression of `self` (`$eval: self.width / 2`); give it an explicit `type`, because a value that reads `self` cannot be inferred. It sees only `self`: no state, context, helpers or imports. A `$eval` that does not read `self` is folded at parse time when it uses only literals, operators and `Math`; anything else needs an explicit `type` too.\n- **`$msg`** — a translatable text; [Localization](../localization.md) owns it.\n- **TypeScript** — anything that reads the data sources, the state or a helper, or needs more than one expression: declare the type in YAML and implement it in `src/expressions/`.\n\n### Declare and implement\n\n- Declare under `expressions:`, by entity type or alias, a `$name` with a JSON schema: `type`, `items`, `properties`, `$ref: phx:...`, or `tsType` with `import`.\n- Implement it with `phx.domain.implementCustomExpressions({ Desk: { $name: (self, state, ctx) => value } })`, default-exported from a file in `src/expressions/`, one file per entity type. Implement it under the entity type or alias that declares it.\n- A declared expression without an implementation stops the application at start with `MISSING_IMPLEMENTATION`; one implemented twice, or one the spec already gives a value, with `DUPLICATE_DEFINITION`.\n- Inference: a component `$read: $name` or filter `active: { $read: $name }` of an undeclared `$name` declares it with the type that prop or criterion expects, as recipe lists usually are. It still needs a TypeScript implementation. Declare it yourself to own the type; a type no read can accept fails with `EXPRESSION_READ_TYPE_CONFLICT`.\n\n### Pure, server-safe and stable\n\n- Expressions are pure: no side effects, no mutation of inputs, the same result for the same state and data. They are computed on demand and cached per state.\n- Expressions and invariants also run on the server. Use `phx.domain` only, never `phx.frontend`, React or a browser-only import; put shared helpers in `_`-prefixed folders.\n- [Actions](actions.md) execute in the browser, but their modules also load in the webhook and must keep runtime imports server-safe; type-only browser imports are allowed.\n- Keep the reference of an object or array result while its inputs are unchanged: wrap the implementation in `memoEval(deps, compute)` from `@salsita-ai/sdk/domain`. `deps(self, state, ctx)` returns an array compared item by item with `===`, and `compute(...deps)` runs only when an item changed.\n- List every input in `deps` and read nothing else in `compute`. Primitives need no `memoEval`.\n- A new object on every evaluation re-renders every reader and can reset systems that react to references, such as cameras; a mutated cached result hides the change.\n\n### The expression context\n\n- `self` is the `$` entity: fields, relations (`self.$drawers`), expressions and constants.\n- `state` is the domain state: `state.entities`, `state.rootEntityId`.\n- `ctx.publishedData`, `ctx.frontendData` and `ctx.sessionData` are typed by the spec's `publishedData:`, `frontendData:` and `sessionData:` schemas: a property missing from the schema's `required` list is optional.\n- A `sessionData` schema cannot list `required` properties (`SESSION_DATA_REQUIRED_PROPERTIES`), so every `ctx.sessionData` property may be `undefined`.\n- `ctx.backendData` is `Record<string, unknown> | undefined`: optional and untyped, so narrow each value before use.\n- `ctx.mode` is `owner`, `read` or `finalize`; `ctx.role` is the session role.\n- `ctx.domain.get$Entity(id, state)` and `ctx.domain.getRoot$Entity(state)` read other entities; `ctx` also has the component reader and the projections.\n\n### The data in React\n\n- `phx.frontend.usePublishedData()` and `phx.frontend.useFrontendData()` return the typed published and frontend data.\n- `phx.frontend.useBackendData()` returns the same optional, untyped backend data as `ctx.backendData`.\n- `phx.frontend.useLoadedData()` returns what the configurator loaded — `initialEntities`, `initialRevisionId`, `modelVersion`, `rootEntityType` — not the current state, which [State slices](../state/slices.md) reads.\n- Prefer an expression when the value also depends on the configuration: it is cached, runs on the server and can be bound in YAML. Read the hooks for data a custom element only displays.",example:t,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/domain-model.mdx` — the Expressions, Constants and Static values with `$eval` sections.\n- `docs/phoenix/expression-context.mdx` — the context, its projections and the SDK expression builders.\n- `docs/phoenix/data-sources.mdx` — declaring the data schemas, their sources and lifetimes.\n- `docs/phoenix/components.mdx` — the `memoEval` section, for component outputs.",phxMembers:["domain.implementCustomExpressions","frontend.usePublishedData","frontend.useFrontendData","frontend.useBackendData","frontend.useLoadedData"]});

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/index.d.ts

@@ -0,0 +1 @@
+export * from './domain-model.js';

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/index.js

@@ -0,0 +1 @@
+export*from"./domain-model.js";

package/dist/application-spec/generate-application/code/templates/skills/features/domain-model/transformers.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Transformers: when to write one, triggers, actions, registration, order and debugging. */
+export declare const generatePhoenixTransformersFeature: () => PhoenixGuide;