@dforge-core/metadata 0.0.34 → 0.0.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist/index.d.ts +7 -0
- package/package.json +67 -66
- package/schemas/entity.schema.json +25 -4
- package/schemas/registers.schema.json +27 -13
- package/schemas/stored_procedures.schema.json +24 -1
- package/schemas/translations.schema.json +7 -0
- package/src/stored-procedures.ts +7 -0
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,33 @@ and this package adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.0.35] — 2026-10-07
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- **Domain-backed stored-procedure result columns:** `stored_procedures.schema.json` and
|
|
15
|
+
`SpColumnDef` accept `domain`; the domain supplies `fieldTypeCd`, `baseDatatypeCd` and
|
|
16
|
+
`params`, so a status a report returns no longer repeats the entity's option list.
|
|
17
|
+
- **`entity.schema.json`:** an `A` column posting from lines takes `groupLinesBy` — line
|
|
18
|
+
columns whose distinct values each post one movement instead of one per line, with `map`
|
|
19
|
+
read over the grouped columns plus the document.
|
|
20
|
+
- **`entity.schema.json`:** a binding's `map`, `headerMap` and `dateField` value may be an
|
|
21
|
+
expression — a string starting with `=` holding an `F`-column formula over the row, with
|
|
22
|
+
one-hop `[ref].[column]` reads.
|
|
23
|
+
- **`entity.schema.json`:** an `A` binding takes `dateTrunc` (`day`, `month`, `year`), which
|
|
24
|
+
takes the `dateField` value back to the start of that period.
|
|
25
|
+
- **`registers.schema.json`:** a register takes `label`, translated under the new
|
|
26
|
+
`registers` section of `translations.schema.json`.
|
|
27
|
+
- **`registers.schema.json`:** an `info` register with a `recorder` takes
|
|
28
|
+
`recordChangesOnly`, and its resources take `absentAs` — what a resource compares as
|
|
29
|
+
before any record is in effect.
|
|
30
|
+
|
|
31
|
+
### Changed
|
|
32
|
+
|
|
33
|
+
- **`entity.schema.json`:** an index is typed — `fields` (required) plus an optional `using`
|
|
34
|
+
(`btree`, `hash`, `gin`, `gist`, `brin`). Any other key, `columns` among them, is refused;
|
|
35
|
+
the installer used to skip such an index without a word.
|
|
36
|
+
|
|
10
37
|
## [0.0.34] — 2026-10-06
|
|
11
38
|
|
|
12
39
|
### Added
|
package/dist/index.d.ts
CHANGED
|
@@ -1134,6 +1134,13 @@ interface SpColumnDef {
|
|
|
1134
1134
|
width?: number;
|
|
1135
1135
|
/** Control parameters, the same shape an entity column's `params` takes. */
|
|
1136
1136
|
params?: Record<string, unknown>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Reusable column domain supplying the control, datatype and option list.
|
|
1139
|
+
* Unqualified resolves within this module, then tenant-created domains;
|
|
1140
|
+
* `module_cd.domain_cd` binds to that module. Mutually exclusive with
|
|
1141
|
+
* `fieldTypeCd`, `baseDatatypeCd` and `params`.
|
|
1142
|
+
*/
|
|
1143
|
+
domain?: string;
|
|
1137
1144
|
}
|
|
1138
1145
|
|
|
1139
1146
|
/** Author block on a manifest. */
|
package/package.json
CHANGED
|
@@ -1,67 +1,68 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
}
|
|
2
|
+
"name": "@dforge-core/metadata",
|
|
3
|
+
"version": "0.0.35",
|
|
4
|
+
"description": "Canonical dForge authoring registries — field types, base datatypes, column types, traits, data-view kinds and chart types — with derivation helpers. Runtime-dependency-free; the single source of truth shared by editors, the web app and the CLI.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "dForge",
|
|
7
|
+
"homepage": "https://github.com/iash44/dForge-core/tree/main/clients/packages/metadata#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/iash44/dForge-core.git",
|
|
11
|
+
"directory": "clients/packages/metadata"
|
|
12
|
+
},
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/iash44/dForge-core/issues"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"dforge",
|
|
18
|
+
"metadata",
|
|
19
|
+
"field-type",
|
|
20
|
+
"trait",
|
|
21
|
+
"registry",
|
|
22
|
+
"low-code"
|
|
23
|
+
],
|
|
24
|
+
"publishConfig": {
|
|
25
|
+
"access": "public"
|
|
26
|
+
},
|
|
27
|
+
"type": "module",
|
|
28
|
+
"main": "./dist/index.js",
|
|
29
|
+
"module": "./dist/index.js",
|
|
30
|
+
"types": "./dist/index.d.ts",
|
|
31
|
+
"exports": {
|
|
32
|
+
".": {
|
|
33
|
+
"source": "./src/index.ts",
|
|
34
|
+
"types": "./dist/index.d.ts",
|
|
35
|
+
"default": "./dist/index.js"
|
|
36
|
+
},
|
|
37
|
+
"./dsl": {
|
|
38
|
+
"source": "./src/dsl/index.ts",
|
|
39
|
+
"types": "./dist/dsl/index.d.ts",
|
|
40
|
+
"default": "./dist/dsl/index.js"
|
|
41
|
+
},
|
|
42
|
+
"./schemas/*": "./schemas/*",
|
|
43
|
+
"./package.json": "./package.json"
|
|
44
|
+
},
|
|
45
|
+
"sideEffects": false,
|
|
46
|
+
"files": [
|
|
47
|
+
"dist",
|
|
48
|
+
"src",
|
|
49
|
+
"schemas",
|
|
50
|
+
"CHANGELOG.md"
|
|
51
|
+
],
|
|
52
|
+
"scripts": {
|
|
53
|
+
"sync-schemas": "node scripts/sync-schemas.mjs",
|
|
54
|
+
"build": "tsup",
|
|
55
|
+
"dev": "tsup --watch",
|
|
56
|
+
"typecheck": "tsc -p tsconfig.build.json --noEmit",
|
|
57
|
+
"test": "vitest run",
|
|
58
|
+
"prepack": "pnpm sync-schemas && pnpm typecheck && pnpm build",
|
|
59
|
+
"package": "pnpm pack"
|
|
60
|
+
},
|
|
61
|
+
"devDependencies": {
|
|
62
|
+
"@types/node": "^25.9.4",
|
|
63
|
+
"ajv": "^8.20.0",
|
|
64
|
+
"tsup": "^8.5.1",
|
|
65
|
+
"typescript": "^6.0.3",
|
|
66
|
+
"vitest": "^4.1.10"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
@@ -114,7 +114,24 @@
|
|
|
114
114
|
},
|
|
115
115
|
"indexes": {
|
|
116
116
|
"type": "object",
|
|
117
|
-
"description": "Database index
|
|
117
|
+
"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.",
|
|
118
|
+
"additionalProperties": {
|
|
119
|
+
"type": "object",
|
|
120
|
+
"required": ["fields"],
|
|
121
|
+
"additionalProperties": false,
|
|
122
|
+
"properties": {
|
|
123
|
+
"fields": {
|
|
124
|
+
"type": "array",
|
|
125
|
+
"minItems": 1,
|
|
126
|
+
"items": { "type": "string" },
|
|
127
|
+
"description": "Indexed columns, in order. Install refuses any key other than fields and using - \"columns\", which a unique constraint accepts, included."
|
|
128
|
+
},
|
|
129
|
+
"using": {
|
|
130
|
+
"enum": ["btree", "hash", "gin", "gist", "brin"],
|
|
131
|
+
"description": "Index method. Omitted, btree."
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
118
135
|
},
|
|
119
136
|
"numberSequence": {
|
|
120
137
|
"$ref": "#/$defs/numberSequence",
|
|
@@ -242,9 +259,11 @@
|
|
|
242
259
|
"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." },
|
|
243
260
|
"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." },
|
|
244
261
|
"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'." },
|
|
245
|
-
"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)." },
|
|
246
|
-
"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." },
|
|
247
|
-
"
|
|
262
|
+
"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])\"." },
|
|
263
|
+
"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')." },
|
|
264
|
+
"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." },
|
|
265
|
+
"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')." },
|
|
266
|
+
"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." },
|
|
248
267
|
"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." },
|
|
249
268
|
"periodEntity": { "type": "string", "description": "Period entity this registry closes against — one of this module's, or 'module.entity' from a dependency." },
|
|
250
269
|
"periodDateField": { "type": "string", "description": "Header date column that resolves the period." },
|
|
@@ -253,6 +272,8 @@
|
|
|
253
272
|
},
|
|
254
273
|
"dependencies": {
|
|
255
274
|
"headerMap": ["lineEntity"],
|
|
275
|
+
"groupLinesBy": ["lineEntity"],
|
|
276
|
+
"dateTrunc": ["dateField"],
|
|
256
277
|
"lineEntity": ["lineField", "lockedLineFields"],
|
|
257
278
|
"lineField": ["lineEntity"],
|
|
258
279
|
"lockedLineFields": ["lineEntity"],
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"then": {
|
|
20
20
|
"required": ["entity"],
|
|
21
21
|
"properties": {
|
|
22
|
-
"period": false, "recorder": false,
|
|
22
|
+
"period": false, "recorder": false, "recordChangesOnly": false,
|
|
23
23
|
"chart": false, "composition": false, "analyticFields": false, "lineMode": false,
|
|
24
24
|
"account": false,
|
|
25
25
|
"debitAccount": false, "creditAccount": false,
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"properties": {
|
|
37
37
|
"entity": false,
|
|
38
38
|
"period": false,
|
|
39
|
-
"recorder": false,
|
|
39
|
+
"recorder": false, "recordChangesOnly": false,
|
|
40
40
|
"chart": false, "composition": false, "analyticFields": false, "lineMode": false,
|
|
41
41
|
"account": false,
|
|
42
42
|
"debitAccount": false, "creditAccount": false,
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"properties": {
|
|
77
77
|
"entity": false,
|
|
78
78
|
"period": false,
|
|
79
|
-
"recorder": false,
|
|
79
|
+
"recorder": false, "recordChangesOnly": false,
|
|
80
80
|
"journalDirection": false,
|
|
81
81
|
"allowNegative": false,
|
|
82
82
|
"autoCreate": false
|
|
@@ -106,7 +106,7 @@
|
|
|
106
106
|
}
|
|
107
107
|
}
|
|
108
108
|
],
|
|
109
|
-
"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:
|
|
109
|
+
"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."
|
|
110
110
|
}
|
|
111
111
|
}
|
|
112
112
|
,
|
|
@@ -146,6 +146,11 @@
|
|
|
146
146
|
"enum": ["balance", "turnover", "info", "accounting"],
|
|
147
147
|
"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."
|
|
148
148
|
},
|
|
149
|
+
"label": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"maxLength": 200,
|
|
152
|
+
"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."
|
|
153
|
+
},
|
|
149
154
|
"description": {
|
|
150
155
|
"type": "string",
|
|
151
156
|
"maxLength": 500,
|
|
@@ -192,12 +197,12 @@
|
|
|
192
197
|
"accountField": {
|
|
193
198
|
"type": "string",
|
|
194
199
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
195
|
-
"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:
|
|
200
|
+
"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."
|
|
196
201
|
},
|
|
197
202
|
"dimensions": {
|
|
198
203
|
"type": "array",
|
|
199
204
|
"items": { "type": "string", "pattern": "^[a-z_][a-z0-9_]*$" },
|
|
200
|
-
"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,
|
|
205
|
+
"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."
|
|
201
206
|
},
|
|
202
207
|
"resources": {
|
|
203
208
|
"type": "object",
|
|
@@ -239,12 +244,17 @@
|
|
|
239
244
|
"period": {
|
|
240
245
|
"type": "string",
|
|
241
246
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
242
|
-
"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
|
|
247
|
+
"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'."
|
|
243
248
|
},
|
|
244
249
|
"recorder": {
|
|
245
250
|
"type": "string",
|
|
246
251
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
247
|
-
"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:
|
|
252
|
+
"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'."
|
|
253
|
+
},
|
|
254
|
+
"recordChangesOnly": {
|
|
255
|
+
"type": "boolean",
|
|
256
|
+
"default": false,
|
|
257
|
+
"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."
|
|
248
258
|
},
|
|
249
259
|
"chart": {
|
|
250
260
|
"type": "string",
|
|
@@ -268,7 +278,7 @@
|
|
|
268
278
|
"slot": {
|
|
269
279
|
"type": "string",
|
|
270
280
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
271
|
-
"description": "Column holding the slot number: WHICH of the posting's analytic columns this analytic is written into. Positional storage is what
|
|
281
|
+
"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."
|
|
272
282
|
},
|
|
273
283
|
"analytic": {
|
|
274
284
|
"type": "string",
|
|
@@ -313,7 +323,7 @@
|
|
|
313
323
|
"minProperties": 1,
|
|
314
324
|
"maxProperties": 8,
|
|
315
325
|
"propertyNames": { "pattern": "^[a-z_][a-z0-9_]*$" },
|
|
316
|
-
"description": "Dimensions that are TWO-SIDED, with the posting column for each side.
|
|
326
|
+
"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.",
|
|
317
327
|
"additionalProperties": {
|
|
318
328
|
"type": "object",
|
|
319
329
|
"required": ["debitField", "creditField"],
|
|
@@ -338,7 +348,7 @@
|
|
|
338
348
|
"maxItems": 8,
|
|
339
349
|
"uniqueItems": true,
|
|
340
350
|
"items": { "type": "string", "pattern": "^[a-z_][a-z0-9_]*$" },
|
|
341
|
-
"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
|
|
351
|
+
"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'."
|
|
342
352
|
},
|
|
343
353
|
"lineMode": {
|
|
344
354
|
"type": "string",
|
|
@@ -373,7 +383,7 @@
|
|
|
373
383
|
"debitField": {
|
|
374
384
|
"type": "string",
|
|
375
385
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
376
|
-
"description": "On an accounting register, the posting column holding this resource's debit side. Declared with 'creditField' and instead of 'field'.
|
|
386
|
+
"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."
|
|
377
387
|
},
|
|
378
388
|
"creditField": {
|
|
379
389
|
"type": "string",
|
|
@@ -385,6 +395,10 @@
|
|
|
385
395
|
"pattern": "^[a-z_][a-z0-9_]*$",
|
|
386
396
|
"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."
|
|
387
397
|
},
|
|
398
|
+
"absentAs": {
|
|
399
|
+
"type": ["number", "string", "boolean"],
|
|
400
|
+
"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)."
|
|
401
|
+
},
|
|
388
402
|
"required": {
|
|
389
403
|
"type": "boolean",
|
|
390
404
|
"default": true,
|
|
@@ -397,7 +411,7 @@
|
|
|
397
411
|
},
|
|
398
412
|
"additionalProperties": false
|
|
399
413
|
},
|
|
400
|
-
"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
|
|
414
|
+
"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."
|
|
401
415
|
},
|
|
402
416
|
"allowNegative": {
|
|
403
417
|
"type": "boolean",
|
|
@@ -117,9 +117,32 @@
|
|
|
117
117
|
"type": "object",
|
|
118
118
|
"description": "Control parameters, the same shape an entity column's `params` takes — `options` for a dropdown or flags, `currency`, `align`, and so on.",
|
|
119
119
|
"additionalProperties": true
|
|
120
|
+
},
|
|
121
|
+
"domain": {
|
|
122
|
+
"type": "string",
|
|
123
|
+
"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."
|
|
120
124
|
}
|
|
121
125
|
},
|
|
122
|
-
"additionalProperties": false
|
|
126
|
+
"additionalProperties": false,
|
|
127
|
+
"oneOf": [
|
|
128
|
+
{
|
|
129
|
+
"title": "Domain-backed result column",
|
|
130
|
+
"description": "Defers to a column domain. Must not restate what the domain owns.",
|
|
131
|
+
"required": ["domain"],
|
|
132
|
+
"properties": {
|
|
133
|
+
"fieldTypeCd": false,
|
|
134
|
+
"baseDatatypeCd": false,
|
|
135
|
+
"params": false
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"title": "Inline result column",
|
|
140
|
+
"description": "Declares its own control and datatype.",
|
|
141
|
+
"properties": {
|
|
142
|
+
"domain": false
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
]
|
|
123
146
|
}
|
|
124
147
|
}
|
|
125
148
|
}
|
|
@@ -58,6 +58,13 @@
|
|
|
58
58
|
"$ref": "#/$defs/labelOnly"
|
|
59
59
|
}
|
|
60
60
|
},
|
|
61
|
+
"registers": {
|
|
62
|
+
"type": "object",
|
|
63
|
+
"description": "Register code (as registers.json keys it) → label and description.",
|
|
64
|
+
"additionalProperties": {
|
|
65
|
+
"$ref": "#/$defs/labelDesc"
|
|
66
|
+
}
|
|
67
|
+
},
|
|
61
68
|
"reports": {
|
|
62
69
|
"type": "object",
|
|
63
70
|
"description": "Report code → label, dataset captions and parameter labels.",
|
package/src/stored-procedures.ts
CHANGED
|
@@ -72,4 +72,11 @@ export interface SpColumnDef {
|
|
|
72
72
|
width?: number;
|
|
73
73
|
/** Control parameters, the same shape an entity column's `params` takes. */
|
|
74
74
|
params?: Record<string, unknown>;
|
|
75
|
+
/**
|
|
76
|
+
* Reusable column domain supplying the control, datatype and option list.
|
|
77
|
+
* Unqualified resolves within this module, then tenant-created domains;
|
|
78
|
+
* `module_cd.domain_cd` binds to that module. Mutually exclusive with
|
|
79
|
+
* `fieldTypeCd`, `baseDatatypeCd` and `params`.
|
|
80
|
+
*/
|
|
81
|
+
domain?: string;
|
|
75
82
|
}
|