@adguard/agtree 3.4.1 → 4.0.0

package/dist/marshalling-utils/misc/modifier-common.js

@@ -1,231 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-/**
- * Property map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent a property.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const ModifierNodeMarshallingMap = {
-    Name: 1,
-    Value: 2,
-    Exception: 3,
-    Start: 4,
-    End: 5,
-};
-/**
- * Value map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const FREQUENT_MODIFIERS_SERIALIZATION_MAP = new Map([
-    ['_', 0],
-    ['all', 1],
-    ['app', 2],
-    ['badfilter', 3],
-    ['cname', 4],
-    ['content', 5],
-    ['cookie', 6],
-    ['csp', 7],
-    ['denyallow', 8],
-    ['document', 9],
-    ['doc', 10],
-    ['domain', 11],
-    ['from', 12],
-    ['elemhide', 13],
-    ['ehide', 14],
-    ['empty', 15],
-    ['first-party', 16],
-    ['1p', 17],
-    ['extension', 18],
-    ['font', 19],
-    ['genericblock', 20],
-    ['generichide', 21],
-    ['ghide', 22],
-    ['header', 23],
-    ['hls', 24],
-    ['image', 25],
-    ['important', 26],
-    ['inline-font', 27],
-    ['inline-script', 28],
-    ['jsinject', 29],
-    ['jsonprune', 30],
-    ['match-case', 31],
-    ['media', 32],
-    ['method', 33],
-    ['mp4', 34],
-    ['network', 35],
-    ['object-subrequest', 36],
-    ['object', 37],
-    ['other', 38],
-    ['permissions', 39],
-    ['ping', 40],
-    ['popunder', 41],
-    ['popup', 42],
-    ['redirect-rule', 43],
-    ['redirect', 44],
-    ['rewrite', 45],
-    ['referrerpolicy', 46],
-    ['removeheader', 47],
-    ['removeparam', 48],
-    ['replace', 49],
-    ['script', 50],
-    ['specifichide', 51],
-    ['shide', 52],
-    ['stealth', 53],
-    ['strict1p', 54],
-    ['strict3p', 55],
-    ['stylesheet', 56],
-    ['css', 57],
-    ['subdocument', 58],
-    ['frame', 59],
-    ['third-party', 60],
-    ['3p', 61],
-    ['to', 62],
-    ['urlblock', 63],
-    ['webrtc', 64],
-    ['websocket', 65],
-    ['xmlhttprequest', 66],
-    ['xhr', 67],
-    // TODO: add new modifiers here
-]);
-/**
- * Value map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- *
- * ! IMPORTANT: If you change values here, please update the binary schema version
- *
- * @note Only 256 values can be represented this way.
- */
-const FREQUENT_REDIRECT_VALUES_SERIALIZATION_MAP = new Map([
-    // AdGuard
-    ['1x1-transparent.gif', 0],
-    ['2x2-transparent.png', 1],
-    ['3x2-transparent.png', 2],
-    ['32x32-transparent.png', 3],
-    ['amazon-apstag', 4],
-    ['ati-smarttag', 5],
-    ['didomi-loader', 6],
-    ['click2load.html', 7],
-    ['fingerprintjs2', 8],
-    ['fingerprintjs3', 9],
-    ['google-analytics', 10],
-    ['google-analytics-ga', 11],
-    ['googlesyndication-adsbygoogle', 12],
-    ['googlesyndication-adsbygoogle', 13],
-    ['googletagmanager-gtm', 14],
-    ['googletagmanager-gtm', 15],
-    ['googletagservices-gpt', 16],
-    ['google-ima3', 17],
-    ['gemius', 18],
-    ['matomo', 19],
-    ['metrika-yandex-watch', 20],
-    ['metrika-yandex-tag', 21],
-    ['naver-wcslog', 22],
-    ['noeval', 23],
-    ['noopcss', 24],
-    ['noopframe', 25],
-    ['noopjs', 26],
-    ['noopjson', 27],
-    ['nooptext', 28],
-    ['noopmp3-0.1s', 29],
-    ['noopmp4-1s', 30],
-    ['noopvmap-1.0', 31],
-    ['noopvast-2.0', 32],
-    ['noopvast-3.0', 33],
-    ['noopvast-4.0', 34],
-    ['prebid', 35],
-    ['pardot-1.0', 36],
-    ['prevent-bab', 37],
-    ['prevent-bab2', 38],
-    ['prevent-fab-3.2.0', 39],
-    ['prevent-fab-3.2.0', 40],
-    ['prevent-popads-net', 41],
-    ['scorecardresearch-beacon', 42],
-    ['set-popads-dummy', 43],
-    ['empty', 44],
-    ['prebid-ads', 45],
-    // empty slots for future use
-    // uBlock Origin
-    ['1x1.gif', 60],
-    ['2x2.png', 61],
-    ['3x2.png', 62],
-    ['32x32.png', 63],
-    ['amazon_apstag.js', 64],
-    ['click2load.html', 65],
-    ['fingerprint2.js', 66],
-    ['fingerprint3.js', 67],
-    ['google-analytics_analytics.js', 68],
-    ['google-analytics_ga.js', 69],
-    ['googlesyndication_adsbygoogle.js', 70],
-    ['googlesyndication.com/adsbygoogle.js', 71],
-    ['google-analytics_ga.js', 72],
-    ['googletagmanager_gtm.js', 73],
-    ['googletagservices_gpt.js', 74],
-    ['google-ima.js', 75],
-    ['noeval-silent.js', 76],
-    ['noop.css', 77],
-    ['noop.html', 78],
-    ['noop.js', 79],
-    ['noop.json', 80],
-    ['noop.txt', 81],
-    ['noop-0.1s.mp3', 82],
-    ['noop-1s.mp4', 83],
-    ['noop-vmap1.0.xml', 84],
-    ['nobab.js', 85],
-    ['nobab2.js', 86],
-    ['nofab.js', 87],
-    ['fuckadblock.js-3.2.0', 88],
-    ['popads.js', 89],
-    ['scorecardresearch_beacon.js', 90],
-    ['popads-dummy.js', 91],
-    ['empty', 92],
-    ['prebid-ads.js', 93],
-    // empty slots for future use
-    // Adblock Plus
-    ['1x1-transparent-gif', 105],
-    ['2x2-transparent-png', 106],
-    ['3x2-transparent-png', 107],
-    ['32x32-transparent-png', 108],
-    ['blank-css', 109],
-    ['blank-html', 110],
-    ['blank-js', 111],
-    ['blank-text', 112],
-    ['blank-mp3', 113],
-    ['blank-mp4', 114],
-    // empty slots for future use
-    ['abp-resource:1x1-transparent-gif', 120],
-    ['abp-resource:2x2-transparent-png', 121],
-    ['abp-resource:3x2-transparent-png', 122],
-    ['abp-resource:32x32-transparent-png', 123],
-    ['abp-resource:blank-css', 124],
-    ['abp-resource:blank-html', 125],
-    ['abp-resource:blank-js', 126],
-    ['abp-resource:blank-text', 127],
-    ['abp-resource:blank-mp3', 128],
-    ['abp-resource:blank-mp4', 129],
-    // TODO: add other common values
-]);
-/**
- * Value map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- *
- * @note This is a special map which allows us to use different value maps for different modifiers.
- */
-const FREQUENT_REDIRECT_MODIFIERS_SERIALIZATION_MAP = new Map([
-    ['redirect', FREQUENT_REDIRECT_VALUES_SERIALIZATION_MAP],
-    ['redirect-rule', FREQUENT_REDIRECT_VALUES_SERIALIZATION_MAP],
-    ['rewrite', FREQUENT_REDIRECT_VALUES_SERIALIZATION_MAP],
-    // TODO: Add other modifiers here
-]);
-
-export { FREQUENT_MODIFIERS_SERIALIZATION_MAP, FREQUENT_REDIRECT_MODIFIERS_SERIALIZATION_MAP, FREQUENT_REDIRECT_VALUES_SERIALIZATION_MAP, ModifierNodeMarshallingMap };

package/dist/marshalling-utils/misc/modifier-list-common.js

@@ -1,21 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-/**
- * Property map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent a property.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const ModifierListNodeMarshallingMap = {
-    Children: 1,
-    Start: 2,
-    End: 3,
-};
-
-export { ModifierListNodeMarshallingMap };

package/dist/marshalling-utils/misc/parameter-list-common.js

@@ -1,21 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-/**
- * Property map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent a property.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const ParameterListNodeMarshallingMap = {
-    Children: 1,
-    Start: 2,
-    End: 3,
-};
-
-export { ParameterListNodeMarshallingMap };

package/dist/marshalling-utils/misc/value-common.js

@@ -1,22 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-/**
- * Property map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent a property.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const ValueNodeMarshallingMap = {
-    Value: 1,
-    FrequentValue: 2,
-    Start: 3,
-    End: 4,
-};
-
-export { ValueNodeMarshallingMap };

package/dist/marshalling-utils/network/network-rule-common.js

@@ -1,24 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-/**
- * Property map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent a property.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-const NetworkRuleMarshallingMap = {
-    Syntax: 1,
-    Exception: 3,
-    Pattern: 4,
-    ModifierList: 5,
-    Start: 6,
-    End: 7,
-};
-
-export { NetworkRuleMarshallingMap };

package/dist/marshalling-utils/syntax-serialization-map.js

@@ -1,30 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-import { AdblockSyntax } from '../utils/adblockers.js';
-
-/**
- * Value map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-let syntaxSerializationMap;
-const getSyntaxSerializationMap = () => {
-    if (!syntaxSerializationMap) {
-        syntaxSerializationMap = new Map([
-            [AdblockSyntax.Common, 0],
-            [AdblockSyntax.Abp, 1],
-            [AdblockSyntax.Adg, 2],
-            [AdblockSyntax.Ubo, 3],
-        ]);
-    }
-    return syntaxSerializationMap;
-};
-
-export { getSyntaxSerializationMap };

package/dist/serializer/base-serializer.js

@@ -1,29 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-import { NotImplementedError } from '../errors/not-implemented-error.js';
-
-/**
- * @file Base serializer class.
- */
-/**
- * Base class for serializers. Each serializer should extend this class.
- */
-class BaseSerializer {
-    /**
-     * Serializes the AST node to a byte buffer.
-     *
-     * @param node AST node to serialize.
-     * @param buffer Output byte buffer to write to.
-     * @param args Additional, parser-specific arguments, if needed.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    static serialize(node, buffer, ...args) {
-        throw new NotImplementedError();
-    }
-}
-
-export { BaseSerializer };

package/dist/serializer/comment/agent-comment-serializer.js

@@ -1,74 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-import { UINT8_MAX, NULL } from '../../utils/constants.js';
-import { AgentSerializer } from './agent-serializer.js';
-import { isUndefined } from '../../utils/type-guards.js';
-import { BaseSerializer } from '../base-serializer.js';
-import { AgentCommentMarshallingMap } from '../../marshalling-utils/comment/agent-comment-common.js';
-import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.js';
-
-/**
- * `AgentCommentSerializer` is responsible for serializing an Adblock agent comments.
- * Adblock agent comment marks that the filter list is supposed to
- * be used by the specified ad blockers.
- *
- * @example
- *  - ```adblock
- *    [AdGuard]
- *    ```
- *  - ```adblock
- *    [Adblock Plus 2.0]
- *    ```
- *  - ```adblock
- *    [uBlock Origin]
- *    ```
- *  - ```adblock
- *    [uBlock Origin 1.45.3]
- *    ```
- *  - ```adblock
- *    [Adblock Plus 2.0; AdGuard]
- *    ```
- */
-class AgentCommentSerializer extends BaseSerializer {
-    /**
-     * Serializes an adblock agent list node to binary format.
-     *
-     * @param node Node to serialize.
-     * @param buffer ByteBuffer for writing binary data.
-     */
-    // TODO: add support for raws, if ever needed
-    static serialize(node, buffer) {
-        buffer.writeUint8(BinaryTypeMarshallingMap.AgentRuleNode);
-        const count = node.children.length;
-        // If there are no children, we do not write any data related to them, to avoid using unnecessary storage,
-        // but children is a required field, so during deserialization we should initialize it as an empty array,
-        // if there are no children in the binary data.
-        if (count) {
-            buffer.writeUint8(AgentCommentMarshallingMap.Children);
-            // note: we store the count, because re-construction of the array is faster if we know the length
-            // 8 bits is more than enough here
-            if (count > UINT8_MAX) {
-                throw new Error(`Too many children: ${count}, the limit is ${UINT8_MAX}`);
-            }
-            buffer.writeUint8(count);
-            for (let i = 0; i < count; i += 1) {
-                AgentSerializer.serialize(node.children[i], buffer);
-            }
-        }
-        if (!isUndefined(node.start)) {
-            buffer.writeUint8(AgentCommentMarshallingMap.Start);
-            buffer.writeUint32(node.start);
-        }
-        if (!isUndefined(node.end)) {
-            buffer.writeUint8(AgentCommentMarshallingMap.End);
-            buffer.writeUint32(node.end);
-        }
-        buffer.writeUint8(NULL);
-    }
-}
-
-export { AgentCommentSerializer };

package/dist/serializer/comment/agent-serializer.js

@@ -1,59 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-import { NULL } from '../../utils/constants.js';
-import { ValueSerializer } from '../misc/value-serializer.js';
-import { isUndefined } from '../../utils/type-guards.js';
-import { BaseSerializer } from '../base-serializer.js';
-import { AgentNodeMarshallingMap, FREQUENT_AGENTS_DESERIALIZATION_MAP } from '../../marshalling-utils/comment/agent-common.js';
-import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.js';
-
-/**
- * Value map for binary serialization. This helps to reduce the size of the serialized data,
- * as it allows us to use a single byte to represent frequently used values.
- *
- * ! IMPORTANT: If you change values here, please update the {@link BINARY_SCHEMA_VERSION}!
- *
- * @note Only 256 values can be represented this way.
- */
-let frequentAgentsSerializationMap;
-const getFrequentAgentsSerializationMap = () => {
-    if (!frequentAgentsSerializationMap) {
-        frequentAgentsSerializationMap = new Map(Array.from(FREQUENT_AGENTS_DESERIALIZATION_MAP).map(([key, value]) => [value.toLowerCase(), key]));
-    }
-    return frequentAgentsSerializationMap;
-};
-/**
- * `AgentSerializer` is responsible for serializing single adblock agent elements into a binary format.
- */
-class AgentSerializer extends BaseSerializer {
-    /**
-     * Serializes an agent node to binary format.
-     *
-     * @param node Node to serialize.
-     * @param buffer ByteBuffer for writing binary data.
-     */
-    static serialize(node, buffer) {
-        buffer.writeUint8(BinaryTypeMarshallingMap.AgentNode);
-        buffer.writeUint8(AgentNodeMarshallingMap.Adblock);
-        ValueSerializer.serialize(node.adblock, buffer, getFrequentAgentsSerializationMap(), true);
-        if (!isUndefined(node.version)) {
-            buffer.writeUint8(AgentNodeMarshallingMap.Version);
-            ValueSerializer.serialize(node.version, buffer);
-        }
-        if (!isUndefined(node.start)) {
-            buffer.writeUint8(AgentNodeMarshallingMap.Start);
-            buffer.writeUint32(node.start);
-        }
-        if (!isUndefined(node.end)) {
-            buffer.writeUint8(AgentNodeMarshallingMap.End);
-            buffer.writeUint32(node.end);
-        }
-        buffer.writeUint8(NULL);
-    }
-}
-
-export { AgentSerializer };

package/dist/serializer/comment/comment-rule-serializer.js

@@ -1,105 +0,0 @@
-/*
- * AGTree v3.4.1 (build date: Fri, 28 Nov 2025 11:48:53 GMT)
- * (c) 2025 Adguard Software Ltd.
- * Released under the MIT license
- * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
- */
-import { AgentCommentSerializer } from './agent-comment-serializer.js';
-import { CommentRuleType } from '../../nodes/index.js';
-import { ConfigCommentSerializer } from './config-comment-serializer.js';
-import { HintCommentSerializer } from './hint-comment-serializer.js';
-import { MetadataCommentSerializer } from './metadata-comment-serializer.js';
-import { PreProcessorCommentSerializer } from './pre-processor-comment-serializer.js';
-import { SimpleCommentSerializer } from './simple-comment-serializer.js';
-import { BaseSerializer } from '../base-serializer.js';
-
-/**
- * `CommentRuleSerializer` is responsible for serializing 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 CommentRuleSerializer extends BaseSerializer {
-    /**
-     * Serializes a comment rule node to binary format.
-     *
-     * @param node Node to serialize.
-     * @param buffer ByteBuffer for writing binary data.
-     */
-    static serialize(node, buffer) {
-        switch (node.type) {
-            case CommentRuleType.AgentCommentRule:
-                AgentCommentSerializer.serialize(node, buffer);
-                return;
-            case CommentRuleType.HintCommentRule:
-                HintCommentSerializer.serialize(node, buffer);
-                return;
-            case CommentRuleType.PreProcessorCommentRule:
-                PreProcessorCommentSerializer.serialize(node, buffer);
-                return;
-            case CommentRuleType.MetadataCommentRule:
-                MetadataCommentSerializer.serialize(node, buffer);
-                return;
-            case CommentRuleType.ConfigCommentRule:
-                ConfigCommentSerializer.serialize(node, buffer);
-                return;
-            case CommentRuleType.CommentRule:
-                SimpleCommentSerializer.serialize(node, buffer);
-                break;
-            default:
-                throw new Error('Unknown comment rule type');
-        }
-    }
-}
-
-export { CommentRuleSerializer };