@adguard/agtree/dist/serializer/rule-serializer.js

Tool set for working with adblock filter lists

/*
 * AGTree v3.4.3 (build date: Thu, 11 Dec 2025 13:43:19 GMT)
 * (c) 2025 Adguard Software Ltd.
 * Released under the MIT license
 * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
 */
import { RuleCategory, NetworkRuleType } from '../nodes/index.js';
import { BaseSerializer } from './base-serializer.js';
import { CommentRuleSerializer } from './comment/comment-rule-serializer.js';
import { CosmeticRuleSerializer } from './cosmetic/cosmetic-rule-serializer.js';
import { HostRuleSerializer } from './network/host-rule-serializer.js';
import { NetworkRuleSerializer } from './network/network-rule-serializer.js';
import { EmptyRuleSerializer } from './empty-rule-serializer.js';
import { InvalidRuleSerializer } from './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 {
    /**
     * 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 RuleCategory.Comment:
                CommentRuleSerializer.serialize(node, buffer);
                break;
            case RuleCategory.Cosmetic:
                CosmeticRuleSerializer.serialize(node, buffer);
                break;
            case RuleCategory.Network:
                switch (node.type) {
                    case NetworkRuleType.HostRule:
                        HostRuleSerializer.serialize(node, buffer);
                        break;
                    case NetworkRuleType.NetworkRule:
                        NetworkRuleSerializer.serialize(node, buffer);
                        break;
                    default:
                        throw new Error('Unknown network rule type');
                }
                break;
            case RuleCategory.Empty:
                EmptyRuleSerializer.serialize(node, buffer);
                break;
            case RuleCategory.Invalid:
                InvalidRuleSerializer.serialize(node, buffer);
                break;
            default:
                throw new Error('Unknown rule category');
        }
    }
}

export { RuleSerializer };