@openpresentation/opf 0.26.2 → 0.26.4

package/dist/format.js

@@ -1,2 +1,2 @@
-export { OPFFormatError, format, isFormatted, sortPresentationKeys } from './chunk-JI3PHXPJ.js';
-import './chunk-N6CNJCIF.js';
+export { OPFFormatError, format, isFormatted, sortPresentationKeys } from './chunk-EQ6S5SEZ.js';
+import './chunk-F4HFDP6I.js';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { SchemaEntry, SchemaName, audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './schemas.js';
-import { C as ConvertInput, a as ConvertOptions, b as ConvertResult, c as ConvertFormat, O as OpenOptions, S as SaveOptions, d as SaveResult } from './conversion-CX_I6Vna.js';
-export { e as ConvertedFile, E as ExportFormat, F as FontsHandle, f as OPFApiError, g as OPFExportError, h as OPFImportError, i as SlideSelection, p as parseSlideSelection } from './conversion-CX_I6Vna.js';
+import { C as ConvertInput, a as ConvertOptions, b as ConvertResult, c as ConvertFormat, O as OpenOptions, S as SaveOptions, d as SaveResult } from './conversion-DSafOGzh.js';
+export { e as ConvertedFile, E as ExportFormat, F as FontsHandle, f as OPFApiError, g as OPFExportError, h as OPFImportError, i as SlideSelection, p as parseSlideSelection } from './conversion-DSafOGzh.js';
 import { validate as validate$1 } from './validator.js';
 export { DEFAULT_VALIDATION_THRESHOLDS, OPFValidationError, assertValid, assertValidCatalogRecord, findValidationRule, validateCatalogRecord, validationRules } from './validator.js';
 import { R as ResolveVariablesOptions, h as VariableDiagnostic } from './validation-types-3ARvTsB0.js';

package/dist/index.js

@@ -1,23 +1,25 @@
-import { defaultCatalogs } from './chunk-XFK4KPKK.js';
-import { stats, embed, edit, OPFApiError, asApiError } from './chunk-OFWBICDO.js';
-export { OPFApiError, OPFExportError, OPFImportError, OPFMoveToCustomError, copySlides, fill, fillRecords, localAssetSources, moveToCustom, parseSlideSelection, sameRecord, updateFromCatalog } from './chunk-OFWBICDO.js';
+import { defaultCatalogs } from './chunk-ZSZDVIDV.js';
+import { stats, embed, edit, OPFApiError, asApiError } from './chunk-NZLW6FBQ.js';
+export { OPFApiError, OPFExportError, OPFImportError, OPFMoveToCustomError, copySlides, fill, fillRecords, localAssetSources, moveToCustom, parseSlideSelection, sameRecord, updateFromCatalog } from './chunk-NZLW6FBQ.js';
 export { specFileEntries, specFileKinds, specFilePaths } from './chunk-UJSAR6GF.js';
 export { FONT_POLICY, applyFontPolicyDecisions, fontAvailabilityDiagnostics, fontPolicyFor } from './chunk-PJSPHHRK.js';
 export { OPFDataImportError, ingest, parseTabularData } from './chunk-TKQ2VFV5.js';
-import { paginate } from './chunk-L65YNP4J.js';
-export { OPFPaginationError, paginateSlide } from './chunk-L65YNP4J.js';
-export { DECK_FORMATS, deckFormatOf, parse, stringify } from './chunk-NWO6HT4F.js';
-export { fromMarkdown, toMarkdown } from './chunk-Q6KMKTEH.js';
-import './chunk-CRCOQ4K2.js';
-import './chunk-7YZ72FRP.js';
-export { OPFMarkdownError } from './chunk-6JAFSZVL.js';
-import './chunk-O2ST5ZKL.js';
-export { diff, merge } from './chunk-LN2ASLMF.js';
-import { validate, OPFValidationError } from './chunk-LUQYSUXS.js';
-export { CATALOG_SCHEMA, DEFAULT_VALIDATION_THRESHOLDS, OPFPatchError, OPFPatchValidationError, OPFValidationError, applyPatch, assertValid, assertValidCatalogRecord, catalogDisplayKinds, catalogSchemaNames, findValidationRule, resolveSlideContext, validateCatalogRecord, validationCategories, validationRules } from './chunk-LUQYSUXS.js';
+import { paginate } from './chunk-QH2W6HIM.js';
+export { OPFPaginationError, paginateSlide } from './chunk-QH2W6HIM.js';
+export { DECK_FORMATS, deckFormatOf, parse, stringify } from './chunk-EDCRBTJF.js';
+export { fromMarkdown, toMarkdown } from './chunk-GWJBZ4LC.js';
+import './chunk-PIO73BQ6.js';
+import './chunk-RYZPBJLB.js';
+import './chunk-MN7DRK57.js';
+import './chunk-O6BY3AU2.js';
+export { OPFMarkdownError } from './chunk-QAEBYDKY.js';
+import './chunk-6NBTZYYD.js';
+export { diff, merge } from './chunk-H5QC3X3K.js';
+import { validate, OPFValidationError } from './chunk-XFOOKVRI.js';
+export { CATALOG_SCHEMA, DEFAULT_VALIDATION_THRESHOLDS, OPFPatchError, OPFPatchValidationError, OPFValidationError, applyPatch, assertValid, assertValidCatalogRecord, catalogDisplayKinds, catalogSchemaNames, findValidationRule, resolveSlideContext, validateCatalogRecord, validationCategories, validationRules } from './chunk-XFOOKVRI.js';
 export { CATALOG_GROUP_PATTERN, CATALOG_REFERENCE_PATTERN, CHART_TYPES, DEFAULT_VARIABLE_DATE_FORMAT, ENGINE_DEFAULT_CHART_TYPES, ENGINE_DEFAULT_COLOR_SCHEME, ENGINE_DEFAULT_FONT_SCHEME, ENGINE_DEFAULT_THEME, LANGUAGES, LOGO_SHAPES, OPFCatalogsOptionError, OPFUnresolvedReferenceError, OPFVariableError, SLIDE_SCOPED_BUILTINS, SOCIAL_PLATFORMS, VARIABLE_KINDS, catalogGroupSource, catalogKinds, catalogRecords, catalogReferenceSites, chartNumber, coerceVariableValue, datasetDiagnostics, formatDataNumber, formatVariableNumber, fromExcelNumberFormat, hasContentVariables, inlineChartData, inlineDatasets, inlineTableData, isDatasetRef, isTemplate, isXYChartType, listBuiltinVariables, listVariables, normalizeLanguageFamily, numberFormatError, parseReference, resolveChartData, resolveDesignRecords, resolveFontScheme, resolveReference, resolveSlideVariables, resolveTableData, resolveVariables, suggestChartNumberFix, tableCellDisplayValue, toExcelNumberFormat, unresolvedReference, unusedDatasets, variableDeclarations } from './chunk-XRMV2GMB.js';
-export { OPFFormatError, format } from './chunk-JI3PHXPJ.js';
-export { audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './chunk-N6CNJCIF.js';
+export { OPFFormatError, format } from './chunk-EQ6S5SEZ.js';
+export { audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './chunk-F4HFDP6I.js';
 
 // src/index.ts
 var withDefaultCatalog = (options) => {
@@ -30,7 +32,7 @@ var stats2 = (presentation2, options) => stats(presentation2, withDefaultCatalog
 var paginate2 = (input, options) => paginate(input, withDefaultCatalog(options));
 var embed2 = (document, options) => embed(document, withDefaultCatalog(options));
 var edit2 = (deck, patch, options) => edit(deck, patch, withDefaultCatalog(options));
-var engine = () => import('./conversion-BKCKBECG.js');
+var engine = () => import('./conversion-QIAJM6DQ.js');
 var rethrow = (error, fallback) => {
   if (error instanceof OPFValidationError) throw error;
   throw asApiError(OPFApiError, error, fallback);

package/dist/markdown.js

@@ -1,7 +1,9 @@
-export { fromMarkdown, toMarkdown } from './chunk-Q6KMKTEH.js';
-import './chunk-CRCOQ4K2.js';
-export { OPFMarkdownError } from './chunk-6JAFSZVL.js';
-import './chunk-O2ST5ZKL.js';
-import './chunk-LUQYSUXS.js';
+export { fromMarkdown, toMarkdown } from './chunk-GWJBZ4LC.js';
+import './chunk-RYZPBJLB.js';
+import './chunk-MN7DRK57.js';
+import './chunk-O6BY3AU2.js';
+export { OPFMarkdownError } from './chunk-QAEBYDKY.js';
+import './chunk-6NBTZYYD.js';
+import './chunk-XFOOKVRI.js';
 import './chunk-XRMV2GMB.js';
-import './chunk-N6CNJCIF.js';
+import './chunk-F4HFDP6I.js';

package/dist/node-engine.d.ts

@@ -1,6 +1,6 @@
 export { b as DeckReport, c as DeckReportOptions, r as readDeckReport } from './deck-report-5vwMGcQz.js';
-import { F as FontsHandle, j as EmbeddedFace, R as Renderer, k as Reporter, P as Peer, l as PptxModule, f as OPFApiError } from './conversion-CX_I6Vna.js';
-export { m as ConversionPlan, D as Diagnostic, n as EXPORT_FORMATS, o as EXPORT_TEXT, q as ExportContext, r as ExportFile, s as ExportFontSummary, E as ExportFormat, t as ExportOptions, u as ExportResult, v as ExportRun, w as ExportText, I as ImportOptions, x as ImportResult, g as OPFExportError, h as OPFImportError, y as PEER_RANGES, z as PPTX_PACKAGE, A as PreparedExport, B as RENDER_EXTRAS, G as RENDER_PACKAGE, H as ReportFinding, J as ResolvedExportOptions, i as SlideSelection, K as Source, V as VERSIONS, L as asApiError, M as assetRoot, N as checkDate, Q as checkOptions, T as checkRenamedOptions, U as checkScale, W as deckFileFormat, X as exportFormatOf, Y as finishReport, Z as importPresentation, _ as loadPptx, $ as loadRenderer, a0 as locatePackage, a1 as missingPeerFrom, p as parseSlideSelection, a2 as planConversion, a3 as prepareExport, a4 as reaches, a5 as readInput, a6 as reportThrown, a7 as resolveExportOptions, a8 as runExport, a9 as runPreparedExport, aa as writePlanned } from './conversion-CX_I6Vna.js';
+import { F as FontsHandle, j as EmbeddedFace, R as Renderer, k as Reporter, P as Peer, l as PptxModule, f as OPFApiError } from './conversion-DSafOGzh.js';
+export { m as ConversionPlan, D as Diagnostic, n as EXPORT_FORMATS, o as EXPORT_TEXT, q as ExportContext, r as ExportFile, s as ExportFontSummary, E as ExportFormat, t as ExportOptions, u as ExportResult, v as ExportRun, w as ExportText, I as ImportOptions, x as ImportResult, g as OPFExportError, h as OPFImportError, y as PEER_RANGES, z as PPTX_PACKAGE, A as PreparedExport, B as RENDER_EXTRAS, G as RENDER_PACKAGE, H as ReportFinding, J as ResolvedExportOptions, i as SlideSelection, K as Source, V as VERSIONS, L as asApiError, M as assetRoot, N as checkDate, Q as checkOptions, T as checkRenamedOptions, U as checkScale, W as deckFileFormat, X as exportFormatOf, Y as finishReport, Z as importPresentation, _ as loadPptx, $ as loadRenderer, a0 as locatePackage, a1 as missingPeerFrom, p as parseSlideSelection, a2 as planConversion, a3 as prepareExport, a4 as reaches, a5 as readInput, a6 as reportThrown, a7 as resolveExportOptions, a8 as runExport, a9 as runPreparedExport, aa as writePlanned } from './conversion-DSafOGzh.js';
 import { a as Catalog } from './catalog-refs-BSfGELpt.js';
 import { e as PresentationPaginationResult } from './pagination-D_kJe4jH.js';
 import './presentation-Bwo8Ko6D.js';

package/dist/node-engine.js

@@ -1,24 +1,26 @@
-import { loadRenderer, listFontDirectories, leaseSharedFonts, prepareFonts } from './chunk-5VJCLUUA.js';
-export { EXPORT_FORMATS, EXPORT_TEXT, PEER_RANGES, PPTX_PACKAGE, RENDER_EXTRAS, RENDER_PACKAGE, Reporter, VERSIONS, assetRoot, checkDate, checkDestinations, checkOptions, checkOutputPattern, checkRenamedOptions, checkScale, createZip, deckFileFormat, deckStem, embeddedFor, exportFormatOf, finishReport, importPresentation, leaseSharedFonts, listFontDirectories, loadPptx, loadRenderer, localAssetProblems, locatePackage, missingPeerFrom, padNumber, planConversion, pointerOf, prepareExport, prepareFonts, publishNew, reaches, readInput, reportThrown, resolveExportOptions, runExport, runImport, runPreparedExport, stemOf, writeFiles, writePlanned } from './chunk-5VJCLUUA.js';
-import { defaultCatalogs } from './chunk-XFK4KPKK.js';
-export { defaultCatalogs, galleryMismatch } from './chunk-XFK4KPKK.js';
-import { OPFApiError } from './chunk-OFWBICDO.js';
-export { OPFApiError, OPFExportError, OPFImportError, asApiError, parseSlideSelection } from './chunk-OFWBICDO.js';
+import { loadRenderer, listFontDirectories, leaseSharedFonts, prepareFonts } from './chunk-6IXSHIAL.js';
+export { EXPORT_FORMATS, EXPORT_TEXT, PEER_RANGES, PPTX_PACKAGE, RENDER_EXTRAS, RENDER_PACKAGE, Reporter, VERSIONS, assetRoot, checkDate, checkDestinations, checkOptions, checkOutputPattern, checkRenamedOptions, checkScale, createZip, deckFileFormat, deckStem, embeddedFor, exportFormatOf, finishReport, importPresentation, leaseSharedFonts, listFontDirectories, loadPptx, loadRenderer, localAssetProblems, locatePackage, missingPeerFrom, padNumber, planConversion, pointerOf, prepareExport, prepareFonts, publishNew, reaches, readInput, reportThrown, resolveExportOptions, runExport, runImport, runPreparedExport, stemOf, writeFiles, writePlanned } from './chunk-6IXSHIAL.js';
+import { defaultCatalogs } from './chunk-ZSZDVIDV.js';
+export { defaultCatalogs, galleryMismatch } from './chunk-ZSZDVIDV.js';
+import { OPFApiError } from './chunk-NZLW6FBQ.js';
+export { OPFApiError, OPFExportError, OPFImportError, asApiError, parseSlideSelection } from './chunk-NZLW6FBQ.js';
 import './chunk-UJSAR6GF.js';
 import './chunk-PJSPHHRK.js';
 import './chunk-TKQ2VFV5.js';
-import { paginate } from './chunk-L65YNP4J.js';
-export { readDeckReport } from './chunk-NWO6HT4F.js';
-import './chunk-Q6KMKTEH.js';
-import './chunk-CRCOQ4K2.js';
-import './chunk-7YZ72FRP.js';
-import './chunk-6JAFSZVL.js';
-import './chunk-O2ST5ZKL.js';
-import './chunk-LN2ASLMF.js';
-import './chunk-LUQYSUXS.js';
+import { paginate } from './chunk-QH2W6HIM.js';
+export { readDeckReport } from './chunk-EDCRBTJF.js';
+import './chunk-GWJBZ4LC.js';
+import './chunk-PIO73BQ6.js';
+import './chunk-RYZPBJLB.js';
+import './chunk-MN7DRK57.js';
+import './chunk-O6BY3AU2.js';
+import './chunk-QAEBYDKY.js';
+import './chunk-6NBTZYYD.js';
+import './chunk-H5QC3X3K.js';
+import './chunk-XFOOKVRI.js';
 import './chunk-XRMV2GMB.js';
-import './chunk-JI3PHXPJ.js';
-import './chunk-N6CNJCIF.js';
+import './chunk-EQ6S5SEZ.js';
+import './chunk-F4HFDP6I.js';
 
 // src/node/paginate.ts
 async function paginateDeck(deck, options) {

package/dist/pagination.js

@@ -1,4 +1,4 @@
-export { OPFPaginationError, paginate, paginateSlide } from './chunk-L65YNP4J.js';
-import './chunk-LUQYSUXS.js';
+export { OPFPaginationError, paginate, paginateSlide } from './chunk-QH2W6HIM.js';
+import './chunk-XFOOKVRI.js';
 import './chunk-XRMV2GMB.js';
-import './chunk-N6CNJCIF.js';
+import './chunk-F4HFDP6I.js';

package/dist/patch.js

@@ -1,3 +1,3 @@
-export { OPFPatchError, OPFPatchValidationError, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken } from './chunk-LUQYSUXS.js';
+export { OPFPatchError, OPFPatchValidationError, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken } from './chunk-XFOOKVRI.js';
 import './chunk-XRMV2GMB.js';
-import './chunk-N6CNJCIF.js';
+import './chunk-F4HFDP6I.js';

package/dist/schema.d.ts

@@ -1,8 +1,21 @@
 import { C as CatalogRecordKind } from './catalog-schemas-DoxA2BgY.js';
+import { SchemaName } from './schemas.js';
 import './catalog-refs-BSfGELpt.js';
-import './schemas.js';
 import './json-BFSdESOE.js';
 
+/**
+ * Which catalog a reference field points into, kept beside the schemas rather than in them: the published schemas
+ * (spec/schemas, openpresentation.org/schema/...) carry no vendor keyword, so any Ajv in strict mode (the default) compiles
+ * them without `addKeyword`. `check:schema-strict` keeps it that way.
+ *
+ * Keys are `<schema name>#<JSON Pointer of the node in that schema document>` (the schema names of `@openpresentation/opf/schemas`);
+ * the node is the one at the pointer as written, a `$ref` and its siblings included. Values are the catalog record kind the
+ * field references. The annotation never changes validation: `describeField` and `catalogKindAt` read it, nothing else.
+ * A test fails when a pointer leaves its schema or a schema reference field is missing here.
+ */
+type SchemaNodeKey = `${SchemaName}#/${string}`;
+declare const schemaCatalogKinds: Readonly<Record<SchemaNodeKey, CatalogRecordKind>>;
+
 /**
  * `@openpresentation/opf/schema`: the field model of an OPF document, read from the JSON Schemas.
  *
@@ -10,7 +23,8 @@ import './json-BFSdESOE.js';
  * `listSchemaFields`, ...) move here from the editor so that the CLI, agents and every editor read the schemas one way. On top of
  * them, `describeField(path, document?)` answers what a source editor needs at any position (the types, enum values,
  * description, required members and ranked children of the node) and `catalogKindAt(path, document?)` names the catalog a
- * reference field points into, from the `x-opf-catalog` annotation of the schema (an annotation: it never changes validation).
+ * reference field points into, from `schemaCatalogKinds`, core-side metadata kept beside the schemas (the published schemas carry
+ * no vendor keyword, so they compile under strict Ajv; the metadata never changes validation).
  *
  * Browser-safe: no `node:` imports. Types are deliberately loose (`JsonSchema`), the schemas being plain JSON.
  */
@@ -143,9 +157,9 @@ interface FieldInfo {
 declare function describeField(path: OpfPath, document?: unknown): FieldInfo;
 /**
  * The catalog kind a field references (`layouts`, `themes`, `colorSchemes`, `fontSchemes`, `narratives`, `audiences`,
- * `purposes`, `tones`), read from the `x-opf-catalog` annotation of the schema at `path`; undefined for every other field.
+ * `purposes`, `tones`), read from `schemaCatalogKinds` for the schema node at `path`; undefined for every other field.
  * Languages are an engine vocabulary, not a catalog: `language` is not a reference.
  */
 declare function catalogKindAt(path: OpfPath, document?: unknown): CatalogRecordKind | undefined;
 
-export { COMMON_KEYS, CatalogRecordKind, type EnumValue, type FieldChild, type FieldInfo, type JsonSchema, type OpfPath, type SchemaField, type SchemaRoot, UNRANKED_PRIORITY, type VariantInfo, activeSchema, catalogKindAt, createSchemaValue, describeField, isPromotedRegionKey, listSchemaFields, resolveSchema, schemaAtPath, schemaLabel, schemaType, schemaVariants, splitOpfPath };
+export { COMMON_KEYS, CatalogRecordKind, type EnumValue, type FieldChild, type FieldInfo, type JsonSchema, type OpfPath, type SchemaField, type SchemaNodeKey, type SchemaRoot, UNRANKED_PRIORITY, type VariantInfo, activeSchema, catalogKindAt, createSchemaValue, describeField, isPromotedRegionKey, listSchemaFields, resolveSchema, schemaAtPath, schemaCatalogKinds, schemaLabel, schemaType, schemaVariants, splitOpfPath };

package/dist/schema.js

@@ -1,3 +1,3 @@
-export { COMMON_KEYS, UNRANKED_PRIORITY, activeSchema, catalogKindAt, createSchemaValue, describeField, isPromotedRegionKey, listSchemaFields, resolveSchema, schemaAtPath, schemaLabel, schemaType, schemaVariants, splitOpfPath } from './chunk-LUQYSUXS.js';
+export { COMMON_KEYS, UNRANKED_PRIORITY, activeSchema, catalogKindAt, createSchemaValue, describeField, isPromotedRegionKey, listSchemaFields, resolveSchema, schemaAtPath, schemaCatalogKinds, schemaLabel, schemaType, schemaVariants, splitOpfPath } from './chunk-XFOOKVRI.js';
 import './chunk-XRMV2GMB.js';
-import './chunk-N6CNJCIF.js';
+import './chunk-F4HFDP6I.js';

package/dist/schemas.js

@@ -1 +1 @@
-export { audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './chunk-N6CNJCIF.js';
+export { audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './chunk-F4HFDP6I.js';

package/dist/source.d.ts

@@ -1,5 +1,29 @@
 import { b as FindingLocation } from './finding-l9dlQ2NF.js';
 
+/** Keys of `<!-- slide: ... -->`. */
+declare const SLIDE_OPTION_KEYS: readonly ["id", "type", "layout", "section", "tag", "hidden", "beat"];
+/** Keys of `<!-- block: ... -->`. */
+declare const BLOCK_OPTION_KEYS: readonly ["id", "type", "as", "region"];
+/** Values of `as=` in a block options comment. */
+declare const BLOCK_AS_VALUES: readonly ["bullets", "video"];
+/** The first word of a fence info string that is not code: `chart`, `metric`, `timeline` and the two YAML escape hatches. */
+declare const FENCE_KINDS: readonly ["chart", "metric", "timeline", "opf-block", "opf-slide"];
+/** Lines of a ```metric fence: `key: value`. */
+declare const METRIC_KEYS: readonly ["value", "label", "description", "unit", "delta", "trend", "sentiment"];
+/** Attributes after the info word: `chart` takes `alt`, `timeline` `name` and `description`, a code fence `title`. */
+declare const FENCE_ATTRIBUTES: {
+    readonly chart: readonly ["alt"];
+    readonly timeline: readonly ["name", "description"];
+    readonly code: readonly ["title"];
+};
+/** Flags of an inline span `[text]{bold italic}` (the converter also reads `strikethrough`, `superscript` and `subscript`). */
+declare const SPAN_FLAGS: readonly ["bold", "italic", "underline", "strike", "sup", "sub"];
+/** Attributes of an inline span that take a value: `[text]{color=#B42318 size=24 font="Open Sans" lang=fr}`. */
+declare const SPAN_VALUES: readonly ["color", "size", "font", "lang"];
+/** Keywords a line of a slide can start with. */
+declare const LINE_KEYWORDS: readonly ["Note:", "Notes:"];
+type FenceKind = (typeof FENCE_KINDS)[number];
+
 /**
  * A range of source text in the `Finding.location` convention: UTF-16 offset and length, 1-based line and column (a line break is
  * `\r\n`, `\r` or `\n`). `exact: false` marks a range that is the nearest ancestor of a node the text does not have.
@@ -85,13 +109,87 @@ interface PathAtResult {
  * underlined in the source. Tolerant: it reads text with syntax errors, comments and trailing commas as far as it can be read.
  * When the node does not exist, the range is that of the nearest ancestor that does, with `exact: false`.
  *
- * Phase 1 reads JSON. YAML and Markdown return `undefined` (phase 2): no range is guessed.
+ * JSON, YAML and Markdown. YAML is read with the `yaml` library's tolerant parse, so a text with syntax errors is located as far as it
+ * can be read. Markdown uses the ranges the converter records for every part it reads (the ones its findings are located by): a
+ * slide, its title, a list item, a block, the `layout=` of an options comment, the keys of the front matter and of the YAML in
+ * `opf-slide` and `opf-block` fences. A slide field the Markdown writes as a line (`# Title`, `- item`) has `value` = the text after
+ * the marker, `key` = the marker and `entry` = the line.
  */
 declare function locate(text: string, format: SourceFormat, pointer: string | readonly (string | number)[], options?: LocateOptions): TextRange | undefined;
 /**
- * The document path and the kind of position at a character offset (a caret between characters). JSON only (phase 1); YAML and
- * Markdown return `undefined`. Tolerant of broken text.
+ * The document path and the kind of position at a character offset (a caret between characters), in JSON, YAML or Markdown.
+ * Tolerant of broken text. In YAML a position on the whitespace of a blank line is `none` after the last node and `between` inside
+ * a collection; in Markdown a position outside the front matter and the slides is `none`.
  */
 declare function pathAt(text: string, format: SourceFormat, offset: number): PathAtResult | undefined;
 
-export { type AnalyzeOptions, type LocateOptions, type LocatePart, type PathAtResult, type SourceFormat, type SyntaxFix, type SyntaxProblem, type SyntaxProblemCode, type TextEdit, type TextRange, analyzeJsonSyntax, applyTextEdits, locate, pathAt };
+/** A range of the text: UTF-16 offsets, `from` inclusive and `to` exclusive, and the one-based line `from` is on. */
+interface ScanRange {
+    from: number;
+    to: number;
+    line: number;
+}
+interface MarkdownFrontMatter extends ScanRange {
+    /** The YAML between the two `---` lines: from the end of the opening line to the start of the closing line. */
+    yamlFrom: number;
+    yamlTo: number;
+    /** False when the closing `---` (or `...`) line is missing: then the YAML runs to the end of the text. */
+    closed: boolean;
+}
+interface MarkdownSlideScan extends ScanRange {
+    /** The slide's number in the converted deck (empty segments between `---` lines are not slides). */
+    index: number;
+}
+interface MarkdownCommentScan extends ScanRange {
+    /** `slide` and `block` are options comments (`<!-- slide: ... -->`), `comment` any other. */
+    kind: "slide" | "block" | "comment";
+    /** The text between `<!--` and `-->` (for an unclosed comment, to the end of its last line). */
+    innerFrom: number;
+    innerTo: number;
+    closed: boolean;
+    /** The slide it is in. */
+    slide: number;
+}
+interface MarkdownFenceScan extends ScanRange {
+    /** The opening fence characters (```` ``` ````, `~~~~`). */
+    marker: string;
+    /** The info string after the fence characters, trimmed; `infoFrom` and `infoTo` are its offsets. */
+    info: string;
+    infoFrom: number;
+    infoTo: number;
+    /** The first word of the info string. */
+    word: string;
+    /** `chart`, `metric`, `timeline`, `opf-block`, `opf-slide`, or `code` for any other fence. */
+    kind: FenceKind | "code";
+    /** The lines between the fences: `bodyFrom` is the start of the first line, `bodyTo` the end of the last (equal when the body is empty). */
+    bodyFrom: number;
+    bodyTo: number;
+    closed: boolean;
+    slide: number;
+}
+interface MarkdownNotesScan extends ScanRange {
+    slide: number;
+}
+interface MarkdownScan {
+    frontMatter?: MarkdownFrontMatter;
+    /** The slides, in order; each runs from its first to its last non-blank line. */
+    slides: MarkdownSlideScan[];
+    /** Offsets of the `---` lines that separate slides. */
+    separators: number[];
+    comments: MarkdownCommentScan[];
+    fences: MarkdownFenceScan[];
+    /** Speaker notes: from the `Note:` or `Notes:` line to the end of the slide. */
+    notes: MarkdownNotesScan[];
+}
+interface ScanMarkdownOptions {
+    /** How the text is cut into slides, as for `fromMarkdown`. */
+    split?: "auto" | "rules" | "headings";
+}
+/**
+ * The structure of a Markdown deck, found with the converter's line rules: front matter, slides, option comments, fences and notes, as
+ * offset ranges. Tolerant: an unclosed front matter, comment or fence is reported with `closed: false` and runs to the end of its slide.
+ * It is the one place an editor learns the dialect's regions from.
+ */
+declare function scanMarkdown(source: string, options?: ScanMarkdownOptions): MarkdownScan;
+
+export { type AnalyzeOptions, BLOCK_AS_VALUES, BLOCK_OPTION_KEYS, FENCE_ATTRIBUTES, FENCE_KINDS, LINE_KEYWORDS, type LocateOptions, type LocatePart, METRIC_KEYS, type MarkdownCommentScan, type MarkdownFenceScan, type MarkdownFrontMatter, type MarkdownNotesScan, type MarkdownScan, type MarkdownSlideScan, type PathAtResult, SLIDE_OPTION_KEYS, SPAN_FLAGS, SPAN_VALUES, type ScanMarkdownOptions, type ScanRange, type SourceFormat, type SyntaxFix, type SyntaxProblem, type SyntaxProblemCode, type TextEdit, type TextRange, analyzeJsonSyntax, applyTextEdits, locate, pathAt, scanMarkdown };