@wroud/navigation/src/pattern-matching/TrieNode.ts

A flexible, pattern-matching navigation system for JavaScript applications with built-in routing, browser integration, and navigation state management

import type { NodeType } from "./types.js";

/**
 * TrieNode represents a node in the pattern matching trie
 */
export class TrieNode {
  readonly type: NodeType;
  readonly name: string;
  readonly children: Map<string, TrieNode>;
  paramChild: TrieNode | null;
  wildcardChild: TrieNode | null;
  /** Type of the parameter for param/wildcard nodes */
  paramType: string;
  isEndOfPattern: boolean;
  pattern: string | null;
  parent: TrieNode | null;

  constructor(
    type: NodeType = "static",
    name: string = "",
    parent: TrieNode | null = null,
    paramType: string = "string",
  ) {
    this.type = type;
    this.name = name;
    this.children = new Map();
    this.paramChild = null;
    this.wildcardChild = null;
    this.paramType = paramType;
    this.isEndOfPattern = false;
    this.pattern = null;
    this.parent = parent;
  }

  /**
   * Mark this node as the end of a pattern
   */
  markAsPatternEnd(pattern: string): this {
    this.isEndOfPattern = true;
    this.pattern = pattern;
    return this;
  }

  /**
   * Get a static child node by segment name
   */
  getStaticChild(segment: string): TrieNode | undefined {
    return this.children.get(segment);
  }

  /**
   * Check if this node has a static child for the given segment
   */
  hasStaticChild(segment: string): boolean {
    return this.children.has(segment);
  }

  /**
   * Add a static child node for the given segment
   */
  addStaticChild(segment: string): TrieNode {
    // Check if child already exists
    const existingChild = this.children.get(segment);
    if (existingChild) {
      return existingChild;
    }

    // Create a new child node with this as parent
    const child = new TrieNode("static", segment, this);
    this.children.set(segment, child);
    return child;
  }

  /**
   * Get or create a parameter child node
   *
   * @param paramName Parameter name
   * @param paramType Declared parameter type
   */
  getOrCreateParamChild(paramName: string, paramType: string): TrieNode {
    if (!this.paramChild) {
      this.paramChild = new TrieNode("param", paramName, this, paramType);
    }
    return this.paramChild;
  }

  /**
   * Get or create a wildcard child node
   *
   * @param wildcardName Parameter name for the wildcard
   * @param paramType Declared parameter type
   */
  getOrCreateWildcardChild(wildcardName: string, paramType: string): TrieNode {
    if (!this.wildcardChild) {
      this.wildcardChild = new TrieNode(
        "wildcard",
        wildcardName,
        this,
        paramType,
      );
    }
    return this.wildcardChild;
  }

  /**
   * Find all patterns that are ancestors of this node
   */
  findAncestorPatterns(): string[] {
    let current = this.parent;
    const ancestors: string[] = [];

    while (current) {
      if (current.isEndOfPattern && current.pattern) {
        ancestors.push(current.pattern);
      }
      current = current.parent;
    }

    return ancestors;
  }
}