@salsita-ai/sdk 0.50.0-develop.0ef5d49cfb → 0.50.0-develop.1162eef277
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.
- package/dist/application-spec/generate-application/code/common/index.d.ts +1 -0
- package/dist/application-spec/generate-application/code/common/index.js +1 -1
- package/dist/application-spec/generate-application/code/common/project-module-list.d.ts +8 -0
- package/dist/application-spec/generate-application/code/common/project-module-list.js +3 -0
- package/dist/application-spec/generate-application/code/domain-runtime-files.js +1 -1
- package/dist/application-spec/generate-application/code/project-scaffolding.js +2 -2
- package/dist/application-spec/generate-application/code/templates/admin-domain-code.d.ts +1 -2
- package/dist/application-spec/generate-application/code/templates/admin-domain-code.js +6 -14
- package/dist/application-spec/generate-application/code/templates/admin-frontend-code.d.ts +1 -2
- package/dist/application-spec/generate-application/code/templates/admin-frontend-code.js +4 -4
- package/dist/application-spec/generate-application/code/templates/configurator-domain-code.d.ts +1 -2
- package/dist/application-spec/generate-application/code/templates/configurator-domain-code.js +7 -16
- package/dist/application-spec/generate-application/code/templates/configurator-frontend-code.d.ts +1 -2
- package/dist/application-spec/generate-application/code/templates/configurator-frontend-code.js +7 -9
- package/dist/application-spec/generate-application/code/templates/domain-spec/generate-assistant.d.ts +2 -2
- package/dist/application-spec/generate-application/code/templates/domain-spec/generate-assistant.js +1 -1
- package/dist/application-spec/generate-application/code/templates/domain-spec.js +4 -4
- package/dist/application-spec/generate-application/code/templates/domain.js +3 -3
- package/dist/application-spec/generate-application/code/templates/index.d.ts +1 -0
- package/dist/application-spec/generate-application/code/templates/index.js +1 -1
- package/dist/application-spec/generate-application/code/templates/skills/agents-md.js +1 -1
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-cli-skill.js +1 -1
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-create-configurator-skill.js +41 -13
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-feedback-skill.js +1 -1
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-review-skill.js +2 -2
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-skill.js +1 -1
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-variants-skill.d.ts +1 -0
- package/dist/application-spec/generate-application/code/templates/skills/phoenix-variants-skill.js +6 -0
- package/dist/application-spec/generate-application/code/templates/skills/sdk-content.d.ts +30 -3
- package/dist/application-spec/generate-application/code/templates/skills/sdk-content.js +19 -5
- package/dist/application-spec/generate-application/code/templates/webhook-builders.js +8 -4
- package/dist/application-spec/generate-application/runtime/sections/assistant-runtime.d.ts +4 -3
- package/dist/application-spec/generate-application/runtime/sections/assistant-runtime.js +1 -1
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-field-type.d.ts +3 -8
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-field-type.js +1 -1
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-schema.d.ts +9 -43
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-schema.js +1 -1
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant-server-settings.d.ts +2 -2
- package/dist/application-spec/parse-application-files/spec/sections/assistant/assistant.d.ts +5 -21
- package/dist/client/phoenix-api.d.ts +58 -30
- package/dist/configurator/application-runtime/extensions/selectors.js +1 -1
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.d.ts +158 -13
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.js +1 -1
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/change-recorder.d.ts +85 -0
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/change-recorder.js +1 -0
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/graphql-tools.d.ts +8 -3
- package/dist/configurator/application-runtime/extensions/systems/assistant-system/graphql-tools.js +1 -1
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/entity-meta.d.ts +4 -0
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/entity-meta.js +1 -1
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/graphql-system.d.ts +16 -1
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/graphql-system.js +1 -1
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/side-effects.d.ts +9 -0
- package/dist/configurator/application-runtime/extensions/systems/graphql-system/side-effects.js +1 -0
- package/dist/configurator/application-runtime/extensions/systems/index.d.ts +1 -1
- package/dist/configurator/application-runtime/extensions/systems/layout-system/layout-system.d.ts +2 -0
- package/dist/configurator/application-runtime/extensions/systems/layout-system/layout-system.js +1 -1
- package/dist/configurator/common/frontend-analytics.d.ts +21 -21
- package/dist/configurator/index.d.ts +0 -1
- package/dist/configurator/index.js +1 -1
- package/dist/configurator/pages/LoadedConfiguratorDetailPage.js +1 -1
- package/dist/configurator/scene/scene-analytics/scene-analytics.d.ts +2 -2
- package/dist/configurator/ui/assistant/AssistantChips.d.ts +11 -0
- package/dist/configurator/ui/assistant/AssistantChips.js +1 -0
- package/dist/configurator/ui/assistant/AssistantComposer.d.ts +6 -0
- package/dist/configurator/ui/assistant/AssistantComposer.js +1 -0
- package/dist/configurator/ui/assistant/AssistantMarkdown.d.ts +7 -0
- package/dist/configurator/ui/assistant/AssistantMarkdown.js +1 -0
- package/dist/configurator/ui/assistant/AssistantPanel.d.ts +11 -0
- package/dist/configurator/ui/assistant/AssistantPanel.js +1 -0
- package/dist/configurator/ui/assistant/AssistantThread.d.ts +6 -0
- package/dist/configurator/ui/assistant/AssistantThread.js +1 -0
- package/dist/configurator/ui/assistant/assistant-failure.d.ts +18 -0
- package/dist/configurator/ui/assistant/assistant-failure.js +1 -0
- package/dist/configurator/ui/assistant/index.d.ts +2 -0
- package/dist/configurator/ui/assistant/index.js +1 -0
- package/dist/configurator/ui/assistant/streamed-markdown.d.ts +6 -0
- package/dist/configurator/ui/assistant/streamed-markdown.js +2 -0
- package/dist/configurator/ui/assistant/theme.d.ts +2 -0
- package/dist/configurator/ui/assistant/theme.js +1 -0
- package/dist/configurator/ui/assistant/thread-items.d.ts +37 -0
- package/dist/configurator/ui/assistant/thread-items.js +1 -0
- package/dist/configurator/ui/assistant/tool-chip.d.ts +44 -0
- package/dist/configurator/ui/assistant/tool-chip.js +1 -0
- package/dist/configurator/ui/assistant/use-follow-stream.d.ts +17 -0
- package/dist/configurator/ui/assistant/use-follow-stream.js +1 -0
- package/dist/configurator/ui/assistant/use-is-assistant-panel-open.d.ts +5 -0
- package/dist/configurator/ui/assistant/use-is-assistant-panel-open.js +1 -0
- package/dist/configurator/ui/configurator-layout/universal/DesktopLayout.js +5 -5
- package/dist/configurator/ui/configurator-layout/universal/MobileLayout.d.ts +2 -0
- package/dist/configurator/ui/configurator-layout/universal/MobileLayout.js +4 -4
- package/dist/configurator/ui/legacy/mobile-controls/MobileControls.d.ts +1 -1
- package/dist/configurator/ui/phoenix-layout-elements/AssistantToolbarButton.d.ts +10 -0
- package/dist/configurator/ui/phoenix-layout-elements/AssistantToolbarButton.js +1 -0
- package/dist/configurator/ui/phoenix-layout-elements/index.d.ts +1 -0
- package/dist/configurator/ui/phoenix-layout-elements/index.js +1 -1
- package/dist/docs/complex-use-cases/filtered-controls-with-fix-dialog.mdx +84 -98
- package/dist/docs/complex-use-cases/navigation-reset-selection.mdx +18 -12
- package/dist/docs/index.json +1 -1
- package/dist/docs/layouts/custom-price.mdx +14 -16
- package/dist/docs/layouts/sidebar/tabs.mdx +24 -21
- package/dist/docs/layouts/toolbar.mdx +6 -0
- package/dist/docs/other-features/domain-actions.mdx +1 -1
- package/dist/docs/other-features/side-effects.mdx +68 -34
- package/dist/docs/other-features/transformers.mdx +1 -1
- package/dist/docs/phoenix/admin.mdx +9 -24
- package/dist/docs/phoenix/localization.mdx +3 -22
- package/dist/docs/phoenix/phoenix-cli.mdx +81 -2
- package/dist/docs/phoenix/project-structure.mdx +9 -2
- package/dist/docs/phoenix/sdk-builder-workflow.mdx +4 -3
- package/dist/docs/recipes-and-delete/recipe-hierarchy-selection.mdx +15 -13
- package/dist/docs/relations/hierarchy.mdx +13 -2
- package/dist/domain/actions/action-factory.d.ts +3 -2
- package/dist/domain/application/application-config.d.ts +25 -75
- package/dist/domain/application/assistant/assistant-manifest.d.ts +61 -0
- package/dist/domain/application/assistant/assistant-manifest.js +1 -0
- package/dist/domain/application/assistant/assistant-resolved-manifest.d.ts +95 -0
- package/dist/domain/application/assistant/assistant-resolved-manifest.js +1 -0
- package/dist/domain/application/assistant/assistant-value-type.d.ts +9 -0
- package/dist/domain/application/assistant/assistant-value-type.js +1 -0
- package/dist/domain/application/assistant/build-assistant-manifest.d.ts +4 -0
- package/dist/domain/application/assistant/build-assistant-manifest.js +1 -0
- package/dist/{phoenix/application-spec → domain/application/assistant}/generate-assistant-prompt.d.ts +6 -5
- package/dist/domain/application/assistant/generate-assistant-prompt.js +1 -0
- package/dist/domain/application/assistant/index.d.ts +4 -0
- package/dist/domain/application/assistant/index.js +1 -0
- package/dist/domain/application/assistant-field-options.d.ts +1 -1
- package/dist/domain/application/assistant-mutations.d.ts +1 -1
- package/dist/domain/application/assistant-recipe-groups.d.ts +1 -1
- package/dist/domain/application/configurator-builder.d.ts +33 -18
- package/dist/domain/application/configurator-builder.js +1 -1
- package/dist/domain/application/element-registration.d.ts +5 -0
- package/dist/domain/application/element-registration.js +1 -1
- package/dist/domain/application/handler-registration.d.ts +5 -0
- package/dist/domain/application/handler-registration.js +1 -1
- package/dist/domain/application/index.d.ts +5 -4
- package/dist/domain/application/index.js +1 -1
- package/dist/domain/application/resolve-imported-transformers.d.ts +11 -1
- package/dist/domain/application/resolve-imported-transformers.js +1 -1
- package/dist/domain/components/domain-component-optic.d.ts +3 -0
- package/dist/domain/components/domain-component-optic.js +2 -2
- package/dist/domain/components/updates.d.ts +16 -0
- package/dist/domain/core/action.d.ts +1 -1
- package/dist/domain/domain-builder.d.ts +10 -1
- package/dist/domain/domain-builder.js +1 -1
- package/dist/domain/domain-context/index.d.ts +1 -1
- package/dist/domain/domain-context/store-system/store-system.js +1 -1
- package/dist/domain/domain-context/transformers/chain-builder.d.ts +1 -1
- package/dist/domain/domain-runtime/domain-runtime.d.ts +4 -4
- package/dist/domain/domain-runtime/spec/initialize.js +1 -1
- package/dist/domain/domain-runtime/spec/selectors.d.ts +2 -2
- package/dist/domain/domain-runtime/spec/selectors.js +1 -1
- package/dist/domain/domain-runtime/spec/types.d.ts +3 -3
- package/dist/domain/index.d.ts +3 -2
- package/dist/domain/index.js +1 -1
- package/dist/domain/invariants/invariants.d.ts +9 -0
- package/dist/domain/invariants/invariants.js +1 -1
- package/dist/domain/mocks/create-mock-domain-runtime.d.ts +3 -3
- package/dist/domain/mocks/create-mock-domain-runtime.js +1 -1
- package/dist/domain/project-modules/index.d.ts +1 -0
- package/dist/domain/project-modules/index.js +1 -0
- package/dist/domain/project-modules/project-modules.d.ts +41 -0
- package/dist/domain/project-modules/project-modules.js +1 -0
- package/dist/domain/system-components/common/dimension-indicator-schema.d.ts +1 -1
- package/dist/domain/system-components/common/dimension-indicator-schema.js +1 -1
- package/dist/domain/system-components/phoenix-layout-elements/assistant-toolbar-button.d.ts +44 -0
- package/dist/domain/system-components/phoenix-layout-elements/assistant-toolbar-button.js +1 -0
- package/dist/domain/system-components/phoenix-layout-elements/index.d.ts +1 -0
- package/dist/domain/system-components/phoenix-layout-elements/index.js +1 -1
- package/dist/domain/system-components/phoenix-layout-elements/phoenix-layout-element.d.ts +2 -1
- package/dist/domain/system-components/phoenix-layout-elements/phoenix-layout-element.js +1 -1
- package/dist/editor/Editor.js +1 -1
- package/dist/editor/domain-editors/use-implementation-files.d.ts +7 -6
- package/dist/editor/domain-editors/use-implementation-files.js +1 -1
- package/dist/editor/graphql/GraphQLPanel.js +1 -1
- package/dist/editor/variants/VariantAnswerFooter.d.ts +17 -0
- package/dist/editor/variants/VariantAnswerFooter.js +1 -0
- package/dist/editor/variants/VariantPreviewHandler.d.ts +6 -0
- package/dist/editor/variants/VariantPreviewHandler.js +1 -0
- package/dist/editor/variants/variant-preview-styles.d.ts +49 -0
- package/dist/editor/variants/variant-preview-styles.js +1 -0
- package/dist/i18n/locales/cs/messages.js +1 -1
- package/dist/i18n/locales/da/messages.js +1 -1
- package/dist/i18n/locales/de/messages.js +1 -1
- package/dist/i18n/locales/de-AT/messages.js +1 -1
- package/dist/i18n/locales/en/messages.js +1 -1
- package/dist/i18n/locales/en-AU/messages.js +1 -1
- package/dist/i18n/locales/en-GB/messages.js +1 -1
- package/dist/i18n/locales/es/messages.js +1 -1
- package/dist/i18n/locales/fr/messages.js +1 -1
- package/dist/i18n/locales/hu/messages.js +1 -1
- package/dist/i18n/locales/it/messages.js +1 -1
- package/dist/i18n/locales/nl/messages.js +1 -1
- package/dist/i18n/locales/pl/messages.js +1 -1
- package/dist/i18n/locales/pt/messages.js +1 -1
- package/dist/i18n/locales/ro/messages.js +1 -1
- package/dist/i18n/locales/sk/messages.js +1 -1
- package/dist/i18n/locales/tr/messages.js +1 -1
- package/dist/legacy/domain-cli/gen/configurator-builder.js +21 -8
- package/dist/legacy/domain-cli/utils/cache.d.ts +1 -1
- package/dist/legacy/domain-cli/utils/cache.js +1 -1
- package/dist/legacy/domain-spec/__generated/domain-schema.d.ts +6 -0
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-admin.js +18 -19
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-configurator.js +15 -16
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-embedded-admin.js +22 -23
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/frontend-embedded-configurator.js +15 -16
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/generator-shared.d.ts +7 -2
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/generator-shared.js +8 -12
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/index.d.ts +1 -1
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/index.js +1 -1
- package/dist/legacy/phoenix-cli/project-gen/generators/file-templates/webhook-builders.js +7 -7
- package/dist/phoenix/application-spec/application-spec-builder.js +1 -1
- package/dist/phoenix/application-spec/resolve-deployment-data.d.ts +4 -3
- package/dist/phoenix/application-spec/resolve-deployment-data.js +2 -2
- package/dist/phoenix/cli.js +1 -1
- package/dist/phoenix/commands/deploy.js +2 -2
- package/dist/phoenix/commands/dev.js +5 -5
- package/dist/phoenix/commands/index.d.ts +1 -0
- package/dist/phoenix/commands/index.js +1 -1
- package/dist/phoenix/commands/prepare-deployment-command.js +2 -2
- package/dist/phoenix/commands/prepare-local-environment-command.js +1 -1
- package/dist/phoenix/commands/story-dev.js +2 -2
- package/dist/phoenix/commands/variants.d.ts +35 -0
- package/dist/phoenix/commands/variants.js +1 -0
- package/dist/phoenix/editor-server/commands-router.d.ts +68 -1
- package/dist/phoenix/editor-server/commands-router.js +1 -1
- package/dist/phoenix/editor-server/editor-router.d.ts +65 -0
- package/dist/phoenix/editor-server/editor-server.d.ts +3 -3
- package/dist/phoenix/editor-server/editor-server.js +1 -1
- package/dist/phoenix/editor-server/protocol.d.ts +1 -0
- package/dist/phoenix/editor-server/spec-router.js +1 -1
- package/dist/phoenix/editor-server/trpc.d.ts +3 -0
- package/dist/phoenix/services/application-spec-project-watcher.d.ts +13 -2
- package/dist/phoenix/services/application-spec-project-watcher.js +3 -3
- package/dist/phoenix/services/index.d.ts +4 -0
- package/dist/phoenix/services/index.js +1 -1
- package/dist/phoenix/services/phoenix-application.d.ts +21 -0
- package/dist/phoenix/services/phoenix-application.js +1 -0
- package/dist/phoenix/services/phoenix-store.d.ts +48 -0
- package/dist/phoenix/services/phoenix-store.js +1 -0
- package/dist/phoenix/services/phx-variant-previews-plugin.d.ts +9 -0
- package/dist/phoenix/services/phx-variant-previews-plugin.js +1 -0
- package/dist/phoenix/services/prepare-development-environment.js +1 -1
- package/dist/phoenix/services/variant-file-session.d.ts +36 -0
- package/dist/phoenix/services/variant-file-session.js +1 -0
- package/dist/phoenix/services/variant-preview-service.d.ts +80 -0
- package/dist/phoenix/services/variant-preview-service.js +1 -0
- package/dist/phoenix/services/vite-config.js +1 -1
- package/dist/react-sdk/application-runtime/common-services/analytics/analytics-service.d.ts +2 -2
- package/dist/react-sdk/application-runtime/common-services/analytics/domain-controls-analytics.d.ts +21 -21
- package/dist/react-sdk/application-runtime/hooks/data/use-published-data.d.ts +1 -1
- package/dist/react-sdk/application-runtime/hooks/use-domain-application-props.d.ts +5 -2
- package/dist/react-sdk/application-runtime/hooks/use-spec.d.ts +1 -1
- package/dist/react-sdk/application-runtime/mocks/create-mock-application-runtime.d.ts +1 -1
- package/dist/react-sdk/application-runtime/mocks/create-mock-application-runtime.js +1 -1
- package/dist/react-sdk/application-runtime/runtime/create-application-runtime.d.ts +4 -4
- package/dist/ui-sdk/common/use-viewport-size.d.ts +4 -1
- package/dist/ui-sdk/common/use-viewport-size.js +1 -1
- package/dist/ui-sdk/components/mobile-controls/index.d.ts +1 -1
- package/dist/ui-sdk/theme/types.d.ts +4 -0
- package/dist/webhook/builders/common.d.ts +3 -0
- package/dist/webhook/builders/webhook-builder.d.ts +1 -1
- package/dist/webhook/builders/webhook-builder.js +1 -1
- package/package.json +5 -8
- package/schema/domain-spec.json +24 -0
- package/dist/configurator/assistant/index.d.ts +0 -1
- package/dist/configurator/assistant/index.js +0 -1
- package/dist/configurator/assistant/use-assistant-chat.d.ts +0 -20
- package/dist/configurator/assistant/use-assistant-chat.js +0 -1
- package/dist/extras/assistant/AssistantChat.d.ts +0 -6
- package/dist/extras/assistant/AssistantChat.js +0 -1
- package/dist/extras/assistant/index.d.ts +0 -1
- package/dist/extras/assistant/index.js +0 -1
- package/dist/phoenix/application-spec/generate-assistant-prompt.js +0 -1
|
@@ -66,42 +66,76 @@ With following control structure. The top input selects the material, the bottom
|
|
|
66
66
|
The transformer is used to change the finish if necessary and show the notification.
|
|
67
67
|
|
|
68
68
|
```typescript
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
.
|
|
69
|
+
// src/transformers/fix-finish.ts
|
|
70
|
+
import { msg } from '@lingui/core/macro'
|
|
71
|
+
|
|
72
|
+
import { availableMaterials } from '../_shared/materials.js'
|
|
73
|
+
|
|
74
|
+
export default phx.frontend.transformerBuilder.when
|
|
75
|
+
.entity(['Plate'])
|
|
76
|
+
.modified({ atFields: ['material'] })
|
|
77
|
+
.causes.self.violation(['finishNotAvailable'])
|
|
78
|
+
.then.applySideEffect(({ update, getOld$Entity }) => {
|
|
79
|
+
const oldPlate = getOld$Entity()
|
|
80
|
+
const newMaterial = update.stateDelta.material
|
|
81
|
+
|
|
82
|
+
const validMaterial =
|
|
83
|
+
availableMaterials.find(m => m.material === newMaterial && m.finish === oldPlate.finish) ??
|
|
84
|
+
availableMaterials.find(m => m.material === newMaterial)
|
|
85
|
+
|
|
86
|
+
if (!validMaterial || validMaterial.finish === oldPlate.finish) {
|
|
87
|
+
return []
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// create an additional update that will fix the material finish
|
|
91
|
+
const fixUpdate = phx.frontend.updates.DomainEntityModification({
|
|
92
|
+
entityId: oldPlate.id,
|
|
93
|
+
stateDelta: {
|
|
94
|
+
finish: validMaterial.finish,
|
|
95
|
+
},
|
|
96
|
+
updateTag: 'fix.finish',
|
|
97
|
+
hint: msg`Material finish was adjusted`, // specify a hint for the user (side effect)
|
|
98
|
+
})
|
|
99
|
+
|
|
100
|
+
return [fixUpdate]
|
|
101
|
+
})
|
|
102
|
+
.build('fix-finish')
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
+
Each file in `src/transformers/` default-exports one transformer and is picked up by its location. The `transformers` section of the spec turns it on by name. For a transformer made with `build(name)` that is the name passed to `build(...)`, which must match the file name with case and dashes ignored (`fix-finish.ts` and `fixFinish` match). For a plain-function export it is the file name:
|
|
106
|
+
|
|
107
|
+
```yaml
|
|
108
|
+
# spec/application.yaml
|
|
109
|
+
transformers:
|
|
110
|
+
- name: fix-finish
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Hints and the AI assistant
|
|
114
|
+
|
|
115
|
+
In a configurator with the AI assistant, the assistant is told the same hints: they arrive as
|
|
116
|
+
`sideEffects` with the result of its changes and in the dry-runs of recipes and options, so it can
|
|
117
|
+
tell the user what else happened. The hints also explain what the user changed between two messages:
|
|
118
|
+
every message carries a change record of the configuration, and each of its lines ends with the hint
|
|
119
|
+
of the last update that touched it, or with the `updateTag` when the update has none. Set `agentHint`
|
|
120
|
+
beside `hint` when the assistant needs different wording, for example with ids or values a snackbar
|
|
121
|
+
would not show:
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
phx.frontend.updates.DomainEntityModification({
|
|
125
|
+
entityId: oldPlate.id,
|
|
126
|
+
stateDelta: { finish: validMaterial.finish },
|
|
127
|
+
updateTag: 'fix.finish',
|
|
128
|
+
hint: msg`Material finish was adjusted`,
|
|
129
|
+
agentHint: `The finish of ${oldPlate.id} was changed to ${validMaterial.finish}, the only one this material comes in.`,
|
|
130
|
+
})
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
- `agentHint` is a plain string, never shown to the user and not localized.
|
|
134
|
+
- `agentHint: null` keeps the wording from the assistant while the user still gets the `hint`: the
|
|
135
|
+
update is left out of `sideEffects`, and the change record explains its line by the `updateTag`. It
|
|
136
|
+
does not hide the change itself, which the assistant can always read from the configuration.
|
|
137
|
+
- `agentHint` without a `hint` tells only the assistant.
|
|
138
|
+
|
|
105
139
|
## Example
|
|
106
140
|
|
|
107
141
|
Here you can see the live example!
|
|
@@ -102,7 +102,7 @@ export const removeExtraneousBranchesAndLeavesWhenShortened = phx.frontend.trans
|
|
|
102
102
|
- With `overrideMatchinUpdates(ctx => /* side effect updates */)` the updates returned by the provided callback will replace the original **matched update**. This will be triggered for every matching update. Note that this action is not available in events which are not bound to a specific update - such as a violation check without a defined cause.
|
|
103
103
|
- With `overrideAllUpdates(ctx => /* side effect updates */)` the updates returned by the provided callback will replace all original updates. This will be triggered only once for a single run of the transformer. This allows for implementation of transformers that behave similarly as the raw `UpdateTransformer`
|
|
104
104
|
- High-level actions: `select`, `deselect`, `navigate`, `changeView` - more on these in the other examples.
|
|
105
|
-
- `build(name)` is the final step to create the transformer.
|
|
105
|
+
- `build(name)` is the final step to create the transformer. The name identifies the transformer while tracing, and it is the name the `transformers` section of the spec refers to, so it must match the file name with case and dashes ignored (`fix-finish.ts` and `fixFinish` match). Note that this returns a `RegistrableTransformer`. Default-export it from a file in `src/transformers/` and list the name passed to `build(...)` in the `transformers` section of the spec; the generated code registers it. The shorter snippets on this page use descriptive names for readability; the complete implementation below uses names that match its files.
|
|
106
106
|
|
|
107
107
|
### Side-Effect on Update Causing Another Entity's Violation
|
|
108
108
|
|
|
@@ -427,43 +427,28 @@ For technical details about data transformation and storage, see [Data Sources -
|
|
|
427
427
|
|
|
428
428
|
## Web Component Integration
|
|
429
429
|
|
|
430
|
-
Admin functionality
|
|
430
|
+
Admin functionality is part of the same application as the configurator and needs no separate web component setup.
|
|
431
431
|
|
|
432
|
-
###
|
|
432
|
+
### Registering Admin Components
|
|
433
433
|
|
|
434
|
-
|
|
434
|
+
The frontend entry is generated into `.phoenix/`, so a project never calls the configurator builder itself. Every file
|
|
435
|
+
in `src/admin/components/` is picked up by its location and its default export is registered as admin components:
|
|
435
436
|
|
|
436
437
|
```typescript
|
|
437
438
|
// src/admin/components/admin-components.tsx
|
|
438
|
-
|
|
439
|
-
import { customAdminOptics } from './optics.js'
|
|
440
|
-
import { NotAuthenticatedPage } from '../pages/NotAuthenticatedPage.js'
|
|
441
|
-
|
|
442
|
-
const config = configuratorBuilder
|
|
443
|
-
.withComponentOptics(customConfiguratorComponents)
|
|
444
|
-
.withAdminComponentOptics(customAdminOptics) // Register admin components
|
|
445
|
-
.buildConfig({
|
|
446
|
-
deploymentId: phx.runtimeConfig.DEPLOYMENT_ID,
|
|
447
|
-
persistence: {
|
|
448
|
-
type: 'server',
|
|
449
|
-
serverUrl: phx.runtimeConfig.SERVER_URL,
|
|
450
|
-
},
|
|
451
|
-
ui: {
|
|
452
|
-
notAuthenticatedPage: <NotAuthenticatedPage />, // Show when user not authenticated
|
|
453
|
-
},
|
|
454
|
-
// ... other config
|
|
455
|
-
})
|
|
439
|
+
// ... customAdminOptics as defined in the example above
|
|
456
440
|
|
|
457
|
-
|
|
441
|
+
export default customAdminOptics
|
|
458
442
|
```
|
|
459
443
|
|
|
460
|
-
|
|
444
|
+
The page shown to a user who is not authenticated is an element. Create it with
|
|
445
|
+
`phx.frontend.createNotAuthenticatedPage(...)` in a file under `src/elements/`.
|
|
461
446
|
|
|
462
447
|
### Built-in Admin Integration
|
|
463
448
|
|
|
464
449
|
Phoenix automatically provides admin functionality when:
|
|
465
450
|
|
|
466
|
-
1. Admin components are
|
|
451
|
+
1. Admin components are default-exported from files in `src/admin/components/`
|
|
467
452
|
2. Admin configuration exists in `phoenix.config.ts`
|
|
468
453
|
3. User has admin session token
|
|
469
454
|
|
|
@@ -116,28 +116,9 @@ After running `pnpm lingui:compile`, your custom translations will override the
|
|
|
116
116
|
- Adapt translations for your target audience
|
|
117
117
|
- Maintain consistency with your existing product language
|
|
118
118
|
|
|
119
|
-
**Frontend integration**:
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
import { configuratorBuilder } from 'project-domain'
|
|
123
|
-
import { createI18n } from 'project-i18n'
|
|
124
|
-
|
|
125
|
-
const i18n = createI18n()
|
|
126
|
-
|
|
127
|
-
export const config = configuratorBuilder
|
|
128
|
-
.withComponentOptics(customComponents)
|
|
129
|
-
.withPresets(presets)
|
|
130
|
-
.withI18n(i18n) // Register i18n service with configurator
|
|
131
|
-
.buildConfig({
|
|
132
|
-
features: {
|
|
133
|
-
availableLocales: ['en', 'de', 'cs'],
|
|
134
|
-
},
|
|
135
|
-
services: {
|
|
136
|
-
logger,
|
|
137
|
-
},
|
|
138
|
-
// ... other configuration
|
|
139
|
-
})
|
|
140
|
-
```
|
|
119
|
+
**Frontend integration**: the generated `.phoenix` code creates the i18n service from `.phoenix/i18n.ts` and registers
|
|
120
|
+
it with the application, so there is nothing to wire by hand. The languages come from `availableLocales` in
|
|
121
|
+
`spec/application.yaml`.
|
|
141
122
|
|
|
142
123
|
## Working with YAML Domain Specifications
|
|
143
124
|
|
|
@@ -491,6 +491,85 @@ phoenix screenshot -o preview.png -w 1920 --height 1080
|
|
|
491
491
|
| `--height` | `1080` | Image height in pixels |
|
|
492
492
|
| `--format` / `-f` | `png` | Image format (`png` or `jpeg`) |
|
|
493
493
|
|
|
494
|
+
### `phoenix variants`
|
|
495
|
+
|
|
496
|
+
Show several options over the configurator and wait for your pick. It is built for coding agents: when a decision is a matter of taste, such as the edge of a table top, how glossy a finish is or where a control sits, the agent writes one file per option, you choose in the browser, and the command hands your answer back to the agent.
|
|
497
|
+
|
|
498
|
+
```bash
|
|
499
|
+
phoenix variants .phoenix/variants/table-edge --title 'Which edge suits the table?' --description 'Only the edge of the top differs.'
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
Every `<id>.variant.js` script or `<id>.html` page in the folder is one option, shown in file-name order. Each script edits frontend project files on top of the same captured baseline. Original is always the first choice and restores that baseline. Switching options removes the previous option's edits and applies the selected script; the editor dialog has any number of choices on the left and your already loaded configurator on the right.
|
|
503
|
+
|
|
504
|
+
```js
|
|
505
|
+
// .phoenix/variants/brand/blue.variant.js
|
|
506
|
+
export const title = 'Blue brand'
|
|
507
|
+
export const description = 'A blue primary colour with the current layout.'
|
|
508
|
+
|
|
509
|
+
export default ({ read, write, remove }) => {
|
|
510
|
+
const file = 'src/handlers/theme.ts'
|
|
511
|
+
write(file, read(file).replace("main: '#E93335'", "main: '#2364aa'"))
|
|
512
|
+
}
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
`read(path)` always reads the baseline. `write(path, contents)` replaces or creates a file; `remove(path)` deletes it. Scripts run in the browser and collect edits; Phoenix validates and writes the batch locally. Supported files are YAML under `spec/` outside `spec/admin/`, and TypeScript under `src/components`, `transformers`, `handlers`, `elements` and `_`-prefixed shared folders. Expressions, actions and invariants also run on the server, so a script cannot edit them.
|
|
516
|
+
|
|
517
|
+
For standalone UI or branding proposals, write self-contained HTML files. Each page renders in its own iframe when selected; its `<title>` names the option and `<meta name="description" content="...">` describes it. HTML and scripts may share a set if their file names give distinct option ids.
|
|
518
|
+
|
|
519
|
+
```html
|
|
520
|
+
<!-- .phoenix/variants/brand/blue.html -->
|
|
521
|
+
<!doctype html>
|
|
522
|
+
<title>Blue studio</title>
|
|
523
|
+
<meta name="description" content="A calm blue identity with generous spacing." />
|
|
524
|
+
<style>
|
|
525
|
+
body {
|
|
526
|
+
margin: 0;
|
|
527
|
+
padding: 40px;
|
|
528
|
+
background: #f0f5fa;
|
|
529
|
+
color: #163b66;
|
|
530
|
+
font-family: sans-serif;
|
|
531
|
+
}
|
|
532
|
+
</style>
|
|
533
|
+
<h1>Made for your everyday.</h1>
|
|
534
|
+
<button>Design your table</button>
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
Scripts run once per selection. The completed file batch calls the existing rebuild queue directly, without a separate file-change event stream or a watcher that reapplies the option.
|
|
538
|
+
|
|
539
|
+
Use script options for controls, layout, brand, lights, visual effects, materials, positions, components, elements and transformers. Changes to the model, schemas, data or deployment settings are rejected before any files are written. Environment files, webhooks, their shared implementation dependencies, dependencies and uploaded assets cannot be overridden. Files connected through symbolic links are also excluded, so restoring the baseline preserves the original files. No server preparation or webhook rebuild runs for a variant transaction.
|
|
540
|
+
|
|
541
|
+
Picking a script keeps its exact implementation in the project. Picking an HTML page returns the selected proposal for the agent to implement; the page itself changes no project source files. Choosing Original keeps the captured baseline. Users finish by confirming Original or another option. Escape stays available to the configurator, and clicking the backdrop leaves the comparison open. The agent can use `--close` to restore the baseline source files without giving an answer. Phoenix records recovery information on disk and restores interrupted previews at the next `phoenix dev` start. It never overwrites a file edited outside the preview: switching options over such an edit is refused, and when the comparison ends, or is restored at the next start, that file is left as it is with a warning in the dev log while the others are restored. Other source changes made while a comparison is open are rebuilt once it ends.
|
|
542
|
+
|
|
543
|
+
Answers are held for four seconds with Undo and Send now.
|
|
544
|
+
|
|
545
|
+
The command prints the outcome as JSON. After `chosen` it removes the folder:
|
|
546
|
+
|
|
547
|
+
| `status` | Meaning |
|
|
548
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
549
|
+
| `chosen` | An option was picked: `choice` is its id, or `null` for Original; `label` is its name. |
|
|
550
|
+
| `waiting` | The wait ran out. The preview stays open: the same command attaches to it again, and an answer given in between is returned by the next run. |
|
|
551
|
+
| `closed` | The preview was closed without an answer, by `--close` or by another set of options taking its place. The folder is kept. |
|
|
552
|
+
|
|
553
|
+
| Flag | Default | Description |
|
|
554
|
+
| ---------------------- | ----------------------------- | --------------------------------------------------------- |
|
|
555
|
+
| `--title` / `-t` | `Which option do you prefer?` | Question shown above the options |
|
|
556
|
+
| `--description` / `-d` | — | A line saying what differs between the options |
|
|
557
|
+
| `--timeout` | `540` | Seconds to wait for the answer |
|
|
558
|
+
| `--keep` | `false` | Keep the folder after the answer |
|
|
559
|
+
| `--close` | `false` | Close the open preview without an answer; needs no folder |
|
|
560
|
+
| `--port` / `-p` | `3020` | Editor WebSocket port |
|
|
561
|
+
|
|
562
|
+
Known limits:
|
|
563
|
+
|
|
564
|
+
- Variant transactions start rebuilding immediately, bypassing the normal file-watcher debounce. Hot reload still needs to parse and apply the updated implementation. There is no wait for UI or scene loading to settle; allow a visible transition to finish before judging or choosing.
|
|
565
|
+
- Only one option is displayed at a time; simultaneous comparison is not supported.
|
|
566
|
+
- For script options and Original, the dialog moves the existing configurator into the preview and returns it on close, preserving the loaded scene, camera and UI state. Opening the dialog starts no second application or initial loading screen. Configuration interactions still change the current configuration; restoring source files does not undo them.
|
|
567
|
+
- Custom scripts are trusted project code. Their file API stages edits; scripts must not make network requests or other side effects.
|
|
568
|
+
- Binary assets, CSS files, locale catalog changes, dependency changes and edits requiring a full application restart are unsupported.
|
|
569
|
+
- Storybook `story-dev` has no variant previews. A project on the legacy pipeline has no variant previews; the command says so and exits.
|
|
570
|
+
|
|
571
|
+
Generated projects carry the `phoenix-variants` agent skill, which tells coding agents when to offer options, how to write each kind and what to do with your answer.
|
|
572
|
+
|
|
494
573
|
## SDK Development
|
|
495
574
|
|
|
496
575
|
### `phoenix link`
|
|
@@ -603,7 +682,7 @@ SDK-builder workspaces sign the CLI in with a personal API token instead of proj
|
|
|
603
682
|
|
|
604
683
|
Signs the CLI in to the SDK-builder workspace `<customer>`:
|
|
605
684
|
|
|
606
|
-
1. Opens Studio, where you name the token and approve the sign-in (use `--no-open` to only print the link). The page shows the workspace, your account, the computer the CLI runs on and how long the link still works. The CLI suggests the name `phoenix CLI on <computer>`; change it so you can tell your machines and agents apart later.
|
|
685
|
+
1. Opens Studio, where you name the token and approve the sign-in (use `--no-open` to only print the link). Only a super admin of the workspace can open its Studio, so only a super admin can sign the CLI in. The page shows the workspace, your account, the computer the CLI runs on and how long the link still works. The CLI suggests the name `phoenix CLI on <computer>`; change it so you can tell your machines and agents apart later.
|
|
607
686
|
2. Studio sends a one-time code back to the CLI on `127.0.0.1`.
|
|
608
687
|
3. The CLI exchanges the code for a token with the name you approved, and sends the browser back to Studio, which confirms the sign-in.
|
|
609
688
|
|
|
@@ -628,7 +707,7 @@ Revokes the token on the server and removes it from the credentials file. `--reg
|
|
|
628
707
|
|
|
629
708
|
### `phoenix deploy`
|
|
630
709
|
|
|
631
|
-
Validates the spec, adds the pnpm settings `phoenix init` writes to `pnpm-workspace.yaml` when they are missing, packs and uploads the project, starts its build on the server and follows it until the configurator is live. Before the upload the server compares the domain model with the deployed one: a model that changed under an already deployed model version is refused with the reason, and needs a new model version and a [migration](?path=/docs/phoenix-migrations--docs). Once the build starts it prints `Follow the build in Studio: <url>`, the build's page in the Studio you signed in through; a sign-in stored by an older CLI has no Studio URL, so sign in again to get the link. `--region` or `--serverUrl` selects the server, as for `login`; `--no-wait` returns as soon as the build starts.
|
|
710
|
+
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.
|
|
632
711
|
|
|
633
712
|
### `phoenix feedback [message]`
|
|
634
713
|
|
|
@@ -49,6 +49,12 @@ project-root/
|
|
|
49
49
|
| `locales/` | Locale catalogs (`.po` sources; compiled `.ts`, do not edit) |
|
|
50
50
|
| `_*` | Shared code folders at any depth (not auto-imported) |
|
|
51
51
|
|
|
52
|
+
Every file in `components/`, `elements/`, `expressions/`, `actions/`, `invariants/`, `transformers/` and `handlers/`
|
|
53
|
+
(and their `admin/` counterparts) is imported by its location, so its default export must be what that folder's `phx`
|
|
54
|
+
factory returns, or an array of those. A file that exports anything else, such as a plain React component in
|
|
55
|
+
`elements/`, stops the application at start with an `Invalid default export in <file>` error that names the expected
|
|
56
|
+
shape. Keep plain components and helpers in a `_*` folder.
|
|
57
|
+
|
|
52
58
|
### Admin Folders (src/admin/)
|
|
53
59
|
|
|
54
60
|
The `admin/` folder supports these admin-specific categories:
|
|
@@ -189,7 +195,7 @@ type CustomMaterial = Phx['AdminModel']['CustomMaterial']
|
|
|
189
195
|
|
|
190
196
|
### DO NOT EDIT (Fully Auto-Generated)
|
|
191
197
|
|
|
192
|
-
- **Everything in `.phoenix/`** - Completely regenerated on each build
|
|
198
|
+
- **Everything in `.phoenix/`** - Completely regenerated on each build. The one exception is `.phoenix/variants/`, where a coding agent writes the option files for `phoenix variants`; a rebuild keeps it
|
|
193
199
|
- `tsconfig.json`, `eslint.config.js`, `prettier.config.js`, `.prettierignore`
|
|
194
200
|
- `.linguirc`, `.nvmrc`
|
|
195
201
|
- `src/locales/**/*.ts` - Compiled from `.po` catalogs
|
|
@@ -198,7 +204,7 @@ type CustomMaterial = Phx['AdminModel']['CustomMaterial']
|
|
|
198
204
|
|
|
199
205
|
### Agent Guidance
|
|
200
206
|
|
|
201
|
-
Coding agents (Claude Code, Codex, Cursor) read `AGENTS.md` and the Phoenix agent skills. `AGENTS.md` is written once with the build commands, the do-not-edit list and a pointer to the skills; after that it is yours. 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. 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.
|
|
207
|
+
Coding agents (Claude Code, Codex, Cursor) read `AGENTS.md` and the Phoenix agent skills. `AGENTS.md` is written once with the build commands, the do-not-edit list and a pointer to the skills; after that it is yours. 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.
|
|
202
208
|
|
|
203
209
|
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`.
|
|
204
210
|
|
|
@@ -316,6 +322,7 @@ project-root/
|
|
|
316
322
|
│ │ └── builders.ts
|
|
317
323
|
│ ├── .swc/ # SWC transpiled sources
|
|
318
324
|
│ ├── .lingui/ # Compiled i18n catalogs
|
|
325
|
+
│ ├── variants/ # Option files of `phoenix variants`, written by coding agents
|
|
319
326
|
│ ├── dist/ # Build output
|
|
320
327
|
│ │ ├── frontend/ # Frontend bundles
|
|
321
328
|
│ │ └── webhooks/ # Webhook bundles
|
|
@@ -36,7 +36,7 @@ The starter `spec/application.yaml` begins with `project: default`, which means
|
|
|
36
36
|
pnpm phoenix login <workspace>
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
`phoenix login` opens Studio, where you name the token and approve the sign-in. The CLI suggests `phoenix CLI on <computer>`; a name of your own, such as the agent and the machine, tells your tokens apart later. Studio sends a one-time code back to the CLI on `127.0.0.1`, the CLI exchanges it for a personal token and returns the browser to Studio, which confirms the sign-in. The code only works for the CLI that asked for it and expires after five minutes. **Deny** stops the waiting CLI at once and creates no token. Use `--no-open` to print the link instead of opening a browser.
|
|
39
|
+
`phoenix login` opens Studio, where you name the token and approve the sign-in. Only a super admin of the workspace can open Studio, so only a super admin can approve it. The CLI suggests `phoenix CLI on <computer>`; a name of your own, such as the agent and the machine, tells your tokens apart later. Studio sends a one-time code back to the CLI on `127.0.0.1`, the CLI exchanges it for a personal token and returns the browser to Studio, which confirms the sign-in. The code only works for the CLI that asked for it and expires after five minutes. **Deny** stops the waiting CLI at once and creates no token. Use `--no-open` to print the link instead of opening a browser.
|
|
40
40
|
|
|
41
41
|
The CLI stores the token in `~/.phoenix/credentials.json`, readable only by you, with one entry per server. `PHOENIX_CREDENTIALS_FILE` moves the file. The token acts for you in your workspace until you revoke it. It stops working when you are removed from the workspace or banned.
|
|
42
42
|
|
|
@@ -59,7 +59,7 @@ pnpm phoenix dev
|
|
|
59
59
|
|
|
60
60
|
Signed in, `phoenix dev` needs no `.env` and nothing set up in Studio. When it starts, it asks the server for your development environment in the project the spec names. The server creates that environment the first time and finds it again on every later run. `phoenix dev` prints the workspace, project and environment it works in, prepares a development deployment there and opens the webhook tunnel, as for any Phoenix project (see [Phoenix CLI](?path=/docs/phoenix-phoenix-cli--docs)). It then prints the address of the preview as `Preview: <url>`; the preview talks to the server the deployment was prepared on.
|
|
61
61
|
|
|
62
|
-
Every user
|
|
62
|
+
Every user who signs the CLI in gets their own development environment, so a teammate (a super admin of the workspace, like you) who clones the project and signs in doesn't overwrite your schema or take over your webhooks. The development environment is separate from `production`: nothing you do in `phoenix dev` changes the live configurator.
|
|
63
63
|
|
|
64
64
|
`pnpm dev:local` still runs the project without any server, with state kept in the browser.
|
|
65
65
|
|
|
@@ -107,4 +107,5 @@ Coding agents working in your project use the same command, guided by the genera
|
|
|
107
107
|
- `phoenix deploy` always deploys to the workspace's default project; it doesn't read `project` from the spec yet.
|
|
108
108
|
- Only `phoenix dev` works from the sign-in. `phoenix deployment:prepare-dev` still needs the `.env` block of a Studio development environment.
|
|
109
109
|
- Every deploy uploads the whole project; there are no incremental uploads.
|
|
110
|
-
- Your own environment variables can't use platform names such as `LAMBDA_FUNCTION_NAME
|
|
110
|
+
- Your own environment variables are set in Studio under Environment, by a super admin of the workspace, and apply from the next deploy. `phoenix dev` doesn't receive them: your development environment has its own variables. A build reads them from `process.env`; a webhook reads the ones the spec declares under `env.webhook`, through `phx.webhooksEnv` (see [Webhooks](?path=/docs/phoenix-webhooks--docs)). They can't use platform names such as `LAMBDA_FUNCTION_NAME`, the `AWS_` prefix, the identity provider settings such as `CLERK_API_KEY`, or names the CLI and the deploy tooling read themselves, such as `SERVER_URL` or `NODE_OPTIONS`; Studio refuses those names.
|
|
111
|
+
- Only super admins of a workspace can open its Studio. Admins and users see a page that says so.
|
|
@@ -160,21 +160,23 @@ Room: {
|
|
|
160
160
|
|
|
161
161
|
### Entity Replacement Transformer
|
|
162
162
|
|
|
163
|
-
|
|
163
|
+
Add a transformer to handle entity deselection when replacement occurs. This ensures clean state transitions:
|
|
164
164
|
|
|
165
165
|
```typescript
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
166
|
+
// src/transformers/deselect-special.ts
|
|
167
|
+
export default phx.frontend.transformerBuilder.when
|
|
168
|
+
.entity(['RedSpecialConsole', 'BlueSpecialConsole'])
|
|
169
|
+
.replacedWith(['RedSpecialConsole', 'BlueSpecialConsole'])
|
|
170
|
+
.then.deselect()
|
|
171
|
+
.build('deselect-special')
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Each file in `src/transformers/` default-exports one transformer and is picked up by its location. The `transformers` section of the spec turns it on by name. For a transformer made with `build(name)` that is the name passed to `build(...)`, which must match the file name with case and dashes ignored (`fix-finish.ts` and `fixFinish` match). For a plain-function export it is the file name:
|
|
175
|
+
|
|
176
|
+
```yaml
|
|
177
|
+
# spec/application.yaml
|
|
178
|
+
transformers:
|
|
179
|
+
- name: deselect-special
|
|
178
180
|
```
|
|
179
181
|
|
|
180
182
|
### Initial Configuration
|
|
@@ -69,8 +69,19 @@ relations:
|
|
|
69
69
|
|
|
70
70
|
Consider enabling select-parent-on-deselection to keep selection stable:
|
|
71
71
|
|
|
72
|
-
```
|
|
73
|
-
.
|
|
72
|
+
```typescript
|
|
73
|
+
// src/transformers/select-parent.ts
|
|
74
|
+
import { createSelectParentOnDeselectionTransformer } from '@salsita-ai/sdk/domain'
|
|
75
|
+
|
|
76
|
+
export default createSelectParentOnDeselectionTransformer
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Each file in `src/transformers/` default-exports one transformer and is picked up by its location. The `transformers` section of the spec turns it on by name. For a transformer made with `build(name)` that is the name passed to `build(...)`, which must match the file name with case and dashes ignored (`fix-finish.ts` and `fixFinish` match). For a plain-function export it is the file name:
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
# spec/application.yaml
|
|
83
|
+
transformers:
|
|
84
|
+
- name: select-parent
|
|
74
85
|
```
|
|
75
86
|
|
|
76
87
|
## Example
|
|
@@ -4,7 +4,8 @@ import type { $DomainEntity, DomainEntity } from '../core/model.js';
|
|
|
4
4
|
* Creates the `implementActions` factory the generated `domain-spec.ts` exposes as
|
|
5
5
|
* `phx.domain.implementActions`. A module in `src/actions/` implements any subset of the declared
|
|
6
6
|
* actions and gets each parameter and result typed from the spec; a name the spec does not declare
|
|
7
|
-
* is a type error, since its implementation would have to be `never`. The generated barrel
|
|
8
|
-
* the modules
|
|
7
|
+
* is a type error, since its implementation would have to be `never`. The generated barrel lists
|
|
8
|
+
* the modules; `DomainBuilder.withActionModules` merges them, and domain initialization checks that
|
|
9
|
+
* every declared action is implemented.
|
|
9
10
|
*/
|
|
10
11
|
export declare const createActionFactory: <ENTITIES extends DomainEntity<string>, ALLOWED_ROOT_ENTITIES extends ENTITIES, $MAP extends Record<ENTITIES['type'], $DomainEntity<ENTITIES>>, PUBLISHED_DATA extends Record<string, unknown>, SESSION_DATA extends Record<string, unknown>, FRONTEND_DATA extends Record<string, unknown>, NAVIGATION_STATES extends string, VIEW_STATES extends string, TOOL_STATES extends string, EXPORT_STATES extends string, ACTION_TYPES extends ActionTypes>() => <IMPLEMENTATIONS extends Partial<ActionImplementations<ENTITIES, ALLOWED_ROOT_ENTITIES, $MAP, PUBLISHED_DATA, SESSION_DATA, FRONTEND_DATA, NAVIGATION_STATES, VIEW_STATES, TOOL_STATES, EXPORT_STATES, ACTION_TYPES>>>(implementations: IMPLEMENTATIONS & Readonly<Record<Exclude<keyof IMPLEMENTATIONS, keyof ACTION_TYPES>, never>>) => IMPLEMENTATIONS;
|
|
@@ -6,12 +6,11 @@ import type { Logger } from '@salsita-ai/common/utils';
|
|
|
6
6
|
import type { SessionRole, SessionTokenPayload } from '@salsita-ai/contracts/api';
|
|
7
7
|
import type { CellValue } from '@salsita-ai/contracts/webhook';
|
|
8
8
|
import type { AdminIntegrationService } from '#package/react-sdk';
|
|
9
|
-
import type {
|
|
10
|
-
import type {
|
|
11
|
-
import type { AnalyticsSystem, DomainContextSystems, TransformerFactory, Transformers } from '../domain-context/index.js';
|
|
9
|
+
import type { $DomainEntity, DomainEntity, DomainFactory, ProductPreset } from '../core/index.js';
|
|
10
|
+
import type { AnalyticsSystem, TransformerFactory } from '../domain-context/index.js';
|
|
12
11
|
import type { RegistrableTransformer } from '../domain-context/transformers/index.js';
|
|
13
|
-
import type {
|
|
14
|
-
import type {
|
|
12
|
+
import type { ProjectModule } from '../project-modules/index.js';
|
|
13
|
+
import type { AssistantResolvedManifest } from './assistant/index.js';
|
|
15
14
|
import type { WebComponentEventDescriptor } from './web-component-event.js';
|
|
16
15
|
import type { WebComponentPropertyDescriptor } from './web-component-property.js';
|
|
17
16
|
export type ImportedTransformer<ENTITIES extends DomainEntity<string>, ALLOWED_ROOT_ENTITIES extends ENTITIES, $MAP extends Record<ENTITIES['type'], $DomainEntity<ENTITIES>>, NAVIGATION_STATES extends string, VIEW_STATES extends string, TOOL_STATES extends string, EXPORT_STATES extends string> = {
|
|
@@ -22,6 +21,17 @@ export type SpecTransformer = {
|
|
|
22
21
|
name: string;
|
|
23
22
|
priority?: number;
|
|
24
23
|
};
|
|
24
|
+
/**
|
|
25
|
+
* The transformers of an application: the `src/transformers/` files as project modules, and the spec's
|
|
26
|
+
* `transformers` section, which selects them by name and orders them by priority. A plain-function
|
|
27
|
+
* export is selected by its file name; a transformer made with `build(name)` by that name, which the spec
|
|
28
|
+
* parser requires to match the file name with case and dashes ignored. The runtime spec resolves the two
|
|
29
|
+
* into the factory the store system calls on every update.
|
|
30
|
+
*/
|
|
31
|
+
export interface TransformersConfig {
|
|
32
|
+
readonly importedTransformers: readonly ProjectModule[];
|
|
33
|
+
readonly specTransformers: readonly SpecTransformer[];
|
|
34
|
+
}
|
|
25
35
|
export interface DataSchemaPrimitiveField {
|
|
26
36
|
readonly type: 'string' | 'number' | 'integer' | 'boolean';
|
|
27
37
|
readonly enum?: ReadonlyArray<string | number>;
|
|
@@ -64,67 +74,6 @@ export type DataSpec = {
|
|
|
64
74
|
export type ChunksSpec = Readonly<Record<string, {
|
|
65
75
|
readonly scope: string;
|
|
66
76
|
}>>;
|
|
67
|
-
/**
|
|
68
|
-
* Where one exposed assistant GraphQL field reads its value on the `$` entity: a stored field name,
|
|
69
|
-
* or an expression name including its `$`. `localized` marks a localizable value that resolves to a
|
|
70
|
-
* string in the current locale.
|
|
71
|
-
*/
|
|
72
|
-
export interface AssistantFieldSource {
|
|
73
|
-
readonly source: string;
|
|
74
|
-
readonly localized?: true;
|
|
75
|
-
}
|
|
76
|
-
/**
|
|
77
|
-
* One recipe group the assistant manifest exposes on an entity type: a `childEntityRecipes` instance
|
|
78
|
-
* under `childRecipes`, a `replaceEntityRecipes` instance under `replaceRecipes`. `groupId` is the
|
|
79
|
-
* name the agent addresses the group by, `instanceName` the component instance it reads,
|
|
80
|
-
* `description` the manifest's text replacing the component's group description, and `dryRuns`
|
|
81
|
-
* whether the recipes of the group can be dry-run.
|
|
82
|
-
*/
|
|
83
|
-
export interface AssistantRecipeGroup {
|
|
84
|
-
readonly groupId: string;
|
|
85
|
-
readonly instanceName: string;
|
|
86
|
-
readonly description?: string;
|
|
87
|
-
readonly dryRuns: boolean;
|
|
88
|
-
}
|
|
89
|
-
/**
|
|
90
|
-
* The options edge of one writable field the assistant manifest links to its component. `field` is
|
|
91
|
-
* the delta field of `modify<Type>` the choices are for, `edgeName` the field of `<Type>Meta` that
|
|
92
|
-
* lists them, `componentType` and `instanceName` the component instance they are read from, and
|
|
93
|
-
* `validate` whether `modify<Type>` rejects a value that is not among them, and `dryRuns` whether
|
|
94
|
-
* the choices can be dry-run.
|
|
95
|
-
*/
|
|
96
|
-
export interface AssistantFieldOptions {
|
|
97
|
-
readonly field: string;
|
|
98
|
-
readonly edgeName: string;
|
|
99
|
-
readonly componentType: 'materialSwatch' | 'attributeSelection' | 'distanceDimensionSelect';
|
|
100
|
-
readonly instanceName: string;
|
|
101
|
-
readonly validate: boolean;
|
|
102
|
-
readonly dryRuns: boolean;
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* Experimental assistant manifest generated from the application spec `assistant` section. `sdl` is
|
|
106
|
-
* the GraphQL schema text prepared at parse time; `fields` maps each GraphQL object type's exposed
|
|
107
|
-
* fields (type name → GraphQL field name) to the stored field or expression its resolvers read;
|
|
108
|
-
* `deletableTypes` lists the entity types the `deleteEntity` mutation may delete, with aliases
|
|
109
|
-
* already expanded, and absent means none; `writableFields` maps, per entity type with a
|
|
110
|
-
* `modify<Type>` mutation, each field of its delta input to the stored property it writes, and
|
|
111
|
-
* absent means no entity type is writable; `childRecipes` lists, per entity type with a `meta` field,
|
|
112
|
-
* the recipe groups `meta { childRecipes }` and `addChild` expose, in manifest order, and absent
|
|
113
|
-
* means none; `replaceRecipes` lists the same for `meta { replaceRecipes }` and `replaceEntity`;
|
|
114
|
-
* `fieldOptions` lists, per entity type, the options edges `meta` exposes for its
|
|
115
|
-
* writable fields, and absent means none; `actions` maps each custom `Mutation` field to the
|
|
116
|
-
* declared action it runs, and absent means none. Consumed by the configurator GraphQL system.
|
|
117
|
-
*/
|
|
118
|
-
export interface AssistantManifest {
|
|
119
|
-
readonly sdl: string;
|
|
120
|
-
readonly fields: Readonly<Record<string, Readonly<Record<string, AssistantFieldSource>>>>;
|
|
121
|
-
readonly deletableTypes?: readonly string[];
|
|
122
|
-
readonly writableFields?: Readonly<Record<string, Readonly<Record<string, string>>>>;
|
|
123
|
-
readonly childRecipes?: Readonly<Record<string, readonly AssistantRecipeGroup[]>>;
|
|
124
|
-
readonly replaceRecipes?: Readonly<Record<string, readonly AssistantRecipeGroup[]>>;
|
|
125
|
-
readonly fieldOptions?: Readonly<Record<string, readonly AssistantFieldOptions[]>>;
|
|
126
|
-
readonly actions?: Readonly<Record<string, string>>;
|
|
127
|
-
}
|
|
128
77
|
export type AdminPagesSpec = {
|
|
129
78
|
readonly presets?: boolean | {
|
|
130
79
|
readonly categoryNavigationState?: string;
|
|
@@ -171,9 +120,11 @@ export interface DomainConfig<ENTITIES extends DomainEntity<string>, ALLOWED_ROO
|
|
|
171
120
|
*/
|
|
172
121
|
readonly domainFactory: DomainFactory<ENTITIES, ALLOWED_ROOT_ENTITIES, $MAP, PUBLISHED_DATA, SESSION_DATA, FRONTEND_DATA>;
|
|
173
122
|
/**
|
|
174
|
-
* Components attached to the domain used for the Application to work
|
|
123
|
+
* Components attached to the domain used for the Application to work, as project modules: the
|
|
124
|
+
* `src/components/` files and the optics a generated file lists. The runtime spec validates and
|
|
125
|
+
* flattens them.
|
|
175
126
|
*/
|
|
176
|
-
readonly componentOptics:
|
|
127
|
+
readonly componentOptics: readonly ProjectModule[];
|
|
177
128
|
/**
|
|
178
129
|
* List of languages that the user will be able to provide in multi-lingual text fields in the Admin UI
|
|
179
130
|
*/
|
|
@@ -352,15 +303,14 @@ export interface ApplicationConfig<ENTITIES extends DomainEntity<string>, ALLOWE
|
|
|
352
303
|
readonly chunks?: ChunksSpec;
|
|
353
304
|
readonly dataSpec?: DataSpec;
|
|
354
305
|
readonly publishedDataHash?: string;
|
|
355
|
-
readonly assistant?:
|
|
356
|
-
/**
|
|
357
|
-
|
|
358
|
-
*/
|
|
359
|
-
readonly createTransformers?: (ctx: DomainContextSystems<ENTITIES, ALLOWED_ROOT_ENTITIES, $MAP, NAVIGATION_STATES, VIEW_STATES, TOOL_STATES, EXPORT_STATES>) => Transformers<ENTITIES>;
|
|
306
|
+
readonly assistant?: AssistantResolvedManifest | null;
|
|
307
|
+
/** The project's transformers; the runtime spec validates the files and builds the store's transformer factory from them. */
|
|
308
|
+
readonly transformers?: TransformersConfig;
|
|
360
309
|
readonly adminNavigation?: AdminNavigationConfig<ADMIN_NAVIGATION_STATES, ADMIN_VIEW_STATES> | undefined;
|
|
361
310
|
readonly adminDomain: DomainConfig<ADMIN_ENTITIES, ADMIN_ALLOWED_ROOT_ENTITIES, ADMIN_$MAP, PUBLISHED_DATA, SESSION_DATA, FRONTEND_DATA>;
|
|
362
|
-
|
|
363
|
-
readonly
|
|
311
|
+
/** The `src/handlers/` and `src/elements/` files as project modules; the runtime spec validates and flattens both. */
|
|
312
|
+
readonly handlers: readonly ProjectModule[];
|
|
313
|
+
readonly elements: readonly ProjectModule[];
|
|
364
314
|
readonly mount: MountConfig<ENTITIES, ALLOWED_ROOT_ENTITIES, $MAP, NAVIGATION_STATES, VIEW_STATES, TOOL_STATES, EXPORT_STATES, CHAT_CONTEXT, PUBLISHED_DATA, SESSION_DATA, FRONTEND_DATA, ADMIN_ENTITIES, ADMIN_ALLOWED_ROOT_ENTITIES, ADMIN_$MAP, ADMIN_NAVIGATION_STATES, ADMIN_VIEW_STATES>;
|
|
365
315
|
}
|
|
366
316
|
export {};
|