@adguard/agtree 3.0.0-alpha.1 → 3.0.0-alpha.2

package/dist/cjs/parser/css/balancing.js

@@ -1,97 +0,0 @@
-/*
- * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var cssTokenizer = require('@adguard/css-tokenizer');
-var sprintfJs = require('sprintf-js');
-var adblockSyntaxError = require('../../errors/adblock-syntax-error.js');
-var constants = require('./constants.js');
-
-/**
- * @file Tokenizer helpers for balanced pairs.
- */
-/**
- * Map of opening tokens to their corresponding closing tokens.
- */
-const standardTokenPairs = new Map([
-    [cssTokenizer.TokenType.Function, cssTokenizer.TokenType.CloseParenthesis],
-    [cssTokenizer.TokenType.OpenParenthesis, cssTokenizer.TokenType.CloseParenthesis],
-    [cssTokenizer.TokenType.OpenSquareBracket, cssTokenizer.TokenType.CloseSquareBracket],
-    [cssTokenizer.TokenType.OpenCurlyBracket, cssTokenizer.TokenType.CloseCurlyBracket],
-]);
-/**
- * Map of opening tokens to their corresponding closing tokens just for function calls. This makes possible a more
- * lightweight and tolerant check for balanced pairs in some cases.
- */
-const functionTokenPairs = new Map([
-    [cssTokenizer.TokenType.Function, cssTokenizer.TokenType.CloseParenthesis],
-    [cssTokenizer.TokenType.OpenParenthesis, cssTokenizer.TokenType.CloseParenthesis],
-]);
-/**
- * Helper function to tokenize and ensure balanced pairs.
- *
- * @param raw Raw CSS string to tokenize
- * @param onToken Callback which will be invoked for each token, extended with a `balance` parameter
- * @param onError Error callback which is called when a parsing error is found (optional)
- * @param functionHandlers Custom function handlers (optional)
- * @param tokenPairs Map of opening tokens to their corresponding closing tokens
- * @throws If the input is not balanced
- * @todo Consider adding a `tolerant` flag if error throwing seems too aggressive in the future
- */
-const tokenizeWithBalancedPairs = (raw, onToken, onError = () => { }, functionHandlers, tokenPairs = standardTokenPairs) => {
-    const stack = [];
-    const values = new Set(tokenPairs.values());
-    cssTokenizer.tokenizeExtended(raw, (type, start, end, props) => {
-        if (tokenPairs.has(type)) {
-            // If the token is an opening token, push its corresponding closing token to the stack.
-            // It is safe to use non-null assertion here, because we have checked that the token exists in the map.
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            stack.push(tokenPairs.get(type));
-        }
-        else if (values.has(type)) {
-            // If the token is a closing token, check if it matches the last opening token, and if so, pop it.
-            if (stack[stack.length - 1] === type) {
-                stack.pop();
-            }
-            else {
-                throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants.ERROR_MESSAGES.EXPECTED_TOKEN_BUT_GOT, cssTokenizer.getFormattedTokenName(stack[stack.length - 1]), cssTokenizer.getFormattedTokenName(type)), start, raw.length);
-            }
-        }
-        onToken(type, start, end, props, stack.length);
-    }, onError, functionHandlers);
-    // If the stack is not empty, then there are some opening tokens that were not closed.
-    if (stack.length > 0) {
-        throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants.ERROR_MESSAGES.EXPECTED_TOKEN_BUT_GOT, cssTokenizer.getFormattedTokenName(stack[stack.length - 1]), constants.END_OF_INPUT), raw.length - 1, raw.length);
-    }
-};
-/**
- * Tokenize and ensure balanced pairs for standard CSS.
- *
- * @param raw Raw CSS string to tokenize
- * @param onToken Callback which will be invoked for each token, extended with a `balance` parameter
- * @param onError Error callback which is called when a parsing error is found (optional)
- * @param functionHandlers Custom function handlers (optional)
- * @throws If the input is not balanced
- */
-const tokenizeBalanced = (raw, onToken, onError = () => { }, functionHandlers) => {
-    tokenizeWithBalancedPairs(raw, onToken, onError, functionHandlers);
-};
-/**
- * Tokenize and ensure balanced pairs for function calls.
- *
- * @param raw Raw CSS string to tokenize
- * @param onToken Callback which will be invoked for each token, extended with a `balance` parameter
- * @param onError Error callback which is called when a parsing error is found (optional)
- * @param functionHandlers Custom function handlers (optional)
- * @throws If the input is not balanced
- */
-const tokenizeFnBalanced = (raw, onToken, onError = () => { }, functionHandlers) => {
-    tokenizeWithBalancedPairs(raw, onToken, onError, functionHandlers, functionTokenPairs);
-};
-
-exports.tokenizeBalanced = tokenizeBalanced;
-exports.tokenizeFnBalanced = tokenizeFnBalanced;

package/dist/cjs/parser/css/constants.js

@@ -1,21 +0,0 @@
-/*
- * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-/**
- * @file Error messages for CSS token stream and balancer.
- */
-const END_OF_INPUT = 'end of input';
-const ERROR_MESSAGES = {
-    EXPECTED_ANY_TOKEN_BUT_GOT: "Expected a token, but got '%s'",
-    EXPECTED_TOKEN_BUT_GOT: "Expected '%s', but got '%s'",
-    EXPECTED_TOKEN_WITH_BALANCE_BUT_GOT: "Expected '%s' with balance '%d', but got '%d'",
-    EXPECTED_TOKEN_WITH_VALUE_BUT_GOT: "Expected '%s' with value '%s', but got '%s'",
-};
-
-exports.END_OF_INPUT = END_OF_INPUT;
-exports.ERROR_MESSAGES = ERROR_MESSAGES;

package/dist/cjs/parser/css/css-token-stream.js

@@ -1,345 +0,0 @@
-/*
- * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var cssTokenizer = require('@adguard/css-tokenizer');
-var sprintfJs = require('sprintf-js');
-var balancing = require('./balancing.js');
-var constants = require('../../utils/constants.js');
-var adblockSyntaxError = require('../../errors/adblock-syntax-error.js');
-var constants$1 = require('./constants.js');
-var css = require('../../converter/data/css.js');
-
-/**
- * @file CSS token stream.
- */
-/**
- * Represents a stream of CSS tokens.
- */
-class CssTokenStream {
-    /**
-     * The tokens in the stream.
-     */
-    tokens = [];
-    /**
-     * The source string.
-     */
-    source = constants.EMPTY;
-    /**
-     * The current index in the stream.
-     */
-    index = 0;
-    /**
-     * The base offset of the source string.
-     */
-    baseOffset;
-    /**
-     * Initializes a new instance of the TokenStream class.
-     *
-     * @param source The source string to tokenize.
-     * @param baseOffset The base offset of the source string.
-     */
-    constructor(source, baseOffset = 0) {
-        this.source = source;
-        // Tokenize the source string with the CSS tokenizer and add balance level to each token.
-        // 'onToken' callback is invoked when a token is found in the source string.
-        // Passed parameters:
-        // - type: type of the token
-        // - start: start index of the token
-        // - end: end index of the token
-        // - props: additional properties of the token, if any (we don't use it here, this is why we use underscore)
-        // - balance: balance level of the token
-        balancing.tokenizeBalanced(source, (type, start, end, _, balance) => {
-            this.tokens.push({
-                type,
-                start,
-                end,
-                balance,
-            });
-        });
-        this.index = 0;
-        this.baseOffset = baseOffset;
-    }
-    /**
-     * Gets the number of tokens in the stream.
-     *
-     * @returns The number of tokens in the stream.
-     */
-    get length() {
-        return this.tokens.length;
-    }
-    /**
-     * Checks if the end of the token stream is reached.
-     *
-     * @returns True if the end of the stream is reached, otherwise false.
-     */
-    isEof() {
-        return this.index >= this.tokens.length;
-    }
-    /**
-     * Gets the token at the specified index.
-     *
-     * @param index The index of the token to retrieve.
-     * @returns The token at the specified index or undefined if the index is out of bounds.
-     */
-    get(index = this.index) {
-        return this.tokens[index];
-    }
-    /**
-     * Gets the token at the specified index or throws if no token is found at the specified index.
-     *
-     * @param index The index of the token to retrieve.
-     * @returns The token at the specified index or undefined if the index is out of bounds.
-     * @throws If no token is found at the specified index.
-     */
-    getOrFail(index = this.index) {
-        const token = this.get(index);
-        if (!token) {
-            throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants$1.ERROR_MESSAGES.EXPECTED_ANY_TOKEN_BUT_GOT, constants$1.END_OF_INPUT), this.baseOffset + this.source.length - 1, this.baseOffset + this.source.length);
-        }
-        return token;
-    }
-    /**
-     * Gets the source fragment of the token at the specified index.
-     *
-     * @param index The index of the token to retrieve the fragment for.
-     * @returns The source fragment of the token or an empty string if the index is out of bounds.
-     */
-    fragment(index = this.index) {
-        const token = this.get(index);
-        if (token) {
-            return this.source.slice(token.start, token.end);
-        }
-        return constants.EMPTY;
-    }
-    /**
-     * Moves the index to the next token and returns it.
-     *
-     * @returns The next token or undefined if the end of the stream is reached.
-     */
-    advance() {
-        if (this.isEof()) {
-            return undefined;
-        }
-        this.index += 1;
-        return this.tokens[this.index];
-    }
-    /**
-     * Looks ahead in the stream without changing the index.
-     *
-     * @param index The relative index to look ahead to, starting from the current index.
-     * @returns The next token or undefined if the end of the stream is reached.
-     */
-    lookahead(index = 1) {
-        return this.tokens[this.index + Math.max(1, index)];
-    }
-    /**
-     * Looks behind in the stream without changing the index.
-     *
-     * @param index The relative index to look behind to, starting from the current index.
-     * @returns The previous token or undefined if the current token is the first in the stream.
-     */
-    lookbehind(index = 1) {
-        if (this.index === 0) {
-            return undefined;
-        }
-        return this.tokens[this.index - Math.max(1, index)];
-    }
-    /**
-     * Looks behind in the stream for the previous non-whitespace token without changing the index.
-     *
-     * @returns The previous non-whitespace token or undefined if it could not be found.
-     */
-    lookbehindForNonWs() {
-        for (let i = this.index - 1; i >= 0; i -= 1) {
-            if (this.tokens[i].type !== cssTokenizer.TokenType.Whitespace) {
-                return this.tokens[i];
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Skips whitespace tokens in the stream.
-     */
-    skipWhitespace() {
-        while (this.get()?.type === cssTokenizer.TokenType.Whitespace) {
-            this.index += 1;
-        }
-    }
-    /**
-     * Skips tokens until the current balance level is reached.
-     *
-     * @returns The number of tokens skipped.
-     */
-    skipUntilBalanced() {
-        if (this.isEof()) {
-            return 0;
-        }
-        // It is safe to use ! here, because we check for EOF above
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const currentBalance = this.get().balance;
-        // If the current balance is 0, do nothing
-        if (currentBalance === 0) {
-            return 0;
-        }
-        // Otherwise, skip tokens until the balance is the current balance - 1
-        let skipped = 0;
-        while (!this.isEof() && this.get()?.balance !== currentBalance - 1) {
-            this.index += 1;
-            skipped += 1;
-        }
-        return skipped;
-    }
-    /**
-     * Skips tokens until a token with the specified type or the end of the stream is reached.
-     *
-     * @param type The type of token to skip until.
-     * @param balance The balance level of the token to skip until.
-     * @returns The number of tokens skipped.
-     */
-    skipUntil(type, balance) {
-        let skipped = 0;
-        while (!this.isEof()
-            && (this.get()?.type !== type || (balance !== undefined && this.get()?.balance !== balance))) {
-            this.index += 1;
-            skipped += 1;
-        }
-        return skipped;
-    }
-    /**
-     * Skips tokens until a token with the specified type or the end of the stream is reached. This is an extended
-     * version of skipUntil that also returns the number of tokens skipped without calculating leading and trailing
-     * whitespace tokens.
-     *
-     * @param type The type of token to skip until.
-     * @param balance The balance level of the token to skip until.
-     * @returns An array containing the number of tokens skipped and the number of tokens skipped without leading and
-     * trailing whitespace tokens.
-     */
-    skipUntilExt(type, balance) {
-        let i = this.index;
-        let firstNonWsToken = -1; // -1 means no non-whitespace token found yet
-        let lastNonWsToken = -1; // -1 means no non-whitespace token found yet
-        while (i < this.tokens.length) {
-            const currentToken = this.tokens[i];
-            if (currentToken.type === cssTokenizer.TokenType.Whitespace) {
-                i += 1;
-                continue;
-            }
-            else if (currentToken.type === type && currentToken.balance === balance) {
-                break;
-            }
-            if (firstNonWsToken === -1) {
-                firstNonWsToken = i;
-            }
-            lastNonWsToken = i;
-            i += 1;
-        }
-        const skipped = i - this.index;
-        this.index = i;
-        return {
-            skipped,
-            // if firstNonWsToken is -1, then lastNonWsToken is also -1
-            skippedTrimmed: firstNonWsToken === -1 ? 0 : lastNonWsToken - firstNonWsToken + 1,
-        };
-    }
-    /**
-     * Expects that the end of the stream is not reached.
-     */
-    expectNotEof() {
-        if (this.isEof()) {
-            throw new adblockSyntaxError.AdblockSyntaxError('Unexpected end of input', this.baseOffset + this.source.length - 1, this.baseOffset + this.source.length);
-        }
-    }
-    /**
-     * Expects the current token to have a specific type and optional value and balance level.
-     *
-     * @param type The expected token type.
-     * @param data Optional expectation data.
-     * @throws If the end of the stream is reached or if the token type or expectation data does not match.
-     */
-    expect(type, data) {
-        const token = this.get();
-        if (!token) {
-            throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants$1.ERROR_MESSAGES.EXPECTED_TOKEN_BUT_GOT, cssTokenizer.getFormattedTokenName(type), constants$1.END_OF_INPUT), this.baseOffset + this.source.length - 1, this.baseOffset + this.source.length);
-        }
-        if (token.type !== type) {
-            throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants$1.ERROR_MESSAGES.EXPECTED_TOKEN_BUT_GOT, cssTokenizer.getFormattedTokenName(type), cssTokenizer.getFormattedTokenName(token.type)), this.baseOffset + token.start, this.baseOffset + token.end);
-        }
-        if (data?.balance !== undefined && token.balance !== data.balance) {
-            throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants$1.ERROR_MESSAGES.EXPECTED_TOKEN_WITH_BALANCE_BUT_GOT, cssTokenizer.getFormattedTokenName(type), data.balance, token.balance), this.baseOffset + token.start, this.baseOffset + token.end);
-        }
-        if (data?.value && this.fragment() !== data.value) {
-            throw new adblockSyntaxError.AdblockSyntaxError(sprintfJs.sprintf(constants$1.ERROR_MESSAGES.EXPECTED_TOKEN_WITH_VALUE_BUT_GOT, cssTokenizer.getFormattedTokenName(type), data.value, this.fragment()), this.baseOffset + token.start, this.baseOffset + token.end);
-        }
-    }
-    /**
-     * Gets the balance level of the token at the specified index.
-     *
-     * @param index The index of the token to retrieve the balance level for.
-     * @returns The balance level of the token or 0 if the index is out of bounds.
-     */
-    getBalance(index = this.index) {
-        return this.tokens[index]?.balance || 0;
-    }
-    /**
-     * Checks whether the token stream contains any Extended CSS elements, such as `:contains()`, etc.
-     *
-     * @returns `true` if the stream contains any Extended CSS elements, otherwise `false`.
-     */
-    hasAnySelectorExtendedCssNode() {
-        return this.hasAnySelectorExtendedCssNodeInternal(css.EXT_CSS_PSEUDO_CLASSES);
-    }
-    /**
-     * Strictly checks whether the token stream contains any Extended CSS elements, such as `:contains()`.
-     * Some Extended CSS elements are natively supported by browsers, like `:has()`.
-     * This method is used to check for Extended CSS elements that are not natively supported by browsers,
-     * this is why it called "strict", because it strictly checks for Extended CSS elements.
-     *
-     * @returns `true` if the stream contains any Extended CSS elements, otherwise `false`.
-     */
-    hasAnySelectorExtendedCssNodeStrict() {
-        return this.hasAnySelectorExtendedCssNodeInternal(css.EXT_CSS_PSEUDO_CLASSES_STRICT);
-    }
-    /**
-     * Checks whether the token stream contains any Extended CSS elements, such as `:has()`, `:contains()`, etc.
-     *
-     * @param pseudos Set of pseudo-classes to check for.
-     *
-     * @returns `true` if the stream contains any Extended CSS elements, otherwise `false`.
-     */
-    hasAnySelectorExtendedCssNodeInternal(pseudos) {
-        for (let i = 0; i < this.tokens.length; i += 1) {
-            const token = this.tokens[i];
-            if (token.type === cssTokenizer.TokenType.Function) {
-                const name = this.source.slice(token.start, token.end - 1); // omit the last parenthesis
-                if (pseudos.has(name)) {
-                    return true;
-                }
-            }
-            else if (token.type === cssTokenizer.TokenType.OpenSquareBracket) {
-                let j = i + 1;
-                // skip whitespace
-                while (j < this.tokens.length && this.tokens[j].type === cssTokenizer.TokenType.Whitespace) {
-                    j += 1;
-                }
-                if (j < this.tokens.length && this.tokens[j].type === cssTokenizer.TokenType.Ident) {
-                    const attr = this.source.slice(this.tokens[j].start, this.tokens[j].end);
-                    // [-ext-<name>=...] or [-abp-<name>=...]
-                    if (attr.startsWith(css.LEGACY_EXT_CSS_ATTRIBUTE_PREFIX) || attr.startsWith(css.ABP_EXT_CSS_PREFIX)) {
-                        return true;
-                    }
-                }
-                // do not check these tokens again
-                i = j;
-            }
-        }
-        return false;
-    }
-}
-
-exports.CssTokenStream = CssTokenStream;