pro-editor-schema 1.4.1 → 1.5.5-8

package/README.md

@@ -4,7 +4,7 @@ TypeScript library that defines XML/HTML schema rules used by the editor and pro
 
 ## NPM
 
-https://www.npmjs.com/package/pro-editor-schema?activeTab=versions
+https://www.npmjs.com/package/pro-editor-schema
 
 ## What this repository contains
 
@@ -131,6 +131,7 @@ The publishing workflow is defined in `.github/workflows/publish.yml`.
 - `src/schema/elementSchemas/elements` — element schema definitions and `ELEMENT_SCHEMAS`.
 - `src/schema/elementSchemas/atoms` — atom schema definitions and `ATOM_SCHEMAS`.
 - `src/schema/elementSchemas/inlineElements` — inline schema definitions and `INLINE_ELEMENT_SCHEMAS`.
+- `src/schema/referenceSchemas` — reference type and reference field schemas for bibliography entries.
 - `src/schema/shared` — shared allowed-children lists, global attributes, and labels.
 - `src/schema/helpers` — `createSchema` and schema lookup/attribute helpers.
 - `src/helpers` — DOM helpers (`createElement`, `closestElementBySchema`, ignored attributes/elements, and related utilities).
@@ -181,7 +182,7 @@ From `src/index.ts`, consumers can import:
 - **Schema helpers:** `findSchemaByCode`, `findSchemaByElement`, `findAttributeDefinitionByName`, `getAttributeName`, `isAttributeRestricted`, `isTrackChangesSchema`
 - **DOM helpers:** `createElement`, `closestElementBySchema`, `queryElementBySchema`, `queryAllElementsBySchema`, `getElementLinks`, `getStore`, `isDeletedElement`
 - **Ignored nodes:** `isIgnoredAttribute`, `isIgnoredElement`, `IGNORED_ATTRIBUTES`, `IGNORED_ELEMENT_SELECTORS`
-- **Validation:** `validateXml`
+- **Validation:** `validateXml`, `validateXmlAsync`
 - **Shared constants:** `ElementLabel`, global attribute constants, dependents forbidden elements
 
 ## Usage examples
@@ -255,6 +256,30 @@ It also runs per-element checks for:
 
 Schema-based attribute and child validation only runs for codes listed in `schemasToValidateAgainst`.
 
+### Validate a large document without freezing the page
+
+```ts
+import { validateXmlAsync } from "pro-editor-schema";
+
+const controller = new AbortController();
+const errors = await validateXmlAsync(
+  rootElement.cloneNode(true) as Element,
+  elementsToLink,
+  linkElements,
+  ["para", "heading"],
+  { signal: controller.signal },
+);
+```
+
+`validateXmlAsync` returns the same issues as `validateXml`, in the same order, but works in short slices and hands the main thread back between them (`scheduler.yield()` where available, otherwise `setTimeout`).
+
+- `signal` — aborting it rejects the promise with the signal's reason, for example when a newer edit makes the run outdated.
+- `timeBudgetMs` — how long to work before yielding. Defaults to 8 ms.
+
+Pass a copy of the document if it can change while validation runs.
+
+Listing `referenceBibliomixed` checks each bibliography entry against the schema of its reference type instead (see [Reference schemas](#reference-schemas)).
+
 ## How validation works
 
 - `validateXml` traverses the XML tree and delegates checks per element.
@@ -273,6 +298,25 @@ Validation results use `ValidationError`:
 - `level` (`blocker` | `warning` | `info`)
 - `kind` (`unlinked` | `forbidden` | `missing` | `converted`)
 - `description`
+- `elements` (optional) — the elements the issue is about, when it is about specific ones. Reference issues set it; it is empty for an issue about the reference as a whole.
+
+## Reference schemas
+
+A `bibliomixed` is mixed content, so its structure is described by two schemas on top of the element schemas of its parts (`bibliomset`, `pubdate`, `publishername`, and so on):
+
+- `REFERENCE_FIELD_SCHEMAS` — every bibliographic field (`title`, `year`, `publisher`, ...), and the element schemas that can express it. Any field may be tagged more than once.
+- `REFERENCE_TYPE_SCHEMAS` — one schema per reference type, keyed by the DocBook `role` of the `bibliomixed` (`monograph`, `article`, ...), with the fields the type allows and requires. Legacy roles such as `book` and `journal` resolve to the type they stand for.
+
+Helpers:
+
+- `findReferenceTypeSchemaByElement(bibliomixed)` — the type schema a reference declares.
+- `findReferenceFieldByElement(element)` — the field a tagged part expresses. The same element can express different fields: a `title1` inside a `book` or `journal` block is the container title, a `date` with `role="accessed"` is the access date.
+- `getReferenceParts(bibliomixed)` — the outermost tagged parts of a reference. Content inside a tracked deletion is left out and pending insertions count.
+- `getReferenceFieldElements(bibliomixed)` — the fields those parts express, each with its element.
+- `getReferenceStructureIssueElements(bibliomixed, issue)` — the elements of that reference an issue is about, also when the issue was found on a copy of it. Empty for an issue about the reference as a whole, such as a missing field.
+- `validateReferenceStructure(bibliomixed)` — structured issues for editors that present them their own way. `unknown_type`, `missing` and `not_allowed` describe the fields of the type. `wrong_element` names a tag the type or DocBook does not permit and the tag to use instead, and `markup` names a DocBook tagging rule that is broken (a missing `xmlid`, a `bibliomset` relation the type does not use or repeats, a `personname` without a name order, a `uri` outside a link, and so on); both carry the offending elements.
+
+`validateXml` reports the same issues as `warning`s when `referenceBibliomixed` is in `schemasToValidateAgainst`. It checks entries inside a `bibliography` that have at least one tagged part; plain-text entries and deleted entries are skipped.
 
 ## Adding or updating a schema
 

package/dist/index.d.mts

@@ -21,7 +21,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
     matchesElement?: (element: Element) => boolean;
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
-type ElementSchemaCode = "referenceBibliomixed" | "referenceBibliography" | "bibliodiv" | "degrees" | "email" | "equation" | "fignote" | "figsource" | "firstname" | "footnote" | "footnoteno" | "honorific" | "img" | "informalfigure" | "keyword" | "label1" | "li" | "line" | "linegroup" | "lrh" | "math" | "mathphrase" | "merror" | "mfrac" | "mi" | "mmultiscripts" | "mn" | "mo" | "mover" | "mpadded" | "mphantom" | "mprescripts" | "mroot" | "mrow" | "ms" | "mspace" | "msqrt" | "mstyle" | "msub" | "msubsup" | "msup" | "mtable" | "mtd" | "mtext" | "mtr" | "munder" | "munderover" | "olink" | "org" | "orgname" | "para" | "punc" | "rrh" | "source1" | "speaker" | "subtitle1" | "surname" | "tag" | "tblfn" | "tblsource" | "thead" | "title1" | "token" | "tp" | "abstract1" | "affiliation" | "alttext" | "appendix" | "author" | "authorgroup" | "blockquote" | "caption1" | "chapter" | "dialogue" | "epigraph" | "figure1" | "footnoteSection" | "heading" | "imageobject" | "info1" | "keywordset" | "mediaobject" | "ol" | "personname" | "poem" | "sidebar" | "table" | "table1" | "tbody" | "td" | "tgroup" | "tr" | "ul";
+type ElementSchemaCode = "referenceBibliomixed" | "referenceBibliography" | "bibliodiv" | "bibliomset" | "editor" | "othercredit" | "translator" | "collab" | "pubdate" | "date" | "publishername" | "address" | "city" | "volumenum" | "issuenum" | "pagenums" | "pagenum" | "edition" | "pubId" | "biblioid" | "bibliomisc" | "confgroup" | "conftitle" | "degrees" | "email" | "equation" | "fignote" | "figsource" | "firstname" | "footnote" | "footnoteno" | "honorific" | "img" | "informalfigure" | "keyword" | "label1" | "li" | "line" | "linegroup" | "lrh" | "math" | "mathphrase" | "merror" | "mfrac" | "mi" | "mmultiscripts" | "mn" | "mo" | "mover" | "mpadded" | "mphantom" | "mprescripts" | "mroot" | "mrow" | "ms" | "mspace" | "msqrt" | "mstyle" | "msub" | "msubsup" | "msup" | "mtable" | "mtd" | "mtext" | "mtr" | "munder" | "munderover" | "olink" | "org" | "orgname" | "para" | "punc" | "rrh" | "source1" | "speaker" | "subtitle1" | "surname" | "tag" | "tblfn" | "tblsource" | "thead" | "title1" | "token" | "tp" | "abstract1" | "affiliation" | "alttext" | "appendix" | "author" | "authorgroup" | "blockquote" | "caption1" | "chapter" | "dialogue" | "epigraph" | "figure1" | "footnoteSection" | "heading" | "imageobject" | "info1" | "keywordset" | "mediaobject" | "ol" | "personname" | "poem" | "sidebar" | "table" | "table1" | "tbody" | "td" | "tgroup" | "tr" | "ul";
 type AtomSchemaCode = "mark" | "indexterm" | "primary" | "secondary" | "tertiary" | "quaternary" | "bookmark" | "see" | "commentQuerySection" | "comment" | "content" | "query" | "reply" | "deletion" | "lineGroupRemoval" | "emphasis" | "highlightmark" | "i" | "insertion" | "sc" | "strike" | "sub" | "sup" | "u" | "b" | "referenceMark" | "abbreviation";
 type InlineSchemaCode = "footnote1" | "inlineequation" | "link" | "uri" | "phrase";
 
@@ -47,11 +47,7 @@ declare const SCHEMAS: {
         readonly defaultValue: "added";
     }]>;
     phrase: Schema<readonly ["store", "ele-id", "xml:lang"], readonly []>;
-    bibliodiv: Schema<readonly ["store", "ele-id", {
-        readonly name: "role";
-        readonly values: readonly ["H1", "H2", "H3", "H4", "H5", "H6"];
-        readonly defaultValue: "H1";
-    }], readonly []>;
+    bibliodiv: Schema<readonly ["store", "ele-id", "role"], readonly []>;
     referenceBibliography: Schema<readonly ["store", "ele-id", "xmlid", {
         readonly name: "role";
         readonly values: readonly ["chapterend"];
@@ -62,6 +58,30 @@ declare const SCHEMAS: {
         readonly defaultValue: "doc-bibliography";
     }], readonly []>;
     referenceBibliomixed: Schema<readonly ["store", "ele-id", "xmlid", "role"], readonly ["track-role", "data-userid", "data-date"]>;
+    bibliomset: Schema<readonly [{
+        readonly name: "relation";
+        readonly values: readonly ["part", "article", "book", "journal"];
+        readonly defaultValue: "part";
+    }], readonly ["store", "ele-id"]>;
+    editor: Schema<readonly [], readonly ["store", "ele-id"]>;
+    othercredit: Schema<readonly [], readonly ["store", "ele-id", "class", "otherclass"]>;
+    translator: Schema<readonly [], readonly ["store", "ele-id"]>;
+    collab: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pubdate: Schema<readonly [], readonly ["store", "ele-id"]>;
+    date: Schema<readonly [], readonly ["store", "ele-id", "role"]>;
+    publishername: Schema<readonly [], readonly ["store", "ele-id"]>;
+    address: Schema<readonly [], readonly ["store", "ele-id"]>;
+    city: Schema<readonly [], readonly ["store", "ele-id"]>;
+    volumenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    issuenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pagenums: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pagenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    edition: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pubId: Schema<readonly [], readonly ["store", "ele-id", "pub-id-type", "assigning-authority"]>;
+    biblioid: Schema<readonly [], readonly ["store", "ele-id", "class", "otherclass"]>;
+    bibliomisc: Schema<readonly [], readonly ["store", "ele-id", "role"]>;
+    confgroup: Schema<readonly [], readonly ["store", "ele-id"]>;
+    conftitle: Schema<readonly [], readonly ["store", "ele-id"]>;
     para: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "data-alignment", "data-left-indent", "data-right-indent", "data-special-indent", "data-space-above", "data-space-below", "data-indent-type", "data-layout-user", "data-paragraph-style", "xmlid", "role", "data-pos"]>;
     title1: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "data-alignment", "data-left-indent", "data-right-indent", "data-special-indent", "data-space-above", "data-space-below", "data-indent-type", "data-layout-user", "data-paragraph-style", "role", {
         readonly name: "fm-role";
@@ -69,7 +89,7 @@ declare const SCHEMAS: {
         readonly defaultValue: "false";
     }, {
         readonly name: "title";
-        readonly values: readonly ["H1", "H2", "H3", "H4", "H5", "H6", "foot_note"];
+        readonly values: readonly [...string[], "foot_note"];
         readonly defaultValue: "H1";
     }]>;
     footnote: Schema<readonly ["store", "ele-id", "label", "xmlid", {
@@ -248,7 +268,7 @@ declare const SCHEMAS: {
     }]>;
     sidebar: Schema<readonly ["store", "ele-id", {
         readonly name: "status";
-        readonly values: readonly ["box1", "box2", "box3", "box4", "box5"];
+        readonly values: string[];
         readonly defaultValue: "box1";
     }], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", {
         readonly name: "role";
@@ -290,7 +310,7 @@ declare const SCHEMAS: {
     sc: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date"]>;
     emphasis: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "role";
-        readonly values: readonly ["lowercase", "uppercase", "initialcaps"];
+        readonly values: readonly ["lowercase", "uppercase", "initialcaps", "Non breaking space"];
         readonly defaultValue: "lowercase";
     }]>;
     strike: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date"]>;
@@ -358,6 +378,235 @@ declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is Rest
 
 declare const isTrackChangesSchema: (schema: Schema) => boolean;
 
+type ReferenceTypeCode = "monograph" | "serial" | "contribution" | "article" | "message" | "website" | "unpublished" | "case" | "legislation" | "other" | "recording" | "film";
+type ReferenceFieldCode = "author" | "editor" | "title" | "year" | "containerTitle" | "publisherPlace" | "publisher" | "volume" | "issue" | "pages" | "doi" | "url" | "accessDate" | "genre" | "eventTitle" | "eventPlace" | "documentNumber" | "pubmedId";
+type RequiredReferenceField = "title" | "containerTitle" | "creators" | "year";
+type BibliomsetRelation = "part" | "book" | "article" | "journal";
+type ReferenceElementReplacement = {
+    tag: string;
+    replacement?: string;
+};
+type ReferenceFieldSchema = {
+    code: ReferenceFieldCode;
+    label: string;
+    elementCodes: readonly SchemaCode[];
+};
+type ReferenceTypeSchema = {
+    code: ReferenceTypeCode;
+    label: string;
+    legacyRoles: readonly string[];
+    allowedFields: readonly ReferenceFieldCode[];
+    requiredFields: readonly RequiredReferenceField[];
+    bibliomsetRelations?: readonly BibliomsetRelation[];
+    replacedElements?: readonly ReferenceElementReplacement[];
+    fieldLabels?: Partial<Record<ReferenceFieldCode, string>>;
+};
+
+declare const findReferenceTypeSchemaByElement: (reference: Element) => ReferenceTypeSchema | undefined;
+
+declare const findReferenceFieldByElement: (element: Element) => ReferenceFieldCode | undefined;
+
+declare const REFERENCE_FIELD_SCHEMAS: {
+    author: {
+        code: "author";
+        label: string;
+        elementCodes: ("othercredit" | "author")[];
+    };
+    editor: {
+        code: "editor";
+        label: string;
+        elementCodes: "editor"[];
+    };
+    title: {
+        code: "title";
+        label: string;
+        elementCodes: "title1"[];
+    };
+    year: {
+        code: "year";
+        label: string;
+        elementCodes: ("pubdate" | "date" | "confgroup")[];
+    };
+    containerTitle: {
+        code: "containerTitle";
+        label: string;
+        elementCodes: "title1"[];
+    };
+    publisherPlace: {
+        code: "publisherPlace";
+        label: string;
+        elementCodes: "address"[];
+    };
+    publisher: {
+        code: "publisher";
+        label: string;
+        elementCodes: ("publishername" | "orgname")[];
+    };
+    volume: {
+        code: "volume";
+        label: string;
+        elementCodes: "volumenum"[];
+    };
+    issue: {
+        code: "issue";
+        label: string;
+        elementCodes: "issuenum"[];
+    };
+    pages: {
+        code: "pages";
+        label: string;
+        elementCodes: "pagenums"[];
+    };
+    doi: {
+        code: "doi";
+        label: string;
+        elementCodes: "link"[];
+    };
+    url: {
+        code: "url";
+        label: string;
+        elementCodes: "link"[];
+    };
+    accessDate: {
+        code: "accessDate";
+        label: string;
+        elementCodes: "date"[];
+    };
+    genre: {
+        code: "genre";
+        label: string;
+        elementCodes: "bibliomisc"[];
+    };
+    eventTitle: {
+        code: "eventTitle";
+        label: string;
+        elementCodes: "confgroup"[];
+    };
+    eventPlace: {
+        code: "eventPlace";
+        label: string;
+        elementCodes: "address"[];
+    };
+    documentNumber: {
+        code: "documentNumber";
+        label: string;
+        elementCodes: "bibliomisc"[];
+    };
+    pubmedId: {
+        code: "pubmedId";
+        label: string;
+        elementCodes: "biblioid"[];
+    };
+};
+
+declare const REFERENCE_TYPE_SCHEMAS: {
+    monograph: {
+        code: "monograph";
+        label: string;
+        legacyRoles: string[];
+        allowedFields: ("editor" | "author" | "title" | "year" | "publisherPlace" | "publisher" | "volume" | "doi" | "url")[];
+        requiredFields: ("title" | "creators")[];
+        fieldLabels: {
+            title: string;
+        };
+    };
+    serial: {
+        code: "serial";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("title" | "year" | "volume" | "issue" | "doi" | "url")[];
+        requiredFields: "title"[];
+    };
+    contribution: {
+        code: "contribution";
+        label: string;
+        legacyRoles: string[];
+        allowedFields: ("editor" | "author" | "title" | "year" | "containerTitle" | "publisherPlace" | "publisher" | "pages" | "doi" | "url")[];
+        requiredFields: ("title" | "containerTitle" | "creators")[];
+        bibliomsetRelations: ("book" | "part")[];
+        fieldLabels: {
+            title: string;
+            containerTitle: string;
+        };
+    };
+    article: {
+        code: "article";
+        label: string;
+        legacyRoles: string[];
+        allowedFields: ("editor" | "author" | "title" | "year" | "containerTitle" | "publisherPlace" | "publisher" | "volume" | "issue" | "pages" | "doi" | "url" | "accessDate" | "genre" | "pubmedId")[];
+        requiredFields: ("title" | "containerTitle")[];
+        bibliomsetRelations: ("article" | "journal")[];
+        fieldLabels: {
+            title: string;
+            containerTitle: string;
+        };
+    };
+    message: {
+        code: "message";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("author" | "title" | "year" | "doi" | "url")[];
+        requiredFields: "title"[];
+    };
+    website: {
+        code: "website";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("author" | "title" | "year" | "doi" | "url" | "accessDate")[];
+        requiredFields: "title"[];
+    };
+    unpublished: {
+        code: "unpublished";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("author" | "title" | "year" | "publisher" | "doi" | "url" | "genre" | "eventTitle" | "eventPlace")[];
+        requiredFields: "title"[];
+        replacedElements: {
+            tag: string;
+            replacement: string;
+        }[];
+    };
+    case: {
+        code: "case";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("title" | "year" | "doi" | "url" | "documentNumber")[];
+        requiredFields: "title"[];
+    };
+    legislation: {
+        code: "legislation";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("title" | "year" | "publisherPlace" | "doi" | "url" | "documentNumber")[];
+        requiredFields: "title"[];
+    };
+    other: {
+        code: "other";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: readonly ["author", "editor", "title", "year", "containerTitle", "publisherPlace", "publisher", "volume", "issue", "pages", "accessDate", "genre", "eventTitle", "eventPlace", "documentNumber", "pubmedId", "doi", "url"];
+        requiredFields: "title"[];
+    };
+    recording: {
+        code: "recording";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("author" | "title" | "year" | "doi" | "url")[];
+        requiredFields: ("title" | "year")[];
+        replacedElements: {
+            tag: string;
+            replacement: string;
+        }[];
+    };
+    film: {
+        code: "film";
+        label: string;
+        legacyRoles: never[];
+        allowedFields: ("title" | "year" | "doi" | "url")[];
+        requiredFields: "title"[];
+    };
+};
+
 declare const ElementLabel: Record<SchemaCode, string>;
 
 type DependentForbiddenElement = {
@@ -379,6 +628,7 @@ declare const FIGURE_PLACEMENT_ATTRIBUTE = "data-figure-placement";
 declare const LAYOUT_CELL_WIDTH_ATTRIBUTE = "data-cell-width";
 declare const LAYOUT_TABLE_ORIENTATION_ATTRIBUTE = "data-table-orientation";
 declare const LAYOUT_TABLE_PLACEMENT_ATTRIBUTE = "data-table-placement";
+declare const VALIDATION_IGNORED_ATTRIBUTE = "data-validation-ignored";
 declare const LAYOUT_ATTRIBUTES: readonly ["data-alignment", "data-left-indent", "data-right-indent", "data-special-indent", "data-space-above", "data-space-below", "data-indent-type", "data-layout-user", "data-paragraph-style"];
 declare const TRACK_CHANGES_ATTR_DATA_USERNAME = "data-username";
 declare const TRACK_CHANGES_ATTR_DATA_USERID = "data-userid";
@@ -392,11 +642,7 @@ declare const LINKEND_ATTRIBUTE = "linkend";
 declare const ID_ATTRS: readonly ["store", "ele-id"];
 
 declare const ELEMENT_SCHEMAS: {
-    bibliodiv: Schema<readonly ["store", "ele-id", {
-        readonly name: "role";
-        readonly values: readonly ["H1", "H2", "H3", "H4", "H5", "H6"];
-        readonly defaultValue: "H1";
-    }], readonly []>;
+    bibliodiv: Schema<readonly ["store", "ele-id", "role"], readonly []>;
     referenceBibliography: Schema<readonly ["store", "ele-id", "xmlid", {
         readonly name: "role";
         readonly values: readonly ["chapterend"];
@@ -407,6 +653,30 @@ declare const ELEMENT_SCHEMAS: {
         readonly defaultValue: "doc-bibliography";
     }], readonly []>;
     referenceBibliomixed: Schema<readonly ["store", "ele-id", "xmlid", "role"], readonly ["track-role", "data-userid", "data-date"]>;
+    bibliomset: Schema<readonly [{
+        readonly name: "relation";
+        readonly values: readonly ["part", "article", "book", "journal"];
+        readonly defaultValue: "part";
+    }], readonly ["store", "ele-id"]>;
+    editor: Schema<readonly [], readonly ["store", "ele-id"]>;
+    othercredit: Schema<readonly [], readonly ["store", "ele-id", "class", "otherclass"]>;
+    translator: Schema<readonly [], readonly ["store", "ele-id"]>;
+    collab: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pubdate: Schema<readonly [], readonly ["store", "ele-id"]>;
+    date: Schema<readonly [], readonly ["store", "ele-id", "role"]>;
+    publishername: Schema<readonly [], readonly ["store", "ele-id"]>;
+    address: Schema<readonly [], readonly ["store", "ele-id"]>;
+    city: Schema<readonly [], readonly ["store", "ele-id"]>;
+    volumenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    issuenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pagenums: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pagenum: Schema<readonly [], readonly ["store", "ele-id"]>;
+    edition: Schema<readonly [], readonly ["store", "ele-id"]>;
+    pubId: Schema<readonly [], readonly ["store", "ele-id", "pub-id-type", "assigning-authority"]>;
+    biblioid: Schema<readonly [], readonly ["store", "ele-id", "class", "otherclass"]>;
+    bibliomisc: Schema<readonly [], readonly ["store", "ele-id", "role"]>;
+    confgroup: Schema<readonly [], readonly ["store", "ele-id"]>;
+    conftitle: Schema<readonly [], readonly ["store", "ele-id"]>;
     para: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "data-alignment", "data-left-indent", "data-right-indent", "data-special-indent", "data-space-above", "data-space-below", "data-indent-type", "data-layout-user", "data-paragraph-style", "xmlid", "role", "data-pos"]>;
     title1: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "data-alignment", "data-left-indent", "data-right-indent", "data-special-indent", "data-space-above", "data-space-below", "data-indent-type", "data-layout-user", "data-paragraph-style", "role", {
         readonly name: "fm-role";
@@ -414,7 +684,7 @@ declare const ELEMENT_SCHEMAS: {
         readonly defaultValue: "false";
     }, {
         readonly name: "title";
-        readonly values: readonly ["H1", "H2", "H3", "H4", "H5", "H6", "foot_note"];
+        readonly values: readonly [...string[], "foot_note"];
         readonly defaultValue: "H1";
     }]>;
     footnote: Schema<readonly ["store", "ele-id", "label", "xmlid", {
@@ -593,7 +863,7 @@ declare const ELEMENT_SCHEMAS: {
     }]>;
     sidebar: Schema<readonly ["store", "ele-id", {
         readonly name: "status";
-        readonly values: readonly ["box1", "box2", "box3", "box4", "box5"];
+        readonly values: string[];
         readonly defaultValue: "box1";
     }], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", {
         readonly name: "role";
@@ -662,7 +932,7 @@ declare const ATOM_SCHEMAS: {
     sc: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date"]>;
     emphasis: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "role";
-        readonly values: readonly ["lowercase", "uppercase", "initialcaps"];
+        readonly values: readonly ["lowercase", "uppercase", "initialcaps", "Non breaking space"];
         readonly defaultValue: "lowercase";
     }]>;
     strike: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date"]>;
@@ -721,16 +991,18 @@ type ValidationErrorLevel = "blocker" | "warning" | "info";
 type ValidationErrorKind = "unlinked" | "uncited" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
 type ValidationError = {
     id: string;
-    store: string;
+    store?: string;
     title: string;
     level: ValidationErrorLevel;
     kind: ValidationErrorKind;
     description: string;
+    ignored: boolean;
+    elements?: Element[];
 };
 
 /**
  * Validates the XML document against the schema.
- 
+
  * @param xml - The XML document to validate.
  * @param elementsToLink - The elements IDs that are linked to.
  * @param linkElements - The elements IDs that are linked to.
@@ -739,6 +1011,82 @@ type ValidationError = {
  * @returns The validation errors.
  */
 declare const validateXml: (xml: Element, elementsToLink: string[], linkElements: string[], schemasToValidateAgainst: SchemaCode[]) => ValidationError[];
+type ValidateXmlAsyncOptions = {
+    /** Rejects with the signal's reason once aborted. */
+    signal?: AbortSignal;
+    /** How long to work before handing the main thread back. Defaults to 8 ms. */
+    timeBudgetMs?: number;
+};
+/**
+ * Same result as `validateXml`, but works in short slices and hands the main
+ * thread back between them, so large documents do not freeze the page.
+ *
+ * Pass a copy of the document if it can change while validation runs.
+ */
+declare const validateXmlAsync: (xml: Element, elementsToLink: string[], linkElements: string[], schemasToValidateAgainst: SchemaCode[], { signal, timeBudgetMs }?: ValidateXmlAsyncOptions) => Promise<ValidationError[]>;
+
+type LinkIds = readonly string[] | ReadonlySet<string>;
+
+declare const findElementLinkedTo: (linkend: string, elementsToLink: LinkIds) => boolean;
+declare const LINK_TO_CROSS_CHECK: string[];
+declare const LINK_BLOCKER_ROLES: string[];
+declare const validateLinkend: (linkElement: Element, elementsToLink: LinkIds) => ValidationError[];
+
+/** Work split into steps: each `yield` is a point where a caller may pause. */
+type Steps<T> = Generator<void, T, void>;
+
+declare const POSSIBLE_WEBLINK_CLASS = "possible-weblink";
+declare const POSSIBLE_WEBLINK_EXCLUDE_SELECTORS: string[];
+type PossibleWeblink = {
+    weblink: string;
+    elements: Element[];
+};
+declare const getPossibleWeblinks: (root: Element) => Map<string, PossibleWeblink>;
+declare const markPossibleWeblinks: (editor: HTMLElement) => Map<string, PossibleWeblink>;
+declare function validatePossibleWeblinksSteps(root: Element): Steps<ValidationError[]>;
+declare const validatePossibleWeblinks: (root: Element) => ValidationError[];
+declare const clearWeblinkMatches: (editor: HTMLElement) => void;
+
+declare const validateOlink: (element: Element) => ValidationError[];
+
+type ElementHierarchy = "heading" | "box";
+declare const validateHierarchy: (element: Element, elementHierarchy: ElementHierarchy) => ValidationError[];
+
+declare const extractFootnoteNumber: (footnote: Element | null) => number | "no label";
+declare const validateFootnoteNumber: (footnoteElement: Element) => ValidationError[];
+declare const validateConsecutiveFootnotes: (root: Element | Document) => ValidationError[];
+declare const validateConsecutiveFootnoteCues: (root: Element | Document) => ValidationError[];
+
+declare const validateElementToLinkTo: (element: Element, linkElements: LinkIds) => ValidationError[];
+
+declare const validateElementAgainstSchema: (element: Element, schema: Schema) => ValidationError[];
+declare const getEffectiveChildElements: (element: Element) => Element[];
+
+declare const validateAttributes: (element: Element, schema: Schema) => ValidationError[];
+
+type ReferenceMarkupRule = "missing_id" | "bibliomset_relation" | "bibliomset_missing" | "bibliomset_repeated" | "bibliomset_title" | "bibliomset_nested" | "part_editor" | "personname_role" | "name_outside_personname" | "othercredit_artist" | "link_without_target" | "doi_inside_uri" | "doi_outside_doi_org" | "uri_outside_link" | "confgroup_text" | "confdates_outside_confgroup";
+type ReferenceMarkupIssue = {
+    code: "wrong_element";
+    tag: string;
+    replacement?: string;
+    elements: Element[];
+} | {
+    code: "markup";
+    rule: ReferenceMarkupRule;
+    elements: Element[];
+};
+
+type ReferenceStructureIssue = {
+    code: "unknown_type";
+} | {
+    code: "missing";
+    field: RequiredReferenceField;
+} | {
+    code: "not_allowed";
+    field: ReferenceFieldCode;
+} | ReferenceMarkupIssue;
+declare const validateReferenceStructure: (reference: Element) => ReferenceStructureIssue[];
+declare const getReferenceStructureIssueElements: (reference: Element, issue: ReferenceStructureIssue) => Element[];
 
 declare const getElementLinks: (contentChaptersToValidate: string[]) => {
     elementsToLink: string[];
@@ -785,4 +1133,12 @@ type GetAdjacentElementOptions = {
 };
 declare const getAdjacentElement: ({ element, direction, code, }: GetAdjacentElementOptions) => HTMLElement | undefined;
 
-export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, DEPENDENT_FORBIDDEN_ELEMENTS, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, ElementLabel, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH_ATTRIBUTE, LAYOUT_TABLE_ORIENTATION_ATTRIBUTE, LAYOUT_TABLE_PLACEMENT_ATTRIBUTE, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, LINKEND_ATTRIBUTE, RIGHT_INDENT_ATTRIBUTE, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaAttributes, type SchemaCode, type SchemaKind, type SchemasByCode, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, XMLID_ATTRIBUTE, closestElementBySchema, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAdjacentElement, getAttributeName, getElementLinks, getStore, isAttributeRestricted, isDeletedElement, isIgnoredAttribute, isIgnoredElement, isTrackChangesSchema, queryAllElementsBySchema, queryElementBySchema, validateXml };
+type ReferenceFieldElement = {
+    field: ReferenceFieldCode;
+    element: HTMLElement;
+};
+declare const REFERENCE_PART_SELECTOR: string;
+declare const getReferenceParts: (reference: Element) => HTMLElement[];
+declare const getReferenceFieldElements: (reference: Element) => ReferenceFieldElement[];
+
+export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, type BibliomsetRelation, DEPENDENT_FORBIDDEN_ELEMENTS, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, ElementLabel, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH_ATTRIBUTE, LAYOUT_TABLE_ORIENTATION_ATTRIBUTE, LAYOUT_TABLE_PLACEMENT_ATTRIBUTE, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, LINKEND_ATTRIBUTE, LINK_BLOCKER_ROLES, LINK_TO_CROSS_CHECK, POSSIBLE_WEBLINK_CLASS, POSSIBLE_WEBLINK_EXCLUDE_SELECTORS, REFERENCE_FIELD_SCHEMAS, REFERENCE_PART_SELECTOR, REFERENCE_TYPE_SCHEMAS, RIGHT_INDENT_ATTRIBUTE, type ReferenceElementReplacement, type ReferenceFieldCode, type ReferenceFieldElement, type ReferenceFieldSchema, type ReferenceMarkupIssue, type ReferenceMarkupRule, type ReferenceStructureIssue, type ReferenceTypeCode, type ReferenceTypeSchema, type RequiredReferenceField, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaAttributes, type SchemaCode, type SchemaKind, type SchemasByCode, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, VALIDATION_IGNORED_ATTRIBUTE, type ValidateXmlAsyncOptions, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, XMLID_ATTRIBUTE, clearWeblinkMatches, closestElementBySchema, createElement, extractFootnoteNumber, findAttributeDefinitionByName, findElementLinkedTo, findReferenceFieldByElement, findReferenceTypeSchemaByElement, findSchemaByCode, findSchemaByElement, getAdjacentElement, getAttributeName, getEffectiveChildElements, getElementLinks, getPossibleWeblinks, getReferenceFieldElements, getReferenceParts, getReferenceStructureIssueElements, getStore, isAttributeRestricted, isDeletedElement, isIgnoredAttribute, isIgnoredElement, isTrackChangesSchema, markPossibleWeblinks, queryAllElementsBySchema, queryElementBySchema, validateAttributes, validateConsecutiveFootnoteCues, validateConsecutiveFootnotes, validateElementAgainstSchema, validateElementToLinkTo, validateFootnoteNumber, validateHierarchy, validateLinkend, validateOlink, validatePossibleWeblinks, validatePossibleWeblinksSteps, validateReferenceStructure, validateXml, validateXmlAsync };