html-validate 7.15.0 → 7.15.1

package/dist/types/test-utils.d.ts

@@ -1,782 +1,5 @@
-import { SchemaObject } from 'ajv';
-
-/**
- * DOM Attribute.
- *
- * Represents a HTML attribute. Can contain either a fixed static value or a
- * placeholder for dynamic values (e.g. interpolated).
- *
- * @public
- */
-export declare class Attribute {
-    /** Attribute name */
-    readonly key: string;
-    readonly value: string | DynamicValue | null;
-    readonly keyLocation: Location_2;
-    readonly valueLocation: Location_2 | null;
-    readonly originalAttribute?: string;
-    /**
-     * @param key - Attribute name.
-     * @param value - Attribute value. Set to `null` for boolean attributes.
-     * @param keyLocation - Source location of attribute name.
-     * @param valueLocation - Source location of attribute value.
-     * @param originalAttribute - If this attribute was dynamically added via a
-     * transformation (e.g. vuejs `:id` generating the `id` attribute) this
-     * parameter should be set to the attribute name of the source attribute (`:id`).
-     */
-    constructor(key: string, value: null | string | DynamicValue | null, keyLocation: Location_2, valueLocation: Location_2 | null, originalAttribute?: string);
-    /**
-     * Flag set to true if the attribute value is static.
-     */
-    get isStatic(): boolean;
-    /**
-     * Flag set to true if the attribute value is dynamic.
-     */
-    get isDynamic(): boolean;
-    /**
-     * Test attribute value.
-     *
-     * @param pattern - Pattern to match value against. Can be a RegExp, literal
-     * string or an array of strings (returns true if any value matches the
-     * array).
-     * @param dynamicMatches - If true `DynamicValue` will always match, if false
-     * it never matches.
-     * @returns `true` if attribute value matches pattern.
-     */
-    valueMatches(pattern: RegExp, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string[], dynamicMatches?: boolean): boolean;
-}
-
-/**
- * Raw attribute data.
- *
- * @public
- */
-export declare interface AttributeData {
-    /** Attribute name */
-    key: string;
-    /** Attribute value */
-    value: string | DynamicValue | null;
-    /** Quotation mark (if present) */
-    quote: '"' | "'" | null;
-    /** Original attribute name (when a dynamic attribute is used), e.g
-     * "ng-attr-foo" or "v-bind:foo" */
-    originalAttribute?: string;
-}
-
-/* Excluded from this release type: BaseToken */
-
-/**
- * @public
- */
-export declare type CategoryOrTag = string;
-
-/**
- * @public
- */
-declare interface CSSStyleDeclaration_2 {
-    [key: string]: string;
-}
-export { CSSStyleDeclaration_2 as CSSStyleDeclaration }
-
-/**
- * @public
- */
-export declare interface DeprecatedElement {
-    message?: string;
-    documentation?: string;
-    source?: string;
-}
-
-/**
- * @public
- */
-export declare type DOMInternalID = number;
-
-/**
- * @public
- */
-export declare class DOMNode {
-    readonly nodeName: string;
-    readonly nodeType: NodeType;
-    readonly childNodes: DOMNode[];
-    readonly location: Location_2;
-    /* Excluded from this release type: unique */
-    private cache;
-    /**
-     * Set of disabled rules for this node.
-     *
-     * Rules disabled by using directives are added here.
-     */
-    private disabledRules;
-    /**
-     * Set of blocked rules for this node.
-     *
-     * Rules blocked by using directives are added here.
-     */
-    private blockedRules;
-    /**
-     * Create a new DOMNode.
-     *
-     * @param nodeType - What node type to create.
-     * @param nodeName - What node name to use. For `HtmlElement` this corresponds
-     * to the tagName but other node types have specific predefined values.
-     * @param location - Source code location of this node.
-     */
-    constructor(nodeType: NodeType, nodeName: string | undefined, location: Location_2);
-    /* Excluded from this release type: cacheEnable */
-    /**
-     * Fetch cached value from this DOM node.
-     *
-     * Cache is not enabled until `cacheEnable()` is called by [[Parser]] (when
-     * the element is fully constructed).
-     *
-     * @returns value or `undefined` if the value doesn't exist.
-     */
-    cacheGet<K extends keyof DOMNodeCache>(key: K): DOMNodeCache[K] | undefined;
-    cacheGet(key: string | number | symbol): any | undefined;
-    /**
-     * Store a value in cache.
-     *
-     * @returns the value itself is returned.
-     */
-    cacheSet<K extends keyof DOMNodeCache>(key: K, value: DOMNodeCache[K]): DOMNodeCache[K];
-    cacheSet<T>(key: string | number | symbol, value: T): T;
-    /**
-     * Remove a value by key from cache.
-     *
-     * @returns `true` if the entry existed and has been removed.
-     */
-    cacheRemove<K extends keyof DOMNodeCache>(key: K): boolean;
-    cacheRemove(key: string | number | symbol): boolean;
-    /**
-     * Check if key exists in cache.
-     */
-    cacheExists<K extends keyof DOMNodeCache>(key: K): boolean;
-    cacheExists(key: string | number | symbol): boolean;
-    /**
-     * Get the text (recursive) from all child nodes.
-     */
-    get textContent(): string;
-    append(node: DOMNode): void;
-    isRootElement(): boolean;
-    /**
-     * Tests if two nodes are the same (references the same object).
-     */
-    isSameNode(otherNode: DOMNode): boolean;
-    /**
-     * Returns a DOMNode representing the first direct child node or `null` if the
-     * node has no children.
-     */
-    get firstChild(): DOMNode;
-    /**
-     * Returns a DOMNode representing the last direct child node or `null` if the
-     * node has no children.
-     */
-    get lastChild(): DOMNode;
-    /* Excluded from this release type: blockRule */
-    /* Excluded from this release type: blockRules */
-    /* Excluded from this release type: disableRule */
-    /* Excluded from this release type: disableRules */
-    /**
-     * Enable a previously disabled rule for this node.
-     */
-    enableRule(ruleId: string): void;
-    /**
-     * Enables multiple rules.
-     */
-    enableRules(rules: string[]): void;
-    /* Excluded from this release type: ruleEnabled */
-    /* Excluded from this release type: ruleBlockers */
-    generateSelector(): string | null;
-}
-
-/**
- * @public
- */
-export declare interface DOMNodeCache {
-}
-
-/**
- * @public
- */
-declare class DOMTokenList_2 extends Array<string> {
-    readonly value: string;
-    private readonly locations;
-    constructor(value: string | DynamicValue | null, location: Location_2 | null);
-    item(n: number): string | undefined;
-    location(n: number): Location_2 | undefined;
-    contains(token: string): boolean;
-    iterator(): Generator<{
-        index: number;
-        item: string;
-        location: Location_2;
-    }>;
-}
-export { DOMTokenList_2 as DOMTokenList }
-
-/**
- * @public
- */
-export declare class DynamicValue {
-    readonly expr: string;
-    constructor(expr: string);
-    toString(): string;
-}
-
-/**
- * @public
- */
-export declare interface ElementTable {
-    [tagName: string]: MetaElement;
-}
-
-/**
- * @public
- */
-export declare interface FormAssociated {
-    /** Listed elements have a name attribute and is listed in the form and fieldset elements property. */
-    listed: boolean;
-}
-
-/**
- * @public
- */
-export declare class HtmlElement extends DOMNode {
-    readonly tagName: string;
-    readonly parent: HtmlElement | null;
-    readonly voidElement: boolean;
-    readonly depth: number;
-    closed: NodeClosed;
-    protected readonly attr: {
-        [key: string]: Attribute[];
-    };
-    private metaElement;
-    private annotation;
-    constructor(tagName: string | undefined, parent: HtmlElement | null, closed: NodeClosed, meta: MetaElement | null, location: Location_2);
-    /* Excluded from this release type: rootNode */
-    /* Excluded from this release type: fromTokens */
-    /**
-     * Returns annotated name if set or defaults to `<tagName>`.
-     *
-     * E.g. `my-annotation` or `<div>`.
-     */
-    get annotatedName(): string;
-    /**
-     * Get list of IDs referenced by `aria-labelledby`.
-     *
-     * If the attribute is unset or empty this getter returns null.
-     * If the attribute is dynamic the original {@link DynamicValue} is returned.
-     *
-     * @public
-     */
-    get ariaLabelledby(): string[] | DynamicValue | null;
-    /**
-     * Similar to childNodes but only elements.
-     */
-    get childElements(): HtmlElement[];
-    /**
-     * Find the first ancestor matching a selector.
-     *
-     * Implementation of DOM specification of Element.closest(selectors).
-     */
-    closest(selectors: string): HtmlElement | null;
-    /**
-     * Generate a DOM selector for this element. The returned selector will be
-     * unique inside the current document.
-     */
-    generateSelector(): string | null;
-    /**
-     * Tests if this element has given tagname.
-     *
-     * If passing "*" this test will pass if any tagname is set.
-     */
-    is(tagName: string): boolean;
-    /**
-     * Load new element metadata onto this element.
-     *
-     * Do note that semantics such as `void` cannot be changed (as the element has
-     * already been created). In addition the element will still "be" the same
-     * element, i.e. even if loading meta for a `<p>` tag upon a `<div>` tag it
-     * will still be a `<div>` as far as the rest of the validator is concerned.
-     *
-     * In fact only certain properties will be copied onto the element:
-     *
-     * - content categories (flow, phrasing, etc)
-     * - required attributes
-     * - attribute allowed values
-     * - permitted/required elements
-     *
-     * Properties *not* loaded:
-     *
-     * - inherit
-     * - deprecated
-     * - foreign
-     * - void
-     * - implicitClosed
-     * - scriptSupporting
-     * - deprecatedAttributes
-     *
-     * Changes to element metadata will only be visible after `element:ready` (and
-     * the subsequent `dom:ready` event).
-     */
-    loadMeta(meta: MetaElement): void;
-    /**
-     * Match this element against given selectors. Returns true if any selector
-     * matches.
-     *
-     * Implementation of DOM specification of Element.matches(selectors).
-     */
-    matches(selector: string): boolean;
-    get meta(): MetaElement | null;
-    /**
-     * Set annotation for this element.
-     */
-    setAnnotation(text: string): void;
-    /**
-     * Set attribute. Stores all attributes set even with the same name.
-     *
-     * @param key - Attribute name
-     * @param value - Attribute value. Use `null` if no value is present.
-     * @param keyLocation - Location of the attribute name.
-     * @param valueLocation - Location of the attribute value (excluding quotation)
-     * @param originalAttribute - If attribute is an alias for another attribute
-     * (dynamic attributes) set this to the original attribute name.
-     */
-    setAttribute(key: string, value: string | DynamicValue | null, keyLocation: Location_2, valueLocation: Location_2 | null, originalAttribute?: string): void;
-    /**
-     * Get a list of all attributes on this node.
-     */
-    get attributes(): Attribute[];
-    hasAttribute(key: string): boolean;
-    /**
-     * Get attribute.
-     *
-     * By default only the first attribute is returned but if the code needs to
-     * handle duplicate attributes the `all` parameter can be set to get all
-     * attributes with given key.
-     *
-     * This usually only happens when code contains duplicate attributes (which
-     * `no-dup-attr` will complain about) or when a static attribute is combined
-     * with a dynamic, consider:
-     *
-     * <p class="foo" dynamic-class="bar">
-     *
-     * @param key - Attribute name
-     * @param all - Return single or all attributes.
-     */
-    getAttribute(key: string): Attribute | null;
-    getAttribute(key: string, all: true): Attribute[];
-    /**
-     * Get attribute value.
-     *
-     * Returns the attribute value if present.
-     *
-     * - Missing attributes return `null`.
-     * - Boolean attributes return `null`.
-     * - `DynamicValue` returns attribute expression.
-     *
-     * @param key - Attribute name
-     * @returns Attribute value or null.
-     */
-    getAttributeValue(key: string): string | null;
-    /**
-     * Add text as a child node to this element.
-     *
-     * @param text - Text to add.
-     * @param location - Source code location of this text.
-     */
-    appendText(text: string | DynamicValue, location: Location_2): void;
-    /**
-     * Return a list of all known classes on the element. Dynamic values are
-     * ignored.
-     */
-    get classList(): DOMTokenList_2;
-    /**
-     * Get element ID if present.
-     */
-    get id(): string | null;
-    get style(): CSSStyleDeclaration_2;
-    /**
-     * Returns the first child element or null if there are no child elements.
-     */
-    get firstElementChild(): HtmlElement | null;
-    /**
-     * Returns the last child element or null if there are no child elements.
-     */
-    get lastElementChild(): HtmlElement | null;
-    get siblings(): HtmlElement[];
-    get previousSibling(): HtmlElement | null;
-    get nextSibling(): HtmlElement | null;
-    getElementsByTagName(tagName: string): HtmlElement[];
-    querySelector(selector: string): HtmlElement | null;
-    querySelectorAll(selector: string): HtmlElement[];
-    private querySelectorImpl;
-    /* Excluded from this release type: visitDepthFirst */
-    /* Excluded from this release type: someChildren */
-    /* Excluded from this release type: everyChildren */
-    /* Excluded from this release type: find */
-}
-
-/**
- * @public
- */
-declare interface Location_2 {
-    /**
-     * The filemane this location refers to.
-     */
-    readonly filename: string;
-    /**
-     * The string offset (number of characters into the string) this location
-     * refers to.
-     */
-    readonly offset: number;
-    /**
-     * The line number in the file.
-     */
-    readonly line: number;
-    /**
-     * The column number in the file. Tabs counts as 1 (not expanded).
-     */
-    readonly column: number;
-    /**
-     * The number of characters this location refers to. This includes any
-     * whitespace characters such as newlines.
-     */
-    readonly size: number;
-}
-export { Location_2 as Location }
-
-/**
- * @public
- */
-export declare interface MetaAttribute {
-    allowed?: MetaAttributeAllowedCallback;
-    boolean?: boolean;
-    deprecated?: boolean | string;
-    enum?: Array<string | RegExp>;
-    list?: boolean;
-    omit?: boolean;
-    required?: boolean;
-}
-
-/**
- * Callback for the `allowed` property of `MetaAttribute`. It takes a node and
- * should return `null` if there is no errors and a string with an error
- * description if there is an error.
- *
- * @public
- * @param node - The node the attribute belongs to.
- * @param attr - The current attribute being validated.
- */
-export declare type MetaAttributeAllowedCallback = (node: HtmlElement, attr: Attribute) => string | null | undefined;
-
-/**
- * @public
- */
-export declare interface MetaData {
-    inherit?: string;
-    metadata?: boolean | PropertyExpression;
-    flow?: boolean | PropertyExpression;
-    sectioning?: boolean | PropertyExpression;
-    heading?: boolean | PropertyExpression;
-    phrasing?: boolean | PropertyExpression;
-    embedded?: boolean | PropertyExpression;
-    interactive?: boolean | PropertyExpression;
-    deprecated?: boolean | string | DeprecatedElement;
-    foreign?: boolean;
-    void?: boolean;
-    transparent?: boolean | string[];
-    implicitClosed?: string[];
-    scriptSupporting?: boolean;
-    form?: boolean;
-    /** Mark element as a form-associated element */
-    formAssociated?: Partial<FormAssociated>;
-    labelable?: boolean | PropertyExpression;
-    deprecatedAttributes?: string[];
-    requiredAttributes?: string[];
-    attributes?: PermittedAttribute;
-    permittedContent?: Permitted;
-    permittedDescendants?: Permitted;
-    permittedOrder?: PermittedOrder;
-    permittedParent?: Permitted;
-    requiredAncestors?: RequiredAncestors;
-    requiredContent?: RequiredContent;
-    textContent?: TextContent | `${TextContent}`;
-}
-
-/**
- * @public
- */
-export declare interface MetaElement extends Omit<MetaData, "deprecatedAttributes" | "requiredAttributes"> {
-    tagName: string;
-    formAssociated?: FormAssociated;
-    attributes: Record<string, MetaAttribute>;
-    textContent?: TextContent;
-}
-
-/**
- * Properties listed here can be used to reverse search elements with the given
- * property enabled. See [[MetaTable.getTagsWithProperty]].
- *
- * @public
- */
-export declare type MetaLookupableProperty = "metadata" | "flow" | "sectioning" | "heading" | "phrasing" | "embedded" | "interactive" | "deprecated" | "foreign" | "void" | "transparent" | "scriptSupporting" | "form" | "formAssociated" | "labelable";
-
-/**
- * @public
- */
-export declare class MetaTable {
-    readonly elements: ElementTable;
-    private schema;
-    /* Excluded from this release type: __constructor */
-    /* Excluded from this release type: init */
-    /* Excluded from this release type: extendValidationSchema */
-    /* Excluded from this release type: loadFromObject */
-    /* Excluded from this release type: loadFromFile */
-    /**
-     * Get [[MetaElement]] for the given tag. If no specific metadata is present
-     * the global metadata is returned or null if no global is present.
-     *
-     * @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;
-    /**
-     * Construct a new AJV schema validator.
-     */
-    private getSchemaValidator;
-    /**
-     * @public
-     */
-    getJSONSchema(): SchemaObject;
-    /**
-     * Finds the global element definition and merges each known element with the
-     * global, e.g. to assign global attributes.
-     */
-    private resolveGlobal;
-    private mergeElement;
-    /* Excluded from this release type: resolve */
-}
-
-/**
- * @public
- */
-export declare enum NodeClosed {
-    Open = 0,
-    EndTag = 1,
-    VoidOmitted = 2,
-    VoidSelfClosed = 3,
-    ImplicitClosed = 4
-}
-
-/**
- * @public
- */
-export declare enum NodeType {
-    ELEMENT_NODE = 1,
-    TEXT_NODE = 3,
-    DOCUMENT_NODE = 9
-}
-
-/**
- * @public
- */
-export declare type Permitted = PermittedEntry[];
-
-/**
- * @public
- */
-export declare type PermittedAttribute = Record<string, MetaAttribute | Array<string | RegExp> | null>;
-
-/**
- * @public
- */
-export declare type PermittedEntry = CategoryOrTag | PermittedGroup | Array<CategoryOrTag | PermittedGroup>;
-
-/**
- * @public
- */
-export declare interface PermittedGroup {
-    exclude?: string | string[];
-}
-
-/**
- * @public
- */
-export declare type PermittedOrder = string[];
-
-/**
- * @public
- */
-export declare type ProcessAttributeCallback = (this: unknown, attr: AttributeData) => Iterable<AttributeData>;
-
-/**
- * @public
- */
-export declare type ProcessElementCallback = (this: ProcessElementContext, node: HtmlElement) => void;
-
-/**
- * @public
- */
-export declare interface ProcessElementContext {
-    getMetaFor(this: void, tagName: string): MetaElement | null;
-}
-
-/**
- * @public
- */
-export declare type PropertyExpression = string | [string, any];
-
-/**
- * @public
- */
-export declare type RequiredAncestors = string[];
-
-/**
- * @public
- */
-export declare type RequiredContent = string[];
-
-/* Excluded from this release type: RuleBlocker */
-
-/**
- * @public
- */
-export declare interface SchemaValidationPatch {
-    properties?: Record<string, unknown>;
-    definitions?: Record<string, unknown>;
-}
-
-/**
- * Source interface.
- *
- * HTML source with file, line and column context.
- *
- * Optional hooks can be attached. This is usually added by transformers to
- * postprocess.
- *
- * @public
- */
-export declare interface Source {
-    data: string;
-    filename: string;
-    /**
-     * Line in the original data.
-     *
-     * Starts at 1 (first line).
-     */
-    line: number;
-    /**
-     * Column in the original data.
-     *
-     * Starts at 1 (first column).
-     */
-    column: number;
-    /**
-     * Offset in the original data.
-     *
-     * Starts at 0 (first character).
-     */
-    offset: number;
-    /**
-     * Original data. When a transformer extracts a portion of the original source
-     * this must be set to the full original source.
-     *
-     * Since the transformer might be chained always test if the input source
-     * itself has `originalData` set, e.g.:
-     *
-     * `originalData = input.originalData || input.data`.
-     */
-    originalData?: string;
-    /**
-     * Hooks for processing the source as it is being parsed.
-     */
-    hooks?: SourceHooks;
-    /**
-     * Internal property to keep track of what transformers has run on this
-     * source. Entries are in reverse-order, e.g. the last applied transform is
-     * first.
-     */
-    transformedBy?: string[];
-}
-
-/**
- * @public
- */
-export declare interface SourceHooks {
-    /**
-     * Called for every attribute.
-     *
-     * The original attribute must be yielded as well or no attribute will be
-     * added.
-     *
-     * @returns Attribute data for an attribute to be added to the element.
-     */
-    processAttribute?: ProcessAttributeCallback | null;
-    /**
-     * Called for every element after element is created but before any children.
-     *
-     * May modify the element.
-     */
-    processElement?: ProcessElementCallback | null;
-}
-
-/* Excluded from this release type: TagCloseToken */
-
-/* Excluded from this release type: TagOpenToken */
-
-/**
- * @public
- */
-export declare enum TextContent {
-    NONE = "none",
-    DEFAULT = "default",
-    REQUIRED = "required",
-    ACCESSIBLE = "accessible"
-}
-
-/* Excluded from this release type: TokenType */
-
-/**
- * @public
- */
-export declare interface TransformContext {
-    /**
-     * Test if an additional chainable transformer is present.
-     *
-     * Returns true only if there is a transformer configured for the given
-     * filename.
-     *
-     * @param filename - Filename to use to match next transformer.
-     */
-    hasChain(filename: string): boolean;
-    /**
-     * Chain transformations.
-     *
-     * Sometimes multiple transformers must be applied. For instance, a Markdown
-     * file with JSX in a code-block.
-     *
-     * @param source - Source to chain transformations on.
-     * @param filename - Filename to use to match next transformer (unrelated to
-     * filename set in source)
-     */
-    chain(source: Source, filename: string): Iterable<Source>;
-}
+import { Source } from 'html-validate';
+import { TransformContext } from 'html-validate';
 
 /**
  * @public