@orkestrel/program 0.0.11 → 0.0.13

package/README.md

@@ -1,17 +1,20 @@
 # @orkestrel/program
 
-A **program composition layer** over
-[`@orkestrel/qualifier`](https://github.com/orkestrel/qualifier) and
-[`@orkestrel/rater`](https://github.com/orkestrel/rater): a pure,
-JSON-serializable `ProgramDefinition` composes one qualification with an optional
-rating, plus optional notices, authority, and batch aggregate policy. `Program` executes
-the workflow in one direction — qualify the subject, stop on terminal
-qualification, select eligible rating lines, rate only those lines, derive status,
-then evaluate optional authority — returning a nested `ProgramResult` (or
-`AggregateResult` for batch `execute`). Globally ineligible or referred subjects
-never reach the rater. Execution never mutates its inputs — every result is a
-fresh object. Environment-agnostic — no I/O, no browser or server assumptions.
-Part of the `@orkestrel` line.
+> The program composition layer: a pure, JSON-serializable `ProgramDefinition`
+> that composes one qualification with an optional rating, plus notices,
+> authority, and batch aggregate policy, and a `Program` that executes that
+> definition in one direction — qualify, select, rate, derive status, then decide.
+
+Build a definition with the `buildProgramDefinition` function, compile it with
+`createProgram`, and call `execute` with one subject for a `ProgramResult` or
+with a subject array for an `AggregateResult`. Execution never mutates its
+inputs; every result is a fresh object. Injected qualifier, rater, and reason
+instances stay caller-owned, and a standalone program owns the engine it creates.
+Built over [`@orkestrel/qualifier`](https://github.com/orkestrel/qualifier),
+[`@orkestrel/rater`](https://github.com/orkestrel/rater), and the shared
+[`@orkestrel/reason`](https://github.com/orkestrel/reason) engine.
+Environment-agnostic — no I/O, no browser or server assumptions. Part of the
+`@orkestrel` line.
 
 ## Install
 
@@ -21,52 +24,56 @@ npm install @orkestrel/program
 
 ## Requirements
 
-- Node.js >= 24
-- ESM (`import`) and CommonJS (`require`) via the `exports` field
+- Node.js >= 22.12.0
+- ESM (`import`) and CommonJS (`require`) through the `exports` field
 
 ## Usage
 
 ```ts
-import { createProgram, programDefinition } from '@orkestrel/program'
-import { qualificationDefinition, rulingDefinition } from '@orkestrel/qualifier'
-import { lineDefinition, ratingDefinition } from '@orkestrel/rater'
+import { buildProgramDefinition, createProgram } from '@orkestrel/program'
+import { createQualificationDefinition, createRuling } from '@orkestrel/qualifier'
+import { buildLineDefinition, buildRatingDefinition } from '@orkestrel/rater'
 import {
-	atom,
-	factorGroup,
-	logicalDefinition,
-	quantitativeDefinition,
-	rule,
-	staticFactor,
+	createAtom,
+	createFactorGroup,
+	createLogicalDefinition,
+	createQuantitativeDefinition,
+	createRule,
+	createStaticFactor,
 } from '@orkestrel/reason'
 
-const gates = logicalDefinition('gates', 'Eligibility gates', [
-	rule('licensed', [atom('licensed', 'equals', false)], atom('blocked', 'equals', true)),
+const gates = createLogicalDefinition('gates', 'Eligibility gates', [
+	createRule(
+		'licensed',
+		[createAtom('licensed', 'equals', false)],
+		createAtom('blocked', 'equals', true),
+	),
 ])
 
-const qualification = qualificationDefinition(
+const qualification = createQualificationDefinition(
 	'standard-qualification',
 	'Standard qualification',
 	[gates],
 	{
 		rulings: [
-			rulingDefinition('license', 'gates', 'licensed', 'restriction', {
+			createRuling('license', 'gates', 'licensed', 'restriction', {
 				message: 'A license is required',
 			}),
 		],
 	},
 )
 
-const base = lineDefinition(
+const base = buildLineDefinition(
 	'base',
 	'Base premium',
-	quantitativeDefinition('base-rate', 'Base rate', [
-		factorGroup('amount', 'sum', [staticFactor('minimum', 100)]),
+	createQuantitativeDefinition('base-rate', 'Base rate', [
+		createFactorGroup('amount', 'sum', [createStaticFactor('minimum', 100)]),
 	]),
 )
 
-const rating = ratingDefinition('standard-rating', 'Standard rating', [base])
+const rating = buildRatingDefinition('standard-rating', 'Standard rating', [base])
 
-const definition = programDefinition('standard', 'Standard program', qualification, rating)
+const definition = buildProgramDefinition('standard', 'Standard program', qualification, rating)
 
 const program = createProgram(definition)
 
@@ -102,7 +109,7 @@ one aggregate-aware batch and returns an `AggregateResult`. Every single-subject
 
 For the full surface — `Program`, `ProgramManager`, `ProgramResult`,
 `AggregateResult`, validators, factories, errors, and options — see
-[`guides/src/program.md`](guides/src/program.md).
+[`guides/program.md`](guides/program.md).
 
 ## Package