@getodk/xpath 0.4.1 → 0.6.0

package/dist/lib/collections/sort.d.ts

@@ -1 +1 @@
-export declare const seededRandomize: <T>(values: readonly T[], seed?: number | bigint) => T[];
+export declare const seededRandomize: <T>(values: readonly T[], seed?: bigint | number) => T[];

package/dist/lib/datetime/coercion.d.ts

@@ -1,4 +1,4 @@
-import { Temporal } from '@js-temporal/polyfill';
+import { Temporal } from 'temporal-polyfill';
 export declare const tryParseDateString: (value: string) => Date | null;
-export declare const dateTimeFromString: (timeZone: Temporal.TimeZone, value: string) => Temporal.ZonedDateTime | null;
-export declare const dateTimeFromNumber: (timeZone: Temporal.TimeZone, milliseconds: number) => Temporal.ZonedDateTime | null;
+export declare const dateTimeFromString: (timeZone: Temporal.TimeZoneLike, value: string) => Temporal.ZonedDateTime | null;
+export declare const dateTimeFromNumber: (timeZone: Temporal.TimeZoneLike, milliseconds: number) => Temporal.ZonedDateTime | null;

package/dist/lib/datetime/functions.d.ts

@@ -1,5 +1,5 @@
-import { Temporal } from '@js-temporal/polyfill';
-export declare const currentLocalDateTimeString: (timeZone: Temporal.TimeZone) => string;
+import { Temporal } from 'temporal-polyfill';
+export declare const currentLocalDateTimeString: (timeZone: Temporal.TimeZoneLike) => string;
 export declare const localDateTimeString: (dateTime: Temporal.ZonedDateTime) => string;
 export declare const localDateTimeOrDateString: (dateTime: Temporal.ZonedDateTime) => string;
-export declare const now: (timeZone: Temporal.TimeZone) => Temporal.ZonedDateTime;
+export declare const now: (timeZone: Temporal.TimeZoneLike) => Temporal.ZonedDateTime;

package/dist/xforms/XFormsItextTranslations.d.ts

@@ -3,6 +3,7 @@ import { XPathNode } from '../adapter/interface/XPathNode.ts';
 import { XPathDOMProvider } from '../adapter/xpathDOMProvider.ts';
 import { XFormsElementRepresentation } from './XFormsElementRepresentation.ts';
 type XFormsItextTextID = string;
+export type XFormsItextTranslationValueElement<T extends XPathNode> = XFormsElementRepresentation<T, 'value', 'form'>;
 type XFormsItextTranslationTextElement<T extends XPathNode> = XFormsElementRepresentation<T, 'text'>;
 export type XFormsItextTranslationElement<T extends XPathNode> = XFormsElementRepresentation<T, 'translation', 'lang'>;
 type XFormsItextTextMap<T extends XPathNode> = ReadonlyMap<XFormsItextTextID, XFormsItextTranslationTextElement<T>>;
@@ -42,35 +43,34 @@ export declare class XFormsItextTranslations<T extends XPathNode> implements XFo
     private getTranslationMetadata;
     private getTranslationTextElement;
     /**
+     * Retrieves all translation value elements for a given Itext in the active language.
+     *
      * @package
      *
-     * Here, "default" is meant as more precise language than "regular" as
-     * {@link https://getodk.github.io/xforms-spec/#languages | specified by ODK XForms}. In other words, this is equivalent to the following hypothetical XPath pseudo-code (whitespace added to improve structural clarity):
+     * This method fetches the `text` element matching `itextID` and returns its child `value` elements,
+     * which may have an optional `@form` attribute.
+     *
+     * The operation is conceptually similar to the following XPath query:
      *
      * ```xpath
-     * string(
-     *   imaginary:itext-translation(
-     *     xpath3-fn:environment-variable('activeLanguage')
-     *   )
-     *     /text[@id = $itextID]
-     *       /value[not(@form)]
+     * imaginary:itext-translation(
+     *   xpath3-fn:environment-variable('activeLanguage')
      * )
+     *   /text[@id = $itextID]
+     *     /value
      * ```
      *
      * Or alternately:
      *
      * ```xpath
-     * string(
-     *   imaginary:itext-root()
-     *     /translation[@lang = xpath3-fn:environment-variable('activeLanguage')]
-     *       /text[@id = $itextID]
-     *         /value[not(@form)]
-     * )
+     * imaginary:itext-root()
+     *   /translation[@lang = xpath3-fn:environment-variable('activeLanguage')]
+     *     /text[@id = $itextID]
+     *       /value
      * ```
-     *
-     * @todo The above really feels like it adds some helpful clarity to how `jr:itext()` is designed to work, and the kinds of structures, state and input involved. Since there's already some discomfort around that API as specified, it's worth considering
+     * Returns an array of `XFormsItextTranslationValueElement<T>`
      */
-    getDefaultTranslationText(itextID: string): string;
+    getTranslationValues(itextID: string): Array<XFormsItextTranslationValueElement<T>>;
     getLanguages(): readonly XFormsItextTranslationLanguage[];
     getActiveLanguage(): XFormsItextTranslationLanguage | null;
     setActiveLanguage(language: XFormsItextTranslationLanguage | null): XFormsItextTranslationLanguage | null;

package/dist/xforms/XFormsXPathEvaluator.d.ts

@@ -3,7 +3,7 @@ import { XPathNode } from '../adapter/interface/XPathNode.ts';
 import { AdapterParentNode } from '../adapter/interface/XPathNodeKindAdapter.ts';
 import { EvaluationContext } from '../context/EvaluationContext.ts';
 import { EvaluatorOptions, Evaluator } from '../evaluator/Evaluator.ts';
-import { XFormsItextTranslationLanguage, XFormsItextTranslationMap, XFormsItextTranslationsState } from './XFormsItextTranslations.ts';
+import { XFormsItextTranslationLanguage, XFormsItextTranslationMap, XFormsItextTranslationsState, XFormsItextTranslationValueElement } from './XFormsItextTranslations.ts';
 import { XFormsSecondaryInstanceElement, XFormsSecondaryInstanceMap } from './XFormsSecondaryInstances.ts';
 /**
  * @todo We accept an arbitrary parent node specifically for legacy WHATWG DOM
@@ -18,7 +18,7 @@ export interface XFormsXPathEvaluatorOptions<T extends XPathNode> extends Evalua
 }
 export declare class XFormsXPathEvaluator<T extends XPathNode> extends Evaluator<T> implements XFormsItextTranslationsState {
     static getSecondaryInstance<T extends XPathNode>(context: EvaluationContext<T>, id: string): XFormsSecondaryInstanceElement<T> | null;
-    static getDefaultTranslationText<T extends XPathNode>(context: EvaluationContext<T>, itextID: string): string;
+    static getTranslationValues<T extends XPathNode>(context: EvaluationContext<T>, itextID: string): Array<XFormsItextTranslationValueElement<T>>;
     readonly rootNode: AdapterParentNode<T>;
     /**
      * @package

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getodk/xpath",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "license": "Apache-2.0",
   "description": "XPath implementation for ODK Web Forms",
   "type": "module",
@@ -54,10 +54,9 @@
     "test:types:test": "tsc --project ./test/tsconfig.json --emitDeclarationOnly false --noEmit"
   },
   "dependencies": {
-    "@getodk/common": "0.5.2",
-    "@js-temporal/polyfill": "^0.4.4",
+    "@getodk/common": "0.6.1",
     "crypto-js": "^4.2.0",
-    "itertools-ts": "^2.2.0"
+    "temporal-polyfill": "^0.3.0"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",

package/dist/functions/javarosa/string.d.ts

@@ -1,9 +0,0 @@
-import { StringFunction } from '../../evaluator/functions/StringFunction.ts';
-/**
- * @todo This could be a {@link NodeSetFunction}. If it were, that might be a
- * good starting point for thinking about how we'll support:
- *
- * - `<output>` in itext translations
- * - `<value form="...">` (short, guidance, various media types)
- */
-export declare const itext: StringFunction;

package/dist/lib/datetime/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const DAY_MILLISECONDS: number;
-export declare const MILLISECOND_NANOSECONDS: bigint;
-export declare const ISO_DATE_LIKE_PATTERN: RegExp;
-export declare const ISO_TIME_LIKE_PATTERN: RegExp;
-export declare const ISO_DATE_TIME_LIKE_PATTERN: RegExp;
-export declare const ISO_DATE_OR_DATE_TIME_LIKE_PATTERN: RegExp;

package/dist/lib/iterators/Reiterable.d.ts

@@ -1,15 +0,0 @@
-type BooleanPredicate<T> = (value: T) => boolean;
-export declare class Reiterable<T> implements Iterable<T> {
-    protected source: Iterable<T> | Iterator<T>;
-    static from<T>(source: Iterable<T> | Iterator<T>): Reiterable<T>;
-    protected active: IterableIterator<T>;
-    protected cache: T[];
-    protected constructor(source: Iterable<T> | Iterator<T>);
-    [Symbol.iterator](): Iterator<T>;
-    entries(): IterableIterator<readonly [key: number, value: T]>;
-    keys(): IterableIterator<number>;
-    values(): IterableIterator<T>;
-    first(): T | void;
-    some(predicate: BooleanPredicate<T>): boolean;
-}
-export {};

package/dist/lib/iterators/common.d.ts

@@ -1,17 +0,0 @@
-type Iter<T> = Iterable<T> | Iterator<T>;
-export declare function toIterableIterator<T>(iter: Iter<T>): IterableIterator<T>;
-type MapIterated<T, U> = (value: T) => U;
-export type MapIterable<T, U> = (iterable: Iter<T>) => IterableIterator<U>;
-export declare const map: <T, U>(fn: MapIterated<T, U>) => MapIterable<T, U>;
-export declare const eager: <T>(iterable: Iter<T>) => IterableIterator<T>;
-type TypedGuardIterated<T, U extends T> = (value: T) => value is U;
-type PredicateGuardIterated<T> = (value: T) => boolean;
-type GuardIterated<T, U extends T> = PredicateGuardIterated<T & U> | TypedGuardIterated<T, U>;
-type UnguardedIterated<Guard extends GuardIterated<any, any>> = Guard extends TypedGuardIterated<infer T, any> ? T : Guard extends PredicateGuardIterated<infer T> ? T : never;
-type GuardedIterated<Guard extends GuardIterated<any, any>> = Guard extends TypedGuardIterated<infer T, infer U> ? T & U : Guard extends PredicateGuardIterated<infer T> ? T : never;
-type FilterIterable<Guard extends GuardIterated<any, any>> = MapIterable<UnguardedIterated<Guard>, GuardedIterated<Guard>>;
-export declare const filter: <Guard extends GuardIterated<any, any>>(guard: Guard) => FilterIterable<Guard>;
-export declare const distinct: <T>(iterable: Iterable<T>) => Generator<T, void, unknown>;
-type TeeResult<T> = [IterableIterator<T>, IterableIterator<T>];
-export declare const tee: <T>(input: Iterable<T> | Iterator<T>) => TeeResult<T>;
-export {};

package/dist/lib/iterators/index.d.ts

@@ -1,3 +0,0 @@
-export * from 'itertools-ts';
-export * from './common.ts';
-export * from './Reiterable.ts';