@getodk/xpath 0.5.0 → 0.6.0

package/dist/functions/javarosa/node-set.d.ts

@@ -0,0 +1,2 @@
+import { NodeSetFunction } from '../../evaluator/functions/NodeSetFunction.ts';
+export declare const itext: NodeSetFunction;

package/dist/index.js

@@ -5609,7 +5609,7 @@ const substring = new StringFunction(
     return string2.substring(start, end);
   }
 );
-const string$2 = new StringFunction(
+const string$1 = new StringFunction(
   "string",
   [{ arityType: "optional" }],
   (context, [expression]) => (expression?.evaluate(context) ?? context).toString()
@@ -5642,13 +5642,13 @@ const translate = new StringFunction(
   }
 );
 
-const string$3 = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+const string$2 = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
   concat: concat$1,
   contains,
   normalizeSpace,
   startsWith,
-  string: string$2,
+  string: string$1,
   stringLength,
   substring,
   substringAfter,
@@ -5660,7 +5660,7 @@ const fn = new FunctionLibrary(FN_NAMESPACE_URI, [
   ...Object.values(boolean$2),
   ...Object.values(nodeset$1),
   ...Object.values(number$3),
-  ...Object.values(string$3)
+  ...Object.values(string$2)
 ]);
 
 class BaseStep {
@@ -7443,21 +7443,21 @@ const enk = new FunctionLibrary(ENKETO_NAMESPACE_URI, [
   new FunctionAlias("format-date", formatDateTime)
 ]);
 
-const itext = new StringFunction(
+const itext = new NodeSetFunction(
   "itext",
   [{ arityType: "required", typeHint: "string" }],
   (context, [itextIDExpression]) => {
     const itextID = itextIDExpression.evaluate(context).toString();
-    return XFormsXPathEvaluator.getDefaultTranslationText(context, itextID);
+    return XFormsXPathEvaluator.getTranslationValues(context, itextID) ?? [];
   }
 );
 
-const string$1 = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+const nodeSet = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
   itext
 }, Symbol.toStringTag, { value: 'Module' }));
 
-const jr = new FunctionLibrary(JAVAROSA_NAMESPACE_URI, [...Object.values(string$1)]);
+const jr = new FunctionLibrary(JAVAROSA_NAMESPACE_URI, [...Object.values(nodeSet)]);
 
 const booleanFromString = new BooleanFunction(
   "boolean-from-string",
@@ -15160,46 +15160,39 @@ class XFormsItextTranslations {
     return textMap.get(itextID) ?? null;
   }
   /**
+   * 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) {
+  getTranslationValues(itextID) {
     const textElement = this.getTranslationTextElement(itextID);
     if (textElement == null) {
-      return "";
-    }
-    const { domProvider } = this;
-    for (const valueElement of domProvider.getChildrenByLocalName(textElement, "value")) {
-      if (!domProvider.hasLocalNamedAttribute(valueElement, "form")) {
-        return domProvider.getNodeValue(valueElement);
-      }
+      return [];
     }
-    return "";
+    return [...this.domProvider.getChildrenByLocalName(textElement, "value")];
   }
   getLanguages() {
     return this.languages;
@@ -15236,9 +15229,9 @@ class XFormsXPathEvaluator extends Evaluator {
     assertInternalXFormsXPathEvaluatorContext(context);
     return context.evaluator.secondaryInstancesById.get(id) ?? null;
   }
-  static getDefaultTranslationText(context, itextID) {
+  static getTranslationValues(context, itextID) {
     assertInternalXFormsXPathEvaluatorContext(context);
-    return context.evaluator.itextTranslations.getDefaultTranslationText(itextID);
+    return context.evaluator.itextTranslations.getTranslationValues(itextID);
   }
   rootNode;
   /**