@adguard/agtree 3.0.0 → 3.1.0

package/dist/cjs/deserializer/rule-deserializer.js

@@ -1,67 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var baseDeserializer = require('./base-deserializer.js');
-var commentRuleDeserializer = require('./comment/comment-rule-deserializer.js');
-var cosmeticRuleDeserializer = require('./cosmetic/cosmetic-rule-deserializer.js');
-var hostRuleDeserializer = require('./network/host-rule-deserializer.js');
-var networkRuleDeserializer = require('./network/network-rule-deserializer.js');
-var emptyRuleDeserializer = require('./empty-rule-deserializer.js');
-var invalidRuleDeserializer = require('./invalid-rule-deserializer.js');
-var binaryTypeCommon = require('../marshalling-utils/misc/binary-type-common.js');
-
-/**
- * `RuleDeserializer` is responsible for deserializing the rules.
- *
- * It automatically determines the category and syntax of the rule, so you can pass any kind of rule to it.
- */
-class RuleDeserializer extends baseDeserializer.BaseDeserializer {
-    /**
-     * Deserializes a rule node from binary format.
-     *
-     * @param buffer ByteBuffer for reading binary data.
-     * @param node Destination node.
-     */
-    static deserialize(buffer, node) {
-        // lookup instead of storing +1 byte
-        const type = buffer.peekUint8();
-        switch (type) {
-            case binaryTypeCommon.BinaryTypeMarshallingMap.AgentRuleNode:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.HintRuleNode:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.PreProcessorCommentRuleNode:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.MetadataCommentRuleNode:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.ConfigCommentRuleNode:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.CommentRuleNode:
-                commentRuleDeserializer.CommentRuleDeserializer.deserialize(buffer, node);
-                break;
-            case binaryTypeCommon.BinaryTypeMarshallingMap.ElementHidingRule:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.CssInjectionRule:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.ScriptletInjectionRule:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.HtmlFilteringRule:
-            case binaryTypeCommon.BinaryTypeMarshallingMap.JsInjectionRule:
-                cosmeticRuleDeserializer.CosmeticRuleDeserializer.deserialize(buffer, node);
-                break;
-            case binaryTypeCommon.BinaryTypeMarshallingMap.NetworkRuleNode:
-                networkRuleDeserializer.NetworkRuleDeserializer.deserialize(buffer, node);
-                break;
-            case binaryTypeCommon.BinaryTypeMarshallingMap.HostRuleNode:
-                hostRuleDeserializer.HostRuleDeserializer.deserialize(buffer, node);
-                break;
-            case binaryTypeCommon.BinaryTypeMarshallingMap.EmptyRule:
-                emptyRuleDeserializer.EmptyRuleDeserializer.deserialize(buffer, node);
-                break;
-            case binaryTypeCommon.BinaryTypeMarshallingMap.InvalidRule:
-                invalidRuleDeserializer.InvalidRuleDeserializer.deserialize(buffer, node);
-                break;
-            default:
-                throw new Error('Unknown rule category');
-        }
-    }
-}
-
-exports.RuleDeserializer = RuleDeserializer;

package/dist/cjs/deserializer/syntax-deserialization-map.js

@@ -1,23 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var syntaxSerializationMap = require('../marshalling-utils/syntax-serialization-map.js');
-
-/**
- * Value map for binary deserialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- */
-let syntaxDeserializationMap;
-const getSyntaxDeserializationMap = () => {
-    if (!syntaxDeserializationMap) {
-        syntaxDeserializationMap = new Map(Array.from(syntaxSerializationMap.getSyntaxSerializationMap(), ([key, value]) => [value, key]));
-    }
-    return syntaxDeserializationMap;
-};
-
-exports.getSyntaxDeserializationMap = getSyntaxDeserializationMap;

package/dist/cjs/errors/adblock-syntax-error.js

@@ -1,41 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-/**
- * @file Customized syntax error class for Adblock Filter Parser.
- */
-const ERROR_NAME = 'AdblockSyntaxError';
-/**
- * Customized syntax error class for Adblock Filter Parser,
- * which contains the location range of the error.
- */
-class AdblockSyntaxError extends SyntaxError {
-    /**
-     * Start offset of the error.
-     */
-    start;
-    /**
-     * End offset of the error.
-     */
-    end;
-    /**
-     * Constructs a new `AdblockSyntaxError` instance.
-     *
-     * @param message Error message.
-     * @param start Start offset of the error.
-     * @param end End offset of the error.
-     */
-    constructor(message, start, end) {
-        super(message);
-        this.name = ERROR_NAME;
-        this.start = start;
-        this.end = end;
-    }
-}
-
-exports.AdblockSyntaxError = AdblockSyntaxError;

package/dist/cjs/errors/binary-schema-mismatch-error.js

@@ -1,39 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-/**
- * @file Customized error for binary schema mismatch.
- */
-const ERROR_NAME = 'BinarySchemaMismatchError';
-/**
- * Customized error for binary schema mismatch.
- */
-class BinarySchemaMismatchError extends Error {
-    /**
-     * Expected schema version.
-     */
-    expectedVersion;
-    /**
-     * Actual schema version.
-     */
-    actualVersion;
-    /**
-     * Constructs a new `BinarySchemaMismatchError` instance.
-     *
-     * @param expectedVersion Expected schema version.
-     * @param actualVersion Actual schema version.
-     */
-    constructor(expectedVersion, actualVersion) {
-        super(`Expected schema version ${expectedVersion}, but got ${actualVersion}`);
-        this.name = ERROR_NAME;
-        this.expectedVersion = expectedVersion;
-        this.actualVersion = actualVersion;
-    }
-}
-
-exports.BinarySchemaMismatchError = BinarySchemaMismatchError;

package/dist/cjs/errors/not-implemented-error.js

@@ -1,33 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-/**
- * @file Customized error class for not implemented features.
- */
-const ERROR_NAME = 'NotImplementedError';
-const BASE_MESSAGE = 'Not implemented';
-/**
- * Customized error class for not implemented features.
- */
-class NotImplementedError extends Error {
-    /**
-     * Constructs a new `NotImplementedError` instance.
-     *
-     * @param message Additional error message (optional)
-     */
-    constructor(message = undefined) {
-        // Prepare the full error message
-        const fullMessage = message
-            ? `${BASE_MESSAGE}: ${message}`
-            : BASE_MESSAGE;
-        super(fullMessage);
-        this.name = ERROR_NAME;
-    }
-}
-
-exports.NotImplementedError = NotImplementedError;

package/dist/cjs/errors/rule-conversion-error.js

@@ -1,28 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-/**
- * @file Customized error class for conversion errors.
- */
-const ERROR_NAME = 'RuleConversionError';
-/**
- * Customized error class for conversion errors.
- */
-class RuleConversionError extends Error {
-    /**
-     * Constructs a new `RuleConversionError` instance.
-     *
-     * @param message Error message
-     */
-    constructor(message) {
-        super(message);
-        this.name = ERROR_NAME;
-    }
-}
-
-exports.RuleConversionError = RuleConversionError;

package/dist/cjs/generator/base-generator.js

@@ -1,29 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var notImplementedError = require('../errors/not-implemented-error.js');
-
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/**
- * @file Base parser class.
- */
-/**
- * Base class for generators. Each generator should extend this class.
- */
-class BaseGenerator {
-    /**
-     * Generates a string from the AST node.
-     *
-     * @param node AST node to generate a string from.
-     */
-    static generate(node) {
-        throw new notImplementedError.NotImplementedError();
-    }
-}
-
-exports.BaseGenerator = BaseGenerator;

package/dist/cjs/generator/comment/agent-comment-generator.js

@@ -1,30 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var constants = require('../../utils/constants.js');
-var baseGenerator = require('../base-generator.js');
-var agentGenerator = require('./agent-generator.js');
-
-class AgentCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts an adblock agent AST to a string.
-     *
-     * @param ast Agent rule AST
-     * @returns Raw string
-     */
-    static generate(ast) {
-        let result = constants.OPEN_SQUARE_BRACKET;
-        result += ast.children
-            .map(agentGenerator.AgentGenerator.generate)
-            .join(constants.SEMICOLON + constants.SPACE);
-        result += constants.CLOSE_SQUARE_BRACKET;
-        return result;
-    }
-}
-
-exports.AgentCommentGenerator = AgentCommentGenerator;

package/dist/cjs/generator/comment/agent-generator.js

@@ -1,34 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var baseGenerator = require('../base-generator.js');
-var constants = require('../../utils/constants.js');
-var typeGuards = require('../../utils/type-guards.js');
-
-class AgentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts an adblock agent node to a string.
-     *
-     * @param value Agent node
-     * @returns Raw string
-     */
-    static generate(value) {
-        let result = constants.EMPTY;
-        // Agent adblock name
-        result += value.adblock.value;
-        // Agent adblock version (if present)
-        if (!typeGuards.isUndefined(value.version)) {
-            // Add a space between the name and the version
-            result += constants.SPACE;
-            result += value.version.value;
-        }
-        return result;
-    }
-}
-
-exports.AgentGenerator = AgentGenerator;

package/dist/cjs/generator/comment/comment-rule-generator.js

@@ -1,102 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var index = require('../../nodes/index.js');
-var baseGenerator = require('../base-generator.js');
-var agentCommentGenerator = require('./agent-comment-generator.js');
-var hintCommentGenerator = require('./hint-comment-generator.js');
-var preProcessorCommentGenerator = require('./pre-processor-comment-generator.js');
-var metadataCommentGenerator = require('./metadata-comment-generator.js');
-var configCommentGenerator = require('./config-comment-generator.js');
-var simpleCommentGenerator = require('./simple-comment-generator.js');
-
-/* eslint-disable no-param-reassign */
-/**
- * `CommentParser` is responsible for parsing any comment-like adblock rules.
- *
- * @example
- * Example rules:
- *  - Adblock agent rules:
- *      - ```adblock
- *        [AdGuard]
- *        ```
- *      - ```adblock
- *        [Adblock Plus 2.0]
- *        ```
- *      - etc.
- *  - AdGuard hint rules:
- *      - ```adblock
- *        !+ NOT_OPTIMIZED
- *        ```
- *      - ```adblock
- *        !+ NOT_OPTIMIZED PLATFORM(windows)
- *        ```
- *      - etc.
- *  - Pre-processor rules:
- *      - ```adblock
- *        !#if (adguard)
- *        ```
- *      - ```adblock
- *        !#endif
- *        ```
- *      - etc.
- *  - Metadata rules:
- *      - ```adblock
- *        ! Title: My List
- *        ```
- *      - ```adblock
- *        ! Version: 2.0.150
- *        ```
- *      - etc.
- *  - AGLint inline config rules:
- *      - ```adblock
- *        ! aglint-enable some-rule
- *        ```
- *      - ```adblock
- *        ! aglint-disable some-rule
- *        ```
- *      - etc.
- *  - Simple comments:
- *      - Regular version:
- *        ```adblock
- *        ! This is just a comment
- *        ```
- *      - uBlock Origin / "hostlist" version:
- *        ```adblock
- *        # This is just a comment
- *        ```
- *      - etc.
- */
-class CommentRuleGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a comment rule node to a string.
-     *
-     * @param node Comment rule node
-     * @returns Raw string
-     */
-    static generate(node) {
-        switch (node.type) {
-            case index.CommentRuleType.AgentCommentRule:
-                return agentCommentGenerator.AgentCommentGenerator.generate(node);
-            case index.CommentRuleType.HintCommentRule:
-                return hintCommentGenerator.HintCommentGenerator.generate(node);
-            case index.CommentRuleType.PreProcessorCommentRule:
-                return preProcessorCommentGenerator.PreProcessorCommentGenerator.generate(node);
-            case index.CommentRuleType.MetadataCommentRule:
-                return metadataCommentGenerator.MetadataCommentGenerator.generate(node);
-            case index.CommentRuleType.ConfigCommentRule:
-                return configCommentGenerator.ConfigCommentGenerator.generate(node);
-            case index.CommentRuleType.CommentRule:
-                return simpleCommentGenerator.SimpleCommentGenerator.generate(node);
-            default:
-                throw new Error('Unknown comment rule type');
-        }
-    }
-}
-
-exports.CommentRuleGenerator = CommentRuleGenerator;

package/dist/cjs/generator/comment/config-comment-generator.js

@@ -1,44 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var baseGenerator = require('../base-generator.js');
-var constants = require('../../utils/constants.js');
-var parameterListGenerator = require('../misc/parameter-list-generator.js');
-
-class ConfigCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts an inline configuration comment node to a string.
-     *
-     * @param node Inline configuration comment node
-     * @returns Raw string
-     */
-    static generate(node) {
-        let result = constants.EMPTY;
-        result += node.marker.value;
-        result += constants.SPACE;
-        result += node.command.value;
-        if (node.params) {
-            result += constants.SPACE;
-            if (node.params.type === 'ParameterList') {
-                result += parameterListGenerator.ParameterListGenerator.generate(node.params, constants.COMMA);
-            }
-            else {
-                // Trim JSON boundaries
-                result += JSON.stringify(node.params.value).slice(1, -1).trim();
-            }
-        }
-        // Add comment within the config comment
-        if (node.comment) {
-            result += constants.SPACE;
-            result += node.comment.value;
-        }
-        return result;
-    }
-}
-
-exports.ConfigCommentGenerator = ConfigCommentGenerator;

package/dist/cjs/generator/comment/hint-comment-generator.js

@@ -1,27 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var baseGenerator = require('../base-generator.js');
-var constants = require('../../utils/constants.js');
-var hintGenerator = require('./hint-generator.js');
-
-class HintCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a hint rule node to a raw string.
-     *
-     * @param node Hint rule node
-     * @returns Raw string
-     */
-    static generate(node) {
-        let result = constants.HINT_MARKER + constants.SPACE;
-        result += node.children.map(hintGenerator.HintGenerator.generate).join(constants.SPACE);
-        return result;
-    }
-}
-
-exports.HintCommentGenerator = HintCommentGenerator;

package/dist/cjs/generator/comment/hint-generator.js

@@ -1,32 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var constants = require('../../utils/constants.js');
-var baseGenerator = require('../base-generator.js');
-var parameterListGenerator = require('../misc/parameter-list-generator.js');
-
-class HintGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a single hint AST to a string.
-     *
-     * @param hint Hint AST
-     * @returns Hint string
-     */
-    static generate(hint) {
-        let result = constants.EMPTY;
-        result += hint.name.value;
-        if (hint.params && hint.params.children.length > 0) {
-            result += constants.OPEN_PARENTHESIS;
-            result += parameterListGenerator.ParameterListGenerator.generate(hint.params, constants.COMMA);
-            result += constants.CLOSE_PARENTHESIS;
-        }
-        return result;
-    }
-}
-
-exports.HintGenerator = HintGenerator;

package/dist/cjs/generator/comment/metadata-comment-generator.js

@@ -1,32 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var constants = require('../../utils/constants.js');
-var valueGenerator = require('../misc/value-generator.js');
-var baseGenerator = require('../base-generator.js');
-
-class MetadataCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a metadata comment rule node to a string.
-     *
-     * @param node Metadata comment rule node.
-     * @returns Raw string.
-     */
-    static generate(node) {
-        let result = constants.EMPTY;
-        result += valueGenerator.ValueGenerator.generate(node.marker);
-        result += constants.SPACE;
-        result += valueGenerator.ValueGenerator.generate(node.header);
-        result += constants.COLON;
-        result += constants.SPACE;
-        result += valueGenerator.ValueGenerator.generate(node.value);
-        return result;
-    }
-}
-
-exports.MetadataCommentGenerator = MetadataCommentGenerator;

package/dist/cjs/generator/comment/pre-processor-comment-generator.js

@@ -1,47 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var constants = require('../../utils/constants.js');
-var baseGenerator = require('../base-generator.js');
-var valueGenerator = require('../misc/value-generator.js');
-var parameterListGenerator = require('../misc/parameter-list-generator.js');
-var logicalExpressionGenerator = require('../misc/logical-expression-generator.js');
-
-class PreProcessorCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a pre-processor comment node to a string.
-     *
-     * @param node Pre-processor comment node
-     * @returns Raw string
-     */
-    static generate(node) {
-        let result = constants.EMPTY;
-        result += constants.PREPROCESSOR_MARKER;
-        result += node.name.value;
-        if (node.params) {
-            // Space is not allowed after "safari_cb_affinity" directive, so we need to handle it separately.
-            if (node.name.value !== constants.SAFARI_CB_AFFINITY) {
-                result += constants.SPACE;
-            }
-            if (node.params.type === 'Value') {
-                result += valueGenerator.ValueGenerator.generate(node.params);
-            }
-            else if (node.params.type === 'ParameterList') {
-                result += constants.OPEN_PARENTHESIS;
-                result += parameterListGenerator.ParameterListGenerator.generate(node.params);
-                result += constants.CLOSE_PARENTHESIS;
-            }
-            else {
-                result += logicalExpressionGenerator.LogicalExpressionGenerator.generate(node.params);
-            }
-        }
-        return result;
-    }
-}
-
-exports.PreProcessorCommentGenerator = PreProcessorCommentGenerator;

package/dist/cjs/generator/comment/simple-comment-generator.js

@@ -1,28 +0,0 @@
-/*
- * AGTree v3.0.0 (build date: Tue, 12 Nov 2024 14:05:06 GMT)
- * (c) 2024 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-'use strict';
-
-var baseGenerator = require('../base-generator.js');
-var constants = require('../../utils/constants.js');
-var valueGenerator = require('../misc/value-generator.js');
-
-class SimpleCommentGenerator extends baseGenerator.BaseGenerator {
-    /**
-     * Converts a comment rule node to a string.
-     *
-     * @param node Comment rule node.
-     * @returns Raw string.
-     */
-    static generate(node) {
-        let result = constants.EMPTY;
-        result += valueGenerator.ValueGenerator.generate(node.marker);
-        result += valueGenerator.ValueGenerator.generate(node.text);
-        return result;
-    }
-}
-
-exports.SimpleCommentGenerator = SimpleCommentGenerator;