@openpresentation/opf 0.14.0 → 0.16.0

package/dist/json-BFSdESOE.d.ts

@@ -0,0 +1,19 @@
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+interface JsonObject {
+    readonly [key: string]: JsonValue;
+}
+/**
+ * Structural shape of a bundled JSON Schema document (the schema itself, not
+ * data validated against it). Kept intentionally loose — `$id`/`$schema` are
+ * typed precisely because callers rely on them (see `src/validator.ts`), and
+ * everything else falls through the index signature. This avoids inferring a
+ * deeply-nested literal type for every property/subschema, which is what
+ * previously made `dist/schemas.d.ts` balloon to hundreds of KB.
+ */
+interface JsonSchemaDocument extends JsonObject {
+    readonly $id: string;
+    readonly $schema: string;
+}
+
+export type { JsonPrimitive as J, JsonSchemaDocument as a, JsonObject as b };

package/dist/markdown.d.ts

@@ -1,10 +1,10 @@
-import { P as Presentation } from './presentation-C5eHkevA.js';
-import { F as Finding, d as FindingLocation, e as FindingReport } from './finding-C_por275.js';
-import { V as ValidateOptions } from './validation-types-zh03LeZy.js';
-import './catalogs-D-yyQWCQ.js';
-import './schemas-DDpqAgyS.js';
-import './composition-_WEwBe2a.js';
-import './chart-data-B_3z9VTb.js';
+import { C as Catalog } from './catalog-refs-_anZs-Qz.js';
+import { P as Presentation } from './presentation-COrFuj2g.js';
+import { a as Finding, b as FindingLocation } from './finding-CT_f_vbD.js';
+import { V as ValidateOptions, a as ValidationReport } from './validation-types-HxIgJfKx.js';
+import './composition-D4ADF5c-.js';
+import './chart-data-BnNqgnC-.js';
+import './json-BFSdESOE.js';
 
 interface EmbeddedPart {
     /** JSON Pointer into the OPF document. */
@@ -24,6 +24,16 @@ interface ParseOptions {
     split?: "rules" | "headings";
 }
 
+/**
+ * Deterministic Markdown to OPF and OPF to Markdown conversion for the OPF Markdown dialect (RR-30): YAML front
+ * matter for deck metadata, `---` between slides, `#` title, `##` subtitle, paragraphs, lists, block quotes with
+ * a dash attribution, fenced code, pipe tables, images, `chart`, `metric` and `timeline` fences, `Note:` speaker
+ * notes and HTML comments for slide and block options. Anything the dialect has no syntax for is embedded as YAML
+ * (`opf-slide`, `opf-block`) so a round trip loses nothing, or dropped and reported on request.
+ *
+ * No renderer, fonts, DOM, network or model calls. The same input always gives the same output.
+ */
+
 interface FromMarkdownOptions extends ParseOptions {
     /** Deck properties used when the front matter does not set them (for example `{ name: "Title" }`). The front matter wins. */
     defaults?: Record<string, unknown>;
@@ -32,8 +42,10 @@ interface FromMarkdownOptions extends ParseOptions {
      * `format` and `references`; options pick other rules or categories; `false` skips the check.
      */
     validate?: boolean | ValidateOptions;
+    /** Catalogs the host registered, for the references check of `validate: true` (the default). Nothing is fetched. */
+    catalogs?: readonly Catalog[];
 }
-interface FromMarkdownResult {
+interface FromMarkdownResult extends ValidationReport {
     /** The converted deck. Always an object; when `valid` is false it is a best effort that does not validate. */
     presentation: Presentation;
     /** True when there are no errors (Markdown syntax errors and OPF validation errors both count). */
@@ -42,7 +54,6 @@ interface FromMarkdownResult {
     findings: (Finding & {
         location: FindingLocation;
     })[];
-    counts: FindingReport["counts"];
 }
 /** Convert Markdown in the OPF dialect to an OPF document. Never throws for malformed content; read `valid` and `findings`. */
 declare function fromMarkdown(markdown: string, options?: FromMarkdownOptions): FromMarkdownResult;

package/dist/markdown.js

@@ -1,9 +1,9 @@
-export { fromMarkdown, toMarkdown } from './chunk-UPQQD7MA.js';
-export { OPFMarkdownError } from './chunk-4LDGKLUC.js';
-import './chunk-4VJDTF55.js';
-import './chunk-CSQHPVGL.js';
-import './chunk-JDJBDYSR.js';
-import './chunk-6OXY2CP3.js';
-import './chunk-S5W34SIJ.js';
-import './chunk-XOZ4KMSR.js';
-import './chunk-LS2FMPI5.js';
+export { fromMarkdown, toMarkdown } from './chunk-FQSIIADJ.js';
+export { OPFMarkdownError } from './chunk-5UEUAW57.js';
+import './chunk-NAWQR7MN.js';
+import './chunk-5TO6I3GB.js';
+import './chunk-PX5AWL7Y.js';
+import './chunk-5PDN7BN6.js';
+import './chunk-TRDXRRQK.js';
+import './chunk-SPFV27O5.js';
+import './chunk-WEDGVC5W.js';

package/dist/{pagination-BZpXLvFL.d.ts → pagination-DzZPFheM.d.ts}

@@ -1,41 +1,26 @@
-import { a as FontSchemeDiagnostic, C as ComposeSlideOptions, b as Fonts, c as LayoutDiagnostic } from './composition-_WEwBe2a.js';
-import { C as CatalogKind } from './catalogs-D-yyQWCQ.js';
+import { C as ComposeSlideOptions, F as Fonts, L as LayoutDiagnostic } from './composition-D4ADF5c-.js';
+import { U as UnresolvedReferenceDiagnostic, R as RecordProvenance, b as CatalogOptions } from './catalog-refs-_anZs-Qz.js';
 
 /**
  * One slide's composition context: the layout, canvas, theme and font families that `composeSlide` needs,
  * resolved the one way every engine must resolve them (slide design, then deck design, then theme, then the
  * engine default, per field). Core pagination, the layout checks, the renderer, the exporter and the editor
- * each used to rebuild this chain by hand. Catalogs load here, so this lives at the package root, not in the
- * catalog-free `/composition` entry.
+ * all call this, with the same `catalogs` option, so preview and export resolve the same records.
  */
 type Rec = Record<string, any>;
-/** Reported when a reference resolves to nothing, so the slide still composes with documented fallbacks. */
-interface SlideContextReferenceDiagnostic {
-    code: 'unresolved-layout' | 'unresolved-theme' | 'unresolved-color-scheme';
-    /** Where the unresolved id is written: `slides.N.layout`, `slides.N.design.theme`, `design.colorScheme` and so on. */
-    path: string;
-    /** The id that matched no inline, host or bundled record. */
-    id: string;
-    /** The record used instead: `minimal` for a theme, `cool-horizon` for a colour scheme. Absent for a layout, which has no substitute. */
-    fallback?: string;
-    message: string;
-}
-/**
- * An unresolved font scheme falls back to DEFAULT_FONT_SCHEME, a theme to `minimal` and a colour scheme to `cool-horizon`;
- * an unresolved layout composes with no layout record (automatic composition). None of them throws.
- */
-type SlideContextDiagnostic = FontSchemeDiagnostic | SlideContextReferenceDiagnostic;
-interface SlideContextOptions {
+/** A reference that resolves nowhere, so the slide composes with the automatic layout or the engine default. */
+type SlideContextDiagnostic = UnresolvedReferenceDiagnostic;
+interface SlideContextOptions extends CatalogOptions {
     /** The fonts handle; core reads its `textMeasurement`. Without it composition uses core's portable estimate. */
     fonts?: Fonts;
-    /** Host catalog records, consulted after the deck's inline `catalogs` and before the bundled ones. */
-    catalogs?: Partial<Record<CatalogKind, readonly unknown[]>>;
     /** One-based displayed slide number. Default: index + 1. */
     slideNumber?: number;
     /** Displayed slide count for `{total}`. Default: the deck's slide count. */
     slideCount?: number;
     /** Host-supplied current calendar date (ISO YYYY-MM-DD) for `date: true` header/footer fields. */
     date?: string;
+    /** Throw OPFUnresolvedReferenceError for a reference that resolves nowhere, instead of falling back (strict export). */
+    strictReferences?: boolean;
 }
 interface SlideContext {
     /** Ready for `composeSlide(slide, options)`. */
@@ -46,15 +31,28 @@ interface SlideContext {
         theme: Rec;
         colorScheme: Rec;
         fontScheme: Rec;
-        /** Where the font scheme reference is written, dotted like `FontSchemeDiagnostic.path`. */
+        /** Where the font scheme reference is written, dotted. */
         fontSchemePath: string;
+        /** The layout record, when the slide names one that resolves. */
+        layout?: Rec;
+        /**
+         * Where each resolved record came from: `{ kind, reference, id, group, source?, origin }` (origin `document` for an
+         * embedded record, `host` for a registered catalog's). A kind is absent when nothing resolved for it (the engine
+         * default, or automatic composition for a layout), so engines record provenance without resolving again.
+         */
+        provenance: {
+            layout?: RecordProvenance;
+            theme?: RecordProvenance;
+            colorScheme?: RecordProvenance;
+            fontScheme?: RecordProvenance;
+        };
     };
 }
 /**
  * Resolve slide `index` of `presentation` into the options `composeSlide` takes. Never throws for an unresolved
- * reference: the fallback applies and `diagnostics` says what was missed (`unresolved-font-scheme`,
- * `unresolved-layout`, `unresolved-theme`, `unresolved-color-scheme`). Throws a RangeError for an index outside the deck or non-positive
- * canvas dimensions, which a schema-valid deck cannot have.
+ * reference unless `strictReferences` is set: the engine default (or automatic composition, for a layout) applies and
+ * `diagnostics` holds one `unresolved-reference` per reference. Throws a RangeError for an index outside the deck or
+ * non-positive canvas dimensions, which a schema-valid deck cannot have.
  */
 declare function resolveSlideContext(presentation: unknown, index: number, options?: SlideContextOptions): SlideContext;
 
@@ -95,7 +93,7 @@ declare class OPFPaginationError extends Error {
 }
 /** Explicit, lossless authoring transform. It never changes slide count during rendering. */
 declare function paginateSlide(input: unknown, options?: PaginationOptions): PaginationResult;
-interface PresentationPaginationOptions {
+interface PresentationPaginationOptions extends CatalogOptions {
     /** The fonts handle: page breaks are chosen with its `textMeasurement`. Without it core uses its portable estimate. */
     fonts?: Fonts;
     /** Unscaled reference-pixel clearance for supplied vector text outlines. */
@@ -104,7 +102,9 @@ interface PresentationPaginationOptions {
     maxSlides?: number;
     /** Host-supplied current calendar date (ISO YYYY-MM-DD) for `date: true` header/footer fields. */
     date?: string;
-    /** Receives each `unresolved-font-scheme`, `unresolved-theme`, `unresolved-color-scheme` and `unresolved-layout` diagnostic once per reference path; pagination continues with the fallback. */
+    /** Throw OPFUnresolvedReferenceError for a reference that resolves nowhere, instead of falling back (strict export). */
+    strictReferences?: boolean;
+    /** Receives each `unresolved-reference` diagnostic once per reference path; pagination continues with the fallback. */
     onDiagnostic?: (diagnostic: SlideContextDiagnostic) => void;
 }
 interface PresentationPaginationResult {
@@ -113,7 +113,7 @@ interface PresentationPaginationResult {
         sourceSlideIndex: number;
     })[];
 }
-/** Resolve local catalogs and paginate a complete presentation without mutating it. */
+/** Resolve the slides' references (the document's catalogs groups, then the registered catalogs) and paginate a complete presentation without mutating it. */
 declare function paginate(input: unknown, options?: PresentationPaginationOptions): PresentationPaginationResult;
 
-export { OPFPaginationError as O, type PaginatedPage as P, type SlideContext as S, type PaginationMapping as a, type PaginationOptions as b, type PaginationResult as c, type PresentationPaginationOptions as d, type PresentationPaginationResult as e, type SlideContextDiagnostic as f, type SlideContextOptions as g, type SlideContextReferenceDiagnostic as h, paginateSlide as i, paginate as p, resolveSlideContext as r };
+export { OPFPaginationError as O, type PaginatedPage as P, type SlideContext as S, type PaginationMapping as a, type PaginationOptions as b, type PaginationResult as c, type PresentationPaginationOptions as d, type PresentationPaginationResult as e, type SlideContextDiagnostic as f, type SlideContextOptions as g, paginateSlide as h, paginate as p, resolveSlideContext as r };

package/dist/pagination.d.ts

@@ -1,5 +1,4 @@
-import './composition-_WEwBe2a.js';
-export { O as OPFPaginationError, P as PaginatedPage, a as PaginationMapping, b as PaginationOptions, c as PaginationResult, d as PresentationPaginationOptions, e as PresentationPaginationResult, p as paginate, i as paginateSlide } from './pagination-BZpXLvFL.js';
-import './chart-data-B_3z9VTb.js';
-import './catalogs-D-yyQWCQ.js';
-import './schemas-DDpqAgyS.js';
+import './composition-D4ADF5c-.js';
+import './catalog-refs-_anZs-Qz.js';
+export { O as OPFPaginationError, P as PaginatedPage, a as PaginationMapping, b as PaginationOptions, c as PaginationResult, d as PresentationPaginationOptions, e as PresentationPaginationResult, p as paginate, h as paginateSlide } from './pagination-DzZPFheM.js';
+import './chart-data-BnNqgnC-.js';

package/dist/pagination.js

@@ -1,6 +1,6 @@
-export { OPFPaginationError, paginate, paginateSlide } from './chunk-XIZUK2XM.js';
-import './chunk-JDJBDYSR.js';
-import './chunk-6OXY2CP3.js';
-import './chunk-S5W34SIJ.js';
-import './chunk-XOZ4KMSR.js';
-import './chunk-LS2FMPI5.js';
+export { OPFPaginationError, paginate, paginateSlide } from './chunk-BSYQDWT4.js';
+import './chunk-PX5AWL7Y.js';
+import './chunk-5PDN7BN6.js';
+import './chunk-TRDXRRQK.js';
+import './chunk-SPFV27O5.js';
+import './chunk-WEDGVC5W.js';

package/dist/patch.d.ts

@@ -1,4 +1,4 @@
-import { e as FindingReport, F as Finding, J as JsonPatchOperation } from './finding-C_por275.js';
+import { F as FindingReport, a as Finding, J as JsonPatchOperation } from './finding-CT_f_vbD.js';
 
 type JsonPointer = string;
 type PatchErrorCode = "invalid-patch" | "invalid-patch-operation" | "unsupported-patch-operation" | "invalid-json-pointer" | "patch-path-missing" | "patch-parent-missing" | "invalid-array-index" | "patch-test-failed" | "patch-invalid-move" | "patch-root-remove" | "patch-invalid-document";

package/dist/patch.js

@@ -1,6 +1,6 @@
-export { OPFPatchError, OPFPatchValidationError, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken } from './chunk-BFLVSVA7.js';
-import './chunk-JDJBDYSR.js';
-import './chunk-6OXY2CP3.js';
-import './chunk-S5W34SIJ.js';
-import './chunk-XOZ4KMSR.js';
-import './chunk-LS2FMPI5.js';
+export { OPFPatchError, OPFPatchValidationError, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken } from './chunk-3XDRQYWZ.js';
+import './chunk-PX5AWL7Y.js';
+import './chunk-5PDN7BN6.js';
+import './chunk-TRDXRRQK.js';
+import './chunk-SPFV27O5.js';
+import './chunk-WEDGVC5W.js';