@salsita-ai/sdk 0.50.0-develop.da8d27f5d7 → 0.50.0-develop.ea458ea381

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/dist/application-spec/errors/diagnostic-codes.d.ts +6 -0
  2. package/dist/application-spec/errors/diagnostic-codes.js +1 -1
  3. package/dist/application-spec/errors/diagnostic-messages.d.ts +6 -0
  4. package/dist/application-spec/errors/diagnostic-messages.js +1 -1
  5. package/dist/application-spec/generate-application/code/domain-runtime-files.js +1 -1
  6. package/dist/application-spec/generate-application/code/templates/application-types.js +6 -6
  7. package/dist/application-spec/generate-application/code/templates/configurator-domain-code.d.ts +1 -0
  8. package/dist/application-spec/generate-application/code/templates/configurator-domain-code.js +11 -8
  9. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-domain-block.d.ts +3 -1
  10. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-domain-block.js +70 -66
  11. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-phx-globals.js +3 -0
  12. package/dist/application-spec/generate-application/code/templates/domain-spec.js +5 -5
  13. package/dist/application-spec/generate-application/code/templates/domain.js +2 -2
  14. package/dist/application-spec/generate-application/code/templates/global-definition/generate-action-types.d.ts +11 -0
  15. package/dist/application-spec/generate-application/code/templates/global-definition/generate-action-types.js +8 -0
  16. package/dist/application-spec/generate-application/code/templates/global-definition/index.d.ts +1 -0
  17. package/dist/application-spec/generate-application/code/templates/global-definition/index.js +1 -1
  18. package/dist/application-spec/generate-application/code/templates/globals.js +1 -0
  19. package/dist/application-spec/generate-application/code/templates/index.d.ts +6 -6
  20. package/dist/application-spec/generate-application/code/templates/index.js +1 -1
  21. package/dist/application-spec/generate-application/code/templates/skills/agents-md.js +2 -0
  22. package/dist/application-spec/generate-application/code/templates/skills/phoenix-cli-skill.js +1 -0
  23. package/dist/application-spec/generate-application/code/templates/{phoenix-create-configurator-skill.d.ts → skills/phoenix-create-configurator-skill.d.ts} +1 -1
  24. package/dist/application-spec/generate-application/code/templates/{phoenix-create-configurator-skill.js → skills/phoenix-create-configurator-skill.js} +1 -1
  25. package/dist/application-spec/generate-application/code/templates/{phoenix-feedback-skill.js → skills/phoenix-feedback-skill.js} +1 -1
  26. package/dist/application-spec/generate-application/code/templates/{phoenix-review-skill.js → skills/phoenix-review-skill.js} +6 -4
  27. package/dist/application-spec/generate-application/code/templates/skills/phoenix-skill.js +1 -0
  28. package/dist/application-spec/generate-application/code/templates/{common → skills}/sdk-content.d.ts +24 -1
  29. package/dist/application-spec/generate-application/code/templates/skills/sdk-content.js +67 -0
  30. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-runtime.d.ts +2 -0
  31. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-runtime.js +1 -1
  32. package/dist/application-spec/generate-application/runtime/sections/actions-runtime.d.ts +14 -0
  33. package/dist/application-spec/generate-application/runtime/sections/actions-runtime.js +1 -0
  34. package/dist/application-spec/generate-application/runtime/sections/index.d.ts +1 -0
  35. package/dist/application-spec/generate-application/runtime/sections/index.js +1 -1
  36. package/dist/application-spec/parse-application-files/categorize/categorize-files.d.ts +3 -1
  37. package/dist/application-spec/parse-application-files/categorize/categorize-files.js +1 -1
  38. package/dist/application-spec/parse-application-files/merge/index.d.ts +1 -0
  39. package/dist/application-spec/parse-application-files/merge/index.js +1 -1
  40. package/dist/application-spec/parse-application-files/merge/merged-actions.d.ts +11 -0
  41. package/dist/application-spec/parse-application-files/merge/merged-actions.js +1 -0
  42. package/dist/application-spec/parse-application-files/merge/merged-spec.d.ts +2 -0
  43. package/dist/application-spec/parse-application-files/merge/merged-spec.js +1 -1
  44. package/dist/application-spec/parse-application-files/raw-spec/index.d.ts +1 -0
  45. package/dist/application-spec/parse-application-files/raw-spec/index.js +1 -1
  46. package/dist/application-spec/parse-application-files/raw-spec/raw-actions.d.ts +18 -0
  47. package/dist/application-spec/parse-application-files/raw-spec/raw-actions.js +1 -0
  48. package/dist/application-spec/parse-application-files/raw-spec/raw-assistant.d.ts +14 -2
  49. package/dist/application-spec/parse-application-files/raw-spec/raw-assistant.js +1 -1
  50. package/dist/application-spec/parse-application-files/raw-spec/raw-spec-file.d.ts +2 -0
  51. package/dist/application-spec/parse-application-files/raw-spec/raw-spec-file.js +1 -1
  52. package/dist/application-spec/parse-application-files/resolve/resolve-import-modules.js +1 -1
  53. package/dist/application-spec/parse-application-files/spec/application/application-spec.js +1 -1
  54. package/dist/application-spec/parse-application-files/spec/application/configurator-spec/configurator-spec.d.ts +4 -2
  55. package/dist/application-spec/parse-application-files/spec/application/configurator-spec/configurator-spec.js +1 -1
  56. package/dist/application-spec/parse-application-files/spec/common/index.d.ts +1 -0
  57. package/dist/application-spec/parse-application-files/spec/common/index.js +1 -1
  58. package/dist/application-spec/parse-application-files/spec/common/schema-ref-resolver.d.ts +23 -0
  59. package/dist/application-spec/parse-application-files/spec/common/schema-ref-resolver.js +1 -0
  60. package/dist/application-spec/parse-application-files/spec/model/names/action-name.d.ts +10 -0
  61. package/dist/application-spec/parse-application-files/spec/model/names/action-name.js +1 -0
  62. package/dist/application-spec/parse-application-files/spec/model/names/index.d.ts +1 -0
  63. package/dist/application-spec/parse-application-files/spec/model/names/index.js +1 -1
  64. package/dist/application-spec/parse-application-files/spec/sections/actions.d.ts +35 -0
  65. package/dist/application-spec/parse-application-files/spec/sections/actions.js +1 -0
  66. package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-field-type.d.ts +3 -14
  67. package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-field-type.js +1 -1
  68. package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-schema.d.ts +12 -3
  69. package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-schema.js +1 -1
  70. package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant.d.ts +5 -3
  71. package/dist/application-spec/parse-application-files/spec/sections/index.d.ts +1 -0
  72. package/dist/application-spec/parse-application-files/spec/sections/index.js +1 -1
  73. package/dist/client/phoenix-api.d.ts +5 -1
  74. package/dist/configurator/application-runtime/extensions/configurator-extension-systems.d.ts +2 -1
  75. package/dist/configurator/application-runtime/extensions/configurator-extension-systems.js +1 -1
  76. package/dist/configurator/application-runtime/extensions/selectors.d.ts +2 -1
  77. package/dist/configurator/application-runtime/extensions/selectors.js +1 -1
  78. package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.d.ts +35 -0
  79. package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.js +1 -0
  80. package/dist/configurator/{assistant → application-runtime/extensions/systems/assistant-system}/browser-details.d.ts +1 -1
  81. package/dist/configurator/application-runtime/extensions/systems/assistant-system/browser-details.js +1 -0
  82. package/dist/configurator/{assistant → application-runtime/extensions/systems/assistant-system}/graphql-tools.d.ts +13 -14
  83. package/dist/configurator/application-runtime/extensions/systems/assistant-system/graphql-tools.js +1 -0
  84. package/dist/configurator/application-runtime/extensions/systems/graphql-system/graphql-system.js +1 -1
  85. package/dist/configurator/application-runtime/extensions/systems/index.d.ts +1 -0
  86. package/dist/configurator/application-runtime/extensions/systems/index.js +1 -1
  87. package/dist/configurator/assistant/use-assistant-chat.js +1 -1
  88. package/dist/docs/index.json +12 -2
  89. package/dist/docs/other-features/domain-actions.mdx +418 -0
  90. package/dist/docs/phoenix/best-practices.mdx +1 -0
  91. package/dist/docs/phoenix/migrations.mdx +45 -5
  92. package/dist/docs/phoenix/phoenix-cli.mdx +5 -3
  93. package/dist/docs/phoenix/project-structure.mdx +3 -0
  94. package/dist/docs/phoenix/sdk-builder-workflow.mdx +6 -4
  95. package/dist/domain/actions/action-factory.d.ts +10 -0
  96. package/dist/domain/actions/action-factory.js +1 -0
  97. package/dist/domain/actions/prepare-action-implementations.d.ts +15 -0
  98. package/dist/domain/actions/prepare-action-implementations.js +5 -0
  99. package/dist/domain/application/application-config.d.ts +3 -1
  100. package/dist/domain/application/assistant-mutations.d.ts +15 -14
  101. package/dist/domain/application/assistant-mutations.js +1 -1
  102. package/dist/domain/core/action.d.ts +67 -0
  103. package/dist/domain/core/action.js +1 -0
  104. package/dist/domain/core/domain-factory.d.ts +4 -0
  105. package/dist/domain/core/index.d.ts +1 -0
  106. package/dist/domain/domain-builder.d.ts +7 -0
  107. package/dist/domain/domain-builder.js +1 -1
  108. package/dist/domain/domain-context/action-system/action-system.d.ts +40 -0
  109. package/dist/domain/domain-context/action-system/action-system.js +1 -0
  110. package/dist/domain/domain-context/domain-context-systems.d.ts +5 -2
  111. package/dist/domain/domain-context/index.d.ts +1 -0
  112. package/dist/domain/domain-context/index.js +1 -1
  113. package/dist/domain/domain-runtime/domain-context/domain-context.js +1 -1
  114. package/dist/domain/domain-runtime/domain-context/selectors.d.ts +4 -0
  115. package/dist/domain/domain-runtime/domain-context/selectors.js +1 -1
  116. package/dist/domain/domain-runtime/domain-runtime.d.ts +12 -0
  117. package/dist/domain/domain-runtime/spec/initialize.js +1 -1
  118. package/dist/domain/domain-runtime/spec/types.d.ts +15 -1
  119. package/dist/domain/index.d.ts +2 -0
  120. package/dist/domain/index.js +1 -1
  121. package/dist/domain/mocks/create-mock-domain-runtime.d.ts +6 -0
  122. package/dist/editor/domain-editors/DomainSpecContext.js +1 -1
  123. package/dist/editor/domain-editors/apply-spec-update.js +1 -1
  124. package/dist/editor/domain-editors/use-implementation-files.d.ts +7 -3
  125. package/dist/editor/domain-editors/use-implementation-files.js +1 -1
  126. package/dist/phoenix/application-spec/generate-assistant-prompt.d.ts +2 -2
  127. package/dist/phoenix/application-spec/generate-assistant-prompt.js +1 -1
  128. package/dist/phoenix/commands/deploy.js +2 -2
  129. package/dist/phoenix/commands/login.d.ts +24 -6
  130. package/dist/phoenix/commands/login.js +2 -2
  131. package/dist/react-sdk/application-runtime/runtime/create-application-runtime.d.ts +12 -0
  132. package/dist/react-sdk/domain-context/common-hooks/use-domain-context.d.ts +3 -0
  133. package/package.json +3 -3
  134. package/dist/application-spec/generate-application/code/templates/agents-md.js +0 -2
  135. package/dist/application-spec/generate-application/code/templates/common/sdk-content.js +0 -67
  136. package/dist/application-spec/generate-application/code/templates/phoenix-cli-skill.js +0 -1
  137. package/dist/application-spec/generate-application/code/templates/phoenix-skill.js +0 -1
  138. package/dist/configurator/assistant/browser-details.js +0 -1
  139. package/dist/configurator/assistant/graphql-tools.js +0 -1
  140. /package/dist/application-spec/generate-application/code/templates/{common → skills}/agent-skill.d.ts +0 -0
  141. /package/dist/application-spec/generate-application/code/templates/{common → skills}/agent-skill.js +0 -0
  142. /package/dist/application-spec/generate-application/code/templates/{agents-md.d.ts → skills/agents-md.d.ts} +0 -0
  143. /package/dist/application-spec/generate-application/code/templates/{phoenix-cli-skill.d.ts → skills/phoenix-cli-skill.d.ts} +0 -0
  144. /package/dist/application-spec/generate-application/code/templates/{phoenix-feedback-skill.d.ts → skills/phoenix-feedback-skill.d.ts} +0 -0
  145. /package/dist/application-spec/generate-application/code/templates/{phoenix-review-skill.d.ts → skills/phoenix-review-skill.d.ts} +0 -0
  146. /package/dist/application-spec/generate-application/code/templates/{phoenix-skill.d.ts → skills/phoenix-skill.d.ts} +0 -0
@@ -1,5 +1,5 @@
1
1
  {
2
- "generatedAt": "2026-10-08T09:21:48.882Z",
2
+ "generatedAt": "2026-10-08T15:23:30.576Z",
3
3
  "categories": [
4
4
  {
5
5
  "name": "Phoenix",
@@ -26,7 +26,7 @@
26
26
  },
27
27
  {
28
28
  "title": "Best Practices",
29
- "description": "1. **YAML is king** - 99% of configuration should be in spec/\\*.yaml files 2. **Custom code locations** (in order of preference): - `src/expressions/` - Computed/derived properties -...",
29
+ "description": "1. **YAML is king** - 99% of configuration should be in spec/\\*.yaml files 2. **Custom code locations** (in order of preference): - `src/expressions/` - Computed/derived properties - `src/actions/` -...",
30
30
  "path": "docs/phoenix/best-practices.mdx",
31
31
  "category": [
32
32
  "Phoenix",
@@ -2479,6 +2479,16 @@
2479
2479
  ],
2480
2480
  "source": "storybook-example"
2481
2481
  },
2482
+ {
2483
+ "title": "Domain Actions",
2484
+ "description": "A plate carries holes, and a hole can be nudged by an offset as long as it stays on the plate. The arrow buttons of a selected hole and the AI assistant both make this change, so the rule (\"stay on...",
2485
+ "path": "docs/other-features/domain-actions.mdx",
2486
+ "category": [
2487
+ "Other features",
2488
+ "Domain Actions"
2489
+ ],
2490
+ "source": "storybook-example"
2491
+ },
2482
2492
  {
2483
2493
  "title": "Not Found (404)",
2484
2494
  "description": "Error page that is displayed when the configuration is not accesible.",
@@ -0,0 +1,418 @@
1
+ # Domain Actions
2
+
3
+ - [Use case](#use-case)
4
+ - [Declare the action](#declare-the-action)
5
+ - [Implement it](#implement-it)
6
+ - [Run it from the UI](#run-it-from-the-ui)
7
+ - [Expose it to the assistant](#expose-it-to-the-assistant)
8
+ - [Known gaps](#known-gaps)
9
+ - [Example](#example)
10
+
11
+ ## Use case
12
+
13
+ A plate carries holes, and a hole can be nudged by an offset as long as it stays on the plate. The arrow buttons of a selected hole and the AI assistant both make this change, so the rule ("stay on the plate") has to live in one place.
14
+
15
+ An **action** is that place: a named domain operation you declare once under `actions:`, implement in `src/actions/` with generated parameter and result types, and run from any control through `actionSystem.prepareAction()`. The same action is exposed to the assistant as a custom mutation by naming it under `assistant.actions`. Use an action whenever a change is more than writing one field: a swap, a move among siblings, a change that touches several entities at once.
16
+
17
+ ## Declare the action
18
+
19
+ `params` and `result` are maps of named JSON schemas, with the same `phx:` refs, `references`, `tsType` and `import` as entity shapes. A param whose schema allows `null` is optional; every other param is required. A result member typed `phx:$DomainEntity` is the enhanced entity after the change.
20
+
21
+ ```yaml
22
+ actions:
23
+ nudgeHole:
24
+ description: Moves a hole by an offset on the plate; the move fails when the hole would leave the plate
25
+ params:
26
+ holeId:
27
+ $ref: phx:DomainEntityId
28
+ references: Hole
29
+ description: The hole to move
30
+ dx:
31
+ type: integer
32
+ description: Offset along the x axis, in plate units
33
+ dy:
34
+ type: integer
35
+ description: Offset along the y axis, in plate units
36
+ result:
37
+ hole:
38
+ $ref: phx:$DomainEntity
39
+ references: Hole
40
+ description: The hole at its new position
41
+ plate:
42
+ $ref: phx:$DomainEntity
43
+ references: Plate
44
+ description: The plate after the move
45
+ ```
46
+
47
+ Generation derives the types `ActionTypes`, `ActionName`, `ActionParams<'nudgeHole'>` and `ActionResult<'nudgeHole'>` from it: here `ActionParams<'nudgeHole'>` is `{ holeId: Hole['id']; dx: number; dy: number }` and `ActionResult<'nudgeHole'>` is `{ hole: $Hole; plate: $Plate }`. The `description` of the action, of a param and of a result member becomes the doc comment of its generated property, so it shows in the editor wherever the action is implemented or called.
48
+
49
+ ## Implement it
50
+
51
+ A file in `src/actions/` default-exports `phx.domain.implementActions({...})` with any subset of the declared actions. The implementation receives the validated parameters, the state the action runs on, and a context with the `expressionContext`, the domain `systems`, `getIdSequence()` for entities it creates and the typed `updates` factory. It returns the updates it wants applied and `readResult`, which reads the result from the state those updates produced, including whatever the transformers added. It never stages or commits anything.
52
+
53
+ ```ts
54
+ // src/actions/nudge-hole.ts
55
+ export default phx.domain.implementActions({
56
+ nudgeHole: ({ holeId, dx, dy }, state, { systems: { domain }, updates }) => {
57
+ // `references: Hole` types the id, but any entity id passes the runtime check, so the entity is verified here.
58
+ const hole = state.entities.find(entity => entity.id === holeId)
59
+
60
+ if (hole?.type !== 'Hole') {
61
+ throw new Error(
62
+ `"${holeId}" is not a hole of the plate, so it cannot be nudged. Query the plate's holes and use an id they return.`
63
+ )
64
+ }
65
+
66
+ const x = hole.x + dx
67
+ const y = hole.y + dy
68
+
69
+ if (Math.abs(x) > 150 || Math.abs(y) > 150) {
70
+ throw new Error(
71
+ `Nudging "${holeId}" by (${dx}, ${dy}) would put it at (${x}, ${y}), outside the plate. Keep both coordinates between -150 and 150.`
72
+ )
73
+ }
74
+
75
+ return {
76
+ updates: [updates.DomainEntityModification({ entityId: hole.id, stateDelta: { x, y }, updateTag: 'nudgeHole' })],
77
+ readResult: ({ state: nudged }) => ({
78
+ hole: domain.get$Entity(holeId, nudged),
79
+ plate: domain.getRoot$Entity(nudged),
80
+ }),
81
+ }
82
+ },
83
+ })
84
+ ```
85
+
86
+ Throw to reject a call: the message reaches the user through the control's hint and the assistant through the failed mutation, so say what went wrong and what to send instead. An action declared without an implementation, or an implementation of a name the spec does not declare, is a type error. A declared action without an implementation also stops the domain from initializing, and under `phoenix dev` the editor reports it as a `MISSING_ACTION_IMPLEMENTATIONS` diagnostic and does not apply the change; an implementation of an undeclared name is logged.
87
+
88
+ ## Run it from the UI
89
+
90
+ `phx.frontend.useDomain().actionSystem.prepareAction(name, args, state)` validates `args` against the declared params and returns `{ updates, readResult }`. Hand the updates to `useUpdateControl()` like any other change: it dry-runs them for hints and commits them on click.
91
+
92
+ ```tsx
93
+ export default phx.frontend.createCustomPhoenixEntityElement('NudgeControl', ({ entityId }) => {
94
+ const { actionSystem } = phx.frontend.useDomain()
95
+ const state = phx.frontend.useCommittedState()
96
+ const prepare = phx.frontend.useUpdateControl()
97
+
98
+ const left = prepare(actionSystem.prepareAction('nudgeHole', { holeId: entityId, dx: -20, dy: 0 }, state).updates)
99
+
100
+ return (
101
+ <Button disabled={left.disabled} title={left.hints} onClick={left.update}>
102
+ ←
103
+ </Button>
104
+ )
105
+ })
106
+ ```
107
+
108
+ `prepareAction` throws for arguments that do not fit the params, for an unknown action and for whatever the implementation rejects, so a control that may ask for an impossible move catches the error and shows its message, as the example's control does.
109
+
110
+ ## Expose it to the assistant
111
+
112
+ Naming the action under `assistant.actions` adds a `Mutation` field with one argument per param and a `<Name>Result` type whose entity members are traversable edges. `as` renames the field, `description` replaces the action's.
113
+
114
+ ```yaml
115
+ assistant:
116
+ actions:
117
+ nudgeHole:
118
+ ```
119
+
120
+ ```graphql
121
+ type Mutation {
122
+ nudgeHole(holeId: ID!, dx: Int!, dy: Int!): NudgeHoleResult!
123
+ }
124
+
125
+ type NudgeHoleResult {
126
+ hole: Hole!
127
+ plate: Plate!
128
+ }
129
+ ```
130
+
131
+ The field runs the same `prepareAction`, applies the updates through the same validation as every other mutation, and fails with the action's message when the call is rejected.
132
+
133
+ ## Known gaps
134
+
135
+ - `references` on a `phx:DomainEntityId` param types the parameter and the GraphQL argument, but at runtime any entity id passes the params check: the implementation verifies that the id names an entity of the expected type, as the example does.
136
+ - Actions exist in the configurator domain only; the admin domain declares none.
137
+ - The result of `readResult` is not validated at runtime: the generated TypeScript type and the GraphQL coercion are the checks.
138
+ - The assistant cannot dry-run a custom mutation the way it dry-runs recipes and field options.
139
+ - `useDomain()` types `prepareAction` with the generic action map, so the name and the arguments are not checked against your `ActionTypes` at that call site; the implementation side is fully typed.
140
+
141
+ ## Example
142
+
143
+ Select a hole and nudge it with the arrows. A move that would leave the plate is disabled with the action's message.
144
+
145
+ ## Complete Implementation
146
+
147
+ {/* AUTO-GENERATED SECTION: This section is automatically updated by 'phoenix story build' */}
148
+
149
+ <details>
150
+ <summary>Click to view the complete implementation files</summary>
151
+
152
+ ### ./spec/domain.yaml
153
+
154
+ ```yaml
155
+ model:
156
+ latest:
157
+ entityTypes:
158
+ - Plate
159
+ - Hole
160
+ aliases:
161
+ RootEntity:
162
+ - Plate
163
+ shapes:
164
+ Hole:
165
+ x:
166
+ type: number
167
+ y:
168
+ type: number
169
+
170
+ relations:
171
+ Plate:
172
+ $holes:
173
+ kind: allOfType
174
+ target: Hole
175
+ cardinality: 0-N
176
+ composedOf: true
177
+ Hole:
178
+ $plate:
179
+ kind: allOfType
180
+ target: Plate
181
+ cardinality: 1-1
182
+ composedOf: false
183
+
184
+ expressions:
185
+ Hole:
186
+ $radius:
187
+ type: number
188
+
189
+ # A named domain operation: declared once, implemented in src/actions/, run by the NudgeControl
190
+ # element and by the assistant alike.
191
+ actions:
192
+ nudgeHole:
193
+ description: Moves a hole by an offset on the plate; the move fails when the hole would leave the plate
194
+ params:
195
+ holeId:
196
+ $ref: phx:DomainEntityId
197
+ references: Hole
198
+ description: The hole to move
199
+ dx:
200
+ type: integer
201
+ description: Offset along the x axis, in plate units
202
+ dy:
203
+ type: integer
204
+ description: Offset along the y axis, in plate units
205
+ result:
206
+ hole:
207
+ $ref: phx:$DomainEntity
208
+ references: Hole
209
+ description: The hole at its new position
210
+ plate:
211
+ $ref: phx:$DomainEntity
212
+ references: Plate
213
+ description: The plate after the move
214
+
215
+ assistant:
216
+ ai:
217
+ provider: openai
218
+ model: balanced
219
+ reasoning: low
220
+ entities:
221
+ Plate:
222
+ $holes:
223
+ description: The holes of the plate
224
+ Hole:
225
+ x:
226
+ y:
227
+ actions:
228
+ nudgeHole:
229
+
230
+ presets:
231
+ - rootEntityType: 'Plate'
232
+ initialDomainEntities:
233
+ - id: 'Plate-1'
234
+ type: 'Plate'
235
+ - id: 'Hole-1'
236
+ type: 'Hole'
237
+ x: -60
238
+ y: 40
239
+ - id: 'Hole-2'
240
+ type: 'Hole'
241
+ x: 70
242
+ y: -50
243
+
244
+ components:
245
+ Plate:
246
+ applicationConfig:
247
+ main:
248
+ layout: 'universal'
249
+ staticPerspectiveCamera:
250
+ main:
251
+ distance: 400
252
+ priority: 1
253
+ polarAngle: 1.2
254
+ azimuthAngle: -0.2
255
+ sceneEntityProperties:
256
+ main:
257
+ offsetX: -100
258
+ offsetY: -100
259
+ offsetZ: -10
260
+ sceneEntityObject:
261
+ Plate:
262
+ object:
263
+ $read: $render
264
+ detail:
265
+ main:
266
+ title: 'Plate'
267
+ subtitle: 'A plate with holes'
268
+ description: 'Select a hole to nudge it.'
269
+ Hole:
270
+ sceneEntityProperties:
271
+ main:
272
+ offsetX:
273
+ $read: x
274
+ offsetY:
275
+ $read: y
276
+ sceneEntitySelectHotspot:
277
+ main:
278
+ offsetX: 15
279
+ offsetY: 15
280
+ offsetZ: 30
281
+ detail:
282
+ main:
283
+ title: 'Hole'
284
+ subtitle: 'A hole in the plate'
285
+ description: 'Nudge it with the arrows; a hole cannot leave the plate.'
286
+ propertyPage:
287
+ main:
288
+ children:
289
+ - kind: propertyContainerGroup
290
+ props:
291
+ spacing: large
292
+ children:
293
+ - kind: customElement
294
+ props:
295
+ name: NudgeControl
296
+ ```
297
+
298
+ ### ./src/actions/nudge-hole.ts
299
+
300
+ ```ts
301
+ import { phx } from '../../.phoenix/phx.js'
302
+
303
+ /** How far a hole may sit from the plate's center on either axis, in plate units. */
304
+ const REACH = 150
305
+
306
+ export default phx.domain.implementActions({
307
+ nudgeHole: ({ holeId, dx, dy }, state, { systems: { domain }, updates }) => {
308
+ // `references: Hole` types the id, but any entity id passes the runtime check, so the entity is verified here.
309
+ const hole = state.entities.find(entity => entity.id === holeId)
310
+
311
+ if (hole?.type !== 'Hole') {
312
+ throw new Error(
313
+ `"${holeId}" is not a hole of the plate, so it cannot be nudged. Query the plate's holes and use an id they return.`
314
+ )
315
+ }
316
+
317
+ const x = hole.x + dx
318
+ const y = hole.y + dy
319
+
320
+ if (Math.abs(x) > REACH || Math.abs(y) > REACH) {
321
+ throw new Error(
322
+ `Nudging "${holeId}" by (${dx}, ${dy}) would put it at (${x}, ${y}), outside the plate. Keep both coordinates between ${-REACH} and ${REACH}.`
323
+ )
324
+ }
325
+
326
+ return {
327
+ updates: [updates.DomainEntityModification({ entityId: hole.id, stateDelta: { x, y }, updateTag: 'nudgeHole' })],
328
+ readResult: ({ state: nudged }) => ({
329
+ hole: domain.get$Entity(holeId, nudged),
330
+ plate: domain.getRoot$Entity(nudged),
331
+ }),
332
+ }
333
+ },
334
+ })
335
+ ```
336
+
337
+ ### ./src/elements/NudgeControl.tsx
338
+
339
+ ```tsx
340
+ import { Button, Stack } from '@mui/material'
341
+
342
+ import { PropertyContainer } from '@salsita-ai/sdk/ui'
343
+
344
+ import { phx } from '../../.phoenix/phx.js'
345
+
346
+ const STEP = 20
347
+
348
+ /** Nudges the selected hole with the same `nudgeHole` action the assistant calls, one step at a time. */
349
+ export default phx.frontend.createCustomPhoenixEntityElement('NudgeControl', ({ entityId }) => {
350
+ const { actionSystem } = phx.frontend.useDomain()
351
+ const state = phx.frontend.useCommittedState()
352
+ const prepare = phx.frontend.useUpdateControl()
353
+ const hole = state.entities.find(entity => entity.id === entityId)
354
+
355
+ if (hole?.type !== 'Hole') {
356
+ return <></>
357
+ }
358
+
359
+ // An action throws when the move leaves the plate; the button for that direction is then disabled with the message.
360
+ const nudge = (dx: number, dy: number) => {
361
+ try {
362
+ return prepare(actionSystem.prepareAction('nudgeHole', { holeId: hole.id, dx, dy }, state).updates)
363
+ } catch (error) {
364
+ return { disabled: true, hints: error instanceof Error ? error.message : String(error), update: () => {} }
365
+ }
366
+ }
367
+
368
+ const directions = [
369
+ { label: '←', dx: -STEP, dy: 0 },
370
+ { label: '→', dx: STEP, dy: 0 },
371
+ { label: '↑', dx: 0, dy: STEP },
372
+ { label: '↓', dx: 0, dy: -STEP },
373
+ ]
374
+
375
+ return (
376
+ <PropertyContainer.Item title="Nudge" description={`Moves the hole by ${STEP} units.`}>
377
+ <Stack direction="row" spacing={1}>
378
+ {directions.map(({ label, dx, dy }) => {
379
+ const control = nudge(dx, dy)
380
+
381
+ return (
382
+ <Button
383
+ key={label}
384
+ variant="outlined"
385
+ disabled={control.disabled}
386
+ title={control.hints ?? undefined}
387
+ onClick={event => {
388
+ event.stopPropagation()
389
+ control.update()
390
+ }}
391
+ >
392
+ {label}
393
+ </Button>
394
+ )
395
+ })}
396
+ </Stack>
397
+ </PropertyContainer.Item>
398
+ )
399
+ })
400
+ ```
401
+
402
+ ### ./src/expressions/plate.ts
403
+
404
+ ```ts
405
+ import { createPlate } from '../../../../common/plate-rendering.js'
406
+ import { phx } from '../../.phoenix/phx.js'
407
+
408
+ export default phx.domain.implementCustomExpressions({
409
+ Hole: {
410
+ $radius: () => 10,
411
+ },
412
+ Plate: {
413
+ $render: plate => createPlate({ features: plate.$holes }),
414
+ },
415
+ })
416
+ ```
417
+
418
+ </details>
@@ -5,6 +5,7 @@
5
5
  1. **YAML is king** - 99% of configuration should be in spec/\*.yaml files
6
6
  2. **Custom code locations** (in order of preference):
7
7
  - `src/expressions/` - Computed/derived properties
8
+ - `src/actions/` - Named domain operations declared under `actions:`
8
9
  - `src/invariants/` - Business rule constraints
9
10
  - `src/transformers/` - Automatic state fixers
10
11
  - `src/handlers/` - Event & lifecycle handlers
@@ -18,6 +18,8 @@ Each version defines its own:
18
18
 
19
19
  This versioning allows you to track changes over time and ensure proper migration paths.
20
20
 
21
+ The version number is not written anywhere: `latest` is the highest numbered version plus one, so a model with only `latest` is version 1. Once a version has been deployed it cannot change, because saved configurations depend on it. `phoenix deploy` refuses a model that differs from the one deployed under the same version, before anything is uploaded. To change a deployed model, keep it unchanged as `v<N>`, make the change in `latest` and add the migration to version N+1. Development environments replace the deployed model instead, so `phoenix dev` accepts every change.
22
+
21
23
  ## Model File Structure
22
24
 
23
25
  It's recommended to split your model versions into separate files for better maintainability:
@@ -39,9 +41,11 @@ The CLI generates separate TypeScript types for each version, which helps ensure
39
41
 
40
42
  ```typescript
41
43
  // The Migration type ensures you handle all entity types
42
- type Migration<FromEntity, ToEntity> = (state: FromEntity[]) => ToEntity[]
44
+ type Migration<FromEntity, ToEntity> = (state: readonly FromEntity[]) => readonly ToEntity[]
43
45
  ```
44
46
 
47
+ The types of each version are generated as global namespaces: `ModelV1`, `ModelV2`, and so on. `ModelV1.AnyDomainEntity` is the union of all entities of version 1, and `ModelV1.<EntityType>` is one of them. The admin model has its own namespaces, `AdminV1`, `AdminV2`, and so on. A migration needs no import for them.
48
+
45
49
  ## Migration File Location
46
50
 
47
51
  Migration files are organized in the `src/migrations/` directory with a specific naming convention:
@@ -63,11 +67,16 @@ Each migration file should export a function named `migrateToVN` where N is the
63
67
 
64
68
  ```typescript
65
69
  // src/migrations/v2.ts
66
- export const migrateToV2: Migration<V1Entity, V2Entity> = state => {
70
+ import type { Migration } from '@salsita-ai/sdk/domain'
71
+
72
+ export const migrateToV2: Migration<ModelV1.AnyDomainEntity, ModelV2.AnyDomainEntity> = state => {
67
73
  // Transform entities from v1 to v2
74
+ return state
68
75
  }
69
76
  ```
70
77
 
78
+ Keep the `Migration<...>` type on the export, with its `readonly` arrays: the generated domain file passes each migration to the migration builder, and a function typed with mutable arrays does not type-check there.
79
+
71
80
  **Note:** Migrations start from version 2. There is no migration TO v1 since v1 is the initial version. The first migration you write will be `migrateToV2`.
72
81
 
73
82
  The `ts-pattern` library is recommended for implementing migrations as it provides type-safe pattern matching.
@@ -77,11 +86,15 @@ The `ts-pattern` library is recommended for implementing migrations as it provid
77
86
  Migrations are implemented as functions that transform entities from one version to another. Each migration handles the transition between consecutive versions:
78
87
 
79
88
  ```typescript
80
- export const migrateToV4: Migration<V3Entity, V4Entity> = state => {
89
+ import { match } from 'ts-pattern'
90
+
91
+ import type { Migration } from '@salsita-ai/sdk/domain'
92
+
93
+ export const migrateToV4: Migration<ModelV3.AnyDomainEntity, ModelV4.AnyDomainEntity> = state => {
81
94
  return state.map(entity => {
82
95
  return (
83
96
  match(entity)
84
- .returnType<V4Entity>()
97
+ .returnType<ModelV4.AnyDomainEntity>()
85
98
  .with({ type: 'Burner' }, value => ({ ...value, y: 0 }))
86
99
  .with({ type: 'Cabinet' }, value => ({ ...value, y: 0 }))
87
100
  // ... handle other entities
@@ -91,6 +104,33 @@ export const migrateToV4: Migration<V3Entity, V4Entity> = state => {
91
104
  }
92
105
  ```
93
106
 
107
+ ### Renaming an Entity Type
108
+
109
+ An entity id starts with its entity type, such as `Box-1`, and is typed per entity type (`DomainEntityId<'Box'>`). The runtime validates that an entity's id matches its type, so an entity that keeps its data under a new type name needs a new id, and every relation that points at it must be rewritten to that id. The id is built from a string, which TypeScript cannot check, so this is one place where a cast is needed:
110
+
111
+ ```typescript
112
+ import { parseDomainEntityId } from '@salsita-ai/sdk/domain'
113
+
114
+ const toTableId = (id: ModelV1.Box['id']) =>
115
+ // The id is rebuilt for the new type name; nothing narrower than a cast can type a template string as an id
116
+ `Table-${parseDomainEntityId(id).sequenceNumber}` as ModelV2.Table['id']
117
+ ```
118
+
119
+ ### Replacing the Model Entirely
120
+
121
+ When the new model has nothing in common with the deployed one, there is nothing to convert. This is the case when a project that was first deployed as the starter gets its real model: the starter's `Box` model is version 1 in production, and a deployed version cannot change. Keep the deployed model as `v1`, define the real model in `latest`, and let the migration return the starting state of the new model, the `initialDomainEntities` of its preset:
122
+
123
+ ```typescript
124
+ // src/migrations/v2.ts
125
+ import type { Migration } from '@salsita-ai/sdk/domain'
126
+
127
+ export const migrateToV2: Migration<ModelV1.AnyDomainEntity, ModelV2.AnyDomainEntity> = () => [
128
+ // the entities of the new model's preset
129
+ ]
130
+ ```
131
+
132
+ No entity of a type that the new version no longer has may stay in the returned state: the migrated state is validated against the latest model, and an unknown entity type fails the load.
133
+
94
134
  ## Migration Runtime
95
135
 
96
136
  Migrations are executed automatically every time the domain is loaded, both in the client application and in webhooks. During this process:
@@ -114,7 +154,7 @@ When implementing migrations:
114
154
 
115
155
  4. **Testing**: Thoroughly test migrations with real-world data to ensure they handle all edge cases, use existing configurations from previous versions.
116
156
 
117
- 5. **Version Bumping**: Consider bumping the model version for both breaking changes (removing fields, changing types) and additive changes where existing data needs proper defaults. If you add a new required field, existing configurations need a migration to set that field's default value.
157
+ 5. **Version Bumping**: Every change to a model that has been deployed needs a new version, whether it is breaking (removing fields, changing types) or additive. If you add a new required field, existing configurations need a migration to set that field's default value; a change that needs no conversion still needs a migration that returns the state unchanged.
118
158
 
119
159
  ## Admin Model Migrations
120
160
 
@@ -569,9 +569,11 @@ SDK-builder workspaces sign the CLI in with a personal API token instead of proj
569
569
 
570
570
  Signs the CLI in to the SDK-builder workspace `<customer>`:
571
571
 
572
- 1. Opens Studio, where you approve the sign-in (use `--no-open` to only print the link).
572
+ 1. Opens Studio, where you name the token and approve the sign-in (use `--no-open` to only print the link). The page shows the workspace, your account, the computer the CLI runs on and how long the link still works. The CLI suggests the name `phoenix CLI on <computer>`; change it so you can tell your machines and agents apart later.
573
573
  2. Studio sends a one-time code back to the CLI on `127.0.0.1`.
574
- 3. The CLI exchanges the code for a token.
574
+ 3. The CLI exchanges the code for a token with the name you approved, and sends the browser back to Studio, which confirms the sign-in.
575
+
576
+ **Deny** in Studio stops the CLI at once: it exits with `The sign-in was denied in Studio` and no token is created. The link works for five minutes and only for the CLI that printed it; after that, Studio shows that it no longer works and the CLI gives up.
575
577
 
576
578
  The token is stored in `~/.phoenix/credentials.json`, readable only by you, per server, together with the Studio URL of the sign-in; `PHOENIX_CREDENTIALS_FILE` moves the file. The token works until you revoke it. Signing in again to the same server revokes the token it replaces; the CLI warns if the server could not revoke it.
577
579
 
@@ -592,7 +594,7 @@ Revokes the token on the server and removes it from the credentials file. `--reg
592
594
 
593
595
  ### `phoenix deploy`
594
596
 
595
- Validates the spec, adds the pnpm settings `phoenix init` writes to `pnpm-workspace.yaml` when they are missing, packs and uploads the project, starts its build on the server and follows it until the configurator is live. Once the build starts it prints `Follow the build in Studio: <url>`, the build's page in the Studio you signed in through; a sign-in stored by an older CLI has no Studio URL, so sign in again to get the link. `--region` or `--serverUrl` selects the server, as for `login`; `--no-wait` returns as soon as the build starts.
597
+ Validates the spec, adds the pnpm settings `phoenix init` writes to `pnpm-workspace.yaml` when they are missing, packs and uploads the project, starts its build on the server and follows it until the configurator is live. Before the upload the server compares the domain model with the deployed one: a model that changed under an already deployed model version is refused with the reason, and needs a new model version and a [migration](?path=/docs/phoenix-migrations--docs). Once the build starts it prints `Follow the build in Studio: <url>`, the build's page in the Studio you signed in through; a sign-in stored by an older CLI has no Studio URL, so sign in again to get the link. `--region` or `--serverUrl` selects the server, as for `login`; `--no-wait` returns as soon as the build starts.
596
598
 
597
599
  ### `phoenix feedback <message>`
598
600
 
@@ -40,6 +40,7 @@ project-root/
40
40
  | `components/` | Phoenix system components (ECS) |
41
41
  | `elements/` | Page elements (pages, providers) |
42
42
  | `expressions/` | Domain logic expressions |
43
+ | `actions/` | Implementations of the domain actions declared under `actions:` |
43
44
  | `invariants/` | Domain constraints |
44
45
  | `transformers/` | Data transformation logic |
45
46
  | `handlers/` | Event & lifecycle handlers |
@@ -249,6 +250,7 @@ project-root/
249
250
  │ ├── components/ # Phoenix system components (ECS)
250
251
  │ ├── elements/ # UI elements (pages, providers)
251
252
  │ ├── expressions/ # Domain logic expressions
253
+ │ ├── actions/ # Domain action implementations
252
254
  │ ├── invariants/ # Domain constraints
253
255
  │ ├── transformers/ # Data transformation logic
254
256
  │ ├── handlers/ # Event & lifecycle handlers
@@ -362,6 +364,7 @@ Domain logic files define the business rules and computed properties of your con
362
364
  | Purpose | Location | Example Files |
363
365
  | ------------ | ------------------- | ---------------------------------------------- |
364
366
  | Expressions | `src/expressions/` | `table.ts`, `legs.ts`, `module.ts` |
367
+ | Actions | `src/actions/` | `move-part.ts`, `swap-cabinets.ts` |
365
368
  | Invariants | `src/invariants/` | `top.ts`, `legs.ts` |
366
369
  | Transformers | `src/transformers/` | `fix-table-top-material-update-transformer.ts` |
367
370
  | Migrations | `src/migrations/` | `v2.ts`, `v3.ts`, `v4.ts` |
@@ -36,11 +36,11 @@ The starter `spec/application.yaml` begins with `project: default`, which means
36
36
  pnpm phoenix login <workspace>
37
37
  ```
38
38
 
39
- `phoenix login` opens Studio, where you approve the sign-in. Studio sends a one-time code back to the CLI on `127.0.0.1`, and the CLI exchanges it for a personal token. The code only works for the CLI that asked for it and expires after five minutes. Use `--no-open` to print the link instead of opening a browser.
39
+ `phoenix login` opens Studio, where you name the token and approve the sign-in. The CLI suggests `phoenix CLI on <computer>`; a name of your own, such as the agent and the machine, tells your tokens apart later. Studio sends a one-time code back to the CLI on `127.0.0.1`, the CLI exchanges it for a personal token and returns the browser to Studio, which confirms the sign-in. The code only works for the CLI that asked for it and expires after five minutes. **Deny** stops the waiting CLI at once and creates no token. Use `--no-open` to print the link instead of opening a browser.
40
40
 
41
41
  The CLI stores the token in `~/.phoenix/credentials.json`, readable only by you, with one entry per server. `PHOENIX_CREDENTIALS_FILE` moves the file. The token acts for you in your workspace until you revoke it. It stops working when you are removed from the workspace or banned.
42
42
 
43
- `pnpm phoenix logout` revokes the token and removes it from the file. Studio's **CLI tokens** page lists your tokens with when they were last used, and revokes any of them, for example one left on another computer.
43
+ `pnpm phoenix logout` revokes the token and removes it from the file. Studio's **CLI tokens** page lists your tokens by the names you gave them, with when they were last used, and revokes any of them, for example one left on another computer. A revoked token leaves the list.
44
44
 
45
45
  `login`, `logout` and `deploy` follow the region, not the `SERVER_URL` in the project's `.env`. `dev` follows the region too when `.env` has no `SERVER_URL`:
46
46
 
@@ -77,8 +77,9 @@ pnpm phoenix deploy
77
77
 
78
78
  1. It validates the application spec.
79
79
  2. It packs the project files: the `.yaml` files in `spec`, everything in `src`, `mocks`, `assets`, `public` and `templates`, and `package.json`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `.gitignore`, `CLAUDE.md` and `.cursor/rules/phoenix.mdc`. Every `node_modules`, `.phoenix` and `__generated` folder, every `.DS_Store` and `._*` file and every `.env` and `.env.*` file are left out, at any depth.
80
- 3. It uploads the archive, which may be up to 200 MB.
81
- 4. It starts the build, prints a link to the build's page in Studio and follows the build until your configurator is live, then prints its URL.
80
+ 3. It asks the server for a build. The server compares your domain model with the deployed one and refuses, before anything is uploaded, a model that changed under an already deployed model version; see [Migrations](?path=/docs/phoenix-migrations--docs).
81
+ 4. It uploads the archive, which may be up to 200 MB.
82
+ 5. It starts the build, prints a link to the build's page in Studio and follows the build until your configurator is live, then prints its URL.
82
83
 
83
84
  On the server, the install follows your `pnpm-lock.yaml` and `pnpm-workspace.yaml`, so it allows the same build scripts and package versions as `pnpm install` on your computer. The build runs without platform secrets. It sees only your own environment variables and the public platform values, the [build environment](?path=/docs/phoenix-phoenix-cli--docs) that `phoenix deployment:build-envs` writes. The trusted deploy step then publishes the frontend, webhooks and assets.
84
85
 
@@ -100,6 +101,7 @@ Coding agents working in your project use the same command, guided by the genera
100
101
  ## Known limits
101
102
 
102
103
  - You can deploy once the workspace's first deployment is live. Until then, `phoenix deploy` tells you the workspace is still being set up.
104
+ - The first deployment is the starter, so the starter's model is version 1 in production. Replacing it with your own model needs the starter's model kept as `v1` and a migration to version 2; [Migrations](?path=/docs/phoenix-migrations--docs) shows the migration for replacing a model entirely.
103
105
  - One workspace has one project, one `production` environment and one development environment per user.
104
106
  - `phoenix deploy` always deploys to the workspace's default project; it doesn't read `project` from the spec yet.
105
107
  - Only `phoenix dev` works from the sign-in. `phoenix deployment:prepare-dev` still needs the `.env` block of a Studio development environment.
@@ -0,0 +1,10 @@
1
+ import type { ActionImplementations, ActionTypes } from '../core/action.js';
2
+ import type { $DomainEntity, DomainEntity } from '../core/model.js';
3
+ /**
4
+ * Creates the `implementActions` factory the generated `domain-spec.ts` exposes as
5
+ * `phx.domain.implementActions`. A module in `src/actions/` implements any subset of the declared
6
+ * actions and gets each parameter and result typed from the spec; a name the spec does not declare
7
+ * is a type error, since its implementation would have to be `never`. The generated barrel merges
8
+ * the modules and checks that every declared action is implemented.
9
+ */
10
+ export declare const createActionFactory: <ENTITIES extends DomainEntity<string>, ALLOWED_ROOT_ENTITIES extends ENTITIES, $MAP extends Record<ENTITIES['type'], $DomainEntity<ENTITIES>>, PUBLISHED_DATA extends Record<string, unknown>, SESSION_DATA extends Record<string, unknown>, FRONTEND_DATA extends Record<string, unknown>, NAVIGATION_STATES extends string, VIEW_STATES extends string, TOOL_STATES extends string, EXPORT_STATES extends string, ACTION_TYPES extends ActionTypes>() => <IMPLEMENTATIONS extends Partial<ActionImplementations<ENTITIES, ALLOWED_ROOT_ENTITIES, $MAP, PUBLISHED_DATA, SESSION_DATA, FRONTEND_DATA, NAVIGATION_STATES, VIEW_STATES, TOOL_STATES, EXPORT_STATES, ACTION_TYPES>>>(implementations: IMPLEMENTATIONS & Readonly<Record<Exclude<keyof IMPLEMENTATIONS, keyof ACTION_TYPES>, never>>) => IMPLEMENTATIONS;
@@ -0,0 +1 @@
1
+ export const createActionFactory=()=>t=>t;