@adguard/agtree
Version:
Tool set for working with adblock filter lists
63 lines (60 loc) • 2.98 kB
JavaScript
/*
* AGTree v3.2.2 (build date: Tue, 08 Jul 2025 13:39:47 GMT)
* (c) 2025 Adguard Software Ltd.
* Released under the MIT license
* https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
*/
import { CosmeticRuleSeparator } from '../../nodes/index.js';
import { RuleConverterBase } from '../base-interfaces/rule-converter-base.js';
import { CssSelectorConverter } from '../css/index.js';
import { AdblockSyntax } from '../../utils/adblockers.js';
import { clone } from '../../utils/clone.js';
import { createNodeConversionResult } from '../base-interfaces/conversion-result.js';
import { CssTokenStream } from '../../parser/css/css-token-stream.js';
/**
* @file Element hiding rule converter
*/
/**
* Element hiding rule converter class
*
* @todo Implement `convertToUbo` and `convertToAbp`
*/
class ElementHidingRuleConverter extends RuleConverterBase {
/**
* Converts an element hiding rule to AdGuard format, if possible.
*
* @param rule Rule node to convert
* @returns An object which follows the {@link NodeConversionResult} interface. Its `result` property contains
* the array of converted rule nodes, and its `isConverted` flag indicates whether the original rule was converted.
* If the rule was not converted, the result array will contain the original node with the same object reference
* @throws If the rule is invalid or cannot be converted
*/
static convertToAdg(rule) {
const separator = rule.separator.value;
let convertedSeparator = separator;
const stream = new CssTokenStream(rule.body.selectorList.value);
const convertedSelectorList = CssSelectorConverter.convertToAdg(stream);
// Change the separator if the rule contains ExtendedCSS elements,
// but do not force non-extended CSS separator if the rule does not contain any ExtendedCSS selectors,
// because sometimes we use it to force executing ExtendedCSS library.
if (stream.hasAnySelectorExtendedCssNodeStrict()) {
convertedSeparator = rule.exception
? CosmeticRuleSeparator.ExtendedElementHidingException
: CosmeticRuleSeparator.ExtendedElementHiding;
}
// Check if the rule needs to be converted
if (!(rule.syntax === AdblockSyntax.Common || rule.syntax === AdblockSyntax.Adg)
|| separator !== convertedSeparator
|| convertedSelectorList.isConverted) {
// TODO: Replace with custom clone method
const ruleClone = clone(rule);
ruleClone.syntax = AdblockSyntax.Adg;
ruleClone.separator.value = convertedSeparator;
ruleClone.body.selectorList.value = convertedSelectorList.result;
return createNodeConversionResult([ruleClone], true);
}
// Otherwise, return the original rule
return createNodeConversionResult([rule], false);
}
}
export { ElementHidingRuleConverter };