@openpresentation/opf 0.16.0 → 0.18.1

package/dist/data.d.ts

@@ -1,4 +1,4 @@
-import { C as Chart } from './presentation-COrFuj2g.js';
+import { C as Chart } from './presentation-HondgJ3l.js';
 export { C as ChartMapping, a as ChartNumberFix, b as ChartNumberFixOperation, c as ChartNumberFixOptions, D as DataCellValue, d as DataColumn, e as DataDiagnostic, f as DataDiagnosticCode, g as DataResolveOptions, h as DataSourceRef, i as DataStyledCell, j as DataTableCell, k as DataTableHeader, l as DataTableValue, m as DataTextRun, n as Dataset, o as DatasetRef, R as ResolvedChartData, p as ResolvedTableData, q as chartNumber, r as datasetDiagnostics, s as formatDataNumber, t as fromExcelNumberFormat, u as inlineChartData, v as inlineDatasets, w as inlineTableData, x as isDatasetRef, y as isXYChartType, z as numberFormatError, A as resolveChartData, B as resolveTableData, E as suggestChartNumberFix, F as tableCellDisplayValue, G as toExcelNumberFormat, H as unusedDatasets } from './chart-data-BnNqgnC-.js';
 
 type DataCell = string | number | boolean | null;
@@ -28,7 +28,7 @@ interface DataImportOptions {
     header?: boolean;
     columns?: string[];
 }
-interface ImportDataOptions extends DataImportOptions {
+interface IngestOptions extends DataImportOptions {
     as: 'table' | 'chart';
     /** Default `column`. Values outside `CHART_TYPES` make an invalid chart; the CLI checks `--chart-type` first. */
     chartType?: ImportedChartType;
@@ -39,12 +39,12 @@ declare class OPFDataImportError extends Error {
     constructor(message: string);
 }
 declare function parseTabularData(input: unknown, options?: DataImportOptions): TabularData;
-declare function importData(input: unknown, options: ImportDataOptions & {
+declare function ingest(input: unknown, options: IngestOptions & {
     as: 'table';
 }): ImportedTable;
-declare function importData(input: unknown, options: ImportDataOptions & {
+declare function ingest(input: unknown, options: IngestOptions & {
     as: 'chart';
 }): ImportedChart;
-declare function importData(input: unknown, options: ImportDataOptions): ImportedTable | ImportedChart;
+declare function ingest(input: unknown, options: IngestOptions): ImportedTable | ImportedChart;
 
-export { type DataCell, type DataImportOptions, type ImportDataOptions, type ImportedChart, type ImportedChartData, type ImportedChartType, type ImportedTable, OPFDataImportError, type TabularData, importData, parseTabularData };
+export { type DataCell, type DataImportOptions, type ImportedChart, type ImportedChartData, type ImportedChartType, type ImportedTable, type IngestOptions, OPFDataImportError, type TabularData, ingest, parseTabularData };

package/dist/data.js

@@ -1,3 +1,3 @@
-export { OPFDataImportError, importData, parseTabularData } from './chunk-SMLMI6IZ.js';
-export { chartNumber, datasetDiagnostics, formatDataNumber, fromExcelNumberFormat, inlineChartData, inlineDatasets, inlineTableData, isDatasetRef, isXYChartType, numberFormatError, resolveChartData, resolveTableData, suggestChartNumberFix, tableCellDisplayValue, toExcelNumberFormat, unusedDatasets } from './chunk-5PDN7BN6.js';
+export { OPFDataImportError, ingest, parseTabularData } from './chunk-ZCFSDSUX.js';
+export { chartNumber, datasetDiagnostics, formatDataNumber, fromExcelNumberFormat, inlineChartData, inlineDatasets, inlineTableData, isDatasetRef, isXYChartType, numberFormatError, resolveChartData, resolveTableData, suggestChartNumberFix, tableCellDisplayValue, toExcelNumberFormat, unusedDatasets } from './chunk-MBU42S5Y.js';
 import './chunk-SPFV27O5.js';

package/dist/deck-report-wszX7uo8.d.ts

@@ -0,0 +1,40 @@
+import { a as Catalog } from './catalog-refs-BSfGELpt.js';
+import { P as Presentation } from './presentation-HondgJ3l.js';
+import { V as ValidationReport, a as ValidateOptions } from './validation-types-PbGDrNUr.js';
+
+/** The serializations of a deck: `json` (canonical), `yaml` (`.opf.yaml`) and `markdown` (`.opf.md`). */
+type DeckFormat = "json" | "yaml" | "markdown";
+/** Every deck format, in the order JSON, YAML, Markdown. */
+declare const DECK_FORMATS: readonly DeckFormat[];
+/**
+ * The format a file name stands for: `.opf.md` is Markdown, `.yaml` and `.yml` are YAML (any case), every other name is JSON.
+ * A plain `.md` file is not a deck: it is Markdown that `fromMarkdown` converts when asked, so it is never detected.
+ */
+declare function deckFormatOf(filename: string | undefined): DeckFormat;
+/** Where a deck's text comes from: its format, or the file name that names it, and the catalogs its references resolve in. */
+interface ParseOptions {
+    /** The format of the text. Wins over `filename`. */
+    format?: DeckFormat;
+    /** The file name, for the format only: `.opf.md` is Markdown, `.yaml` and `.yml` are YAML, anything else is JSON. The content is never sniffed. */
+    filename?: string;
+    /** Catalogs the host registered, for the references check. Nothing is fetched. */
+    catalogs?: readonly Catalog[];
+}
+/** The options of `readDeckReport`: `parse`'s, plus the check to run. */
+interface DeckReportOptions extends ParseOptions {
+    /** `true` (the default) checks `format` and `references`; options pick other rules; `false` reports only syntax errors. */
+    validate?: boolean | ValidateOptions;
+}
+/** A deck read from text with the report of its check, whatever the format. */
+interface DeckReport extends ValidationReport {
+    /** The deck; a best effort (an empty object after a syntax error) when `valid` is false. */
+    presentation: Presentation;
+    format: DeckFormat;
+}
+/**
+ * The reader behind `parse` that never throws for content: the deck and the `validate` report of it, every finding
+ * located in the text. Not exported from the package root; the Node file API and `parse` use it.
+ */
+declare function readDeckReport(text: string, options?: DeckReportOptions, caller?: string): DeckReport;
+
+export { type DeckFormat as D, type ParseOptions as P, DECK_FORMATS as a, type DeckReport as b, type DeckReportOptions as c, deckFormatOf as d, readDeckReport as r };

package/dist/deck.d.ts

@@ -1,67 +1,37 @@
-import { C as Catalog } from './catalog-refs-_anZs-Qz.js';
-import { P as Presentation } from './presentation-COrFuj2g.js';
-import { V as ValidateOptions, a as ValidationReport } from './validation-types-HxIgJfKx.js';
-import './composition-D4ADF5c-.js';
+import { D as DeckFormat, P as ParseOptions } from './deck-report-wszX7uo8.js';
+export { a as DECK_FORMATS, d as deckFormatOf } from './deck-report-wszX7uo8.js';
+import { P as Presentation } from './presentation-HondgJ3l.js';
+import './catalog-refs-BSfGELpt.js';
+import './validation-types-PbGDrNUr.js';
+import './composition-C-OoqvAr.js';
 import './chart-data-BnNqgnC-.js';
 import './finding-CT_f_vbD.js';
 import './json-BFSdESOE.js';
 
 /**
  * One entry point to read and write a deck in any of its three serializations (RR-60): JSON, the canonical and interchange
- * form, and the two authoring forms of the same data, YAML (`.opf.yaml`, RR-56) and Markdown (`.opf.md`, RR-30). `readDeck`
- * turns text into a deck and the `validate` report of it, with every finding located in the text that was read; `writeDeck`
- * turns a deck into text.
+ * form, and the two authoring forms of the same data, YAML (`.opf.yaml`, RR-56) and Markdown (`.opf.md`, RR-30). `parse`
+ * turns text into a deck (a deck that fails the format and references check throws, with every finding located in the text
+ * that was read); `stringify` turns a deck into text.
  *
  * The format comes from the `format` option, else from the file name, and never from the content: a string that starts with
  * `{` is JSON only because JSON is the default. No renderer, fonts, DOM, network or model calls, and no Node APIs, so it runs in
  * a browser. The same input always gives the same output.
  */
 
-/** The serializations of a deck: `json` (canonical), `yaml` (`.opf.yaml`) and `markdown` (`.opf.md`). */
-type DeckFormat = "json" | "yaml" | "markdown";
-/** Every deck format, in the order JSON, YAML, Markdown. */
-declare const DECK_FORMATS: readonly DeckFormat[];
 /**
- * The format a file name stands for: `.opf.md` is Markdown, `.yaml` and `.yml` are YAML (any case), every other name is JSON.
- * A plain `.md` file is not a deck: it is Markdown that `fromMarkdown` converts when asked, so it is never detected.
+ * Read a deck from JSON, YAML or Markdown text and return it. The format comes from `format`, else from `filename`, never from the
+ * content. The deck is checked for format and references (in `catalogs`); a syntax, schema or reference error throws
+ * `OPFValidationError`, whose `report.findings` carry `location` (the UTF-16 offset and length, and the one-based line and column
+ * of the text that caused them; a JSON syntax error is `opf/json-syntax`, a YAML one `yaml/<rule>`, a Markdown one
+ * `markdown/<rule>`). Warnings do not throw: `validate` reports them. Throws a `TypeError` for text that is not a string, a
+ * format that is none of the three, or a bad option.
  */
-declare function deckFormatOf(filename: string | undefined): DeckFormat;
-interface ReadDeckOptions {
-    /** The format of the text. Wins over `filename`. */
-    format?: DeckFormat;
-    /** The file name, for the format only: `.opf.md` is Markdown, `.yaml` and `.yml` are YAML, anything else is JSON. The content is never sniffed. */
-    filename?: string;
-    /** Catalogs the host registered, for the references check. Nothing is fetched. */
-    catalogs?: readonly Catalog[];
-    /**
-     * Check the deck with `validate` and locate its findings in the text: `true` (the default) checks `format` and `references`;
-     * options pick other rules or categories (`{}` runs every rule; `catalogs` above is added when the options name none);
-     * `false` skips the check, so only syntax errors are reported and `schemaValid` is null.
-     */
-    validate?: boolean | ValidateOptions;
-}
-/**
- * The deck read from the text with the `validate` report of it (`valid`, `schemaValid`, `checks`, `findings`, `counts`, and
- * `template` and `unfilledVariables` for a deck with content variables), the same whatever the format.
- */
-interface ReadDeckResult extends ValidationReport {
-    /** The deck. Always a value; when `valid` is false it is a best effort (an empty object after a syntax error). */
-    presentation: Presentation;
-    /** The format the text was read as. */
-    format: DeckFormat;
-}
-/**
- * Read a deck from JSON, YAML or Markdown text. Never throws for malformed content; read `valid` and `findings`. The findings
- * of a YAML or Markdown deck carry `location` (the UTF-16 offset and length, one-based line and column of the text that caused
- * them, a validation finding mapped to the field it names); so do those of a JSON deck. A JSON syntax error is `opf/json-syntax`,
- * a YAML one `yaml/<rule>` and a Markdown one `markdown/<rule>`. Throws a `TypeError` for text that is not a string, a format
- * that is none of the three, or a bad option.
- */
-declare function readDeck(text: string, options?: ReadDeckOptions): ReadDeckResult;
-interface WriteDeckOptions {
+declare function parse(text: string, options?: ParseOptions): Presentation;
+interface StringifyOptions {
     /** The format to write. Wins over `filename`. */
     format?: DeckFormat;
-    /** The file name the text is for, for the format only (see `readDeck`). */
+    /** The file name the text is for, for the format only (see `parse`). */
     filename?: string;
     /** YAML: start with `# yaml-language-server: $schema=...` so editors validate and complete the file. */
     schemaComment?: boolean;
@@ -69,9 +39,9 @@ interface WriteDeckOptions {
 /**
  * Write a deck as text: JSON as two-space JSON with a final newline, YAML in canonical form (`toYaml`) and Markdown in canonical
  * form (`toMarkdown`, with anything the dialect has no syntax for embedded in `opf-slide` and `opf-block` fences so nothing is
- * lost). `readDeck` reads each result back to the same deck. YAML and Markdown throw `OPFYamlError` or `OPFMarkdownError`
+ * lost). `parse` reads each result back to the same deck. YAML and Markdown throw `OPFYamlError` or `OPFMarkdownError`
  * (`invalid-document`) for a document that is not valid OPF; JSON writes whatever it is given.
  */
-declare function writeDeck(presentation: unknown, options?: WriteDeckOptions): string;
+declare function stringify(presentation: unknown, options?: StringifyOptions): string;
 
-export { DECK_FORMATS, type DeckFormat, type ReadDeckOptions, type ReadDeckResult, type WriteDeckOptions, deckFormatOf, readDeck, writeDeck };
+export { DeckFormat, ParseOptions, type StringifyOptions, parse, stringify };

package/dist/deck.js

@@ -1,12 +1,12 @@
-export { DECK_FORMATS, deckFormatOf, readDeck, writeDeck } from './chunk-KINQFU6X.js';
-import './chunk-FQSIIADJ.js';
-import './chunk-K4DQQIT4.js';
-import './chunk-5UEUAW57.js';
-import './chunk-6OR326EA.js';
-import './chunk-NAWQR7MN.js';
-import './chunk-5TO6I3GB.js';
-import './chunk-PX5AWL7Y.js';
-import './chunk-5PDN7BN6.js';
+export { DECK_FORMATS, deckFormatOf, parse, stringify } from './chunk-ZOHFLP3O.js';
+import './chunk-DBYZI75U.js';
+import './chunk-NS3VYB57.js';
+import './chunk-CJPDTLGD.js';
+import './chunk-JXVS7BJK.js';
+import './chunk-VCGRMNY2.js';
+import './chunk-RAKEVM52.js';
+import './chunk-JT3QXA22.js';
+import './chunk-MBU42S5Y.js';
 import './chunk-TRDXRRQK.js';
 import './chunk-SPFV27O5.js';
-import './chunk-WEDGVC5W.js';
+import './chunk-6WW2EDUW.js';

package/dist/diff.js

@@ -1,7 +1,7 @@
-export { categoryOf, describeValue, diff, formatDiffReport, matchArrays, merge, similarity } from './chunk-UM24JFUE.js';
-import './chunk-3XDRQYWZ.js';
-import './chunk-PX5AWL7Y.js';
-import './chunk-5PDN7BN6.js';
+export { categoryOf, describeValue, diff, formatDiffReport, matchArrays, merge, similarity } from './chunk-YWXB4XAT.js';
+import './chunk-YZXTXX2D.js';
+import './chunk-JT3QXA22.js';
+import './chunk-MBU42S5Y.js';
 import './chunk-TRDXRRQK.js';
 import './chunk-SPFV27O5.js';
-import './chunk-WEDGVC5W.js';
+import './chunk-6WW2EDUW.js';