@orkestrel/qualifier 0.0.12 → 0.0.14

package/README.md

@@ -1,13 +1,18 @@
 # @orkestrel/qualifier
 
-A typed **eligibility engine** over [`@orkestrel/reason`](https://github.com/orkestrel/reason):
-authored **passes** — quantitative derivations and logical rule gates — run in order
-against a **subject** (a plain data record) to produce **findings** (evidence-rich
-ruling outcomes), **derivations** (quantitative audit trails), and **eligibility**
-(global plus per-scope). The caller supplies the definition; `Qualifier` only
-evaluates what it is given. Qualification 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.
+> A synchronous, deterministic eligibility engine that runs a pure,
+> JSON-serializable `QualificationDefinition`'s ordered `passes` against one
+> subject through one `@orkestrel/reason` engine and returns a fresh
+> `QualificationResult` carrying global and scoped eligibility, evidence-rich
+> `findings`, and quantitative `derivations`.
+
+Author the passes — quantitative derivations and logical rule gates — hand a subject
+(a plain data record) to `qualify`, and read what comes back. The caller supplies the
+definition; `Qualifier` only evaluates what it is given. Inject a
+[`@orkestrel/reason`](https://github.com/orkestrel/reason) `ReasonInterface` where
+qualification shares an engine with the rest of your reasoning, and call `destroy()`
+when the qualifier's work is done. Environment-agnostic — no I/O, no browser or
+server assumptions. Part of the `@orkestrel` line.
 
 ## Install
 
@@ -17,22 +22,26 @@ npm install @orkestrel/qualifier
 
 ## 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 { createQualifier, qualificationDefinition, rulingDefinition } from '@orkestrel/qualifier'
-import { atom, logicalDefinition, rule } from '@orkestrel/reason'
-
-const gates = logicalDefinition('gates', 'Eligibility gates', [
-	rule('licensed', [atom('licensed', 'equals', false)], atom('blocked', 'equals', true)),
+import { createQualificationDefinition, createQualifier, createRuling } from '@orkestrel/qualifier'
+import { createAtom, createLogicalDefinition, createRule } from '@orkestrel/reason'
+
+const gates = createLogicalDefinition('gates', 'Eligibility gates', [
+	createRule(
+		'licensed',
+		[createAtom('licensed', 'equals', false)],
+		createAtom('blocked', 'equals', true),
+	),
 ])
 
-const definition = qualificationDefinition('standard', 'Standard eligibility', [gates], {
+const definition = createQualificationDefinition('standard', 'Standard eligibility', [gates], {
 	rulings: [
-		rulingDefinition('license', 'gates', 'licensed', 'restriction', {
+		createRuling('license', 'gates', 'licensed', 'restriction', {
 			message: 'A license is required',
 		}),
 	],
@@ -55,7 +64,7 @@ overload. Every `qualify` call fires once through `qualifier.emitter` (`qualify`
 
 For the full surface — `Qualifier`, `QualificationResult`, finding types, validators,
 factories, errors, and options — see
-[`guides/src/qualifier.md`](guides/src/qualifier.md).
+[`guides/qualifier.md`](guides/qualifier.md).
 
 ## Package