@cleocode/lafs 2026.3.74 → 2026.4.3

package/dist/src/compliance.d.ts

@@ -1,31 +1,208 @@
-import type { ConformanceReport, FlagInput, LAFSEnvelope } from "./types.js";
-import { type EnvelopeValidationResult } from "./validateEnvelope.js";
-export type ComplianceStage = "schema" | "envelope" | "flags" | "format";
+import type { ConformanceReport, FlagInput, LAFSEnvelope } from './types.js';
+import { type EnvelopeValidationResult } from './validateEnvelope.js';
+/**
+ * Identifies which stage of the compliance pipeline produced an issue.
+ *
+ * @remarks
+ * Used by {@link ComplianceIssue} to classify where a failure originated
+ * during multi-stage LAFS compliance enforcement.
+ */
+export type ComplianceStage = 'schema' | 'envelope' | 'flags' | 'format';
+/**
+ * Describes a single compliance failure detected during enforcement.
+ *
+ * @remarks
+ * Each issue maps to a specific pipeline stage and includes a human-readable
+ * message with an optional detail string for diagnostics.
+ */
 export interface ComplianceIssue {
+    /** The pipeline stage that produced this issue. */
     stage: ComplianceStage;
+    /** A short, human-readable description of the failure. */
     message: string;
+    /**
+     * Additional diagnostic information about the failure.
+     * @defaultValue undefined
+     */
     detail?: string;
 }
+/**
+ * Options controlling which compliance stages are executed.
+ *
+ * @remarks
+ * All options default to safe values so callers can pass an empty object
+ * and still get schema validation.
+ */
 export interface EnforceComplianceOptions {
+    /**
+     * Whether to run envelope conformance checks after schema validation.
+     * @defaultValue true
+     */
     checkConformance?: boolean;
+    /**
+     * Whether to run flag conformance checks.
+     * @defaultValue false
+     */
     checkFlags?: boolean;
+    /**
+     * Flag input to validate when {@link checkFlags} is enabled.
+     * @defaultValue undefined
+     */
     flags?: FlagInput;
+    /**
+     * When true, asserts that the resolved output format is JSON.
+     * @defaultValue false
+     */
     requireJsonOutput?: boolean;
 }
+/**
+ * Aggregated result of a full LAFS compliance run.
+ *
+ * @remarks
+ * Contains the overall pass/fail status, per-stage reports, and the
+ * parsed envelope when schema validation succeeds.
+ */
 export interface ComplianceResult {
+    /** True when every executed stage passes with zero issues. */
     ok: boolean;
+    /**
+     * The parsed envelope, present only when schema validation succeeds.
+     * @defaultValue undefined
+     */
     envelope?: LAFSEnvelope;
+    /** Schema validation result from the native validator (or AJV fallback). */
     validation: EnvelopeValidationResult;
+    /**
+     * Envelope conformance report, present when {@link EnforceComplianceOptions.checkConformance} is true.
+     * @defaultValue undefined
+     */
     envelopeConformance?: ConformanceReport;
+    /**
+     * Flag conformance report, present when {@link EnforceComplianceOptions.checkFlags} is true.
+     * @defaultValue undefined
+     */
     flagConformance?: ConformanceReport;
+    /** All issues collected across every executed stage. */
     issues: ComplianceIssue[];
 }
+/**
+ * Error thrown when {@link assertCompliance} or {@link withCompliance} detects failures.
+ *
+ * @remarks
+ * Extends `Error` with a structured `issues` array so callers can
+ * programmatically inspect each failure without parsing the message string.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   assertCompliance(envelope);
+ * } catch (err) {
+ *   if (err instanceof ComplianceError) {
+ *     console.log(err.issues);
+ *   }
+ * }
+ * ```
+ */
 export declare class ComplianceError extends Error {
+    /** The structured list of compliance issues that caused this error. */
     readonly issues: ComplianceIssue[];
+    /**
+     * Creates a new ComplianceError from a list of issues.
+     *
+     * @param issues - The compliance issues that triggered this error.
+     */
     constructor(issues: ComplianceIssue[]);
 }
+/**
+ * Runs the full LAFS compliance pipeline against an unknown input value.
+ *
+ * @remarks
+ * Executes stages in order: schema validation, envelope conformance,
+ * flag conformance, and output-format assertion. Each stage is gated
+ * by the corresponding option. Schema validation always runs first;
+ * if it fails, later stages are skipped.
+ *
+ * @param input - The raw value to validate as a LAFS envelope.
+ * @param options - Controls which optional stages execute.
+ * @returns A {@link ComplianceResult} with the aggregate pass/fail status and per-stage reports.
+ *
+ * @example
+ * ```ts
+ * const result = enforceCompliance(rawJson, { checkFlags: true, flags: { jsonFlag: true } });
+ * if (!result.ok) {
+ *   console.error(result.issues);
+ * }
+ * ```
+ */
 export declare function enforceCompliance(input: unknown, options?: EnforceComplianceOptions): ComplianceResult;
+/**
+ * Validates input and throws {@link ComplianceError} on any failure.
+ *
+ * @remarks
+ * Thin wrapper around {@link enforceCompliance} that converts a non-ok
+ * result into an exception. Useful in pipelines where compliance is a
+ * hard gate.
+ *
+ * @param input - The raw value to validate as a LAFS envelope.
+ * @param options - Controls which optional stages execute.
+ * @returns The validated {@link LAFSEnvelope} when all stages pass.
+ * @throws {@link ComplianceError} When any compliance stage fails.
+ *
+ * @example
+ * ```ts
+ * const envelope = assertCompliance(rawJson);
+ * ```
+ */
 export declare function assertCompliance(input: unknown, options?: EnforceComplianceOptions): LAFSEnvelope;
+/**
+ * Wraps an envelope-producing function with automatic compliance enforcement.
+ *
+ * @remarks
+ * Returns a new async function that calls the producer, then pipes the
+ * result through {@link assertCompliance}. If the producer returns a
+ * non-compliant envelope, the wrapper throws {@link ComplianceError}.
+ *
+ * @typeParam TArgs - Argument types forwarded to the producer function.
+ * @typeParam TResult - The envelope subtype returned by the producer.
+ * @param producer - A sync or async function that produces a LAFS envelope.
+ * @param options - Compliance options forwarded to {@link assertCompliance}.
+ * @returns An async function with the same signature that enforces compliance on every call.
+ *
+ * @example
+ * ```ts
+ * const safeFetch = withCompliance(fetchEnvelope, { checkConformance: true });
+ * const envelope = await safeFetch('/api/data');
+ * ```
+ */
 export declare function withCompliance<TArgs extends unknown[], TResult extends LAFSEnvelope>(producer: (...args: TArgs) => TResult | Promise<TResult>, options?: EnforceComplianceOptions): (...args: TArgs) => Promise<LAFSEnvelope>;
+/**
+ * Middleware signature for intercepting LAFS envelopes in a pipeline.
+ *
+ * @remarks
+ * Follows a standard middleware pattern: receive the current envelope,
+ * call `next()` to continue the chain, then optionally transform the result.
+ *
+ * @param envelope - The envelope entering this middleware.
+ * @param next - Callback that invokes the next middleware or terminal handler.
+ * @returns The (possibly transformed) envelope to pass upstream.
+ */
 export type ComplianceMiddleware = (envelope: LAFSEnvelope, next: () => LAFSEnvelope | Promise<LAFSEnvelope>) => Promise<LAFSEnvelope> | LAFSEnvelope;
+/**
+ * Creates a {@link ComplianceMiddleware} that enforces LAFS compliance on the next handler's output.
+ *
+ * @remarks
+ * The returned middleware calls `next()`, then pipes the candidate envelope
+ * through {@link assertCompliance}. Non-compliant envelopes cause a
+ * {@link ComplianceError} to propagate.
+ *
+ * @param options - Compliance options forwarded to {@link assertCompliance}.
+ * @returns A middleware function that validates the downstream envelope.
+ *
+ * @example
+ * ```ts
+ * const mw = createComplianceMiddleware({ checkConformance: true });
+ * const result = await mw(currentEnvelope, () => produceEnvelope());
+ * ```
+ */
 export declare function createComplianceMiddleware(options?: EnforceComplianceOptions): ComplianceMiddleware;
+//# sourceMappingURL=compliance.d.ts.map

package/dist/src/compliance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compliance.d.ts","sourceRoot":"","sources":["../../src/compliance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAEL,KAAK,wBAAwB,EAE9B,MAAM,uBAAuB,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,mDAAmD;IACnD,KAAK,EAAE,eAAe,CAAC;IACvB,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,EAAE,EAAE,OAAO,CAAC;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,4EAA4E;IAC5E,UAAU,EAAE,wBAAwB,CAAC;IACrC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;IACxC;;;OAGG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,wDAAwD;IACxD,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC;IAEnC;;;;OAIG;gBACS,MAAM,EAAE,eAAe,EAAE;CAKtC;AAYD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,OAAO,GAAE,wBAA6B,GACrC,gBAAgB,CA2DlB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,EACd,OAAO,GAAE,wBAA6B,GACrC,YAAY,CAMd;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,cAAc,CAAC,KAAK,SAAS,OAAO,EAAE,EAAE,OAAO,SAAS,YAAY,EAClF,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,EACxD,OAAO,GAAE,wBAA6B,GACrC,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,YAAY,CAAC,CAK3C;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,KAC7C,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,GAAE,wBAA6B,GACrC,oBAAoB,CAKtB"}

package/dist/src/compliance.js

@@ -1,11 +1,35 @@
-import { runEnvelopeConformance, runFlagConformance } from "./conformance.js";
-import { resolveOutputFormat } from "./flagSemantics.js";
-import { assertEnvelope, validateEnvelope } from "./validateEnvelope.js";
+import { runEnvelopeConformance, runFlagConformance } from './conformance.js';
+import { resolveOutputFormat } from './flagSemantics.js';
+import { assertEnvelope, validateEnvelope, } from './validateEnvelope.js';
+/**
+ * Error thrown when {@link assertCompliance} or {@link withCompliance} detects failures.
+ *
+ * @remarks
+ * Extends `Error` with a structured `issues` array so callers can
+ * programmatically inspect each failure without parsing the message string.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   assertCompliance(envelope);
+ * } catch (err) {
+ *   if (err instanceof ComplianceError) {
+ *     console.log(err.issues);
+ *   }
+ * }
+ * ```
+ */
 export class ComplianceError extends Error {
+    /** The structured list of compliance issues that caused this error. */
     issues;
+    /**
+     * Creates a new ComplianceError from a list of issues.
+     *
+     * @param issues - The compliance issues that triggered this error.
+     */
     constructor(issues) {
-        super(`LAFS compliance failed: ${issues.map((issue) => issue.message).join("; ")}`);
-        this.name = "ComplianceError";
+        super(`LAFS compliance failed: ${issues.map((issue) => issue.message).join('; ')}`);
+        this.name = 'ComplianceError';
         this.issues = issues;
     }
 }
@@ -18,14 +42,35 @@ function conformanceIssues(report, stage) {
         detail: check.detail,
     }));
 }
+/**
+ * Runs the full LAFS compliance pipeline against an unknown input value.
+ *
+ * @remarks
+ * Executes stages in order: schema validation, envelope conformance,
+ * flag conformance, and output-format assertion. Each stage is gated
+ * by the corresponding option. Schema validation always runs first;
+ * if it fails, later stages are skipped.
+ *
+ * @param input - The raw value to validate as a LAFS envelope.
+ * @param options - Controls which optional stages execute.
+ * @returns A {@link ComplianceResult} with the aggregate pass/fail status and per-stage reports.
+ *
+ * @example
+ * ```ts
+ * const result = enforceCompliance(rawJson, { checkFlags: true, flags: { jsonFlag: true } });
+ * if (!result.ok) {
+ *   console.error(result.issues);
+ * }
+ * ```
+ */
 export function enforceCompliance(input, options = {}) {
-    const { checkConformance = true, checkFlags = false, flags, requireJsonOutput = false, } = options;
+    const { checkConformance = true, checkFlags = false, flags, requireJsonOutput = false } = options;
     const issues = [];
     const validation = validateEnvelope(input);
     if (!validation.valid) {
         issues.push(...validation.errors.map((error) => ({
-            stage: "schema",
-            message: "schema validation failed",
+            stage: 'schema',
+            message: 'schema validation failed',
             detail: error,
         })));
         return {
@@ -39,22 +84,22 @@ export function enforceCompliance(input, options = {}) {
     if (checkConformance) {
         envelopeConformance = runEnvelopeConformance(envelope);
         if (!envelopeConformance.ok) {
-            issues.push(...conformanceIssues(envelopeConformance, "envelope"));
+            issues.push(...conformanceIssues(envelopeConformance, 'envelope'));
         }
     }
     let flagConformance;
     if (checkFlags && flags) {
         flagConformance = runFlagConformance(flags);
         if (!flagConformance.ok) {
-            issues.push(...conformanceIssues(flagConformance, "flags"));
+            issues.push(...conformanceIssues(flagConformance, 'flags'));
         }
     }
     if (requireJsonOutput) {
         const resolved = resolveOutputFormat(flags ?? {});
-        if (resolved.format !== "json") {
+        if (resolved.format !== 'json') {
             issues.push({
-                stage: "format",
-                message: "non-json output format resolved",
+                stage: 'format',
+                message: 'non-json output format resolved',
                 detail: `resolved format is ${resolved.format}`,
             });
         }
@@ -68,6 +113,24 @@ export function enforceCompliance(input, options = {}) {
         issues,
     };
 }
+/**
+ * Validates input and throws {@link ComplianceError} on any failure.
+ *
+ * @remarks
+ * Thin wrapper around {@link enforceCompliance} that converts a non-ok
+ * result into an exception. Useful in pipelines where compliance is a
+ * hard gate.
+ *
+ * @param input - The raw value to validate as a LAFS envelope.
+ * @param options - Controls which optional stages execute.
+ * @returns The validated {@link LAFSEnvelope} when all stages pass.
+ * @throws {@link ComplianceError} When any compliance stage fails.
+ *
+ * @example
+ * ```ts
+ * const envelope = assertCompliance(rawJson);
+ * ```
+ */
 export function assertCompliance(input, options = {}) {
     const result = enforceCompliance(input, options);
     if (!result.ok || !result.envelope) {
@@ -75,15 +138,53 @@ export function assertCompliance(input, options = {}) {
     }
     return result.envelope;
 }
+/**
+ * Wraps an envelope-producing function with automatic compliance enforcement.
+ *
+ * @remarks
+ * Returns a new async function that calls the producer, then pipes the
+ * result through {@link assertCompliance}. If the producer returns a
+ * non-compliant envelope, the wrapper throws {@link ComplianceError}.
+ *
+ * @typeParam TArgs - Argument types forwarded to the producer function.
+ * @typeParam TResult - The envelope subtype returned by the producer.
+ * @param producer - A sync or async function that produces a LAFS envelope.
+ * @param options - Compliance options forwarded to {@link assertCompliance}.
+ * @returns An async function with the same signature that enforces compliance on every call.
+ *
+ * @example
+ * ```ts
+ * const safeFetch = withCompliance(fetchEnvelope, { checkConformance: true });
+ * const envelope = await safeFetch('/api/data');
+ * ```
+ */
 export function withCompliance(producer, options = {}) {
     return async (...args) => {
         const envelope = await producer(...args);
         return assertCompliance(envelope, options);
     };
 }
+/**
+ * Creates a {@link ComplianceMiddleware} that enforces LAFS compliance on the next handler's output.
+ *
+ * @remarks
+ * The returned middleware calls `next()`, then pipes the candidate envelope
+ * through {@link assertCompliance}. Non-compliant envelopes cause a
+ * {@link ComplianceError} to propagate.
+ *
+ * @param options - Compliance options forwarded to {@link assertCompliance}.
+ * @returns A middleware function that validates the downstream envelope.
+ *
+ * @example
+ * ```ts
+ * const mw = createComplianceMiddleware({ checkConformance: true });
+ * const result = await mw(currentEnvelope, () => produceEnvelope());
+ * ```
+ */
 export function createComplianceMiddleware(options = {}) {
     return async (_envelope, next) => {
         const candidate = await next();
         return assertCompliance(candidate, options);
     };
 }
+//# sourceMappingURL=compliance.js.map

package/dist/src/compliance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compliance.js","sourceRoot":"","sources":["../../src/compliance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EACL,cAAc,EAEd,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AA2F/B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,uEAAuE;IAC9D,MAAM,CAAoB;IAEnC;;;;OAIG;IACH,YAAY,MAAyB;QACnC,KAAK,CAAC,2BAA2B,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,SAAS,iBAAiB,CAAC,MAAyB,EAAE,KAAsB;IAC1E,OAAO,MAAM,CAAC,MAAM;SACjB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;SAC9B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,KAAK;QACL,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,SAAS;QAC/B,MAAM,EAAE,KAAK,CAAC,MAAM;KACrB,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAc,EACd,UAAoC,EAAE;IAEtC,MAAM,EAAE,gBAAgB,GAAG,IAAI,EAAE,UAAU,GAAG,KAAK,EAAE,KAAK,EAAE,iBAAiB,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAElG,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,MAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CACT,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACnC,KAAK,EAAE,QAAiB;YACxB,OAAO,EAAE,0BAA0B;YACnC,MAAM,EAAE,KAAK;SACd,CAAC,CAAC,CACJ,CAAC;QAEF,OAAO;YACL,EAAE,EAAE,KAAK;YACT,UAAU;YACV,MAAM;SACP,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEvC,IAAI,mBAAkD,CAAC;IACvD,IAAI,gBAAgB,EAAE,CAAC;QACrB,mBAAmB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,IAAI,eAA8C,CAAC;IACnD,IAAI,UAAU,IAAI,KAAK,EAAE,CAAC;QACxB,eAAe,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,QAAQ,GAAG,mBAAmB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAClD,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,QAAQ;gBACf,OAAO,EAAE,iCAAiC;gBAC1C,MAAM,EAAE,sBAAsB,QAAQ,CAAC,MAAM,EAAE;aAChD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QACvB,QAAQ;QACR,UAAU;QACV,mBAAmB;QACnB,eAAe;QACf,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAc,EACd,UAAoC,EAAE;IAEtC,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,MAAM,CAAC,QAAQ,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,cAAc,CAC5B,QAAwD,EACxD,UAAoC,EAAE;IAEtC,OAAO,KAAK,EAAE,GAAG,IAAW,EAAyB,EAAE;QACrD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACzC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC;AACJ,CAAC;AAkBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,0BAA0B,CACxC,UAAoC,EAAE;IAEtC,OAAO,KAAK,EAAE,SAAuB,EAAE,IAAgD,EAAE,EAAE;QACzF,MAAM,SAAS,GAAG,MAAM,IAAI,EAAE,CAAC;QAC/B,OAAO,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/conformance.d.ts

@@ -1,7 +1,60 @@
-import type { ConformanceReport, FlagInput } from "./types.js";
-import { type ConformanceTier } from "./conformanceProfiles.js";
+import { type ConformanceTier } from './conformanceProfiles.js';
+import type { ConformanceReport, FlagInput } from './types.js';
+/**
+ * Options for configuring envelope conformance checking.
+ *
+ * @remarks
+ * When a tier is specified, only the checks belonging to that tier (and below)
+ * are included in the final report.
+ */
 export interface EnvelopeConformanceOptions {
+    /**
+     * The conformance tier to filter checks by.
+     * @defaultValue undefined
+     */
     tier?: ConformanceTier;
 }
+/**
+ * Runs the full suite of LAFS envelope conformance checks.
+ *
+ * @remarks
+ * Validates schema, envelope invariants, error-code registration,
+ * agent-action validity, transport mapping consistency, context mutation
+ * rules, MVI level, strict-mode behavior, pagination mode consistency,
+ * strict-mode enforcement, and context preservation. When a
+ * {@link EnvelopeConformanceOptions.tier} is specified, only checks
+ * belonging to that tier are included in the returned report.
+ *
+ * @param envelope - The raw value to validate as a LAFS envelope.
+ * @param options - Optional tier filter for the conformance checks.
+ * @returns A {@link ConformanceReport} with individual check results and an overall pass/fail.
+ *
+ * @example
+ * ```ts
+ * const report = runEnvelopeConformance(parsedJson, { tier: 'core' });
+ * if (!report.ok) {
+ *   console.error(report.checks.filter(c => !c.pass));
+ * }
+ * ```
+ */
 export declare function runEnvelopeConformance(envelope: unknown, options?: EnvelopeConformanceOptions): ConformanceReport;
+/**
+ * Runs LAFS flag-semantics conformance checks against a set of flag inputs.
+ *
+ * @remarks
+ * Verifies that conflicting flags (`--human` + `--json`) are properly rejected,
+ * the protocol default resolves to JSON, and project/user config overrides are
+ * respected. Catches {@link LAFSFlagError} with code `E_FORMAT_CONFLICT` as a
+ * valid conformance outcome.
+ *
+ * @param flags - The flag input to validate.
+ * @returns A {@link ConformanceReport} with individual check results and an overall pass/fail.
+ *
+ * @example
+ * ```ts
+ * const report = runFlagConformance({ humanFlag: true, jsonFlag: false });
+ * console.log(report.ok); // true
+ * ```
+ */
 export declare function runFlagConformance(flags: FlagInput): ConformanceReport;
+//# sourceMappingURL=conformance.d.ts.map

package/dist/src/conformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conformance.d.ts","sourceRoot":"","sources":["../../src/conformance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAoB,MAAM,0BAA0B,CAAC;AAGlF,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAa/D;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,OAAO,EACjB,OAAO,GAAE,0BAA+B,GACvC,iBAAiB,CA8UnB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,GAAG,iBAAiB,CA+CtE"}