@adguard/agtree 3.0.0 → 3.0.1

package/dist/types/generator/css/adg-css-injection-generator.d.ts

@@ -1,5 +1,8 @@
 import type { CssInjectionRuleBody } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * AdGuard CSS injection generator.
+ */
 export declare class AdgCssInjectionGenerator extends BaseGenerator {
     private static removeDeclaration;
     /**

package/dist/types/generator/css/ubo-selector-generator.d.ts

@@ -1,5 +1,8 @@
 import { BaseGenerator } from '../base-generator';
 import { type UboSelector } from '../../nodes';
+/**
+ * UBO selector generator.
+ */
 export declare class UboSelectorGenerator extends BaseGenerator {
     /**
      * Serializes a uBO selector node to a string.

package/dist/types/generator/filterlist-generator.d.ts

@@ -1,8 +1,7 @@
 import { type FilterList } from '../nodes';
 import { BaseGenerator } from './base-generator';
 /**
- * `FilterListParser` is responsible for parsing a whole adblock filter list (list of rules).
- * It is a wrapper around `RuleParser` which parses each line separately.
+ * Generates a serialized filter list.
  */
 export declare class FilterListGenerator extends BaseGenerator {
     /**
@@ -11,7 +10,9 @@ export declare class FilterListGenerator extends BaseGenerator {
      * @param ast AST to generate
      * @param preferRaw If `true`, then the parser will use `raws.text` property of each rule
      * if it is available. Default is `false`.
+     * @param tolerant If `true`, errors during rule generation will be logged to the console and invalid rules
+     * will be skipped. If `false`, an error will be thrown on the first invalid rule. Default is `true`.
      * @returns Serialized filter list
      */
-    static generate(ast: FilterList, preferRaw?: boolean): string;
+    static generate(ast: FilterList, preferRaw?: boolean, tolerant?: boolean): string;
 }

package/dist/types/generator/misc/domain-list-generator.d.ts

@@ -1,5 +1,8 @@
 import type { DomainList } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Domain list generator.
+ */
 export declare class DomainListGenerator extends BaseGenerator {
     /**
      * Converts a domain list node to a string.

package/dist/types/generator/misc/list-items-generator.d.ts

@@ -1,4 +1,7 @@
 import { type ListItem, type ListItemNodeType } from '../../nodes';
+/**
+ * Utility class for generating string representations of list items.
+ */
 export declare class ListItemsGenerator {
     /**
      * Generates a string representation of a list item.

package/dist/types/generator/misc/logical-expression-generator.d.ts

@@ -1,5 +1,8 @@
 import { BaseGenerator } from '../base-generator';
 import { type AnyExpressionNode } from '../../nodes';
+/**
+ * Generator for logical expression nodes.
+ */
 export declare class LogicalExpressionGenerator extends BaseGenerator {
     /**
      * Generates a string representation of the logical expression (serialization).

package/dist/types/generator/misc/modifier-generator.d.ts

@@ -1,10 +1,13 @@
 import type { Modifier } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Generator for modifier nodes.
+ */
 export declare class ModifierGenerator extends BaseGenerator {
     /**
-     * Generates a string from a modifier (serializes it).
+     * Converts a modifier AST node to a string.
      *
-     * @param modifier Modifier to generate string from
+     * @param modifier Modifier AST node to convert
      * @returns String representation of the modifier
      */
     static generate(modifier: Modifier): string;

package/dist/types/generator/misc/modifier-list-generator.d.ts

@@ -1,5 +1,8 @@
 import { BaseGenerator } from '../base-generator';
 import type { ModifierList } from '../../nodes';
+/**
+ * Generator for modifier list nodes.
+ */
 export declare class ModifierListGenerator extends BaseGenerator {
     /**
      * Converts a modifier list AST to a string.

package/dist/types/generator/misc/parameter-list-generator.d.ts

@@ -1,5 +1,8 @@
 import type { ParameterList } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Generator for parameter list nodes.
+ */
 export declare class ParameterListGenerator extends BaseGenerator {
     /**
      * Converts a parameter list AST to a string.

package/dist/types/generator/misc/value-generator.d.ts

@@ -1,5 +1,8 @@
 import type { Value } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Generator for value nodes.
+ */
 export declare class ValueGenerator extends BaseGenerator {
     /**
      * Converts a value node to a string.

package/dist/types/generator/network/host-rule-generator.d.ts

@@ -1,5 +1,8 @@
 import type { HostRule } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Generator for host rule nodes.
+ */
 export declare class HostRuleGenerator extends BaseGenerator {
     /**
      * Converts a host rule node to a raw string.

package/dist/types/generator/network/network-rule-generator.d.ts

@@ -1,11 +1,14 @@
 import type { NetworkRule } from '../../nodes';
 import { BaseGenerator } from '../base-generator';
+/**
+ * Generator for network rule nodes.
+ */
 export declare class NetworkRuleGenerator extends BaseGenerator {
     /**
-     * Converts a network rule (basic rule) AST to a string.
+     * Generates a string from a network rule AST node.
      *
-     * @param node Network rule node
-     * @returns Raw string
+     * @param node Network rule node to generate a string from.
+     * @returns Generated string representation of the network rule.
      */
     static generate(node: NetworkRule): string;
 }

package/dist/types/generator/rule-generator.d.ts

@@ -1,5 +1,8 @@
 import { BaseGenerator } from './base-generator';
 import { type AnyRule } from '../nodes';
+/**
+ * RuleGenerator is responsible for converting adblock rule ASTs to their string representation.
+ */
 export declare class RuleGenerator extends BaseGenerator {
     /**
      * Converts a rule AST to a string.

package/dist/types/marshalling-utils/comment/agent-comment-common.d.ts

@@ -6,8 +6,9 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum AgentCommentMarshallingMap {
-    Children = 1,
-    Start = 2,
-    End = 3
-}
+export declare const AgentCommentMarshallingMap: {
+    readonly Children: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type AgentCommentMarshallingMap = typeof AgentCommentMarshallingMap[keyof typeof AgentCommentMarshallingMap];

package/dist/types/marshalling-utils/comment/agent-common.d.ts

@@ -6,12 +6,13 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum AgentNodeMarshallingMap {
-    Adblock = 1,
-    Version = 2,
-    Start = 3,
-    End = 4
-}
+export declare const AgentNodeMarshallingMap: {
+    readonly Adblock: 1;
+    readonly Version: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type AgentNodeMarshallingMap = typeof AgentNodeMarshallingMap[keyof typeof AgentNodeMarshallingMap];
 /**
  * Value map for binary deserialization. This helps to reduce the size of the serialized data,
  * as it allows us to use a single byte to represent frequently used values.

package/dist/types/marshalling-utils/comment/config-comment-common.d.ts

@@ -6,14 +6,15 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum ConfigCommentRuleMarshallingMap {
-    Marker = 1,
-    Command = 2,
-    Params = 3,
-    Comment = 4,
-    Start = 5,
-    End = 6
-}
+export declare const ConfigCommentRuleMarshallingMap: {
+    readonly Marker: 1;
+    readonly Command: 2;
+    readonly Params: 3;
+    readonly Comment: 4;
+    readonly Start: 5;
+    readonly End: 6;
+};
+export type ConfigCommentRuleMarshallingMap = typeof ConfigCommentRuleMarshallingMap[keyof typeof ConfigCommentRuleMarshallingMap];
 /**
  * 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.
@@ -22,11 +23,12 @@ export declare const enum ConfigCommentRuleMarshallingMap {
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum ConfigNodeMarshallingMap {
-    Value = 1,
-    Start = 2,
-    End = 3
-}
+export declare const ConfigNodeMarshallingMap: {
+    readonly Value: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type ConfigNodeMarshallingMap = typeof ConfigNodeMarshallingMap[keyof typeof ConfigNodeMarshallingMap];
 /**
  * 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.

package/dist/types/marshalling-utils/comment/hint-comment-common.d.ts

@@ -6,9 +6,10 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum HintCommentMarshallingMap {
-    Syntax = 1,
-    Children = 2,
-    Start = 3,
-    End = 4
-}
+export declare const HintCommentMarshallingMap: {
+    readonly Syntax: 1;
+    readonly Children: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type HintCommentMarshallingMap = typeof HintCommentMarshallingMap[keyof typeof HintCommentMarshallingMap];

package/dist/types/marshalling-utils/comment/hint-common.d.ts

@@ -6,12 +6,13 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum HintNodeMarshallingMap {
-    Name = 1,
-    Params = 2,
-    Start = 3,
-    End = 4
-}
+export declare const HintNodeMarshallingMap: {
+    readonly Name: 1;
+    readonly Params: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type HintNodeMarshallingMap = typeof HintNodeMarshallingMap[keyof typeof HintNodeMarshallingMap];
 /**
  * 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.

package/dist/types/marshalling-utils/comment/metadata-comment-common.d.ts

@@ -6,13 +6,14 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum MetadataCommentMarshallingMap {
-    Marker = 1,
-    Header = 2,
-    Value = 3,
-    Start = 4,
-    End = 5
-}
+export declare const MetadataCommentMarshallingMap: {
+    readonly Marker: 1;
+    readonly Header: 2;
+    readonly Value: 3;
+    readonly Start: 4;
+    readonly End: 5;
+};
+export type MetadataCommentMarshallingMap = typeof MetadataCommentMarshallingMap[keyof typeof MetadataCommentMarshallingMap];
 /**
  * Value map for binary deserialization. This helps to reduce the size of the serialized data,
  * as it allows us to use a single byte to represent frequently used values.

package/dist/types/marshalling-utils/comment/pre-processor-comment-common.d.ts

@@ -6,13 +6,14 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum PreProcessorRuleMarshallingMap {
-    Name = 1,
-    Params = 2,
-    Syntax = 3,
-    Start = 4,
-    End = 5
-}
+export declare const PreProcessorRuleMarshallingMap: {
+    readonly Name: 1;
+    readonly Params: 2;
+    readonly Syntax: 3;
+    readonly Start: 4;
+    readonly End: 5;
+};
+export type PreProcessorRuleMarshallingMap = typeof PreProcessorRuleMarshallingMap[keyof typeof PreProcessorRuleMarshallingMap];
 /**
  * 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.

package/dist/types/marshalling-utils/comment/simple-comment-common.d.ts

@@ -6,9 +6,10 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum SimpleCommentMarshallingMap {
-    Marker = 1,
-    Text = 2,
-    Start = 3,
-    End = 4
-}
+export declare const SimpleCommentMarshallingMap: {
+    readonly Marker: 1;
+    readonly Text: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type SimpleCommentMarshallingMap = typeof SimpleCommentMarshallingMap[keyof typeof SimpleCommentMarshallingMap];

package/dist/types/marshalling-utils/cosmetic/body/abp-snippet-injection-body-common.d.ts

@@ -6,11 +6,12 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum AbpSnippetBodyMarshallingMap {
-    Children = 1,
-    Start = 2,
-    End = 3
-}
+export declare const AbpSnippetBodyMarshallingMap: {
+    readonly Children: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type AbpSnippetBodyMarshallingMap = typeof AbpSnippetBodyMarshallingMap[keyof typeof AbpSnippetBodyMarshallingMap];
 /**
  * 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.

package/dist/types/marshalling-utils/cosmetic/body/css-injection-body-common.d.ts

@@ -6,11 +6,12 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum CssInjectionRuleMarshallingMap {
-    SelectorList = 1,
-    DeclarationList = 2,
-    MediaQueryList = 3,
-    Remove = 4,
-    Start = 5,
-    End = 6
-}
+export declare const CssInjectionRuleMarshallingMap: {
+    readonly SelectorList: 1;
+    readonly DeclarationList: 2;
+    readonly MediaQueryList: 3;
+    readonly Remove: 4;
+    readonly Start: 5;
+    readonly End: 6;
+};
+export type CssInjectionRuleMarshallingMap = typeof CssInjectionRuleMarshallingMap[keyof typeof CssInjectionRuleMarshallingMap];

package/dist/types/marshalling-utils/cosmetic/body/element-hiding-body-common.d.ts

@@ -6,8 +6,9 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum ElementHidingRuleMarshallingMap {
-    SelectorList = 1,
-    Start = 2,
-    End = 3
-}
+export declare const ElementHidingRuleMarshallingMap: {
+    readonly SelectorList: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type ElementHidingRuleMarshallingMap = typeof ElementHidingRuleMarshallingMap[keyof typeof ElementHidingRuleMarshallingMap];

package/dist/types/marshalling-utils/cosmetic/cosmetic-rule-common.d.ts

@@ -6,16 +6,17 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum CosmeticRuleMarshallingMap {
-    Syntax = 1,
-    Exception = 2,
-    Separator = 3,
-    Modifiers = 4,
-    Domains = 5,
-    Body = 6,
-    Start = 7,
-    End = 8
-}
+export declare const CosmeticRuleMarshallingMap: {
+    readonly Syntax: 1;
+    readonly Exception: 2;
+    readonly Separator: 3;
+    readonly Modifiers: 4;
+    readonly Domains: 5;
+    readonly Body: 6;
+    readonly Start: 7;
+    readonly End: 8;
+};
+export type CosmeticRuleMarshallingMap = typeof CosmeticRuleMarshallingMap[keyof typeof CosmeticRuleMarshallingMap];
 /**
  * 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.

package/dist/types/marshalling-utils/empty-rule-common.d.ts

@@ -6,7 +6,8 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum EmptyRuleMarshallingMap {
-    Start = 1,
-    End = 2
-}
+export declare const EmptyRuleMarshallingMap: {
+    readonly Start: 1;
+    readonly End: 2;
+};
+export type EmptyRuleMarshallingMap = typeof EmptyRuleMarshallingMap[keyof typeof EmptyRuleMarshallingMap];

package/dist/types/marshalling-utils/filter-list-common.d.ts

@@ -6,8 +6,9 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum FilterListNodeMarshallingMap {
-    Children = 1,
-    Start = 2,
-    End = 3
-}
+export declare const FilterListNodeMarshallingMap: {
+    readonly Children: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type FilterListNodeMarshallingMap = typeof FilterListNodeMarshallingMap[keyof typeof FilterListNodeMarshallingMap];

package/dist/types/marshalling-utils/invalid-rule-common.d.ts

@@ -6,8 +6,9 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum InvalidRuleMarshallingMap {
-    Error = 1,
-    Start = 2,
-    End = 3
-}
+export declare const InvalidRuleMarshallingMap: {
+    readonly Error: 1;
+    readonly Start: 2;
+    readonly End: 3;
+};
+export type InvalidRuleMarshallingMap = typeof InvalidRuleMarshallingMap[keyof typeof InvalidRuleMarshallingMap];

package/dist/types/marshalling-utils/invalid-rule-error-node-common.d.ts

@@ -6,9 +6,10 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum InvalidRuleErrorNodeMarshallingMap {
-    Name = 1,
-    Message = 2,
-    Start = 3,
-    End = 4
-}
+export declare const InvalidRuleErrorNodeMarshallingMap: {
+    readonly Name: 1;
+    readonly Message: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type InvalidRuleErrorNodeMarshallingMap = typeof InvalidRuleErrorNodeMarshallingMap[keyof typeof InvalidRuleErrorNodeMarshallingMap];

package/dist/types/marshalling-utils/misc/binary-type-common.d.ts

@@ -3,54 +3,55 @@
  *
  * @note Values should be fit into 8 bits.
  */
-export declare const enum BinaryTypeMarshallingMap {
-    Null = 1,
-    Undefined = 2,
-    Boolean = 3,
-    Int = 4,
-    Float = 5,
-    NotANumber = 6,
-    String = 7,
-    FilterListNode = 8,
-    EmptyRule = 9,
-    InvalidRule = 10,
-    CommentRuleNode = 11,
-    AgentNode = 12,
-    AgentRuleNode = 13,
-    HintNode = 14,
-    HintRuleNode = 15,
-    MetadataCommentRuleNode = 16,
-    ConfigCommentRuleNode = 17,
-    PreProcessorCommentRuleNode = 18,
-    ConfigNode = 19,
-    NetworkRuleNode = 20,
-    HostRuleNode = 21,
-    ElementHidingRule = 22,
-    CssInjectionRule = 23,
-    ScriptletInjectionRule = 24,
-    JsInjectionRule = 25,
-    HtmlFilteringRule = 26,
-    ScriptletInjectionRuleBodyNode = 27,
-    ElementHidingRuleBody = 28,
-    CssInjectionRuleBody = 29,
-    HtmlFilteringRuleBody = 30,
-    JsInjectionRuleBody = 31,
-    ValueNode = 32,
-    RawNode = 33,
-    ModifierNode = 34,
-    ModifierListNode = 35,
-    ParameterListNode = 36,
-    DomainListNode = 37,
-    DomainNode = 38,
-    MethodListNode = 39,
-    MethodNode = 40,
-    StealthOptionListNode = 41,
-    StealthOptionNode = 42,
-    AppListNode = 43,
-    AppNode = 44,
-    HostnameListNode = 45,
-    InvalidRuleErrorNode = 46,
-    ExpressionVariableNode = 47,
-    ExpressionOperatorNode = 48,
-    ExpressionParenthesisNode = 49
-}
+export declare const BinaryTypeMarshallingMap: {
+    readonly Null: 1;
+    readonly Undefined: 2;
+    readonly Boolean: 3;
+    readonly Int: 4;
+    readonly Float: 5;
+    readonly NotANumber: 6;
+    readonly String: 7;
+    readonly FilterListNode: 8;
+    readonly EmptyRule: 9;
+    readonly InvalidRule: 10;
+    readonly CommentRuleNode: 11;
+    readonly AgentNode: 12;
+    readonly AgentRuleNode: 13;
+    readonly HintNode: 14;
+    readonly HintRuleNode: 15;
+    readonly MetadataCommentRuleNode: 16;
+    readonly ConfigCommentRuleNode: 17;
+    readonly PreProcessorCommentRuleNode: 18;
+    readonly ConfigNode: 19;
+    readonly NetworkRuleNode: 20;
+    readonly HostRuleNode: 21;
+    readonly ElementHidingRule: 22;
+    readonly CssInjectionRule: 23;
+    readonly ScriptletInjectionRule: 24;
+    readonly JsInjectionRule: 25;
+    readonly HtmlFilteringRule: 26;
+    readonly ScriptletInjectionRuleBodyNode: 27;
+    readonly ElementHidingRuleBody: 28;
+    readonly CssInjectionRuleBody: 29;
+    readonly HtmlFilteringRuleBody: 30;
+    readonly JsInjectionRuleBody: 31;
+    readonly ValueNode: 32;
+    readonly RawNode: 33;
+    readonly ModifierNode: 34;
+    readonly ModifierListNode: 35;
+    readonly ParameterListNode: 36;
+    readonly DomainListNode: 37;
+    readonly DomainNode: 38;
+    readonly MethodListNode: 39;
+    readonly MethodNode: 40;
+    readonly StealthOptionListNode: 41;
+    readonly StealthOptionNode: 42;
+    readonly AppListNode: 43;
+    readonly AppNode: 44;
+    readonly HostnameListNode: 45;
+    readonly InvalidRuleErrorNode: 46;
+    readonly ExpressionVariableNode: 47;
+    readonly ExpressionOperatorNode: 48;
+    readonly ExpressionParenthesisNode: 49;
+};
+export type BinaryTypeMarshallingMap = typeof BinaryTypeMarshallingMap[keyof typeof BinaryTypeMarshallingMap];

package/dist/types/marshalling-utils/misc/domain-list-common.d.ts

@@ -6,12 +6,13 @@
  *
  * @note Only 256 values can be represented this way.
  */
-export declare const enum DomainListMarshallingMap {
-    Separator = 1,
-    Children = 2,
-    Start = 3,
-    End = 4
-}
+export declare const DomainListMarshallingMap: {
+    readonly Separator: 1;
+    readonly Children: 2;
+    readonly Start: 3;
+    readonly End: 4;
+};
+export type DomainListMarshallingMap = typeof DomainListMarshallingMap[keyof typeof DomainListMarshallingMap];
 /**
  * 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.