@dforge-core/metadata 0.0.33 → 0.0.34

package/CHANGELOG.md

@@ -7,6 +7,41 @@ and this package adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.34] — 2026-10-06
+
+### Added
+
+- **`registers.schema.json`** for a module's `registers.json`: a register declared once —
+  `kind` (`balance`, `turnover`, `info`, `accounting`), dimensions, resources, journal, an
+  optional `totals` cache — that documents bind to. `entity.schema.json`: an `A` / `L` column
+  binds with `register`, `map`, `headerMap`, `dateField` and `skipPostingWhenEmpty` instead of
+  restating the register.
+- **Register DSL built-ins** in `checkDsl`'s list: `getBalance`, `getTurnover`, `getSlice`,
+  `getAccountBalance`, `getAccountTurnover`, `getCorrespondence`.
+- **`reports.schema.json`:** a report takes `label` (its name: page title, breadcrumb,
+  parameter dialog) beside `description` (what it shows, under the name). Without a label the
+  description is the name, as before; the platform warns about it at pack, validate and
+  install. `ReportDef` gains `label?`.
+- **`reports.schema.json`:** dataset type `R` reads an accounting register over an interval
+  (`register`: `name`, `resource`, `interval`, `columns`, `filter`, `sort`, `rollup`).
+- **Domain-backed module settings and trait fields:** `settings.schema.json` / `SettingDef`
+  and `traits.schema.json` accept `domain`; the domain supplies the type and control, and a
+  trait field naming one may not restate them.
+- **`seed_data.schema.json`:** in `demo-data/`, a value may be a formula
+  (`{ "$f": "…" }`) and a file may `repeat` its records over `@var` `from`..`to`.
+  `SeedDataFile` gains `repeat?`; new `SeedDataRepeat` type.
+
+### Changed
+
+- **`deps.schema.json`:** a contract against a system module (`admin`, `metadata`,
+  `workspace`, `sys-billing`) may declare `"entities": {}` — a pure platform-version gate for
+  a feature that introduced no entity. Against any other module at least one entity is still
+  required.
+- **A bare `domain` code** resolves to the module's own domain, then a tenant-created one —
+  never another module's (`entity.schema.json`, `domains.schema.json` descriptions).
+
+## [0.0.33] — 2026-09-29
+
 ### Changed
 
 - **`translations.schema.json`:** `views.<code>` accepts `desc` (the view description) next

package/dist/dsl/index.js

@@ -782,6 +782,45 @@ var BUILTINS = [
     returns: "object",
     doc: "Load the referenced record for a FK column. Read its fields with `ref.get('field')`."
   },
+  // Register reads. The first argument names a REGISTER (`module_cd.register_cd`,
+  // declared in that module's registers.json) and not an entity, so none of these
+  // carries `entityArg` — entity-code completion there would offer the wrong list.
+  {
+    name: "getBalance",
+    signature: "getBalance(register, dims?, asOf?)",
+    returns: "object",
+    doc: "Balance of an accumulation register per resource. A dimension left out of `dims` is summed over, so passing none gives the register's total. `asOf` reads as of a date instead of now."
+  },
+  {
+    name: "getTurnover",
+    signature: "getTurnover(register, dims, from, to)",
+    returns: "object",
+    doc: "What moved through a register over an interval: `{in, out, net}` per resource. `dims` may be `null` to sum over every dimension; `from` and `to` are both required."
+  },
+  {
+    name: "getSlice",
+    signature: "getSlice(register, dims, onDate?, mode?)",
+    returns: "object | null",
+    doc: "One record of an information register \u2014 the latest on or before `onDate`, or `null` when there is none. Returns the record plus `_period`. Unlike a balance, a dimension may NOT be omitted: a slice is one keyed record, not a sum."
+  },
+  {
+    name: "getAccountBalance",
+    signature: "getAccountBalance(register, account, filter?, asOf?)",
+    returns: "object",
+    doc: "Balance of one account of an accounting register: `{debit, credit, net}` per resource. `filter` narrows by a dimension, or by an analytic kind the ACCOUNT declares \u2014 an analytic takes the key alone, or `{ entity, value }` to name one entity of a kind that is a union of several."
+  },
+  {
+    name: "getAccountTurnover",
+    signature: "getAccountTurnover(register, account, filter, from, to)",
+    returns: "object",
+    doc: "What moved through one account over an interval: `{debit, credit, net}` per resource. `filter` narrows as in `getAccountBalance` and may be `null`; `from` and `to` are both required."
+  },
+  {
+    name: "getCorrespondence",
+    signature: "getCorrespondence(register, debitAccount, creditAccount, filter, from, to)",
+    returns: "object",
+    doc: 'What moved between two accounts over an interval. Needs `lineMode: "compound"` \u2014 a classic register records the other half of an entry as an untied second row and cannot answer this. `filter` narrows by dimensions the two sides share, never by an analytic (an analytic belongs to one account and this read names two).'
+  },
   // Messaging
   {
     name: "error",