{
  "rules": ["||example.org^$third-party", "@@||safe.example.com^"],
  "text": "||example.org^
! A comment",
  "nodeTypes": ["NetworkRule", "Modifier"],
  "maxDepth": 10,
  "includeContext": true,
  "turnstileToken": "<optional>"
}

{
  "success": true,
  "nodes": [
    {
      "type": "FilterList",
      "depth": 0,
      "node": { "type": "FilterList", "children": [ ... ] }
    },
    {
      "type": "NetworkRule",
      "depth": 1,
      "key": "children",
      "index": 0,
      "node": { "type": "NetworkRule", "pattern": { ... }, "modifiers": { ... } }
    },
    {
      "type": "Modifier",
      "depth": 3,
      "key": "children",
      "index": 0,
      "node": { "type": "Modifier", "name": { ... }, "value": { ... } }
    }
  ],
  "summary": {
    "FilterList": 1,
    "NetworkRule": 2,
    "Modifier": 3,
    "total": 6
  },
  "duration": "4ms"
}

curl -X POST https://api.bloqr.dev/api/ast/walk \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": [
      "||example.org^$third-party,domain=example.net",
      "@@||safe.example.com^$important"
    ],
    "nodeTypes": ["Modifier"]
  }'

curl -X POST https://api.bloqr.dev/api/ast/walk \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "||example.org^
example.com##.banner",
    "maxDepth": 3,
    "includeContext": true
  }'

echo '||example.org^$domain=foo.com' | deno run ... src/cli/CliApp.deno.ts --ast-walk

echo '||example.org^$domain=foo.com' | deno run ... src/cli/CliApp.deno.ts \
  --ast-walk \
  --ast-walk-types NetworkRule \
  --ast-walk-types Modifier

deno run ... src/cli/CliApp.deno.ts \
  --ast-walk \
  --input rules.txt \
  --ast-walk-depth 3

cat my-filter-list.txt | deno run ... src/cli/CliApp.deno.ts --ast-walk | jq '.summary'

{
  "nodes": [
    { "type": "FilterList", "depth": 0, "key": null, "index": null, "node": { ... } },
    { "type": "NetworkRule", "depth": 1, "key": "children", "index": 0, "node": { ... } }
  ],
  "summary": {
    "FilterList": 1,
    "NetworkRule": 1,
    "total": 2
  }
}

import { walkAGTree } from '../utils/AGTreeParser.ts';

// Generic callback — visits every node in pre-order
walkAGTree(filterList, (node, ctx) => {
    console.log(ctx.depth, node.type);
});

// Halt traversal early by returning false
let firstNetworkRule: Node | undefined;
walkAGTree(filterList, (node) => {
    if (node.type === 'NetworkRule') {
        firstNetworkRule = node;
        return false; // stop
    }
});

import { AGTreeParser } from '../utils/AGTreeParser.ts';

// Typed visitor map — only specified handlers are invoked
const excludedDomains: string[] = [];
AGTreeParser.walkDeep(filterList, {
    Domain(d) {
        if (d.exception) excludedDomains.push(d.value);
    },
});

// Catch-all handler for any unspecified node types
AGTreeParser.walkDeep(filterList, {
    Modifier(m) { /* ... */ },
    '*'(node) { /* all other types */ },
});

export interface WalkContext {
    /** The parent node, or null if this is the root. */
    parent: Node | null;
    /** The property name on the parent holding this node (e.g. 'children', 'body', 'modifiers'). */
    key: string | null;
    /** Zero-based index within the parent array property; null for non-array properties. */
    index: number | null;
    /** Zero-based traversal depth (root node = 0). */
    depth: number;
}

AGTreeParser.walkDeep(filterList, {
    NetworkRule(node, ctx)             { /* ... */ },
    HostRule(node, ctx)                { /* ... */ },
    Modifier(node, ctx)                { /* ... */ },
    Domain(node, ctx)                  { /* ... */ },
    ElementHidingRule(node, ctx)       { /* ... */ },
    ScriptletInjectionRule(node, ctx)  { /* ... */ },
    CommentRule(node, ctx)             { /* ... */ },
    PreProcessorCommentRule(node, ctx) { /* ... */ },
    // ... etc.
    '*'(node, ctx)                     { /* catch-all */ },
});