@irvinebroque/http-rfc-utils 0.1.0

package/dist/jsonpath.d.ts

@@ -0,0 +1,98 @@
+/**
+ * JSONPath query expressions per RFC 9535.
+ * RFC 9535 §§2.1-2.7.
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html
+ *
+ * Implements:
+ * - Root identifier ($) and current node identifier (@)
+ * - Name, wildcard, index, slice, and filter selectors
+ * - Child and descendant segments
+ * - Built-in functions: length(), count(), match(), search(), value()
+ * - Normalized path formatting
+ *
+ * Out of scope:
+ * - Custom function extensions (only built-in functions supported)
+ * - Full I-Regexp (RFC 9485) validation (uses JavaScript RegExp)
+ */
+import type { JsonPathQuery, JsonPathSegment, JsonPathSelector, JsonPathNode, JsonPathOptions } from './types.js';
+export type { JsonPathQuery, JsonPathSegment, JsonPathSelector, JsonPathNode, JsonPathOptions, };
+/**
+ * Parse a JSONPath query string into an AST.
+ * Returns null if the query is not well-formed or valid.
+ *
+ * @param query - JSONPath query string (e.g., "$.store.book[*].author")
+ * @returns Parsed AST, or null on invalid syntax
+ *
+ * @example
+ * parseJsonPath('$.store.book[*]')  // { type: 'query', root: '$', segments: [...] }
+ * parseJsonPath('invalid')          // null
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.1
+ */
+export declare function parseJsonPath(query: string): JsonPathQuery | null;
+/**
+ * Execute a JSONPath query against a JSON document.
+ * Returns an array of matching values (nodelist).
+ *
+ * @param query - JSONPath query string
+ * @param document - JSON document to query
+ * @param options - Query options
+ * @returns Array of matching values, or null on invalid query
+ *
+ * @example
+ * queryJsonPath('$.store.book[*].author', doc)  // ['Author1', 'Author2']
+ * queryJsonPath('$..price', doc)                // [8.95, 12.99, 399]
+ * queryJsonPath('$.store.book[?@.price<10]', doc)  // [{ title: 'Book1', ... }]
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.1.2
+ */
+export declare function queryJsonPath(query: string, document: unknown, options?: JsonPathOptions): unknown[] | null;
+/**
+ * Execute a JSONPath query and return nodes with paths.
+ *
+ * @param query - JSONPath query string
+ * @param document - JSON document to query
+ * @returns Array of nodes with values and paths, or null on invalid query
+ *
+ * @example
+ * queryJsonPathNodes('$.store.book[0].title', doc)
+ * // [{ value: 'Sayings of the Century', path: "$['store']['book'][0]['title']" }]
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.7
+ */
+export declare function queryJsonPathNodes(query: string, document: unknown): JsonPathNode[] | null;
+/**
+ * Validate a JSONPath query string without parsing.
+ *
+ * @param query - String to validate
+ * @returns true if valid JSONPath syntax
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.1
+ */
+export declare function isValidJsonPath(query: string): boolean;
+/**
+ * Format a normalized path from path segments.
+ *
+ * @param segments - Array of string keys or numeric indices
+ * @returns Normalized path string
+ *
+ * @example
+ * formatNormalizedPath(['store', 'book', 0])  // "$['store']['book'][0]"
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.7
+ */
+export declare function formatNormalizedPath(segments: (string | number)[]): string;
+/**
+ * Compile a JSONPath query for repeated execution.
+ * More efficient when the same query is used multiple times.
+ *
+ * @param query - JSONPath query string
+ * @returns Compiled query function, or null on invalid query
+ *
+ * @example
+ * const fn = compileJsonPath('$.store.book[*].author');
+ * fn(doc1)  // ['Author1', ...]
+ * fn(doc2)  // ['Author2', ...]
+ */
+export declare function compileJsonPath(query: string): ((document: unknown) => unknown[]) | null;
+//# sourceMappingURL=jsonpath.d.ts.map

package/dist/jsonpath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonpath.d.ts","sourceRoot":"","sources":["../src/jsonpath.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EACR,aAAa,EACb,eAAe,EAGf,gBAAgB,EAmBhB,YAAY,EACZ,eAAe,EAClB,MAAM,YAAY,CAAC;AAGpB,YAAY,EACR,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,eAAe,GAClB,CAAC;AAqbF;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAcjE;AA2bD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CACzB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,OAAO,EACjB,OAAO,CAAC,EAAE,eAAe,GAC1B,OAAO,EAAE,GAAG,IAAI,CAWlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAC9B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,OAAO,GAClB,YAAY,EAAE,GAAG,IAAI,CAKvB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,CAe1E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC3B,KAAK,EAAE,MAAM,GACd,CAAC,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,EAAE,CAAC,GAAG,IAAI,CAQ3C"}