@adguard/agtree 2.1.2 → 3.0.0-alpha.1

package/dist/esm/serializer/comment/metadata-comment-serializer.mjs

@@ -0,0 +1,73 @@
+/*
+ * 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
+ */
+import { NULL } from '../../utils/constants.mjs';
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { BaseSerializer } from '../base-serializer.mjs';
+import { MetadataCommentMarshallingMap, FREQUENT_HEADERS_DESERIALIZATION_MAP } from '../../marshalling-utils/comment/metadata-comment-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+
+/**
+ * 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.
+ * @note This map is generated from `FREQUENT_HEADERS_DESERIALIZATION_MAP` to keep uppercase characters
+ * while deserializing.
+ */
+let frequentHeadersSerializationMap;
+const getFrequentHeadersSerializationMap = () => {
+    if (!frequentHeadersSerializationMap) {
+        frequentHeadersSerializationMap = new Map(Array.from(FREQUENT_HEADERS_DESERIALIZATION_MAP.entries())
+            .map(([key, value]) => [value.toLowerCase(), key]));
+    }
+    return frequentHeadersSerializationMap;
+};
+/**
+ * `MetadataCommentSerializer` is responsible for serializing metadata comments.
+ * Metadata comments are special comments that specify some properties of the list.
+ *
+ * @example
+ * For example, in the case of
+ * ```adblock
+ * ! Title: My List
+ * ```
+ * the name of the header is `Title`, and the value is `My List`, which means that
+ * the list title is `My List`, and it can be used in the adblocker UI.
+ * @see {@link https://help.eyeo.com/adblockplus/how-to-write-filters#special-comments}
+ */
+class MetadataCommentSerializer extends BaseSerializer {
+    /**
+     * Serializes a metadata comment 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.MetadataCommentRuleNode);
+        buffer.writeUint8(MetadataCommentMarshallingMap.Marker);
+        ValueSerializer.serialize(node.marker, buffer);
+        buffer.writeUint8(MetadataCommentMarshallingMap.Header);
+        ValueSerializer.serialize(node.header, buffer, getFrequentHeadersSerializationMap(), true);
+        buffer.writeUint8(MetadataCommentMarshallingMap.Value);
+        ValueSerializer.serialize(node.value, buffer);
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(MetadataCommentMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(MetadataCommentMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { MetadataCommentSerializer };

package/dist/esm/serializer/comment/pre-processor-comment-serializer.mjs

@@ -0,0 +1,71 @@
+/*
+ * 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
+ */
+import { NULL } from '../../utils/constants.mjs';
+import { LogicalExpressionSerializer } from '../misc/logical-expression-serializer.mjs';
+import { ParameterListSerializer } from '../misc/parameter-list-serializer.mjs';
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { BaseSerializer } from '../base-serializer.mjs';
+import { PreProcessorRuleMarshallingMap, FREQUENT_DIRECTIVES_SERIALIZATION_MAP, FREQUENT_PARAMS_SERIALIZATION_MAP } from '../../marshalling-utils/comment/pre-processor-comment-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+import { getSyntaxSerializationMap } from '../../marshalling-utils/syntax-serialization-map.mjs';
+
+/**
+ * `PreProcessorSerializer` is responsible for serializing preprocessor rules.
+ * Pre-processor comments are special comments that are used to control the behavior of the filter list processor.
+ * Please note that this parser only handles general syntax for now, and does not validate the parameters at
+ * the parsing stage.
+ *
+ * @example
+ * If your rule is
+ * ```adblock
+ * !#if (adguard)
+ * ```
+ * then the directive's name is `if` and its value is `(adguard)`, but the parameter list
+ * is not parsed / validated further.
+ * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#pre-processor-directives}
+ * @see {@link https://github.com/gorhill/uBlock/wiki/Static-filter-syntax#pre-parsing-directives}
+ */
+class PreProcessorCommentSerializer extends BaseSerializer {
+    /**
+     * Serializes a pre-processor comment 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.PreProcessorCommentRuleNode);
+        buffer.writeUint8(PreProcessorRuleMarshallingMap.Name);
+        ValueSerializer.serialize(node.name, buffer, FREQUENT_DIRECTIVES_SERIALIZATION_MAP);
+        buffer.writeUint8(PreProcessorRuleMarshallingMap.Syntax);
+        buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+        if (!isUndefined(node.params)) {
+            buffer.writeUint8(PreProcessorRuleMarshallingMap.Params);
+            if (node.params.type === 'Value') {
+                ValueSerializer.serialize(node.params, buffer);
+            }
+            else if (node.params.type === 'ParameterList') {
+                ParameterListSerializer.serialize(node.params, buffer, FREQUENT_PARAMS_SERIALIZATION_MAP, true);
+            }
+            else {
+                LogicalExpressionSerializer.serialize(node.params, buffer);
+            }
+        }
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(PreProcessorRuleMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(PreProcessorRuleMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { PreProcessorCommentSerializer };

package/dist/esm/serializer/comment/simple-comment-serializer.mjs

@@ -0,0 +1,52 @@
+/*
+ * 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
+ */
+import { NULL } from '../../utils/constants.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { BaseSerializer } from '../base-serializer.mjs';
+import { SimpleCommentMarshallingMap } from '../../marshalling-utils/comment/simple-comment-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+
+/**
+ * `SimpleCommentSerializer` is responsible for parsing simple comments.
+ * Some comments have a special meaning in adblock syntax, like agent comments or hints,
+ * but this parser is only responsible for parsing regular comments,
+ * whose only purpose is to provide some human-readable information.
+ *
+ * @example
+ * ```adblock
+ * ! This is a simple comment
+ * # This is a simple comment, but in host-like syntax
+ * ```
+ */
+class SimpleCommentSerializer extends BaseSerializer {
+    /**
+     * Serializes a simple comment 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(BinaryTypeMarshallingMap.CommentRuleNode);
+        buffer.writeUint8(SimpleCommentMarshallingMap.Marker);
+        ValueSerializer.serialize(node.marker, buffer);
+        buffer.writeUint8(SimpleCommentMarshallingMap.Text);
+        ValueSerializer.serialize(node.text, buffer);
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(SimpleCommentMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(SimpleCommentMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { SimpleCommentSerializer };

package/dist/esm/serializer/cosmetic/body/abp-snippet-injection-body-serializer.mjs

@@ -0,0 +1,36 @@
+/*
+ * 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
+ */
+import { BaseSerializer } from '../../base-serializer.mjs';
+import { ScriptletBodySerializer } from './scriptlet-body-serializer.mjs';
+import { FREQUENT_ABP_SNIPPET_ARGS_SERIALIZATION_MAP } from '../../../marshalling-utils/cosmetic/body/abp-snippet-injection-body-common.mjs';
+
+/**
+ * `AbpSnippetInjectionBodyParser` is responsible for parsing the body of an Adblock Plus-style snippet rule.
+ *
+ * Please note that the parser will parse any scriptlet rule if it is syntactically correct.
+ * For example, it will parse this:
+ * ```adblock
+ * example.com#$#snippet0 arg0
+ * ```
+ *
+ * but it didn't check if the scriptlet `snippet0` actually supported by any adblocker.
+ *
+ * @see {@link https://help.eyeo.com/adblockplus/snippet-filters-tutorial}
+ */
+class AbpSnippetInjectionBodySerializer extends BaseSerializer {
+    /**
+     * Serializes a scriptlet call body node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        ScriptletBodySerializer.serialize(node, buffer, FREQUENT_ABP_SNIPPET_ARGS_SERIALIZATION_MAP);
+    }
+}
+
+export { AbpSnippetInjectionBodySerializer };

package/dist/esm/serializer/cosmetic/body/adg-scriptlet-injection-body-serializer.mjs

@@ -0,0 +1,36 @@
+/*
+ * 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
+ */
+import { BaseSerializer } from '../../base-serializer.mjs';
+import { ScriptletBodySerializer } from './scriptlet-body-serializer.mjs';
+import { FREQUENT_ADG_SCRIPTLET_ARGS_SERIALIZATION_MAP } from '../../../marshalling-utils/cosmetic/body/adg-scriptlet-injection-body-common.mjs';
+
+/**
+ * `AdgScriptletInjectionBodyParser` is responsible for parsing the body of an AdGuard-style scriptlet rule.
+ *
+ * Please note that the parser will parse any scriptlet rule if it is syntactically correct.
+ * For example, it will parse this:
+ * ```adblock
+ * example.com#%#//scriptlet('scriptlet0', 'arg0')
+ * ```
+ *
+ * but it didn't check if the scriptlet `scriptlet0` actually supported by any adblocker.
+ *
+ * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#scriptlets}
+ */
+class AdgScriptletInjectionBodySerializer extends BaseSerializer {
+    /**
+     * Serializes a scriptlet call body node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        ScriptletBodySerializer.serialize(node, buffer, FREQUENT_ADG_SCRIPTLET_ARGS_SERIALIZATION_MAP);
+    }
+}
+
+export { AdgScriptletInjectionBodySerializer };

package/dist/esm/serializer/cosmetic/body/scriptlet-body-serializer.mjs

@@ -0,0 +1,47 @@
+/*
+ * 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
+ */
+import { UINT8_MAX, NULL } from '../../../utils/constants.mjs';
+import { ParameterListSerializer } from '../../misc/parameter-list-serializer.mjs';
+import { isUndefined } from '../../../utils/type-guards.mjs';
+import { BaseSerializer } from '../../base-serializer.mjs';
+import { AbpSnippetBodyMarshallingMap } from '../../../marshalling-utils/cosmetic/body/abp-snippet-injection-body-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../../marshalling-utils/misc/binary-type-common.mjs';
+
+class ScriptletBodySerializer extends BaseSerializer {
+    /**
+     * Serializes a hint rule node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     * @param frequentScriptletArgs Map of frequently used scriptlet names / arguments
+     * and their serialization index (optional).
+     */
+    static serialize = (node, buffer, frequentScriptletArgs) => {
+        buffer.writeUint8(BinaryTypeMarshallingMap.ScriptletInjectionRuleBodyNode);
+        const { length } = node.children;
+        buffer.writeUint8(AbpSnippetBodyMarshallingMap.Children);
+        // note: we store the count, because re-construction of the array is faster if we know the length
+        if (length > UINT8_MAX) {
+            throw new Error(`Too many scriptlet children: ${length}, the limit is ${UINT8_MAX}`);
+        }
+        buffer.writeUint8(length);
+        for (let i = 0; i < length; i += 1) {
+            ParameterListSerializer.serialize(node.children[i], buffer, frequentScriptletArgs);
+        }
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(AbpSnippetBodyMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(AbpSnippetBodyMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    };
+}
+
+export { ScriptletBodySerializer };

package/dist/esm/serializer/cosmetic/body/ubo-scriptlet-injection-body-serializer.mjs

@@ -0,0 +1,36 @@
+/*
+ * 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
+ */
+import { ScriptletBodySerializer } from './scriptlet-body-serializer.mjs';
+import { BaseSerializer } from '../../base-serializer.mjs';
+import { FREQUENT_UBO_SCRIPTLET_ARGS_SERIALIZATION_MAP } from '../../../marshalling-utils/cosmetic/body/ubo-scriptlet-injection-body-common.mjs';
+
+/**
+ * `UboScriptletInjectionBodySerializer` is responsible for serializing the body of a uBlock-style scriptlet rule.
+ *
+ * Please note that the parser will parse any scriptlet rule if it is syntactically correct.
+ * For example, it will parse this:
+ * ```adblock
+ * example.com##+js(scriptlet0, arg0)
+ * ```
+ *
+ * but it didn't check if the scriptlet `scriptlet0` actually supported by any adblocker.
+ *
+ * @see {@link https://github.com/gorhill/uBlock/wiki/Static-filter-syntax#scriptlet-injection}
+ */
+class UboScriptletInjectionBodySerializer extends BaseSerializer {
+    /**
+     * Serializes a scriptlet call body node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        ScriptletBodySerializer.serialize(node, buffer, FREQUENT_UBO_SCRIPTLET_ARGS_SERIALIZATION_MAP);
+    }
+}
+
+export { UboScriptletInjectionBodySerializer };

package/dist/esm/serializer/cosmetic/cosmetic-rule-serializer.mjs

@@ -0,0 +1,129 @@
+/*
+ * 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
+ */
+import { AdblockSyntax } from '../../utils/adblockers.mjs';
+import { DomainListSerializer } from '../misc/domain-list-serializer.mjs';
+import { NULL } from '../../utils/constants.mjs';
+import { CosmeticRuleType } from '../../nodes/index.mjs';
+import { AbpSnippetInjectionBodySerializer } from './body/abp-snippet-injection-body-serializer.mjs';
+import { UboScriptletInjectionBodySerializer } from './body/ubo-scriptlet-injection-body-serializer.mjs';
+import { AdgScriptletInjectionBodySerializer } from './body/adg-scriptlet-injection-body-serializer.mjs';
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { BaseSerializer } from '../base-serializer.mjs';
+import { ElementHidingBodySerializer } from './element-hiding-body-serializer.mjs';
+import { CssInjectionBodySerializer } from './css-injection-body-serializer.mjs';
+import { ModifierListSerializer } from '../misc/modifier-list-serializer.mjs';
+import { CosmeticRuleMarshallingMap, COSMETIC_RULE_SEPARATOR_SERIALIZATION_MAP } from '../../marshalling-utils/cosmetic/cosmetic-rule-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+import { getSyntaxSerializationMap } from '../../marshalling-utils/syntax-serialization-map.mjs';
+
+/**
+ * `CosmeticRuleParser` is responsible for parsing cosmetic rules.
+ *
+ * Where possible, it automatically detects the difference between supported syntaxes:
+ *  - AdGuard
+ *  - uBlock Origin
+ *  - Adblock Plus
+ *
+ * If the syntax is common / cannot be determined, the parser gives `Common` syntax.
+ *
+ * Please note that syntactically correct rules are parsed even if they are not actually
+ * compatible with the given adblocker. This is a completely natural behavior, meaningful
+ * checking of compatibility is not done at the parser level.
+ */
+// TODO: Make raw body parsing optional
+// TODO: Split into smaller sections
+class CosmeticRuleSerializer extends BaseSerializer {
+    /**
+     * Serializes a cosmetic 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) {
+        // specific properties
+        switch (node.type) {
+            case CosmeticRuleType.ElementHidingRule:
+                // rule type
+                buffer.writeUint8(BinaryTypeMarshallingMap.ElementHidingRule);
+                // syntax
+                buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+                // rule body
+                ElementHidingBodySerializer.serialize(node.body, buffer);
+                break;
+            case CosmeticRuleType.CssInjectionRule:
+                // rule type
+                buffer.writeUint8(BinaryTypeMarshallingMap.CssInjectionRule);
+                // syntax
+                buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+                // rule body
+                CssInjectionBodySerializer.serialize(node.body, buffer);
+                break;
+            case CosmeticRuleType.JsInjectionRule:
+                // rule type
+                buffer.writeUint8(BinaryTypeMarshallingMap.JsInjectionRule);
+                // syntax
+                buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+                // rule body
+                ValueSerializer.serialize(node.body, buffer);
+                break;
+            case CosmeticRuleType.HtmlFilteringRule:
+                // rule type
+                buffer.writeUint8(BinaryTypeMarshallingMap.HtmlFilteringRule);
+                // syntax
+                buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+                // rule body
+                ValueSerializer.serialize(node.body, buffer);
+                break;
+            case CosmeticRuleType.ScriptletInjectionRule:
+                // rule type
+                buffer.writeUint8(BinaryTypeMarshallingMap.ScriptletInjectionRule);
+                // syntax
+                buffer.writeUint8(getSyntaxSerializationMap().get(node.syntax) ?? 0);
+                // rule body
+                switch (node.syntax) {
+                    case AdblockSyntax.Adg:
+                        AdgScriptletInjectionBodySerializer.serialize(node.body, buffer);
+                        break;
+                    case AdblockSyntax.Abp:
+                        AbpSnippetInjectionBodySerializer.serialize(node.body, buffer);
+                        break;
+                    case AdblockSyntax.Ubo:
+                        UboScriptletInjectionBodySerializer.serialize(node.body, buffer);
+                        break;
+                    default:
+                        throw new Error('Scriptlet rule should have an explicit syntax');
+                }
+                break;
+            default:
+                throw new Error('Unknown cosmetic rule type');
+        }
+        // common properties
+        buffer.writeUint8(CosmeticRuleMarshallingMap.Exception);
+        buffer.writeUint8(node.exception ? 1 : 0);
+        buffer.writeUint8(CosmeticRuleMarshallingMap.Separator);
+        ValueSerializer.serialize(node.separator, buffer, COSMETIC_RULE_SEPARATOR_SERIALIZATION_MAP);
+        if (node.modifiers) {
+            buffer.writeUint8(CosmeticRuleMarshallingMap.Modifiers);
+            ModifierListSerializer.serialize(node.modifiers, buffer);
+        }
+        buffer.writeUint8(CosmeticRuleMarshallingMap.Domains);
+        DomainListSerializer.serialize(node.domains, buffer);
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(CosmeticRuleMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(CosmeticRuleMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { CosmeticRuleSerializer };

package/dist/esm/serializer/cosmetic/css-injection-body-serializer.mjs

@@ -0,0 +1,48 @@
+/*
+ * 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
+ */
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { NULL } from '../../utils/constants.mjs';
+import { BaseSerializer } from '../base-serializer.mjs';
+import { CssInjectionRuleMarshallingMap } from '../../marshalling-utils/cosmetic/body/css-injection-body-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+
+class CssInjectionBodySerializer extends BaseSerializer {
+    /**
+     * Serializes a CSS injection rule body node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        buffer.writeUint8(BinaryTypeMarshallingMap.CssInjectionRuleBody);
+        if (node.mediaQueryList) {
+            buffer.writeUint8(CssInjectionRuleMarshallingMap.MediaQueryList);
+            ValueSerializer.serialize(node.mediaQueryList, buffer);
+        }
+        buffer.writeUint8(CssInjectionRuleMarshallingMap.SelectorList);
+        ValueSerializer.serialize(node.selectorList, buffer);
+        if (node.declarationList) {
+            buffer.writeUint8(CssInjectionRuleMarshallingMap.DeclarationList);
+            ValueSerializer.serialize(node.declarationList, buffer);
+        }
+        if (node.remove) {
+            buffer.writeUint8(CssInjectionRuleMarshallingMap.Remove);
+        }
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(CssInjectionRuleMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(CssInjectionRuleMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { CssInjectionBodySerializer };

package/dist/esm/serializer/cosmetic/element-hiding-body-serializer.mjs

@@ -0,0 +1,37 @@
+/*
+ * 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
+ */
+import { BaseSerializer } from '../base-serializer.mjs';
+import { ValueSerializer } from '../misc/value-serializer.mjs';
+import { isUndefined } from '../../utils/type-guards.mjs';
+import { NULL } from '../../utils/constants.mjs';
+import { ElementHidingRuleMarshallingMap } from '../../marshalling-utils/cosmetic/body/element-hiding-body-common.mjs';
+import { BinaryTypeMarshallingMap } from '../../marshalling-utils/misc/binary-type-common.mjs';
+
+class ElementHidingBodySerializer extends BaseSerializer {
+    /**
+     * Serializes an element hiding rule body node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        buffer.writeUint8(BinaryTypeMarshallingMap.ElementHidingRuleBody);
+        buffer.writeUint8(ElementHidingRuleMarshallingMap.SelectorList);
+        ValueSerializer.serialize(node.selectorList, buffer);
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(ElementHidingRuleMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(ElementHidingRuleMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { ElementHidingBodySerializer };

package/dist/esm/serializer/empty-rule-serializer.mjs

@@ -0,0 +1,34 @@
+/*
+ * 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
+ */
+import { BaseSerializer } from './base-serializer.mjs';
+import { isUndefined } from '../utils/type-guards.mjs';
+import { NULL } from '../utils/constants.mjs';
+import { EmptyRuleMarshallingMap } from '../marshalling-utils/empty-rule-common.mjs';
+import { BinaryTypeMarshallingMap } from '../marshalling-utils/misc/binary-type-common.mjs';
+
+class EmptyRuleSerializer extends BaseSerializer {
+    /**
+     * Serializes an empty rule node to binary format.
+     *
+     * @param node Node to serialize.
+     * @param buffer ByteBuffer for writing binary data.
+     */
+    static serialize(node, buffer) {
+        buffer.writeUint8(BinaryTypeMarshallingMap.EmptyRule);
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(EmptyRuleMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(EmptyRuleMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { EmptyRuleSerializer };

package/dist/esm/serializer/filterlist-serializer.mjs

@@ -0,0 +1,46 @@
+/*
+ * 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
+ */
+import { NULL } from '../utils/constants.mjs';
+import { isUndefined } from '../utils/type-guards.mjs';
+import { BaseSerializer } from './base-serializer.mjs';
+import { RuleSerializer } from './rule-serializer.mjs';
+import { FilterListNodeMarshallingMap } from '../marshalling-utils/filter-list-common.mjs';
+import { BinaryTypeMarshallingMap } from '../marshalling-utils/misc/binary-type-common.mjs';
+
+/**
+ * `FilterListParser` is responsible for parsing a whole adblock filter list (list of rules).
+ * It is a wrapper around `RuleParser` which parses each line separately.
+ */
+class FilterListSerializer extends BaseSerializer {
+    /**
+     * Serializes a filter 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.FilterListNode);
+        buffer.writeUint8(FilterListNodeMarshallingMap.Children);
+        const count = node.children.length;
+        buffer.writeUint32(count);
+        for (let i = 0; i < count; i += 1) {
+            RuleSerializer.serialize(node.children[i], buffer);
+        }
+        if (!isUndefined(node.start)) {
+            buffer.writeUint8(FilterListNodeMarshallingMap.Start);
+            buffer.writeUint32(node.start);
+        }
+        if (!isUndefined(node.end)) {
+            buffer.writeUint8(FilterListNodeMarshallingMap.End);
+            buffer.writeUint32(node.end);
+        }
+        buffer.writeUint8(NULL);
+    }
+}
+
+export { FilterListSerializer };

package/dist/esm/serializer/index.mjs

@@ -0,0 +1,7 @@
+/*
+ * 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
+ */
+export { RuleSerializer } from './rule-serializer.mjs';