@getodk/xpath 0.2.0 → 0.3.0

package/dist/evaluator/result/XPathEvaluationResult.d.ts

@@ -0,0 +1,61 @@
+import { XPathNode } from '../../adapter/interface/XPathNode.ts';
+declare const ANY_TYPE: XPathResult['ANY_TYPE'];
+export type ANY_TYPE = typeof ANY_TYPE;
+declare const NUMBER_TYPE: XPathResult['NUMBER_TYPE'];
+export type NUMBER_TYPE = typeof NUMBER_TYPE;
+declare const STRING_TYPE: XPathResult['STRING_TYPE'];
+export type STRING_TYPE = typeof STRING_TYPE;
+declare const BOOLEAN_TYPE: XPathResult['BOOLEAN_TYPE'];
+export type BOOLEAN_TYPE = typeof BOOLEAN_TYPE;
+declare const UNORDERED_NODE_ITERATOR_TYPE: XPathResult['UNORDERED_NODE_ITERATOR_TYPE'];
+export type UNORDERED_NODE_ITERATOR_TYPE = typeof UNORDERED_NODE_ITERATOR_TYPE;
+declare const ORDERED_NODE_ITERATOR_TYPE: XPathResult['ORDERED_NODE_ITERATOR_TYPE'];
+export type ORDERED_NODE_ITERATOR_TYPE = typeof ORDERED_NODE_ITERATOR_TYPE;
+declare const UNORDERED_NODE_SNAPSHOT_TYPE: XPathResult['UNORDERED_NODE_SNAPSHOT_TYPE'];
+export type UNORDERED_NODE_SNAPSHOT_TYPE = typeof UNORDERED_NODE_SNAPSHOT_TYPE;
+declare const ORDERED_NODE_SNAPSHOT_TYPE: XPathResult['ORDERED_NODE_SNAPSHOT_TYPE'];
+export type ORDERED_NODE_SNAPSHOT_TYPE = typeof ORDERED_NODE_SNAPSHOT_TYPE;
+declare const ANY_UNORDERED_NODE_TYPE: XPathResult['ANY_UNORDERED_NODE_TYPE'];
+export type ANY_UNORDERED_NODE_TYPE = typeof ANY_UNORDERED_NODE_TYPE;
+declare const FIRST_ORDERED_NODE_TYPE: XPathResult['FIRST_ORDERED_NODE_TYPE'];
+export type FIRST_ORDERED_NODE_TYPE = typeof FIRST_ORDERED_NODE_TYPE;
+export declare const XPATH_EVALUATION_RESULT: {
+    ANY_TYPE: 0;
+    ANY_UNORDERED_NODE_TYPE: 8;
+    BOOLEAN_TYPE: 3;
+    FIRST_ORDERED_NODE_TYPE: 9;
+    NUMBER_TYPE: 1;
+    ORDERED_NODE_ITERATOR_TYPE: 5;
+    ORDERED_NODE_SNAPSHOT_TYPE: 7;
+    STRING_TYPE: 2;
+    UNORDERED_NODE_ITERATOR_TYPE: 4;
+    UNORDERED_NODE_SNAPSHOT_TYPE: 6;
+};
+export type XPathEvaluationResultType = ANY_TYPE | ANY_UNORDERED_NODE_TYPE | BOOLEAN_TYPE | FIRST_ORDERED_NODE_TYPE | NUMBER_TYPE | ORDERED_NODE_ITERATOR_TYPE | ORDERED_NODE_SNAPSHOT_TYPE | STRING_TYPE | UNORDERED_NODE_ITERATOR_TYPE | UNORDERED_NODE_SNAPSHOT_TYPE;
+/**
+ * Establishes baseline API compatibility with the WHAT Working Group DOM
+ * standard {@link XPathResult}, extended to support any
+ * {@link XPathDOMAdapter}'s arbitrary DOM implementation.
+ */
+export interface XPathEvaluationResult<T extends XPathNode> {
+    readonly booleanValue: boolean;
+    readonly invalidIteratorState: boolean;
+    readonly numberValue: number;
+    readonly resultType: XPathEvaluationResultType;
+    readonly singleNodeValue: T | null;
+    readonly snapshotLength: number;
+    readonly stringValue: string;
+    readonly ANY_TYPE: ANY_TYPE;
+    readonly ANY_UNORDERED_NODE_TYPE: ANY_UNORDERED_NODE_TYPE;
+    readonly BOOLEAN_TYPE: BOOLEAN_TYPE;
+    readonly FIRST_ORDERED_NODE_TYPE: FIRST_ORDERED_NODE_TYPE;
+    readonly NUMBER_TYPE: NUMBER_TYPE;
+    readonly ORDERED_NODE_ITERATOR_TYPE: ORDERED_NODE_ITERATOR_TYPE;
+    readonly ORDERED_NODE_SNAPSHOT_TYPE: ORDERED_NODE_SNAPSHOT_TYPE;
+    readonly STRING_TYPE: STRING_TYPE;
+    readonly UNORDERED_NODE_ITERATOR_TYPE: UNORDERED_NODE_ITERATOR_TYPE;
+    readonly UNORDERED_NODE_SNAPSHOT_TYPE: UNORDERED_NODE_SNAPSHOT_TYPE;
+    iterateNext(): T | null;
+    snapshotItem(index: number): T | null;
+}
+export {};

package/dist/evaluator/result/toXPathEvaluationResult.d.ts

@@ -0,0 +1,5 @@
+import { XPathNode } from '../../adapter/interface/XPathNode.ts';
+import { XPathDOMProvider } from '../../adapter/xpathDOMProvider.ts';
+import { Evaluation } from '../../evaluations/Evaluation.ts';
+import { XPathEvaluationResult, XPathEvaluationResultType } from './XPathEvaluationResult.ts';
+export declare const toXPathEvaluationResult: <T extends XPathNode>(domProvider: XPathDOMProvider<T>, resultType: XPathEvaluationResultType, evaluation: Evaluation<T>) => XPathEvaluationResult<T>;

package/dist/evaluator/step/Step.d.ts

@@ -1,6 +1,5 @@
 import { AbsoluteLocationPathNode, FilterPathExprNode, PredicateNode, RelativeLocationPathNode } from '../../static/grammar/SyntaxNode.ts';
-
-type AxisType = 'ancestor-or-self' | 'ancestor' | 'attribute' | 'child' | 'descendant-or-self' | 'descendant' | 'following-sibling' | 'following' | 'namespace' | 'parent' | 'preceding-sibling' | 'preceding' | 'self';
+export type AxisType = 'ancestor-or-self' | 'ancestor' | 'attribute' | 'child' | 'descendant-or-self' | 'descendant' | 'following-sibling' | 'following' | 'namespace' | 'parent' | 'preceding-sibling' | 'preceding' | 'self';
 type NodeType = '__NAMED__' | 'comment' | 'node' | 'processing-instruction' | 'text';
 type StepType = 'NodeTypeTest' | 'ProcessingInstructionNameTest' | 'QualifiedNameTest' | 'NodeNameTest' | 'QualifiedWildcardTest' | 'UnqualifiedWildcardTest';
 export declare abstract class BaseStep {