@adguard/agtree 4.0.0 → 4.0.2

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

@@ -1,5 +1,5 @@
-import { BaseGenerator } from '../base-generator.js';
 import type { ModifierList } from '../../nodes/index.js';
+import { BaseGenerator } from '../base-generator.js';
 /**
  * Generator for modifier list nodes.
  */
@@ -7,8 +7,9 @@ export declare class ModifierListGenerator extends BaseGenerator {
     /**
      * Converts a modifier list AST to a string.
      *
-     * @param ast Modifier list AST
-     * @returns Raw string
+     * @param ast Modifier list AST.
+     *
+     * @returns Raw string.
      */
     static generate(ast: ModifierList): string;
 }

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

@@ -7,10 +7,11 @@ export declare class ParameterListGenerator extends BaseGenerator {
     /**
      * Converts a parameter list AST to a string.
      *
-     * @param params Parameter list AST
-     * @param separator Separator character (default: comma)
-     * @param allowSpace Allow space between parameters (default: true)
-     * @returns String representation of the parameter list
+     * @param params Parameter list AST.
+     * @param separator Separator character (default: comma).
+     * @param allowSpace Allow space between parameters (default: true).
+     *
+     * @returns String representation of the parameter list.
      */
     static generate(params: ParameterList, separator?: string, allowSpace?: boolean): string;
 }

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

@@ -8,6 +8,7 @@ export declare class ValueGenerator extends BaseGenerator {
      * Converts a value node to a string.
      *
      * @param node Value node.
+     *
      * @returns Raw string.
      */
     static generate(node: Value): string;

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

@@ -8,6 +8,7 @@ export declare class HostRuleGenerator extends BaseGenerator {
      * Converts a host rule node to a raw string.
      *
      * @param node Host rule node.
+     *
      * @returns Raw string.
      */
     static generate(node: HostRule): string;

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

@@ -8,6 +8,7 @@ export declare class NetworkRuleGenerator extends BaseGenerator {
      * Generates a string from a network rule AST node.
      *
      * @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,5 @@
-import { BaseGenerator } from './base-generator.js';
 import { type AnyRule } from '../nodes/index.js';
+import { BaseGenerator } from './base-generator.js';
 /**
  * RuleGenerator is responsible for converting adblock rule ASTs to their string representation.
  */
@@ -7,8 +7,10 @@ export declare class RuleGenerator extends BaseGenerator {
     /**
      * Converts a rule AST to a string.
      *
-     * @param ast - Adblock rule AST
-     * @returns Raw string
+     * @param ast Adblock rule AST.
+     *
+     * @returns Raw string.
+     *
      * @example
      * Take a look at the following example:
      * ```js

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * @file AGTree entry point
+ * @file AGTree entry point.
  */
 export { RuleParser } from './parser/rule-parser.js';
 export { RuleGenerator } from './generator/rule-generator.js';
@@ -28,7 +28,6 @@ export { ParameterListParser } from './parser/misc/parameter-list-parser.js';
 export { HostRuleParser } from './parser/network/host-rule-parser.js';
 export { PreProcessorCommentParser } from './parser/comment/preprocessor-parser.js';
 export { RuleConversionError } from './errors/rule-conversion-error.js';
-export { BinarySchemaMismatchError } from './errors/binary-schema-mismatch-error.js';
 export { modifierValidator } from './validator/index.js';
 export * from './converter/index.js';
 export { ADG_SCRIPTLET_MASK, AGLINT_COMMAND_PREFIX, COMMA_DOMAIN_LIST_SEPARATOR, NEGATION_MARKER, HINT_MARKER, IF, INCLUDE, MODIFIERS_SEPARATOR, MODIFIER_ASSIGN_OPERATOR, PIPE_MODIFIER_SEPARATOR, NETWORK_RULE_EXCEPTION_MARKER, NETWORK_RULE_SEPARATOR, PREPROCESSOR_MARKER, SAFARI_CB_AFFINITY, UBO_SCRIPTLET_MASK, } from './utils/constants.js';

package/dist/types/nodes/index.d.ts

@@ -266,7 +266,7 @@ export interface Raw extends Node {
 export interface ParameterList extends Node {
     type: 'ParameterList';
     /**
-     * List of values
+     * List of values.
      *
      * @note `null` values are allowed in the list, they represent empty parameters.
      */
@@ -301,7 +301,7 @@ export interface ExpressionParenthesisNode extends Node {
 export interface FilterList extends Node {
     type: 'FilterList';
     /**
-     * List of rules
+     * List of rules.
      */
     children: AnyRule[];
 }
@@ -316,19 +316,19 @@ export interface RuleBase extends Node {
      */
     syntax: AdblockSyntax;
     /**
-     * Category of the adblock rule
+     * Category of the adblock rule.
      */
     category: RuleCategory;
     /**
-     * Raw data of the rule
+     * Raw data of the rule.
      */
     raws?: {
         /**
-         * Original rule text
+         * Original rule text.
          */
         text?: string;
         /**
-         * Newline character used in the rule (if any)
+         * Newline character used in the rule (if any).
          */
         nl?: NewLine;
     };
@@ -336,11 +336,11 @@ export interface RuleBase extends Node {
 export interface InvalidRuleError extends Node {
     type: 'InvalidRuleError';
     /**
-     * Error name
+     * Error name.
      */
     name: string;
     /**
-     * Error message
+     * Error message.
      */
     message: string;
 }
@@ -350,28 +350,28 @@ export interface InvalidRuleError extends Node {
 export interface InvalidRule extends RuleBase {
     type: 'InvalidRule';
     /**
-     * Category of the adblock rule
+     * Category of the adblock rule.
      */
     category: typeof RuleCategory.Invalid;
     /**
-     * Raw rule text
+     * Raw rule text.
      */
     raw: string;
     /**
-     * Error details
+     * Error details.
      */
     error: InvalidRuleError;
 }
 /**
- * Represents an "empty rule" (practically an empty line)
+ * Represents an "empty rule" (practically an empty line).
  */
 export interface EmptyRule extends RuleBase {
     /**
-     * Type of the adblock rule (should be always present)
+     * Type of the adblock rule (should be always present).
      */
     type: 'EmptyRule';
     /**
-     * Category of the adblock rule
+     * Category of the adblock rule.
      */
     category: typeof RuleCategory.Empty;
 }
@@ -516,11 +516,11 @@ export interface PreProcessorCommentRule extends CommentBase {
     category: typeof RuleCategory.Comment;
     type: typeof CommentRuleType.PreProcessorCommentRule;
     /**
-     * Name of the directive
+     * Name of the directive.
      */
     name: Value;
     /**
-     * Params (optional)
+     * Params (optional).
      */
     params?: Value | ParameterList | AnyExpressionNode;
 }
@@ -640,15 +640,15 @@ export interface ModifierList extends Node {
  */
 export interface Modifier extends Node {
     /**
-     * Modifier name
+     * Modifier name.
      */
     name: Value;
     /**
-     * Is this modifier an exception? For example, `~third-party` is an exception
+     * Is this modifier an exception? For example, `~third-party` is an exception.
      */
     exception?: boolean;
     /**
-     * Modifier value (optional)
+     * Modifier value (optional).
      */
     value?: Value;
 }
@@ -721,7 +721,7 @@ export type AnyListItem = App | Domain | Method | StealthOption;
  */
 export interface DomainList extends Node {
     /**
-     * Type of the node. Basically, the idea is that each main AST part should have a type
+     * Type of the node. Basically, the idea is that each main AST part should have a type.
      */
     type: typeof ListNodeType.DomainList;
     /**
@@ -729,7 +729,7 @@ export interface DomainList extends Node {
      */
     separator: DomainListSeparator;
     /**
-     * List of domains
+     * List of domains.
      */
     children: Domain[];
 }
@@ -742,7 +742,7 @@ export interface DomainList extends Node {
  */
 export interface AppList extends Node {
     /**
-     * Type of the node. Basically, the idea is that each main AST part should have a type
+     * Type of the node. Basically, the idea is that each main AST part should have a type.
      */
     type: typeof ListNodeType.AppList;
     /**
@@ -750,7 +750,7 @@ export interface AppList extends Node {
      */
     separator: PipeSeparator;
     /**
-     * List of apps
+     * List of apps.
      */
     children: App[];
 }
@@ -763,7 +763,7 @@ export interface AppList extends Node {
  */
 export interface MethodList extends Node {
     /**
-     * Type of the node. Basically, the idea is that each main AST part should have a type
+     * Type of the node. Basically, the idea is that each main AST part should have a type.
      */
     type: typeof ListNodeType.MethodList;
     /**
@@ -771,7 +771,7 @@ export interface MethodList extends Node {
      */
     separator: PipeSeparator;
     /**
-     * List of methods
+     * List of methods.
      */
     children: Method[];
 }
@@ -784,7 +784,7 @@ export interface MethodList extends Node {
  */
 export interface StealthOptionList extends Node {
     /**
-     * Type of the node. Basically, the idea is that each main AST part should have a type
+     * Type of the node. Basically, the idea is that each main AST part should have a type.
      */
     type: typeof ListNodeType.StealthOptionList;
     /**
@@ -792,7 +792,7 @@ export interface StealthOptionList extends Node {
      */
     separator: PipeSeparator;
     /**
-     * List of stealth options
+     * List of stealth options.
      */
     children: StealthOption[];
 }
@@ -835,7 +835,7 @@ export interface CssInjectionRuleBody extends Node {
      */
     declarationList?: Value;
     /**
-     * Remove flag
+     * Remove flag.
      */
     remove?: boolean;
 }
@@ -1036,7 +1036,7 @@ export interface CosmeticRule extends RuleBase {
     category: typeof RuleCategory.Cosmetic;
     type: CosmeticRuleType;
     /**
-     * List of modifiers (optional)
+     * List of modifiers (optional).
      */
     modifiers?: ModifierList;
     /**
@@ -1070,16 +1070,16 @@ export interface CosmeticRule extends RuleBase {
  * Example rules:
  * - ```adblock
  *   example.com##.ads
- *   ```
+ *   ```.
  * - ```adblock
  *   example.com#@#.ads
- *   ```
+ *   ```.
  * - ```adblock
  *   example.com#?#.ads:has(> .something)
- *   ```
+ *   ```.
  * - ```adblock
  *   example.com#@?#.ads:has(> .something)
- *   ```
+ *   ```.
  */
 export interface ElementHidingRule extends CosmeticRule {
     type: typeof CosmeticRuleType.ElementHidingRule;
@@ -1091,24 +1091,24 @@ export interface ElementHidingRule extends CosmeticRule {
  * Example rules (AdGuard):
  *  - ```adblock
  *    example.com#$#body { padding-top: 0 !important; }
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#$#@media (min-width: 1024px) { body { padding-top: 0 !important; } }
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#$?#@media (min-width: 1024px) { .something:has(.ads) { padding-top: 0 !important; } }
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#$#.ads { remove: true; }
- *    ```
+ *    ```.
  *
  * Example rules (uBlock Origin):
  *  - ```adblock
  *    example.com##body:style(padding-top: 0 !important;)
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com##.ads:remove()
- *    ```
+ *    ```.
  */
 export interface CssInjectionRule extends CosmeticRule {
     type: typeof CosmeticRuleType.CssInjectionRule;
@@ -1120,29 +1120,29 @@ export interface CssInjectionRule extends CosmeticRule {
  * Example rules (AdGuard):
  *  - ```adblock
  *    example.com#%#//scriptlet('scriptlet-name', 'arg0', 'arg1')
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#@%#//scriptlet('scriptlet-name', 'arg0', 'arg1')
- *    ```
+ *    ```.
  *
  * Example rules (uBlock Origin):
  *  - ```adblock
  *    example.com##+js(scriptlet-name, arg0, arg1)
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#@#+js(scriptlet-name, arg0, arg1)
- *    ```
+ *    ```.
  *
  * Example rules (Adblock Plus):
  *  - ```adblock
  *    example.com#$#scriptlet-name arg0 arg1
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#@$#scriptlet-name arg0 arg1
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#$#scriptlet0 arg00 arg01; scriptlet1 arg10 arg11
- *    ```
+ *    ```.
  */
 export interface ScriptletInjectionRule extends CosmeticRule {
     type: typeof CosmeticRuleType.ScriptletInjectionRule;
@@ -1154,18 +1154,18 @@ export interface ScriptletInjectionRule extends CosmeticRule {
  * Example rules (AdGuard):
  *  - ```adblock
  *    example.com$$script[tag-content="detect"]
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com$@$script[tag-content="detect"]
- *    ```
+ *    ```.
  *
  * Example rules (uBlock Origin):
  *  - ```adblock
  *    example.com##^script:has-text(detect)
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#@#^script:has-text(detect)
- *    ```
+ *    ```.
  */
 export interface HtmlFilteringRule extends CosmeticRule {
     type: typeof CosmeticRuleType.HtmlFilteringRule;
@@ -1177,10 +1177,10 @@ export interface HtmlFilteringRule extends CosmeticRule {
  * Example rules (AdGuard):
  *  - ```adblock
  *    example.com#%#let a = 2;
- *    ```
+ *    ```.
  *  - ```adblock
  *    example.com#@%#let a = 2;
- *    ```
+ *    ```.
  */
 export interface JsInjectionRule extends CosmeticRule {
     type: typeof CosmeticRuleType.JsInjectionRule;
@@ -1195,7 +1195,7 @@ export declare const NetworkRuleType: {
 };
 export type NetworkRuleType = typeof NetworkRuleType[keyof typeof NetworkRuleType];
 /**
- * Represents the common properties of network rules
+ * Represents the common properties of network rules.
  */
 export interface NetworkRuleBase extends RuleBase {
     /**
@@ -1213,7 +1213,7 @@ export interface NetworkRuleBase extends RuleBase {
     syntax: AdblockSyntax;
 }
 /**
- * Represents the common properties of network rules
+ * Represents the common properties of network rules.
  */
 export interface NetworkRule extends NetworkRuleBase {
     /**
@@ -1296,6 +1296,7 @@ export interface HostRule extends NetworkRuleBase {
      * 127.0.0.1 example.com example.org
      * ↑↑↑↑↑↑↑↑↑
      * ```
+     *
      * @note If IP is not specified in the rule, it parsed as null IP: `0.0.0.0`.
      */
     ip: Value;

package/dist/types/parser/comment/agent-comment-parser.d.ts

@@ -26,8 +26,9 @@ export declare class AgentCommentParser extends BaseParser {
     /**
      * Checks if the raw rule is an adblock agent comment.
      *
-     * @param raw Raw rule
-     * @returns `true` if the rule is an adblock agent, `false` otherwise
+     * @param raw Raw rule.
+     *
+     * @returns `true` if the rule is an adblock agent, `false` otherwise.
      */
     static isAgentRule(raw: string): boolean;
     /**
@@ -36,7 +37,8 @@ export declare class AgentCommentParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Agent rule AST or null (if the raw rule cannot be parsed as an adblock agent comment)
+     *
+     * @returns Agent rule AST or null (if the raw rule cannot be parsed as an adblock agent comment).
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): AgentCommentRule | null;
 }

package/dist/types/parser/comment/agent-parser.d.ts

@@ -23,8 +23,9 @@ export declare class AgentParser extends BaseParser {
      * The string can have a version in formats like
      * [Adblock Plus 2.0], or [Adblock Plus 3.1; AdGuard].
      *
-     * @param str String to check
-     * @returns `true` if the string is a valid version, `false` otherwise
+     * @param str String to check.
+     *
+     * @returns `true` if the string is a valid version, `false` otherwise.
      */
     private static isValidVersion;
     /**
@@ -33,8 +34,10 @@ export declare class AgentParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Agent rule AST
-     * @throws {AdblockSyntaxError} If the raw rule cannot be parsed as an adblock agent
+     *
+     * @returns Agent rule AST.
+     *
+     * @throws {AdblockSyntaxError} If the raw rule cannot be parsed as an adblock agent.
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): Agent;
 }

package/dist/types/parser/comment/comment-parser.d.ts

@@ -60,8 +60,9 @@ export declare class CommentParser extends BaseParser {
     /**
      * Checks whether a rule is a comment.
      *
-     * @param raw Raw rule
-     * @returns `true` if the rule is a comment, `false` otherwise
+     * @param raw Raw rule.
+     *
+     * @returns `true` if the rule is a comment, `false` otherwise.
      */
     static isCommentRule(raw: string): boolean;
     /**
@@ -70,7 +71,8 @@ export declare class CommentParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Comment AST or null (if the raw rule cannot be parsed as comment)
+     *
+     * @returns Comment AST or null (if the raw rule cannot be parsed as comment).
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): AnyCommentRule | null;
 }

package/dist/types/parser/comment/config-comment-parser.d.ts

@@ -1,5 +1,6 @@
 /**
  * @file AGLint configuration comments. Inspired by ESLint inline configuration comments.
+ *
  * @see {@link https://eslint.org/docs/latest/user-guide/configuring/rules#using-configuration-comments}
  */
 import { type ConfigCommentRule } from '../../nodes/index.js';
@@ -14,7 +15,8 @@ export declare class ConfigCommentParser extends BaseParser {
     /**
      * Checks if the raw rule is an inline configuration comment rule.
      *
-     * @param raw Raw rule
+     * @param raw Raw rule.
+     *
      * @returns `true` if the rule is an inline configuration comment rule, otherwise `false`.
      */
     static isConfigComment(raw: string): boolean;
@@ -24,8 +26,9 @@ export declare class ConfigCommentParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
+     *
      * @returns
-     * Inline configuration comment AST or null (if the raw rule cannot be parsed as configuration comment)
+     * Inline configuration comment AST or null (if the raw rule cannot be parsed as configuration comment).
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): ConfigCommentRule | null;
 }

package/dist/types/parser/comment/hint-comment-parser.d.ts

@@ -3,31 +3,36 @@ import { BaseParser } from '../base-parser.js';
 /**
  * `HintRuleParser` is responsible for parsing AdGuard hint rules.
  *
+ * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#hints}
+ *
  * @example
  * The following hint rule
  * ```adblock
  * !+ NOT_OPTIMIZED PLATFORM(windows)
  * ```
  * contains two hints: `NOT_OPTIMIZED` and `PLATFORM`.
- * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#hints}
  */
 export declare class HintCommentParser extends BaseParser {
     /**
      * Checks if the raw rule is a hint rule.
      *
-     * @param raw Raw rule
-     * @returns `true` if the rule is a hint rule, `false` otherwise
+     * @param raw Raw rule.
+     *
+     * @returns `true` if the rule is a hint rule, `false` otherwise.
      */
     static isHintRule(raw: string): boolean;
     /**
      * Parses a raw rule as a hint comment.
      *
+     * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#hints-1}
+     *
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Hint AST or null (if the raw rule cannot be parsed as a hint comment)
-     * @throws If the input matches the HINT pattern but syntactically invalid
-     * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#hints-1}
+     *
+     * @returns Hint AST or null (if the raw rule cannot be parsed as a hint comment).
+     *
+     * @throws If the input matches the HINT pattern but syntactically invalid.
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): HintCommentRule | null;
 }

package/dist/types/parser/comment/hint-parser.d.ts

@@ -1,5 +1,6 @@
 /**
- * @file AdGuard Hints
+ * @file AdGuard Hints.
+ *
  * @see {@link https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#hints}
  */
 import { type Hint } from '../../nodes/index.js';
@@ -23,8 +24,10 @@ export declare class HintParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Hint rule AST or null
-     * @throws If the syntax is invalid
+     *
+     * @returns Hint rule AST or null.
+     *
+     * @throws If the syntax is invalid.
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): Hint;
 }

package/dist/types/parser/comment/metadata-comment-parser.d.ts

@@ -1,5 +1,5 @@
 /**
- * @file Metadata comments
+ * @file Metadata comments.
  */
 import { type MetadataCommentRule } from '../../nodes/index.js';
 import { BaseParser } from '../base-parser.js';
@@ -7,6 +7,8 @@ import { BaseParser } from '../base-parser.js';
  * `MetadataParser` is responsible for parsing metadata comments.
  * Metadata comments are special comments that specify some properties of the list.
  *
+ * @see {@link https://help.eyeo.com/adblockplus/how-to-write-filters#special-comments}
+ *
  * @example
  * For example, in the case of
  * ```adblock
@@ -14,7 +16,6 @@ import { BaseParser } from '../base-parser.js';
  * ```
  * 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}
  */
 export declare class MetadataCommentParser extends BaseParser {
     /**
@@ -23,7 +24,8 @@ export declare class MetadataCommentParser extends BaseParser {
      * @param raw Raw input to parse.
      * @param options Global parser options.
      * @param baseOffset Starting offset of the input. Node locations are calculated relative to this offset.
-     * @returns Metadata comment AST or null (if the raw rule cannot be parsed as a metadata comment)
+     *
+     * @returns Metadata comment AST or null (if the raw rule cannot be parsed as a metadata comment).
      */
     static parse(raw: string, options?: import("../index.js").ParserOptions, baseOffset?: number): MetadataCommentRule | null;
 }