@adguard/agtree 3.0.0 → 3.0.1

package/dist/cjs/serializer/network/host-rule-serializer.js

@@ -1,72 +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 valueSerializer = require('../misc/value-serializer.js');
-var typeGuards = require('../../utils/type-guards.js');
-var hostnameListSerializer = require('./hostname-list-serializer.js');
-var baseSerializer = require('../base-serializer.js');
-var hostRuleCommon = require('../../marshalling-utils/misc/host-rule-common.js');
-var binaryTypeCommon = require('../../marshalling-utils/misc/binary-type-common.js');
-var syntaxSerializationMap = require('../../marshalling-utils/syntax-serialization-map.js');
-
-/**
- * `HostRuleSerializer` is responsible for serializing hosts-like rules.
- *
- * HostRule is a structure for simple host-level rules (i.e. /etc/hosts syntax).
- * It also supports "just domain" syntax. In this case, the IP will be set to 0.0.0.0.
- *
- * Rules syntax looks like this:
- * ```text
- * IP_address canonical_hostname [aliases...]
- * ```
- *
- * @example
- * `192.168.1.13 bar.mydomain.org bar` -- ipv4
- * `ff02::1 ip6-allnodes` -- ipv6
- * `::1 localhost ip6-localhost ip6-loopback` -- ipv6 aliases
- * `example.org` -- "just domain" syntax
- * @see {@link http://man7.org/linux/man-pages/man5/hosts.5.html}
- */
-class HostRuleSerializer extends baseSerializer.BaseSerializer {
-    /**
-     * Serializes a host rule 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(binaryTypeCommon.BinaryTypeMarshallingMap.HostRuleNode);
-        buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.Syntax);
-        buffer.writeUint8(syntaxSerializationMap.getSyntaxSerializationMap().get(node.syntax) ?? 0);
-        if (node.ip) {
-            buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.Ip);
-            valueSerializer.ValueSerializer.serialize(node.ip, buffer);
-        }
-        if (node.hostnames) {
-            buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.HostnameList);
-            hostnameListSerializer.HostnameListSerializer.serialize(node.hostnames, buffer);
-        }
-        if (node.comment) {
-            buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.Comment);
-            valueSerializer.ValueSerializer.serialize(node.comment, buffer);
-        }
-        if (!typeGuards.isUndefined(node.start)) {
-            buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.Start);
-            buffer.writeUint32(node.start);
-        }
-        if (!typeGuards.isUndefined(node.end)) {
-            buffer.writeUint8(hostRuleCommon.HostRuleMarshallingMap.End);
-            buffer.writeUint32(node.end);
-        }
-        buffer.writeUint8(constants.NULL);
-    }
-}
-
-exports.HostRuleSerializer = HostRuleSerializer;

package/dist/cjs/serializer/network/hostname-list-serializer.js

@@ -1,49 +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 baseSerializer = require('../base-serializer.js');
-var typeGuards = require('../../utils/type-guards.js');
-var constants = require('../../utils/constants.js');
-var valueSerializer = require('../misc/value-serializer.js');
-var hostnameListCommon = require('../../marshalling-utils/misc/hostname-list-common.js');
-var binaryTypeCommon = require('../../marshalling-utils/misc/binary-type-common.js');
-
-class HostnameListSerializer extends baseSerializer.BaseSerializer {
-    /**
-     * Serializes a hostname list node to binary format.
-     *
-     * @param node Node to serialize.
-     * @param buffer ByteBuffer for writing binary data.
-     */
-    static serialize(node, buffer) {
-        buffer.writeUint8(binaryTypeCommon.BinaryTypeMarshallingMap.HostnameListNode);
-        if (!typeGuards.isUndefined(node.start)) {
-            buffer.writeUint8(hostnameListCommon.HostnameListNodeMarshallingMap.Start);
-            buffer.writeUint32(node.start);
-        }
-        if (!typeGuards.isUndefined(node.end)) {
-            buffer.writeUint8(hostnameListCommon.HostnameListNodeMarshallingMap.End);
-            buffer.writeUint32(node.end);
-        }
-        const count = node.children.length;
-        if (count) {
-            // note: we store the count, because re-construction of the array is faster if we know the length
-            if (count > constants.UINT16_MAX) {
-                throw new Error(`Too many children: ${count}, the limit is ${constants.UINT16_MAX}`);
-            }
-            buffer.writeUint8(hostnameListCommon.HostnameListNodeMarshallingMap.Children);
-            buffer.writeUint16(count);
-            for (let i = 0; i < count; i += 1) {
-                valueSerializer.ValueSerializer.serialize(node.children[i], buffer);
-            }
-        }
-        buffer.writeUint8(constants.NULL);
-    }
-}
-
-exports.HostnameListSerializer = HostnameListSerializer;

package/dist/cjs/serializer/network/network-rule-serializer.js

@@ -1,56 +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 typeGuards = require('../../utils/type-guards.js');
-var valueSerializer = require('../misc/value-serializer.js');
-var baseSerializer = require('../base-serializer.js');
-var modifierListSerializer = require('../misc/modifier-list-serializer.js');
-var networkRuleCommon = require('../../marshalling-utils/network/network-rule-common.js');
-var binaryTypeCommon = require('../../marshalling-utils/misc/binary-type-common.js');
-var syntaxSerializationMap = require('../../marshalling-utils/syntax-serialization-map.js');
-
-/**
- * `NetworkRuleSerializer` is responsible for serializing network rules.
- *
- * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#basic-rules}
- * @see {@link https://help.eyeo.com/adblockplus/how-to-write-filters#basic}
- */
-class NetworkRuleSerializer extends baseSerializer.BaseSerializer {
-    /**
-     * Serializes a network rule 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(binaryTypeCommon.BinaryTypeMarshallingMap.NetworkRuleNode);
-        buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.Syntax);
-        buffer.writeUint8(syntaxSerializationMap.getSyntaxSerializationMap().get(node.syntax) ?? 0);
-        buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.Exception);
-        buffer.writeUint8(node.exception ? 1 : 0);
-        buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.Pattern);
-        valueSerializer.ValueSerializer.serialize(node.pattern, buffer);
-        if (!typeGuards.isUndefined(node.modifiers)) {
-            buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.ModifierList);
-            modifierListSerializer.ModifierListSerializer.serialize(node.modifiers, buffer);
-        }
-        if (!typeGuards.isUndefined(node.start)) {
-            buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.Start);
-            buffer.writeUint32(node.start);
-        }
-        if (!typeGuards.isUndefined(node.end)) {
-            buffer.writeUint8(networkRuleCommon.NetworkRuleMarshallingMap.End);
-            buffer.writeUint32(node.end);
-        }
-        buffer.writeUint8(constants.NULL);
-    }
-}
-
-exports.NetworkRuleSerializer = NetworkRuleSerializer;

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

@@ -1,63 +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 baseSerializer = require('./base-serializer.js');
-var commentRuleSerializer = require('./comment/comment-rule-serializer.js');
-var cosmeticRuleSerializer = require('./cosmetic/cosmetic-rule-serializer.js');
-var hostRuleSerializer = require('./network/host-rule-serializer.js');
-var networkRuleSerializer = require('./network/network-rule-serializer.js');
-var emptyRuleSerializer = require('./empty-rule-serializer.js');
-var invalidRuleSerializer = require('./invalid-rule-serializer.js');
-
-/**
- * `RuleSerializer` is responsible for serializing the rules.
- *
- * It automatically determines the category and syntax of the rule, so you can pass any kind of rule to it.
- */
-class RuleSerializer extends baseSerializer.BaseSerializer {
-    /**
-     * Serializes a rule 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) {
-        switch (node.category) {
-            case index.RuleCategory.Comment:
-                commentRuleSerializer.CommentRuleSerializer.serialize(node, buffer);
-                break;
-            case index.RuleCategory.Cosmetic:
-                cosmeticRuleSerializer.CosmeticRuleSerializer.serialize(node, buffer);
-                break;
-            case index.RuleCategory.Network:
-                switch (node.type) {
-                    case index.NetworkRuleType.HostRule:
-                        hostRuleSerializer.HostRuleSerializer.serialize(node, buffer);
-                        break;
-                    case index.NetworkRuleType.NetworkRule:
-                        networkRuleSerializer.NetworkRuleSerializer.serialize(node, buffer);
-                        break;
-                    default:
-                        throw new Error('Unknown network rule type');
-                }
-                break;
-            case index.RuleCategory.Empty:
-                emptyRuleSerializer.EmptyRuleSerializer.serialize(node, buffer);
-                break;
-            case index.RuleCategory.Invalid:
-                invalidRuleSerializer.InvalidRuleSerializer.serialize(node, buffer);
-                break;
-            default:
-                throw new Error('Unknown rule category');
-        }
-    }
-}
-
-exports.RuleSerializer = RuleSerializer;

package/dist/cjs/utils/adblockers.js

@@ -1,57 +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 Possible adblock syntaxes are listed here.
- */
-/**
- * Possible adblock syntaxes (supported by this library)
- */
-exports.AdblockSyntax = void 0;
-(function (AdblockSyntax) {
-    /**
-     * Common syntax, which is supported by more than one adblocker (or by all adblockers).
-     *
-     * We typically use this syntax when we cannot determine the concrete syntax of the rule,
-     * because the syntax is used by more than one adblocker natively.
-     *
-     * @example
-     * - `||example.org^$important` is a common syntax, since it is used by all adblockers natively, and
-     * we cannot determine at parsing level whether `important` is a valid option or not, and if it is valid,
-     * then which adblocker supports it.
-     */
-    AdblockSyntax["Common"] = "Common";
-    /**
-     * Adblock Plus syntax.
-     *
-     * @example
-     * - `example.org#$#abort-on-property-read alert` is an Adblock Plus syntax, since it is not used by any other
-     * adblockers directly (probably supported by some on-the-fly conversion, but this is not the native syntax).
-     * @see {@link https://adblockplus.org/}
-     */
-    AdblockSyntax["Abp"] = "AdblockPlus";
-    /**
-     * uBlock Origin syntax.
-     *
-     * @example
-     * - `example.com##+js(set, atob, noopFunc)` is an uBlock Origin syntax, since it is not used by any other
-     * adblockers directly (probably supported by some on-the-fly conversion, but this is not the native syntax).
-     * @see {@link https://github.com/gorhill/uBlock}
-     */
-    AdblockSyntax["Ubo"] = "UblockOrigin";
-    /**
-     * AdGuard syntax.
-     *
-     * @example
-     * - `example.org#%#//scriptlet("abort-on-property-read", "alert")` is an AdGuard syntax, since it is not used
-     * by any other adblockers directly (probably supported by some on-the-fly conversion, but this is not the native
-     * syntax).
-     * @see {@link https://adguard.com/}
-     */
-    AdblockSyntax["Adg"] = "AdGuard";
-})(exports.AdblockSyntax || (exports.AdblockSyntax = {}));

package/dist/cjs/utils/binary-schema-version.js

@@ -1,19 +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 Binary schema version.
- */
-/**
- * Binary schema version.
- * This version number is used to ensure that the binary format is compatible with the current library version.
- * We increment this number if the serialized format changes in a way that is not backwards-compatible.
- */
-const BINARY_SCHEMA_VERSION = 1;
-
-exports.BINARY_SCHEMA_VERSION = BINARY_SCHEMA_VERSION;

package/dist/cjs/utils/byte-buffer.js

@@ -1,93 +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';
-
-/* eslint-disable no-bitwise */
-/**
- * @file Core ByteBuffer implementation for handling binary data in chunks.
- */
-/**
- * Core ByteBuffer implementation for handling binary data in chunks.
- * This class allows for efficient byte storage and manipulation by organizing data into chunks
- * and providing methods to read and write bytes.
- */
-class ByteBuffer {
-    /**
-     * The size of each chunk in bytes (32 KB).
-     */
-    // ! IMPORTANT: If you ever change this value, make sure to update optimized bitwise operations in the code.
-    static CHUNK_SIZE = 32768; // 32 * 1024
-    /**
-     * An array of Uint8Array chunks that make up the buffer.
-     */
-    chunks;
-    /**
-     * The total number of chunks in the buffer.
-     */
-    chunksLength;
-    /**
-     * Constructs a new ByteBuffer instance.
-     *
-     * @param chunks Optional array of chunks to initialize the ByteBuffer with.
-     * @param cloneChunks Flag indicating if the chunks should be cloned. For performance reasons,
-     * its default value is `false`. If the original chunks are guaranteed not to change,
-     * leave this flag as `false` to avoid unnecessary copying.
-     */
-    constructor(chunks, cloneChunks = false) {
-        const chunksToUse = chunks ?? [];
-        this.chunks = cloneChunks ? chunksToUse.map((chunk) => new Uint8Array(chunk)) : chunksToUse;
-        this.chunksLength = chunks?.length ?? 0;
-    }
-    /**
-     * Ensures that the buffer has enough capacity to accommodate a given position.
-     * This method adjusts the `chunks` array size to ensure it can hold the specified position.
-     *
-     * @param position The position to ensure capacity for.
-     */
-    ensureCapacity(position) {
-        // same as Math.floor(position / chunk size), just optimized for the 32 KB chunk size
-        const requiredChunkIndex = position >>> 0x000F;
-        for (let i = this.chunksLength; i <= requiredChunkIndex; i += 1) {
-            this.chunks.push(new Uint8Array(ByteBuffer.CHUNK_SIZE));
-            this.chunksLength += 1;
-        }
-    }
-    /**
-     * Writes a byte to the buffer at the specified position.
-     * If the position is outside of the buffer's current size, the buffer is resized to accommodate it.
-     *
-     * @param position The position at which to write the byte.
-     * @param value The byte value to write (0-255).
-     */
-    writeByte(position, value) {
-        // same as Math.floor(position / chunk size), just optimized for the 32 KB chunk size
-        const chunkIndex = position >>> 0x000F;
-        // same as position % chunk size, just optimized for the 32 KB chunk size
-        const chunkOffset = position & 0x7FFF;
-        if (chunkIndex >= this.chunksLength) {
-            this.ensureCapacity(position);
-        }
-        this.chunks[chunkIndex][chunkOffset] = value;
-    }
-    /**
-     * Reads a byte from the specified position in the buffer.
-     * Returns `undefined` if the position is outside of the buffer's current size.
-     *
-     * @param position The position from which to read the byte.
-     * @returns The read byte value, or `undefined` if the position is out of bounds.
-     */
-    readByte(position) {
-        const chunkIndex = position >>> 0x000F;
-        const chunkOffset = position & 0x7FFF;
-        if (chunkIndex >= this.chunksLength) {
-            return undefined;
-        }
-        return this.chunks[chunkIndex][chunkOffset];
-    }
-}
-
-exports.ByteBuffer = ByteBuffer;

package/dist/cjs/utils/categorizer.js

@@ -1,46 +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 cosmeticRuleParser = require('../parser/cosmetic/cosmetic-rule-parser.js');
-var typeGuards = require('./type-guards.js');
-var options = require('../parser/options.js');
-
-/**
- * Utility functions for categorizing rules.
- */
-// TODO: Optimize functions to avoid produce unnecessary data (currently, most of node data is not used).
-// TODO: Add support for other rule categories, like network rules (when needed).
-class RuleCategorizer {
-    /**
-     * Determines the type of a given raw cosmetic rule.
-     *
-     * @param rawRule Raw rule to check.
-     *
-     * @returns Type of the cosmetic rule or `null` if the rule is cannot be parsed as a cosmetic rule.
-     */
-    static getCosmeticRuleType(rawRule) {
-        try {
-            const node = cosmeticRuleParser.CosmeticRuleParser.parse(rawRule, {
-                ...options.defaultParserOptions,
-                isLocIncluded: false,
-                includeRaws: false,
-            });
-            // If rule cannot be recognized as a cosmetic rule, return null.
-            if (typeGuards.isNull(node)) {
-                return null;
-            }
-            return node.type;
-        }
-        catch {
-            // Be tolerant to parsing errors and simply return null.
-            return null;
-        }
-    }
-}
-
-exports.RuleCategorizer = RuleCategorizer;

package/dist/cjs/utils/clone.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 cloneDeep = require('clone-deep');
-
-/**
- * @file Clone related utilities
- *
- * We should keep clone related functions in this file. Thus, we just provide
- * a simple interface for cloning values, we use it across the AGTree project,
- * and the implementation "under the hood" can be improved later, if needed.
- */
-/**
- * Clones an input value to avoid side effects. Use it only in justified cases,
- * because it can impact performance negatively.
- *
- * @param value Value to clone
- * @returns Cloned value
- */
-function clone(value) {
-    // TODO: Replace cloneDeep with a more efficient implementation
-    return cloneDeep(value);
-}
-
-exports.clone = clone;