@dforge-core/metadata 0.0.40 → 0.0.42

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dforge-core/metadata",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "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.",
   "license": "MIT",
   "author": "dForge",
@@ -54,7 +54,7 @@
     "ajv": "^8.20.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.10"
+    "vitest": "^5.0.4"
   },
   "scripts": {
     "sync-schemas": "node scripts/sync-schemas.mjs",

package/schemas/entity.schema.json

@@ -6,7 +6,8 @@
 	"type": "object",
 	"anyOf": [
 		{ "required": ["fields"] },
-		{ "required": ["traits"] }
+		{ "required": ["traits"] },
+		{ "required": ["extends", "reactions"] }
 	],
 	"properties": {
 		"extends": {
@@ -191,11 +192,20 @@
 						"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."
+						"description": "Indexed columns, in order. Install refuses any key other than fields, using, unique and where - \"columns\", which a unique constraint accepts, included."
 					},
 					"using": {
 						"enum": ["btree", "hash", "gin", "gist", "brin"],
 						"description": "Index method. Omitted, btree."
+					},
+					"unique": {
+						"type": "boolean",
+						"description": "A unique index. With \"where\" it is unique among the rows the condition selects, which a unique constraint cannot be (unique among the rows that are not deleted)."
+					},
+					"where": {
+						"type": "string",
+						"minLength": 1,
+						"description": "A partial index: SQL condition over the table's columns, e.g. \"is_deleted = false\". Only the rows it selects are indexed, and a query uses the index only when its own filter implies the condition. One condition, without ';', '$' or comments. Changing it rebuilds the index on upgrade."
 					}
 				}
 			}
@@ -208,6 +218,26 @@
 			"$ref": "#/$defs/periodConfig",
 			"description": "Period entity configuration. Requires 'period' trait."
 		},
+		"periodGuards": {
+			"type": "array",
+			"description": "Closed-period locks for a document that posts to no register. Each guard names a period entity, the date the document's period follows from, and the column that references the period. The platform fills that column from the date and makes it a foreign key, so a document is written only into a period that exists and is open, and a period documents refer to cannot be deleted. Not allowed on an extension.",
+			"items": {
+				"type": "object",
+				"required": ["periodEntity", "periodDateField", "periodField", "lockedFields"],
+				"properties": {
+					"periodEntity": { "type": "string", "description": "The period entity ('period' trait): this module's, or another module's as 'module.entity'." },
+					"periodDateField": { "type": "string", "description": "The document's date column the period is resolved from." },
+					"periodField": { "type": "string", "description": "The document's column referencing the period's key (varchar, like the key). Filled by the platform from the date; whatever a writer puts there is replaced." },
+					"periodKeyField": { "type": "string", "default": "period_key", "description": "The period entity's key column. Must be its primary key or unique." },
+					"periodClosedField": { "type": "string", "default": "closed", "description": "The period entity's closed flag." },
+					"lockedFields": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "Fields a closed period freezes. Insert and delete are always refused there, and the date is always watched; [\"periodDateField\"] refuses just that, [\"*\"] freezes the whole row." },
+					"lineEntity": { "type": "string", "description": "The document's line entity, guarded through its header's date." },
+					"lineField": { "type": "string", "description": "The line's foreign key to the header." },
+					"lockedLineFields": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "Line fields a closed period freezes; [\"*\"] for the whole row. Required with lineEntity." }
+				},
+				"additionalProperties": false
+			}
+		},
 		"accumulation": {
 			"$ref": "#/$defs/accumulationConfig",
 			"description": "Accumulation registry configuration (simple document without lines). Requires 'accumulation' trait."

package/schemas/roles.schema.json

@@ -18,11 +18,14 @@
 				},
 				"rights": {
 					"type": "object",
-					"description": "Entity rights: entity code → rights string",
+					"description": "Security object → rights string. Keys are PREFIX-NAMESPACED so an action and an entity may share a code: a bare key is an entity code in this module ('invoice'), 'module.entity' is an entity owned by a module this one depends on ('parties.party'), 'action:<action_cd>' is an action from this module's ui/actions.json, and 'sp:<sp_cd>' is a stored procedure from logic/stored_procedures.json ('sp:module.sp_cd' for a dependency's), and 'report:<report_cd>' is a report from ui/reports.json ('report:module.report_cd' for a dependency's). A grant on an action written WITHOUT the 'action:' prefix is read as an entity code, resolves to nothing, and is silently dropped at install — action.execute then returns PERMISSION_DENIED.",
+					"propertyNames": {
+						"pattern": "^(action:[A-Za-z_][A-Za-z0-9_-]*|(sp|report):([A-Za-z_][A-Za-z0-9_-]*\\.)?[A-Za-z_][A-Za-z0-9_-]*|([A-Za-z_][A-Za-z0-9_-]*\\.)?[A-Za-z_][A-Za-z0-9_-]*)$"
+					},
 					"additionalProperties": {
 						"type": "string",
 						"pattern": "^[SIUDCE]*$",
-						"description": "Rights: S=Select, I=Insert, U=Update, D=Delete, C=Clone, E=Execute"
+						"description": "Rights: S=Select, I=Insert, U=Update, D=Delete, C=Clone, E=Execute. Entity objects take any of SIUDC; actions, stored procedures and reports take E."
 					}
 				}
 			},

package/src/dsl/builtins.ts

@@ -99,15 +99,15 @@ export const BUILTINS: Builtin[] = [
 	},
 	{
 		name: "getAccountBalance",
-		signature: "getAccountBalance(register, account, filter?, asOf?)",
+		signature: "getAccountBalance(register, account, filter?, asOf?, options?)",
 		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 — an analytic takes the key alone, or `{ entity, value }` to name one entity of a kind that is a union of several.",
+		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 — an analytic takes the key alone, or `{ entity, value }` to name one entity of a kind that is a union of several. `options`: `groupBy` (a name or array — returns an array, a row per combination with a non-zero balance), `exclude: { entity, key }` (leaves out that document's postings) and `before` (a moment, exclusive, in place of `asOf`).",
 	},
 	{
 		name: "getAccountTurnover",
-		signature: "getAccountTurnover(register, account, filter, from, to)",
+		signature: "getAccountTurnover(register, account, filter, from, to, options?)",
 		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.",
+		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. `options` takes `groupBy` and `exclude` as in `getAccountBalance`; a grouped turnover has a row per combination that moved.",
 	},
 	{
 		name: "getCorrespondence",

package/src/index.ts

@@ -103,6 +103,7 @@ export {
 	type ReportPanel,
 	type Dataset,
 	type ReportQuery,
+	type RegisterSource,
 	type ColumnDef,
 	type ParamDef,
 	type ParamDefBase,