@salsita-ai/sdk 0.50.0-develop.be40f0cee8 → 0.50.0-develop.d81d7591c5
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/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.js +1 -1
- package/dist/configurator/ui/assistant/AssistantComposer.d.ts +1 -6
- package/dist/configurator/ui/assistant/AssistantComposer.js +1 -1
- package/dist/configurator/ui/assistant/AssistantPanel.js +1 -1
- package/dist/configurator/ui/assistant/AssistantThread.d.ts +1 -6
- package/dist/configurator/ui/assistant/AssistantThread.js +1 -1
- package/dist/configurator/ui/assistant/index.d.ts +1 -1
- package/dist/configurator/ui/assistant/index.js +1 -1
- package/dist/configurator/ui/assistant/thread-items.d.ts +1 -1
- package/dist/configurator/ui/assistant/tool-chip.d.ts +8 -1
- package/dist/configurator/ui/assistant/tool-chip.js +1 -1
- 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 +2 -2
- package/dist/configurator/ui/configurator-layout/universal/Layout.js +1 -1
- 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 +2 -2
- package/dist/configurator/ui/phoenix-layout-elements/AssistantToolbarButton.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 +3 -1
- 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-resolved-manifest.d.ts +95 -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/system-component-builder.js +1 -1
- package/dist/domain/components/updates.d.ts +16 -0
- package/dist/domain/core/action.d.ts +1 -1
- package/dist/domain/core/component.d.ts +1 -1
- package/dist/domain/core/decoder/create-decoder.d.ts +6 -0
- package/dist/domain/core/decoder/create-decoder.js +1 -0
- package/dist/domain/core/decoder/decoder.d.ts +6 -0
- package/dist/domain/core/decoder/decoder.js +1 -0
- package/dist/domain/core/decoder/index.d.ts +2 -0
- package/dist/domain/core/decoder/index.js +1 -0
- package/dist/domain/core/domain-factory.js +1 -1
- package/dist/domain/core/index.d.ts +1 -3
- package/dist/domain/core/index.js +1 -1
- package/dist/domain/core/reflection.d.ts +1 -1
- package/dist/domain/core/reflection.js +1 -1
- package/dist/domain/core/schema/enhanced-json-schema.js +1 -0
- package/dist/domain/core/schema/extended-schema-validator.js +1 -0
- package/dist/domain/core/schema/index.d.ts +3 -0
- package/dist/domain/core/schema/index.js +1 -0
- package/dist/domain/core/schema/schema-validator.js +1 -0
- package/dist/domain/domain-builder.d.ts +10 -1
- package/dist/domain/domain-builder.js +1 -1
- package/dist/domain/domain-context/action-system/action-system.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/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/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/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 +4 -4
- 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 -30
- package/dist/configurator/assistant/use-assistant-chat.js +0 -1
- package/dist/configurator/ui/assistant/AssistantPanelProvider.d.ts +0 -42
- package/dist/configurator/ui/assistant/AssistantPanelProvider.js +0 -1
- package/dist/domain/core/json-schema.js +0 -1
- package/dist/phoenix/application-spec/generate-assistant-prompt.js +0 -1
- /package/dist/domain/{core/enhanced-json-schema.js → application/assistant/assistant-manifest.js} +0 -0
- /package/dist/domain/{core/schema-validator.js → application/assistant/assistant-resolved-manifest.js} +0 -0
- /package/dist/domain/core/{schema-validator-ajv.d.ts → schema/create-ajv-schema-validator.d.ts} +0 -0
- /package/dist/domain/core/{schema-validator-ajv.js → schema/create-ajv-schema-validator.js} +0 -0
- /package/dist/domain/core/{schema-validator-csp.d.ts → schema/create-csp-schema-validator.d.ts} +0 -0
- /package/dist/domain/core/{schema-validator-csp.js → schema/create-csp-schema-validator.js} +0 -0
- /package/dist/domain/core/{enhanced-json-schema.d.ts → schema/enhanced-json-schema.d.ts} +0 -0
- /package/dist/domain/core/{json-schema.d.ts → schema/extended-schema-validator.d.ts} +0 -0
- /package/dist/domain/core/{schema-validator.d.ts → schema/schema-validator.d.ts} +0 -0
|
@@ -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 {};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where one exposed assistant GraphQL field reads its value on the `$` entity: a stored field name,
|
|
3
|
+
* or an expression name including its `$`. `localized` marks a localizable value that resolves to a
|
|
4
|
+
* string in the current locale.
|
|
5
|
+
*/
|
|
6
|
+
export interface AssistantFieldSource {
|
|
7
|
+
readonly source: string;
|
|
8
|
+
readonly localized?: true;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* One recipe group the assistant manifest exposes on an entity type: a `childEntityRecipes` instance
|
|
12
|
+
* under `childRecipes`, a `replaceEntityRecipes` instance under `replaceRecipes`. `groupId` is the
|
|
13
|
+
* name the agent addresses the group by, `instanceName` the component instance it reads,
|
|
14
|
+
* `description` the manifest's text replacing the component's group description, and `dryRuns`
|
|
15
|
+
* whether the recipes of the group can be dry-run.
|
|
16
|
+
*/
|
|
17
|
+
export interface AssistantRecipeGroup {
|
|
18
|
+
readonly groupId: string;
|
|
19
|
+
readonly instanceName: string;
|
|
20
|
+
readonly description?: string;
|
|
21
|
+
readonly dryRuns: boolean;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* The options edge of one writable field the assistant manifest links to its component. `field` is
|
|
25
|
+
* the delta field of `modify<Type>` the choices are for, `edgeName` the field of `<Type>Meta` that
|
|
26
|
+
* lists them, `componentType` and `instanceName` the component instance they are read from, and
|
|
27
|
+
* `validate` whether `modify<Type>` rejects a value that is not among them, and `dryRuns` whether
|
|
28
|
+
* the choices can be dry-run.
|
|
29
|
+
*/
|
|
30
|
+
export interface AssistantFieldOptions {
|
|
31
|
+
readonly field: string;
|
|
32
|
+
readonly edgeName: string;
|
|
33
|
+
readonly componentType: 'materialSwatch' | 'attributeSelection' | 'distanceDimensionSelect';
|
|
34
|
+
readonly instanceName: string;
|
|
35
|
+
readonly validate: boolean;
|
|
36
|
+
readonly dryRuns: boolean;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Experimental assistant manifest generated from the application spec `assistant` section. `sdl` is
|
|
40
|
+
* the GraphQL schema text rebuilt from the resolved manifest; `fields` maps each GraphQL object type's exposed
|
|
41
|
+
* fields (type name → GraphQL field name) to the stored field or expression its resolvers read;
|
|
42
|
+
* `deletableTypes` lists the entity types the `deleteEntity` mutation may delete, with aliases
|
|
43
|
+
* already expanded, and absent means none; `writableFields` maps, per entity type with a
|
|
44
|
+
* `modify<Type>` mutation, each field of its delta input to the stored property it writes, and
|
|
45
|
+
* absent means no entity type is writable; `childRecipes` lists, per entity type with a `meta` field,
|
|
46
|
+
* the recipe groups `meta { childRecipes }` and `addChild` expose, in manifest order, and absent
|
|
47
|
+
* means none; `replaceRecipes` lists the same for `meta { replaceRecipes }` and `replaceEntity`;
|
|
48
|
+
* `fieldOptions` lists, per entity type, the options edges `meta` exposes for its
|
|
49
|
+
* writable fields, and absent means none; `actions` maps each custom `Mutation` field to the
|
|
50
|
+
* declared action it runs, and absent means none. Consumed by the configurator GraphQL system.
|
|
51
|
+
*/
|
|
52
|
+
export interface AssistantManifest {
|
|
53
|
+
readonly sdl: string;
|
|
54
|
+
readonly fields: Readonly<Record<string, Readonly<Record<string, AssistantFieldSource>>>>;
|
|
55
|
+
readonly deletableTypes?: readonly string[];
|
|
56
|
+
readonly writableFields?: Readonly<Record<string, Readonly<Record<string, string>>>>;
|
|
57
|
+
readonly childRecipes?: Readonly<Record<string, readonly AssistantRecipeGroup[]>>;
|
|
58
|
+
readonly replaceRecipes?: Readonly<Record<string, readonly AssistantRecipeGroup[]>>;
|
|
59
|
+
readonly fieldOptions?: Readonly<Record<string, readonly AssistantFieldOptions[]>>;
|
|
60
|
+
readonly actions?: Readonly<Record<string, string>>;
|
|
61
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import type { AssistantFieldOptions, AssistantRecipeGroup } from './assistant-manifest.js';
|
|
2
|
+
/** JSON description of a scalar or recursively nested list, including nullability at each level. */
|
|
3
|
+
export type AssistantValueType = {
|
|
4
|
+
readonly kind: 'scalar';
|
|
5
|
+
readonly name: 'Int' | 'Float' | 'String' | 'Boolean' | 'ID' | 'JSON';
|
|
6
|
+
readonly nonNull: boolean;
|
|
7
|
+
} | {
|
|
8
|
+
readonly kind: 'list';
|
|
9
|
+
readonly item: AssistantValueType;
|
|
10
|
+
readonly nonNull: boolean;
|
|
11
|
+
};
|
|
12
|
+
/** A relation edge resolved against the model at parse time, linked to GraphQL types only during building. */
|
|
13
|
+
export interface AssistantRelationType {
|
|
14
|
+
readonly kind: 'edge';
|
|
15
|
+
readonly target: string;
|
|
16
|
+
readonly cardinality: '1-1' | '0-1' | '0-N' | '1-N';
|
|
17
|
+
}
|
|
18
|
+
/** A field's source and resolved type, carried in the application bundle without GraphQL instances. */
|
|
19
|
+
export interface AssistantResolvedField {
|
|
20
|
+
readonly name: string;
|
|
21
|
+
readonly source: string;
|
|
22
|
+
readonly type: {
|
|
23
|
+
readonly kind: 'value';
|
|
24
|
+
readonly type: AssistantValueType;
|
|
25
|
+
} | AssistantRelationType;
|
|
26
|
+
readonly localized: boolean;
|
|
27
|
+
readonly description?: string;
|
|
28
|
+
}
|
|
29
|
+
/** Declared UI state values used to describe the navigation query. */
|
|
30
|
+
export interface AssistantStates {
|
|
31
|
+
readonly navigationStates: readonly string[];
|
|
32
|
+
readonly viewStates: readonly string[];
|
|
33
|
+
readonly toolStates: readonly string[];
|
|
34
|
+
}
|
|
35
|
+
/** Serializable resolved whitelist from which the browser or backend constructs the assistant schema. */
|
|
36
|
+
export interface AssistantResolvedManifest {
|
|
37
|
+
readonly entityTypes: readonly string[];
|
|
38
|
+
readonly aliases: Readonly<Record<string, readonly string[]>>;
|
|
39
|
+
readonly exampleType?: string;
|
|
40
|
+
readonly fields: Readonly<Record<string, readonly AssistantResolvedField[]>>;
|
|
41
|
+
readonly states: AssistantStates;
|
|
42
|
+
readonly deletableTypes: readonly string[];
|
|
43
|
+
readonly writableTypes: readonly AssistantWritableType[];
|
|
44
|
+
readonly childRecipes: Readonly<Record<string, AssistantResolvedRecipes>>;
|
|
45
|
+
readonly replaceRecipes: Readonly<Record<string, AssistantResolvedRecipes>>;
|
|
46
|
+
readonly optionsEdges: Readonly<Record<string, readonly AssistantResolvedOptionsEdge[]>>;
|
|
47
|
+
readonly actionFields: readonly AssistantResolvedAction[];
|
|
48
|
+
}
|
|
49
|
+
/** Optional mutation input for one stored field, using its exposed name. */
|
|
50
|
+
export interface AssistantWritableField {
|
|
51
|
+
readonly name: string;
|
|
52
|
+
readonly property: string;
|
|
53
|
+
readonly type: AssistantValueType;
|
|
54
|
+
readonly description?: string;
|
|
55
|
+
}
|
|
56
|
+
/** One entity type's writable fields, in manifest order. */
|
|
57
|
+
export interface AssistantWritableType {
|
|
58
|
+
readonly entityType: string;
|
|
59
|
+
readonly fields: readonly AssistantWritableField[];
|
|
60
|
+
}
|
|
61
|
+
/** Description hints resolved from recipe/option entries; no parse context is retained. */
|
|
62
|
+
export type AssistantResolvedHint = 'sameForAllInstances' | 'constantDuringSession';
|
|
63
|
+
/** Recipe groups and their description hints for one entity type. */
|
|
64
|
+
export interface AssistantResolvedRecipes {
|
|
65
|
+
readonly groups: readonly AssistantRecipeGroup[];
|
|
66
|
+
readonly hints: readonly AssistantResolvedHint[];
|
|
67
|
+
}
|
|
68
|
+
/** One options edge, carrying the write-validation contract and schema description hints. */
|
|
69
|
+
export interface AssistantResolvedOptionsEdge {
|
|
70
|
+
readonly options: AssistantFieldOptions;
|
|
71
|
+
readonly hints: readonly AssistantResolvedHint[];
|
|
72
|
+
}
|
|
73
|
+
/** An action result field, either an entity edge or a plain JSON-described value. */
|
|
74
|
+
export type AssistantResolvedActionResult = {
|
|
75
|
+
readonly kind: 'edge';
|
|
76
|
+
readonly target: string;
|
|
77
|
+
readonly list: boolean;
|
|
78
|
+
readonly nullable: boolean;
|
|
79
|
+
readonly description?: string;
|
|
80
|
+
} | {
|
|
81
|
+
readonly kind: 'value';
|
|
82
|
+
readonly type: AssistantValueType;
|
|
83
|
+
readonly description?: string;
|
|
84
|
+
};
|
|
85
|
+
/** A custom mutation resolved against the declared action, independent of its implementation. */
|
|
86
|
+
export interface AssistantResolvedAction {
|
|
87
|
+
readonly fieldName: string;
|
|
88
|
+
readonly actionName: string;
|
|
89
|
+
readonly description?: string;
|
|
90
|
+
readonly args: Readonly<Record<string, {
|
|
91
|
+
readonly type: AssistantValueType;
|
|
92
|
+
readonly description?: string;
|
|
93
|
+
}>>;
|
|
94
|
+
readonly result: Readonly<Record<string, AssistantResolvedActionResult>>;
|
|
95
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { type GraphQLInputType, type GraphQLOutputType, GraphQLScalarType } from 'graphql';
|
|
2
|
+
import type { AssistantValueType } from './assistant-resolved-manifest.js';
|
|
3
|
+
/**
|
|
4
|
+
* Opaque scalar for values the assistant schema does not type: objects, custom TypeScript types and
|
|
5
|
+
* loose unions. A value is plain serializable data and passes through unchanged.
|
|
6
|
+
*/
|
|
7
|
+
export declare const GraphQLJSON: GraphQLScalarType<unknown, unknown>;
|
|
8
|
+
/** Recreates a GraphQL value type from the JSON descriptor, preserving every list and nullability layer. */
|
|
9
|
+
export declare const createAssistantValueType: (descriptor: AssistantValueType) => GraphQLInputType & GraphQLOutputType;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{GraphQLBoolean as e,GraphQLFloat as t,GraphQLID as a,GraphQLInt as n,GraphQLList as r,GraphQLNonNull as l,GraphQLScalarType as s,GraphQLString as i}from"graphql";export const GraphQLJSON=new s({name:"JSON",description:"Any JSON value, returned as stored. Always plain serializable data."});let o={Int:n,Float:t,String:i,Boolean:e,ID:a,JSON:GraphQLJSON};export const createAssistantValueType=e=>{let t="list"===e.kind?new r(createAssistantValueType(e.item)):o[e.name];return e.nonNull?new l(t):t};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { AssistantManifest } from './assistant-manifest.js';
|
|
2
|
+
import type { AssistantResolvedManifest } from './assistant-resolved-manifest.js';
|
|
3
|
+
/** Constructs the schema and runtime sources exclusively from serializable resolved data. */
|
|
4
|
+
export declare const buildAssistantManifest: (resolved: AssistantResolvedManifest) => Required<AssistantManifest>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{GraphQLBoolean as e,GraphQLID as t,GraphQLInputObjectType as n,GraphQLInterfaceType as i,GraphQLList as o,GraphQLNonNull as r,GraphQLObjectType as s,GraphQLSchema as a,GraphQLString as p,printSchema as d,validateSchema as h}from"graphql";import{GraphQLJSON as c,createAssistantValueType as l}from"./assistant-value-type.js";let y="AnyDomainEntity",u="RootEntity",f={section:"childRecipes",mutation:"addChild"},g={section:"replaceRecipes",mutation:"replaceEntity"},w=(e,t)=>Object.entries(e).find(([e])=>e===t)?.[1],m=(e,t)=>{if(!t||0===t.length)return e;let n=`One of: ${t.map(e=>`"${e}"`).join(", ")}.`;return e?/[.!?]$/.test(e)?`${e} ${n}`:`${e}. ${n}`:n},b=({target:e,cardinality:t},n)=>{let i=n(e);switch(t){case"1-1":return new r(i);case"0-1":return i;case"0-N":case"1-N":return new r(new o(new r(i)))}},v=(e,n,i)=>{let o={id:{type:new r(t),description:i?`Unique id of the entity, e.g. "${i}-1".`:void 0},type:{type:new r(p),description:i?`Entity type name, e.g. "${i}".`:void 0}};for(let t of e)o[t.name]={type:"edge"===t.type.kind?b(t.type,n):l(t.type.type),description:t.description};return o},$=e=>Object.fromEntries(e.map(({name:e,source:t,localized:n})=>[e,n?{source:t,localized:!0}:{source:t}])),j={sameForAllInstances:e=>`All ${e} instances have the same recipe groups and recipes.`,constantDuringSession:()=>"They do not change during the session."},O={sameForAllInstances:e=>`All ${e} instances have the same options.`,constantDuringSession:()=>"The options do not change during the session."},E=(e,t,n)=>e.map(e=>` ${t[e](n)}`).join(""),R=({section:e},{groups:t,hints:n},{entityType:i,purpose:s,recipeGroup:a})=>{let p=t.filter(({dryRuns:e})=>!e).map(({groupId:e})=>e);return 0===t.length?{}:{[e]:{type:new r(new o(new r(a))),description:`The recipe groups for ${s} this ${i}: ${t.map(({groupId:e})=>e).join(", ")}. A group is listed only while the configurator offers it on the entity.${p.length>0?` Recipes of these groups cannot be dry-run: ${p.join(", ")}.`:""}${E(n,j,i)}`}}},k=({entityType:e,childRecipes:t,replaceRecipes:n,optionsEdges:i},{recipeGroup:a,fieldOption:p})=>new s({name:`${e}Meta`,fields:Object.assign(R(f,t,{entityType:e,purpose:"adding children to",recipeGroup:a}),R(g,n,{entityType:e,purpose:"replacing",recipeGroup:a}),...i.map(({options:{edgeName:t,field:n,validate:i,dryRuns:s},hints:a})=>({[t]:{type:new o(new r(p)),description:`The values "${n}" of this ${e} can take, as the configurator offers them in the current state of the entity. Null when the configurator does not offer a choice on this entity. ${i?`modify${e} rejects a "${n}" value that is not in the list.`:`modify${e} does not check "${n}" against the list.`}${s?"":" Its options cannot be dry-run."}${E(a,O,e)}`}})))}),I=e=>Object.entries(e).map(([e,t])=>`${e} (${t.map(({groupId:e})=>e).join(", ")})`);export const buildAssistantManifest=b=>{var j,O,E,R,T;let A,N,D,M,{entityTypes:S,aliases:q,exampleType:W,fields:C,states:G,deletableTypes:K,writableTypes:U,actionFields:F,optionsEdges:x}=b,z=Object.fromEntries(Object.entries(b.childRecipes).map(([e,t])=>[e,t.groups])),Q=Object.fromEntries(Object.entries(b.replaceRecipes).map(([e,t])=>[e,t.groups])),B=new Map,H=new Map,J=new Map,L=e=>{let[t,...n]=Object.entries(q).find(([t])=>t===e)?.[1]??[];return(t&&0===n.length?H.get(t):void 0)??J.get(e)??V},P=e=>H.get(e)??L(e),V=new i({name:y,description:"Every domain entity.",fields:()=>v(C[y]??[],P,W)});for(let e of(J.set(y,V),Object.keys(q)))e!==y&&J.set(e,new i({name:e,interfaces:[V],fields:()=>v(C[e]??[],P)}));let X={};for(let e of S){let t=[y,...Object.entries(q).filter(([t,n])=>t!==y&&n.includes(e)).map(([e])=>e)],n=C[e]??[];X[e]=$(n),H.set(e,new s({name:e,interfaces:t.flatMap(e=>J.get(e)??[]),fields:()=>{let t=B.get(e);return{...v(n,P),...t?{meta:{type:new r(t),description:"What the configurator offers on this entity besides its fields."}}:{}}}}))}let Y=(j=()=>L(J.has(u)?u:y),O=()=>L(y),A=new s({name:"DryRunError",description:"One reason a change cannot be made right now.",fields:{type:{type:new r(p),description:'Kind of the problem, or "uncaught".'},entityId:{type:t,description:"The entity the problem is on, when it is on one."},message:{type:p,description:"The problem as the configurator words it for the user."}}}),new s({name:"DryRun",description:"What using a recipe or writing an option would do, tried out on the configuration the query reads. Nothing is changed.",fields:()=>({ok:{type:new r(e),description:"Whether the change would succeed on the configuration the query reads."},root:{type:j(),description:"The root entity of the configuration as it would be after the change; null when ok is false. Everything selected under it reads that configuration."},changedEntities:{type:new r(new o(new r(O()))),description:"Every entity the change would add or modify, read from that configuration; empty when ok is false. An entity whose id the configuration does not have yet would be added, and its id may differ in the real mutation. An entity that is written to is listed even when it gets the values it already has."},deletedEntityIds:{type:new r(new o(new r(t))),description:"The ids of the entities the change would remove; empty when ok is false."},sideEffects:{type:new r(new o(new r(p))),description:"What the configurator would do beyond the change itself, such as parts it would add or replace, in its own words; empty when ok is false."},errors:{type:new r(new o(new r(A))),description:"Why the change cannot be made; empty when ok is true."}})})),Z={recipeGroup:(E=[...Object.keys(z).length>0?[f.mutation]:[],...Object.keys(Q).length>0?[g.mutation]:[]],N=E.join(" or "),D=new s({name:"Recipe",description:"One recipe of a recipe group: something that can be added to the entity, or something the entity can be replaced with, depending on the edge the group is listed under.",fields:{key:{type:new r(p),description:`Identifies the recipe within its group; pass it to ${N} as recipeKey. Keys can change with the configuration and with the language, so read them from the listing rather than remembering them.`},name:{type:new r(p),description:"Name shown to the user."},description:{type:p},imageUrl:{type:p,description:"Thumbnail shown to the user."},dryRun:{type:Y,description:"Tries the recipe out. Each selected dry-run costs a full recalculation, so select it only on the recipes you are deciding between. Null for a group whose recipes cannot be dry-run."}}}),new s({name:"RecipeGroup",description:"A group of recipes of an entity, as the configurator offers them to the user.",fields:{groupId:{type:new r(p),description:`Identifies the group on its entity; pass it to ${N} as recipeGroupId.`},name:{type:new r(p),description:"Name shown to the user."},description:{type:p},recipes:{type:new r(new o(new r(D)))}}})),fieldOption:new s({name:"FieldOption",description:"One choice of a field, as the configurator offers it to the user.",fields:{value:{type:new r(c),description:"The value to write to the field."},name:{type:p,description:"Name shown to the user."},description:{type:p},imageUrl:{type:p,description:"Image shown to the user."},color:{type:p,description:'Color shown to the user, as "#rrggbb".'},dryRun:{type:Y,description:"Tries writing the value to the field. Each selected dry-run costs a full recalculation, so select it only on the options you are deciding between. Null for a field whose options cannot be dry-run."}}})};for(let e of S){let t=w(b.childRecipes,e)??{groups:[],hints:[]},n=w(b.replaceRecipes,e)??{groups:[],hints:[]},i=w(x,e)??[];(t.groups.length>0||n.groups.length>0||i.length>0)&&B.set(e,k({entityType:e,childRecipes:t,replaceRecipes:n,optionsEdges:i},Z))}let _=new a({query:(R=L(J.has(u)?u:y),T=L(y),M=(e=>{let t={};for(let[n,i,o]of[["navigationState","Active navigation state.",e.navigationStates],["viewState","Active view state.",e.viewStates],["toolState","Active tool state.",e.toolStates]])o.length>1&&(t[n]={type:new r(p),description:m(i,o)});if(0!==Object.keys(t).length)return new s({name:"Navigation",description:"The active UI states of the configurator.",fields:t})})(G),new s({name:"Query",fields:{root:{type:new r(R),description:"The root entity of the configuration."},entities:{type:new r(new o(T)),args:{ids:{type:new o(new r(t))}},description:`Every entity of the configuration, or, when ids are given, those entities in the same order with null for an unknown id. Ids have the form "<Type>-<number>"${W?`, e.g. "${W}-1"`:""}; any other id is an error.`},selectedEntity:{type:new r(T),description:"The selected entity, or the root entity when nothing is selected."},...M?{navigation:{type:new r(M)}}:{}}})),mutation:(({deletableTypes:e,writableTypes:i,childRecipes:a,replaceRecipes:d,actionFields:h,objectTypes:c,anyDomainEntity:y,targetOutputType:u})=>{let f,g;if(0!==e.length||0!==i.length||0!==Object.keys(a).length||0!==Object.keys(d).length||0!==h.length)return new s({name:"Mutation",fields:Object.assign(0===e.length?{}:{deleteEntity:{type:new r(new o(new r(t))),args:{id:{type:new r(t)}},description:`Deletes the entity with the given id, together with the entities composed into it, and returns the ids of every entity the deletion removed, the given one first. Deletable entity types: ${e.join(", ")}. Nothing can be read from removed entities afterwards, so query what you need from them before deleting.`}},0===(f=I(a)).length?{}:{addChild:{type:new r(new o(new r(y))),args:{parentId:{type:new r(t)},recipeGroupId:{type:new r(p)},recipeKey:{type:new r(p)}},description:`Adds a child to the entity with the id parentId by one recipe of one of its recipe groups. Entity types with recipe groups: ${f.join("; ")}. Read the groupId and the recipe key from "meta { childRecipes }" of the parent. Returns every entity the change added, the recipe's own first and then whatever the configurator added in response, such as a part the new child needs; the list is empty when the configurator removed them again.`}},0===(g=I(d)).length?{}:{replaceEntity:{type:new r(new o(new r(y))),args:{entityId:{type:new r(t)},recipeGroupId:{type:new r(p)},recipeKey:{type:new r(p)}},description:`Replaces the entity with the id entityId by one recipe of one of its replace recipe groups. Entity types with replace recipe groups: ${g.join("; ")}. Read the groupId and the recipe key from "meta { replaceRecipes }" of the entity. The replacement is a new entity with a new id: the id passed in no longer exists afterwards, and the replacement has the field values of its recipe, not those of the entity it replaces. Returns every entity the change added, the replacement first and then whatever the configurator added in response, such as a part the replacement needs; the list is empty when the configurator removed them again.`}},...i.flatMap(e=>{let i=c.get(e.entityType);return i?[(({entityType:e,fields:i},o)=>{let s=Object.fromEntries(i.map(({name:e,type:t,description:n})=>[e,{type:l(t),description:n}]));return{[`modify${e}`]:{type:o,args:{id:{type:new r(t)},delta:{type:new r(new n({name:`${e}Delta`,fields:s}))}},description:`Changes writable fields of the one ${e} with the given id: ${i.map(({name:e})=>e).join(", ")}. The delta sets only the fields it names and needs at least one; values are in stored units, as the field descriptions say. Returns the entity as it is after the change, including what the configurator adjusted in response, or null when the change caused the entity to be removed.`}}})(e,i)]:[]}),Object.fromEntries(h.map(e=>{var t;return[e.fieldName,{type:new r(new s({name:(t=e.fieldName,`${t.charAt(0).toUpperCase()+t.slice(1)}Result`),description:`What ${e.fieldName} returns, read from the configuration after the change.`,fields:()=>Object.fromEntries(Object.entries(e.result).map(([e,t])=>[e,{type:"edge"===t.kind?(({target:e,list:t,nullable:n},i)=>{let s=t?new o(new r(i(e))):i(e);return n?s:new r(s)})(t,u):l(t.type),description:t.description}]))})),args:Object.fromEntries(Object.entries(e.args).map(([e,t])=>[e,{type:l(t.type),description:t.description}])),description:e.description}]})))})})({deletableTypes:K,writableTypes:U,childRecipes:z,replaceRecipes:Q,actionFields:F,objectTypes:H,anyDomainEntity:L(y),targetOutputType:P}),types:[...J.values(),...H.values()]}),ee=h(_);if(ee.length>0)throw Error(ee.map(e=>e.message).join(" "));return{sdl:d(_),fields:X,deletableTypes:K,writableFields:Object.fromEntries(U.map(({entityType:e,fields:t})=>[e,Object.fromEntries(t.map(({name:e,property:t})=>[e,t]))])),childRecipes:z,replaceRecipes:Q,fieldOptions:Object.fromEntries(S.flatMap(e=>{let t=w(x,e);return t?[[e,t.map(({options:e})=>e)]]:[]})),actions:Object.fromEntries(F.map(({fieldName:e,actionName:t})=>[e,t]))}};
|
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { AssistantManifest } from './assistant-manifest.js';
|
|
2
2
|
/**
|
|
3
3
|
* The part of the assistant's system prompt that explains how to read the generated GraphQL schema.
|
|
4
|
-
* It is generated here, by the SDK that also runs in the browser, and
|
|
4
|
+
* It is generated here, by the SDK that also runs in the browser, and returned by the deployment webhook,
|
|
5
5
|
* because the conventions it describes belong to this SDK version and not to the server. The part
|
|
6
6
|
* about changes is left out when the schema has no `Mutation` type, the part about adding
|
|
7
7
|
* entities when it has no `addChild` mutation, the part about replacing them when it has no
|
|
8
8
|
* `replaceEntity` mutation, the part about the choices of a field when it has
|
|
9
|
-
* no options edge, and the part about custom changes when the manifest exposes no action. The last
|
|
10
|
-
* `query` and `apply` tools, which every run registers whatever the schema holds
|
|
9
|
+
* no options edge, and the part about custom changes when the manifest exposes no action. The last two sections explain the
|
|
10
|
+
* `query` and `apply` tools, which every run registers whatever the schema holds, and the change
|
|
11
|
+
* record the `AssistantSystem` attaches to every user message.
|
|
11
12
|
*/
|
|
12
|
-
export declare const generateAssistantPrompt: (assistant:
|
|
13
|
+
export declare const generateAssistantPrompt: (assistant: AssistantManifest) => string;
|