@xml-tools/validation/api.d.ts

XML validation APIs

import {
  XMLAstNode,
  XMLAttribute,
  XMLElement,
  XMLDocument,
} from "@xml-tools/ast";

declare type AttributeValidator = (node: XMLAttribute) => ValidationIssue[];
declare type ElementValidator = (node: XMLElement) => ValidationIssue[];
declare function validate(options: {
  doc: XMLDocument;
  validators: {
    attribute?: AttributeValidator[];
    element?: ElementValidator[];
  };
}): ValidationIssue[];

interface ValidationIssue {
  msg: string;
  /**
   * ASTNode where the issue occurred.
   */
  node: XMLAstNode;
  /**
   * The Severity is optional as that may need to be determined outside
   * the validation logic, For example in an IDE's inspections configuration.
   */
  severity?: "info" | "warning" | "error";

  /**
   * Optional property to indicate a more specific error location.
   * For example: For Missing Attribute error in an element we may want to
   * only mark the Element **Name** area instead of the whole element.
   */
  position?: { startOffset: number; endOffset: number };
}