pro-editor-schema 1.3.0 → 1.4.1

package/README.md

@@ -2,11 +2,15 @@
 
 TypeScript library that defines XML/HTML schema rules used by the editor and provides validation utilities for document structure, attributes, links, and footnotes.
 
+## NPM
+
+https://www.npmjs.com/package/pro-editor-schema?activeTab=versions
+
 ## What this repository contains
 
 - Schema definitions for supported tags and schema codes.
 - Shared schema constants and attribute helpers.
-- Runtime schema lookup utilities.
+- Runtime schema lookup and DOM helpers.
 - XML validation utilities (`validateXml` and related validators).
 - Type-safe element factory (`createElement`) based on schema definitions.
 
@@ -18,94 +22,121 @@ npm install
 
 ## Scripts
 
-| Command              | Description                                                                         |
-| -------------------- | ----------------------------------------------------------------------------------- |
-| `npm run dev`        | Build in watch mode                                                                 |
-| `npm run build`      | Build CJS, ESM, and type declarations                                               |
-| `npm run typecheck`  | Run TypeScript without emitting files                                               |
-| `npm run lint`       | Run ESLint on `src/`                                                                |
-| `npm run test`       | Run tests once with Vitest                                                          |
-| `npm run test:watch` | Run tests in watch mode                                                             |
-| `npm run check`      | Run the full verification pipeline (`npm ci`, `typecheck`, `lint`, `test`, `build`) |
+| Command                      | Description                                                                         |
+| ---------------------------- | ----------------------------------------------------------------------------------- |
+| `npm run dev`                | Build in watch mode                                                                 |
+| `npm run build`              | Build CJS, ESM, and type declarations                                               |
+| `npm run typecheck`          | Run TypeScript without emitting files                                               |
+| `npm run lint`               | Run ESLint on `src/`                                                                |
+| `npm run test`               | Run tests once with Vitest                                                          |
+| `npm run test:watch`         | Run tests in watch mode                                                             |
+| `npm run check`              | Run the full verification pipeline (`npm ci`, `typecheck`, `lint`, `test`, `build`) |
+| `npm run release:patch`      | Create `release/v*`, bump patch, and push (`1.3.4` → `1.3.5`)                       |
+| `npm run release:minor`      | Create `release/v*`, bump minor, and push (`1.3.4` → `1.4.0`)                       |
+| `npm run release:major`      | Create `release/v*`, bump major, and push (`1.3.4` → `2.0.0`)                       |
+| `npm run release:prerelease` | Create `prerelease/v*`, bump prerelease, and push (`1.4.0` → `1.4.0-1`)             |
 
 For local development, `npm run check` is the fastest way to verify everything before pushing.
 
 ## Publishing
 
-The package is published to npm as `pro-editor-schema`. Use the `beta` tag for pre-release installs, and the default `latest` tag for latest.
+The package is published to npm as `pro-editor-schema`.
+
+Publishing is automated by GitHub Actions when a pull request into `master` is merged from a `release/` or `prerelease/` branch.
+
+| Branch prefix | npm dist-tag |
+| ------------- | ------------ |
+| `release/`    | `latest`     |
+| `prerelease/` | `prerelease` |
+
+Other merged branches do not publish.
 
 ### Prerequisites
 
 1. You must have publish access to the `pro-editor-schema` package on npm.
-2. Log in if needed:
+2. Start from a clean git working tree.
 
-```bash
-npm login
-```
+### Publish a release
 
-3. Bump the version in `package.json` (and commit it). npm rejects republishing an existing version.
-4. Verify the package:
+From your current branch, run one of:
 
-```bash
-npm run check
-```
+- `npm run release:patch` — bug fixes / small backwards-compatible changes, e.g. `1.3.4` → branch `release/v1.3.5`
+- `npm run release:minor` — backwards-compatible functionality, e.g. `1.3.4` → branch `release/v1.4.0`
+- `npm run release:major` — breaking changes, e.g. `1.3.4` → branch `release/v2.0.0`
+- `npm run release:prerelease` — first prerelease of a version, e.g. `1.4.0` → branch `prerelease/v1.4.0-1` (then `1.4.0-1` → `prerelease/v1.4.0-2`)
 
-### Publish to beta
+Each command:
 
-```bash
-npm publish --tag beta --access public
-```
+1. Creates the `release/v*` or `prerelease/v*` branch.
+2. Bumps `package.json` and commits the version.
+3. Pushes the branch (and version tag) to origin.
 
-Install the beta build in a consumer app with:
+Then open a pull request into `master` and merge it.
 
-```bash
-npm install pro-editor-schema@beta
-```
+Merging a `release/` or `prerelease/` branch into `master` starts the publishing workflow.
+
+The workflow:
+
+1. Checks out the repository.
+2. Installs dependencies with `npm ci`.
+3. Runs the full test suite.
+4. Runs TypeScript typechecking.
+5. Runs ESLint.
+6. Builds the package.
+7. Publishes to npm with the `latest` or `prerelease` dist-tag, based on the branch prefix.
 
-### Publish to latest
+### Latest releases
 
-Production uses npm’s default `latest` tag:
+Production releases are published with npm's `latest` dist-tag.
+Prereleases are published with the `prerelease` dist-tag.
+
+Install the latest production version:
 
 ```bash
-npm publish --access public
+npm install pro-editor-schema
 ```
 
-Install the latest build with:
+Or explicitly:
 
 ```bash
-npm install pro-editor-schema
-# or explicitly:
 npm install pro-editor-schema@latest
 ```
 
+Install a prerelease:
+
+```bash
+npm install pro-editor-schema@prerelease
+```
+
 ### Notes
 
-- Always run `npm run check` before publishing so typecheck, lint, tests, and build succeed.
-- Each publish needs a new `version` in `package.json`.
-- Staging and latest can point at different versions at the same time (for example `1.1.3` on `beta` and `1.1.2` on `latest`).
-- GitHub Actions also publishes to `latest` when you push a `v*` git tag (see `.github/workflows/publish.yml`).
+- Each npm version can only be published once.
+- Do not manually run `npm publish` when using the GitHub Actions workflow.
 
 ## CI
 
-GitHub Actions runs on push and pull requests to `main` / `master`:
+GitHub Actions CI runs on pull requests (`.github/workflows/ci.yml`):
 
-- **Typecheck** — `npm run typecheck`
-- **Lint** — `npm run lint`
-- **Test** — `npm test`
+- **Typecheck** — `npm run typecheck` (full project)
+- **Lint** — `npm run lint` (full `src/`)
+- **Test** — Vitest for files changed in the PR (`vitest run --changed` against the PR base branch)
 
-Workflow file: `.github/workflows/ci.yml`
+The publishing workflow is defined in `.github/workflows/publish.yml`.
 
 ## Project structure
 
-- `src/index.ts` — public exports for schemas, types, shared constants, and validation.
+- `src/index.ts` — public exports for schemas, types, helpers, and validation.
 - `src/schema/schema.types.ts` — core schema and validation-related types.
 - `src/schema/schemas.ts` — central `SCHEMAS` map (`code -> schema`).
 - `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/shared` — shared attribute and ignored-node constants.
-- `src/schema/utils` — schema lookup, element creation, and label helpers.
+- `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).
 - `src/validation` — document validation entrypoint and validation modules.
+- `src/validation/helpers` — validation issue helpers and ignored-validation codes.
+- `src/validation/utils` — validation-only DOM helpers.
 - `src/**/*.test.ts` — Vitest test files (run with `happy-dom`).
 
 ## Schema model
@@ -147,9 +178,11 @@ From `src/index.ts`, consumers can import:
 
 - **Types:** `Schema`, `SchemaCode`, `ElementSchemaCode`, `AtomSchemaCode`, `InlineSchemaCode`, `ValidationError`
 - **Maps:** `SCHEMAS`, `ELEMENT_SCHEMAS`, `ATOM_SCHEMAS`, `INLINE_ELEMENT_SCHEMAS`
-- **Utilities:** `findSchemaByCode`, `findSchemaByElement`, `createElement`, `ElementLabel`
+- **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`
-- **Shared constants:** ignored elements/attributes, global attribute constants, dependents forbidden elements
+- **Shared constants:** `ElementLabel`, global attribute constants, dependents forbidden elements
 
 ## Usage examples
 
@@ -175,6 +208,20 @@ const para = createElement({
 });
 ```
 
+### Find the closest matching element
+
+```ts
+import { closestElementBySchema } from "pro-editor-schema";
+
+const heading = closestElementBySchema({
+  element,
+  code: "heading",
+  ignoreDeletedElements: true,
+});
+```
+
+`closest()` includes the starting element. To look at a parent only, pass `element.parentElement`.
+
 ### Validate an XML root
 
 ```ts
@@ -202,19 +249,21 @@ const errors = validateXml(rootElement, elementsToLink, linkElements, [
 It also runs per-element checks for:
 
 - Link targets (`linkend`) on linkable elements
-- Uncited bibliographic references
-- Unreferenced footnotes
+- Uncited elements
 - Heading hierarchy
+- ORCID `olink` values
 
 Schema-based attribute and child validation only runs for codes listed in `schemasToValidateAgainst`.
 
 ## How validation works
 
 - `validateXml` traverses the XML tree and delegates checks per element.
+- `isIgnoredElement` skips editor UI helper nodes.
 - `findSchemaByElement` resolves schema from tag and optional `matchesElement`.
 - `validateAttributes` validates restricted attribute values.
 - `validateChildren` ensures child tags are allowed and required children exist.
-- `validateFootnotes`, `validateLinkend`, and `validateReferenceCited` provide cross-reference integrity checks.
+- `validateFootnotes`, `validateLinkend`, `validateElementToLinkTo`, `validateHeadingHierarchy`, `validateOlink`, and `validateWeblink` provide additional integrity checks.
+- `isIgnoredValidation` skips remaining child-tree validation for selected schema codes (for example bibliographic mixed content).
 
 Validation results use `ValidationError`:
 
@@ -245,5 +294,5 @@ Validation results use `ValidationError`:
 
 - Tag matching is done in uppercase in schema definitions and validation.
 - Some schema codes represent block/group-like structures while still being typed as `kind: "element"` in the current model.
-- Ignored attributes and ignored UI helper elements are excluded from strict validation by design.
-- Track-changes atoms (`insertion`, `deletion`) are unwrapped when validating required children.
+- Ignored attributes and ignored UI helper elements live in `src/helpers` and are excluded from strict validation by design.
+- Track-changes atoms (`insertion`, `deletion`, `lineGroupRemoval`) are unwrapped when validating required children.

package/dist/index.d.mts

@@ -22,7 +22,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
 };
 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 AtomSchemaCode = "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 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";
 
 declare const SCHEMAS: {
@@ -338,42 +338,28 @@ declare const SCHEMAS: {
         readonly values: readonly ["add", "edit"];
         readonly defaultValue: "add";
     }], readonly []>;
+    mark: Schema<readonly ["id"], readonly ["data-markjs", {
+        readonly name: "data-replaceable";
+        readonly values: readonly ["true", "false"];
+        readonly defaultValue: "true";
+    }]>;
 };
 type SchemasByCode = typeof SCHEMAS;
 
-declare const isTrackChangesSchema: (schema: Schema) => boolean;
-declare const isIgnoredAttribute: (attribute: string) => boolean;
-declare const isIgnoredElement: (element: Element) => boolean;
-declare const isIgnoredValidation: (code: SchemaCode) => boolean;
+declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
+
 declare const findSchemaByCode: (code: SchemaCode) => Schema;
+
 declare const findSchemaByElement: (element: Element) => Schema | undefined;
-declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
+
 declare const getAttributeName: (attribute: AttributeDefinition) => string;
-declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
 
-type AttributeValue<TAttribute extends AttributeDefinition> = TAttribute extends string ? string : TAttribute extends RestrictedAttribute<infer TValues> ? TValues extends readonly string[] ? TValues[number] : string : never;
-type AttributeName<TAttribute extends AttributeDefinition> = TAttribute extends string ? TAttribute : TAttribute extends RestrictedAttribute ? TAttribute["name"] : never;
-type AttributesFromDefinitions<TDefinitions extends readonly AttributeDefinition[]> = {
-    [TAttribute in TDefinitions[number] as AttributeName<TAttribute>]: AttributeValue<TAttribute>;
-};
-type SchemaAttributes<TSchema extends Schema> = TSchema extends Schema<infer TRequired extends readonly AttributeDefinition[], infer TOptional extends readonly AttributeDefinition[]> ? AttributesFromDefinitions<TRequired> & Partial<AttributesFromDefinitions<TOptional>> : never;
-type CreateElementParams<TCode extends SchemaCode> = {
-    schemaCode: TCode;
-    attributes: SchemaAttributes<SchemasByCode[TCode]>;
-};
-declare const createElement: <TCode extends SchemaCode>({ schemaCode, attributes, }: CreateElementParams<TCode>) => HTMLElement;
+declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
 
-declare const queryElementBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement | undefined;
-declare const queryAllElementsBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement[];
+declare const isTrackChangesSchema: (schema: Schema) => boolean;
 
 declare const ElementLabel: Record<SchemaCode, string>;
 
-declare const IGNORED_ELEMENT_SELECTORS: string[];
-declare const IGNORED_VALIDATION_ELEMENT_SELECTORS: SchemaCode[];
-
-declare const IGNORED_ATTRIBUTES: string[];
-declare const IGNORED_ATTRIBUTES_STARTS_WITH: string[];
-
 type DependentForbiddenElement = {
     code: SchemaCode;
     dependentElements: SchemaCode[];
@@ -401,6 +387,8 @@ declare const TRACK_CHANGES_ATTR_DATA_DATE = "data-date";
 declare const TRACK_CHANGES_ATTRS: readonly ["data-username", "data-userid", "data-time", "data-date"];
 declare const ELE_ID_ATTRIBUTE = "ele-id";
 declare const STORE_ATTRIBUTE = "store";
+declare const XMLID_ATTRIBUTE = "xmlid";
+declare const LINKEND_ATTRIBUTE = "linkend";
 declare const ID_ATTRS: readonly ["store", "ele-id"];
 
 declare const ELEMENT_SCHEMAS: {
@@ -722,10 +710,15 @@ declare const ATOM_SCHEMAS: {
         readonly values: readonly ["add", "edit"];
         readonly defaultValue: "add";
     }], readonly []>;
+    mark: Schema<readonly ["id"], readonly ["data-markjs", {
+        readonly name: "data-replaceable";
+        readonly values: readonly ["true", "false"];
+        readonly defaultValue: "true";
+    }]>;
 };
 
 type ValidationErrorLevel = "blocker" | "warning" | "info";
-type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
+type ValidationErrorKind = "unlinked" | "uncited" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
 type ValidationError = {
     id: string;
     store: string;
@@ -747,4 +740,49 @@ type ValidationError = {
  */
 declare const validateXml: (xml: Element, elementsToLink: string[], linkElements: string[], schemasToValidateAgainst: SchemaCode[]) => ValidationError[];
 
-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, IGNORED_VALIDATION_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, 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, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, isIgnoredValidation, isTrackChangesSchema, queryAllElementsBySchema, queryElementBySchema, validateXml };
+declare const getElementLinks: (contentChaptersToValidate: string[]) => {
+    elementsToLink: string[];
+    linkedElements: string[];
+};
+
+type AttributeValue<TAttribute extends AttributeDefinition> = TAttribute extends string ? string : TAttribute extends RestrictedAttribute<infer TValues> ? TValues extends readonly string[] ? TValues[number] : string : never;
+type AttributeName<TAttribute extends AttributeDefinition> = TAttribute extends string ? TAttribute : TAttribute extends RestrictedAttribute ? TAttribute["name"] : never;
+type AttributesFromDefinitions<TDefinitions extends readonly AttributeDefinition[]> = {
+    [TAttribute in TDefinitions[number] as AttributeName<TAttribute>]: AttributeValue<TAttribute>;
+};
+type SchemaAttributes<TSchema extends Schema> = TSchema extends Schema<infer TRequired extends readonly AttributeDefinition[], infer TOptional extends readonly AttributeDefinition[]> ? AttributesFromDefinitions<TRequired> & Partial<AttributesFromDefinitions<TOptional>> : never;
+type CreateElementParams<TCode extends SchemaCode> = {
+    schemaCode: TCode;
+    attributes: SchemaAttributes<SchemasByCode[TCode]>;
+};
+declare const createElement: <TCode extends SchemaCode>({ schemaCode, attributes, }: CreateElementParams<TCode>) => HTMLElement;
+
+declare const queryElementBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement | undefined;
+declare const queryAllElementsBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement[];
+
+type ClosestElementBySchemaOptions = {
+    element: Element | HTMLElement;
+    code: SchemaCode;
+    ignoreDeletedElements?: boolean;
+};
+declare const closestElementBySchema: ({ element, code, ignoreDeletedElements, }: ClosestElementBySchemaOptions) => HTMLElement | undefined;
+
+declare const getStore: (element: Element) => string;
+
+declare const isDeletedElement: (element: Element) => boolean;
+
+declare const IGNORED_ATTRIBUTES: string[];
+declare const IGNORED_ATTRIBUTES_STARTS_WITH: string[];
+declare const isIgnoredAttribute: (attribute: string) => boolean;
+
+declare const IGNORED_ELEMENT_SELECTORS: string[];
+declare const isIgnoredElement: (element: Element) => boolean;
+
+type GetAdjacentElementOptions = {
+    element: HTMLElement | Element;
+    direction: "next" | "previous";
+    code: SchemaCode;
+};
+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 };

package/dist/index.d.ts

@@ -22,7 +22,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
 };
 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 AtomSchemaCode = "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 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";
 
 declare const SCHEMAS: {
@@ -338,42 +338,28 @@ declare const SCHEMAS: {
         readonly values: readonly ["add", "edit"];
         readonly defaultValue: "add";
     }], readonly []>;
+    mark: Schema<readonly ["id"], readonly ["data-markjs", {
+        readonly name: "data-replaceable";
+        readonly values: readonly ["true", "false"];
+        readonly defaultValue: "true";
+    }]>;
 };
 type SchemasByCode = typeof SCHEMAS;
 
-declare const isTrackChangesSchema: (schema: Schema) => boolean;
-declare const isIgnoredAttribute: (attribute: string) => boolean;
-declare const isIgnoredElement: (element: Element) => boolean;
-declare const isIgnoredValidation: (code: SchemaCode) => boolean;
+declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
+
 declare const findSchemaByCode: (code: SchemaCode) => Schema;
+
 declare const findSchemaByElement: (element: Element) => Schema | undefined;
-declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
+
 declare const getAttributeName: (attribute: AttributeDefinition) => string;
-declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
 
-type AttributeValue<TAttribute extends AttributeDefinition> = TAttribute extends string ? string : TAttribute extends RestrictedAttribute<infer TValues> ? TValues extends readonly string[] ? TValues[number] : string : never;
-type AttributeName<TAttribute extends AttributeDefinition> = TAttribute extends string ? TAttribute : TAttribute extends RestrictedAttribute ? TAttribute["name"] : never;
-type AttributesFromDefinitions<TDefinitions extends readonly AttributeDefinition[]> = {
-    [TAttribute in TDefinitions[number] as AttributeName<TAttribute>]: AttributeValue<TAttribute>;
-};
-type SchemaAttributes<TSchema extends Schema> = TSchema extends Schema<infer TRequired extends readonly AttributeDefinition[], infer TOptional extends readonly AttributeDefinition[]> ? AttributesFromDefinitions<TRequired> & Partial<AttributesFromDefinitions<TOptional>> : never;
-type CreateElementParams<TCode extends SchemaCode> = {
-    schemaCode: TCode;
-    attributes: SchemaAttributes<SchemasByCode[TCode]>;
-};
-declare const createElement: <TCode extends SchemaCode>({ schemaCode, attributes, }: CreateElementParams<TCode>) => HTMLElement;
+declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
 
-declare const queryElementBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement | undefined;
-declare const queryAllElementsBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement[];
+declare const isTrackChangesSchema: (schema: Schema) => boolean;
 
 declare const ElementLabel: Record<SchemaCode, string>;
 
-declare const IGNORED_ELEMENT_SELECTORS: string[];
-declare const IGNORED_VALIDATION_ELEMENT_SELECTORS: SchemaCode[];
-
-declare const IGNORED_ATTRIBUTES: string[];
-declare const IGNORED_ATTRIBUTES_STARTS_WITH: string[];
-
 type DependentForbiddenElement = {
     code: SchemaCode;
     dependentElements: SchemaCode[];
@@ -401,6 +387,8 @@ declare const TRACK_CHANGES_ATTR_DATA_DATE = "data-date";
 declare const TRACK_CHANGES_ATTRS: readonly ["data-username", "data-userid", "data-time", "data-date"];
 declare const ELE_ID_ATTRIBUTE = "ele-id";
 declare const STORE_ATTRIBUTE = "store";
+declare const XMLID_ATTRIBUTE = "xmlid";
+declare const LINKEND_ATTRIBUTE = "linkend";
 declare const ID_ATTRS: readonly ["store", "ele-id"];
 
 declare const ELEMENT_SCHEMAS: {
@@ -722,10 +710,15 @@ declare const ATOM_SCHEMAS: {
         readonly values: readonly ["add", "edit"];
         readonly defaultValue: "add";
     }], readonly []>;
+    mark: Schema<readonly ["id"], readonly ["data-markjs", {
+        readonly name: "data-replaceable";
+        readonly values: readonly ["true", "false"];
+        readonly defaultValue: "true";
+    }]>;
 };
 
 type ValidationErrorLevel = "blocker" | "warning" | "info";
-type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
+type ValidationErrorKind = "unlinked" | "uncited" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
 type ValidationError = {
     id: string;
     store: string;
@@ -747,4 +740,49 @@ type ValidationError = {
  */
 declare const validateXml: (xml: Element, elementsToLink: string[], linkElements: string[], schemasToValidateAgainst: SchemaCode[]) => ValidationError[];
 
-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, IGNORED_VALIDATION_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, 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, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, isIgnoredValidation, isTrackChangesSchema, queryAllElementsBySchema, queryElementBySchema, validateXml };
+declare const getElementLinks: (contentChaptersToValidate: string[]) => {
+    elementsToLink: string[];
+    linkedElements: string[];
+};
+
+type AttributeValue<TAttribute extends AttributeDefinition> = TAttribute extends string ? string : TAttribute extends RestrictedAttribute<infer TValues> ? TValues extends readonly string[] ? TValues[number] : string : never;
+type AttributeName<TAttribute extends AttributeDefinition> = TAttribute extends string ? TAttribute : TAttribute extends RestrictedAttribute ? TAttribute["name"] : never;
+type AttributesFromDefinitions<TDefinitions extends readonly AttributeDefinition[]> = {
+    [TAttribute in TDefinitions[number] as AttributeName<TAttribute>]: AttributeValue<TAttribute>;
+};
+type SchemaAttributes<TSchema extends Schema> = TSchema extends Schema<infer TRequired extends readonly AttributeDefinition[], infer TOptional extends readonly AttributeDefinition[]> ? AttributesFromDefinitions<TRequired> & Partial<AttributesFromDefinitions<TOptional>> : never;
+type CreateElementParams<TCode extends SchemaCode> = {
+    schemaCode: TCode;
+    attributes: SchemaAttributes<SchemasByCode[TCode]>;
+};
+declare const createElement: <TCode extends SchemaCode>({ schemaCode, attributes, }: CreateElementParams<TCode>) => HTMLElement;
+
+declare const queryElementBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement | undefined;
+declare const queryAllElementsBySchema: (content: Document | Element | HTMLElement | ParentNode, schemaCode: SchemaCode) => HTMLElement[];
+
+type ClosestElementBySchemaOptions = {
+    element: Element | HTMLElement;
+    code: SchemaCode;
+    ignoreDeletedElements?: boolean;
+};
+declare const closestElementBySchema: ({ element, code, ignoreDeletedElements, }: ClosestElementBySchemaOptions) => HTMLElement | undefined;
+
+declare const getStore: (element: Element) => string;
+
+declare const isDeletedElement: (element: Element) => boolean;
+
+declare const IGNORED_ATTRIBUTES: string[];
+declare const IGNORED_ATTRIBUTES_STARTS_WITH: string[];
+declare const isIgnoredAttribute: (attribute: string) => boolean;
+
+declare const IGNORED_ELEMENT_SELECTORS: string[];
+declare const isIgnoredElement: (element: Element) => boolean;
+
+type GetAdjacentElementOptions = {
+    element: HTMLElement | Element;
+    direction: "next" | "previous";
+    code: SchemaCode;
+};
+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 };