@salsita-ai/sdk 0.50.0-develop.5a0bcdee42 → 0.50.0-develop.5ac9723d62

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

@@ -0,0 +1,87 @@
+import{createPhoenixFeatureGuide as e}from"../guide.js";let a=`Read when the configurator needs several languages, when adding user-facing text to such a project, or when a PDF or email must follow the configurator user's language.
+
+Enable localization when the client sells in several languages; take them from the product definition, and ask when it names none. With one language and none planned, plain strings are fine. When more are likely, make every text translatable from the start: converting later touches every label, message and template.`,t=`A table sold in English and German: option labels in the spec, an invariant message and a picker in a custom layout.
+
+\`\`\`yaml
+# spec/application.yaml
+availableLocales: [en, de]
+textLanguages: [en, de]
+
+# spec/table.yaml
+invariants:
+  Table:
+    glassLength:
+      types: [glassTooLong]
+components:
+  Table:
+    applicationConfig:
+      main:
+        availableLocales: [en, de] # what users can pick; add it to an existing instance
+    attributeSelection:
+      finish:
+        value:
+          $bind: finish
+        options:
+          - value: oak
+            label:
+              $msg: Oak
+          - value: glass
+            label:
+              $msg: Glass
+\`\`\`
+
+\`\`\`ts
+// src/invariants/table.ts
+import { msg } from '@lingui/core/macro'
+
+const MAX_GLASS_LENGTH = 2000
+
+export default phx.domain.implementCustomInvariants({
+  Table: {
+    glassLength: table =>
+      table.finish === 'glass' && table.length > MAX_GLASS_LENGTH
+        ? [
+            {
+              type: 'glassTooLong',
+              severity: 'fatal',
+              message: msg\`Glass tops are available up to \${MAX_GLASS_LENGTH} mm.\`,
+            },
+          ]
+        : [],
+  },
+})
+\`\`\`
+
+\`\`\`tsx
+// src/elements/_shared/LanguagePicker.tsx, rendered by the project's ConfiguratorLayout
+import { msg } from '@lingui/core/macro'
+import { MenuItem, TextField } from '@mui/material'
+
+const LANGUAGE = msg\`Language\`
+
+export const LanguagePicker = () => {
+  const label = phx.frontend.useLocalizable(LANGUAGE)
+  const { locales, locale, setLocale, available } = phx.frontend.useLocaleSwitch()
+
+  if (!available) {
+    return null
+  }
+
+  return (
+    <TextField select size="small" label={label} value={locale} onChange={event => setLocale(event.target.value)}>
+      {locales.map(option => (
+        <MenuItem key={option.locale} value={option.locale}>
+          {option.displayName}
+        </MenuItem>
+      ))}
+    </TextField>
+  )
+}
+\`\`\`
+
+After \`pnpm phoenix sync\`, translate the texts in \`src/locales/de/messages.po\`, keeping the placeholder:
+
+\`\`\`po
+msgid "Glass tops are available up to {MAX_GLASS_LENGTH} mm."
+msgstr "Glasplatten gibt es bis {MAX_GLASS_LENGTH} mm L\xe4nge."
+\`\`\``;export const generatePhoenixLocalizationFeature=()=>e({path:"features/localization.md",title:"Localization",summary:"Languages, translatable spec and TypeScript texts, the language switch, the webhook's language, catalogs and formatting; read when the configurator must work in more than one language or a text must be translatable.",whenToUse:a,capabilities:"### Enable languages\n\nThree lists, each with its own job:\n\n- **`availableLocales`** in `spec/application.yaml` (default `[en]`) — the languages with a project catalog, `src/locales/<locale>/messages.po`.\n- **`availableLocales` of the root entity's `applicationConfig`** — the languages users can pick. Without it the switch offers English only and the default toolbar has no language button. Keep it within the top-level list: picking another locale activates its fallback.\n- **`textLanguages`** in `spec/application.yaml` — the languages Admin edits multilingual texts in, and the fallback order of `$lang` values.\n\nThe configurator starts in the embedding page's `locale` attribute or property (English when unset), not the first listed locale. A page locale outside `availableLocales` falls back to a listed one: a regional locale to its listed base language (`de-AT` to `de`), anything else to `en`, or to the first listed locale when `en` is not listed. List a regional locale the site sets when its texts should differ from the base language; its empty entries compile from the base language. In a language the SDK lacks, built-in texts stay English.\n\n### Spec texts: `$msg` or `$lang`\n\n- **`$msg`** — UI text authored in the spec: titles, labels, hints, static invariant messages, constants. The text is its own id, so rewording drops its translations; add a stable `$msgId: 'finish.title'` to texts likely to change.\n- **`$lang`** — data carrying its own translations: Admin content, published data, imports. Inline `$lang` in the spec suits data the client supplies translated.\n- A plain string shows unchanged in every language.\n- An expression holding `$msg` or `$lang` declares `$ref: phx:Localizable`; for `$msg`, `type: string` reports `EXPRESSION_VALUE_TYPE_MISMATCH`.\n- `$lang` resolves to the active locale, then each `textLanguages` entry, then `en`, else an empty string. List every market language there, primary first.\n\n### TypeScript texts\n\n- `msg` from `@lingui/core/macro` creates a message descriptor: use it for invariant messages, expression results the UI shows and labels passed to components. `` msg`Up to ${max} mm` `` keeps a placeholder for translators, `msg({ id, message })` fixes the id, `plural` handles counts.\n- Expressions, invariants and transformers run without a locale, on the server too: return descriptors or `$lang`, never translated strings or formatted numbers. [Violations](state/violations.md) covers hint texts formatted per change.\n- In React, render content with `<Trans>` from `@lingui/react/macro`. Where a string is needed (an attribute, a string-only prop, a spec text, a descriptor):\n  - `phx.frontend.useLocalizable(text)` returns one text in the active language;\n  - `phx.frontend.useResolveLocalizable()` returns `resolve(text)` for lists, loops and conditional texts.\n- Both accept a string, a descriptor or `$lang`, apply the `textLanguages` fallback and re-render on a language change. Resolve inside components, never at module scope.\n\n### Language switch\n\n- The default toolbar shows a language button, and a menu action on phones, when the `applicationConfig` list has several locales. A configured `toolbar` lists `languageToolbarButton` and `languageMenuAction` itself; [Toolbar actions](custom-layout/toolbar-actions.md) covers toolbars a layout renders.\n- `phx.frontend.useLocaleSwitch()` returns `{ locales, locale, setLocale, available }`: the `applicationConfig` locales as `{ locale, displayName }`, each named in its own language; the active locale; a setter; and whether there is a choice. Use it for your own picker and wherever code needs the active locale.\n\n### Webhooks\n\n- The language reaches the webhook only if the finalize handler sends it: `apiClient.finalize(configurationId, finalizationUuid, finalizeData, locale, frontendData)`, with `locale` from `phx.frontend.useLocaleSwitch()`. Without it, PDFs and emails come out in English. [Finalization](../processes/finalization.md) owns the handler.\n- Tasks get `ctx.resolveLocalizable(text)`, bound to that locale and `textLanguages`, and `ctx.i18n`. The PDF and email builders resolve every localizable input; templates use `<Trans>`, and `HtmlHelpers.Localized` from `@salsita-ai/sdk/webhook` for domain texts.\n- `.withLocale('de')` renders one PDF or email in another language. Plain payloads (CSV, HTTP) need `ctx.resolveLocalizable` on each text.\n\n### Catalogs and translation\n\n- `pnpm phoenix sync` and `pnpm phoenix build` extract every `msg`, `<Trans>` and `$msg` into the PO files and compile the TypeScript catalogs.\n- `pnpm phoenix dev` only creates missing catalogs at startup; with `--withLingui` (or `WITH_LINGUI=true`) it extracts and compiles on every change. Without it a new text stays English until the next sync. Restart dev after changing `availableLocales`.\n- Translate in the `msgstr` entries of `src/locales/<locale>/messages.po`, keeping placeholders such as `{max}`. Never edit the compiled `messages.ts` ([CLI core](../core/cli.md)).\n- An empty `msgstr` compiles from the fallback chain (`de-AT` → `de` → `en`): the text shows English, without an error. Before a handover, search for empty `msgstr \"\"` entries after the header.\n- When you translate yourself, tell the client which languages need a native speaker's review and record them as provisional.\n\n### Numbers and currency\n\n- `phx.frontend.useRootEntityPrice()` formats the root's `price` component for the active locale in its `currency` (`USD` when unset), and returns `null` while the root has none; choose the currency per market in the spec.\n- Format other numbers, dates and lists with `Intl` and the active locale: `useLocaleSwitch().locale` in React, `ctx.i18n.locale` in webhooks.",example:t,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/localization.mdx` — enabling languages, choosing the language, `$msg`, `$msgId`, `$lang` and its sources, the hooks and server-side translation.\n- `docs/phoenix/webhooks.mdx` — localized PDF and email builders and `.withLocale`.\n- `docs/other-features/violation-messages.mdx` — translated violation hints with nested labels.\n- `docs/other-features/currency.mdx` — the currency chosen from session data, one price component per currency filtered with `active`.\n- `docs/integrations/webcomponent-api/basics.mdx` — the page's `locale` property.",phxMembers:["frontend.useResolveLocalizable","frontend.useLocalizable","frontend.useLocaleSwitch","frontend.useRootEntityPrice"]});

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

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../guide.js';
+/** Scene objects built in code: scene elements, custom entities and attached three.js objects, rebuilding and disposal. */
+export declare const generatePhoenixSceneObjectsFeature: () => PhoenixGuide;

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

@@ -0,0 +1,43 @@
+import{createPhoenixFeatureGuide as e}from"../guide.js";let t=`A worktop with a cut-out per basin, as a scene element. The geometry is rebuilt only when the length or the cut-outs change; React Three Fiber releases the old one.
+
+\`\`\`yaml
+# spec/domain.yaml, components of Washtable
+sceneEntityObject:
+  worktop:
+    name: 'Worktop'
+sceneEntityObjectProperties:
+  worktop:
+    offsetY: 850
+\`\`\`
+
+\`\`\`tsx
+// src/elements/Worktop.tsx
+import { useMemo } from 'react'
+import { Path, Shape } from 'three'
+
+const NO_CUT_OUTS: readonly number[] = []
+
+export default phx.frontend.createCustomPhoenixEntityElement('Worktop', ({ entityId }) => {
+  const entity = phx.frontend.useCommittedState().entities.find(e => e.id === entityId)
+  const washtable = entity?.type === 'Washtable' ? entity : undefined
+  const length = washtable?.length ?? 1200
+  const cutOuts = washtable?.basinPositions ?? NO_CUT_OUTS
+
+  const shape = useMemo(() => {
+    const top = new Shape().moveTo(0, 0).lineTo(length, 0).lineTo(length, 460).lineTo(0, 460).closePath()
+    for (const x of cutOuts) {
+      top.holes.push(new Path().absellipse(x, 230, 180, 140, 0, Math.PI * 2, false, 0))
+    }
+    return top
+  }, [length, cutOuts])
+
+  return (
+    <mesh rotation-x={-Math.PI / 2} castShadow receiveShadow>
+      <extrudeGeometry args={[shape, { depth: 12, bevelEnabled: false }]} />
+      <meshPhysicalMaterial color="#f1ede4" roughness={0.35} clearcoat={0.3} />
+    </mesh>
+  )
+})
+\`\`\`
+
+A new finish changes only the material's color; dragging a basin changes \`basinPositions\`, which a cut-out needs, so that rebuild is real.`;export const generatePhoenixSceneObjectsFeature=()=>e({path:"features/scene-objects.md",title:"Scene objects built in code",summary:"Geometry built in code instead of loaded from a model, and keeping its rebuilds cheap; read when part of the product or its setting is generated.",whenToUse:"Read when part of the product or its setting is built in code instead of loaded from a model: geometry that follows the configuration, such as a worktop with cut-outs where the basins sit, a shelf that grows with its width or a room whose walls follow the plan.\n\nPrefer a model when one exists: `sceneEntityRemoteObject` loads a GLB, and `sceneEntityObjectProperties` positions it and binds its transforms to state. Build in code what a model cannot express.",capabilities:"### Three ways to build it\n\n- **A scene element** — usually the best fit. Name an element in an entity's `sceneEntityObject` instance, `name: 'Worktop'`, and register it in `src/elements/` with `phx.frontend.createCustomPhoenixEntityElement('Worktop', ({ entityId }) => …)`; [Custom controls](domain-controls/custom-controls.md) has the registration rules. It returns React Three Fiber JSX, meshes with their geometries and materials, and reads state through the hooks like any entity element. React Three Fiber releases what it created when the element unmounts or a geometry's `args` change.\n- **A whole custom entity** — `customSceneEntity` with `name` replaces the entity's entire representation by the element. The entity's remote objects, object properties, materials, decals and clips are then ignored; child entities still render.\n- **A three.js object** — attach `sceneEntityObjectComponent` from `@salsita-ai/sdk/domain` with `phx.domain.attachComponent` in `src/components/`, its state `{ object }` built in `memoEval`. The SDK renders the object as given and never disposes it.\n\nFor the first and third, `sceneEntityObjectProperties` of the same instance still positions, hides and highlights the object.\n\n### Rebuild only when the shape changes\n\nA rebuild costs geometry, triangulation and an upload to the GPU, and a slider or a drag can ask for one every frame.\n\n- Rebuild when an input that changes the shape changes, such as a length or a cut-out, and nothing else: memoize the geometry on those inputs, `useMemo` in an element or the `memoEval` dependencies of an attached object.\n- Move, rotate or recolor the existing object for a position or a finish, through `sceneEntityObjectProperties` bindings or the material, instead of rebuilding it.\n- A three.js object you replace keeps its GPU memory until you call `dispose()` on its geometries, materials and textures, so dispose what a rebuild replaces. Reuse a texture across rebuilds rather than cloning it and setting `needsUpdate` each time, which uploads it again.\n\n### Shadows and effects\n\n- On a three.js object, `sceneEntityObjectProperties` sets `castShadow` and `receiveShadow` on every child from the spec, `false` when unset, so flags set in code are overwritten: set them in the spec. A scene element sets them on its own meshes.\n- Soft shadows on large surfaces, outlines and other effects cost every frame; keep those whose result the client sees.",example:t,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/3d-scene/rendering/basic.mdx` — loaded models, object properties and three.js objects attached in code.\n- `docs/3d-scene/rendering/scene-entity-object.mdx` — the `sceneEntityObject` component and its forms.\n- `docs/3d-scene/rendering/custom-entity.mdx` — `customSceneEntity` and a complete React Three Fiber element.\n- `docs/3d-scene/rendering/soft-shadows.mdx` — the canvas, object and light settings shadows need.\n- The **Performance** category — what costs per frame and per change.",phxMembers:[]});

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

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

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

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

package/dist/application-spec/generate-application/code/templates/skills/features/state/slices.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The store's three slices, which UI reads which, and the hooks that read them without needless re-renders. */
+export declare const generatePhoenixStateSlicesFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/state/slices.js

@@ -0,0 +1,48 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A cabinet label follows a drag frame by frame, while the order summary ignores previews and rejected changes. The label returns a tuple of numbers, so it re-renders only when one changes; returning \`cabinet.$shelves\` would re-render it on every pointer move.
+
+\`\`\`tsx
+// src/elements/CabinetWidthLabel.tsx
+import { Trans } from '@lingui/react/macro'
+import { Typography } from '@mui/material'
+
+export default phx.frontend.createCustomPhoenixEntityElement('CabinetWidthLabel', ({ entityId }) => {
+  if (!phx.domain.model.Cabinet.isId(entityId)) {
+    throw new Error('CabinetWidthLabel is attached to a Cabinet only.')
+  }
+
+  const [width, shelves] = phx.frontend.useRenderedEntitySelector(
+    entityId,
+    cabinet => [cabinet.width, cabinet.$shelves.length] as const,
+    []
+  )
+
+  return (
+    <Typography variant="caption">
+      <Trans>
+        {width} mm, {shelves} shelves
+      </Trans>
+    </Typography>
+  )
+})
+\`\`\`
+
+\`\`\`tsx
+// src/_shared/OrderSummary.tsx: committed only, so a dragged-across position never shows a price
+import { Trans } from '@lingui/react/macro'
+import { Typography } from '@mui/material'
+
+export const OrderSummary = () => {
+  const [cabinets, total] = phx.frontend.useRootEntitySelector(
+    kitchen => [kitchen.$cabinets.length, kitchen.$totalPrice] as const,
+    []
+  )
+
+  return (
+    <Typography>
+      <Trans>
+        {cabinets} cabinets, {total}
+      </Trans>
+    </Typography>
+  )
+}
+\`\`\``;export const generatePhoenixStateSlicesFeature=()=>e({path:"features/state/slices.md",title:"State slices",summary:"The rendered, committed and potentially invalid slices and the hooks that read them; read when UI shows configuration state, such as a live label during a drag or a price summary.",whenToUse:"Read when UI shows configuration state: choosing between a live preview and the committed configuration, picking a reading hook, or keeping an element from re-rendering on every drag frame. Writing changes belongs to [Updates and dry runs](updates.md).",capabilities:"### The three slices\n\nThe store keeps three slices. Each emits a state emission `{ kind, state, validity }`; an update emission adds `previousState` and `updates`.\n\n- **`rendered`** — every valid state, committed or staged: gesture previews and hover included. The scene renders from it. An invalid staged state is not emitted, so the preview stays at the last valid one.\n- **`committed`** — every valid committed state: what is saved, what undo records and what finalizing checks.\n- **`potentiallyInvalid`** — every attempted commit, rejected ones included. No reading hook targets it; configurator messages report its rejections ([Messages](../custom-layout/messages.md)).\n\n`state` is `{ rootEntityId, rootEntityType, entities, ephemeralRecords }`:\n\n- `entities` are raw entities: own fields only, no `$` expressions or relations. Read the `$` entity through the entity hooks below.\n- `ephemeralRecords` hold navigation, view, tool, selection, hover and drag state. They are never saved, and a commit that changes only them makes no undo step. Read them with the hooks of [Application states](../application-states/index.md), not by scanning records.\n\n### Choose a slice\n\n- **Rendered** — what must follow a gesture while it happens: a dimension label during a drag, an in-scene overlay, a live preview of the value being changed.\n- **Committed** — what must not flicker with previews or show a state nobody accepted: price, summaries, step completion, enabling Next or Finalize, analytics, data sent to a server.\n- Never mix them in one value: a price computed from rendered state shows prices of positions a drag only passed through.\n\n### Reading hooks\n\nEach pair reads the committed slice first, the rendered slice second:\n\n- `phx.frontend.useStoreSelector(select, deps)` \xb7 `phx.frontend.useRenderedSelector(select, deps)` — `select(emission)` returns any value. An optional third argument `false` pauses updates, for hidden UI.\n- `phx.frontend.useEntitySelector(id, select, deps)` \xb7 `phx.frontend.useRenderedEntitySelector(id, select, deps)` — `select($entity, emission)` for one entity.\n- `phx.frontend.useRootEntitySelector(select, deps)` \xb7 `phx.frontend.useRenderedRootEntitySelector(select, deps)` — the same for the root entity.\n- `phx.frontend.useEntityState(id)` — the committed `$` entity. It takes the id only and has no rendered twin on `phx.frontend`; use `useRenderedEntitySelector`.\n- `phx.frontend.useRootEntityState()` \xb7 `phx.frontend.useRootEntityRenderedState()` — the root `$` entity.\n- `phx.frontend.useRootEntityId()` \xb7 `phx.frontend.useRootEntityRenderedId()` — the root entity's id.\n- `phx.frontend.useCommittedState()` \xb7 `phx.frontend.useRenderedState()` — the whole `state`.\n- `phx.frontend.useCommittedSlice()` \xb7 `phx.frontend.useRenderedSlice()` — the whole emission, `validity` included. Neither takes an argument.\n- `phx.frontend.useStoreSelector$(select, deps)` \xb7 `phx.frontend.useRenderedSelector$(select, deps)` — an RxJS observable of the selected value, for work outside rendering such as a debounced request in an effect. It replays the current value and emits for every emission, equal or not: add `distinctUntilChanged()`.\n\nThe entity hooks throw for an id the state does not contain: take ids from the slice you read, and drop an id once its entity is deleted. In event handlers and async flows, read `storeSystem.stateSlices.committed.value.state` from `phx.frontend.useDomain()` when the code runs; a value captured during render may be stale by then.\n\n### Keep re-renders narrow\n\n- A selector runs for every emission of its slice; the component re-renders only when the result changes. Results compare shallowly: a primitive by value, an object or array member by member, each member by reference.\n- Return primitives, ids, counts or tuples of them. A relation such as `$shelves`, and anything built from it, is a new array on every state, so returning it re-renders every time: return its `length` or its ids.\n- The whole-object hooks (`useEntityState`, `useRootEntityState`, `useRootEntityRenderedState`, the state and slice hooks) compare the whole entity or state. An entity re-renders its component when one of its fields or expression values changes, and a relation is a new array on every state, so an entity with relations, such as the root, re-renders on every commit, and on every drag frame for the rendered ones. Keep them for small panels; use a selector in elements mounted per entity or shown during gestures.\n- List in `deps` every component value the selector reads, as for `useMemo`; the entity selectors add the id themselves. A missing dependency keeps a stale selector.\n- Treat every returned value as immutable. Move expensive derivations into [expressions](../domain-model/expressions.md), which are cached per state, rather than computing them in selectors.",example:t,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- `docs/performance/render-isolation.mdx` — rendered entity selectors that keep a large scene smooth while dragging, and why their results must compare equal.\n- `docs/phoenix/state-management.mdx` — slices, the emission lifecycle, validity results and the selector hooks.\n- `docs/phoenix/configurator-interface.mdx` — "Core Hooks": the slice, selector and entity hooks with a sample call each.',phxMembers:["frontend.useStoreSelector","frontend.useRenderedSelector","frontend.useStoreSelector$","frontend.useRenderedSelector$","frontend.useEntitySelector","frontend.useRenderedEntitySelector","frontend.useRootEntitySelector","frontend.useRenderedRootEntitySelector","frontend.useEntityState","frontend.useRootEntityState","frontend.useRootEntityRenderedState","frontend.useRootEntityId","frontend.useRootEntityRenderedId","frontend.useCommittedState","frontend.useRenderedState","frontend.useCommittedSlice","frontend.useRenderedSlice"]});

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

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The state index followed by its guides: reading the store, writing it, and how violations surface. */
+export declare const generatePhoenixStateGuides: () => readonly PhoenixGuide[];

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

@@ -0,0 +1 @@
+import{createPhoenixIndexGuide as t}from"../../guide.js";import{generatePhoenixStateSlicesFeature as e}from"./slices.js";import{generatePhoenixUpdatesFeature as o}from"./updates.js";import{generatePhoenixViolationsFeature as a}from"./violations.js";export const generatePhoenixStateGuides=()=>{let n=[e(),o(),a()];return[t({path:"features/state/index.md",title:"State",summary:"Reading and writing the configuration at runtime and how violations surface; read when UI or a handler reads or changes the configuration, or must reflect what a change breaks.",intro:"The configurator keeps the configuration in a store. The slices hold the states UI can read; updates stage and commit changes, and dry runs test them first; the violations of those states disable control options, become hints and block finalizing. Read only the guide for the task. Declaring invariants belongs to [Validation and repair](../domain-model/validation-and-repair.md), transformers to [Transformers](../domain-model/transformers.md), and the controls that write for you to [Domain controls](../domain-controls/index.md).",guides:n,notes:[]}),...n]};

package/dist/application-spec/generate-application/code/templates/skills/features/state/updates.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Writing the configuration: update kinds, the stage and commit cycle, dry runs, undo steps and update guards. */
+export declare const generatePhoenixUpdatesFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/state/updates.js

@@ -0,0 +1,39 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A width scrubber no configured control covers: every position is previewed, the release commits once, and the drag is one undo step. A width that breaks an invariant is not previewed, so the cabinet stays at the last valid width; a rejected release reverts the preview and becomes a message.
+
+\`\`\`tsx
+// src/_shared/WidthScrubber.tsx
+import { Slider } from '@mui/material'
+
+export const WidthScrubber = ({ cabinetId }: { readonly cabinetId: Cabinet['id'] }) => {
+  const { storeSystem } = phx.frontend.useDomain()
+  const width = phx.frontend.useRenderedEntitySelector(cabinetId, cabinet => cabinet.width, [])
+
+  const preview = (value: number | number[]) => {
+    if (typeof value !== 'number') {
+      return
+    }
+
+    // Replaces the previous preview: the whole change from the committed state
+    storeSystem.stage([
+      phx.frontend.updates.DomainEntityModification({
+        entityId: cabinetId,
+        stateDelta: { width: value },
+        updateTag: 'cabinet.scrubWidth',
+      }),
+    ])
+  }
+
+  return (
+    <Slider
+      value={width}
+      min={400}
+      max={1200}
+      step={10}
+      onChange={(_event, value) => preview(value)}
+      onChangeCommitted={() => storeSystem.commit()}
+    />
+  )
+}
+\`\`\`
+
+A discrete action is one call, such as \`storeSystem.stageAndCommit([phx.frontend.updates.EntityDeletion({ entityId, updateTag: 'cabinet.remove' })])\`. When configurator users pick it among options, a control with a dry run is the better home.`;export const generatePhoenixUpdatesFeature=()=>e({path:"features/state/updates.md",title:"Updates and dry runs",summary:"Update kinds, the stage, commit and rollback cycle, dry runs and undo steps; read when code writes the configuration or a transformer must stay cheap.",whenToUse:"Read when code writes the configuration outside a configured control, previews a change during a gesture, dry-runs a change to decide whether to offer it, needs ids for new entities, or narrows updates in a transformer.",capabilities:"### Choose the write path\n\n- Write through the control hooks of [Custom controls](../domain-controls/custom-controls.md) first: they build updates, dry-run options, stage gestures and commit. `phx.frontend.useUpdateControl(fixableViolations)` returns `prepare(updates)`, which dry-runs any updates and returns `{ disabled, hints, update, stage, trace }`.\n- Use the store system only when no control hook fits: a gesture you drive yourself, a write from a toolbar action, dialog or handler, a confirmation before a commit, or work that waits for a gesture to end.\n- `phx.frontend.useDomain()` returns the stable domain systems (`storeSystem`, `domain`, `undoSystem`, `navigationSystem`, `componentReader`, the projections), safe in dependency arrays. Navigation and selection changes belong to [Application states](../application-states/index.md).\n- Transformers return update arrays and never write to the store ([Transformers](../domain-model/transformers.md)).\n\n### Build updates\n\nEach `phx.frontend.updates` factory takes one object with an `updateTag` naming the change, such as `'cabinet.scrubWidth'`; `withTag` filters, the guards below and analytics read it. An optional localizable `hint` reaches configurator users as a side-effect message on commit: set it when a transformer changes something they did not touch.\n\n- `DomainEntityModification({ entityId, stateDelta, updateTag })` — sets some of the entity's own fields, never `id` or `type`.\n- `DomainEntityCreation({ entity, parentId, updateTag })` — adds a complete entity, optionally to the reference component instance named by `collection`. Build it with `phx.domain.createRecipe({ type, … })`, which fills the spec defaults, and replace its placeholder id. For children from recipes, prefer `phx.frontend.useCookRecipes`, which assigns ids.\n- `DomainEntityReplacement({ entityId, replacementEntity, keepChildren, updateTag })` — swaps in a new entity with a new id; `keepChildren: false` deletes its composed children.\n- `EntityDeletion({ entityId, updateTag })` — removes an entity; built-in transformers delete its composed children and prune references to it.\n- `ComponentModification({ componentInstance, writableState, updateTag })` — writes a component's writable state, as built-in controls do; it throws for a state the component rejects.\n\n`phx.frontend.getIdSequence(entities, pendingUpdates)` returns `{ nextId(type) }`, above every existing id and every id created or replaced in `pendingUpdates`. Draw a batch's ids from one sequence: two sequences from one state return the same id. In a transformer, use the context's `getIdSequence()`.\n\n### Stage, commit and roll back\n\n- `storeSystem.stage(updates)` runs transformers and invariants against the committed state and previews a valid result in the rendered slice; an invalid stage previews nothing. Each call replaces the staged updates: stage the whole change from the committed state, never a delta.\n- `storeSystem.commit()` prepares the staged updates again, runs the `onBeforeCommit` hooks and commits a valid result. A rejected commit keeps the committed state, resets the preview and reaches configurator messages through the potentially invalid slice.\n- `storeSystem.rollback()` drops the staged updates and their preview.\n- `storeSystem.stageAndCommit(updates)` writes a discrete action in one step: a click, a toggle, an add.\n- `storeSystem.hasStagedUpdates` is `true` while a staged change is pending; a hover stages nothing. It is a getter, not a subscription: check it before snapshotting the committed state, such as for an export.\n- `storeSystem.onBeforeCommit((emission, emit) => …)` runs before every commit and returns its unregister function; register it in an effect. Returning `false` holds the commit, such as to confirm a destructive change: the preview rolls back, and `emit()` commits that emission later. The hooks run again then, so let it through.\n- Leave `storeSystem.commitPrepared` to the SDK's own operations.\n\n### Dry runs\n\n- `storeSystem.prepareStateEmission(updates, storeSystem.stateSlices.committed.value.state, 'committed')` returns the emission a commit would produce, `{ state, validity, updates, … }`, without emitting it. Controls dry-run every option this way ([Violations](violations.md)).\n- Transformers and invariants run in a dry run exactly as in a commit, with the kind `'committed'`, so a transformer cannot tell them apart: `onEmissionsOfKind(['committed'])` skips staged previews but not dry runs.\n- Every mounted control dry-runs each option after every commit: ten options run the transformer pipeline and every invariant ten times per change. Staging runs them on every frame of a gesture.\n- Keep transformers pure and cheap: no requests, storage, analytics or React state.\n\n### Undo steps\n\n- One commit that changes entities is one undo step, transformer updates included, so a transformer's repair undoes with the change that caused it.\n- A commit that changes only navigation, view, tool or selection state makes no step.\n- Staged frames make no steps, but `stageAndCommit` on every keystroke or slider tick makes one each: stage while the value changes and commit once, on release or blur. [Toolbar actions](../custom-layout/toolbar-actions.md) covers the undo and redo buttons.\n\n### Update guards\n\nNarrow updates in a transformer (`ctx.updates`, `overrideAllUpdates`) or in an `onBeforeCommit` emission:\n\n- `phx.frontend.isCreateEntityUpdate(update, types)`, `phx.frontend.isReplaceEntityUpdate(update, types)` and `phx.frontend.isDeleteEntityUpdate(update, types)` — an entity of `types` added or replaced from a recipe, or removed by a built-in delete control. They check the SDK's own tags, so your own `EntityDeletion` does not match.\n- `(update, types, instanceName)` guards — the write of one built-in control on one component instance: `phx.frontend.isAttributeSelectionUpdate`, `phx.frontend.isAttributeSwitchUpdate`, `phx.frontend.isTextValueUpdate`, `phx.frontend.isSwatchSelectionUpdate`, `phx.frontend.isGenericDimensionUpdate`, `phx.frontend.isDistanceDimensionUpdate`, `phx.frontend.isAngleDimensionUpdate`.\n- A built-in step at priority `Infinity` turns component writes into entity modifications. Transformers default to that priority and run after it, and `onBeforeCommit` sees its result, so the control guards never match there. Give such a transformer a finite `priority` in its `transformers:` entry, or filter with `when.entity([...]).modified({ atFields })`.",example:t,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- `docs/other-features/transformers.mdx` — the transformer guide, including a component trigger registered with a finite priority.\n- `docs/complex-use-cases/navigation-guard.mdx` — an `onBeforeCommit` hook that holds a commit until configurator users confirm.\n- `docs/phoenix/state-management.mdx` — the stage, commit and rollback cycle and the emission kinds.\n- `docs/phoenix/configurator-interface.mdx` — "Updates Factory" and "Update Type Guards": every factory member, a control that dry-runs its updates, and the guards.',phxMembers:["frontend.updates","frontend.getIdSequence","frontend.useDomain","frontend.isCreateEntityUpdate","frontend.isReplaceEntityUpdate","frontend.isDeleteEntityUpdate","frontend.isAngleDimensionUpdate","frontend.isDistanceDimensionUpdate","frontend.isGenericDimensionUpdate","frontend.isAttributeSelectionUpdate","frontend.isAttributeSwitchUpdate","frontend.isTextValueUpdate","frontend.isSwatchSelectionUpdate"]});

package/dist/application-spec/generate-application/code/templates/skills/features/state/violations.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** How violations disable control options, become hint text and gate Next and Finalize at runtime. */
+export declare const generatePhoenixViolationsFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/state/violations.js

@@ -0,0 +1,36 @@
+import{createPhoenixFeatureGuide as t}from"../../guide.js";let i=`A missing purpose is a \`warning\`: the change stays, the purpose step's Next waits for it, and finalizing waits for it like for every other warning. Its priority puts its text alone in the finalize hint while lower-ranked warnings also hold.
+
+\`\`\`yaml
+# spec/invariants.yaml
+invariants:
+  KitchenRange:
+    purposeRequired:
+      type: purpose-required
+      severity: warning
+      message:
+        $msg: Choose a purpose before continuing
+      controlViolationPriority: 10
+\`\`\`
+
+\`\`\`tsx
+// src/_shared/PurposeNextButton.tsx
+import { Trans } from '@lingui/react/macro'
+import { Button, Tooltip } from '@mui/material'
+
+export const PurposeNextButton = () => {
+  const { canGoNext, next } = phx.frontend.useStepNavigation()
+  const { violations } = phx.frontend.useFinalizeViolations()
+  const resolve = phx.frontend.useResolveLocalizable()
+  const missing = violations?.find(({ violation }) => violation.type === 'purpose-required')
+
+  return (
+    <Tooltip title={missing ? resolve(missing.violation.message ?? missing.violation.type) : ''}>
+      <span>
+        <Button variant="contained" disabled={!canGoNext || missing !== undefined} onClick={() => next()}>
+          <Trans>Next</Trans>
+        </Button>
+      </span>
+    </Tooltip>
+  )
+}
+\`\`\``;export const generatePhoenixViolationsFeature=()=>t({path:"features/state/violations.md",title:"Violations",summary:"How violations disable control options, become hints and gate finalizing; read when a control or button must reflect what a change would break or what still blocks the configuration.",whenToUse:"Read when a control must show what an option would break, when hint text needs ranking or custom wording, or when Next or Finalize must wait for the configuration's problems. Declaring invariants, choosing a severity and repairing with transformers belong to [Validation and repair](../domain-model/validation-and-repair.md).",capabilities:"### Where violations surface\n\n- **Controls** — every option is dry-run ([Updates and dry runs](updates.md#dry-runs)). An option is `disabled` when its dry run, after transformers, still has a `fatal` or `fixable` violation or an invariant throws; its hint is the text of those violations. A `warning` or `notice` never disables an option.\n- **Messages** — a rejected commit reaches the potentially invalid slice, and its violations become configurator messages. They include every violation of that state, notices and warnings too, so check `violation.severity`. [Messages](../custom-layout/messages.md) owns showing them.\n- **Finalizing** — reads the committed state: a `warning` or a failed save blocks it, a `notice` only adds text.\n\n### Control violations\n\n`phx.frontend.useControlViolations(ignoredTypes)` returns a function from a prepared emission to `{ disabled, hints, violations }`:\n\n- no violation — enabled, no hint;\n- `notice` or `warning` — enabled, no hint, `violations` listed;\n- `fatal` or `fixable` — disabled, `hints` from those violations, `violations` all of them;\n- an invariant that throws — disabled, no hint. A transformer that throws is not caught: the control's render throws.\n\nPrefer `phx.frontend.useUpdateControl` from [Custom controls](../domain-controls/custom-controls.md), which prepares the emission and applies this mapping. Call `useControlViolations` yourself only for an emission you prepared, such as a dialog listing from `violations` what an option would break.\n\n`fixableViolations`, an argument of every control hook and of both update hooks, only removes those violation types from the hint text: the option stays disabled. List a type when another part of the UI explains it. To keep an option enabled, repair the violation in a transformer, so its dry run ends valid.\n\n### Hint text\n\n- Hints keep only the violations with the highest `controlViolationPriority` (default 0), drop duplicates and join several as sentences. Rank a root cause above its consequences, such as size above color.\n- Ignored types are removed before the highest priority is found, so ignoring the top-ranked violation shows the next one.\n- Set `controlViolationPriority` on a YAML invariant or on a violation returned from TypeScript. The finalize hint applies the same ranking.\n- A TypeScript violation may add `formatControlViolationMessage(emission, { i18n })`: a hint naming the attempted value, or `null` to drop this hint, such as for all but one of identical violations. Messages keep using `message`.\n- `message` is optional on a TypeScript violation, and messages fall back to its type. In YAML it is a string or `$msg`; [Localization](../localization.md) covers the catalogs.\n- `phx.frontend.useMapViolationHints(ignoreTypes?)` returns `(violations, emission) => string`, the hint text these rules make from any violations. For the committed state, take the emission from `phx.frontend.useCommittedSlice()`.\n\n### Finalize and step gating\n\n`phx.frontend.useFinalizeViolations()` returns `{ disabled, hints, violations }` for the committed state:\n\n- `disabled` while a `warning` holds or the last save failed; `hints` then says why, and `violations` is `undefined` for a failed save;\n- a `notice` leaves it enabled, with its text in `hints`;\n- `violations` lists the committed state's violations, `undefined` when there are none.\n\n`phx.frontend.useStateValidity()` returns the validity of the last committed emission: `{ valid: true, severity: null }`, or `{ valid: true, severity: 'warning' | 'notice', entityViolations }`. A `fatal` or `fixable` violation is never committed, so a `warning` is the problem the committed state can still have. Its type also lists the rejected results: narrow on `severity` before reading `entityViolations`.\n\n- Gate Finalize with `disabled` and show `hints` beside it; `useFinalizeActions` already returns both ([Finalization actions](../custom-layout/finalization-actions.md)).\n- Next enforces nothing by itself ([Tabs and steps](../custom-layout/tabs-and-steps.md)). Gate it with `disabled` and show `hints`. `useStateValidity().severity === 'warning'` holds it for the configuration alone, ignoring a failed save, and gives no text.\n- When a step waits only for its own problems, filter `violations` by their types and word them with `useMapViolationHints`.",example:i,documentation:'Read each with `pnpm phoenix docs -r <path>`:\n\n- `docs/other-features/violation-messages.mdx` — `controlViolationPriority` and `formatControlViolationMessage` worked through four ranked violations, with localized hint text.\n- `docs/other-features/violation-severity.mdx` — what each severity does to controls and finalizing; [Validation and repair](../domain-model/validation-and-repair.md) owns choosing one.\n- `docs/complex-use-cases/filtered-controls-with-fix-dialog.mdx` — controls ordered so transformers repair lower choices, with `fixableViolations` shortening each hint.\n- `docs/phoenix/configurator-interface.mdx` — "Violations" lists the violation hooks with what each returns.',phxMembers:["frontend.useControlViolations","frontend.useFinalizeViolations","frontend.useStateValidity","frontend.useMapViolationHints"]});

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

@@ -0,0 +1,2 @@
+import { type PhoenixGuide } from '../guide.js';
+export declare const generatePhoenixVariantsFeature: () => PhoenixGuide;

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

@@ -0,0 +1 @@
+import{createPhoenixFeatureGuide as e}from"../guide.js";export const generatePhoenixVariantsFeature=()=>e({path:"features/variants.md",title:"Variants",summary:"Supported alternative types, preview constraints and usage; read when preparing a comparison in the live preview and applying the choice.",whenToUse:"Read when preparing a visual or interaction comparison in the running preview. The [workflow](../core/workflow.md#visual-choices) owns whether alternatives would help; this guide covers the supported options and how to collect and apply a choice.",capabilities:'### Option types\n\n- Use `<id>.variant.js` to edit real frontend project files on top of one captured baseline. Use `<id>.html` for a standalone branding, layout or flow proposal rendered in an iframe.\n- Use the same mechanism for controls, layout, brand, lights, visuals, materials, positions, components, elements and transformers.\n- Keep the model, schemas, data, assistant server settings, webhooks and code shared with them, dependencies, environment and uploaded assets unchanged. The preview rejects changes needing server preparation.\n- Options reuse the already loaded configurator, one at a time. Variant transactions bypass the file-watcher debounce; hot reload still takes time to apply, without a special wait for rendering to settle.\n\n### Design the comparison\n\n- One decision per set, one set open at a time. Vary the decision being compared and keep unrelated details identical.\n- Make the difference visible in the UI or the scene; similar materials in flat light may not distinguish the alternatives.\n- Choose the number of options that clarifies the decision; no fixed count is required.\n- Name options in the client\'s product language and explain what changes in one line.\n\n### Write the options\n\n- One folder per set: `.phoenix/variants/<name>/`, one script or HTML file per option. HTML and scripts can share a set, but option ids must be unique. Keep HTML self-contained. This folder survives rebuilds and is never committed.\n- For HTML, set `<title>` and `<meta name="description" content="...">`; choosing a page changes no source files.\n- For scripts, export `title` and `description` as plain string literals, and a default function `({ read, write, remove }) => {}`; it may be async.\n- `read(path)` returns the original baseline file contents. `write(path, contents)` replaces or creates a file; `remove(path)` deletes it. Paths are relative to the project root.\n- Scripts run once per selection in the browser and collect edits. Phoenix validates and writes the whole batch locally and owns backups and undo. Do not perform your own filesystem or network operations.\n- Supported edits are YAML in `spec/` outside `spec/admin/`, and TypeScript under `src/components`, `transformers`, `handlers`, `elements` and `_`-prefixed shared folders. Expressions and invariants run on the server too; those folders and action files are outside the supported edit surface.\n- Every option starts from the same baseline. Original restores it; switching restores the files only the previous option changed.\n- Keep the working tree untouched while comparing. Phoenix never overwrites an edit made outside the preview: it refuses to switch options over one, and when the comparison ends it leaves that file as it is and warns in the dev log.\n\n### Run it and wait\n\n```bash\npnpm phoenix variants .phoenix/variants/<name> --title \'<the question>\' --description \'<what differs between the options>\'\n```\n\n- `pnpm phoenix dev` must be running with the preview open in a browser. Tell the client the options are open there.\n- Put the title and the description in single quotes, so the shell passes backticks, `$` and double quotes through unchanged. In bash or zsh, write a single quote inside them as `\'\\\'\'`; in PowerShell, double it instead.\n- The command waits for the answer, 540 seconds unless `--timeout <seconds>` says otherwise, so give it a command timeout longer than that. It prints JSON:\n  - `"status": "chosen"` with `choice` (the option id, or `null` for Original) and `label`;\n  - `"status": "waiting"` when the wait ran out. The options stay open: run the same command again, or end the turn and run it when the client is back. An answer given in between is returned by the next run;\n  - `"status": "closed"` when the preview was closed without an answer.\n- `pnpm phoenix variants --close` closes the open set when the comparison is abandoned.\n- `--port <port>` names the editor WebSocket port when `phoenix dev` does not use 3020.\n- The live configurator keeps its current configuration. Interactions still change it; restoring source files does not undo configuration changes.\n\n### Use the answer\n\n- **Chosen** — a script\'s exact file edits remain in the project. For an HTML choice, implement the selected proposal using the SDK and compare the result with the page. With `choice: null`, the client chose Original and the baseline remains. Verify the result with `pnpm phoenix inspect:scene` and `pnpm phoenix screenshot`, and tell the client anything that came out differently.\n- Record the decision and its reason in the [project record](../core/workflow.md#records).\n- The client confirms Original or another option; Escape and the backdrop do not close the comparison. `--close` restores the baseline source files without an answer. The folder is removed once the client answers; pass `--keep` while its files are still needed to build from, and remove the folder afterwards.',example:"Compare warm and neutral lighting with two variant scripts while keeping the product and camera unchanged. Use HTML proposals instead when comparing standalone pages, such as branding sheets, then implement the selected proposal in the project. Original remains available as the captured baseline.",documentation:"Read `docs/phoenix/phoenix-cli.mdx` with `pnpm phoenix docs -r docs/phoenix/phoenix-cli.mdx` for the CLI contract. Use the [review index](../processes/review/index.md) to select evidence for the applied result.",phxMembers:[]});

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/assistant-setup.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The assistant setup handler that narrows the assistant per session. */
+export declare const generatePhoenixAssistantSetupFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/assistant-setup.js

@@ -0,0 +1,32 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let s=`A configurator user who opens a shared configuration may ask about it but not change it:
+
+\`\`\`yaml
+# spec/assistant.yaml
+assistant:
+  instructions: Help the visitor choose a chair and explain the finishes.
+  ai:
+    provider: openai
+    model: balanced
+    reasoning: low
+  entities:
+    Chair:
+      label:
+      finish:
+  writable:
+    Chair:
+      finish:
+\`\`\`
+
+\`\`\`ts
+// src/handlers/assistant-setup.ts
+export default phx.domain.createAssistantSetupHandler((manifest, { access }) =>
+  access === 'o'
+    ? manifest
+    : {
+        ...manifest,
+        writable: {},
+        deletable: {},
+        instructions: 'The visitor is viewing a shared configuration. Describe it and answer questions; never offer to change it.',
+      }
+)
+\`\`\``;export const generatePhoenixAssistantSetupFeature=()=>e({path:"features/webhooks/assistant-setup.md",title:"Assistant setup",summary:"`phx.domain.createAssistantSetupHandler`, which narrows what the assistant may see and change per session or switches it off; read when the assistant must behave differently by role, session data or access.",whenToUse:"Read when the assistant must offer less to some sessions — viewers of a shared configuration, anonymous users, a customer group — or none at all.",capabilities:"### The handler\n\n- `phx.webhooks` has no builder for it: default-export `phx.domain.createAssistantSetupHandler((manifest, { role, sessionData, access }) => manifest)` from a file in `src/handlers/`, at most one per project. The file joins the webhook automatically, so it imports only server-safe modules ([Webhook entry and environment](entry-and-environment.md)).\n- The SDK calls it for every assistant session with the manifest the `assistant` spec declares, and uses what it returns. Return `null` to switch the assistant off for the session.\n- `role` and `sessionData` come from [authentication](authentication.md); `access` is how the configuration was opened, such as `o` for its owner.\n\n### What it may change\n\n- Narrow, never widen: leave out entries of `entities`, `writable`, `deletable`, `actions` and the recipe maps to hide them. Entries keep the entity and alias split of the YAML; narrow those original declarations and the SDK expands them to member types afterwards.\n- Writable options accept only `validate: true` and `allowDryRuns: false`; recipe groups accept a `description` and `allowDryRuns: false`; screenshot views accept a `description`; deletable entries are `{}`. Names, component bindings, hints and types are fixed by the spec.\n- `instructions` and `ai` change the server's prompt and model. An empty `instructions` string clears the spec's instructions; an omitted one keeps them. `ai.voice` turns voice messages and the replies read aloud on or off for the session; the panel follows the server, so it shows the mic, the play buttons and the mute control exactly when the server takes them.\n- The assistant's buttons and panel follow the spec, not the handler; hide them per session in the layout, for example with `$filter`.\n\n### Constraints\n\n- Keep it synchronous, pure and deterministic: it runs in the browser and in the webhook, and both must reach the same manifest.\n- In the browser the manifest has no `instructions` or `ai`, and what the handler returns for them is ignored. Never decide the other entries from `manifest.ai`, or the browser's schema would differ from the server's.\n- A handler that throws or returns an invalid manifest leaves the assistant unavailable for the session. Deployed environments reuse a session's setup for up to 15 minutes; under `phoenix dev` it runs on every request, within 15 seconds.",example:s,documentation:"The shipped SDK docs do not cover the assistant setup handler yet; [Webhook entry and environment](entry-and-environment.md) covers how its file joins the webhook.",phxMembers:["domain.createAssistantSetupHandler"]});

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/authentication.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The auth hook: its flows, what a handler returns and how the session reaches the rest of the project. */
+export declare const generatePhoenixWebhookAuthenticationFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/authentication.js

@@ -0,0 +1,42 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let s=`Dealers arrive from a portal with a code; everyone else browses with retail prices:
+
+\`\`\`yaml
+# spec/session.yaml
+useAuthHook: true
+sessionData:
+  type: object
+  properties:
+    customerGroup:
+      type: string
+      enum:
+        - retail
+        - dealer
+  additionalProperties: false
+\`\`\`
+
+\`\`\`ts
+// src/webhooks/auth.ts
+export const authHandler = phx.webhooks.authHandlerBuilder
+  .withCodeHandler(async ({ accessToken }, { logger }) => {
+    const response = await fetch(\`\${phx.webhooksEnv.CRM_API_URL}/dealers/me\`, {
+      headers: { authorization: \`Bearer \${accessToken}\` },
+    })
+
+    if (!response.ok) {
+      logger.warn(\`The CRM refused the dealer token with status \${response.status}.\`)
+
+      return { success: false }
+    }
+
+    const dealer: { readonly id: string } = await response.json()
+
+    return {
+      success: true,
+      role: 'user',
+      data: { customerGroup: 'dealer' },
+      userId: dealer.id,
+    }
+  })
+  .withAnonymousHandler(async () => ({ success: true, role: 'anonymous', data: { customerGroup: 'retail' } }))
+  .build()
+\`\`\``;export const generatePhoenixWebhookAuthenticationFeature=()=>e({path:"features/webhooks/authentication.md",title:"Authentication",summary:"The auth hook: code, refresh, anonymous and Clerk flows, roles, session data and expiry; read when the configurator signs users in or treats some of them differently.",whenToUse:"Read when configurator users sign in, arrive from a host application, need different roles or prices, or when anonymous access must be refused.",capabilities:"### When the hook runs\n\n- With `useAuthHook: true` every configurator session starts with a call to the hook. Without it every configurator user gets an anonymous session and the hook never runs. Clerk sign-in needs `useClerk: true` as well, which adds the Clerk credentials to the webhook.\n- Build the hook with `phx.webhooks.authHandlerBuilder` and register it with `withAuthHook` in the [entry](entry-and-environment.md). What the browser sends picks the flow:\n  - **Code** — a host application's backend deposited its token with the platform and handed the configurator a one-time code. `withCodeHandler` receives `{ accessToken, refreshToken?, idToken? }` and decides who the configurator user is.\n  - **Refresh** — the session expired and the browser holds a refresh token an earlier answer returned. `withRefreshHandler` receives `{ refreshToken }`.\n  - **Anonymous** — neither. `withAnonymousHandler` grants or refuses a session to configurator users who are not signed in; without it their sessions fail.\n- `withClerkCodeHandler()`, `withClerkSessionHandler()` and `withClerkRefreshHandler()` add the Clerk flows, which are tried before the custom handlers. The session handler rejects banned Clerk users.\n- Under `phoenix dev` the hook has 15 seconds to answer.\n\n### What a handler returns\n\n- `{ success: false }` refuses the session. `{ success: true, role, data }` grants it:\n  - `role` — `anonymous`, `user`, `admin` or `superadmin`. The admin roles also open Project Admin.\n  - `data` — the session data, validated strictly against the spec's `sessionData` schema. The schema declares no required properties, because Admin and preset sessions carry no custom session data, so code reading it handles a missing field. Later webhook calls read it as `data.sessionPayload`, and the configurator reads it as session data. It is readable in the browser, so it never holds a credential configurator users must not see, such as an API key.\n  - `userId` — the stable id of the person, so their configurations and assistant threads follow them.\n  - `refreshToken` — returned to the browser for the refresh flow; return one only together with a refresh handler.\n  - `expirationTime` — when the session ends, as a Unix timestamp in seconds, not a duration. Leave it out: the three-hour default is what the platform's session tracking assumes, so change it only when the client needs other session lengths.\n- `withPublishedChunkScopes(({ role, data }) => [...])` grants the published-data chunk scopes a session may read; `public` is always granted. Read `docs/phoenix/publishing.mdx` before scoping chunks.",example:s,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/sessions-and-access.mdx` — sessions, roles, the session user and access to configurations.\n- `docs/phoenix/clerk-sign-in.mdx` — Clerk sign-in, its handlers and pages.\n- `docs/phoenix/integration/authentication-internal.mdx` and `authentication-external.mdx` — a host application signing its users in with a code.",phxMembers:["webhooks.authHandlerBuilder"]});

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/backend-data.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Backend data: the webhook handler that fetches per-session data, when it runs and how the project reads it. */
+export declare const generatePhoenixWebhookBackendDataFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/backend-data.js

@@ -0,0 +1,45 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let a=`Lead times depend on the customer group and come from the CRM:
+
+\`\`\`yaml
+# spec/backend-data.yaml
+backendData:
+  type: object
+  properties:
+    leadTimeDays:
+      type: number
+  required:
+    - leadTimeDays
+  additionalProperties: false
+\`\`\`
+
+\`\`\`ts
+// src/webhooks/backend-data.ts
+type FetchBackendData = Parameters<typeof phx.webhooks.webhookBuilder.withFetchBackendData>[0]
+
+const FALLBACK_LEAD_TIME_DAYS = 28
+
+const fetchLeadTimeDays = async (customerGroup: string): Promise<number> => {
+  const response = await fetch(\`\${phx.webhooksEnv.CRM_API_URL}/lead-times/\${customerGroup}\`, {
+    headers: { authorization: \`Bearer \${phx.webhooksEnv.CRM_API_TOKEN}\` },
+  })
+
+  if (!response.ok) {
+    throw new Error(\`The CRM answered with status \${response.status}.\`)
+  }
+
+  const { days }: { readonly days: number } = await response.json()
+
+  return days
+}
+
+export const fetchBackendData: FetchBackendData = async ({ sessionPayload }, { logger }) => {
+  try {
+    return { backendData: { leadTimeDays: await fetchLeadTimeDays(sessionPayload.customerGroup ?? 'retail') } }
+  } catch (error) {
+    // The fallback keeps the configurator and every finalization working while the CRM is down
+    logger.warn(\`Lead times are unavailable (\${String(error)}); using \${FALLBACK_LEAD_TIME_DAYS} days.\`)
+
+    return { backendData: { leadTimeDays: FALLBACK_LEAD_TIME_DAYS } }
+  }
+}
+\`\`\``;export const generatePhoenixWebhookBackendDataFeature=()=>e({path:"features/webhooks/backend-data.md",title:"Backend data",summary:"Data the webhook fetches per session, such as stock, lead times or customer prices, and how expressions and tasks read it; read when the configurator needs data only the server may fetch.",whenToUse:"Read when a value depends on who is configuring or changes faster than published content, and fetching it needs a credential the browser must not see.",capabilities:"### When it runs\n\n- Declare a `backendData` schema; without one the configurator never asks for backend data. Register the handler with `withFetchBackendData` in the [entry](entry-and-environment.md).\n- The configurator asks for it when it loads and again whenever its frontend data changes, and the webhook runs the handler again before every [finalization](finalization.md). The two answers can differ, and finalization uses its own.\n- A failure in the browser's request leaves backend data `undefined` and the configurator keeps running, so expressions handle `undefined`. A failure before finalization fails the finalization: catch what may fail and return a safe value when one exists.\n- Under `phoenix dev` the handler has 15 seconds to answer, and an answer above 5 MiB is refused.\n\n### What it receives and returns\n\n- The handler receives `{ sessionRole, sessionPayload, frontendData, frontendUrl, deploymentId }` and the `logger`, and returns `{ backendData }`, validated against the schema.\n- Backend data is readable in the browser. Fetch with the credentials in the webhook and return only what the configurator may show.\n- Expressions read it as `ctx.backendData` ([Expressions](../domain-model/expressions.md)) and webhook tasks as `data.backendData`. Both are `Record<string, unknown> | undefined`: the schema validates the handler's answer but does not type what reads it, so narrow each value before use.\n- Choose backend data for values that depend on who is configuring or change too often to publish: stock, lead times, customer prices. Published data suits catalogue content, frontend data what the embedding page passes in.",example:a,documentation:"Read `docs/phoenix/data-sources.mdx` with `pnpm phoenix docs -r docs/phoenix/data-sources.mdx` for every data source and its lifetime; its backend data section shows the frontend side.",phxMembers:[]});

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/entry-and-environment.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** The webhook entry, which project code joins the webhook, and its environment variables. */
+export declare const generatePhoenixWebhookEntryFeature: () => PhoenixGuide;

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/entry-and-environment.js

@@ -0,0 +1,38 @@
+import{createPhoenixFeatureGuide as e}from"../../guide.js";let t=`A quote configurator reads its CRM and integration credentials from the environment and registers the hooks the other webhook guides implement:
+
+\`\`\`yaml
+# spec/webhook-env.yaml
+env:
+  webhook:
+    CRM_API_URL:
+      type: url
+      required: true
+      devDefault: http://localhost:4000
+    CRM_API_TOKEN:
+      type: str
+      required: true
+    QUOTE_SENDER:
+      type: str
+      default: quotes@example.com
+    WOOCOMMERCE_SHOP_URL:
+      type: url
+    WOOCOMMERCE_API_KEY:
+      type: str
+    QUOTES_SPREADSHEET_ID:
+      type: str
+    GOOGLE_SERVICE_ACCOUNT_JSON:
+      type: str
+\`\`\`
+
+\`\`\`ts
+// src/webhooks/index.ts
+import { authHandler } from './auth.js'
+import { fetchBackendData } from './backend-data.js'
+import { quoteFinalization } from './finalization.js'
+
+export default phx.webhooks.webhookBuilder
+  .withAuthHook(authHandler)
+  .withFetchBackendData(fetchBackendData)
+  .withConfiguratorFinalize(quoteFinalization)
+  .build()
+\`\`\``;export const generatePhoenixWebhookEntryFeature=()=>e({path:"features/webhooks/entry-and-environment.md",title:"Webhook entry and environment",summary:"`src/webhooks/index.ts`, which project code runs on the server, browser-import limits and `env.webhook` variables; read when creating the webhook, adding server code or a secret, or fixing a webhook parse or build error.",whenToUse:"Read when the project needs server-side code — sign-in, backend data, finalization — or a credential, or when parsing or the build names a webhook file.",capabilities:"### The entry\n\n- The webhook is the project's server side: one bundle the platform calls for sign-in, backend data, finalization and its callback, Admin publishing and assistant setup. A deployed environment runs it as a cloud function; `phoenix dev` runs it on the developer's machine through the development tunnel.\n- `src/webhooks/index.ts` is the entry and default-exports `phx.webhooks.webhookBuilder` with its hooks, then `.build()`. Only that file is imported; other files in `src/webhooks/` run when it imports them. Files in `src/webhooks/` without an `index.ts` fail with `MISSING_WEBHOOK_INDEX`.\n- The builder takes `withAuthHook` ([Authentication](authentication.md)), `withFetchBackendData` ([Backend data](backend-data.md)) and `withConfiguratorFinalize` ([Finalization](finalization.md)). Register only what the project uses. The SDK adds [Admin publishing](publishing.md) itself, and [assistant setup](assistant-setup.md) when the spec configures the assistant.\n- Without an entry the SDK builds a webhook that signs every configurator user in anonymously. `useAuthHook: true` or `useClerk: true` without an entry reports `AUTH_WITHOUT_PROJECT_WEBHOOK`.\n- A hook that throws answers with an error: the sign-in, the finalization or the publish fails. Its message reaches the server log, not the configurator user, so log what went wrong with the `logger` each hook receives.\n\n### Project code in the webhook\n\n- The spec's domain, expressions and invariants also run in the webhook. Action modules load in its shared domain assembly, but action implementations currently execute only in the browser, including assistant custom mutations. Components, admin components and handlers are frontend-only by default.\n- A handler module that calls `phx.domain.createAssistantSetupHandler` or one of the `phx.domain.admin` publishing and validation factories joins the webhook automatically. The call is detected literally, so do not alias it.\n- Make `'use webhook'` the first statement of another component or handler the server needs, such as one that prepares the scene for server rendering. Leading comments may precede it.\n- An included file and every local file it imports must not import the browser SDK entry points (`admin`, `application`, `configurator`, `editor`, `react`, `ui`, `extras/clerk`) or style, font and image files. Type-only imports are allowed. For files included by `'use webhook'` or a detected handler registration, parsing reports `WEBHOOK_UNSAFE_IMPORT` with the import chain; action modules are not covered by that parse-time check. Unsafe action imports can fail when the webhook is built or loaded. Move logic both sides need into a module without them, and keep rendering in a frontend-only file.\n\n### Environment variables and secrets\n\n- Declare variables under `env.webhook`: `type` is `bool`, `str`, `num` or `url`, with an optional `default`, `devDefault` (the value under `phoenix dev`) and `required`. A variable that is neither required nor defaulted is `undefined` when unset. Read them as `phx.webhooksEnv.NAME`.\n- Values are fixed when the webhook is built: a changed value needs a restart of `phoenix dev` locally and a new deploy on an environment. Deployed builds take values from the environment variables a workspace super admin sets in Studio; `phoenix dev` takes them from `.env`, which is not committed.\n- Keep credentials in the webhook. Session data, backend data and the finalization result all reach the browser, and `env.frontend` values are public.\n- `budgets.webhookGzipMb` fails the build when the compressed webhook grows past it; `phoenix build --onlyWebhook` builds the webhook alone.",example:t,documentation:"Read with `pnpm phoenix docs -r <path>`:\n\n- `docs/phoenix/webhooks.mdx` — the entry, the built-in webhook and environment variables.\n- `docs/phoenix/webhook-membership.mdx` — which files join the webhook and the server-safe import rule.\n- `docs/phoenix/sdk-builder-workflow.mdx` — setting environment variables in Studio.",phxMembers:["webhooks.webhookBuilder"]});

package/dist/application-spec/generate-application/code/templates/skills/features/webhooks/finalization.d.ts

@@ -0,0 +1,3 @@
+import { type PhoenixGuide } from '../../guide.js';
+/** Configurator finalization: the pipeline, task data and context, prefetch, resources, execution order and failure. */
+export declare const generatePhoenixWebhookFinalizationFeature: () => PhoenixGuide;