import type { Node } from 'web-tree-sitter';
import type { ArgumentsNode } from './arguments.js';
import type { NameNode } from './name.js';
const TYPE = 'directive' as const;



// ================================================================
// ================================================================
//
//                           DirectiveNode
//
//        GraphQL directive node
//
// ================================================================
// ================================================================


/**
 * Represents a directive in the GraphQL AST.
 * 
 * Children:
 *   {@link ArgumentsNode}, {@link NameNode}
 * 
 */
export interface DirectiveNode extends Node {
  type: typeof TYPE;
}


// ================================================================
// ================================================================
//
//                           Type Guard
//
// ================================================================
// ================================================================


/**
 * Type guard to check if a node is a {@link DirectiveNode}.
 * 
 * @param node - The node to check
 * @returns True if the node is a {@link DirectiveNode}
 * 
 * @example
 * ```typescript
 * if (isDirectiveNode(node)) {
 *   // TypeScript now knows node is DirectiveNode
 *   console.log(node.type); // 'directive'
 * }
 * ```
 */
export function isDirectiveNode(node: unknown): node is DirectiveNode {
  return (node as any)?.type === TYPE;
}


// ================================================================
// ================================================================
//
//                           Constructor
//
// ================================================================
// ================================================================


/**
 * Creates a new {@link DirectiveNode} with the specified properties.
 * 
 * @param props - The node properties
 * @param props.arguments - {@link ArgumentsNode}
 * @param props.name - {@link NameNode}
 * @returns A new {@link DirectiveNode}
 * 
 * @example
 * ```typescript
 * const node = DirectiveNode({
 *   // properties...
 * });
 * ```
 */
export function DirectiveNode(props: Omit<DirectiveNode, 'type'>): DirectiveNode {
  return {
    type: TYPE,
    ...props
  };
}