DefinitelyTyped/types/css-tree/index.d.ts

// Type definitions for css-tree 1.0
// Project: https://github.com/csstree/csstree
// Definitions by: Erik Källén <https://github.com/erik-kallen>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.7

export interface CssLocation {
    source: string;
    start: {
        offset: number;
        line: number;
        column: number
    };
    end: {
        offset: number;
        line: number;
        column: number
    };
}

export interface ListItem<TData> {
    prev: ListItem<TData> | null;
    next: ListItem<TData> | null;
    data: TData;
}

export type IteratorFn<TData, TResult, TContext = List<TData>> = (this: TContext, item: TData, node: ListItem<TData>, list: List<TData>) => TResult;
export type FilterFn<TData, TResult extends TData, TContext = List<TData>> = (this: TContext, item: TData, node: ListItem<TData>, list: List<TData>) => item is TResult;

export class List<TData> {
    constructor();
    fromArray(array: TData[]): List<TData>;
    createItem(data: TData): ListItem<TData>;
    toArray(): TData[];
    toJSON(): TData[];
    getSize(): number;
    isEmpty(): boolean;
    first(): TData | null;
    last(): TData | null;
    each<TContext>(fn: IteratorFn<TData, void, TContext>, context: TContext): void;
    each(fn: IteratorFn<TData, void>): void;
    forEach<TContext>(fn: IteratorFn<TData, void, TContext>, context: TContext): void;
    forEach(fn: IteratorFn<TData, void>): void;
    eachRight<TContext>(fn: IteratorFn<TData, void, TContext>, context: TContext): void;
    eachRight(fn: IteratorFn<TData, void>): void;
    forEachRight<TContext>(fn: IteratorFn<TData, void, TContext>, context: TContext): void;
    forEachRight(fn: IteratorFn<TData, void>): void;
    nextUntil<TContext>(start: ListItem<TData>, fn: IteratorFn<TData, boolean, TContext>, context: TContext): void;
    nextUntil(start: ListItem<TData>, fn: IteratorFn<TData, boolean>): void;
    prevUntil<TContext>(start: ListItem<TData>, fn: IteratorFn<TData, boolean, TContext>, context: TContext): void;
    prevUntil(start: ListItem<TData>, fn: IteratorFn<TData, boolean>): void;
    some<TContext>(fn: IteratorFn<TData, boolean, TContext>, context: TContext): void;
    some(fn: IteratorFn<TData, boolean>): void;
    map<TContext, TResult>(fn: IteratorFn<TData, TResult, TContext>, context: TContext): List<TResult>;
    map<TResult>(fn: IteratorFn<TData, TResult>): List<TResult>;
    filter<TContext, TResult extends TData>(fn: FilterFn<TData, TResult, TContext>, context: TContext): List<TResult>;
    filter<TResult extends TData>(fn: FilterFn<TData, TResult>): List<TResult>;
    filter<TContext>(fn: IteratorFn<TData, boolean, TContext>, context: TContext): List<TData>;
    filter(fn: IteratorFn<TData, boolean>): List<TData>;
    clear(): void;
    copy(): List<TData>;
    prepend(item: ListItem<TData>): List<TData>;
    prependData(data: TData): List<TData>;
    append(item: ListItem<TData>): List<TData>;
    appendData(data: TData): List<TData>;
    insert(item: ListItem<TData>, before: ListItem<TData>): List<TData>;
    insertData(data: TData, before: ListItem<TData>): List<TData>;
    remove(item: ListItem<TData>): ListItem<TData>;
    push(item: TData): void;
    pop(): ListItem<TData> | undefined;
    unshift(data: TData): void;
    shift(): ListItem<TData> | undefined;
    prependList(list: List<TData>): List<TData>;
    appendList(list: List<TData>): List<TData>;
    insertList(list: List<TData>, before: ListItem<TData>): List<TData>;
    replace(oldItem: ListItem<TData>, newItemOrList: List<TData> | ListItem<TData>): List<TData>;
}

export interface CssNodeCommon {
    type: string;
    loc?: CssLocation;
}

export interface AnPlusB extends CssNodeCommon {
    type: 'AnPlusB';
    a: string | null;
    b: string | null;
}

export interface Atrule extends CssNodeCommon {
    type: 'Atrule';
    name: string;
    prelude: AtrulePrelude | Raw | null;
    block: Block | null;
}

export interface AtrulePlain extends CssNodeCommon {
    type: 'Atrule';
    name: string;
    prelude: AtrulePreludePlain | Raw | null;
    block: BlockPlain | null;
}

export interface AtrulePrelude extends CssNodeCommon {
    type: 'AtrulePrelude';
    children: List<CssNode>;
}

export interface AtrulePreludePlain extends CssNodeCommon {
    type: 'AtrulePrelude';
    children: CssNodePlain[];
}

export interface AttributeSelector extends CssNodeCommon {
    type: 'AttributeSelector';
    name: Identifier;
    matcher: string | null;
    value: StringNode | Identifier | null;
    flags: string | null;
}

export interface Block extends CssNodeCommon {
    type: 'Block';
    children: List<CssNode>;
}

export interface BlockPlain extends CssNodeCommon {
    type: 'Block';
    children: CssNodePlain[];
}

export interface Brackets extends CssNodeCommon {
    type: 'Brackets';
    children: List<CssNode>;
}

export interface BracketsPlain extends CssNodeCommon {
    type: 'Brackets';
    children: CssNodePlain[];
}

export interface CDC extends CssNodeCommon {
    type: 'CDC';
}

export interface CDO extends CssNodeCommon {
    type: 'CDO';
}

export interface ClassSelector extends CssNodeCommon {
    type: 'ClassSelector';
    name: string;
}

export interface Combinator extends CssNodeCommon {
    type: 'Combinator';
    name: string;
}

export interface Comment extends CssNodeCommon {
    type: 'Comment';
    value: string;
}

export interface Declaration extends CssNodeCommon {
    type: 'Declaration';
    important: boolean | string;
    property: string;
    value: Value | Raw;
}

export interface DeclarationPlain extends CssNodeCommon {
    type: 'Declaration';
    important: boolean | string;
    property: string;
    value: ValuePlain | Raw;
}

export interface DeclarationList extends CssNodeCommon {
    type: 'DeclarationList';
    children: List<CssNode>;
}

export interface DeclarationListPlain extends CssNodeCommon {
    type: 'DeclarationList';
    children: CssNodePlain[];
}

export interface Dimension extends CssNodeCommon {
    type: 'Dimension';
    value: string;
    unit: string;
}

export interface FunctionNode extends CssNodeCommon {
    type: 'Function';
    name: string;
    children: List<CssNode>;
}

export interface FunctionNodePlain extends CssNodeCommon {
    type: 'Function';
    name: string;
    children: CssNodePlain[];
}

export interface HexColor extends CssNodeCommon {
    type: 'HexColor';
    value: string;
}

export interface IdSelector extends CssNodeCommon {
    type: 'IdSelector';
    name: string;
}

export interface Identifier extends CssNodeCommon {
    type: 'Identifier';
    name: string;
}

export interface MediaFeature extends CssNodeCommon {
    type: 'MediaFeature';
    name: string;
    value: Identifier | NumberNode | Dimension | Ratio | null;
}

export interface MediaQuery extends CssNodeCommon {
    type: 'MediaQuery';
    children: List<CssNode>;
}

export interface MediaQueryPlain extends CssNodeCommon {
    type: 'MediaQuery';
    children: CssNodePlain[];
}

export interface MediaQueryList extends CssNodeCommon {
    type: 'MediaQueryList';
    children: List<CssNode>;
}

export interface MediaQueryListPlain extends CssNodeCommon {
    type: 'MediaQueryList';
    children: CssNodePlain[];
}

export interface Nth extends CssNodeCommon {
    type: 'Nth';
    nth: AnPlusB | Identifier;
    selector: SelectorList | null;
}

export interface NthPlain extends CssNodeCommon {
    type: 'Nth';
    nth: AnPlusB | Identifier;
    selector: SelectorListPlain | null;
}

export interface NumberNode extends CssNodeCommon {
    type: 'Number';
    value: string;
}

export interface Operator extends CssNodeCommon {
    type: 'Operator';
    value: string;
}

export interface Parentheses extends CssNodeCommon {
    type: 'Parentheses';
    children: List<CssNode>;
}

export interface ParenthesesPlain extends CssNodeCommon {
    type: 'Parentheses';
    children: CssNodePlain[];
}

export interface Percentage extends CssNodeCommon {
    type: 'Percentage';
    value: string;
}

export interface PseudoClassSelector extends CssNodeCommon {
    type: 'PseudoClassSelector';
    name: string;
    children: List<CssNode> | null;
}

export interface PseudoClassSelectorPlain extends CssNodeCommon {
    type: 'PseudoClassSelector';
    name: string;
    children: CssNodePlain[] | null;
}

export interface PseudoElementSelector extends CssNodeCommon {
    type: 'PseudoElementSelector';
    name: string;
    children: List<CssNode> | null;
}

export interface PseudoElementSelectorPlain extends CssNodeCommon {
    type: 'PseudoElementSelector';
    name: string;
    children: CssNodePlain[] | null;
}

export interface Ratio extends CssNodeCommon {
    type: 'Ratio';
    left: string;
    right: string;
}

export interface Raw extends CssNodeCommon {
    type: 'Raw';
    value: string;
}

export interface Rule extends CssNodeCommon {
    type: 'Rule';
    prelude: SelectorList | Raw;
    block: Block;
}

export interface RulePlain extends CssNodeCommon {
    type: 'Rule';
    prelude: SelectorListPlain | Raw;
    block: BlockPlain;
}

export interface Selector extends CssNodeCommon {
    type: 'Selector';
    children: List<CssNode>;
}

export interface SelectorPlain extends CssNodeCommon {
    type: 'Selector';
    children: CssNodePlain[];
}

export interface SelectorList extends CssNodeCommon {
    type: 'SelectorList';
    children: List<CssNode>;
}

export interface SelectorListPlain extends CssNodeCommon {
    type: 'SelectorList';
    children: CssNodePlain[];
}

export interface StringNode extends CssNodeCommon {
    type: 'String';
    value: string;
}

export interface StyleSheet extends CssNodeCommon {
    type: 'StyleSheet';
    children: List<CssNode>;
}

export interface StyleSheetPlain extends CssNodeCommon {
    type: 'StyleSheet';
    children: CssNodePlain[];
}

export interface TypeSelector extends CssNodeCommon {
    type: 'TypeSelector';
    name: string;
}

export interface UnicodeRange extends CssNodeCommon {
    type: 'UnicodeRange';
    value: string;
}

export interface Url extends CssNodeCommon {
    type: 'Url';
    value: StringNode | Raw;
}

export interface Value extends CssNodeCommon {
    type: 'Value';
    children: List<CssNode>;
}

export interface ValuePlain extends CssNodeCommon {
    type: 'Value';
    children: CssNodePlain[];
}

export interface WhiteSpace extends CssNodeCommon {
    type: 'WhiteSpace';
    value: string;
}

export type CssNode =
    AnPlusB
    | Atrule
    | AtrulePrelude
    | AttributeSelector
    | Block
    | Brackets
    | CDC
    | CDO
    | ClassSelector
    | Combinator
    | Comment
    | Declaration
    | DeclarationList
    | Dimension
    | FunctionNode
    | HexColor
    | IdSelector
    | Identifier
    | MediaFeature
    | MediaQuery
    | MediaQueryList
    | Nth
    | NumberNode
    | Operator
    | Parentheses
    | Percentage
    | PseudoClassSelector
    | PseudoElementSelector
    | Ratio
    | Raw
    | Rule
    | Selector
    | SelectorList
    | StringNode
    | StyleSheet
    | TypeSelector
    | UnicodeRange
    | Url
    | Value
    | WhiteSpace;

export type CssNodePlain =
    AnPlusB
    | AtrulePlain
    | AtrulePreludePlain
    | AttributeSelector
    | BlockPlain
    | BracketsPlain
    | CDC
    | CDO
    | ClassSelector
    | Combinator
    | Comment
    | DeclarationPlain
    | DeclarationListPlain
    | Dimension
    | FunctionNodePlain
    | HexColor
    | IdSelector
    | Identifier
    | MediaFeature
    | MediaQueryPlain
    | MediaQueryListPlain
    | NthPlain
    | NumberNode
    | Operator
    | ParenthesesPlain
    | Percentage
    | PseudoClassSelectorPlain
    | PseudoElementSelectorPlain
    | Ratio
    | Raw
    | RulePlain
    | SelectorPlain
    | SelectorListPlain
    | StringNode
    | StyleSheetPlain
    | TypeSelector
    | UnicodeRange
    | Url
    | ValuePlain
    | WhiteSpace;

export interface SyntaxParseError extends SyntaxError {
    input: string;
    offset: number;
    rawMessage: string;
}

export interface ParseOptions {
    context?: string;
    atrule?: string;
    positions?: boolean;
    onParseError?: (error: SyntaxParseError, fallbackNode: CssNode) => void;
    filename?: string;
    offset?: number;
    line?: number;
    column?: number;
    parseAtrulePrelude?: boolean;
    parseRulePrelude?: boolean;
    parseValue?: boolean;
    parseCustomProperty?: boolean;
}

export function parse(text: string, options?: ParseOptions): CssNode;

export interface GenerateHandlers {
    children: (node: CssNode, delimiter?: (node: CssNode) => void) => void;
    node: (node: CssNode) => void;
    chunk: (chunk: string) => void;
    result: () => string;
}

export interface GenerateOptions {
    sourceMap?: boolean;
    decorator?: (handlers: GenerateHandlers) => GenerateHandlers;
}

export function generate(ast: CssNode, options?: GenerateOptions): string;

export interface WalkContext {
    root: CssNode;
    stylesheet: StyleSheet | null;
    atrule: Atrule | null;
    atrulePrelude: AtrulePrelude | null;
    rule: Rule | null;
    selector: SelectorList | null;
    block: Block | null;
    declaration: Declaration | null;
    function: FunctionNode | PseudoClassSelector | PseudoElementSelector | null;
}

export type EnterOrLeaveFn = (this: WalkContext, node: CssNode, item: ListItem<CssNode>, list: List<CssNode>) => void;

export interface WalkOptions {
    enter?: EnterOrLeaveFn;
    leave?: EnterOrLeaveFn;
    visit?: string;
    reverse?: boolean;
}

export function walk(ast: CssNode, options: EnterOrLeaveFn | WalkOptions): void;

export interface Property {
    readonly basename: string;
    readonly name: string;
    readonly hack: string;
    readonly vendor: string;
    readonly prefix: string;
    readonly custom: boolean;
}

export function property(value: string): Property;

export interface Keyword {
    readonly basename: string;
    readonly name: string;
    readonly vendor: string;
    readonly prefix: string;
    readonly custom: boolean;
}

export function keyword(value: string): Keyword;

export function clone(node: CssNode): CssNode;

export function fromPlainObject(node: CssNodePlain): CssNode;
export function toPlainObject(node: CssNode): CssNodePlain;