@openpresentation/opf 0.14.0 → 0.15.1

package/dist/{validation-types-zh03LeZy.d.ts → validation-types-BOcY9GTs.d.ts}

@@ -1,7 +1,7 @@
-import { C as CatalogKind } from './catalogs-D-yyQWCQ.js';
-import { T as TextMeasurement } from './composition-_WEwBe2a.js';
-import { f as FindingSeverity, e as FindingReport } from './finding-C_por275.js';
-import { J as JsonPrimitive } from './schemas-DDpqAgyS.js';
+import { a as Catalog } from './catalog-refs-BSfGELpt.js';
+import { T as TextMeasurement } from './composition-D2tghM82.js';
+import { c as FindingSeverity, F as FindingReport } from './finding-CT_f_vbD.js';
+import { J as JsonPrimitive } from './json-BFSdESOE.js';
 
 /**
  * Template variables: typed, named values a deck declares once and uses in many
@@ -226,8 +226,8 @@ interface ValidateOptions {
         rule: string;
         path: string;
     }[];
-    /** Catalog records already loaded by the host, consulted after the document's own `catalogs`. Nothing is fetched. */
-    catalogs?: Partial<Record<CatalogKind, readonly unknown[]>>;
+    /** Catalogs the host registered, matched by source; the first is the host default for an omitted catalogs.default. Nothing is fetched. */
+    catalogs?: readonly Catalog[];
     /** Host policy (category `policy`). */
     contracts?: readonly Contract[];
     thresholds?: Partial<ValidationThresholds>;
@@ -244,7 +244,7 @@ interface ValidationChecks {
     /** `checked` for text input (JSON syntax and duplicate keys), `not-applicable` for a parsed document. */
     syntax: 'checked' | 'not-applicable';
     schema: 'checked' | 'not-run';
-    /** Catalog ids, assets, datasets and references, resolved against the document, supplied catalogs and the bundled ones. Nothing is fetched. */
+    /** Content references, assets, datasets and citations, resolved against the document's catalogs groups and the registered catalogs. Nothing is fetched. */
     references: 'checked' | 'not-run';
     policy: 'checked' | 'not-run';
     accessibility: 'checked' | 'not-run';

package/dist/validator.d.ts

@@ -1,11 +1,13 @@
-import { C as CatalogKind } from './catalogs-D-yyQWCQ.js';
-import { F as Finding } from './finding-C_por275.js';
-import { P as Presentation } from './presentation-C5eHkevA.js';
-import { i as ValidationThresholds, h as ValidationRuleInfo, a as ValidationReport, V as ValidateOptions } from './validation-types-zh03LeZy.js';
-export { C as Contract, d as ValidateFonts, e as ValidationCategory, f as ValidationChecks, g as ValidationRuleCost, z as validationCategories } from './validation-types-zh03LeZy.js';
-import './schemas-DDpqAgyS.js';
-import './composition-_WEwBe2a.js';
-import './chart-data-B_3z9VTb.js';
+import { a as CatalogRecordKind } from './catalog-schemas-CinPh5WA.js';
+import { a as Finding } from './finding-CT_f_vbD.js';
+import { P as Presentation } from './presentation-CDKQVkyI.js';
+import { i as ValidationThresholds, h as ValidationRuleInfo, a as ValidationReport, V as ValidateOptions } from './validation-types-BOcY9GTs.js';
+export { C as Contract, d as ValidateFonts, e as ValidationCategory, f as ValidationChecks, g as ValidationRuleCost, z as validationCategories } from './validation-types-BOcY9GTs.js';
+import './catalog-refs-BSfGELpt.js';
+import './schemas.js';
+import './json-BFSdESOE.js';
+import './composition-D2tghM82.js';
+import './chart-data-BnNqgnC-.js';
 
 /**
  * The series palette opf-render and opf-pptx draw charts with (`CHART_COLORS`), in series order. A host with
@@ -51,10 +53,11 @@ declare function validate(input: unknown, options?: ValidateOptions): Validation
  */
 declare function assertValid(value: unknown, options?: ValidateOptions): asserts value is Presentation;
 /**
- * Check one catalog record (an audience, theme, layout, font scheme and so on) against its schema. The report has the same
- * shape as `validate`'s; every finding is `format` and a record that links to an unknown id warns.
+ * Check one published catalog record file (an audience, theme, layout, font scheme, chart type and so on) against its
+ * companion schema, `$schema` and `id` included. The report has the same shape as `validate`'s; every finding is `format`.
+ * A record a document embeds is checked by `validate`, keyed by its id and without `$schema`.
  */
-declare function validateCatalogRecord(kind: CatalogKind, value: unknown): ValidationReport;
-declare function assertValidCatalogRecord(kind: CatalogKind, value: unknown): void;
+declare function validateCatalogRecord(kind: CatalogRecordKind, value: unknown): ValidationReport;
+declare function assertValidCatalogRecord(kind: CatalogRecordKind, value: unknown): void;
 
 export { DEFAULT_CHART_PALETTE, DEFAULT_VALIDATION_THRESHOLDS, OPFValidationError, ValidateOptions, ValidationReport, ValidationRuleInfo, ValidationThresholds, assertValid, assertValidCatalogRecord, findValidationRule, promotedRegionKeys, validate, validateCatalogRecord, validationRules };

package/dist/validator.js

@@ -1,5 +1,5 @@
-export { DEFAULT_CHART_PALETTE, DEFAULT_VALIDATION_THRESHOLDS, OPFValidationError, assertValid, assertValidCatalogRecord, findValidationRule, validate, validateCatalogRecord, validationCategories, validationRules } from './chunk-JDJBDYSR.js';
-export { promotedRegionKeys } from './chunk-6OXY2CP3.js';
-import './chunk-S5W34SIJ.js';
-import './chunk-XOZ4KMSR.js';
-import './chunk-LS2FMPI5.js';
+export { DEFAULT_CHART_PALETTE, DEFAULT_VALIDATION_THRESHOLDS, OPFValidationError, assertValid, assertValidCatalogRecord, findValidationRule, validate, validateCatalogRecord, validationCategories, validationRules } from './chunk-QDI75P2M.js';
+export { promotedRegionKeys } from './chunk-O744SXXA.js';
+import './chunk-TRDXRRQK.js';
+import './chunk-SPFV27O5.js';
+import './chunk-2CJPC4HI.js';

package/dist/yaml.d.ts

@@ -1,10 +1,10 @@
-import { P as Presentation } from './presentation-C5eHkevA.js';
-import { V as ValidateOptions, a as ValidationReport } from './validation-types-zh03LeZy.js';
-import { F as Finding, d as FindingLocation } from './finding-C_por275.js';
-import './catalogs-D-yyQWCQ.js';
-import './schemas-DDpqAgyS.js';
-import './composition-_WEwBe2a.js';
-import './chart-data-B_3z9VTb.js';
+import { a as Catalog } from './catalog-refs-BSfGELpt.js';
+import { P as Presentation } from './presentation-CDKQVkyI.js';
+import { V as ValidateOptions, a as ValidationReport } from './validation-types-BOcY9GTs.js';
+import { a as Finding, b as FindingLocation } from './finding-CT_f_vbD.js';
+import './composition-D2tghM82.js';
+import './chart-data-BnNqgnC-.js';
+import './json-BFSdESOE.js';
 
 /** A finding located in the YAML source: `yaml/<rule>` syntax and dialect errors (category `format`) and the OPF findings of the parsed deck. */
 type YamlFinding = Finding & {
@@ -19,6 +19,19 @@ interface YamlComments {
 /** Find the comments of a YAML text (they are lost when a command rewrites the file) and its editor modeline. */
 declare function scanYamlComments(source: string): YamlComments;
 
+/**
+ * OPF as YAML (RR-56): read a deck written as YAML and write any valid deck as YAML, with no renderer, fonts, network
+ * or model. JSON stays the canonical form; `.opf.yaml` is an authoring serialization of the same data.
+ *
+ * The reader accepts one dialect, strict by default: JSON-compatible YAML 1.2 (core schema) with exactly one document
+ * whose root is a mapping, no duplicate keys, no custom tags, no anchors, aliases or merge keys (opt in with
+ * `aliases: true`) and only finite numbers. Errors carry the offset, line and column of the YAML that caused them,
+ * including the OPF validation findings mapped back to the YAML of the field they name. The writer emits canonical schema key
+ * order, 2-space block style and quoted ambiguous strings, and reads its own output back before returning it.
+ *
+ * The same input always gives the same output.
+ */
+
 /** The canonical schema URL (`$id` of the presentation schema), used by `schemaComment`. */
 declare const YAML_SCHEMA_URL: string;
 interface FromYamlOptions {
@@ -27,6 +40,8 @@ interface FromYamlOptions {
      * and `references`; options pick other rules or categories (`{}` runs every rule); `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[];
     /**
      * Expand anchors, aliases and `<<` merge keys (default false: they are an error). The expansion is capped at 100 aliases
      * and an alias inside its own anchor is rejected, so the result is always finite JSON-compatible data.

package/dist/yaml.js

@@ -1,11 +1,11 @@
-import { Ctx } from './chunk-4LDGKLUC.js';
-import { sortPresentationKeys } from './chunk-5ZU6JAPP.js';
-import { same } from './chunk-CSQHPVGL.js';
-import { validate } from './chunk-JDJBDYSR.js';
-import './chunk-6OXY2CP3.js';
-import './chunk-S5W34SIJ.js';
-import './chunk-XOZ4KMSR.js';
-import { presentation } from './chunk-LS2FMPI5.js';
+import { Ctx } from './chunk-3RKB4RDJ.js';
+import { sortPresentationKeys } from './chunk-ZPU46TFA.js';
+import { same } from './chunk-VGAOJEY7.js';
+import { validate } from './chunk-QDI75P2M.js';
+import './chunk-O744SXXA.js';
+import './chunk-TRDXRRQK.js';
+import { checkCatalogsOption } from './chunk-SPFV27O5.js';
+import { presentation } from './chunk-2CJPC4HI.js';
 import { Parser, parseDocument, isMap, Document, visit, isScalar, isAlias, isSeq } from 'yaml';
 
 var MAX_ALIAS_COUNT = 100;
@@ -262,11 +262,12 @@ var YAML_SCHEMA_URL = presentation.$id;
 var NOT_CHECKED = { syntax: "checked", schema: "not-run", references: "not-run", policy: "not-run", accessibility: "not-run", content: "not-run", layout: "not-run", backgroundPixels: "not-read", imageBytes: "embedded-only", nativeExport: "not-checked" };
 function fromYaml(yaml, options = {}) {
   if (typeof yaml !== "string") throw new TypeError("fromYaml expects a string.");
+  checkCatalogsOption(options.catalogs, "fromYaml");
   const parsed = readYamlDocument(yaml, options.aliases === true);
   const findings = [...parsed.findings];
   let report = { schemaValid: null, checks: NOT_CHECKED };
   if (!parsed.errors && options.validate !== false) {
-    const checked = validate(parsed.value, options.validate === true || options.validate === void 0 ? { only: ["format", "references"] } : options.validate);
+    const checked = validate(parsed.value, options.validate === true || options.validate === void 0 ? { only: ["format", "references"], ...options.catalogs ? { catalogs: options.catalogs } : {} } : options.validate);
     report = {
       schemaValid: checked.schemaValid,
       checks: { ...checked.checks, syntax: "checked" },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openpresentation/opf",
-  "version": "0.14.0",
-  "description": "Canonical Open Presentation Format schemas, catalogs, TypeScript types, and local validation.",
+  "version": "0.15.1",
+  "description": "Canonical Open Presentation Format schemas, TypeScript types, local validation and composition; the pinned default catalog ships as the opt-in @openpresentation/opf/catalog.",
   "license": "MIT",
   "author": "Open Presentation",
   "homepage": "https://openpresentation.org",
@@ -38,9 +38,9 @@
       "types": "./dist/schemas.d.ts",
       "import": "./dist/schemas.js"
     },
-    "./catalogs": {
-      "types": "./dist/catalogs.d.ts",
-      "import": "./dist/catalogs.js"
+    "./catalog": {
+      "types": "./dist/catalog.d.ts",
+      "import": "./dist/catalog.js"
     },
     "./validator": {
       "types": "./dist/validator.d.ts",
@@ -54,10 +54,6 @@
       "types": "./dist/spec-files.d.ts",
       "import": "./dist/spec-files.js"
     },
-    "./previews": {
-      "types": "./dist/previews.d.ts",
-      "import": "./dist/previews.js"
-    },
     "./examples": {
       "types": "./dist/examples.d.ts",
       "import": "./dist/examples.js"