html-validate 6.0.0 → 6.1.1

package/dist/es/core.d.ts

@@ -3,6 +3,9 @@ import { SchemaObject as SchemaObject$1 } from 'ajv/dist/types';
 
 /** @internal */
 declare type EventCallback = (event: string, data: any) => void;
+/**
+ * @internal
+ */
 declare class EventHandler {
     listeners: {
         [event: string]: EventCallback[];
@@ -67,6 +70,9 @@ declare type RuleConfig = Record<string, RuleSeverity | [RuleSeverity] | [RuleSe
 interface TransformMap {
     [key: string]: string;
 }
+/**
+ * @public
+ */
 interface ConfigData {
     /**
      * If set to true no new configurations will be searched.
@@ -112,6 +118,8 @@ interface ConfigData {
 
 /**
  * Reported error message.
+ *
+ * @public
  */
 interface Message {
     /** Rule that triggered this message */
@@ -139,6 +147,9 @@ interface Message {
      */
     context?: any;
 }
+/**
+ * @public
+ */
 interface Result {
     messages: Message[];
     filePath: string;
@@ -148,6 +159,8 @@ interface Result {
 }
 /**
  * Report object returned by [[HtmlValidate]].
+ *
+ * @public
  */
 interface Report {
     /** `true` if validation was successful */
@@ -159,6 +172,9 @@ interface Report {
     /** Total warnings of errors across all sources */
     warningCount: number;
 }
+/**
+ * @internal
+ */
 declare class Reporter {
     protected result: {
         [filename: string]: Message[];
@@ -174,6 +190,9 @@ declare class Reporter {
     protected isValid(): boolean;
 }
 
+/**
+ * @public
+ */
 interface RuleDocumentation {
     description: string;
     url?: string;
@@ -186,6 +205,9 @@ interface IncludeExcludeOptions {
     include: string[] | null;
     exclude: string[] | null;
 }
+/**
+ * @public
+ */
 declare abstract class Rule<ContextType = void, OptionsType = void> {
     private reporter;
     private parser;
@@ -341,6 +363,8 @@ interface Event {
 }
 /**
  * Configuration ready event.
+ *
+ * @public
  */
 interface ConfigReadyEvent extends Event {
     config: ResolvedConfig;
@@ -354,12 +378,16 @@ interface ConfigReadyEvent extends Event {
  *
  * The source object must not be modified (use a transformer if modifications
  * are required)
+ *
+ * @public
  */
 interface SourceReadyEvent extends Event {
     source: Source;
 }
 /**
  * Token event.
+ *
+ * @public
  */
 interface TokenEvent extends Event {
     type: TokenType;
@@ -367,6 +395,8 @@ interface TokenEvent extends Event {
 }
 /**
  * Event emitted when starting tags are encountered.
+ *
+ * @public
  */
 interface TagStartEvent extends Event {
     /** Event location. */
@@ -374,10 +404,17 @@ interface TagStartEvent extends Event {
     /** The node being started. */
     target: HtmlElement;
 }
-/** Deprecated alias for TagStartEvent */
+/**
+ * Deprecated alias for TagStartEvent
+ *
+ * @public
+ * @deprecated Use TagStartEvent instead
+ */
 declare type TagOpenEvent = TagStartEvent;
 /**
  * Event emitted when end tags `</..>` are encountered.
+ *
+ * @public
  */
 interface TagEndEvent extends Event {
     /** Event location. */
@@ -388,11 +425,18 @@ interface TagEndEvent extends Event {
     /** The node being closed. */
     previous: HtmlElement;
 }
-/** Deprecated alias for TagEndEvent */
+/**
+ * Deprecated alias for TagEndEvent
+ *
+ * @public
+ * @deprecated Use TagEndEvent instead
+ */
 declare type TagCloseEvent = TagEndEvent;
 /**
  * Event emitted when a tag is ready (i.e. all the attributes has been
  * parsed). The children of the element will not yet be finished.
+ *
+ * @public
  */
 interface TagReadyEvent extends Event {
     /** Event location. */
@@ -402,6 +446,8 @@ interface TagReadyEvent extends Event {
 }
 /**
  * Event emitted when an element is fully constructed (including its children).
+ *
+ * @public
  */
 interface ElementReadyEvent extends Event {
     /** Event location. */
@@ -411,6 +457,8 @@ interface ElementReadyEvent extends Event {
 }
 /**
  * Event emitted when attributes are encountered.
+ *
+ * @public
  */
 interface AttributeEvent extends Event {
     /** Location of the full attribute (key, quotes and value) */
@@ -433,6 +481,8 @@ interface AttributeEvent extends Event {
 }
 /**
  * Event emitted when whitespace content is parsed.
+ *
+ * @public
  */
 interface WhitespaceEvent extends Event {
     /** Event location. */
@@ -443,6 +493,8 @@ interface WhitespaceEvent extends Event {
 /**
  * Event emitted when Internet Explorer conditionals `<![if ...]>` are
  * encountered.
+ *
+ * @public
  */
 interface ConditionalEvent extends Event {
     /** Event location. */
@@ -453,6 +505,8 @@ interface ConditionalEvent extends Event {
 /**
  * Event emitted when html-validate directives `<!-- [html-validate-...] -->`
  * are encountered.
+ *
+ * @public
  */
 interface DirectiveEvent extends Event {
     /** Event location. */
@@ -466,6 +520,8 @@ interface DirectiveEvent extends Event {
 }
 /**
  * Event emitted when doctypes `<!DOCTYPE ..>` are encountered.
+ *
+ * @public
  */
 interface DoctypeEvent extends Event {
     /** Event location. */
@@ -480,18 +536,25 @@ interface DoctypeEvent extends Event {
 /**
  * Event emitted after initialization but before tokenization and parsing occurs.
  * Can be used to initialize state in rules.
+ *
+ * @public
  */
 interface DOMLoadEvent extends Event {
     source: Source;
 }
 /**
  * Event emitted when DOM tree is fully constructed.
+ *
+ * @public
  */
 interface DOMReadyEvent extends Event {
     /** DOM Tree */
     document: DOMTree;
     source: Source;
 }
+/**
+ * @public
+ */
 interface TriggerEventMap {
     "config:ready": ConfigReadyEvent;
     "source:ready": SourceReadyEvent;
@@ -508,6 +571,9 @@ interface TriggerEventMap {
     conditional: ConditionalEvent;
     directive: DirectiveEvent;
 }
+/**
+ * @public
+ */
 interface ListenEventMap {
     "config:ready": ConfigReadyEvent;
     "source:ready": SourceReadyEvent;
@@ -530,6 +596,8 @@ interface ListenEventMap {
 
 /**
  * Parse HTML document into a DOM tree.
+ *
+ * @internal
  */
 declare class Parser {
     private readonly event;
@@ -647,6 +715,8 @@ declare class Parser {
 
 /**
  * Raw attribute data.
+ *
+ * @public
  */
 interface AttributeData {
     /** Attribute name */
@@ -660,11 +730,23 @@ interface AttributeData {
     originalAttribute?: string;
 }
 
+/**
+ * @public
+ */
 declare type ProcessAttributeCallback = (this: unknown, attr: AttributeData) => Iterable<AttributeData>;
+/**
+ * @public
+ */
 interface ProcessElementContext {
     getMetaFor(tagName: string): MetaElement | null;
 }
+/**
+ * @public
+ */
 declare type ProcessElementCallback = (this: ProcessElementContext, node: HtmlElement) => void;
+/**
+ * @public
+ */
 interface SourceHooks {
     /**
      * Called for every attribute.
@@ -689,6 +771,8 @@ interface SourceHooks {
  *
  * Optional hooks can be attached. This is usually added by transformers to
  * postprocess.
+ *
+ * @public
  */
 interface Source {
     data: string;
@@ -733,6 +817,9 @@ interface Source {
     transformedBy?: string[];
 }
 
+/**
+ * @public
+ */
 interface Location {
     /**
      * The filemane this location refers to.
@@ -758,6 +845,9 @@ interface Location {
     readonly size: number;
 }
 
+/**
+ * @public
+ */
 declare class DynamicValue {
     readonly expr: string;
     constructor(expr: string);
@@ -839,6 +929,9 @@ interface DeprecatedElement {
     documentation?: string;
     source?: string;
 }
+/**
+ * @public
+ */
 interface MetaData {
     inherit?: string;
     metadata?: boolean | PropertyExpression;
@@ -874,8 +967,13 @@ declare type MetaLookupableProperty = "metadata" | "flow" | "sectioning" | "head
 /**
  * Properties listed here can be copied (loaded) onto another element using
  * [[HtmlElement.loadMeta]].
+ *
+ * @public
  */
 declare const MetaCopyableProperty: Array<keyof MetaElement>;
+/**
+ * @public
+ */
 interface MetaElement extends Omit<MetaData, "deprecatedAttributes" | "requiredAttributes"> {
     tagName: string;
     attributes: Record<string, MetaAttribute>;
@@ -1014,6 +1112,9 @@ declare class DOMTokenList extends Array<string> {
     }>;
 }
 
+/**
+ * @public
+ */
 declare enum NodeClosed {
     Open = 0,
     EndTag = 1,
@@ -1021,6 +1122,9 @@ declare enum NodeClosed {
     VoidSelfClosed = 3,
     ImplicitClosed = 4
 }
+/**
+ * @public
+ */
 declare class HtmlElement extends DOMNode {
     readonly tagName: string;
     readonly parent: HtmlElement | null;
@@ -1033,7 +1137,13 @@ declare class HtmlElement extends DOMNode {
     private metaElement;
     private annotation;
     constructor(tagName: string | undefined, parent: HtmlElement | null, closed: NodeClosed, meta: MetaElement | null, location: Location);
+    /**
+     * @internal
+     */
     static rootNode(location: Location): HtmlElement;
+    /**
+     * @internal
+     */
     static fromTokens(startToken: Token, endToken: Token, parent: HtmlElement | null, metaTable: MetaTable | null): HtmlElement;
     /**
      * Returns annotated name if set or defaults to `<tagName>`.
@@ -1183,20 +1293,28 @@ declare class HtmlElement extends DOMNode {
     private querySelectorImpl;
     /**
      * Visit all nodes from this node and down. Depth first.
+     *
+     * @internal
      */
     visitDepthFirst(callback: (node: HtmlElement) => void): void;
     /**
      * Evaluates callbackk on all descendants, returning true if any are true.
+     *
+     * @internal
      */
     someChildren(callback: (node: HtmlElement) => boolean): boolean;
     /**
      * Evaluates callbackk on all descendants, returning true if all are true.
+     *
+     * @internal
      */
     everyChildren(callback: (node: HtmlElement) => boolean): boolean;
     /**
      * Visit all nodes from this node and down. Breadth first.
      *
      * The first node for which the callback evaluates to true is returned.
+     *
+     * @internal
      */
     find(callback: (node: HtmlElement) => boolean): HtmlElement | null;
 }
@@ -1225,6 +1343,8 @@ declare class DOMTree {
  *
  * Text nodes are appended as children of `HtmlElement` and cannot have childen
  * of its own.
+ *
+ * @public
  */
 declare class TextNode extends DOMNode {
     private readonly text;
@@ -1248,6 +1368,9 @@ declare class TextNode extends DOMNode {
     get isDynamic(): boolean;
 }
 
+/**
+ * @public
+ */
 interface TransformContext {
     /**
      * Test if an additional chainable transformer is present.
@@ -1277,6 +1400,9 @@ declare module "estree" {
         end: number;
     }
 }
+/**
+ * @public
+ */
 declare class TemplateExtractor {
     private ast;
     private filename;
@@ -1323,12 +1449,18 @@ declare class TemplateExtractor {
     extractObjectProperty(key: string): Source[];
 }
 
+/**
+ * @public
+ */
 declare type Transformer = (this: TransformContext, source: Source) => Iterable<Source>;
 
 interface SchemaValidationPatch {
     properties?: Record<string, unknown>;
     definitions?: Record<string, unknown>;
 }
+/**
+ * @public
+ */
 interface Plugin {
     /**
      * Name of the plugin.
@@ -1406,18 +1538,30 @@ interface Plugin {
     elementSchema?: SchemaValidationPatch | null;
 }
 
+/**
+ * @public
+ */
 declare class MetaTable {
     readonly elements: ElementTable;
     private schema;
+    /**
+     * @internal
+     */
     constructor();
+    /**
+     * @internal
+     */
     init(): void;
     /**
      * Extend validation schema.
+     *
+     * @internal
      */
     extendValidationSchema(patch: SchemaValidationPatch): void;
     /**
      * Load metadata table from object.
      *
+     * @internal
      * @param obj - Object with metadata to load
      * @param filename - Optional filename used when presenting validation error
      */
@@ -1425,21 +1569,27 @@ declare class MetaTable {
     /**
      * Load metadata table from filename
      *
+     * @internal
      * @param filename - Filename to load
      */
     loadFromFile(filename: string): void;
     /**
      * Get [[MetaElement]] for the given tag or null if the element doesn't exist.
      *
+     * @public
      * @returns A shallow copy of metadata.
      */
     getMetaFor(tagName: string): MetaElement | null;
     /**
      * Find all tags which has enabled given property.
+     *
+     * @public
      */
     getTagsWithProperty(propName: MetaLookupableProperty): string[];
     /**
      * Find tag matching tagName or inheriting from it.
+     *
+     * @public
      */
     getTagsDerivedFrom(tagName: string): string[];
     private addEntry;
@@ -1447,6 +1597,9 @@ declare class MetaTable {
      * Construct a new AJV schema validator.
      */
     private getSchemaValidator;
+    /**
+     * @public
+     */
     getJSONSchema(): SchemaObject$1;
     /**
      * Finds the global element definition and merges each known element with the
@@ -1454,9 +1607,15 @@ declare class MetaTable {
      */
     private resolveGlobal;
     private mergeElement;
+    /**
+     * @internal
+     */
     resolve(node: HtmlElement): void;
 }
 
+/**
+ * @public
+ */
 declare enum Severity {
     DISABLED = 0,
     WARN = 1,
@@ -1525,6 +1684,8 @@ interface LoadedPlugin extends Plugin {
  * Configuration holder.
  *
  * Each file being validated will have a unique instance of this class.
+ *
+ * @public
  */
 declare class Config {
     private config;
@@ -1556,18 +1717,25 @@ declare class Config {
      * Validate configuration data.
      *
      * Throws SchemaValidationError if invalid.
+     *
+     * @internal
      */
     static validate(configData: ConfigData, filename?: string | null): void;
     /**
      * Load a default configuration object.
      */
     static defaultConfig(): Config;
+    /**
+     * @internal
+     */
     constructor(options?: ConfigData);
     /**
      * Initialize plugins, transforms etc.
      *
      * Must be called before trying to use config. Can safely be called multiple
      * times.
+     *
+     * @internal
      */
     init(): void;
     /**
@@ -1578,6 +1746,7 @@ declare class Config {
      * Returns a new configuration as a merge of the two. Entries from the passed
      * object takes priority over this object.
      *
+     * @internal
      * @param rhs - Configuration to merge with this one.
      */
     merge(rhs: Config): Config;
@@ -1598,11 +1767,15 @@ declare class Config {
     get(): ConfigData;
     /**
      * Get all configured rules, their severity and options.
+     *
+     * @internal
      */
     getRules(): Map<string, [Severity, RuleOptions]>;
     private static getRulesObject;
     /**
      * Get all configured plugins.
+     *
+     * @internal
      */
     getPlugins(): Plugin[];
     private loadPlugins;
@@ -1613,6 +1786,8 @@ declare class Config {
      *
      * A resolved configuration will merge all extended configs and load all
      * plugins and transformers, and normalize the rest of the configuration.
+     *
+     * @internal
      */
     resolve(): ResolvedConfig;
     /**
@@ -1709,9 +1884,15 @@ declare class NestedError extends Error {
     constructor(message: string, nested?: Error);
 }
 
+/**
+ * @public
+ */
 declare class UserError extends NestedError {
 }
 
+/**
+ * @public
+ */
 declare class SchemaValidationError extends UserError {
     filename: string | null;
     private obj;
@@ -1722,15 +1903,27 @@ declare class SchemaValidationError extends UserError {
     private getRawJSON;
 }
 
+/**
+ * @public
+ */
 declare class ConfigError extends UserError {
 }
 
+/**
+ * @internal
+ */
 declare const presets: Record<string, ConfigData>;
 
+/**
+ * @internal
+ */
 interface EventDump {
     event: string;
     data: any;
 }
+/**
+ * @internal
+ */
 interface TokenDump {
     token: string;
     data: string;
@@ -1741,6 +1934,8 @@ interface TokenDump {
  * Primary API for using HTML-validate.
  *
  * Provides high-level abstractions for common operations.
+ *
+ * @public
  */
 declare class HtmlValidate {
     protected configLoader: ConfigLoader;
@@ -1879,6 +2074,7 @@ declare class HtmlValidate {
     /**
      * Create a parser configured for given filename.
      *
+     * @internal
      * @param source - Source to use.
      */
     getParserFor(source: Source): Parser;
@@ -1909,6 +2105,8 @@ declare class HtmlValidate {
  *
  * In practice this means no configuration is fetch by traversing the
  * filesystem.
+ *
+ * @public
  */
 declare class StaticConfigLoader extends ConfigLoader {
     getConfigFor(handle: string, configOverride?: ConfigData): Config;
@@ -1916,6 +2114,12 @@ declare class StaticConfigLoader extends ConfigLoader {
     protected defaultConfig(): Config;
 }
 
+/** @public */
+declare const version: string;
+
+/**
+ * @public
+ */
 interface CompatibilityOptions {
     /** If `true` nothing no output will be generated on console. Default: `false` */
     silent: boolean;
@@ -1928,6 +2132,7 @@ interface CompatibilityOptions {
  * Tests if plugin is compatible with html-validate library. Unless the `silent`
  * option is used a warning is displayed on the console.
  *
+ * @public
  * @param name - Name of plugin
  * @param declared - What library versions the plugin support (e.g. declared peerDependencies)
  * @returns - `true` if version is compatible
@@ -1941,6 +2146,7 @@ declare function compatibilityCheck(name: string, declared: string, options?: Pa
  * Can be used to create forward/backward compatibility by checking if a rule
  * exists to enable/disable it.
  *
+ * @public
  * @param ruleId - Rule id to check
  * @returns `true` if rule exists
  */
@@ -1970,6 +2176,8 @@ declare function ruleExists(ruleId: string): boolean;
  * 2. If set in the global config the override is merged into global and
  * returned. No configuration files are searched.
  * 3. Setting `root` in configuration file only stops directory traversal.
+ *
+ * @public
  */
 declare class FileSystemConfigLoader extends ConfigLoader {
     protected cache: Map<string, Config | null>;
@@ -2001,14 +2209,18 @@ declare class FileSystemConfigLoader extends ConfigLoader {
     protected defaultConfig(): Config;
 }
 
+/**
+ * @public
+ */
 declare type Formatter = (results: Result[]) => string;
 
 /**
  * Get formatter function by name.
  *
+ * @internal
  * @param name - Name of formatter.
  * @returns Formatter function or null if it doesn't exist.
  */
 declare function getFormatter(name: string): Formatter | null;
 
-export { DOMLoadEvent as $, AttributeData as A, ConfigReadyEvent as B, Config as C, DynamicValue as D, EventDump as E, SourceReadyEvent as F, TokenEvent as G, HtmlValidate as H, TagStartEvent as I, TagOpenEvent as J, TagEndEvent as K, Location as L, MetaData as M, NodeClosed as N, TagCloseEvent as O, ProcessElementContext as P, TagReadyEvent as Q, Rule as R, Severity as S, TextNode as T, UserError as U, ElementReadyEvent as V, AttributeEvent as W, WhitespaceEvent as X, ConditionalEvent as Y, DirectiveEvent as Z, DoctypeEvent as _, ConfigData as a, DOMReadyEvent as a0, TriggerEventMap as a1, ListenEventMap as a2, FileSystemConfigLoader as a3, Formatter as a4, getFormatter as a5, compatibilityCheck as a6, CompatibilityOptions as a7, TokenType as a8, ConfigError as b, ConfigLoader as c, StaticConfigLoader as d, HtmlElement as e, TokenDump as f, SchemaValidationError as g, MetaElement as h, MetaTable as i, MetaCopyableProperty as j, RuleDocumentation as k, Source as l, Report as m, Reporter as n, Message as o, presets as p, Result as q, TransformContext as r, Transformer as s, TemplateExtractor as t, Plugin as u, Parser as v, ruleExists as w, EventHandler as x, EventCallback as y, Event as z };
+export { DoctypeEvent as $, AttributeData as A, Event as B, Config as C, DynamicValue as D, EventDump as E, ConfigReadyEvent as F, SourceReadyEvent as G, HtmlValidate as H, TokenEvent as I, TagStartEvent as J, TagOpenEvent as K, Location as L, MetaData as M, NodeClosed as N, TagEndEvent as O, ProcessElementContext as P, TagCloseEvent as Q, Rule as R, Severity as S, TextNode as T, UserError as U, TagReadyEvent as V, ElementReadyEvent as W, AttributeEvent as X, WhitespaceEvent as Y, ConditionalEvent as Z, DirectiveEvent as _, ConfigData as a, DOMLoadEvent as a0, DOMReadyEvent as a1, TriggerEventMap as a2, ListenEventMap as a3, FileSystemConfigLoader as a4, Formatter as a5, getFormatter as a6, compatibilityCheck as a7, CompatibilityOptions as a8, TokenType as a9, ConfigError as b, ConfigLoader as c, StaticConfigLoader as d, HtmlElement as e, TokenDump as f, SchemaValidationError as g, MetaElement as h, MetaTable as i, MetaCopyableProperty as j, RuleDocumentation as k, Source as l, Report as m, Reporter as n, Message as o, presets as p, Result as q, TransformContext as r, Transformer as s, TemplateExtractor as t, Plugin as u, version as v, Parser as w, ruleExists as x, EventHandler as y, EventCallback as z };