@dforge-core/metadata 0.0.34 → 0.0.36

package/schemas/entity.schema.json

@@ -114,7 +114,24 @@
 		},
 		"indexes": {
 			"type": "object",
-			"description": "Database index definitions"
+			"description": "Database indexes, keyed by index name (the Postgres index name). A register's journal and state tables need none declared: the platform builds the indexes its own reads and writes use.",
+			"additionalProperties": {
+				"type": "object",
+				"required": ["fields"],
+				"additionalProperties": false,
+				"properties": {
+					"fields": {
+						"type": "array",
+						"minItems": 1,
+						"items": { "type": "string" },
+						"description": "Indexed columns, in order. Install refuses any key other than fields and using - \"columns\", which a unique constraint accepts, included."
+					},
+					"using": {
+						"enum": ["btree", "hash", "gin", "gist", "brin"],
+						"description": "Index method. Omitted, btree."
+					}
+				}
+			}
 		},
 		"numberSequence": {
 			"$ref": "#/$defs/numberSequence",
@@ -242,9 +259,11 @@
 				"lineField": { "type": "string", "description": "The line's foreign-key column(s) to the header, comma-separated in the header's key order for a composite key." },
 				"stateField": { "type": "string", "description": "The bool column that records the posted state, when it is not the registry column itself. Written only by the register engine." },
 				"register": { "type": "string", "description": "The register this column posts to, as 'module_cd.register_cd' (declared in that module's registers.json). Binding to one replaces restating what the register is: the declaration supplies the state entity, dimensions, resources, journal, allowNegative and autoCreate, and this column keeps only what legitimately differs per writer — direction/sign, 'map' and 'dateField'." },
-				"map": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Register dimension or resource name -> this document's column carrying it. Every resource the register declares must be mapped (install refuses otherwise); a dimension left out binds to a column of the same name. Only meaningful with 'register'. On an accumulation (A) column a value may be a one-hop reference path, '<reference column>.<target column>', read through the reference at posting time (off the line when the binding posts from lines)." },
-				"headerMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Register dimension or resource name -> this DOCUMENT's column carrying it, for a binding that posts from LINES. A line binding reads every other value off the line, and a dimension that belongs to the document (a dealer, an organisation, a date) cannot be put on the line: a G column is a same-row expression or an aggregate over a child set, so it cannot read a parent. Explicit rather than a fallback, because 'not on the line, try the header' turns a typo into a silent read of an unrelated header column with the same name. Install refuses: a name on neither table, a field also named in 'map', a column also read off the line by 'map', a column that is part of the line's key, a column 'lockedFields' does not freeze (the posting is keyed by it, so it has to hold still while the document is posted), and a RESOURCE unless the register is 'info' (a quantity from the document would be added once per line; an information register's records replace rather than add). A value may be a one-hop reference path off the document, whose reference key column 'lockedFields' must then freeze." },
-				"dateField": { "type": "string", "description": "This document's date column, supplying the date the register stamps on each journal row. Required once the register declares a 'journalDate' — one writer that supplied none would make every balance read as of a date quietly short, across all writers. On an accumulation (A) column it may be a one-hop reference path, '<reference column>.<target column>'." },
+				"map": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Register dimension or resource name -> this document's column carrying it. Every resource the register declares must be mapped (install refuses otherwise); a dimension left out binds to a column of the same name. Only meaningful with 'register'. On an accumulation (A) column a value may be a one-hop reference path, '<reference column>.<target column>', read through the reference at posting time (off the line when the binding posts from lines), or an expression: a string starting with '=' holding an F-column formula over the same row with one-hop reference reads — \"=COALESCE([transit_warehouse_id], [dest_warehouse_id])\"." },
+				"headerMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Register dimension or resource name -> this DOCUMENT's column carrying it, for a binding that posts from LINES. A line binding reads every other value off the line, and a dimension that belongs to the document (a dealer, an organisation, a date) cannot be put on the line: a G column is a same-row expression or an aggregate over a child set, so it cannot read a parent. Explicit rather than a fallback, because 'not on the line, try the header' turns a typo into a silent read of an unrelated header column with the same name. Install refuses: a name on neither table, a field also named in 'map', a column also read off the line by 'map', a column that is part of the line's key, a column 'lockedFields' does not freeze (the posting is keyed by it, so it has to hold still while the document is posted), and a RESOURCE unless the register is 'info' (a quantity from the document would be added once per line; an information register's records replace rather than add). A value may be a one-hop reference path off the document, whose reference key column 'lockedFields' must then freeze, or an expression over the document ('=...', see 'map')." },
+				"groupLinesBy": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true, "description": "Line columns whose distinct values each post ONE movement, instead of one per line — a production report posting 'this unit worked today' once per unit with a count of 1. 'map' is then read over a group row: the grouped line columns, every column of the document, and one-hop reads through a reference of either, so an expression may mix the document and the group key. A quoted constant is stamped once per group; a numeric line column mapped to a resource is summed over the group. Install refuses: a binding that posts from the document, an L column, a grouped column the line does not store or 'lockedLineFields' does not freeze, a line column read that is neither grouped nor a summed resource, a non-numeric summed resource, a column both grouped and summed, an ungrouped line resource on an 'info' register, a name both the line and the document carry, and a document column read that 'lockedFields' does not freeze. Accumulation (A) columns only." },
+				"dateField": { "type": "string", "description": "This document's date column, supplying the date the register stamps on each journal row. Required once the register declares a 'journalDate' — one writer that supplied none would make every balance read as of a date quietly short, across all writers. On an accumulation (A) column it may be a one-hop reference path, '<reference column>.<target column>', or an expression over the document ('=...', see 'map')." },
+				"dateTrunc": { "type": "string", "enum": ["day", "month", "year"], "description": "Takes the date 'dateField' supplies back to the start of its day, month or year before the register stamps it — for a document that carries a time while the register's records sit on whole days. The calendar is the value's as stored; no time zone is applied. Needs 'dateField'. Accumulation (A) columns only." },
 				"skipPostingWhenEmpty": { "type": "array", "items": { "type": "string" }, "description": "THE EXCEPTION, not the normal way to model this — read the guide before declaring it. Register dimensions (by the register's names) whose empty value means THIS POSTING records nothing: the line, or the document when the binding posts from the document. One posting is skipped, never the register and never the document. When that is all the document would have recorded it is left unposted to this register, and the flag is per binding, so its other registers post as usual. An empty dimension NOT listed refuses the posting, naming the row and the dimension. It leaves a document fully posted while some of its lines produced no movement, which usually means the document is modelling two kinds of line in one table: since 'lineEntity' is declared per BINDING, prefer giving each register its own line table (goods lines post to stock, service lines do not) so that every line of each table posts. Declare this only when the distinction is not structural but lives in the data — a batch or serial number filled on some rows and not others — so there is no second table to put those rows in. Accumulation (A) columns only. Formerly skipWhenNull: a package using the old name is refused at install, while a tenant's already-stored params keep being read under it." },
 				"periodEntity": { "type": "string", "description": "Period entity this registry closes against — one of this module's, or 'module.entity' from a dependency." },
 				"periodDateField": { "type": "string", "description": "Header date column that resolves the period." },
@@ -253,6 +272,8 @@
 			},
 			"dependencies": {
 				"headerMap": ["lineEntity"],
+				"groupLinesBy": ["lineEntity"],
+				"dateTrunc": ["dateField"],
 				"lineEntity": ["lineField", "lockedLineFields"],
 				"lineField": ["lineEntity"],
 				"lockedLineFields": ["lineEntity"],

package/schemas/registers.schema.json

@@ -19,7 +19,7 @@
 				"then": {
 					"required": ["entity"],
 					"properties": {
-						"period": false, "recorder": false,
+						"period": false, "recorder": false, "recordChangesOnly": false,
 						"chart": false, "composition": false, "analyticFields": false, "lineMode": false,
 						"account": false,
 						"debitAccount": false, "creditAccount": false,
@@ -36,7 +36,7 @@
 					"properties": {
 						"entity": false,
 						"period": false,
-						"recorder": false,
+						"recorder": false, "recordChangesOnly": false,
 						"chart": false, "composition": false, "analyticFields": false, "lineMode": false,
 						"account": false,
 						"debitAccount": false, "creditAccount": false,
@@ -76,7 +76,7 @@
 					"properties": {
 						"entity": false,
 						"period": false,
-						"recorder": false,
+						"recorder": false, "recordChangesOnly": false,
 						"journalDirection": false,
 						"allowNegative": false,
 						"autoCreate": false
@@ -106,7 +106,7 @@
 							}
 						}
 					],
-					"description": "An accounting register keys its postings by an account, not by a dimension tuple it declares once. What analytics a posting carries, and what each one MEANS, is a property of the account: measured on a production chart of 468 accounts, the analytic count runs 0 to 4 and slot 2 is Nomenclature on one account and Contracts on another. So the chart and the per-account composition are part of the declaration, and 'entity' \u2014 one row per dimension tuple \u2014 has nothing to name."
+					"description": "An accounting register keys its postings by an account, not by a dimension tuple it declares once. What analytics a posting carries, and what each one MEANS, is a property of the account: the analytic count differs from account to account, and slot 2 may be Nomenclature on one account and Contracts on another. So the chart and the per-account composition are part of the declaration, and 'entity' \u2014 one row per dimension tuple \u2014 has nothing to name."
 				}
 			}
 			,
@@ -146,6 +146,11 @@
 				"enum": ["balance", "turnover", "info", "accounting"],
 				"description": "Register kind. 'balance' keeps a running state per dimension tuple (1C регистр накопления / остатки); 'turnover' keeps none and answers only for intervals (1C регистр накопления / обороты), the majority of accumulation registers in practice; 'info' holds values that change over time, or a plain keyed lookup when it declares no period (1C регистр сведений). 'accounting' keys its postings by an account whose analytics the CHART declares, per account, because what an analytic slot means depends on the account it is on. Both of its line modes are posted and read."
 			},
+			"label": {
+				"type": "string",
+				"maxLength": 200,
+				"description": "Display name, shown wherever the register is offered beside entities (the query builder's From picker). Localized under the translation files' registers.<code>.label. The register code when omitted."
+			},
 			"description": {
 				"type": "string",
 				"maxLength": 500,
@@ -192,12 +197,12 @@
 					"accountField": {
 						"type": "string",
 						"pattern": "^[a-z_][a-z0-9_]*$",
-						"description": "Column on the totals entity holding the account a cached row belongs to. Required on an 'accounting' register and refused on every other kind: an accounting register is read per account, so that is what its cache is keyed by, and a compound posting names TWO accounts and folds into two cached rows — one per side, each taking that side's column of every two-sided dimension — so which column holds the one cannot be derived. The analytics are NOT in the key: measured on the base this is ported from, 24.3M postings carry 99.8M analytic rows, so the analytics are where the cardinality is and a cache keyed by them would be about as large as what it summarises. A read that narrows by an analytic goes to the postings, as a read of a part-period goes to them for its edges."
+						"description": "Column on the totals entity holding the account a cached row belongs to. Required on an 'accounting' register and refused on every other kind: an accounting register is read per account, so that is what its cache is keyed by, and a compound posting names TWO accounts and folds into two cached rows — one per side, each taking that side's column of every two-sided dimension — so which column holds the one cannot be derived. The analytics are NOT in the key: a posting typically carries several analytic values, so the analytics are where the cardinality is and a cache keyed by them would be about as large as what it summarises. A read that narrows by an analytic goes to the postings, as a read of a part-period goes to them for its edges."
 					},
 					"dimensions": {
 						"type": "array",
 						"items": { "type": "string", "pattern": "^[a-z_][a-z0-9_]*$" },
-						"description": "Which of the register's dimensions the cache is grouped by; omitted, it is all of them. Only on an 'accounting' register. What it is for is a dimension a posting may legitimately leave empty — a two-sided one, where the measured original fills a currency only for the accounts that keep one. A cached row's key holds no NULL, so install refuses a cached dimension whose posting column is nullable, naming the two ways out: make the column mandatory, or leave the dimension out here and let the cache sum across it. A read that narrows by an uncached dimension goes to the postings."
+						"description": "Which of the register's dimensions the cache is grouped by; omitted, it is all of them. Only on an 'accounting' register. What it is for is a dimension a posting may legitimately leave empty — a two-sided one, such as a currency filled only for the accounts that keep one. A cached row's key holds no NULL, so install refuses a cached dimension whose posting column is nullable, naming the two ways out: make the column mandatory, or leave the dimension out here and let the cache sum across it. A read that narrows by an uncached dimension goes to the postings."
 					},
 					"resources": {
 						"type": "object",
@@ -239,12 +244,17 @@
 			"period": {
 				"type": "string",
 				"pattern": "^[a-z_][a-z0-9_]*$",
-				"description": "Column on an information register's entity holding the moment each record takes effect. Declaring it makes the register periodic, and 'the value as of a date' becomes the last record at or before it. Omit it for a plain keyed lookup with no history \u2014 121 of the 285 information registers in the 1C base measured for this design are of that shape, so it is the common case rather than a degenerate one. Only valid on 'info'."
+				"description": "Column on an information register's entity holding the moment each record takes effect. Declaring it makes the register periodic, and 'the value as of a date' becomes the last record at or before it. Omit it for a plain keyed lookup with no history \u2014 many information registers are of that shape, so it is a common case rather than a degenerate one. Only valid on 'info'."
 			},
 			"recorder": {
 				"type": "string",
 				"pattern": "^[a-z_][a-z0-9_]*$",
-				"description": "Column on an information register's entity where the platform stamps which document wrote each record \u2014 the same jsonb 'source' shape a journal row carries, holding { entity, pk, line, postedBy }. Declaring it makes the register SUBORDINATE to a document: an A column binds to it, posting writes its records, unposting deletes them, and the register's rows stop being something a user maintains. Omit it for an independent register, whose records are written by ordinary means. The split is not a nuance: measured on the 1C base this design is ported from, 115 of the 285 information registers are subordinate and hold 15.7M of the 20.8M rows, and no register is ever both. Only valid on 'info'."
+				"description": "Column on an information register's entity where the platform stamps which document wrote each record \u2014 the same jsonb 'source' shape a journal row carries, holding { entity, pk, line, postedBy }. Declaring it makes the register SUBORDINATE to a document: an A column binds to it, posting writes its records, unposting deletes them, and the register's rows stop being something a user maintains. Omit it for an independent register, whose records are written by ordinary means. The split is not a nuance: subordinate registers tend to hold most of the rows, and no register is ever both. Only valid on 'info'."
+			},
+			"recordChangesOnly": {
+				"type": "boolean",
+				"default": false,
+				"description": "Posting skips a record whose resources all equal the slice in effect on its period for the same dimensions: a document setting a value that is already so writes nothing, and still posts. A property of the register rather than of any writer, because the answer is in the register. Only valid on an 'info' register that declares a 'recorder'. A resource's 'absentAs' says what it compares as before anything is in effect; without it the first record is always written. 1C posting handlers commonly do the same, comparing the new value with the slice and an absent one as zero."
 			},
 			"chart": {
 				"type": "string",
@@ -268,7 +278,7 @@
 					"slot": {
 						"type": "string",
 						"pattern": "^[a-z_][a-z0-9_]*$",
-						"description": "Column holding the slot number: WHICH of the posting's analytic columns this analytic is written into. Positional storage is what the measured base's totals tables use, and it is available because the fill is dense \u2014 an unset analytic is written explicitly rather than omitted, so the declared count and the written count matched exactly across 348,227 analytic sets."
+						"description": "Column holding the slot number: WHICH of the posting's analytic columns this analytic is written into. Positional storage is what 1C's totals tables use, and it is available because the fill is dense \u2014 an unset analytic is written explicitly rather than omitted, so the declared count and the written count match exactly."
 					},
 					"analytic": {
 						"type": "string",
@@ -313,7 +323,7 @@
 				"minProperties": 1,
 				"maxProperties": 8,
 				"propertyNames": { "pattern": "^[a-z_][a-z0-9_]*$" },
-				"description": "Dimensions that are TWO-SIDED, with the posting column for each side. Measured on the base this design is ported from, one accounting register keeps Организация shared and splits Валюта and НалоговоеНазначение per side, while a second register in the same base splits one of its two \u2014 so which dimensions split is a property of the declaration and not of the mode. A dimension left in 'dimensions' stays shared: one column for the whole row. Only valid on a compound register.",
+				"description": "Dimensions that are TWO-SIDED, with the posting column for each side. One accounting register may keep the organisation shared and split the currency and tax purpose per side, while another splits only one of them \u2014 so which dimensions split is a property of the declaration and not of the mode. A dimension left in 'dimensions' stays shared: one column for the whole row. Only valid on a compound register.",
 				"additionalProperties": {
 					"type": "object",
 					"required": ["debitField", "creditField"],
@@ -338,7 +348,7 @@
 				"maxItems": 8,
 				"uniqueItems": true,
 				"items": { "type": "string", "pattern": "^[a-z_][a-z0-9_]*$" },
-				"description": "The posting entity's analytic slot columns, in slot order: slot 1 is written into the first, slot 2 into the second. Each is a jsonb entity link, because an analytic's value is a UNION \u2014 one kind in the measured base resolves to three different document types in the same column, which a 'link' naming one entity cannot type. The length of this array is how many analytics a posting can carry; an account declaring more than that is refused when it posts, not at install, because the platform does not parse a check constraint's expression. Only valid on 'accounting'."
+				"description": "The posting entity's analytic slot columns, in slot order: slot 1 is written into the first, slot 2 into the second. Each is a jsonb entity link, because an analytic's value is a UNION \u2014 one kind may resolve to several different document types in the same column, which a 'link' naming one entity cannot type. The length of this array is how many analytics a posting can carry; an account declaring more than that is refused when it posts, not at install, because the platform does not parse a check constraint's expression. Only valid on 'accounting'."
 			},
 			"lineMode": {
 				"type": "string",
@@ -373,7 +383,7 @@
 						"debitField": {
 							"type": "string",
 							"pattern": "^[a-z_][a-z0-9_]*$",
-							"description": "On an accounting register, the posting column holding this resource's debit side. Declared with 'creditField' and instead of 'field'. Measured on the base this design is ported from, its postings carry one shared amount plus three split by side, and a second accounting register in the same base splits differently again \u2014 so splitting is a property of the resource rather than of the kind. WHAT THE PAIR MEANS DEPENDS ON 'lineMode', which is mandatory, so exactly one reading applies at a time. Under 'classic' a row is one account on one side, so these are where the amount goes when the row is a debit or a credit and exactly one carries a value. Under 'compound' they are the debited side's value and the credited side's value of one resource on one row, and both may carry one \u2014 a currency amount whose two sides are in different currencies is two different numbers, which is why the pair exists at all."
+							"description": "On an accounting register, the posting column holding this resource's debit side. Declared with 'creditField' and instead of 'field'. One register's postings may carry one shared amount plus several split by side, and another register split differently again \u2014 so splitting is a property of the resource rather than of the kind. WHAT THE PAIR MEANS DEPENDS ON 'lineMode', which is mandatory, so exactly one reading applies at a time. Under 'classic' a row is one account on one side, so these are where the amount goes when the row is a debit or a credit and exactly one carries a value. Under 'compound' they are the debited side's value and the credited side's value of one resource on one row, and both may carry one \u2014 a currency amount whose two sides are in different currencies is two different numbers, which is why the pair exists at all."
 						},
 						"creditField": {
 							"type": "string",
@@ -385,6 +395,10 @@
 							"pattern": "^[a-z_][a-z0-9_]*$",
 							"description": "Column this resource accumulates into — on the state entity for a 'balance' register, on the journal for a 'turnover' one. On a COMPOUND accounting register it is the natural form: one row, one amount, this account debited and that one credited. A CLASSIC one refuses it, because a one-sided row carrying a shared column would hold an amount with nothing to say which side it fell on."
 						},
+						"absentAs": {
+							"type": ["number", "string", "boolean"],
+							"description": "Under the register's 'recordChangesOnly': what this resource compares as when no record is in effect yet, or the one in effect holds nothing. A number, a boolean or a string, read as the resource column's type. Omit it and an absent slice differs from every value, so the first record is always written; declare 0 to treat a first value of 0 as no change, as 1C does with ЕСТЬNULL(…, 0)."
+						},
 						"required": {
 							"type": "boolean",
 							"default": true,
@@ -397,7 +411,7 @@
 					},
 					"additionalProperties": false
 				},
-				"description": "The register's measured columns, keyed by resource name \u2014 what it accumulates ('balance', 'turnover') or what a slice of it returns ('info'), as opposed to the dimensions that key it. A binding maps a document column to each resource the register marks required. The 64 bound is generous because an 'info' register's resources are VALUES rather than quantities, and a register of settings legitimately carries dozens: measured on a base being ported, one register holding who signs which customs paper carries 28 \u2014 a post and a name per document kind, in two languages, for two factories \u2014 and its one reader names all 28. An accumulation register wanting more than a handful is usually several registers."
+				"description": "The register's measured columns, keyed by resource name \u2014 what it accumulates ('balance', 'turnover') or what a slice of it returns ('info'), as opposed to the dimensions that key it. A binding maps a document column to each resource the register marks required. The 64 bound is generous because an 'info' register's resources are VALUES rather than quantities, and a register of settings legitimately carries dozens \u2014 one holding who signs which document may carry a post and a name per document kind, in several languages, for several sites. An accumulation register wanting more than a handful is usually several registers."
 			},
 			"allowNegative": {
 				"type": "boolean",

package/schemas/stored_procedures.schema.json

@@ -117,9 +117,32 @@
 					"type": "object",
 					"description": "Control parameters, the same shape an entity column's `params` takes — `options` for a dropdown or flags, `currency`, `align`, and so on.",
 					"additionalProperties": true
+				},
+				"domain": {
+					"type": "string",
+					"description": "Reference to a reusable column domain. Unqualified resolves within this module, then tenant-created domains; 'module_cd.domain_cd' binds to that module. The domain supplies the control, datatype and option list — and its options are translated once, for every consumer."
 				}
 			},
-			"additionalProperties": false
+			"additionalProperties": false,
+			"oneOf": [
+				{
+					"title": "Domain-backed result column",
+					"description": "Defers to a column domain. Must not restate what the domain owns.",
+					"required": ["domain"],
+					"properties": {
+						"fieldTypeCd": false,
+						"baseDatatypeCd": false,
+						"params": false
+					}
+				},
+				{
+					"title": "Inline result column",
+					"description": "Declares its own control and datatype.",
+					"properties": {
+						"domain": false
+					}
+				}
+			]
 		}
 	}
 }

package/schemas/translations.schema.json

@@ -58,6 +58,13 @@
 				"$ref": "#/$defs/labelOnly"
 			}
 		},
+		"registers": {
+			"type": "object",
+			"description": "Register code (as registers.json keys it) → label and description.",
+			"additionalProperties": {
+				"$ref": "#/$defs/labelDesc"
+			}
+		},
 		"reports": {
 			"type": "object",
 			"description": "Report code → label, dataset captions and parameter labels.",

package/src/index.ts

@@ -6,8 +6,10 @@
 //     from a friendly field-type choice;
 //   • structural types — the authoring shape of every module-package file
 //     (manifest, entities, data views, reports, stored procedures, menus, folders,
-//     roles, settings, jobs, triggers, webhooks, print templates, seed data, translations,
-//     actions, diagrams), mirrored from the JSON schemas under docs/schemas/.
+//     roles, settings, registers, jobs, triggers, webhooks, print templates, seed data,
+//     translations, actions, diagrams), mirrored from the JSON schemas under docs/schemas/;
+//   • shared rules — the action-DSL analyzer (./dsl) and the register checks
+//     (checkRegisters / checkRegisterBinding), run by editors and validators alike.
 //
 // No runtime dependencies; safe to import from editors, the web app, the CLI,
 // the MCP server and the VS Code extension.
@@ -131,6 +133,37 @@ export type {
 	TranslatedWithOptions,
 } from "./translations";
 export type { SettingsFile, SettingDef, SettingBaseDatatype } from "./settings";
+export {
+	REGISTER_KINDS,
+	REGISTER_CODE,
+	REGISTER_COLUMN_NAME,
+	REGISTER_TOTALS_PERIODS,
+	isRegisterKind,
+	isPlainColumnRef,
+	registerDimensions,
+	registerResources,
+	registerCarrier,
+	registerResourceShape,
+	registerLineMode,
+	registerRefusedProps,
+	registerRequiredProps,
+	checkRegister,
+	checkRegisters,
+	checkRegisterBinding,
+	type RegisterKind,
+	type RegisterDef,
+	type RegistersFile,
+	type RegisterResourceDef,
+	type RegisterTotalsDef,
+	type RegisterTotalsPeriod,
+	type RegisterCompositionDef,
+	type RegisterBindingParams,
+	type RegisterMapValue,
+	type RegisterBindingTarget,
+	type RegisterIssue,
+	type RegisterEntityInfo,
+	type RegisterEntityLookup,
+} from "./registers";
 export type { JobsFile, JobDef } from "./jobs";
 export type { TriggersFile, TriggerDef, EntityEvent } from "./triggers";
 export type { WebhooksFile, WebhookSubscription, WebhookPayload } from "./webhooks";

package/src/registers/check-binding.ts

@@ -0,0 +1,233 @@
+// Checking an A / L column's `params` against the register it binds.
+
+import { createIssueReporter } from "./issues";
+import type { RegisterIssue, RegisterReporter } from "./issues";
+import { hasKey, isRecord, registerResourceShape, safeTrim, stringList } from "./read";
+import type { Raw } from "./read";
+import type { RegisterDef } from "./types";
+
+/** What a binding is checked against: the parts of a declaration it has to agree with. */
+export type RegisterBindingTarget = Pick<RegisterDef, "kind" | "dimensions" | "resources" | "recorder" | "lineMode" | "sideDimensions">;
+
+/** A reference path (`ref.column`), an expression (`=…`) or a quoted constant — not a plain column. */
+export const isPlainColumnRef = (value: string): boolean => !value.startsWith("=") && !value.startsWith("'") && !value.includes(".");
+
+interface BindingContext {
+	params: Raw;
+	register: RegisterBindingTarget;
+	qualified: string;
+	ledger: boolean;
+	error: RegisterReporter;
+}
+
+function checkPosting(params: Raw, ledger: boolean, error: RegisterReporter): void {
+	const lineEntity = safeTrim(params.lineEntity);
+	const locked = stringList(params.lockedFields);
+	const lockedLines = stringList(params.lockedLineFields);
+
+	if (!Array.isArray(params.lockedFields) || locked.length === 0) {
+		error(["lockedFields"], "register-locked-fields", "'lockedFields' is required: the document columns frozen while posted (or [\"*\"] for the whole row).");
+	}
+	if (lineEntity) {
+		if (!safeTrim(params.lineField)) {
+			error(["lineField"], "register-line", "A line posting needs 'lineField' — the line's key to the document.");
+		}
+		if (!Array.isArray(params.lockedLineFields) || lockedLines.length === 0) {
+			error(["lockedLineFields"], "register-locked-fields", "A line posting needs 'lockedLineFields' (or [\"*\"]).");
+		}
+	} else {
+		if (hasKey(params, "lineField")) {
+			error(["lineField"], "register-line", "'lineField' needs a 'lineEntity'.");
+		}
+		if (hasKey(params, "lockedLineFields")) {
+			error(["lockedLineFields"], "register-line", "'lockedLineFields' is for a line posting — name the 'lineEntity'.");
+		}
+		if (hasKey(params, "headerMap")) {
+			error(["headerMap"], "register-header-map", "'headerMap' is for a binding that posts from lines; a document posting reads every value from the document already.");
+		}
+		if (hasKey(params, "groupLinesBy")) {
+			error(["groupLinesBy"], "register-group-lines", "'groupLinesBy' needs lines to group — name the 'lineEntity'.");
+		}
+	}
+	if (ledger) {
+		if (!lineEntity) {
+			error(["lineEntity"], "register-line", "An L column posts lines: 'lineEntity' and 'lineField' are required.");
+		}
+		for (const key of ["headerMap", "skipPostingWhenEmpty", "dateTrunc", "groupLinesBy"]) {
+			if (hasKey(params, key)) {
+				error([key], "register-ledger-only", `'${key}' is read by A columns only.`);
+			}
+		}
+	}
+	const dateField = safeTrim(params.dateField);
+	if (hasKey(params, "dateTrunc") && !dateField) {
+		error(["dateTrunc"], "register-date", "'dateTrunc' needs a 'dateField'.");
+	}
+	if (dateField && !locked.includes("*") && isPlainColumnRef(dateField) && !locked.includes(dateField)) {
+		error(["dateField"], "register-date-unlocked", `'${dateField}' must be in 'lockedFields': a posted document re-dated would leave what it posted under the old date.`);
+	}
+}
+
+function checkInfoBinding({ params, register, qualified, error }: BindingContext): void {
+	if (!safeTrim(register.recorder)) {
+		error(["register"], "register-info-independent", `"${qualified}" is an independent information register (no 'recorder'): its records are written by data operations, not by posting — unposting could never find them.`);
+	}
+	for (const key of ["direction", "sign"]) {
+		if (hasKey(params, key)) {
+			error([key], "register-info-direction", `'${key}' is refused on a binding to an information register, which records values rather than quantities.`);
+		}
+	}
+}
+
+function checkLedgerAccounts({ params, register, error }: BindingContext): void {
+	if (register.lineMode === "compound") {
+		if (hasKey(params, "accountField")) {
+			error(["accountField"], "register-accounts", "A compound register takes 'debitAccountField' and 'creditAccountField', not 'accountField'.");
+		}
+		if (!safeTrim(params.debitAccountField) || !safeTrim(params.creditAccountField)) {
+			error(["register"], "register-accounts", "A binding to a compound register names 'debitAccountField' and 'creditAccountField'.");
+		}
+		return;
+	}
+	if (!safeTrim(params.accountField)) {
+		error(["register"], "register-accounts", "A binding to a classic register names the line's 'accountField'.");
+	}
+	for (const key of ["debitAccountField", "creditAccountField"]) {
+		if (hasKey(params, key)) {
+			error([key], "register-accounts", `'${key}' belongs to a compound register; a classic one takes 'accountField'.`);
+		}
+	}
+}
+
+/** A ledger `map` entry takes a column per side where the register keeps one per side. */
+function checkLedgerMapValue(ctx: BindingContext, key: string, value: unknown, resources: Raw): void {
+	const { register, error } = ctx;
+	const resource = resources[key];
+	const split = key in resources
+		? isRecord(resource) && registerResourceShape(resource) === "split"
+		: isRecord(register.sideDimensions) && key in register.sideDimensions;
+	if (split) {
+		if (!isRecord(value) || !safeTrim(value.debit) || !safeTrim(value.credit)) {
+			error(["map", key], "register-map-value", `"${key}" has a column per side; map both 'debit' and 'credit' to line columns.`);
+		}
+	} else if (!safeTrim(value)) {
+		error(["map", key], "register-map-value", `"${key}" is shared between the sides; map it to one line column.`);
+	}
+}
+
+/** Returns the names the binding maps, from `map` and `headerMap` alike. */
+function checkMaps(ctx: BindingContext, dimensions: string[], resources: Raw): Set<string> {
+	const { params, qualified, ledger, register, error } = ctx;
+	const known = new Set([...dimensions, ...Object.keys(resources)]);
+	const mapped = new Set<string>();
+	for (const mapKey of ["map", "headerMap"] as const) {
+		const map = isRecord(params[mapKey]) ? params[mapKey] : null;
+		if (!map) {
+			continue;
+		}
+		for (const key of Object.keys(map)) {
+			if (mapped.has(key)) {
+				error([mapKey, key], "register-map-key", `"${key}" is in both 'map' and 'headerMap' — one value cannot come from two places.`);
+			}
+			mapped.add(key);
+			if (!known.has(key)) {
+				error([mapKey, key], "register-map-key", `"${key}" is neither a dimension nor a resource of ${qualified} (dimensions: ${dimensions.join(", ") || "none"}; resources: ${Object.keys(resources).join(", ") || "none"}).`);
+			} else if (ledger && mapKey === "map") {
+				checkLedgerMapValue(ctx, key, map[key], resources);
+			} else if (mapKey === "headerMap" && key in resources && register.kind !== "info") {
+				error([mapKey, key], "register-header-map", `A resource ("${key}") can't come from the document on a line posting — it would be added once per line. Only an information register's records take it.`);
+			}
+		}
+	}
+	return mapped;
+}
+
+function checkMapping(ctx: BindingContext): void {
+	const { params, register, qualified, error } = ctx;
+	const dimensions = stringList(register.dimensions);
+	const resources: Raw = isRecord(register.resources) ? register.resources : {};
+	const mapped = checkMaps(ctx, dimensions, resources);
+
+	const unmapped = Object.entries(resources)
+		.filter(([resource, def]) => !mapped.has(resource) && !(isRecord(def) && def.required === false))
+		.map(([resource]) => resource);
+	if (unmapped.length > 0) {
+		error(
+			[hasKey(params, "map") ? "map" : "register"],
+			"register-unmapped-resource",
+			`Every required resource of ${qualified} must be mapped — missing: ${unmapped.join(", ")}. A writer that omitted one would post a silent zero.`,
+		);
+	}
+	stringList(params.skipPostingWhenEmpty).forEach((name, i) => {
+		if (!dimensions.includes(name)) {
+			error(["skipPostingWhenEmpty", i], "register-skip", `"${name}" isn't a dimension of ${qualified}; 'skipPostingWhenEmpty' names register dimensions.`);
+		}
+	});
+}
+
+/**
+ * Check an A / L column's `params` against the register it binds — paths
+ * relative to `params`. `register` is the resolved declaration, `undefined`
+ * when the module named declares no such register, `null` when that module
+ * can't be seen (every rule that needs the declaration then stands down).
+ */
+export function checkRegisterBinding(
+	columnType: "A" | "L",
+	rawParams: unknown,
+	register: RegisterBindingTarget | null | undefined,
+	options: { moduleCode?: string } = {},
+): RegisterIssue[] {
+	const out: RegisterIssue[] = [];
+	const error = createIssueReporter(out, "entity", "error");
+	if (!isRecord(rawParams)) {
+		return out;
+	}
+	const params = rawParams;
+	const qualified = safeTrim(params.register);
+	if (!qualified) {
+		return out;
+	}
+	const ledger = columnType === "L";
+
+	if (hasKey(params, "registries")) {
+		error(["registries"], "register-and-inline", "A column binds to a register OR restates one inline in 'registries' — keep one.");
+	}
+	if (!qualified.includes(".")) {
+		error(["register"], "register-unqualified", `A register is named as module.register, e.g. "${options.moduleCode ?? "module"}.${qualified}".`);
+		return out;
+	}
+	const dot = qualified.indexOf(".");
+	const moduleCode = qualified.slice(0, dot);
+	const registerCode = qualified.slice(dot + 1);
+
+	// Posting inputs are validated even when the target register cannot be resolved.
+	checkPosting(params, ledger, error);
+
+	if (register === null) {
+		return out;
+	}
+	if (!register) {
+		error(["register"], "unknown-register", `No register "${qualified}" — ${moduleCode}/registers.json doesn't declare "${registerCode}".`);
+		return out;
+	}
+	const kind = register.kind;
+	if (ledger && kind !== "accounting") {
+		error(["register"], "register-kind", `An L column posts to an accounting register; "${qualified}" is a ${kind || "?"} register — use an A column.`);
+		return out;
+	}
+	if (!ledger && kind === "accounting") {
+		error(["register"], "register-kind", `An A column posts to a balance, turnover or info register; "${qualified}" is an accounting register — use an L column.`);
+		return out;
+	}
+	const ctx: BindingContext = { params, register, qualified, ledger, error };
+	if (kind === "info") {
+		checkInfoBinding(ctx);
+	}
+	// No rule on a missing `direction`: the engine posts an increase by default
+	// (gl's VAT binding ships without one).
+	if (ledger) {
+		checkLedgerAccounts(ctx);
+	}
+	checkMapping(ctx);
+	return out;
+}