xlucene-parser 1.10.2 → 1.10.3

package/dist/src/cached-parser.d.ts

@@ -1,8 +1,71 @@
 import { ParserOptions, Node } from './interfaces.js';
 import { Parser } from './parser.js';
+/**
+ * A caching wrapper around the Parser class for improved performance.
+ *
+ * CachedParser maintains an internal cache of parsed queries to avoid
+ * re-parsing identical query strings. This is particularly useful when
+ * the same queries are parsed repeatedly.
+ *
+ * @example
+ * ```typescript
+ * const cache = new CachedParser();
+ *
+ * // First parse - creates and caches the parser
+ * const parser1 = cache.make('name:John');
+ *
+ * // Second parse - returns cached parser
+ * const parser2 = cache.make('name:John');
+ *
+ * console.log(parser1 === parser2); // true
+ * ```
+ */
 export declare class CachedParser {
     constructor();
+    /**
+     * Create or retrieve a cached Parser instance for the given query.
+     *
+     * The cache key is based on the query string and type configuration.
+     * If a parser for the same query and configuration exists in the cache,
+     * it will be returned instead of creating a new one.
+     *
+     * @param query - The xLucene query string to parse
+     * @param options - Optional configuration for parsing behavior
+     * @param _overrideParsedQuery - Internal parameter for providing pre-parsed AST
+     * @returns A Parser instance (cached or newly created)
+     *
+     * @example
+     * ```typescript
+     * const cache = new CachedParser();
+     *
+     * // Create parser with type configuration
+     * const parser = cache.make('age:25', {
+     *   type_config: { age: 'integer' }
+     * });
+     *
+     * // Same query and config returns cached parser
+     * const cachedParser = cache.make('age:25', {
+     *   type_config: { age: 'integer' }
+     * });
+     * ```
+     */
     make(query: string, options?: ParserOptions, _overrideParsedQuery?: Node): Parser;
+    /**
+     * Clear all cached parsers.
+     *
+     * This method removes all entries from the internal cache, forcing
+     * subsequent calls to `make()` to create new Parser instances.
+     *
+     * @example
+     * ```typescript
+     * const cache = new CachedParser();
+     * cache.make('name:John'); // Creates and caches parser
+     *
+     * cache.reset(); // Clear cache
+     *
+     * cache.make('name:John'); // Creates new parser (not cached)
+     * ```
+     */
     reset(): void;
 }
 //# sourceMappingURL=cached-parser.d.ts.map

package/dist/src/cached-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cached-parser.d.ts","sourceRoot":"","sources":["../../src/cached-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAKrC,qBAAa,YAAY;;IAKrB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,oBAAoB,CAAC,EAAE,IAAI,GAAG,MAAM;IAajF,KAAK,IAAI,IAAI;CAIhB"}
+{"version":3,"file":"cached-parser.d.ts","sourceRoot":"","sources":["../../src/cached-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAKrC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAY;;IAKrB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,oBAAoB,CAAC,EAAE,IAAI,GAAG,MAAM;IAajF;;;;;;;;;;;;;;;OAeG;IACH,KAAK,IAAI,IAAI;CAIhB"}

package/dist/src/cached-parser.js

@@ -1,9 +1,56 @@
 import { Parser } from './parser.js';
 const _cache = new WeakMap();
+/**
+ * A caching wrapper around the Parser class for improved performance.
+ *
+ * CachedParser maintains an internal cache of parsed queries to avoid
+ * re-parsing identical query strings. This is particularly useful when
+ * the same queries are parsed repeatedly.
+ *
+ * @example
+ * ```typescript
+ * const cache = new CachedParser();
+ *
+ * // First parse - creates and caches the parser
+ * const parser1 = cache.make('name:John');
+ *
+ * // Second parse - returns cached parser
+ * const parser2 = cache.make('name:John');
+ *
+ * console.log(parser1 === parser2); // true
+ * ```
+ */
 export class CachedParser {
     constructor() {
         _cache.set(this, new Map());
     }
+    /**
+     * Create or retrieve a cached Parser instance for the given query.
+     *
+     * The cache key is based on the query string and type configuration.
+     * If a parser for the same query and configuration exists in the cache,
+     * it will be returned instead of creating a new one.
+     *
+     * @param query - The xLucene query string to parse
+     * @param options - Optional configuration for parsing behavior
+     * @param _overrideParsedQuery - Internal parameter for providing pre-parsed AST
+     * @returns A Parser instance (cached or newly created)
+     *
+     * @example
+     * ```typescript
+     * const cache = new CachedParser();
+     *
+     * // Create parser with type configuration
+     * const parser = cache.make('age:25', {
+     *   type_config: { age: 'integer' }
+     * });
+     *
+     * // Same query and config returns cached parser
+     * const cachedParser = cache.make('age:25', {
+     *   type_config: { age: 'integer' }
+     * });
+     * ```
+     */
     make(query, options, _overrideParsedQuery) {
         const typeConfigKey = options?.type_config ? JSON.stringify(options.type_config) : '';
         const key = `${query}${typeConfigKey}`;
@@ -15,6 +62,22 @@ export class CachedParser {
         cached.set(key, parsed);
         return parsed;
     }
+    /**
+     * Clear all cached parsers.
+     *
+     * This method removes all entries from the internal cache, forcing
+     * subsequent calls to `make()` to create new Parser instances.
+     *
+     * @example
+     * ```typescript
+     * const cache = new CachedParser();
+     * cache.make('name:John'); // Creates and caches parser
+     *
+     * cache.reset(); // Clear cache
+     *
+     * cache.make('name:John'); // Creates new parser (not cached)
+     * ```
+     */
     reset() {
         const cached = _cache.get(this);
         cached.clear();

package/dist/src/cached-parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"cached-parser.js","sourceRoot":"","sources":["../../src/cached-parser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,MAAM,MAAM,GAAG,IAAI,OAAO,EAAwB,CAAC;AAEnD,MAAM,OAAO,YAAY;IACrB;QACI,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,IAAI,CAAC,KAAa,EAAE,OAAuB,EAAE,oBAA2B;QACpE,MAAM,aAAa,GAAG,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,aAAa,EAAE,CAAC;QAEvC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,YAAY;YAAE,OAAO,YAAY,CAAC;QAEtC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAChE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,KAAK;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACjC,MAAM,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACJ"}
+{"version":3,"file":"cached-parser.js","sourceRoot":"","sources":["../../src/cached-parser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,MAAM,MAAM,GAAG,IAAI,OAAO,EAAwB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,YAAY;IACrB;QACI,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CAAC,KAAa,EAAE,OAAuB,EAAE,oBAA2B;QACpE,MAAM,aAAa,GAAG,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,aAAa,EAAE,CAAC;QAEvC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,YAAY;YAAE,OAAO,YAAY,CAAC;QAEtC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAChE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACjC,MAAM,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACJ"}

package/dist/src/functions/index.d.ts

@@ -1,5 +1,8 @@
 import { xLuceneTypeConfig, xLuceneVariables } from '@terascope/types';
 import { FunctionDefinition, FunctionMethods, FunctionNode } from '../interfaces.js';
+/**
+ * Enumeration of available xLucene functions.
+ */
 export declare enum xLuceneFunction {
     geoDistance = "geoDistance",
     geoBox = "geoBox",
@@ -7,7 +10,35 @@ export declare enum xLuceneFunction {
     geoContainsPoint = "geoContainsPoint",
     knn = "knn"
 }
+/**
+ * Registry of available xLucene function implementations.
+ *
+ * Maps function names to their corresponding function definitions
+ * that provide the implementation logic.
+ */
 export declare const xLuceneFunctions: Record<xLuceneFunction, FunctionDefinition>;
+/**
+ * Initialize a function node with the appropriate implementation.
+ *
+ * This function looks up the function implementation based on the node's name
+ * and creates an instance configured with the provided variables and type config.
+ *
+ * @param config - Configuration object
+ * @param { FunctionNode } config.node - The function node from the AST
+ * @param { xLuceneVariables } config.variables - Variables for parameter resolution
+ * @param { xLuceneTypeConfig } config.type_config - Field type configuration
+ * @returns { FunctionMethods } Function methods for matching and query generation
+ * @throws { TypeError } If the function name is not recognized
+ *
+ * @example
+ * ```typescript
+ * const functionMethods = initFunction({
+ *   node: geoDistanceNode,
+ *   variables: { maxDist: '10km' },
+ *   type_config: { location: 'geo' }
+ * });
+ * ```
+ */
 export declare function initFunction({ node, variables, type_config }: {
     node: FunctionNode;
     variables?: xLuceneVariables;

package/dist/src/functions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAOvE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErF,oBAAY,eAAe;IACvB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,gBAAgB,qBAAqB;IACrC,GAAG,QAAQ;CACd;AAED,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAMxE,CAAC;AAEF,wBAAgB,YAAY,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;IAC3D,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,WAAW,EAAE,iBAAiB,CAAC;CAClC,GAAG,eAAe,CAYlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAOvE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErF;;GAEG;AACH,oBAAY,eAAe;IACvB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,gBAAgB,qBAAqB;IACrC,GAAG,QAAQ;CACd;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAMxE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;IAC3D,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,WAAW,EAAE,iBAAiB,CAAC;CAClC,GAAG,eAAe,CAYlB"}

package/dist/src/functions/index.js

@@ -4,6 +4,9 @@ import geoDistanceFn from './geo/distance.js';
 import geoPolygonFn from './geo/polygon.js';
 import geoContainsPointFn from './geo/contains-point.js';
 import knnSearch from './vector/knn.js';
+/**
+ * Enumeration of available xLucene functions.
+ */
 export var xLuceneFunction;
 (function (xLuceneFunction) {
     xLuceneFunction["geoDistance"] = "geoDistance";
@@ -12,6 +15,12 @@ export var xLuceneFunction;
     xLuceneFunction["geoContainsPoint"] = "geoContainsPoint";
     xLuceneFunction["knn"] = "knn";
 })(xLuceneFunction || (xLuceneFunction = {}));
+/**
+ * Registry of available xLucene function implementations.
+ *
+ * Maps function names to their corresponding function definitions
+ * that provide the implementation logic.
+ */
 export const xLuceneFunctions = {
     geoDistance: geoDistanceFn,
     geoBox: geoBoxFn,
@@ -19,6 +28,28 @@ export const xLuceneFunctions = {
     geoContainsPoint: geoContainsPointFn,
     knn: knnSearch
 };
+/**
+ * Initialize a function node with the appropriate implementation.
+ *
+ * This function looks up the function implementation based on the node's name
+ * and creates an instance configured with the provided variables and type config.
+ *
+ * @param config - Configuration object
+ * @param { FunctionNode } config.node - The function node from the AST
+ * @param { xLuceneVariables } config.variables - Variables for parameter resolution
+ * @param { xLuceneTypeConfig } config.type_config - Field type configuration
+ * @returns { FunctionMethods } Function methods for matching and query generation
+ * @throws { TypeError } If the function name is not recognized
+ *
+ * @example
+ * ```typescript
+ * const functionMethods = initFunction({
+ *   node: geoDistanceNode,
+ *   variables: { maxDist: '10km' },
+ *   type_config: { location: 'geo' }
+ * });
+ * ```
+ */
 export function initFunction({ node, variables, type_config }) {
     const fnType = isKey(xLuceneFunctions, node.name)
         ? xLuceneFunctions[node.name]

package/dist/src/functions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,QAAQ,MAAM,cAAc,CAAC;AACpC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AAGxC,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,8CAA2B,CAAA;IAC3B,oCAAiB,CAAA;IACjB,4CAAyB,CAAA;IACzB,wDAAqC,CAAA;IACrC,8BAAW,CAAA;AACf,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAgD;IACzE,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,SAAS;CACjB,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAI1D;IACG,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC;QAC7C,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7B,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,SAAS,CAAC,6BAA6B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACjB,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,IAAI,EAAE;KAChD,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,QAAQ,MAAM,cAAc,CAAC;AACpC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AAGxC;;GAEG;AACH,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,8CAA2B,CAAA;IAC3B,oCAAiB,CAAA;IACjB,4CAAyB,CAAA;IACzB,wDAAqC,CAAA;IACrC,8BAAW,CAAA;AACf,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAgD;IACzE,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,SAAS;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAI1D;IACG,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC;QAC7C,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7B,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,SAAS,CAAC,6BAA6B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACjB,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,IAAI,EAAE;KAChD,CAAC,CAAC;AACP,CAAC"}

package/dist/src/interfaces.d.ts

@@ -1,33 +1,65 @@
 import { Logger } from '@terascope/utils';
 import * as t from '@terascope/types';
 /**
- * @param filterNilVariables CAUTION: Filters out variable nodes that don't have
- * a variable provided in the variables object so make sure to pass in variables.
+ * Configuration options for the Parser constructor.
+ * @property type_config - Optional type config for field type inference.
+ * @property filterNilVariables - If true, removes variable nodes with no value in `variables`.
+ * CAUTION: Make sure to pass all needed variables or parts of the query may be dropped.
+ * @property variables - Optional map of variable names to values for substitution.
  */
 export interface ParserOptions {
     type_config?: t.xLuceneTypeConfig;
     filterNilVariables?: boolean;
     variables?: t.xLuceneVariables;
 }
+/**
+ * Context argument passed to the PEG parser engine.
+ * @internal
+ */
 export interface ContextArg {
     typeConfig?: t.xLuceneTypeConfig;
     variables?: t.xLuceneVariables;
 }
 export type GroupLike = FieldGroup | LogicalGroup;
 export type GroupLikeType = NodeType.LogicalGroup | NodeType.FieldGroup;
+/**
+ * Base interface for all AST nodes.
+ *
+ * Every node in the Abstract Syntax Tree has a type property
+ * that identifies what kind of node it is.
+ */
 export interface Node {
     type: NodeType;
 }
+/**
+ * Base interface for nodes that contain logical flow (LogicalGroup and FieldGroup).
+ *
+ * Group-like nodes organize other nodes into logical conjunctions,
+ * representing AND/OR operations or field-scoped groupings.
+ */
 export interface GroupLikeNode extends Node {
     type: GroupLikeType;
     flow: Conjunction[];
 }
 export type TermLikeType = NodeType.Term | NodeType.Regexp | NodeType.Range | NodeType.Wildcard | NodeType.Function | NodeType.TermList;
+/**
+ * Base interface for nodes that represent searchable terms.
+ *
+ * Term-like nodes include actual search terms, ranges, wildcards,
+ * regular expressions, and functions - anything that can be applied
+ * to a field for matching.
+ */
 export interface TermLikeNode extends Node {
     type: TermLikeType;
     field: Field;
     analyzed?: boolean;
 }
+/**
+ * Enumeration of all possible AST node types.
+ *
+ * Each node in the parsed AST has one of these types, which determines
+ * its structure and behavior.
+ */
 export declare enum NodeType {
     LogicalGroup = "logical-group",
     FieldGroup = "field-group",
@@ -55,11 +87,31 @@ export type FieldValueVariable = {
     scoped: boolean;
     value: string;
 };
+/**
+ * Union type representing either a literal value or a variable reference.
+ *
+ * Field values can be either concrete values or references to variables
+ * that will be resolved later.
+ */
 export type FieldValue<T> = FieldValueValue<T> | FieldValueVariable;
+/**
+ * AST node representing a list of terms.
+ *
+ * Term lists are used internally for function parameters
+ * and other scenarios where multiple values are grouped.
+ *
+ * @internal
+ */
 export interface TermList extends TermLikeNode {
     type: NodeType.TermList;
     value: FieldValue<any>[];
 }
+/**
+ * Interface for nodes that can contain any type of data value.
+ *
+ * This is the most general data type interface, used by Term nodes
+ * that can contain strings, numbers, booleans, or other values.
+ */
 export interface AnyDataType {
     /**
      * The field type here may be the field type specified
@@ -68,41 +120,105 @@ export interface AnyDataType {
     field_type: t.xLuceneFieldType;
     value: FieldValue<string | number | boolean | any>;
 }
+/**
+ * Interface for nodes that contain numeric data values.
+ *
+ * Used by nodes that specifically work with integer or float values.
+ */
 export interface NumberDataType {
     field_type: t.xLuceneFieldType.Integer | t.xLuceneFieldType.Float;
     value: FieldValue<number>;
 }
+/**
+ * Interface for nodes that contain string data values.
+ *
+ * String data types track whether the value was quoted in the original
+ * query and whether it has restricted characters.
+ */
 export interface StringDataType {
     field_type: t.xLuceneFieldType.String;
     value: FieldValue<string>;
     quoted: boolean;
     restricted?: boolean;
 }
+/**
+ * Interface for nodes that contain boolean data values.
+ */
 export interface BooleanDataType {
     field_type: t.xLuceneFieldType.Boolean;
     value: FieldValue<boolean>;
 }
+/**
+ * AST node representing a logical grouping of terms with AND/OR operations.
+ *
+ * Logical groups organize multiple terms or sub-groups with boolean logic.
+ *
+ * @example
+ * Query: "name:John AND age:25" creates a LogicalGroup with two conjunctions
+ */
 export interface LogicalGroup extends GroupLikeNode {
     type: NodeType.LogicalGroup;
 }
+/**
+ * AST node representing a conjunction of terms (implicit AND operation).
+ *
+ * Conjunctions group multiple nodes that should all match.
+ *
+ * @example
+ * Query: "name:John age:25" creates a Conjunction with two Term nodes
+ */
 export interface Conjunction extends Node {
     type: NodeType.Conjunction;
     nodes: Node[];
 }
+/**
+ * AST node representing a negated term or group.
+ *
+ * Negations wrap another node and indicate it should NOT match.
+ *
+ * @example
+ * Query: "NOT name:John" creates a Negation containing a Term node
+ */
 export interface Negation extends Node {
     type: NodeType.Negation;
     node: Node;
 }
+/**
+ * AST node representing multiple operations on the same field.
+ *
+ * Field groups allow multiple conditions to be applied to a single field.
+ *
+ * @example
+ * Query: "age:(>=18 AND <=65)" creates a FieldGroup for the 'age' field
+ */
 export interface FieldGroup extends GroupLikeNode {
     type: NodeType.FieldGroup;
     field_type: t.xLuceneFieldType;
     field: string;
 }
+/**
+ * AST node representing a field existence check.
+ *
+ * Exists nodes check whether a field has any value (is not null/undefined).
+ *
+ * @example
+ * Query: "_exists_:name" creates an Exists node for the 'name' field
+ */
 export interface Exists extends Node {
     type: NodeType.Exists;
     field: string;
 }
 export type RangeOperator = 'gte' | 'gt' | 'lt' | 'lte';
+/**
+ * AST node representing a range query.
+ *
+ * Range nodes specify numeric or string ranges with comparison operators.
+ * They can have one or two bounds (left/right) with different operators.
+ *
+ * @example
+ * Query: "age:[18 TO 65]" creates a Range with gte and lte operators
+ * Query: "score:>=90" creates a Range with only a left bound (gte)
+ */
 export interface Range extends TermLikeNode {
     type: NodeType.Range;
     field_type: t.xLuceneFieldType;
@@ -110,11 +226,27 @@ export interface Range extends TermLikeNode {
     right?: RangeNode;
     __range?: boolean;
 }
+/**
+ * Configuration for one side of a range query.
+ *
+ * Range nodes specify the operator (gte, gt, lt, lte) and the value
+ * for one boundary of a range.
+ */
 export interface RangeNode {
     operator: RangeOperator;
     field_type: t.xLuceneFieldType.Integer | t.xLuceneFieldType.Float | t.xLuceneFieldType.String | t.xLuceneFieldType.AnalyzedString | t.xLuceneFieldType.Date | t.xLuceneFieldType.IP;
     value: FieldValue<number | string>;
 }
+/**
+ * AST node representing a function call.
+ *
+ * Function nodes represent specialized operations like geo queries
+ * that take named parameters.
+ *
+ * @example
+ * Query: "location:geoDistance(point:"40,-74", distance:"10km")"
+ * creates a FunctionNode with name="geoDistance" and parameters
+ */
 export interface FunctionNode extends TermLikeNode {
     type: NodeType.Function;
     /**
@@ -124,12 +256,39 @@ export interface FunctionNode extends TermLikeNode {
     description?: string;
     params: (Term | TermList)[];
 }
+/**
+ * AST node representing a regular expression pattern.
+ *
+ * Regular expression nodes contain patterns for matching text.
+ *
+ * @example
+ * Query: "name:/[A-Z][a-z]+/" creates a Regexp node
+ */
 export interface Regexp extends StringDataType, TermLikeNode {
     type: NodeType.Regexp;
 }
+/**
+ * AST node representing a wildcard pattern.
+ *
+ * Wildcard nodes contain patterns with ? (single character) and
+ * * (multiple characters) wildcards.
+ *
+ * @example
+ * Query: "name:J*n" creates a Wildcard node
+ */
 export interface Wildcard extends StringDataType, TermLikeNode {
     type: NodeType.Wildcard;
 }
+/**
+ * AST node representing a simple term query.
+ *
+ * Term nodes are the most basic type of query, representing
+ * field-value pairs or standalone search terms.
+ *
+ * @example
+ * Query: "name:John" creates a Term node
+ * Query: "hello" creates a Term node with null field
+ */
 export interface Term extends AnyDataType, TermLikeNode {
     type: NodeType.Term;
 }

package/dist/src/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC;CAClC;AAED,MAAM,WAAW,UAAU;IACvB,UAAU,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAAC;IACjC,SAAS,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC;CAClC;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,YAAY,CAAC;AAClD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,UAAU,CAAC;AAExE,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,aAAc,SAAQ,IAAI;IACvC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,YAAY,GAClB,QAAQ,CAAC,IAAI,GACT,QAAQ,CAAC,MAAM,GACf,QAAQ,CAAC,KAAK,GACd,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,QAAQ,CAAC;AAE5B,MAAM,WAAW,YAAa,SAAQ,IAAI;IACtC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,oBAAY,QAAQ;IAChB,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,cAAc;CACzB;AAED,MAAM,WAAW,SAAU,SAAQ,IAAI;IACnC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;CACxB;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAElC,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACZ,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC;AAEpE,MAAM,WAAW,QAAS,SAAQ,YAAY;IAC1C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IACxB;;;MAGE;IACF,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,GAAG,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,GAAG,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;IAClE,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC5B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC;IACvC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,YAAa,SAAQ,aAAa;IAC/C,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;CAC/B;AAED,MAAM,WAAW,WAAY,SAAQ,IAAI;IACrC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;IAC3B,KAAK,EAAE,IAAI,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IAClC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC7C,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC;IAC1B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,MAAO,SAAQ,IAAI;IAChC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AACxD,MAAM,WAAW,KAAM,SAAQ,YAAY;IACvC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC;IAGlB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,GAChC,CAAC,CAAC,gBAAgB,CAAC,KAAK,GACxB,CAAC,CAAC,gBAAgB,CAAC,MAAM,GACzB,CAAC,CAAC,gBAAgB,CAAC,cAAc,GACjC,CAAC,CAAC,gBAAgB,CAAC,IAAI,GACvB,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAC5B,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAC9C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,CAAC,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,MAAO,SAAQ,cAAc,EAAE,YAAY;IACxD,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,QAAS,SAAQ,cAAc,EAAE,YAAY;IAC1D,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW,EAAE,YAAY;IACnD,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,gBAAgB,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,eAAe,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACnC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC;IAClB,IAAI,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC;CACzB;AAED,MAAM,MAAM,4BAA4B,GAClC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAA;CAAE,GAChD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE9B,MAAM,WAAW,eAAe;IAC5B,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;IACzB,oBAAoB,CAChB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,4BAA4B,GACtC,sBAAsB,CAAC;CAC7B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,UAAU,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAAC;IACjC,SAAS,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC;CAClC;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,YAAY,CAAC;AAClD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,UAAU,CAAC;AAExE;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI;IACvC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,YAAY,GAClB,QAAQ,CAAC,IAAI,GACT,QAAQ,CAAC,MAAM,GACf,QAAQ,CAAC,KAAK,GACd,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,QAAQ,CAAC;AAE5B;;;;;;GAMG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI;IACtC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,QAAQ;IAChB,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,cAAc;CACzB;AAED,MAAM,WAAW,SAAU,SAAQ,IAAI;IACnC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;CACxB;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAElC,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACZ,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAS,SAAQ,YAAY;IAC1C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IACxB;;;MAGE;IACF,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,GAAG,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,GAAG,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;IAClE,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC;IACvC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IAC/C,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;CAC/B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACrC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;IAC3B,KAAK,EAAE,IAAI,EAAE,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IAClC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC;CACd;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC7C,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC;IAC1B,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAO,SAAQ,IAAI;IAChC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AACxD;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAM,SAAQ,YAAY;IACvC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC/B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC;IAGlB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,OAAO,GAChC,CAAC,CAAC,gBAAgB,CAAC,KAAK,GACxB,CAAC,CAAC,gBAAgB,CAAC,MAAM,GACzB,CAAC,CAAC,gBAAgB,CAAC,cAAc,GACjC,CAAC,CAAC,gBAAgB,CAAC,IAAI,GACvB,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAC5B,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CACtC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAC9C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACxB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,CAAC,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC/B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAO,SAAQ,cAAc,EAAE,YAAY;IACxD,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;CACzB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc,EAAE,YAAY;IAC1D,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW,EAAE,YAAY;IACnD,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,gBAAgB,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,eAAe,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACnC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC;IAClB,IAAI,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC;CACzB;AAED,MAAM,MAAM,4BAA4B,GAClC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAA;CAAE,GAChD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE9B,MAAM,WAAW,eAAe;IAC5B,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;IACzB,oBAAoB,CAChB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,4BAA4B,GACtC,sBAAsB,CAAC;CAC7B"}

package/dist/src/interfaces.js

@@ -1,3 +1,9 @@
+/**
+ * Enumeration of all possible AST node types.
+ *
+ * Each node in the parsed AST has one of these types, which determines
+ * its structure and behavior.
+ */
 export var NodeType;
 (function (NodeType) {
     NodeType["LogicalGroup"] = "logical-group";

package/dist/src/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AA4CA,MAAM,CAAN,IAAY,QAaX;AAbD,WAAY,QAAQ;IAChB,0CAA8B,CAAA;IAC9B,sCAA0B,CAAA;IAC1B,uCAA2B,CAAA;IAC3B,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,iCAAqB,CAAA;IACrB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,kCAAsB,CAAA;AAC1B,CAAC,EAbW,QAAQ,KAAR,QAAQ,QAanB"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAsEA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,QAaX;AAbD,WAAY,QAAQ;IAChB,0CAA8B,CAAA;IAC9B,sCAA0B,CAAA;IAC1B,uCAA2B,CAAA;IAC3B,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,iCAAqB,CAAA;IACrB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,kCAAsB,CAAA;AAC1B,CAAC,EAbW,QAAQ,KAAR,QAAQ,QAanB"}