chore(platform-objects): designer help text names the currency result in all four locales; changeset

Claude-Session: https://claude.ai/code/session_016njDy8ozy9B9Ns5Y8kAWEK
Co-authored-by: Claude <noreply@anthropic.com>

Author: claude

.changeset/22727-formula-currency-result.md

@@ -0,0 +1,16 @@
+---
+"@objectstack/spec": minor
+"@objectstack/formula": minor
+"@objectstack/platform-objects": patch
+---
+
+A formula field can declare a currency result: `returnType: 'currency'`, with its currency in its own `currencyConfig`
+
+Clause-②: yes (widening)
+
+- **What is new in `@objectstack/spec`.** `FieldSchema.returnType` accepts `'currency'` beside `'number'`, `'text'`, `'boolean'` and `'date'`. A `currency` result is an amount of money. Its value is a bare number, as a currency field's is. Its currency is the formula field's own `currencyConfig`, the same `CurrencyConfigSchema` a currency field carries, with the same defaults and the same refusals: no `currencyConfig` means dynamic mode (the tenant default currency), and `{ currencyMode: 'fixed', defaultCurrency: 'USD' }` fixes it. Nothing is read at display time from the fields the expression references: the currency is a declaration on the formula.
+- **Readers.** The filter doors judge a formula returning `currency` as the currency field it reads like: a text operator on it is refused (`INVALID_FILTER`), and the number door judges its comparands. A formula is still not title-eligible unless it returns `text`, and is still refused for `sum` / `avg` / `min` / `max` (it has no stored column).
+- **Designer forms.** The field designer and the object designer's field grid both offer Currency as a return type. The field designer shows its Currency Config row for a formula whose return type is Currency, as it does for a currency field.
+- **What is new in `@objectstack/formula`.** `inferFormulaReturn(expression, fields)` returns the declaration authoring stamps onto a formula field, judged over the host object's declared field map: `{ returnType: 'currency' }` when the expression is provably an amount of money, plus `currencyConfig: { currencyMode: 'fixed', defaultCurrency }` when its source amounts are in one fixed currency. "Provably money" is unit checking over the expression: amounts in one currency added, subtracted, scaled by a number or a percent, divided by a number, rounded, or picked by `min` / `max` / `coalesce` / a ternary. Two different currencies, an amount multiplied by an amount, or an amount plus a plain quantity are not money. For everything it cannot prove to be money it answers exactly what `inferExpressionType` answers, so a numeric formula stays `number`. Its types `FormulaReturnDeclaration` and `FormulaSourceField` are exported with it. `inferExpressionType` is unchanged.
+- **`@objectstack/platform-objects`.** The designer help text for the return type and the currency config rows names the currency result, in all four locales.
+- **Nothing to migrate.** Every value accepted before is accepted now. To declare a formula over money as money, declare `returnType: 'currency'` and copy the source currency field's `currencyConfig` onto the formula, or run `inferFormulaReturn` and write what it returns.

packages/platform-objects/src/apps/translations/en.metadata-forms.generated.ts

@@ -594,7 +594,7 @@ export const enMetadataForms: NonNullable<TranslationData['metadataForms']> = {
       },
       currencyConfig: {
         label: "Currency Config",
-        helpText: "Which currency this field is in. Unset: dynamic mode. The stored value is a bare number in either mode."
+        helpText: "Which currency this field is in — a currency field, or a formula whose return type is Currency. Unset: dynamic mode. The value is a bare number in either mode."
       },
       "currencyConfig.currencyMode": {
         label: "Currency Mode",
@@ -744,7 +744,7 @@ export const enMetadataForms: NonNullable<TranslationData['metadataForms']> = {
       },
       returnType: {
         label: "Return Type",
-        helpText: "Declared value type of the formula, stamped from the inferred CEL type. Consumers read it instead of re-parsing the expression."
+        helpText: "Declared value type of the formula, stamped from the inferred CEL type. Consumers read it instead of re-parsing the expression. Currency: an amount of money, in the currency the Currency Config of this field declares (dynamic when unset)."
       },
       summaryOperations: {
         label: "Summary Operations",

packages/platform-objects/src/apps/translations/es-ES.metadata-forms.generated.ts

@@ -594,7 +594,7 @@ export const esESMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       currencyConfig: {
         label: "Configuración de moneda",
-        helpText: "En qué moneda está este campo. Sin definir: modo dynamic. En ambos modos el valor almacenado es un número sin más."
+        helpText: "En qué moneda está este campo: un campo de moneda, o una fórmula cuyo tipo de retorno es Moneda. Sin definir: modo dynamic. En ambos modos el valor es un número sin más."
       },
       "currencyConfig.currencyMode": {
         label: "Modo de moneda",
@@ -744,7 +744,7 @@ export const esESMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       returnType: {
         label: "Tipo de retorno",
-        helpText: "Tipo de valor declarado de la fórmula, registrado a partir del tipo CEL inferido. Los consumidores lo leen en vez de volver a analizar la expresión."
+        helpText: "Tipo de valor declarado de la fórmula, registrado a partir del tipo CEL inferido. Los consumidores lo leen en vez de volver a analizar la expresión. Moneda: un importe, en la moneda que declara la configuración de moneda de este campo (dynamic si no se define)."
       },
       summaryOperations: {
         label: "Operaciones de resumen",

packages/platform-objects/src/apps/translations/ja-JP.metadata-forms.generated.ts

@@ -594,7 +594,7 @@ export const jaJPMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       currencyConfig: {
         label: "通貨設定",
-        helpText: "このフィールドの通貨。未設定の場合は dynamic モードです。どちらのモードでも、保存される値は単なる数値です。"
+        helpText: "このフィールドの通貨（通貨フィールド、または戻り値型が「通貨」の数式フィールド）。未設定の場合は dynamic モードです。どちらのモードでも、値は単なる数値です。"
       },
       "currencyConfig.currencyMode": {
         label: "通貨モード",
@@ -744,7 +744,7 @@ export const jaJPMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       returnType: {
         label: "数式の戻り値型",
-        helpText: "数式が宣言する値の型。推論された CEL の型から記録され、利用側は式を解析し直さずにこの値を読みます。"
+        helpText: "数式が宣言する値の型。推論された CEL の型から記録され、利用側は式を解析し直さずにこの値を読みます。通貨：金額で、その通貨はこのフィールドの通貨設定が宣言します（未設定の場合は dynamic）。"
       },
       summaryOperations: {
         label: "集計操作",

packages/platform-objects/src/apps/translations/zh-CN.metadata-forms.generated.ts

@@ -594,7 +594,7 @@ export const zhCNMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       currencyConfig: {
         label: "货币配置",
-        helpText: "此字段使用哪种货币。未设置时为 dynamic 模式。两种模式下存储的值都是一个纯数字。"
+        helpText: "此字段使用哪种货币——货币字段，或返回类型为“货币”的公式字段。未设置时为 dynamic 模式。两种模式下值都是一个纯数字。"
       },
       "currencyConfig.currencyMode": {
         label: "货币模式",
@@ -744,7 +744,7 @@ export const zhCNMetadataForms: NonNullable<TranslationData['metadataForms']> =
       },
       returnType: {
         label: "公式返回类型",
-        helpText: "公式声明的值类型，按推断出的 CEL 类型写入。消费方直接读它，无需重新解析表达式。"
+        helpText: "公式声明的值类型，按推断出的 CEL 类型写入。消费方直接读它，无需重新解析表达式。货币：一笔金额，其货币由此字段的货币配置声明（未设置时为 dynamic）。"
       },
       summaryOperations: {
         label: "汇总操作",