@salsita-ai/sdk 0.50.0-develop.b5468d6828 → 0.50.0-develop.b5d443db78

package/dist/docs/phoenix/localization.mdx

@@ -19,13 +19,13 @@ Phoenix provides a localization system built on **Lingui** that enables multi-la
 
 The localization architecture has two layers that work together automatically. **SDK translations** provide the built-in platform UI components, error messages, and system text. **Project catalogs** contain your domain-specific translations for entities, validation messages, and custom UI components.
 
-These translation sources merge automatically at runtime. The system uses lazy loading where translation catalogs compile to TypeScript modules and load only when needed.
+These translation sources merge automatically at runtime. The translation catalogs compile to TypeScript modules that are bundled with the application.
 
 The translation workflow follows a clear pattern: Lingui extracts translatable strings from your code using `msg()` macros and `$msg` syntax, translators work with standard `.po` files for each language, those files compile into TypeScript modules for your application, and the SDK and project catalogs merge into a unified translation system during initialization.
 
 ## Getting Your Project Set Up
 
-Phoenix uses the **phx-cli** to automatically manage localization setup. When you configure `availableLocales` in your `spec/application.yaml`, the CLI creates and maintains the necessary i18n structure.
+The Phoenix CLI manages the localization setup. When you list the project's languages in the top-level `availableLocales` key of a spec file, such as `spec/application.yaml`, the CLI creates and maintains the necessary i18n structure.
 
 ### Enabling Localization
 
@@ -39,7 +39,7 @@ availableLocales:
   - cs
 ```
 
-Running `phx sync` automatically creates the i18n directory structure:
+Running `pnpm phoenix sync` creates the i18n directory structure:
 
 ```
 project-root/
@@ -57,68 +57,79 @@ project-root/
 ├── spec/
 │   └── application.yaml           # Contains availableLocales
 ├── .phoenix/
-│   ├── .lingui/                   # Compiled i18n catalogs
-│   └── i18n.ts                    # Auto-generated i18n initialization
+│   ├── .linguirc                  # Generated Lingui configuration
+│   └── domain-spec.ts             # Generated code that loads and merges the catalogs
 └── package.json
 ```
 
 **Key directories:**
 
-- `src/locales/<lang>/` - Auto-generated `.po` files for translators, compiled `.ts` files
-- `.phoenix/i18n.ts` - Auto-generated i18n initialization with catalog merging
+- `src/locales/<lang>/` - Generated `.po` files for translators, compiled `.ts` files
+- `.phoenix/domain-spec.ts` - Generated code that imports each locale's compiled catalog and merges it with the SDK's
 
-### Auto-Generated i18n Initialization
+### Generated i18n Initialization
 
-The `.phoenix/i18n.ts` file is auto-generated and handles catalog merging automatically:
+The generated `.phoenix/domain-spec.ts` imports the compiled catalog of every locale in `availableLocales` and merges it with the SDK catalog:
 
 ```typescript
-// .phoenix/i18n.ts (AUTO-GENERATED - DO NOT EDIT)
-import { mergeCatalogs, sdkCatalog } from '@salsita-ai/sdk/i18n'
-
+// .phoenix/domain-spec.ts (excerpt, generated - do not edit)
 import { messages as cs } from '../src/locales/cs/messages.js'
 import { messages as de } from '../src/locales/de/messages.js'
 import { messages as en } from '../src/locales/en/messages.js'
 
-export const catalog = { en, de, cs }
-export const availableLocales = Object.keys(catalog) as Array<keyof typeof catalog>
+const catalog = {
+  en,
+  de,
+  cs,
+}
+// Merges SDK and project catalogs, keeping only the project's locales
+const messages = mergeCatalogs([sdkCatalog, catalog], Object.keys(catalog))
+
+export const createI18n = () => setupI18n({ messages, locale: 'en' })
+```
 
-// Automatically merges SDK and project catalogs
-const messages = mergeCatalogs([sdkCatalog, catalog])
+### Choosing the Language
 
-export const createI18n = () =>
-  setupI18n({
-    messages,
-    locale: 'en',
-  })
+`availableLocales` decides which catalogs the project compiles and ships. The language the configurator shows is chosen separately:
+
+- **Starting language.** The configurator starts in the host's `locale` property (the `locale` attribute of the web component), `en` by default. When it is not in `availableLocales`, the configurator falls back to one that is, as described in [Locale Fallback Configuration](#locale-fallback-configuration).
+- **Language switch.** The toolbar's language button and the menu's language action offer the locales in `applicationConfig.availableLocales` on the root entity (`['en']` without it). Keep that list within the top-level `availableLocales`: picking a locale outside it activates the locale it falls back to, as a starting language does, not the picked one. A project layout builds its own switch with `phx.frontend.useLocaleSwitch()`, see [Configurator Interface → Hooks for a Project Layout](?path=/docs/phoenix-configurator-interface--docs#hooks-for-a-project-layout).
+
+```yaml
+components:
+  Product: # the root entity type
+    applicationConfig:
+      default:
+        availableLocales:
+          - en
+          - de
+          - cs
 ```
 
 ### Overriding SDK Translations
 
 You can customize or override any SDK translation by adding the same message ID to your project's `.po` files. The `mergeCatalogs` function prioritizes project translations over SDK translations when merging.
 
-For example, to customize the finalize button text, add this to your `locales/en/messages.po`:
+The SDK's message IDs start with `sdk.`. For example, to customize the finalize button text and the save-template button, add this to your `src/locales/en/messages.po`:
 
 ```po
-#: src/configurator/ui/finalize/FinalizeButton.tsx:42
-#: src/configurator/ui/finalize/FinalizeButton.tsx:56
-msgid "Finalize"
+msgid "sdk.layout.sidebar.finalizePage.label"
 msgstr "Complete Order"
 
-#: src/configurator/ui/controls/save-configuration/SaveConfigurationButton.tsx:23
-msgid "Save Configuration"
+msgid "sdk.layout.button.saveTemplate.label"
 msgstr "Save My Design"
 ```
 
-After running `pnpm lingui:compile`, your custom translations will override the default SDK translations. This allows you to:
+Once the catalogs are compiled again, by `pnpm phoenix sync`, `pnpm phoenix build` or `pnpm phoenix dev --withLingui`, your custom translations override the default SDK translations. This allows you to:
 
 - Customize terminology to match your brand
 - Provide more context-specific wording
 - Adapt translations for your target audience
 - Maintain consistency with your existing product language
 
-**Frontend integration**: the generated `.phoenix` code creates the i18n service from `.phoenix/i18n.ts` and registers
-it with the application, so there is nothing to wire by hand. The languages come from `availableLocales` in
-`spec/application.yaml`.
+**Frontend integration**: the generated `.phoenix` code creates the i18n service from the catalogs in
+`.phoenix/domain-spec.ts` and registers it with the application, so there is nothing to wire by hand. The catalogs come
+from the top-level `availableLocales`.
 
 ## Working with YAML Domain Specifications
 
@@ -152,6 +163,8 @@ entities:
 
 This is the way to go when you're dealing with content that might evolve over time. The message ID stays the same, so your existing translations remain valid even when you tweak the wording. Plus, you can use dot notation to create nice, organized namespaces for your translations.
 
+A `$msg` compiles to a message descriptor. When an expression that holds one also declares a schema, the schema has to accept a message descriptor, such as `$ref: 'phx:Localizable'` or `$ref: 'phx:MessageDescriptor'`; a `$msg` declared as `type: string` or `type: number` is reported as `EXPRESSION_VALUE_TYPE_MISMATCH`.
+
 You can use both approaches throughout your domain specifications. Here are some common patterns that work well:
 
 ```yaml
@@ -241,12 +254,11 @@ Admin users can switch between different languages to input translations for eac
 
 ```typescript
 import { Stack } from '@mui/material'
-import type { AdminModel } from 'project-domain'
 
 import { LanguageSwitcher, MultilingualTextValueInput, TextValueInput } from '@salsita-ai/sdk/react'
 import { PropertyContainer } from '@salsita-ai/sdk/ui'
 
-export const MaterialSidebar = (props: { id: AdminModel.Material['id'] }) => {
+export const MaterialSidebar = (props: { id: Phx['AdminModel']['Material']['id'] }) => {
   const { id } = props
 
   return (
@@ -327,11 +339,11 @@ publishedData: {
 
 ### Configurator Consumption
 
-In your configurator, use the `resolveLocalizable` function or `useLocalizable` hook to display the appropriate language:
+In your configurator, use the `phx.frontend.useLocalizable` hook or the resolver from `phx.frontend.useResolveLocalizable()` to display the appropriate language:
 
 ```typescript
 // In expressions
-const customExpressions = implementCustomExpressions({
+const customExpressions = phx.domain.implementCustomExpressions({
   Product: {
     $materialName: (product, state, ctx) => {
       const material = ctx.publishedData.materials.find(m => m.id === product.materialId)
@@ -342,7 +354,7 @@ const customExpressions = implementCustomExpressions({
 
 // In React components
 function MaterialDisplay({ materialData }) {
-  const name = useLocalizable(materialData.name)
+  const name = phx.frontend.useLocalizable(materialData.name)
   return <span>{name}</span>
 }
 ```
@@ -367,13 +379,11 @@ function ProductHeader({ product }) {
 }
 ```
 
-Sometimes you need the actual translated string for use in component logic or HTML attributes, rather than rendering it directly. That's where the `useLocalizable` hook comes in handy:
+Sometimes you need the actual translated string for use in component logic or HTML attributes, rather than rendering it directly. That's where the `phx.frontend.useLocalizable` hook comes in handy:
 
 ```tsx
-import { useLocalizable } from '@salsita-ai/sdk/react'
-
 function ValidationMessage({ invariant }) {
-  const message = useLocalizable(invariant.message)
+  const message = phx.frontend.useLocalizable(invariant.message)
 
   return (
     <div className="error" title={message}>
@@ -383,13 +393,13 @@ function ValidationMessage({ invariant }) {
 }
 ```
 
-For more complex scenarios where you need to resolve translations dynamically (like when sorting lists by translated names), there's `useResolveLocalizable`. This gives you a resolver function that you can use however you need:
+For more complex scenarios where you need to resolve translations dynamically (like when sorting lists by translated names), there's `phx.frontend.useResolveLocalizable`. This gives you a resolver function that you can use however you need:
 
 ```tsx
-import { useResolveLocalizable } from '@salsita-ai/sdk/react'
+import { LocalizableMessage } from '@salsita-ai/sdk/react'
 
 function EntityList({ entities }) {
-  const resolve = useResolveLocalizable()
+  const resolve = phx.frontend.useResolveLocalizable()
 
   const sortedEntities = entities.sort((a, b) => resolve(a.displayName).localeCompare(resolve(b.displayName)))
 
@@ -425,6 +435,8 @@ function WelcomeMessage({ userName, itemCount }) {
 
 The localization system isn't just for the frontend — it works in server-side webhook handlers too. PDF and email tasks render React templates with the same Lingui macros (`<Trans>` from `@lingui/react/macro`, `msg` from `@lingui/core/macro`) you already use in UI components. The task context exposes `ctx.resolveLocalizable` already bound to the request locale and domain fallback chain, and the React builders use it for localizable subjects, attachment filenames, bodies, headers, footers, and watermark text.
 
+The request locale is the one the frontend passes as the fourth argument of `apiClient.finalize(configurationId, finalizationId, finalizeData, locale, frontendData)`, where `apiClient` comes from `phx.frontend.useAuthorizedClient()`. Pass the active locale, for example `phx.frontend.useLocaleSwitch().locale`, so the webhook renders in the language the user sees. Without a locale the webhook renders in `en`.
+
 ### In the handler
 
 Use the `msg` template tag for one-off strings you pass into builder methods:
@@ -511,7 +523,7 @@ Legacy Handlebars PDF/email tasks remain supported for backwards compatibility,
 
 ## Your Day-to-Day Development Workflow
 
-The **phx-cli** handles most translation workflow automatically. The basic cycle is: sync to extract strings, translate `.po` files, build to compile.
+The Phoenix CLI handles most of the translation workflow. The basic cycle is: sync to extract and compile the strings, translate the `.po` files, then sync or build again to compile the translations.
 
 ### Development Workflow
 
@@ -519,7 +531,7 @@ For day-to-day development, opt into the Lingui watcher with `--withLingui` (or
 
 ```bash
 # Start development server with hot reload and i18n watch
-phx dev --withLingui
+pnpm phoenix dev --withLingui
 
 # This automatically:
 # - Watches for new translatable strings
@@ -527,26 +539,28 @@ phx dev --withLingui
 # - Compiles translations on change
 ```
 
-Lingui watching is disabled by default, and `phx dev` logs a warning when it is not enabled.
+Lingui watching is disabled by default: `phoenix dev` then only creates the catalogs that are missing at startup, leaves existing `.po` and compiled files as they are, and logs a warning.
 
-When you add new translatable content (using `$msg` in YAML or `msg()` in code), run `phx sync` to extract strings:
+When you add new translatable content (using `$msg` in YAML or `msg()` in code), run `phoenix sync` to extract and compile the strings:
 
 ```bash
-# Sync domain specs and extract i18n strings
-phx sync
+# Sync domain specs, extract and compile i18n strings
+pnpm phoenix sync
 ```
 
-This updates the `.po` files in `src/locales/<lang>/messages.po`. Translators fill in the `msgstr` values for each `msgid`.
+This updates the `.po` files in `src/locales/<lang>/messages.po` and the compiled `.ts` files beside them. Translators fill in the `msgstr` values for each `msgid`.
 
 ### Production Build
 
 When you're ready to ship:
 
 ```bash
-# Build for production (includes i18n compilation)
-phx build
+# Build for production (extracts and compiles the i18n catalogs)
+pnpm phoenix build
 ```
 
+With the application-spec pipeline, `phoenix dev` and `phoenix build` compile the Lingui macros in your frontend code with the SDK's own Lingui macro plugin and the configuration in `.phoenix/.linguirc`, so the project installs no Babel macro packages for them (see [Current and legacy project tooling](?path=/docs/phoenix-phoenix-cli--docs#current-and-legacy-project-tooling)).
+
 ### Translation Files
 
 The `.po` files in `src/locales/` are standard GNU gettext format that most translation tools support:
@@ -565,7 +579,7 @@ During development, missing translations fall back to the message ID. In product
 
 ### Locale Fallback Configuration
 
-Phoenix automatically configures comprehensive locale fallbacks in the generated `.linguirc` file. When a translation is missing for a specific regional locale, it gracefully falls back to the base language before falling back to the default language (English).
+Phoenix automatically configures comprehensive locale fallbacks in the Lingui configuration it generates. When a translation is missing for a specific regional locale, it gracefully falls back to the base language before falling back to the default language (English).
 
 **Fallback Rules:**
 
@@ -595,7 +609,7 @@ User locale: de-AT (Austrian German)
 └─ Translation in en? → Use it (default fallback)
 ```
 
-The fallback configuration is generated by `phx sync` and stored in `.linguirc`. You don't need to configure this manually - it's handled automatically based on your `availableLocales` in `spec/application.yaml`.
+The fallback configuration is generated by `phoenix sync` and stored in `.phoenix/.linguirc` (in the project root on the legacy pipeline; see [Current and legacy project tooling](?path=/docs/phoenix-phoenix-cli--docs#current-and-legacy-project-tooling)). You don't need to configure this manually - it's handled automatically based on your top-level `availableLocales`.
 
 ## What We Learned
 

package/dist/docs/phoenix/migration-guide.mdx

@@ -264,6 +264,8 @@ With the application-spec pipeline (`phoenix.applicationFlow` in `package.json`;
 
 A root `tsconfig.json` from the old multi-folder template, or one written by hand, stays as it is and does not pick up the generated settings or the global `phx` types in `.phoenix/globals.d.ts`, so `pnpm ts:check` fails. Delete it, or replace its content with the line above, before the first sync.
 
+With the application-spec pipeline (see [Current and legacy project tooling](?path=/docs/phoenix-phoenix-cli--docs#current-and-legacy-project-tooling)), `eslint.config.js` and `prettier.config.js` are the project's. Sync replaces a file earlier SDK versions generated, the one under the "Auto-generated file. Do not modify this file manually." header that re-exports `eslintrc` or `prettierrc`, with a file that re-exports the same configuration from `@salsita-ai/sdk/common/eslint` or `@salsita-ai/sdk/common/prettier`, and writes that file into a project that has none. A file of your own stays as it is, and editors, `phoenix check` and `phoenix fix` use it; make sure it imports only packages the project still depends on, or delete it before the first sync. Without the file, `phoenix check` and `phoenix fix` use the SDK's configuration. The legacy pipeline rewrites both files on every sync.
+
 ### 10. Create Mocks (Optional)
 
 If you have mock files, move them to `mocks/`:
@@ -290,7 +292,7 @@ This will:
 
 Other useful commands:
 
-- `pnpm phoenix sync` - Sync dependencies in package.json
+- `pnpm phoenix sync` - Regenerate the generated code and project files
 - `pnpm phoenix gen` - Regenerate project files
 - `pnpm phoenix dev` - Start development server with hot reload
 - `pnpm phoenix deployment:prepare` - Prepare for deployment
@@ -350,33 +352,32 @@ grep -r "from '\.\/" src/
 
 **Error:** Changes to `.phoenix/` files are overwritten
 
-**Solution:** Never commit `.phoenix/` contents. Add to `.gitignore`:
+**Solution:** Keep generated files out of version control. Application-spec projects can commit their project-owned `.phoenix/workspace/` records; sync writes the appropriate ignore rules. Remove any custom rule that ignores the entire `.phoenix/` directory if you want to version those records. See [Project Structure](?path=/docs/phoenix-project-structure--docs#markers-for-partial-auto-generation) for the managed block and ownership rules.
 
-```
-.phoenix/
-```
-
-If you accidentally modified generated files, delete and regenerate:
+If you accidentally modified generated files, clean and regenerate them with the CLI. In application-spec projects this preserves workspace records:
 
 ```bash
-rm -rf .phoenix/
+pnpm phoenix clean
 pnpm phoenix build
 ```
 
+The legacy pipeline has no workspace-preservation contract; see [Phoenix CLI](?path=/docs/phoenix-phoenix-cli--docs#phoenix-clean).
+
 **Note:** Mock templates are no longer auto-applied on Editor load. Users must manually select and apply templates (changed in v0.36.0).
 
 ### .gitignore Conflicts
 
 **Error:** Custom gitignore entries disappear after Phoenix update
 
-**Solution:** Place custom entries between Phoenix markers:
+**Solution:** Place custom entries outside the Phoenix markers. Sync replaces the generated block and preserves everything outside it:
 
 ```gitignore
-# phoenix-start
+# ===== BEGIN PHOENIX AUTO-GENERATED =====
 # Auto-generated by Phoenix - DO NOT EDIT
-.phoenix/
+**/.phoenix/*
+!**/.phoenix/workspace/
 .env.generated
-# phoenix-end
+# ===== END PHOENIX AUTO-GENERATED =====
 
 # Your custom entries below
 my-custom-folder/
@@ -438,19 +439,19 @@ Use this checklist to verify migration completeness:
 - [ ] Configurator renders correctly
 - [ ] Admin interface works
 - [ ] All imports updated to new paths
-- [ ] Node 24 and pnpm v10 installed
+- [ ] Node 24 and a package manager installed
 
 ## Removed Files
 
 The following files are no longer needed - they are auto-generated by the CLI:
 
-| File                        | Replacement                                                                                                                         |
-| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `src/domain/domain.ts`      | Auto-generated in `.phoenix/domain.ts`                                                                                              |
-| `src/frontend/frontend.tsx` | Auto-generated in `.phoenix/configurator.ts`                                                                                        |
-| `tsconfig.json`             | Delete before the first sync; with the application-spec pipeline, sync writes a one-line file that extends `.phoenix/tsconfig.json` |
-| `eslint.config.js`          | Auto-generated by CLI                                                                                                               |
-| `prettier.config.js`        | Auto-generated by CLI                                                                                                               |
+| File                        | Replacement                                                                                                                                                                                                                                                    |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `src/domain/domain.ts`      | Auto-generated in `.phoenix/domain.ts`                                                                                                                                                                                                                         |
+| `src/frontend/frontend.tsx` | Auto-generated in `.phoenix/configurator.ts`                                                                                                                                                                                                                   |
+| `tsconfig.json`             | Delete before the first sync; with the application-spec pipeline, sync writes a one-line file that extends `.phoenix/tsconfig.json`                                                                                                                            |
+| `eslint.config.js`          | With the application-spec pipeline, sync replaces the file earlier SDK versions generated with one that re-exports the SDK's ESLint configuration, or writes one when there is none; a file of your own stays (see [step 9](#9-remove-auto-generated-files))   |
+| `prettier.config.js`        | With the application-spec pipeline, sync replaces the file earlier SDK versions generated with one that re-exports the SDK's Prettier configuration, or writes one when there is none; a file of your own stays (see [step 9](#9-remove-auto-generated-files)) |
 
 ## Builder Options Moved to YAML
 
@@ -484,7 +485,7 @@ Update imports to use these globals instead of importing from packages directly.
 ## Environment Requirements
 
 - Node 24
-- pnpm v10
+- A package manager; the commands in this guide use pnpm
 - `RESOURCES_URL` is an optional frontend environment variable; in local development it defaults to the Vite dev server at `http://localhost:5173`
 
 ## Next Steps