You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 735ab76
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/superpowers/plans/2026-10-04-fr-044-plan-3-report-read-routes.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ What the code does that the documents do not say, found while verifying. Each on
49
49
-**The route segment rule is unchanged:** the object name, `snake_case`d, then pluralized (`docs/features/api-contract.md`). No report-specific spelling.
50
50
-**Default physical table-name pluralization is frozen** (1.0.13). This plan derives no physical name.
51
51
-**Routes, DTOs, allowlists, hooks and controllers are reference helpers** (ADR-0034 Amendment 3). TypeScript's ejectable copies under `codegen-ts/src/reference/` change in the same commit as the package generators; `reference-byte-identical.test.ts` holds them together.
52
-
-**No-churn:** a model with no `object.report` produces byte-identical output in every generator and every docs surface, with five exceptions, each a named behaviour change in the [proof table](#no-churn-and-back-compat-proof): the two that open questions 4 and 5 name (a read-only projection with no declared identity and no `id` field, in TypeScript and Python; a decimal in a TypeScript view read schema), and three found during execution (the API docs of a read-only object document only what is generated, in TypeScript, with the matching Python fix ruled and in progress when this was written; a Java filter allowlist of more than ten fields; a Kotlin controller over a decimal or float field).
52
+
-**No-churn:** a model with no `object.report` produces byte-identical output in every generator and every docs surface, with five exceptions, each a named behaviour change in the [proof table](#no-churn-and-back-compat-proof): the two that open questions 4 and 5 name (a read-only projection with no declared identity and no `id` field, in TypeScript and Python; a decimal in a TypeScript view read schema), and three found during execution (the API docs of a read-only object document exactly what is generated: TypeScript pages lose never-generated symbols, Python pages gain the read symbols they lacked; a Java filter allowlist of more than ten fields; a Kotlin controller over a decimal or float field).
53
53
- ADR-0039: read effective properties with resolving accessors. Any `own*()` call carries a comment naming its sanctioned case. Python `attr()` is OWN.
54
54
- TS: named constants for metamodel strings, no `any`, never `instanceof` a node from another package.
55
55
- Public repo: no private project names, no absolute home paths, in code, fixtures, docs or commit messages.
@@ -1148,8 +1148,8 @@ Expected: PASS.
1148
1148
|**Behaviour change 1** (unreleased vocabulary) | A view-backed report now generates code and mounts a route. Nothing released carries `object.report`|
1149
1149
|**Behaviour change 2** (released behaviour, open question 4) | In TypeScript and Python, a read-only projection with **no declared identity and no field named `id`** loses its `/{id}` routes, its by-id query (`find…ById` / `find_by_id`) and, in TypeScript, its detail hook. That shape could not serve a row by key. A projection with a declared identity, or with an `id` field and no declared identity, served rows by key before and is unchanged (ruled during Task 3: `hasItemRoute` / `has_item_route`). C#, Java and Kotlin keep requiring a declared single-column identity. The CHANGELOG names it |
1150
1150
|**Behaviour change 3** (released output, open question 5) | In TypeScript, a decimal field of a view read schema is `z.string()`, not `z.number()`. The runtime value was always a string. The CHANGELOG names it |
1151
-
|**Behaviour change 4** (released docs output, found in Task 5) |In TypeScript (`meta docs` API pages), a read-only object's API unit documents only what is generated (the same fix is ruled for Python's api-docs builder and was in progress when this row was written; the CHANGELOG names Python only once it lands): a read-only projection's page no longer lists create/update/delete functions, write verbs or Insert/Update schemas, and a keyless one no longer lists `/:id`or the by-id function. Write-through projections and entities are unchanged. The CHANGELOG names it|
1152
-
|**Behaviour change 5** (released output, found in Tasks 7 and 8) | Kotlin: the generated Spring controller of any entity or projection with a `field.decimal` or `field.float` scalar fieldregenerates with different bytes (`coerce<E>Decimal` / `coerce<E>Float` in place of `coerce<E>Double`), because a filter on such a column threw `ClassCastException` (a 500). A TPH controller changes for a float field only. Models with only double, int, long or string fields keep their bytes. Java: a filter allowlist of more than ten fields is spelled with `Map.ofEntries` (it did not compile before); ten or fewer keep their bytes. The CHANGELOG names both |
1151
+
|**Behaviour change 4** (released docs output, found in Task 5) |A read-only object's API unit documents exactly what is generated, and the two ports move in opposite directions. **TypeScript** (`meta docs` API pages): a read-only projection's page LOSES create/update/delete functions, write verbs and Insert/Update schemas that were never generated, and a keyless one loses `/:id`and the by-id function. **Python** (the api-docs builder): a read-only projection's unit had only its model symbol and GAINS the repository seam, `GET <path>`, `GET <path>/{id}` only when it has an item route, and the filter allowlist; never a write verb. A served report's unit uses the same helper. Entities and write-through objects are unchanged in both. The CHANGELOG names each|
1152
+
|**Behaviour change 5** (released output, found in Tasks 7 and 8) | Kotlin: the generated Spring controller (writable, write-through and read-only: projection or report) of any object with a `field.decimal` or `field.float` scalar field, filterable or not, regenerates with different bytes (`coerce<E>Decimal` / `coerce<E>Float` in place of `coerce<E>Double`), because a filter on such a column threw `ClassCastException` (a 500). A TPH controller changes for a `field.float`only, on the base or a subtype (decimals are excluded from the TPH filter list). `field.double` is unchanged. Java: a filter allowlist of more than ten fields is spelled with `Map.ofEntries` (it did not compile before); ten or fewer keep their bytes. The CHANGELOG names both |
1153
1153
1154
1154
## Unverified items
1155
1155
@@ -1189,8 +1189,8 @@ What execution changed or added, beyond the answers above. The tables and tasks
1189
1189
-**A. No UI tier for a report (answer 6).** TypeScript gates the UI tier (the TanStack generators and the source-only Angular generators) on a new `servesClientTier` predicate, while `servesReadApi` is true for a served report. `agent/ui.md` lists no report. An adopter-owned (ejected) hook generator that still gates on `servesReadApi` would emit for a report; the CHANGELOG tells owners to switch to `servesClientTier`.
1190
1190
-**B. The item-route rule (answer 4).** TypeScript `hasItemRoute` and Python `has_item_route`: false for every report; otherwise true when the by-id column exists on the object (a declared primary identity, or no identity and a field named `id`); false otherwise. Only a read-only projection with no identity and no `id` field loses its `/{id}` routes, by-id query and, in TypeScript, its detail hook. This differs from C#, Java and Kotlin, which require a declared single-column identity and are unchanged.
1191
1191
-**C. Decimal (answer 5).** A `field.decimal` in a TypeScript view read schema is `z.string()`, for reports and projections.
1192
-
-**D. API docs accuracy (new, behaviour change 4).**In TypeScript a read-only object's API unit documents only what is generated. The same fix is ruled for Python and was in progress when this note was written.
1193
-
-**E. Per-port fixes found on the way.** C#: a report's enum dimension is sortable (report-only; an entity's enum field is still not sortable in C#). Java: the filter-allowlist generator handles more than ten filterable fields (`Map.ofEntries`). Kotlin: a filter on a decimal or float column no longer throws, which changes the generated controller of any entity or projection with such a field (behaviour change 5); reads of a field whose name needs `safeColumnProperty` compile, byte-neutral for every other name.
1192
+
-**D. API docs accuracy (new, behaviour change 4).**A read-only object's API unit documents exactly what is generated. In TypeScript a read-only projection's page loses the write and (when keyless) by-id symbols that were never generated. In Python a read-only projection's unit, which had only its model symbol, gains the repository seam, `GET <path>`, `GET <path>/{id}`when it has an item route, and the filter allowlist.
1193
+
-**E. Per-port fixes found on the way.** C#: a report's enum dimension is sortable (report-only; an entity's enum field is still not sortable in C#). Java: the filter-allowlist generator handles more than ten filterable fields (`Map.ofEntries`). Kotlin: a filter on a decimal or float column no longer throws, which changes the generated controller of any object with such a field, filterable or not, and of a TPH base for a float only (behaviour change 5); reads of a field whose name needs `safeColumnProperty` compile, byte-neutral for every other name.
1194
1194
-**Requirements ledger (Task 10 Step 5).** Nothing moved. No entry of `metaobjects/meta.requirements.yaml` is about serving a report: `objectReport` and the `reporting` branch describe declaring the vocabulary, and the ledger carries no `@implementedBy` on any node by design.
0 commit comments