@smile-digital-health/crl 5.0.0 → 5.1.1

package/README.md

@@ -6,31 +6,36 @@ Clinical Reasoning Language (CRL) provides a structured way to model clinical de
 
 ## Overview
 
-See the [User Guide](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/USER_GUIDE.md) for a comprehensive introduction to the CRL language, syntax, and authoring best practices. For the **CLI and MCP tool reference** (emit, validate, the MCP tools — for both CRL and CEL), see [TOOLING.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/TOOLING.md).
+See the [User Guide](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/USER_GUIDE.md) for a comprehensive introduction to the CRL language, syntax, and authoring best practices. For the **CLI and MCP tool reference** (emit, validate, the MCP tools — for both CRL and CEL), see [TOOLING.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/TOOLING.md).
 
 CRL is a domain-specific language designed for expressing clinical practice guidelines in a structured and machine-readable format. The language is implemented in TypeScript and provides a comprehensive set of tools for processing CRL documents.
 
+For the authoring reference over MCP, call `authoring_kit({})` to discover guidance,
+or `authoring_kit({view:"full",format:"markdown"})` for the complete audited Markdown.
+The response is the same document as the release's `authoring-kit.md`; the agent can
+read or save it. JSON remains the default. See the [kit guide](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/docs/authoring-kit.md).
+
 ## Metadata annotations
 
-CRL concepts can carry typed metadata via an `@tag` convention on `meta` lines (e.g. `@description`, `@ke-feedback`, `@kg-concept`) — for descriptions, knowledge-engineer feedback, plain-language logic, external-store hints, and extraction provenance. See the [metadata model](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/spec/metadata-model.md) and the canonical [tag registry](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/spec/metadata-registry.json). *(Draft: the convention parses today; Validator enforcement is forthcoming.)*
+CRL concepts can carry typed metadata via an `@tag` convention on `meta` lines (e.g. `@description`, `@ke-feedback`, `@kg-concept`) — for descriptions, knowledge-engineer feedback, plain-language logic, external-store hints, and extraction provenance. See the [metadata model](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/spec/metadata-model.md) and the canonical [tag registry](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/spec/metadata-registry.json). *(Draft: the convention parses today; Validator enforcement is forthcoming.)*
 
 ## Installation
 
 The package is publicly available from npm; installation does not require an npm account or token.
 
 ```bash
-npm install @smile-digital-health/crl@5.0.0
+npm install @smile-digital-health/crl@5.1.1
 ```
 
 For a dependency that accepts compatible CRL5 updates:
 
 ```json
 "dependencies": {
-  "@smile-digital-health/crl": "^5.0.0"
+  "@smile-digital-health/crl": "^5.1.0"
 }
 ```
 
-CRL5 is a breaking language transition. Migrate existing content using the current authoring kit before upgrading; a `^4` dependency does not select5.x. The release notes describe the migration and distinguish changes already shipped in4.123.0.
+CRL5.1 changes the public authoring-kit npm and MCP APIs. When upgrading from 5.0.0, update kit calls as described in the [5.1.0 release notes](https://github.com/alphora/clinical-reasoning-language/releases/tag/v5.1.0); the CRL/CEL language and emitted CQL/FHIR are unchanged from 5.0.0. A `^5` dependency permits 5.1.0. Content from before the CRL5 language transition may also need language migration using the current authoring kit.
 
 ### For Package Maintainers
 
@@ -160,7 +165,7 @@ The FSH-to-CRL transformer converts FHIR Shorthand (FSH) files into Clinical Rea
 - **Deduplication and Suffixing**: Terminology blocks are unique by identifier and body. If a duplicate identifier is encountered with a different body, a numeric suffix (e.g., `_2`) is added to the identifier. If both identifier and body are the same, the block is not duplicated.
 - **Extraction Logic**: For `medicationCodeableConcept`, the transformer uses `system`, `code`, and `identifier` from the FSH object. For `dynamicValue.expression.expression` (where `path = "code.coding"`), the transformer uses `system` and `code` from the CQL code expression string and `identifier` from the corresponding description.
 
-For more details, see the [User Guide](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/USER_GUIDE.md) and the technical mapping documentation.
+For more details, see the [User Guide](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/USER_GUIDE.md) and the technical mapping documentation.
 
 ## CLI Tool Usage
 
@@ -188,7 +193,7 @@ crl-emit --path <root.crl> --out-dir <project-root> --target fhir-def
 
 Output lands at `<project-root>/src/fhir/<ResourceType>/<id>.json`. CQL emit (the existing `--target cql` / default behavior) lands at `<project-root>/src/cql/<library-name>.cql`. Library content references the CQL file via the relative path `../../cql/<library-name>.cql`.
 
-For semantic rules, layout details, deliberate spec deviations, and the MCP `emit_crl` tool, see [`USER_GUIDE.md` §"Emitting FHIR Definition resources"](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl/USER_GUIDE.md#emitting-fhir-definition-resources).
+For semantic rules, layout details, deliberate spec deviations, and the MCP `emit_crl` tool, see [`USER_GUIDE.md` §"Emitting FHIR Definition resources"](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl/USER_GUIDE.md#emitting-fhir-definition-resources).
 
 ## API Usage & Reference
 
@@ -490,7 +495,7 @@ Note: This project uses a custom AST implementation that uses ANTLR's visitor pa
 >
 > The authoritative release checklist and instructions are maintained in a single location:
 > 
-> **[.github/PULL_REQUEST_TEMPLATE/release.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/.github/PULL_REQUEST_TEMPLATE/release.md)**
+> **[.github/PULL_REQUEST_TEMPLATE/release.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/.github/PULL_REQUEST_TEMPLATE/release.md)**
 >
 > Always follow the steps in this file when preparing a new release. This ensures consistency and reduces maintenance overhead. If you need to update the release process, update the PR template only.
 
@@ -504,7 +509,7 @@ Note: This project uses a custom AST implementation that uses ANTLR's visitor pa
 - **Generated Files:** Auto-generated files (e.g., ANTLR outputs, grammar-driven types) are ignored by git and should never be edited manually. Always use the provided scripts to regenerate them.
 - **Documentation:** Keep all documentation referencing the release checklist up-to-date by linking to the PR template.
 
-For more details, see the [release PR template](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/.github/PULL_REQUEST_TEMPLATE/release.md) and the automation scripts in `.github/scripts/`.
+For more details, see the [release PR template](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/.github/PULL_REQUEST_TEMPLATE/release.md) and the automation scripts in `.github/scripts/`.
 
 ### Error Handling Strategy
 
@@ -547,7 +552,7 @@ We provide a Visual Studio Code extension for CRL files:
 - Comment support
 - Language basics for a better editing experience
 
-For installation instructions and full details, see [crl-vscode/README.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.0.0/packages/crl-vscode/README.md)
+For installation instructions and full details, see [crl-vscode/README.md](https://github.com/alphora/clinical-reasoning-language/blob/v5.1.1/packages/crl-vscode/README.md)
 
 ## License
 

package/dist/authoring-kit/audit.json

@@ -0,0 +1,7 @@
+{
+    "auditedRevision": "18799337ec6b91e91a4b1577c0e31a7f1b575714",
+    "auditedSchemaVersion": "2.0",
+    "auditedContentHash": "e9870c0042e7cb2e76a66d10b0edc72056786e0a53ccb73dc417544c8753c8b2",
+    "scope": "Unified kit schema 2.0: canonical content unchanged; Markdown MCP retrieval and JSON compatibility reviewed from 451be38f1fc33723cfe44eec12c1add689c5c52b. Prior 301-file survey and explicit clinical/native evidence limitations retained. Transport owning tests and both real MCP entry points verified; see evidence ledger.",
+    "evidence": "packages/crl/src/authoring-kit/tests/coverage.md"
+}

package/dist/authoring-kit/export.d.ts

@@ -0,0 +1,7 @@
+import type { AuthoringKit } from "./types";
+export declare function assertAuditedKit(kit: AuthoringKit): void;
+export declare function exportAuthoringKit(kit: AuthoringKit): {
+    json: string;
+    markdown: string;
+};
+export declare function renderAuthoringKitMarkdown(kit: AuthoringKit): string;

package/dist/authoring-kit/export.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertAuditedKit = assertAuditedKit;
+exports.exportAuthoringKit = exportAuthoringKit;
+exports.renderAuthoringKitMarkdown = renderAuthoringKitMarkdown;
+const node_crypto_1 = require("node:crypto");
+function assertAuditedKit(kit) {
+    const { contentHash, audit, ...content } = kit;
+    const actual = (0, node_crypto_1.createHash)("sha256").update(JSON.stringify(content)).digest("hex");
+    const scopeSchema = new RegExp("\\bschema\\s+" + kit.schemaVersion.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") + "(?![\\d.])", "i");
+    if (actual !== contentHash || audit.auditedContentHash !== actual ||
+        audit.auditedSchemaVersion !== kit.schemaVersion || !audit.contentMatchesAudit ||
+        !/^[0-9a-f]{40}$/.test(audit.auditedRevision) || !scopeSchema.test(audit.scope) || !audit.evidence.trim()) {
+        throw new Error("Kit export requires a completed audit matching this schema and content. Follow crl-kit-update; a build must not advance the stamp.");
+    }
+}
+const title = (key) => key.replace(/([a-z])([A-Z])/g, "$1 $2").replace(/^./, c => c.toUpperCase());
+const prose = (value) => String(value).replace(/(`+)([\s\S]*?)\1|<[^>\n]+>/g, (match, ticks) => ticks ? match : match.replace(/</g, "\\<").replace(/>/g, "\\>"));
+function render(value, depth, language = "text") {
+    if (value === null || typeof value !== "object")
+        return `${prose(value)}\n\n`;
+    if (Array.isArray(value))
+        return value.map((item, i) => {
+            if (item === null || typeof item !== "object")
+                return `- ${prose(item)}\n`;
+            const record = item;
+            const name = record.title ?? record.name ?? record.id ?? record.check ?? record.tier ?? `Item ${i + 1}`;
+            return `${"#".repeat(Math.min(depth, 6))} ${prose(name)}\n\n${render(item, depth + 1, language)}`;
+        }).join("\n") + "\n";
+    const record = value;
+    const sourceLanguage = typeof record.language === "string" ? record.language : language;
+    return Object.entries(record).filter(([, item]) => item !== undefined).map(([key, item]) => {
+        const heading = `${"#".repeat(Math.min(depth, 6))} ${title(key)}\n\n`;
+        if ((key === "source" || key === "snippet") && typeof item === "string") {
+            const longest = Math.max(2, ...(item.match(/`+/g) ?? []).map(run => run.length));
+            const fence = "`".repeat(longest + 1);
+            return `${heading}${fence}${sourceLanguage}\n${item}\n${fence}\n\n`;
+        }
+        return heading + render(item, depth + 1, sourceLanguage);
+    }).join("");
+}
+function exportAuthoringKit(kit) {
+    assertAuditedKit(kit);
+    return {
+        json: JSON.stringify(kit, null, 2) + "\n",
+        markdown: renderAuthoringKitMarkdown(kit),
+    };
+}
+function renderAuthoringKitMarkdown(kit) {
+    return "# CRL authoring kit\n\nGenerated from the canonical kit. The JSON companion preserves its machine-readable structure. " +
+        "The audit identifies reviewed content; it does not certify later implementation changes or clinical fidelity.\n\n" + render(kit, 2);
+}
+//# sourceMappingURL=export.js.map

package/dist/authoring-kit/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/authoring-kit/export.ts"],"names":[],"mappings":";;AAIA,4CASC;AA6BD,gDAMC;AAID,gEAGC;AAvDD,6CAAyC;AAIzC,SAAgB,gBAAgB,CAAC,GAAiB;IAChD,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClF,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,YAAY,EAAE,GAAG,CAAC,CAAC;IAC/H,IAAI,MAAM,KAAK,WAAW,IAAI,KAAK,CAAC,kBAAkB,KAAK,MAAM;QAC7D,KAAK,CAAC,oBAAoB,KAAK,GAAG,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,mBAAmB;QAC9E,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;QAC9G,MAAM,IAAI,KAAK,CAAC,oIAAoI,CAAC,CAAC;IACxJ,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAE3G,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,6BAA6B,EACnF,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAGrF,SAAS,MAAM,CAAC,KAAc,EAAE,KAAa,EAAE,QAAQ,GAAG,MAAM;IAC9D,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IAC9E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACrD,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,OAAO,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3E,MAAM,MAAM,GAAG,IAA+B,CAAC;YAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACxG,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;QACpG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACrB,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,cAAc,GAAG,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IACxF,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;QACzF,MAAM,OAAO,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC;QACtE,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,SAAS,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACxE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;YACjF,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACtC,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,cAAc,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC;QACtE,CAAC;QACD,OAAO,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAgB,kBAAkB,CAAC,GAAiB;IAClD,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI;QACzC,QAAQ,EAAE,0BAA0B,CAAC,GAAG,CAAC;KAC1C,CAAC;AACJ,CAAC;AAID,SAAgB,0BAA0B,CAAC,GAAiB;IAC1D,OAAO,wHAAwH;QAC7H,mHAAmH,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AACzI,CAAC"}

package/dist/authoring-kit/index.d.ts

@@ -1,11 +1,3 @@
-import type { AuthoringEdge, AuthoringKit, AuthoringStage, AuthoringUseCase } from "./types";
-export type { AuthoringEdge, AuthoringKit, AuthoringStage, AuthoringUseCase, KitFacet, } from "./types";
-export declare const DEFAULT_STAGE: AuthoringStage;
-export declare const STAGES: readonly AuthoringStage[];
-export declare const DEFAULT_USE_CASE: AuthoringUseCase;
-export declare const USE_CASES: Record<AuthoringUseCase, {
-    label: string;
-    chain: readonly AuthoringEdge[];
-}>;
-export declare const USE_CASE_NAMES: readonly AuthoringUseCase[];
-export declare function getAuthoringKit(stage?: string, useCase?: string): AuthoringKit;
+import type { AuthoringKit } from "./types";
+export type { AuthoringKit, } from "./types";
+export declare function getAuthoringKit(): AuthoringKit;