Repository navigation
Commit 9e7824a
docs(spec): currencyMode says what each mode does; the currency-chain text states the fixed condition (#20179)
Part of #20126
Clause-②: no
This PR covers the non-governed sites of the currency-mode class-closure
card. It does not close the card. The remainder is listed at the end:
the Tier H skills site and the enumerating pin.
## What was wrong
`CurrencyConfigSchema` declares two modes. With `currencyMode: 'fixed'`,
the field has one currency, `defaultCurrency`. With `dynamic`, the
default, the field has no currency of its own and shows the tenant
default currency. Every runtime reader follows that rule:
- `packages/spec/src/data/field.zod.ts`: the precision refinement judges
`defaultCurrency` only under `'fixed'`. The `FieldSchema` guidance says
"A field without one uses the tenant default at runtime".
- `packages/services/service-analytics/src/plugin.ts`
(`sourceFieldMeta`): relays `defaultCurrency` only under `'fixed'`, as
landed by the runtime member of this family (#20119).
- objectui's `resolveFieldCurrency`, which the field faces call: reads
`defaultCurrency` only under `'fixed'`. Read from objectui's changeset
`10422-currency-mode-dynamic-tenant-default.md` at its `main`
(`a2f361b`). With no tenant currency set, the amount shows as a plain
number.
Four kinds of text still said otherwise:
1. **The spec describe** (card site 1). It called `dynamic` "user
selectable". No key, stored value or runtime path offers a per-record
currency choice. The value is a bare number (ADR-0104 D1), and the code
lives in field config. The describe ships in the published
`@objectstack/spec` and in the generated
`content/docs/references/data/field.mdx` (2 rows).
2. **`content/docs/api/data-api.mdx`** (card site 3). It named "the
ADR-0053 currency chain" with no mode condition. ADR-0053 is the
date/datetime record and never mentions currency.
3. **service-analytics test text.** Two test files still called the
chain "ADR-0053": the `preview-column-enrichment.test.ts` header table
and two `it` titles, and a `query-dataset.test.ts` section comment. The
#20119 PR noted the test-file labels and left them as they were.
4. **Hand-written `content/docs/**` lines** that taught
`defaultCurrency` without the `fixed` condition. The census is below.
## What changes
- `field.zod.ts`, **`currencyMode` describe only.** It now says what
each mode does. `fixed`: the field has one currency, `defaultCurrency`.
`dynamic` (the default): no field currency, amounts show in the tenant
default (`localization.currency`, or a plain number when that is unset),
and `defaultCurrency` is not read. Neither mode is a per-record choice.
`gen:docs` regenerated the two `field.mdx` rows. No key, value, default
or parse output changes. `.changeset/20126-currency-mode-describe.md` is
an `@objectstack/spec` patch.
- **`data-api.mdx`.** The ADR-0053 citation is gone. The callout now
states the chain as it runs: measure `currency`, then the source field's
`currencyConfig.defaultCurrency` only when that field is `currencyMode:
'fixed'`, then the tenant default. It also says where the chain runs. It
runs on the dataset query (`POST /analytics/dataset/query`). The cube
query this page documents (`POST /analytics/query`) mints no column
`currency`, and `currency-mode-relay.test.ts` pins that cube-face fact.
- **service-analytics, comments and test titles only.** The header table
row, the two `it` titles, one in-test comment ("no field default" now
reads "no fixed field currency") and the `query-dataset.test.ts` section
comment now describe the chain with the fixed condition. The old
ADR-0053 label is gone. No assertion or runtime line changes.
- **Census fixes** (table below): `validation-rules.mdx`,
`common-patterns.mdx` and `protocol/objectql/types.mdx`.
## Census: every hand-written `content/docs` line naming
`defaultCurrency` (at base `84880f9`)
Rule, from the card: the line must also carry `fixed`, or say it is not
the displayed currency under `dynamic`. The census covers 13 lines, the
same per-file counts the dispatch named (3 / 4 / 1 / 2 / 3). `releases/`
is never edited.
| file:line | verdict | why |
|:---|:---|:---|
| `data-modeling/field-types.mdx:156` | pass | the mode row states
`fixed` and `dynamic` |
| `data-modeling/field-types.mdx:157` | pass | "under `fixed`; not the
displayed currency under `dynamic`" |
| `data-modeling/field-types.mdx:160` | pass | the example carries
`currencyMode: 'fixed'` |
| `data-modeling/fields.mdx:77` | pass | `currencyMode: 'fixed'` line |
| `data-modeling/fields.mdx:79` | pass | "the column's currency under
'fixed'" |
| `data-modeling/fields.mdx:86` | pass | "not the displayed currency"
under `dynamic` |
| `data-modeling/fields.mdx:87` | pass | "`fixed` pins the column to
`defaultCurrency`" |
| `data-modeling/validation-rules.mdx:156` | changed | "3-character
currency code" with no mode condition. It now adds "the field's currency
under `fixed`; not the displayed currency under `dynamic`" |
| `getting-started/common-patterns.mdx:53` | changed | `{ precision: 2,
defaultCurrency: 'USD' }` has no mode, so it is `dynamic`, and the
budget shows the tenant currency, never USD. Added `currencyMode:
'fixed'` |
| `getting-started/common-patterns.mdx:82` | changed | same, in the
map-format tab |
| `protocol/objectql/types.mdx:297` | changed (line shape) | The YAML
block already carried `currencyMode: fixed` on :296, but this line did
not carry it. Added the comment "the field's currency under fixed" so
the line meets the pin |
| `protocol/objectql/types.mdx:308` | changed | "The currency code lives
once on the field definition (`currencyConfig.defaultCurrency`)" holds
only under `fixed`. It now states both modes |
| `protocol/objectql/types.mdx:315` | pass | carries `fixed`
(`currencyMode: fixed \| dynamic`). Left as it was, because the callout
above now states the condition |
Two more lines in `validation-rules.mdx` sit in the same `currency`
table and belong to the same class, although neither names
`defaultCurrency`:
- `:155`, the `currencyMode` row, repeated card site 1's "`dynamic`
(user-selectable)" wording. It now matches the describe and adds this
page's validation fact: under `fixed`, an authored `precision` must
agree with the currency's ISO 4217 fraction digits.
- `:158` said "The per-record currency **code**", which contradicts
ADR-0104 D1. It now says the code is never stored per record.
Both sit inside a census-hit file and table, and both are mechanical
rewrites in the wording of the accepted #20118 / #20120 pages.
Pin readings after this PR, over the card's own scopes. The census
script ran from the scratchpad and was not committed.
- The `defaultCurrency` line rule over `content/docs/**/*.mdx` (without
`releases/`): 5 failing at base, **0** at head.
- `ADR-0053` within five lines of `currenc`, over `content/docs/**`,
`packages/services/service-analytics/src/**` and `skills/**`: 5 hits at
base (`data-api.mdx:467`,
`preview-column-enrichment.test.ts:51/:282/:288`,
`query-dataset.test.ts:125`) plus the skills site, and **1** at head.
The one left is `skills/objectstack-ui/rules/dashboards.md:308`, which
is the Tier H remainder.
## Tests and gates
All readings below were taken on head `25b085386`. That head is this
branch plus a merge of `main` at `e2c4e125f`, and the merge brought
nothing into this PR's files. Before the gates ran, all 71 package build
tasks passed (`turbo run build --filter='./packages/*'
--filter='./packages/*/*'`, 71/71).
- **Derived gates.** `node scripts/pm/dispatch-gates.mjs --commands
--repo objectstack-ai/objectstack` derived 109 commands. Each was run
and its exit code recorded, and all 109 exit 0. The `--ran`
reconciliation answers: "109 derived, 109 run, 0 NOT-MEASURED, 0 UNRUN".
The derived set includes `check:docs`, `check:generated` (15 of 15
current), `check:api-surface`, `check:authorable-surface`,
`check:doc-authoring`, `check:nul-bytes`, `check:skill-examples`,
`check:dual-build-cjs-loads` and `check:type-check-debt`.
- **Roster gates.** Six roster families keep their roster in a directory
this PR touches, and all six exit 0: `check-changeset-fixed`,
`check:meta-url-spelling`, `check:spec-changes`, `check:authz-resolver`,
`check:error-code-casing` and `check:filter-alias-parity`.
- **This body.** Run against this text, `check-partof-closing-keyword`
exits 0.
- **`@objectstack/spec`.**
- `pnpm --filter @objectstack/spec test`: 540 files, 15820 passed, 2
todo.
- `pnpm --filter @objectstack/spec run typecheck`: exit 0.
- No spec test pins the old describe text. The phrase "user selectable"
appears only in the describe and its generated page.
- **`@objectstack/service-analytics`.**
- `pnpm --filter @objectstack/service-analytics exec vitest run
--maxWorkers=2` on the two edited files: 2 files, 44 tests passed.
- `pnpm --filter @objectstack/service-analytics run typecheck`: exit 0.
- `tsc --listFiles` includes both edited test files (2 hits; the control
`src/plugin.ts` has 1).
- **Lint, narrowed to the 3 touched TypeScript files** (`pnpm lint` over
the whole repo is CI's run):
- `eslint --no-inline-config --format json` exits 0, and the JSON
reports 3 files, 0 errors and 0 warnings.
- `eslint --print-config` puts the files in the linted population, with
5 rules on.
- `eslint.config.mjs` enables no type-aware linting (no
`parserOptions.project`), so a change to these files cannot move a
verdict on any untouched file.
- **No ablation.** The diff changes text only: a describe, docs,
comments and test titles. No assertion or runtime line changes, so no
negative pin exists to ablate.
## Acceptance notes
- **The `defaultCurrency` describe is left as it was.** It reads
"Default or fixed currency code". The claimed surface is the
`currencyMode` describe only. The generated row meets the card's pin,
because it carries `fixed`, and the rewritten `currencyMode` row beside
it now states the condition. "Default" can still read as a dynamic-mode
default. That belongs to this family and is noted for the closure card,
not changed here.
- **More ADR-0053-for-currency sites exist outside the card's pin
scopes.** They are the same family and are not in this PR's claimed
surface:
- `packages/spec/src/contracts/analytics-service.ts:80`: the published
TSDoc on `AnalyticsResult.fields[].currency` reads "ADR-0053 currency
chain … source-field default → tenant default", with no mode condition.
It ships in the `@objectstack/spec` typings.
- `packages/spec/src/data/percent-scale.ts:14`: a comment saying
"mirrors the ADR-0053 currency chain".
- `packages/spec/liveness/dataset.json` (the `currency` row's evidence
text): "the ADR-0053 chain … the source field's `defaultCurrency`".
- The card's pin scopes (`skills/**`, `content/docs/**`,
`service-analytics/src/**`) do not reach `packages/spec/src/**`. These
are noted for the closure card.
- **A strictly line-based pin would go red on semantically correct skill
lines.** `skills/objectstack-data/rules/field-types.md` lines :55, :183,
:184, :191 and :192 were corrected and accepted with #20120. Each states
the condition across a wrapped sentence or a two-line comment, but none
carries `fixed` on its own line. Whoever writes the enumerating pin must
judge a sentence or block, not a single line, or reshape those lines in
the same Tier H PR.
- **`data-api.mdx` makes a wider claim than currency.** The callout says
`label`, `format` and `percentScale` are resolved server-side on this
page's `fields[]`. That is a source read and was not measured. Both cube
strategies push only `name` and `type`
(`native-sql-strategy.ts:1247/:1252`,
`objectql-strategy.ts:1960/:1964`), and the ADR-0021 column enrichment
runs only on `queryDataset`. Only the currency sentence was in scope and
was corrected. Carrier: none, noted and not filed.
- **Three `query-dataset.test.ts` titles are left as they were.** They
say "inherits the field defaultCurrency", "a currency field with no
defaultCurrency" and "wins over the field default". They cite no ADR, so
they are outside the claimed surface. The section comment above them now
says that `sourceFieldMeta().defaultCurrency` is the field's fixed
currency.
## Remainder of #20126 (not in this PR)
- `skills/objectstack-ui/rules/dashboards.md:304`–`:308`: the
unconditioned chain and the ADR-0053 citation. This is Tier H and gets
its own PR, per triage execution note 1.
- The enumerating pin: a test in the owning package, added by whichever
PR closes the last site (no new `check-*` gate). See the line-based
caveat above.
---
_Generated by [Claude
Code](https://claude.ai/code/session_01CiCTczDo7tGhafXjf61dUJ)_
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent cfe2387 commit 9e7824a
9 files changed
Lines changed: 47 additions & 17 deletions
File tree
- .changeset
- content/docs
- api
- data-modeling
- getting-started
- protocol/objectql
- references/data
- packages
- services/service-analytics/src/__tests__
- spec/src/data
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
464 | 464 | | |
465 | 465 | | |
466 | 466 | | |
467 | | - | |
| 467 | + | |
468 | 468 | | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
469 | 477 | | |
470 | 478 | | |
471 | 479 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
155 | | - | |
156 | | - | |
| 155 | + | |
| 156 | + | |
157 | 157 | | |
158 | | - | |
| 158 | + | |
159 | 159 | | |
160 | 160 | | |
161 | 161 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
82 | | - | |
| 82 | + | |
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
294 | 294 | | |
295 | 295 | | |
296 | 296 | | |
297 | | - | |
| 297 | + | |
298 | 298 | | |
299 | 299 | | |
300 | 300 | | |
| |||
305 | 305 | | |
306 | 306 | | |
307 | 307 | | |
308 | | - | |
309 | | - | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
310 | 313 | | |
311 | 314 | | |
312 | 315 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
236 | 236 | | |
237 | 237 | | |
238 | 238 | | |
239 | | - | |
| 239 | + | |
240 | 240 | | |
241 | 241 | | |
242 | 242 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| |||
279 | 279 | | |
280 | 280 | | |
281 | 281 | | |
282 | | - | |
| 282 | + | |
283 | 283 | | |
284 | 284 | | |
285 | 285 | | |
286 | 286 | | |
287 | 287 | | |
288 | | - | |
| 288 | + | |
289 | 289 | | |
290 | | - | |
| 290 | + | |
291 | 291 | | |
292 | 292 | | |
293 | 293 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
125 | | - | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
126 | 129 | | |
127 | 130 | | |
128 | 131 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
436 | 436 | | |
437 | 437 | | |
438 | 438 | | |
439 | | - | |
| 439 | + | |
440 | 440 | | |
441 | 441 | | |
442 | 442 | | |
| |||
0 commit comments