@salsita-ai/sdk 0.50.0-develop.bd84173265 → 0.50.0-develop.bded01bb03

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 (297) hide show
  1. package/README.md +8 -4
  2. package/dist/admin/default-admin-elements.d.ts +9 -0
  3. package/dist/admin/default-admin-elements.js +1 -0
  4. package/dist/admin/default-elements/built-in-entity-element.d.ts +10 -0
  5. package/dist/admin/default-elements/built-in-entity-element.js +1 -0
  6. package/dist/admin/default-elements/built-in-layout-element.d.ts +10 -0
  7. package/dist/admin/default-elements/built-in-layout-element.js +1 -0
  8. package/dist/admin/default-elements/index.d.ts +2 -0
  9. package/dist/admin/default-elements/index.js +1 -0
  10. package/dist/admin/index.d.ts +1 -0
  11. package/dist/admin/index.js +1 -1
  12. package/dist/application-spec/errors/diagnostic-codes.d.ts +1 -0
  13. package/dist/application-spec/errors/diagnostic-codes.js +1 -1
  14. package/dist/application-spec/errors/diagnostic-messages.d.ts +1 -0
  15. package/dist/application-spec/errors/diagnostic-messages.js +1 -1
  16. package/dist/application-spec/generate-application/code/common/code-imports.js +1 -1
  17. package/dist/application-spec/generate-application/code/common/env-reader.js +2 -2
  18. package/dist/application-spec/generate-application/code/common/index.d.ts +1 -0
  19. package/dist/application-spec/generate-application/code/common/index.js +1 -1
  20. package/dist/application-spec/generate-application/code/common/single-quoted-string.d.ts +6 -0
  21. package/dist/application-spec/generate-application/code/common/single-quoted-string.js +1 -0
  22. package/dist/application-spec/generate-application/code/domain-runtime-files.js +1 -1
  23. package/dist/application-spec/generate-application/code/project-scaffolding.d.ts +5 -7
  24. package/dist/application-spec/generate-application/code/project-scaffolding.js +2 -2
  25. package/dist/application-spec/generate-application/code/story-files.js +1 -1
  26. package/dist/application-spec/generate-application/code/templates/admin-config.js +3 -0
  27. package/dist/application-spec/generate-application/code/templates/common/format-property-key.d.ts +7 -0
  28. package/dist/application-spec/generate-application/code/templates/common/format-property-key.js +1 -0
  29. package/dist/application-spec/generate-application/code/templates/common/schema-to-type-string.js +3 -3
  30. package/dist/application-spec/generate-application/code/templates/domain-spec/factory-types/domain-factory-types.d.ts +35 -0
  31. package/dist/application-spec/generate-application/code/templates/domain-spec/factory-types/domain-factory-types.js +5 -0
  32. package/dist/application-spec/generate-application/code/templates/domain-spec/factory-types/index.d.ts +1 -0
  33. package/dist/application-spec/generate-application/code/templates/domain-spec/factory-types/index.js +1 -0
  34. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-component-optics.d.ts +1 -1
  35. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-component-optics.js +6 -6
  36. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-domain-block.js +59 -63
  37. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-invariants.d.ts +8 -0
  38. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-invariants.js +1 -1
  39. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-presets.js +1 -1
  40. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-resources.js +13 -13
  41. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-states.d.ts +1 -1
  42. package/dist/application-spec/generate-application/code/templates/domain-spec/generate-states.js +2 -2
  43. package/dist/application-spec/generate-application/code/templates/domain-spec/index.d.ts +2 -1
  44. package/dist/application-spec/generate-application/code/templates/domain-spec/index.js +1 -1
  45. package/dist/application-spec/generate-application/code/templates/global-definition/generate-phx-types.d.ts +43 -0
  46. package/dist/application-spec/generate-application/code/templates/global-definition/generate-phx-types.js +31 -0
  47. package/dist/application-spec/generate-application/code/templates/global-definition/index.d.ts +1 -0
  48. package/dist/application-spec/generate-application/code/templates/global-definition/index.js +1 -1
  49. package/dist/application-spec/generate-application/code/templates/globals.js +24 -43
  50. package/dist/application-spec/generate-application/code/templates/index.d.ts +2 -2
  51. package/dist/application-spec/generate-application/code/templates/index.js +1 -1
  52. package/dist/application-spec/generate-application/code/templates/skills/phoenix-cli-skill.js +1 -1
  53. package/dist/application-spec/generate-application/code/templates/skills/phoenix-create-configurator-skill.js +1 -1
  54. package/dist/application-spec/generate-application/code/templates/skills/phoenix-feedback-skill.js +5 -5
  55. package/dist/application-spec/generate-application/code/templates/skills/phoenix-review-skill.js +2 -2
  56. package/dist/application-spec/generate-application/code/templates/skills/phoenix-skill.js +1 -1
  57. package/dist/application-spec/generate-application/code/templates/skills/phoenix-variants-skill.js +2 -2
  58. package/dist/application-spec/generate-application/code/templates/skills/sdk-content.d.ts +13 -2
  59. package/dist/application-spec/generate-application/code/templates/skills/sdk-content.js +2 -2
  60. package/dist/application-spec/generate-application/code/templates/spec-code/collect-spec-code.d.ts +58 -0
  61. package/dist/application-spec/generate-application/code/templates/spec-code/collect-spec-code.js +1 -0
  62. package/dist/application-spec/generate-application/code/templates/spec-code/index.d.ts +2 -0
  63. package/dist/application-spec/generate-application/code/templates/spec-code/index.js +1 -0
  64. package/dist/application-spec/generate-application/code/templates/spec-code/spec-code.d.ts +18 -0
  65. package/dist/application-spec/generate-application/code/templates/spec-code/spec-code.js +41 -0
  66. package/dist/application-spec/generate-application/code/templates/spec-messages/index.d.ts +1 -0
  67. package/dist/application-spec/generate-application/code/templates/spec-messages/index.js +1 -0
  68. package/dist/application-spec/generate-application/code/templates/spec-messages/spec-messages.d.ts +20 -0
  69. package/dist/application-spec/generate-application/code/templates/spec-messages/spec-messages.js +6 -0
  70. package/dist/application-spec/generate-application/code/templates/story/phx-module.d.ts +8 -2
  71. package/dist/application-spec/generate-application/code/templates/story/phx-module.js +15 -3
  72. package/dist/application-spec/generate-application/code/templates/story/wrapper.d.ts +3 -0
  73. package/dist/application-spec/generate-application/code/templates/story/wrapper.js +2 -1
  74. package/dist/application-spec/generate-application/runtime/admin-runtime/admin-model-runtime.d.ts +2 -1
  75. package/dist/application-spec/generate-application/runtime/admin-runtime/admin-model-runtime.js +1 -1
  76. package/dist/application-spec/generate-application/runtime/admin-runtime/admin-runtime.d.ts +2 -1
  77. package/dist/application-spec/generate-application/runtime/admin-runtime/admin-runtime.js +1 -1
  78. package/dist/application-spec/generate-application/runtime/application-runtime.d.ts +8 -2
  79. package/dist/application-spec/generate-application/runtime/application-runtime.js +1 -1
  80. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-model-runtime.d.ts +2 -1
  81. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-model-runtime.js +1 -1
  82. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-runtime.d.ts +2 -1
  83. package/dist/application-spec/generate-application/runtime/configurator-runtime/configurator-runtime.js +1 -1
  84. package/dist/application-spec/generate-application/runtime/sections/build-sdk-optic.d.ts +2 -1
  85. package/dist/application-spec/generate-application/runtime/sections/build-sdk-optic.js +1 -1
  86. package/dist/application-spec/generate-application/runtime/sections/build-user-bound-optic.d.ts +2 -1
  87. package/dist/application-spec/generate-application/runtime/sections/build-user-bound-optic.js +1 -1
  88. package/dist/application-spec/generate-application/runtime/sections/component-optic.d.ts +3 -0
  89. package/dist/application-spec/generate-application/runtime/sections/component-optic.js +1 -1
  90. package/dist/application-spec/generate-application/runtime/sections/expression-runtime.d.ts +5 -3
  91. package/dist/application-spec/generate-application/runtime/sections/expression-runtime.js +1 -1
  92. package/dist/application-spec/generate-application/runtime/sections/generate-memo-eval-plan-runtime.d.ts +9 -5
  93. package/dist/application-spec/generate-application/runtime/sections/generate-memo-eval-plan-runtime.js +1 -1
  94. package/dist/application-spec/generate-application/runtime/sections/reflection-constants-runtime.d.ts +3 -1
  95. package/dist/application-spec/generate-application/runtime/sections/reflection-constants-runtime.js +1 -1
  96. package/dist/application-spec/generate-application/runtime/spec-code/index.d.ts +2 -0
  97. package/dist/application-spec/generate-application/runtime/spec-code/index.js +1 -0
  98. package/dist/application-spec/generate-application/runtime/spec-code/resolve-spec-code.d.ts +18 -0
  99. package/dist/application-spec/generate-application/runtime/spec-code/resolve-spec-code.js +1 -0
  100. package/dist/application-spec/generate-application/runtime/spec-code/spec-code-module.d.ts +17 -0
  101. package/dist/application-spec/generate-application/runtime/spec-code/spec-code-module.js +1 -0
  102. package/dist/application-spec/generate-application/runtime-spec/index.d.ts +1 -0
  103. package/dist/application-spec/generate-application/runtime-spec/index.js +1 -1
  104. package/dist/application-spec/generate-application/runtime-spec/spec-code-id.d.ts +40 -0
  105. package/dist/application-spec/generate-application/runtime-spec/spec-code-id.js +1 -0
  106. package/dist/application-spec/parse-application-files/categorize/categorize-files.js +1 -1
  107. package/dist/application-spec/parse-application-files/spec/expressions/expression-read-types.d.ts +9 -4
  108. package/dist/application-spec/parse-application-files/spec/expressions/expression-read-types.js +1 -1
  109. package/dist/application-spec/parse-application-files/spec/expressions/expression-value-type.d.ts +9 -0
  110. package/dist/application-spec/parse-application-files/spec/expressions/expression-value-type.js +1 -0
  111. package/dist/application-spec/parse-application-files/spec/expressions/expressions.js +1 -1
  112. package/dist/application-spec/parse-application-files/spec/expressions/user-expressions.d.ts +3 -1
  113. package/dist/application-spec/parse-application-files/spec/expressions/user-expressions.js +1 -1
  114. package/dist/configurator/application-runtime/extensions/systems/graphql-system/close-unclosed-braces.d.ts +12 -0
  115. package/dist/configurator/application-runtime/extensions/systems/graphql-system/close-unclosed-braces.js +1 -0
  116. package/dist/configurator/application-runtime/extensions/systems/graphql-system/graphql-system.d.ts +1 -1
  117. package/dist/configurator/application-runtime/extensions/systems/graphql-system/graphql-system.js +1 -1
  118. package/dist/configurator/common/configurator-interface.d.ts +11 -2
  119. package/dist/configurator/common/configurator-interface.js +1 -1
  120. package/dist/configurator/common/index.d.ts +2 -2
  121. package/dist/configurator/common/index.js +1 -1
  122. package/dist/configurator/configuration-not-found-page/ConfigurationNotFoundPageElement.d.ts +12 -0
  123. package/dist/configurator/configuration-not-found-page/ConfigurationNotFoundPageElement.js +1 -0
  124. package/dist/configurator/configuration-not-found-page/index.d.ts +1 -0
  125. package/dist/configurator/configuration-not-found-page/index.js +1 -0
  126. package/dist/configurator/configurator-context/PresetSelectionProvider.js +1 -1
  127. package/dist/configurator/pages/ConfiguratorNotFoundPage.js +1 -1
  128. package/dist/configurator/pages/DefaultNotAuthenticatedPage.d.ts +8 -0
  129. package/dist/configurator/pages/DefaultNotAuthenticatedPage.js +1 -0
  130. package/dist/configurator/pages/DefaultPresetUi.d.ts +7 -0
  131. package/dist/configurator/pages/DefaultPresetUi.js +1 -0
  132. package/dist/configurator/pages/NewConfiguratorPage.js +1 -1
  133. package/dist/configurator/pages/RootPage.js +1 -1
  134. package/dist/configurator/pages/default-configurator-elements.d.ts +4 -1
  135. package/dist/configurator/pages/default-configurator-elements.js +1 -1
  136. package/dist/configurator/pages/default-elements/built-in-entity-element.d.ts +1 -1
  137. package/dist/configurator/pages/default-elements/built-in-layout-element.d.ts +1 -1
  138. package/dist/configurator/preset-screen-elements/PresetDeviceNotSupportedElement.d.ts +4 -0
  139. package/dist/configurator/preset-screen-elements/PresetDeviceNotSupportedElement.js +1 -0
  140. package/dist/configurator/preset-screen-elements/PresetPageActionElement.d.ts +4 -0
  141. package/dist/configurator/preset-screen-elements/PresetPageActionElement.js +1 -0
  142. package/dist/configurator/preset-screen-elements/index.d.ts +2 -0
  143. package/dist/configurator/preset-screen-elements/index.js +1 -0
  144. package/dist/configurator/scene/scene-controls/DeleteEntityFab.js +1 -1
  145. package/dist/configurator/scene/scene-controls/SelectionHotspot.js +1 -1
  146. package/dist/configurator/ui/assistant/AssistantMarkdown.d.ts +1 -1
  147. package/dist/configurator/ui/assistant/AssistantMarkdown.js +1 -1
  148. package/dist/configurator/ui/assistant/entity-link/AssistantEntityLink.js +1 -1
  149. package/dist/configurator/ui/assistant/resource-image/AssistantImage.d.ts +9 -0
  150. package/dist/configurator/ui/assistant/resource-image/AssistantImage.js +1 -0
  151. package/dist/configurator/ui/assistant/resource-image/index.d.ts +3 -0
  152. package/dist/configurator/ui/assistant/resource-image/index.js +1 -0
  153. package/dist/configurator/ui/assistant/resource-image/resource-path.d.ts +11 -0
  154. package/dist/configurator/ui/assistant/resource-image/resource-path.js +1 -0
  155. package/dist/configurator/ui/assistant/resource-image/use-resource-image-url.d.ts +5 -0
  156. package/dist/configurator/ui/assistant/resource-image/use-resource-image-url.js +1 -0
  157. package/dist/configurator/ui/assistant/streamed-markdown.js +1 -1
  158. package/dist/configurator/ui/assistant/use-follow-stream.js +1 -1
  159. package/dist/configurator/ui/configurator-layout/slots/mobile-tabs/use-mobile-tabs.d.ts +1 -1
  160. package/dist/configurator/ui/configurator-layout/slots/mobile-tabs/use-mobile-tabs.js +1 -1
  161. package/dist/configurator/ui/configurator-layout/slots/services/InvariantViolations.js +1 -1
  162. package/dist/configurator/ui/configurator-layout/slots/services/Services.js +1 -1
  163. package/dist/configurator/ui/configurator-layout/slots/sidebar-tabs/use-sidebar-tabs.d.ts +1 -1
  164. package/dist/configurator/ui/configurator-layout/slots/sidebar-tabs/use-sidebar-tabs.js +1 -1
  165. package/dist/configurator/ui/legacy/layout/common/CommonFinalizeButton.js +1 -1
  166. package/dist/configurator/ui/legacy/layout/common/CommonSummaryButton.js +1 -1
  167. package/dist/configurator/ui/legacy/layout/common/CommonTopNavigation.js +1 -1
  168. package/dist/configurator/ui/legacy/layout/common/ResponsiveFinalizeButton.js +1 -1
  169. package/dist/configurator/ui/legacy/layout/common/SummaryReadLayout.js +1 -1
  170. package/dist/configurator/ui/legacy/layout/simple/SimpleOwnerLayout.js +1 -1
  171. package/dist/configurator/ui/legacy/layout/simple/SimpleTopNavigation.js +1 -1
  172. package/dist/configurator/ui/legacy/layout/steps/StepsNavigation.js +1 -1
  173. package/dist/configurator/ui/legacy/layout/steps/StepsOwnerLayout.js +1 -1
  174. package/dist/configurator/ui/legacy/layout/steps/StepsSidebarFooter.js +1 -1
  175. package/dist/configurator/ui/legacy/layout/tabs/TabsOwnerLayout.js +1 -1
  176. package/dist/configurator/ui/legacy/toolbar/common/DimensionUnitSelector.js +1 -1
  177. package/dist/configurator/ui/legacy/toolbar/common/MeasurementsIndicatorsSwitch.js +1 -1
  178. package/dist/configurator/ui/legacy/toolbar/desktop-toolbar/FullscreenToolbarAction.js +1 -1
  179. package/dist/configurator/ui/legacy/toolbar/desktop-toolbar/HelpToolbarAction.js +1 -1
  180. package/dist/configurator/ui/legacy/toolbar/desktop-toolbar/MeasurementsToolbarAction.js +1 -1
  181. package/dist/configurator/ui/legacy/toolbar/desktop-toolbar/UndoRedoToolbarGroup.js +1 -1
  182. package/dist/configurator/ui/phoenix-layout-elements/EnterFullscreenToolbarButton.js +1 -1
  183. package/dist/configurator/ui/phoenix-layout-elements/ExitFullscreenToolbarButton.js +1 -1
  184. package/dist/configurator/ui/phoenix-layout-elements/HelpToolbarButton.js +1 -1
  185. package/dist/configurator/ui/phoenix-layout-elements/LayoutCustomOwnerUi.d.ts +1 -0
  186. package/dist/configurator/ui/phoenix-layout-elements/LayoutCustomOwnerUi.js +1 -1
  187. package/dist/configurator/ui/phoenix-layout-elements/LayoutCustomReadUi.d.ts +1 -0
  188. package/dist/configurator/ui/phoenix-layout-elements/LayoutCustomReadUi.js +1 -1
  189. package/dist/configurator/ui/phoenix-layout-elements/MeasurementsToolbarButton.js +1 -1
  190. package/dist/configurator/ui/phoenix-layout-elements/RedoToolbarButton.js +1 -1
  191. package/dist/configurator/ui/phoenix-layout-elements/UndoToolbarButton.js +1 -1
  192. package/dist/configurator/ui/phoenix-layout-elements/header/common/back-button/use-go-back-action.js +1 -1
  193. package/dist/configurator/ui/phoenix-layout-elements/header/common/horizontal-tabs/DesktopHorizontalTabs.js +1 -1
  194. package/dist/configurator/ui/phoenix-layout-elements/header/common/step-navigation/StepsNavigation.js +1 -1
  195. package/dist/configurator/ui/phoenix-layout-elements/measurements/DimensionUnitSelector.js +1 -1
  196. package/dist/configurator/ui/phoenix-layout-elements/measurements/MeasurementsIndicatorsSwitch.js +1 -1
  197. package/dist/configurator/ui/phoenix-layout-elements/sidebar-footer/basic/BasicFinalizeButton.js +1 -1
  198. package/dist/configurator/ui/phoenix-layout-elements/sidebar-footer/common/CustomFinalizeButton.js +1 -1
  199. package/dist/configurator/ui/phoenix-layout-elements/sidebar-footer/common/EnterSummaryButton.js +1 -1
  200. package/dist/configurator/ui/phoenix-layout-elements/sidebar-footer/common/NextStepButton.js +1 -1
  201. package/dist/configurator/ui/phoenix-layout-elements/sidebar-footer/common/PreviousStepButton.js +1 -1
  202. package/dist/configurator/ui/preset-layout/CategoryPresetUi.js +1 -1
  203. package/dist/configurator/ui/preset-layout/PresetUi.d.ts +4 -0
  204. package/dist/configurator/ui/preset-layout/PresetUi.js +1 -1
  205. package/dist/configurator/ui/save-message-snackbars/SaveMessageSnackbars.d.ts +10 -0
  206. package/dist/configurator/ui/save-message-snackbars/SaveMessageSnackbars.js +1 -0
  207. package/dist/configurator/ui/save-message-snackbars/index.d.ts +1 -0
  208. package/dist/configurator/ui/save-message-snackbars/index.js +1 -0
  209. package/dist/docs/index.json +1 -1
  210. package/dist/docs/layouts/custom-layout.mdx +8 -7
  211. package/dist/docs/other-features/not-found-404.mdx +1 -1
  212. package/dist/docs/phoenix/clerk-sign-in.mdx +1 -1
  213. package/dist/docs/phoenix/configurator-interface.mdx +51 -22
  214. package/dist/docs/phoenix/getting-started.mdx +5 -3
  215. package/dist/docs/phoenix/layout-slots.mdx +19 -19
  216. package/dist/docs/phoenix/localization.mdx +2 -0
  217. package/dist/docs/phoenix/migration-guide.mdx +3 -3
  218. package/dist/docs/phoenix/phoenix-cli.mdx +22 -11
  219. package/dist/docs/phoenix/project-structure.mdx +45 -27
  220. package/dist/docs/phoenix/quickstart.mdx +7 -7
  221. package/dist/docs/phoenix/sdk-builder-workflow.mdx +6 -6
  222. package/dist/docs/phoenix/testing.mdx +8 -0
  223. package/dist/domain/application/assistant/generate-assistant-prompt.js +1 -1
  224. package/dist/domain/domain-runtime/spec/module-checks/element-registration.d.ts +12 -11
  225. package/dist/domain/domain-runtime/spec/module-checks/element-registration.js +1 -1
  226. package/dist/domain/domain-runtime/spec/module-checks/index.d.ts +1 -1
  227. package/dist/domain/domain-runtime/spec/module-checks/index.js +1 -1
  228. package/dist/domain/domain-runtime/spec/selectors.js +1 -1
  229. package/dist/editor/Editor.d.ts +7 -0
  230. package/dist/editor/Editor.js +1 -1
  231. package/dist/editor/mocks/CreateMockYaml.js +2 -2
  232. package/dist/editor/mocks/EditorMockContext.d.ts +2 -0
  233. package/dist/editor/mocks/EditorMockContext.js +1 -1
  234. package/dist/legacy/domain-cli/utils/cache.d.ts +1 -1
  235. package/dist/legacy/domain-cli/utils/cache.js +1 -1
  236. package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-admin.js +10 -11
  237. package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-embedded-admin.js +9 -10
  238. package/dist/phoenix/application-spec/application-spec-builder.d.ts +0 -2
  239. package/dist/phoenix/application-spec/application-spec-builder.js +1 -1
  240. package/dist/phoenix/application-spec/generate-application-spec-project.d.ts +0 -2
  241. package/dist/phoenix/application-spec/generate-application-spec-project.js +2 -2
  242. package/dist/phoenix/application-spec/generate-project-files.d.ts +0 -2
  243. package/dist/phoenix/cli.js +1 -1
  244. package/dist/phoenix/commands/build.js +1 -1
  245. package/dist/phoenix/commands/clean.js +1 -1
  246. package/dist/phoenix/commands/deploy.js +2 -2
  247. package/dist/phoenix/commands/deps/deps.d.ts +22 -1
  248. package/dist/phoenix/commands/deps/deps.js +2 -2
  249. package/dist/phoenix/commands/deps/index.d.ts +1 -1
  250. package/dist/phoenix/commands/deps/index.js +1 -1
  251. package/dist/phoenix/commands/deps/sdk-manifest.js +1 -1
  252. package/dist/phoenix/commands/dev.js +4 -4
  253. package/dist/phoenix/commands/init.d.ts +17 -5
  254. package/dist/phoenix/commands/init.js +1 -1
  255. package/dist/phoenix/commands/link.js +1 -1
  256. package/dist/phoenix/commands/sync.js +1 -1
  257. package/dist/phoenix/commands/unlink.js +1 -1
  258. package/dist/phoenix/services/application-spec-project-watcher.d.ts +0 -2
  259. package/dist/phoenix/services/application-spec-project-watcher.js +2 -2
  260. package/dist/phoenix/utils/index.d.ts +2 -1
  261. package/dist/phoenix/utils/index.js +1 -1
  262. package/dist/phoenix/utils/package-info.d.ts +0 -9
  263. package/dist/phoenix/utils/package-info.js +1 -1
  264. package/dist/phoenix/utils/package-manager/index.d.ts +2 -0
  265. package/dist/phoenix/utils/package-manager/index.js +1 -0
  266. package/dist/phoenix/utils/package-manager/package-manager-commands.d.ts +19 -0
  267. package/dist/phoenix/utils/package-manager/package-manager-commands.js +1 -0
  268. package/dist/phoenix/utils/package-manager/pnpm-project.d.ts +9 -0
  269. package/dist/phoenix/utils/package-manager/pnpm-project.js +1 -0
  270. package/dist/react-sdk/application-runtime/common-services/analytics/index.d.ts +1 -0
  271. package/dist/react-sdk/application-runtime/common-services/analytics/index.js +1 -1
  272. package/dist/react-sdk/domain-application-context/DomainLifecycleBoundary.js +1 -1
  273. package/dist/react-sdk/domain-context/common-hooks/use-configurator-messages.d.ts +15 -4
  274. package/dist/react-sdk/domain-context/common-hooks/use-configurator-messages.js +1 -1
  275. package/dist/react-sdk/domain-context/index.d.ts +2 -0
  276. package/dist/react-sdk/domain-context/index.js +1 -1
  277. package/dist/react-sdk/domain-context/system-hooks/tab-navigation-hooks.d.ts +61 -0
  278. package/dist/react-sdk/domain-context/system-hooks/tab-navigation-hooks.js +1 -0
  279. package/dist/react-sdk/domain-context/system-hooks/undo-redo-hooks.d.ts +20 -0
  280. package/dist/react-sdk/domain-context/system-hooks/undo-redo-hooks.js +1 -0
  281. package/dist/react-sdk/handlers/index.d.ts +1 -0
  282. package/dist/react-sdk/handlers/index.js +1 -1
  283. package/dist/react-sdk/handlers/use-finalize-action.js +1 -0
  284. package/dist/react-sdk/session/NotAuthenticatedPage.d.ts +4 -0
  285. package/dist/react-sdk/session/NotAuthenticatedPage.js +1 -1
  286. package/dist/ui-sdk/theme/types.d.ts +1 -1
  287. package/package.json +3 -3
  288. package/dist/application-spec/generate-application/code/templates/nvmrc.d.ts +0 -1
  289. package/dist/application-spec/generate-application/code/templates/nvmrc.js +0 -2
  290. package/dist/application-spec/generate-application/code/templates/package-json.d.ts +0 -10
  291. package/dist/application-spec/generate-application/code/templates/package-json.js +0 -1
  292. package/dist/configurator/common/use-finalize-action.js +0 -1
  293. package/dist/phoenix/commands/generate-project-files.d.ts +0 -6
  294. package/dist/phoenix/commands/generate-project-files.js +0 -1
  295. /package/dist/{configurator/common → react-sdk/application-runtime/common-services/analytics}/frontend-analytics.d.ts +0 -0
  296. /package/dist/{configurator/common → react-sdk/application-runtime/common-services/analytics}/frontend-analytics.js +0 -0
  297. /package/dist/{configurator/common → react-sdk/handlers}/use-finalize-action.d.ts +0 -0
@@ -292,7 +292,7 @@ This will:
292
292
 
293
293
  Other useful commands:
294
294
 
295
- - `pnpm phoenix sync` - Sync dependencies in package.json
295
+ - `pnpm phoenix sync` - Regenerate the generated code and project files
296
296
  - `pnpm phoenix gen` - Regenerate project files
297
297
  - `pnpm phoenix dev` - Start development server with hot reload
298
298
  - `pnpm phoenix deployment:prepare` - Prepare for deployment
@@ -440,7 +440,7 @@ Use this checklist to verify migration completeness:
440
440
  - [ ] Configurator renders correctly
441
441
  - [ ] Admin interface works
442
442
  - [ ] All imports updated to new paths
443
- - [ ] Node 24 and pnpm v10 installed
443
+ - [ ] Node 24 and a package manager installed
444
444
 
445
445
  ## Removed Files
446
446
 
@@ -486,7 +486,7 @@ Update imports to use these globals instead of importing from packages directly.
486
486
  ## Environment Requirements
487
487
 
488
488
  - Node 24
489
- - pnpm v10
489
+ - A package manager; the commands in this guide use pnpm
490
490
  - `RESOURCES_URL` is an optional frontend environment variable; in local development it defaults to the Vite dev server at `http://localhost:5173`
491
491
 
492
492
  ## Next Steps
@@ -16,7 +16,7 @@ The Phoenix CLI (`phoenix` command) is the unified tool for all configurator dev
16
16
 
17
17
  The SDK and its CLI run on Node.js 22.13 or newer, the range declared in `engines.node` of `@salsita-ai/sdk`. On an older Node.js, `phoenix` stops before it runs a command, names the running version and the required range, and exits with a non-zero code. The legacy binaries run no such check; package managers warn about the range when the SDK is installed.
18
18
 
19
- `phoenix init [folder]` starts a configurator project in `[folder]` (default: the working directory):
19
+ `phoenix init [folder]` starts a configurator project in `[folder]` (default: the working directory). The project installs with any package manager. The commands on this page use pnpm; with npm, run `npm install` and `npx phoenix sync`, with Yarn `yarn phoenix sync`, with Bun `bunx phoenix sync`:
20
20
 
21
21
  ```bash
22
22
  npx -p @salsita-ai/sdk@canary phoenix init my-configurator
@@ -30,12 +30,17 @@ pnpm phoenix dev
30
30
  `phoenix init`:
31
31
 
32
32
  1. Refuses to run when a `spec/` folder already exists, so it never touches an existing project.
33
- 2. Writes a `package.json` that depends on the CLI's SDK version when the folder has none. An existing `package.json` is kept, as long as it depends on the SDK.
33
+ 2. Writes a `package.json` when the folder has none, and an existing one is kept, as long as it depends on the SDK. Either way, `package.json` gains the entries it lacks, and an entry it already has stays as it is:
34
+ - the CLI's SDK version, in a new `package.json`;
35
+ - every package the SDK requires as a peer, at the version [`phoenix deps`](#phoenix-deps) writes: the lowest of the SDK's range, with the `@types/*` packages in `devDependencies`. A peer the project declares in any dependency field counts, whatever its version. `@clerk/clerk-react` is not among them, because the starter spec does not set `useClerk`;
36
+ - `eslint` and `prettier` in `devDependencies`, at the versions the SDK runs itself, so an editor formats and lints with the same versions as `phoenix check`.
37
+
38
+ With these, the install gives the project everything `phoenix dev`, `build` and `check` need. `init` writes no `packageManager` field and no package-manager settings: a project that installs with pnpm 11 adds the settings in [Package manager](?path=/docs/phoenix-project-structure--docs#package-manager) itself.
39
+
34
40
  3. Adds the `dev`, `build`, `deploy`, `check` and `fix` scripts to `package.json` (see [Project Scripts](#project-scripts)). A script the project already has under one of those names keeps its command.
35
41
  4. Writes a starter spec (`spec/application.yaml`, `spec/configurator.yaml`) with one resizable, recolorable box, and switches `package.json` to the application-spec pipeline.
36
- 5. Writes `pnpm-workspace.yaml` with the pnpm settings the first install needs: the build scripts of the SDK's dependencies are allowed or denied, and `@salsita-ai/*` packages are exempt from pnpm's minimum release age. A project inside a pnpm monorepo gets no file; the workspace root holds these settings.
37
42
 
38
- It asks nothing, writes no `.env` and contacts no server. `phoenix sync` then generates every other project file, including the agent skills described in [Project Structure](?path=/docs/phoenix-project-structure--docs). The `.gitignore` is among them only when the folder is inside a git repository, so run `git init` before the first sync, or sync again after it.
43
+ The next steps it prints use the package manager you ran it with, or name none when it cannot tell. It asks nothing, writes no `.env` and contacts no server. `phoenix sync` then generates every other project file, including the agent skills described in [Project Structure](?path=/docs/phoenix-project-structure--docs). The `.gitignore` is among them only when the folder is inside a git repository, so run `git init` before the first sync, or sync again after it.
39
44
 
40
45
  ### Which project `phoenix dev` develops in
41
46
 
@@ -180,7 +185,7 @@ spec/application.yaml → Server prepares environment → CLI writes the generat
180
185
  | `check` | `phoenix check` | Run all checks (TypeScript, ESLint, Prettier) |
181
186
  | `fix` | `phoenix fix` | Auto-fix lint and formatting issues |
182
187
 
183
- The scripts are yours: change, rename or delete them, and add your own. `phoenix sync` and `phoenix clean` leave the `scripts` section of `package.json` as it is, so they add no script, restore none you removed and remove none. Every CLI command also runs without a script, as `pnpm phoenix <command>`.
188
+ The scripts are yours: change, rename or delete them, and add your own. `phoenix sync` and `phoenix clean` leave the `scripts` section of `package.json` as it is, so they add no script, restore none you removed and remove none. Every CLI command also runs without a script, through your package manager: `pnpm phoenix <command>`, `npx phoenix <command>`, `yarn phoenix <command>` or `bunx phoenix <command>`.
184
189
 
185
190
  A project may have other scripts than these five, such as `sync`, `test` or `verify:fix`; they are its own and stay as they are. All of this holds for a project on the application-spec pipeline, which `phoenix init` selects. In a project on the legacy pipeline (see [Current and legacy project tooling](#current-and-legacy-project-tooling)), `phoenix sync` and `phoenix clean` write their own set of scripts into `package.json` on every run, over scripts of the same name.
186
191
 
@@ -398,7 +403,7 @@ Set initial values from a local production build with roughly 5–10% headroom t
398
403
 
399
404
  ### `phoenix clean`
400
405
 
401
- Removes all build artifacts (`.phoenix/`, `node_modules/`), reinstalls dependencies, and rebuilds all generated files from scratch. Use this when:
406
+ Removes `.phoenix/` and regenerates all project files from scratch. It installs nothing and leaves `node_modules/` as it is; to reinstall too, delete `node_modules/` and install with your package manager. In a project on the legacy pipeline (see [Current and legacy project tooling](#current-and-legacy-project-tooling)), `phoenix clean` also removes `node_modules/` and runs `pnpm install`. Use this when:
402
407
 
403
408
  - Generated files are corrupted or out of sync
404
409
  - After major SDK version upgrades
@@ -406,10 +411,12 @@ Removes all build artifacts (`.phoenix/`, `node_modules/`), reinstalls dependenc
406
411
 
407
412
  ### `phoenix sync`
408
413
 
409
- Syncs project dependencies and regenerates all project files without building Vite bundles or webhooks. Faster than `clean` — use this for routine updates after changing spec files or upgrading dependencies. Before installing, it adds the pnpm settings `phoenix init` writes to a standalone project's `pnpm-workspace.yaml` when they are missing; values you set there are kept.
414
+ Regenerates all project files without building Vite bundles or webhooks. Faster than `clean` — use this for routine updates after changing spec files or updating the SDK. It installs nothing: install with your package manager before syncing, after any change to `package.json`. It writes no package-manager settings; `pnpm-workspace.yaml` is the project's own. In a project on the legacy pipeline, `phoenix sync` runs `pnpm install` first.
410
415
 
411
416
  With the application-spec pipeline (see [Current and legacy project tooling](#current-and-legacy-project-tooling)), `.gitignore` is written only when the project is inside a git repository: the project folder or one of its parent folders holds a `.git` entry. Outside a repository, sync neither creates the file nor changes one that is already there, and the same holds for `dev`, `build` and `clean`. Run `git init` before the first sync, or sync again after it, to get the file. The legacy pipeline writes `.gitignore` in every project.
412
417
 
418
+ With the application-spec pipeline, sync never writes `package.json`. Before it generates any file, it checks that `package.json` declares every peer of the installed SDK at a version inside the SDK's range, and stops with a non-zero exit code when it does not. The message lists each peer that fails, with the range the SDK needs and the version found, or `missing`, and names the fix: run [`phoenix deps`](#phoenix-deps), then install with your package manager. `phoenix build`, `phoenix clean` and `phoenix dev` make the same check, and so does the platform build of [`phoenix deploy`](#phoenix-deploy). `phoenix dev` stops when the check fails at start; on a rebuild it reports the failure like a spec error and keeps running. [Dependencies](?path=/docs/phoenix-project-structure--docs#dependencies) has the rules. The legacy pipeline merges the SDK's dependencies into `package.json` on every sync.
419
+
413
420
  | Flag | Env Variable | Default | Description |
414
421
  | ---------------- | --------------- | ------- | ------------------------------ |
415
422
  | `--force` / `-f` | `FORCE_REBUILD` | `false` | Force full rebuild, skip cache |
@@ -423,12 +430,14 @@ pnpm phoenix deps
423
430
  pnpm install
424
431
  ```
425
432
 
433
+ Run it after every SDK update: `phoenix sync`, `dev` and `build` stop while `package.json` does not declare the SDK's peers (see [`phoenix sync`](#phoenix-sync)).
434
+
426
435
  - A missing peer is added at the lowest version of the SDK's range, as an exact version, in alphabetical order: type packages (`@types/*`) to `devDependencies`, the others to `dependencies`.
427
436
  - A peer declared with a version range whose lowest version falls outside the SDK's range is set to the lowest version of the SDK's range, in the field that declares it. The output says when that is a downgrade.
428
437
  - A peer declared with a specifier that is not a version range, such as `workspace:`, `npm:`, `catalog:`, `file:`, `link:` or a git URL, stays as it is.
429
438
  - `@salsita-ai/common`, `@salsita-ai/contracts`, `@salsita-ai/platform-project-sdk`, `@salsita-ai/platform-common` and `@salsita-ai/platform-contracts` are removed, because `@salsita-ai/sdk` replaces them. No other entry is removed.
430
439
 
431
- Every other part of `package.json` keeps its order and formatting. `phoenix deps` installs nothing: it lists each change and names `pnpm install` as the next step, or says that nothing needed to change. Running it again changes nothing. It reads the spec to learn whether the project uses Clerk, so it stops with the spec's errors when the spec does not parse.
440
+ Every other part of `package.json` keeps its order and formatting. `phoenix deps` installs nothing: it lists each change and names the install of the package manager you ran it with as the next step, or says that nothing needed to change. Running it again changes nothing. It reads the spec to learn whether the project uses Clerk, so it stops with the spec's errors when the spec does not parse.
432
441
 
433
442
  This holds for a project on the application-spec pipeline. In a project on the legacy pipeline (see [Current and legacy project tooling](#current-and-legacy-project-tooling)), `phoenix deps` changes nothing and says that `phoenix sync` manages the dependencies.
434
443
 
@@ -606,10 +615,11 @@ Generated projects carry the `phoenix-variants` agent skill, which tells coding
606
615
 
607
616
  ### `phoenix link`
608
617
 
609
- Link a local copy of the Phoenix SDK for development. This creates symlinks so that changes to the SDK source are reflected in your project without publishing.
618
+ An internal tool for working on the SDK itself, and pnpm only: in a project with another package manager's lockfile and no `pnpm-lock.yaml`, it stops and changes nothing. Link a local copy of the Phoenix SDK for development in a project installed with pnpm. It writes a `file:` override for each SDK package into `pnpm-workspace.yaml`, so that after the next install changes to the SDK source are reflected in your project without publishing. It installs nothing; run the install it prints next:
610
619
 
611
620
  ```bash
612
621
  phoenix link --sdk-path ../configurator-phoenix
622
+ pnpm install --config.optimistic-repeat-install=false
613
623
  ```
614
624
 
615
625
  | Flag | Default | Description |
@@ -620,10 +630,11 @@ When linked, `phoenix dev` automatically watches for changes in the linked SDK's
620
630
 
621
631
  ### `phoenix unlink`
622
632
 
623
- Remove the local SDK linking and restore normal package resolution.
633
+ Remove the local SDK linking: it deletes the overrides `phoenix link` wrote. Like `phoenix link`, it is an internal tool and pnpm only. It installs nothing; the install it prints restores normal package resolution:
624
634
 
625
635
  ```bash
626
636
  phoenix unlink
637
+ pnpm install --config.optimistic-repeat-install=false
627
638
  ```
628
639
 
629
640
  ## Utilities
@@ -739,7 +750,7 @@ Revokes the token on the server and removes it from the credentials file. `--reg
739
750
 
740
751
  ### `phoenix deploy`
741
752
 
742
- 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. After `Your configurator is live at <url>` it prints one line for coding agents, which tells them to offer the run evaluation of the `phoenix-feedback` skill once you have nothing more to build; you can ignore it when you run the command yourself. `--region` or `--serverUrl` selects the server, as for `login`; `--no-wait` returns as soon as the build starts.
753
+ Validates the spec, 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. After `Your configurator is live at <url>` it prints one line for coding agents, which tells them to offer the run evaluation of the `phoenix-feedback` skill once you have nothing more to build; you can ignore it when you run the command yourself. `--region` or `--serverUrl` selects the server, as for `login`; `--no-wait` returns as soon as the build starts.
743
754
 
744
755
  To keep the conversation that led to a build, place a reviewed UTF-8 transcript in `conversation.log` at the project root before deploying. Deploy automatically includes it in the private source archive. Download the build's sources from Studio to read it; access is the same as for the rest of that build's sources. The build extractor skips the log, so it is not an application build input or a public asset. Missing logs produce a warning and deployment continues. Directories, links and special files at that path are rejected.
745
756
 
@@ -136,18 +136,37 @@ export default [CabinetModule, DrawerModule, ShelfModule]
136
136
 
137
137
  Phoenix auto-flattens both patterns during build. Use array exports when logically grouping related items in one file.
138
138
 
139
- ## Dependencies Merging
139
+ ## Dependencies
140
140
 
141
- When running `phx sync` or `phx build`, Phoenix manages `package.json` dependencies:
141
+ In a project on the application-spec pipeline, `package.json` is the project's own: `phoenix sync`, `phoenix dev` and `phoenix build` never write it. The SDK lists the packages its code imports from the project's install as peer dependencies (React, three.js, MUI, Lingui and others), and the project declares them next to `@salsita-ai/sdk`. [`phoenix deps`](?path=/docs/phoenix-phoenix-cli--docs#phoenix-deps) adds the missing ones and moves out-of-range ones into the SDK's range; run it, then install, after every SDK update. With pnpm, and the same through any other package manager (`npm install`, `npx phoenix deps` with npm):
142
142
 
143
- | Behavior | Description |
144
- | --------------------- | -------------------------------------------------------------- |
145
- | Phoenix deps override | Required Phoenix dependencies override user-specified versions |
146
- | Versions pinned | All Phoenix deps use exact versions (no ^ or ~) |
147
- | User deps preserved | Non-conflicting user dependencies are kept |
148
- | Manual deps safe | Dependencies not in Phoenix's required list remain untouched |
143
+ ```bash
144
+ pnpm add @salsita-ai/sdk@<version>
145
+ pnpm phoenix deps
146
+ pnpm install
147
+ pnpm phoenix sync
148
+ ```
149
+
150
+ `phoenix sync`, `phoenix dev` and `phoenix build`, also on the platform when a deploy builds, check `package.json` before they generate any file. When a peer is missing, or declared at a version whose lowest match falls outside the SDK's range, they stop and list each such peer with the range the SDK needs and what `package.json` declares. A peer counts in `dependencies`, `devDependencies` or `optionalDependencies`, and a specifier that is not a version range, such as `workspace:` or `link:`, counts as declared. Add your own dependencies to `package.json` as usual; Phoenix leaves them, the Node.js and package-manager versions and the rest of the file as you wrote them.
151
+
152
+ In a project on the legacy pipeline (see [Current and legacy project tooling](?path=/docs/phoenix-phoenix-cli--docs#current-and-legacy-project-tooling)), `phoenix sync` and `phoenix build` merge the SDK's required dependencies into `package.json` instead, at exact versions over the ones you set, and keep every other dependency.
153
+
154
+ ### Package manager
155
+
156
+ A project installs with any package manager: pnpm, npm, Yarn or Bun. Phoenix writes no package-manager settings and no `packageManager` field; the lockfile, `pnpm-workspace.yaml`, `.npmrc` and `.yarnrc.yml` are the project's own. Run `phoenix` through the package manager the project uses, such as `pnpm phoenix sync` or `npx phoenix sync`.
157
+
158
+ A project that installs with pnpm 11 needs a `pnpm-workspace.yaml` in its root before the first install. pnpm 11 stops an install until every dependency build script is allowed or denied, and the SDK's dependencies have three. Its default minimum release age also refuses a package published only recently, so the exclusion lets the project install an SDK build on the day it is released; it is optional:
159
+
160
+ ```yaml
161
+ allowBuilds:
162
+ '@swc/core': true
163
+ esbuild: true
164
+ es5-ext: false
165
+ minimumReleaseAgeExclude:
166
+ - '@salsita-ai/*'
167
+ ```
149
168
 
150
- To add custom dependencies, add them normally to `package.json`. Phoenix preserves them unless they conflict with required framework dependencies.
169
+ The file is yours to extend, for example to allow the build script of a dependency you add. In a pnpm monorepo, these settings go into the workspace root's `pnpm-workspace.yaml`. [`phoenix deploy`](?path=/docs/phoenix-phoenix-cli--docs#phoenix-deploy) packs `pnpm-lock.yaml` and `pnpm-workspace.yaml` when the project has them, and the platform build, which installs with pnpm, follows them.
151
170
 
152
171
  ## Global Interfaces
153
172
 
@@ -180,21 +199,21 @@ type CustomMaterial = Phx['AdminModel']['CustomMaterial']
180
199
 
181
200
  ### Root Level Files
182
201
 
183
- | File | Auto-Generated? | Notes |
184
- | ------------------------------------------------------ | --------------- | -------------------------------------- |
185
- | `package.json` | Partially | Dependencies merged, scripts untouched |
186
- | `tsconfig.json` | Once | Yours; see below |
187
- | `eslint.config.js` | Once | Yours; see below |
188
- | `prettier.config.js` | Once | Yours; see below |
189
- | `.prettierignore` | No | Optional and your own; see below |
190
- | `.nvmrc` | Yes | Managed by Phoenix |
191
- | `.gitignore` | Partially | Only in a git repository; see Markers |
192
- | `.env` | No | Git-ignored, local config |
193
- | `.env.example` | No | Template for env vars |
194
- | `.env.generated` | Yes | Optional, git-ignored; see below |
195
- | `README.md` | No | Project documentation |
196
- | `AGENTS.md` | No | Your own coding-agent instructions |
197
- | `.claude/skills/phoenix*/`, `.agents/skills/phoenix*/` | Yes | Phoenix agent skills |
202
+ | File | Auto-Generated? | Notes |
203
+ | ------------------------------------------------------ | --------------- | ------------------------------------- |
204
+ | `package.json` | No | Yours; see Dependencies |
205
+ | `tsconfig.json` | Once | Yours; see below |
206
+ | `eslint.config.js` | Once | Yours; see below |
207
+ | `prettier.config.js` | Once | Yours; see below |
208
+ | `.prettierignore` | No | Optional and your own; see below |
209
+ | `pnpm-workspace.yaml` | No | Only with pnpm; see Package manager |
210
+ | `.gitignore` | Partially | Only in a git repository; see Markers |
211
+ | `.env` | No | Git-ignored, local config |
212
+ | `.env.example` | No | Template for env vars |
213
+ | `.env.generated` | Yes | Optional, git-ignored; see below |
214
+ | `README.md` | No | Project documentation |
215
+ | `AGENTS.md` | No | Your own coding-agent instructions |
216
+ | `.claude/skills/phoenix*/`, `.agents/skills/phoenix*/` | Yes | Phoenix agent skills |
198
217
 
199
218
  Sync does not write `README.md`, `AGENTS.md`, `.env.example`, `.env.ci` or the `README.md` files in `assets/public/` and `assets/private/`. Earlier SDK versions wrote them once; a project that has them keeps them, and they are yours to edit.
200
219
 
@@ -210,21 +229,20 @@ With the application-spec pipeline, the project's TypeScript settings are in `.p
210
229
 
211
230
  The only root `tsconfig.json` sync replaces is the full file earlier SDK versions generated there, recognised by its settings; any other stays as it is. `phoenix dev`, `phoenix build` and the webhook bundle do not resolve `paths` aliases, so an alias added to the root file passes `phoenix check` and fails the build. `phoenix check` type-checks with the root `tsconfig.json`, or with `.phoenix/tsconfig.json` when the project has none. The legacy pipeline writes the full `tsconfig.json` on every sync.
212
231
 
213
- With the application-spec pipeline, sync writes `eslint.config.js` and `prettier.config.js` only when the project has none, each re-exporting the SDK's shared configuration so editors find it. They are yours to commit and to change. The only ones sync replaces are the files earlier SDK versions generated there; any other stays as it is. `phoenix check` and `phoenix fix` lint and format with the project's files, and with the SDK's configurations when a file is missing (see [`phoenix check`](?path=/docs/phoenix-phoenix-cli--docs#phoenix-check)). Sync formats the files it generates in the project root, such as `package.json` and the agent skills, with the same Prettier configuration, so `phoenix check` accepts them; while the project's configuration cannot be loaded, as before the first install, they get the SDK's settings. The legacy pipeline writes both files on every sync.
232
+ With the application-spec pipeline, sync writes `eslint.config.js` and `prettier.config.js` only when the project has none, each re-exporting the SDK's shared configuration so editors find it. They are yours to commit and to change. The only ones sync replaces are the files earlier SDK versions generated there; any other stays as it is. `phoenix check` and `phoenix fix` lint and format with the project's files, and with the SDK's configurations when a file is missing (see [`phoenix check`](?path=/docs/phoenix-phoenix-cli--docs#phoenix-check)). Sync formats the files it generates in the project root, such as the agent skills, with the same Prettier configuration, so `phoenix check` accepts them; while the project's configuration cannot be loaded, as before the first install, they get the SDK's settings. The legacy pipeline writes both files on every sync.
214
233
 
215
234
  With the application-spec pipeline, the Lingui configuration is `.phoenix/.linguirc`, which sync rewrites with the rest of `.phoenix/` from `availableLocales` in `spec/application.yaml`. Phoenix passes that file to Lingui every time it extracts or compiles the catalogs and to its Vite builds, so a `.linguirc` in the project root is not read and can be deleted. To run Lingui yourself, name the file: `npx lingui extract --config .phoenix/.linguirc`, from the project root. The legacy pipeline writes `.linguirc` in the project root on every sync.
216
235
 
217
236
  ### DO NOT EDIT (Fully Auto-Generated)
218
237
 
219
238
  - **Everything in `.phoenix/`** - Completely regenerated on each build. The exceptions are `.phoenix/variants/`, where a coding agent writes the option files for `phoenix variants`, and `.phoenix/.env.generated`, the generated env file of `phoenix dev`; a rebuild keeps both
220
- - `.nvmrc`
221
239
  - `src/locales/**/*.ts` - Compiled from `.po` catalogs
222
240
  - `.env.generated`
223
241
  - `phoenix` and `phoenix-*` skill folders under `.claude/skills/` and `.agents/skills/` — rewritten on every sync with anything else inside them removed, and other `phoenix`-prefixed skill folders are removed; to customise a skill, copy it to a folder whose name does not start with `phoenix`
224
242
 
225
243
  ### Agent Guidance
226
244
 
227
- Coding agents (Claude Code, Codex, Cursor) read the Phoenix agent skills. An `AGENTS.md` is yours to add for your own instructions; sync does not write one. The `phoenix`, `phoenix-cli`, `phoenix-feedback` and `phoenix-review` skills carry the SDK conventions, CLI tooling and review checklist, and the `phoenix-create-configurator` skill walks the agent from your product documents and assets to a reviewed configurator in five stages. The `phoenix-variants` skill has the agent show you several options over the dev preview when a decision is a matter of taste, and build the one you pick. Phoenix keeps them in step with the installed SDK, including the reference files inside a skill folder. During the internal beta, a project created from a canary build of the SDK gets one more section in the `phoenix` skill: once per conversation the agent checks for a newer canary and, after telling you, updates the project's SDK and runs `phoenix sync`. Other skill folders are never touched.
245
+ Coding agents (Claude Code, Codex, Cursor) read the Phoenix agent skills. An `AGENTS.md` is yours to add for your own instructions; sync does not write one. The `phoenix`, `phoenix-cli`, `phoenix-feedback` and `phoenix-review` skills carry the SDK conventions, CLI tooling and review checklist, and the `phoenix-create-configurator` skill walks the agent from your product documents and assets to a reviewed configurator in five stages. The `phoenix-variants` skill has the agent show you several options over the dev preview when a decision is a matter of taste, and build the one you pick. Phoenix keeps them in step with the installed SDK, including the reference files inside a skill folder. During the internal beta, a project created from a canary build of the SDK gets one more section in the `phoenix` skill: once per conversation the agent checks for a newer canary and, after telling you, updates the project's SDK, runs `phoenix deps`, installs, then runs `phoenix sync`. Other skill folders are never touched.
228
246
 
229
247
  Projects created by earlier SDK versions had this guidance in `CLAUDE.md`, `.cursor/rules/phoenix.mdc` and `commands/review.md`. Sync removes the SDK block from the first two, keeps your own text around it, deletes a file that held nothing else, and deletes the review commands; use the `phoenix-review` skill instead of `/review`.
230
248
 
@@ -15,7 +15,7 @@ Build a working office desk configurator from an empty folder. You will describe
15
15
 
16
16
  ## Before you start
17
17
 
18
- Use Node.js 24 and pnpm 11. The tutorial uses the office desk model served by this documentation site at `/models/office-desk.gltf`; download it first. Real client projects normally start from `phoenix init`. This tutorial creates the four essential files by hand so you can see what Phoenix owns.
18
+ Use Node.js 24 and any package manager; the commands below use pnpm, and with pnpm 11 the project also needs the `pnpm-workspace.yaml` in [Package manager](?path=/docs/phoenix-project-structure--docs#package-manager). The tutorial uses the office desk model served by this documentation site at `/models/office-desk.gltf`; download it first. Real client projects normally start from `phoenix init`. This tutorial creates the four essential files by hand so you can see what Phoenix owns.
19
19
 
20
20
  ## Step 0 — Create the project
21
21
 
@@ -40,17 +40,13 @@ Now add these four files.
40
40
  "dependencies": {
41
41
  "@salsita-ai/sdk": "0.48.0"
42
42
  },
43
- "devDependencies": {
44
- "@lingui/cli": "5.9.5",
45
- "@lingui/swc-plugin": "5.11.0"
46
- },
47
43
  "phoenix": {
48
44
  "applicationFlow": true
49
45
  }
50
46
  }
51
47
  ```
52
48
 
53
- Use the SDK version supplied by your team if it differs from the repository's current `0.48.0` version. `phoenix.applicationFlow` selects the application-spec project structure. The first sync uses Lingui while generating the rest of the dependencies, so its CLI and SWC plugin must also be present in the initial install.
49
+ Use the SDK version supplied by your team if it differs from the repository's current `0.48.0` version. `phoenix.applicationFlow` selects the application-spec project structure. The SDK runs its own Lingui, so the SDK is the only dependency you write by hand; `phoenix deps` adds the packages it needs next to it in the install step below. A project started with `phoenix init` gets a `package.json` that already declares them.
54
50
 
55
51
  ### `.env`
56
52
 
@@ -97,13 +93,17 @@ components:
97
93
  layout: universal
98
94
  ```
99
95
 
100
- Install the SDK, then ask Phoenix to generate the rest of the project:
96
+ Install the SDK, let it declare the packages it needs, such as React, three.js and MUI, install them, then ask Phoenix to generate the rest of the project:
101
97
 
102
98
  ```sh
103
99
  pnpm install
100
+ pnpm phoenix deps
101
+ pnpm install
104
102
  pnpm phoenix sync
105
103
  ```
106
104
 
105
+ `phoenix sync` stops while `package.json` lacks one of those packages; after every SDK update, run `phoenix deps` and install again (see [`phoenix deps`](?path=/docs/phoenix-phoenix-cli--docs#phoenix-deps)). With npm, the same steps are `npm install`, `npx phoenix deps`, `npm install` and `npx phoenix sync`.
106
+
107
107
  `phoenix sync` keeps `spec/` and `src/` as your authored inputs and generates the application shell, types, and `.phoenix/` implementation. Start development without a server:
108
108
 
109
109
  ```sh
@@ -8,9 +8,9 @@ Your workspace's Studio shows the setup, the link to your configurator and the s
8
8
 
9
9
  ## Before you start
10
10
 
11
- - **Package access:** `@salsita-ai/sdk` is public on npm; `npx` and `pnpm install` download it without a registry token.
11
+ - **Package access:** `@salsita-ai/sdk` is public on npm; any package manager downloads it without a registry token.
12
12
  - **Workspace details:** you need your workspace slug and its Phoenix region (`eu` or `us`), which you also received with your workspace.
13
- - **Tools:** Node.js and pnpm.
13
+ - **Tools:** Node.js and a package manager. The commands below use pnpm; with npm, run `npm install` and `npx phoenix …` instead, with Yarn `yarn phoenix …`, with Bun `bunx phoenix …`.
14
14
  - **SDK build:** during the internal beta, use the `canary` build of the SDK, as the commands below do. It is published from every change to the platform, so it is newer than the last release.
15
15
 
16
16
  ## 1. Create a project
@@ -22,11 +22,11 @@ pnpm install
22
22
  pnpm phoenix sync
23
23
  ```
24
24
 
25
- `phoenix init [folder]` writes the starter project: `package.json`, `pnpm-workspace.yaml` and the starter spec, `spec/application.yaml` and `spec/configurator.yaml`, which describe one box you can resize and recolour. The starter depends on the same SDK version as the CLI that created it, and its `package.json` has the `dev`, `build`, `deploy`, `check` and `fix` scripts, which are yours to change. `phoenix sync` then adds the rest of the project: the TypeScript, lint and formatting config and the agent skills. It writes no webhook code: a project without `src/webhooks/index.ts` gets a built-in webhook (see [Webhook Entry Point](?path=/docs/phoenix-webhooks--docs#webhook-entry-point)). It writes a `.gitignore` only when the folder is inside a git repository; run `git init` before the first sync, or sync again after it, to get the file.
25
+ `phoenix init [folder]` writes the starter project: `package.json` and the starter spec, `spec/application.yaml` and `spec/configurator.yaml`, which describe one box you can resize and recolour. The starter depends on the same SDK version as the CLI that created it and on the packages the SDK requires next to it (React, three.js, MUI, Lingui and the others, with their type packages), with ESLint and Prettier at the versions the SDK uses itself. Its `package.json` has the `dev`, `build`, `deploy`, `check` and `fix` scripts, which are yours to change. `phoenix sync` then adds the rest of the project: the TypeScript, lint and formatting config and the agent skills. It writes no webhook code: a project without `src/webhooks/index.ts` gets a built-in webhook (see [Webhook Entry Point](?path=/docs/phoenix-webhooks--docs#webhook-entry-point)). It writes a `.gitignore` only when the folder is inside a git repository; run `git init` before the first sync, or sync again after it, to get the file.
26
26
 
27
- `init` only writes these files: it asks nothing and contacts no server. It refuses a folder that already has a `spec/` folder. A `package.json` already in the folder is kept, as long as it depends on the SDK.
27
+ `init` only writes these files: it asks nothing and contacts no server. It refuses a folder that already has a `spec/` folder. A `package.json` already in the folder is kept, as long as it depends on the SDK, and gains only the entries it lacks (see [Starting a New Project](?path=/docs/phoenix-phoenix-cli--docs#starting-a-new-project)).
28
28
 
29
- `pnpm-workspace.yaml` holds the pnpm settings the install needs: it allows the build scripts of the SDK's dependencies and exempts `@salsita-ai/*` packages from pnpm's minimum release age, so a build of the SDK published today installs. The file is yours to edit, for example to allow the build script of a dependency you add. `phoenix sync` adds these entries when they are missing and keeps the values you set. A project inside a pnpm monorepo gets no file of its own; the workspace root holds the settings.
29
+ Phoenix writes no package-manager settings. With pnpm 11, add a `pnpm-workspace.yaml` that allows the build scripts of the SDK's dependencies before the first install; [Package manager](?path=/docs/phoenix-project-structure--docs#package-manager) has the file.
30
30
 
31
31
  The starter `spec/application.yaml` begins with `project: default`, which means the default project of the workspace you sign in to. Leave it as it is; a workspace has one project.
32
32
 
@@ -81,7 +81,7 @@ pnpm phoenix deploy
81
81
  4. It uploads the archive, which may be up to 200 MB.
82
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.
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
+ On the server, the install runs pnpm. It follows your `pnpm-lock.yaml` and `pnpm-workspace.yaml` when the project has them, so a pnpm project gets the same build scripts and package versions as on your computer; without them, pnpm resolves `package.json` with the settings the SDK needs. 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.
85
85
 
86
86
  If the build fails, is cancelled or takes too long, `phoenix deploy` prints the end of the build log and exits with an error. `--no-wait` returns as soon as the build starts.
87
87
 
@@ -33,6 +33,14 @@ invariants, actions, migrations, presets and the components declared in YAML. `c
33
33
  handler, element and transformer; it reads the frontend environment when it is imported, so a test that
34
34
  uses it stubs `phx.frontendEnv` first.
35
35
 
36
+ A test that mounts the configurator's UI builds from `configuratorConfig`: it carries the SDK's default
37
+ elements, the built-in layout, preset screen, not-found and not-authenticated pages, controls, toolbar
38
+ buttons and sidebar-footer pieces, which `configuratorBuilder` does not, so a test that mounts the UI from `createTestApplicationConfig(configuratorBuilder)`
39
+ shows a "not found" box in place of every built-in element. Code that assembles a config without the
40
+ generated files calls `.withDefaultElements(defaultConfiguratorElements)` on its configurator builder, with
41
+ the list from `@salsita-ai/sdk/configurator`, or `defaultAdminElements` from `@salsita-ai/sdk/admin` for
42
+ the admin.
43
+
36
44
  A test passes the generated export to the helper and does not call the export's methods: they are how the
37
45
  SDK assembles an application, not an interface for tests, while the helper's call does not depend on that
38
46
  assembly.
@@ -1 +1 @@
1
- import{ASSISTANT_BUILT_IN_FORM_ELEMENTS as e}from"./assistant-form-elements.js";let t=[["Containers",["group","choice","choices"]],["Options",["option"]],["Inputs",["input"]]];export const generateAssistantPrompt=a=>{let n=Object.values(a.childRecipes??{}).some(e=>e.length>0),i=Object.values(a.replaceRecipes??{}).some(e=>e.length>0),s=Object.values(a.fieldOptions??{}).some(e=>e.length>0),o=Object.keys(a.actions??{}).length>0,r=(a.deletableTypes?.length??0)>0||Object.values(a.writableFields??{}).some(e=>Object.keys(e).length>0)||n||i||o,h=n||i||s,l=[...n?["`childRecipes` is what can be added to it"]:[],...i?["`replaceRecipes` what it can be replaced with"]:[],...s?["`<field>Options` the values a field accepts"]:[]],d=["`selected`",...(a.navigationFields??[]).map(e=>`\`${e}\``)].join(", ");return[["Tools","- Put related operations in one call and select only the fields you need.",...r?[`- Use a mutation inside \`query\` to answer a what-if about a change ${h?"the lists under `meta` do not show":"before making it"}.`,"- Use `apply` only for what the user asked for."]:["- Nothing in this configurator can be changed through you. Say so when the user asks for a change."],"- When an operation fails, its `errors` say why and what to send instead."],...r?[["After a change","- A change is made only when the `apply` result has `committed: true`. Otherwise `errors` or `message` says what happened; without either, nothing changed. Never say a change was made when it was not.","- `sideEffects` names the major or unexpected things the configurator changed along with your change. Tell the user about them when committed; otherwise they describe what would happen. Smaller adjustments are not listed.","- A mutation returns the state after the change: use the ids and values it returned, not the ones you sent.",...o?["- When one mutation does the whole of what the user asked, use it instead of building the same change from several others."]:[]]]:[],...h?[["What can be done to an entity",`- \`meta\` lists what is possible right now: ${l.join(", ")}. Read the list before such a change and before telling the user what is available.`,`- You can select \`dryRun\` on ${[...n||i?["recipes"]:[],...s?["options"]:[]].join(" or ")} to look ahead and pick one that meets what the user asked for. It is optional before a change.`,"- Read the lists again after a change, unless their descriptions say they stay the same."]]:[],["The `[changes]` block","- Every user message starts with it: a glimpse of what the user did in the configurator since your last turn.",`- \`[changes: none]\`, or only ${d} lines: what you know still holds. Do not query it again.`,"- Other lines are a hint at what to read again: `A` added, `D` deleted, `M` modified with the fields. Text after `#` says what caused the line; `reset: undo/redo` says the user undid or redid changes.","- Read computed fields again when a listed change may affect them.","- `[changes: unavailable]` and `[changes: too many (n)]`: read again before relying on anything you read earlier.",...r?["- Your applied changes are not listed, except those waiting for user approval: they appear once approved."]:[]],["Reading the schema","- Take ids from results.",...(a.deletableTypes?.length??0)>0||i?["- The id of a deleted or replaced entity is gone and may later be given to another entity."]:[],`- A field whose name starts with \`_\` is computed: read it${r?", never write it":""}.`,"- Numbers are in the unit the field description names. Convert when the user uses another unit."],["Links","- You may link an entity of the current configuration when you speak about that very entity: `[the left burner](entity:CookingTop-1)`. It helps the user find it in the configurator.",...h?["- Whenever you name recipes or options you read from `meta`, in a list, a table or a sentence, link each one: `[Single gas burner](recipe:KitchenRange-1/top/gas_single)` or `[Oak](option:Cabinet-2/finishOptions/oak)`. The link shows the user its picture or color and its description, so never draw previews yourself. The target is the entity id, the recipe group id or the options field you read, and the key or value, each encoded as in a URL."]:[]],["Replies","- Write Markdown only, never HTML: the panel does not render it."],["Forms","- To ask the user something they answer by picking or typing, end your reply with a form: a fenced code block with the language `form`. It holds only elements, written as lowercase tags with string attributes, without Markdown or text.","- Every element takes `label`, the text the user sees; on a container or an input it also names the answer. Options and inputs take `value`: an option sends it instead of its label, and an input starts with it.","- Options can also stand on their own, outside a `choice` or `choices`.","- An element or attribute not listed here, or an element other than an option inside a `choice` or `choices`, makes the whole form fail.","- The answer is the user's next message. Each container or input gives a line `Label: value`, or the bare value without a label; the lines of a labelled container are indented by two spaces under it, a `choices` lists each picked option on its own line, and `—` marks what was left unanswered.",'- Example: `<choice label="Plinth"><reply label="Black" /><reply label="Oak" /></choice>` is answered with `Plinth: Oak`.',...t.flatMap(([t,a])=>{let n=e.filter(({role:e})=>a.includes(e));return 0===n.length?[]:[`- ${t}:`,...n.map(e=>` - \`${(({name:e,role:t,attributes:a})=>{let n=["label",..."option"===t||"input"===t?["value"]:[],...Object.keys(a)];return"option"===t||"input"===t?`<${e} ${n.join(" ")} />`:`<${e} ${n.join(" ")}>…</${e}>`})(e)}\`: ${e.description}`)]})],...a.lenses?.declarations?[["Built-in fragments","- These fragments are already defined for every operation. Spread one by name on a field of its type, as in `field { ...FragmentName }`, instead of listing its fields.","- A fragment is a starting selection: add the other fields you need next to the spread, by name from the schema.","- Never define a fragment with one of these names.","",a.lenses.declarations]]:[]].map(e=>e.join("\n")).join("\n\n")};
1
+ import{ASSISTANT_BUILT_IN_FORM_ELEMENTS as e}from"./assistant-form-elements.js";let t=[["Containers",["group","choice","choices"]],["Options",["option"]],["Inputs",["input"]]];export const generateAssistantPrompt=a=>{let n=Object.values(a.childRecipes??{}).some(e=>e.length>0),s=Object.values(a.replaceRecipes??{}).some(e=>e.length>0),i=Object.values(a.fieldOptions??{}).some(e=>e.length>0),o=Object.keys(a.actions??{}).length>0,r=(a.deletableTypes?.length??0)>0||Object.values(a.writableFields??{}).some(e=>Object.keys(e).length>0)||n||s||o,h=n||s||i,l=[...n?["`childRecipes` is what can be added to it"]:[],...s?["`replaceRecipes` what it can be replaced with"]:[],...i?["`<field>Options` the values a field accepts"]:[]],d=["`selected`",...(a.navigationFields??[]).map(e=>`\`${e}\``)].join(", ");return[["Tools","- Put related operations in one call and select only the fields you need.",...r?[`- Use a mutation inside \`query\` to answer a what-if about a change ${h?"the lists under `meta` do not show":"before making it"}.`,"- Use `apply` only for what the user asked for."]:["- Nothing in this configurator can be changed through you. Say so when the user asks for a change."],"- When an operation fails, its `errors` say why and what to send instead."],...r?[["After a change","- A change is made only when the `apply` result has `committed: true`. Otherwise `errors` or `message` says what happened; without either, nothing changed. Never say a change was made when it was not.","- `sideEffects` names the major or unexpected things the configurator changed along with your change. Tell the user about them when committed; otherwise they describe what would happen. Smaller adjustments are not listed.","- A mutation returns the state after the change: use the ids and values it returned, not the ones you sent.",...o?["- When one mutation does the whole of what the user asked, use it instead of building the same change from several others."]:[]]]:[],...h?[["What can be done to an entity",`- \`meta\` lists what is possible right now: ${l.join(", ")}. Read the list before such a change and before telling the user what is available.`,`- You can select \`dryRun\` on ${[...n||s?["recipes"]:[],...i?["options"]:[]].join(" or ")} to look ahead and pick one that meets what the user asked for. It is optional before a change.`,"- Read the lists again after a change, unless their descriptions say they stay the same."]]:[],["The `[changes]` block","- Every user message starts with it: a glimpse of what the user did in the configurator since your last turn.",`- \`[changes: none]\`, or only ${d} lines: what you know still holds. Do not query it again.`,"- Other lines are a hint at what to read again: `A` added, `D` deleted, `M` modified with the fields. Text after `#` says what caused the line; `reset: undo/redo` says the user undid or redid changes.","- Read computed fields again when a listed change may affect them.","- `[changes: unavailable]` and `[changes: too many (n)]`: read again before relying on anything you read earlier.",...r?["- Your applied changes are not listed, except those waiting for user approval: they appear once approved."]:[]],["Reading the schema","- Take ids from results.",...(a.deletableTypes?.length??0)>0||s?["- The id of a deleted or replaced entity is gone and may later be given to another entity."]:[],`- A field whose name starts with \`_\` is computed: read it${r?", never write it":""}.`,"- Numbers are in the unit the field description names. Convert when the user uses another unit."],["Links","- You may link an entity of the current configuration when you speak about that very entity: `[the left burner](entity:CookingTop-1)`. It helps the user find it in the configurator.",...h?["- Whenever you name recipes or options you read from `meta`, in a list, a table or a sentence, link each one: `[Single gas burner](recipe:KitchenRange-1/top/gas_single)` or `[Oak](option:Cabinet-2/finishOptions/oak)`. The link shows the user its picture or color and its description, so never draw previews yourself. The target is the entity id, the recipe group id or the options field you read, and the key or value, each encoded as in a URL."]:[]],["Replies","- Write Markdown only, never HTML: the panel does not render it.","- An image, `![alt](path)`, is shown only when its path is relative."],["Forms","- To ask the user something they answer by picking or typing, end your reply with a form: a fenced code block with the language `form`. It holds only elements, written as lowercase tags with string attributes, without Markdown or text.","- Every element takes `label`, the text the user sees; on a container or an input it also names the answer. Options and inputs take `value`: an option sends it instead of its label, and an input starts with it.","- Options can also stand on their own, outside a `choice` or `choices`.","- An element or attribute not listed here, or an element other than an option inside a `choice` or `choices`, makes the whole form fail.","- The answer is the user's next message. Each container or input gives a line `Label: value`, or the bare value without a label; the lines of a labelled container are indented by two spaces under it, a `choices` lists each picked option on its own line, and `—` marks what was left unanswered.",'- Example: `<choice label="Plinth"><reply label="Black" /><reply label="Oak" /></choice>` is answered with `Plinth: Oak`.',"- The chat shows the answer as the user's own message, so a `value` reads as natural words, never as an id, key or code. Give `value` only when the label alone would be unclear as an answer, and map the answer's labels back to ids yourself.",...t.flatMap(([t,a])=>{let n=e.filter(({role:e})=>a.includes(e));return 0===n.length?[]:[`- ${t}:`,...n.map(e=>` - \`${(({name:e,role:t,attributes:a})=>{let n=["label",..."option"===t||"input"===t?["value"]:[],...Object.keys(a)];return"option"===t||"input"===t?`<${e} ${n.join(" ")} />`:`<${e} ${n.join(" ")}>…</${e}>`})(e)}\`: ${e.description}`)]})],...a.lenses?.declarations?[["Built-in fragments","- These fragments are already defined for every operation. Spread one by name on a field of its type, as in `field { ...FragmentName }`, instead of listing its fields.","- A fragment is a starting selection: add the other fields you need next to the spread, by name from the schema.","- Never define a fragment with one of these names.","",a.lenses.declarations]]:[]].map(e=>e.join("\n")).join("\n\n")};
@@ -26,15 +26,6 @@ export interface CustomPhoenixEntityElementProps {
26
26
  entityId: DomainEntityId<string>;
27
27
  children?: ReactNode;
28
28
  }
29
- export interface SystemElementRegistry {
30
- layoutElements: Record<string, (props: PropsWithChildren) => JSX.Element>;
31
- entityElements: Record<string, (props: CustomPhoenixEntityElementProps) => JSX.Element>;
32
- }
33
- /**
34
- * Internal registry for system-level elements registered at import time
35
- * via createPhoenixLayoutElement / createPhoenixEntityElement.
36
- */
37
- export declare const systemElementRegistry: SystemElementRegistry;
38
29
  type SchemaOfPhoenixLayoutElement<SCHEMA extends {
39
30
  kind: string;
40
31
  props?: Record<string, unknown>;
@@ -61,7 +52,12 @@ export interface PhoenixLayoutElementDefinition<SCHEMA extends {
61
52
  }>;
62
53
  }
63
54
  /**
64
- * For internal use in PHX only.
55
+ * Returns the component of a built-in layout element definition; it registers nothing. A layout
56
+ * element reaches the runtime only through a registration in `elements` or `defaultElements`.
57
+ *
58
+ * @deprecated Register a layout element with `createCustomPhoenixLayoutElement(name, component)`;
59
+ * the built-in ones are in `defaultConfiguratorElements` and `defaultAdminElements`. This API will
60
+ * be removed in a future version.
65
61
  */
66
62
  export declare const createPhoenixLayoutElement: <SCHEMA extends {
67
63
  kind: string;
@@ -95,7 +91,12 @@ export interface PhoenixEntityElementDefinition<SCHEMA extends {
95
91
  component: React.FunctionComponent<SCHEMA['props'] & CustomPhoenixEntityElementProps>;
96
92
  }
97
93
  /**
98
- * For internal use in PHX only.
94
+ * Returns the component of a built-in entity element definition; it registers nothing. An entity
95
+ * element reaches the runtime only through a registration in `elements` or `defaultElements`.
96
+ *
97
+ * @deprecated Register an entity element with `createCustomPhoenixEntityElement(name, component)`;
98
+ * the built-in ones are in `defaultConfiguratorElements` and `defaultAdminElements`. This API will
99
+ * be removed in a future version.
99
100
  */
100
101
  export declare const createPhoenixEntityElement: <SCHEMA extends {
101
102
  kind: string;
@@ -1 +1 @@
1
- import{SHARED_FOLDER_HINT as e,isRecord as t,resolveListModule as n}from"./project-modules.js";export const systemElementRegistry={layoutElements:{},entityElements:{}};export const createPhoenixLayoutElement=e=>(systemElementRegistry.layoutElements[e.schema.properties.kind.enum[0]]=e.component,e.component);export const createCustomPhoenixLayoutElement=(e,t)=>({type:"layout",name:e,element:t});export const createPhoenixEntityElement=e=>(systemElementRegistry.entityElements[e.schema.properties.kind.enum[0]]=e.component,e.component);export const createCustomPhoenixEntityElement=(e,t)=>({type:"entity",name:e,element:t});let o={expected:"an element registration, or an array of them",fix:`Create it with phx.frontend.createCustomPhoenixLayoutElement(...) or phx.frontend.createCustomPhoenixEntityElement(...), ${e}.`},r=e=>!!t(e)&&("icon"===e.type?Array.isArray(e.elements):("entity"===e.type||"layout"===e.type)&&"string"==typeof e.name&&"function"==typeof e.element);export const resolveElementModule=e=>n(e,o,r);export const resolveElementModules=e=>e.flatMap(resolveElementModule);
1
+ import{SHARED_FOLDER_HINT as e,isRecord as t,resolveListModule as o}from"./project-modules.js";export const createPhoenixLayoutElement=e=>e.component;export const createCustomPhoenixLayoutElement=(e,t)=>({type:"layout",name:e,element:t});export const createPhoenixEntityElement=e=>e.component;export const createCustomPhoenixEntityElement=(e,t)=>({type:"entity",name:e,element:t});let n={expected:"an element registration, or an array of them",fix:`Create it with phx.frontend.createCustomPhoenixLayoutElement(...) or phx.frontend.createCustomPhoenixEntityElement(...), ${e}.`},r=e=>!!t(e)&&("icon"===e.type?Array.isArray(e.elements):("entity"===e.type||"layout"===e.type)&&"string"==typeof e.name&&"function"==typeof e.element);export const resolveElementModule=e=>o(e,n,r);export const resolveElementModules=e=>e.flatMap(resolveElementModule);
@@ -1,4 +1,4 @@
1
- export { type PhoenixEntityElementProps, type PhoenixEntityElementRegistration, type PhoenixLayoutElementRegistration, type PhoenixIconRegistration, type ElementRegistration, type CustomPhoenixEntityElementProps, type PhoenixLayoutElementDefinition, type PhoenixEntityElementDefinition, type CreateCustomPhoenixLayoutElement, type CreateCustomPhoenixEntityElement, createPhoenixLayoutElement, createPhoenixEntityElement, createCustomPhoenixLayoutElement, createCustomPhoenixEntityElement, resolveElementModule, resolveElementModules, systemElementRegistry, } from './element-registration.js';
1
+ export { type PhoenixEntityElementProps, type PhoenixEntityElementRegistration, type PhoenixLayoutElementRegistration, type PhoenixIconRegistration, type ElementRegistration, type CustomPhoenixEntityElementProps, type PhoenixLayoutElementDefinition, type PhoenixEntityElementDefinition, type CreateCustomPhoenixLayoutElement, type CreateCustomPhoenixEntityElement, createPhoenixLayoutElement, createPhoenixEntityElement, createCustomPhoenixLayoutElement, createCustomPhoenixEntityElement, resolveElementModule, resolveElementModules, } from './element-registration.js';
2
2
  export { type PhoenixHandlerDefinition, type SystemPhoenixHandlerDefinition, type PhoenixHandlerRegistration, type SystemPhoenixHandlerRegistration, type SystemPhoenixAsyncHandlerDefinition, type SystemPhoenixAsyncHandlerRegistration, type HandlerRegistration, type CreatePhoenixHandler, createPhoenixHandler, createSystemPhoenixHandler, createSystemPhoenixAsyncHandler, resolveHandlerModule, resolveHandlerModules, } from './handler-registration.js';
3
3
  export { type ProjectModule } from './project-modules.js';
4
4
  export { resolveActionModules } from './resolve-action-modules.js';
@@ -1 +1 @@
1
- export{createPhoenixLayoutElement,createPhoenixEntityElement,createCustomPhoenixLayoutElement,createCustomPhoenixEntityElement,resolveElementModule,resolveElementModules,systemElementRegistry}from"./element-registration.js";export{createPhoenixHandler,createSystemPhoenixHandler,createSystemPhoenixAsyncHandler,resolveHandlerModule,resolveHandlerModules}from"./handler-registration.js";export{resolveActionModules}from"./resolve-action-modules.js";export{resolveComponentOpticModules}from"./resolve-component-optic-modules.js";export{resolveExpressionModules}from"./resolve-expression-modules.js";export{resolveImportedTransformers,resolveTransformerModule,resolveTransformerModules}from"./resolve-imported-transformers.js";export{resolveInvariantModules}from"./resolve-invariant-modules.js";
1
+ export{createPhoenixLayoutElement,createPhoenixEntityElement,createCustomPhoenixLayoutElement,createCustomPhoenixEntityElement,resolveElementModule,resolveElementModules}from"./element-registration.js";export{createPhoenixHandler,createSystemPhoenixHandler,createSystemPhoenixAsyncHandler,resolveHandlerModule,resolveHandlerModules}from"./handler-registration.js";export{resolveActionModules}from"./resolve-action-modules.js";export{resolveComponentOpticModules}from"./resolve-component-optic-modules.js";export{resolveExpressionModules}from"./resolve-expression-modules.js";export{resolveImportedTransformers,resolveTransformerModule,resolveTransformerModules}from"./resolve-imported-transformers.js";export{resolveInvariantModules}from"./resolve-invariant-modules.js";
@@ -1 +1 @@
1
- import{createSelector as e}from"@salsita-ai/common/utils";import{buildAssistantManifest as t}from"../../application/assistant/index.js";import{systemElementRegistry as n}from"./module-checks/index.js";export const createSpecSelectors=a=>{let{getState:s}=a,r=e.withTypes(),l=r([r.leaf(e=>e.spec)],e=>e),o=r([l],e=>e.version),i=r([l],e=>e.baseResourcesUrl),m=r([l],e=>e.configurator),g=r([l],e=>e.dataConfig),p=r([l],e=>e.chunks),d=r([l],e=>e.publishedDataHash),c=r([l],e=>e.initialPublishedData),u=r([l],e=>e.canCreate),h=r([l],e=>e.enableAdminRelease),y=r([l],e=>e.textLanguages),f=r([m],e=>e.modelVersion),C=r([l],e=>e.admin),E=r([C],e=>e.preset),x=r([C],e=>e.modelVersion),A=r([m],e=>e.theme),b=r([m],e=>e.assistant),H=r([b],e=>e?t(e):null),D=r([m],e=>e.factory),P=r([C],e=>e.factory),S=r([m],e=>e.componentOptics),w=r([C],e=>e.componentOptics),O=r([m],e=>e.appLoader),T=r([m],e=>e.preview),V=r([m],e=>e.alwaysExpand),L=r([m],e=>e.presets),R=r([m],e=>e.deploymentQueryDisabled),U=r([m],e=>e.prefetchTextureUrls),k=r([m],e=>e.handlerHashes),v=r([m],e=>e.handlers),j=r([v,k],(e,t)=>({...(e=>{let t={},n={},a={};for(let s of e)"phoenix"===s.type&&(t[s.name]=s.handler),"system"===s.type&&(n[s.name]=s.handler),"system-async"===s.type&&(a[s.name]=s.handler);return{handlers:t,systemHandlers:n,systemAsyncHandlers:a}})(e),hashes:t})),F=r([m],e=>e.elementHashes),M=r([m],e=>e.elements),Q=r([m],e=>e.defaultElements),B=r([Q,M,F],(e,t,a)=>({...(e=>{let t={},a={};for(let n of e)"layout"===n.type&&(t[n.name]=n.element),"entity"===n.type&&(a[n.name]=n.element);return{entityElements:{...n.entityElements,...a},layoutElements:{...n.layoutElements,...t}}})([...e,...t]),hashes:a}));return{selectSpec:l,selectVersion:o,selectBaseResourcesUrl:i,selectConfiguratorSpec:m,selectConfiguratorModelVersion:f,selectAdminSpec:C,selectAdminPreset:E,selectAdminModelVersion:x,selectThemeOptions:A,selectAssistant:H,selectConfiguratorFactory:D,selectAdminFactory:P,selectConfiguratorComponentOptics:S,selectAdminComponentOptics:w,selectAppLoader:O,selectPreview:T,selectAlwaysExpand:V,selectPresetSeed:L,selectDeploymentQueryDisabled:R,selectPrefetchTextureUrls:U,selectTextLanguages:y,selectHandlerHashes:k,selectHandlers:v,selectHandlerSlots:j,selectElementHashes:F,selectElements:M,selectElementSlots:B,selectDataConfig:g,selectChunks:p,selectPublishedDataHash:d,selectInitialPublishedData:c,selectCanCreate:u,selectEnableAdminRelease:h,getVersion:()=>o(s()),getBaseResourcesUrl:()=>i(s()),getConfiguratorSpec:()=>m(s()),getConfiguratorModelVersion:()=>f(s()),getAdminSpec:()=>C(s()),getAdminPreset:()=>E(s()),getAdminModelVersion:()=>x(s()),getThemeOptions:()=>A(s()),getAssistant:()=>H(s()),getConfiguratorFactory:()=>D(s()),getAdminFactory:()=>P(s()),getConfiguratorComponentOptics:()=>S(s()),getAdminComponentOptics:()=>w(s()),getAppLoader:()=>O(s()),getPreview:()=>T(s()),getAlwaysExpand:()=>V(s()),getPresetSeed:()=>L(s()),getDeploymentQueryDisabled:()=>R(s()),getPrefetchTextureUrls:()=>U(s()),getTextLanguages:()=>y(s()),getHandlerHashes:()=>k(s()),getHandlers:()=>v(s()),getHandlerSlots:()=>j(s()),getElementHashes:()=>F(s()),getElements:()=>M(s()),getElementSlots:()=>B(s()),getDataConfig:()=>g(s()),getChunks:()=>p(s()),getPublishedDataHash:()=>d(s()),getInitialPublishedData:()=>c(s()),getCanCreate:()=>u(s()),getEnableAdminRelease:()=>h(s())}};
1
+ import{createSelector as e}from"@salsita-ai/common/utils";import{buildAssistantManifest as t}from"../../application/assistant/index.js";export const createSpecSelectors=a=>{let{getState:n}=a,s=e.withTypes(),r=s([s.leaf(e=>e.spec)],e=>e),l=s([r],e=>e.version),o=s([r],e=>e.baseResourcesUrl),i=s([r],e=>e.configurator),g=s([r],e=>e.dataConfig),m=s([r],e=>e.chunks),p=s([r],e=>e.publishedDataHash),d=s([r],e=>e.initialPublishedData),c=s([r],e=>e.canCreate),u=s([r],e=>e.enableAdminRelease),h=s([r],e=>e.textLanguages),y=s([i],e=>e.modelVersion),f=s([r],e=>e.admin),C=s([f],e=>e.preset),A=s([f],e=>e.modelVersion),b=s([i],e=>e.theme),x=s([i],e=>e.assistant),E=s([x],e=>e?t(e):null),H=s([i],e=>e.factory),D=s([f],e=>e.factory),P=s([i],e=>e.componentOptics),S=s([f],e=>e.componentOptics),w=s([i],e=>e.appLoader),O=s([i],e=>e.preview),T=s([i],e=>e.alwaysExpand),V=s([i],e=>e.presets),L=s([i],e=>e.deploymentQueryDisabled),R=s([i],e=>e.prefetchTextureUrls),U=s([i],e=>e.handlerHashes),v=s([i],e=>e.handlers),k=s([v,U],(e,t)=>({...(e=>{let t={},a={},n={};for(let s of e)"phoenix"===s.type&&(t[s.name]=s.handler),"system"===s.type&&(a[s.name]=s.handler),"system-async"===s.type&&(n[s.name]=s.handler);return{handlers:t,systemHandlers:a,systemAsyncHandlers:n}})(e),hashes:t})),F=s([i],e=>e.elementHashes),M=s([i],e=>e.elements),Q=s([i],e=>e.defaultElements),j=s([Q,M,F],(e,t,a)=>({...(e=>{let t={},a={};for(let n of e)"layout"===n.type&&(t[n.name]=n.element),"entity"===n.type&&(a[n.name]=n.element);return{entityElements:a,layoutElements:t}})([...e,...t]),hashes:a}));return{selectSpec:r,selectVersion:l,selectBaseResourcesUrl:o,selectConfiguratorSpec:i,selectConfiguratorModelVersion:y,selectAdminSpec:f,selectAdminPreset:C,selectAdminModelVersion:A,selectThemeOptions:b,selectAssistant:E,selectConfiguratorFactory:H,selectAdminFactory:D,selectConfiguratorComponentOptics:P,selectAdminComponentOptics:S,selectAppLoader:w,selectPreview:O,selectAlwaysExpand:T,selectPresetSeed:V,selectDeploymentQueryDisabled:L,selectPrefetchTextureUrls:R,selectTextLanguages:h,selectHandlerHashes:U,selectHandlers:v,selectHandlerSlots:k,selectElementHashes:F,selectElements:M,selectElementSlots:j,selectDataConfig:g,selectChunks:m,selectPublishedDataHash:p,selectInitialPublishedData:d,selectCanCreate:c,selectEnableAdminRelease:u,getVersion:()=>l(n()),getBaseResourcesUrl:()=>o(n()),getConfiguratorSpec:()=>i(n()),getConfiguratorModelVersion:()=>y(n()),getAdminSpec:()=>f(n()),getAdminPreset:()=>C(n()),getAdminModelVersion:()=>A(n()),getThemeOptions:()=>b(n()),getAssistant:()=>E(n()),getConfiguratorFactory:()=>H(n()),getAdminFactory:()=>D(n()),getConfiguratorComponentOptics:()=>P(n()),getAdminComponentOptics:()=>S(n()),getAppLoader:()=>w(n()),getPreview:()=>O(n()),getAlwaysExpand:()=>T(n()),getPresetSeed:()=>V(n()),getDeploymentQueryDisabled:()=>L(n()),getPrefetchTextureUrls:()=>R(n()),getTextLanguages:()=>h(n()),getHandlerHashes:()=>U(n()),getHandlers:()=>v(n()),getHandlerSlots:()=>k(n()),getElementHashes:()=>F(n()),getElements:()=>M(n()),getElementSlots:()=>j(n()),getDataConfig:()=>g(n()),getChunks:()=>m(n()),getPublishedDataHash:()=>p(n()),getInitialPublishedData:()=>d(n()),getCanCreate:()=>c(n()),getEnableAdminRelease:()=>u(n())}};
@@ -32,6 +32,13 @@ export interface EditorProps {
32
32
  readonly mockTemplates?: MockTemplateDefinition[];
33
33
  /** If true, automatically apply the first template when templates are initialized */
34
34
  readonly autoApplyTemplate?: boolean;
35
+ /**
36
+ * Key of the mock template to apply on mount, in place of the template stored for this page.
37
+ * Applying it does not store it, so it never changes what an editor without this prop opens.
38
+ * An unknown key logs a warning and falls back to the stored template, or to the first template
39
+ * when `autoApplyTemplate` is set.
40
+ */
41
+ readonly initialTemplateKey?: string;
35
42
  /** Key used to scope localStorage template persistence (e.g. environment slug) */
36
43
  readonly environmentKey?: string;
37
44
  /** Web component tag name for creating and discovering reflection systems. */