@getodk/xpath 0.7.0 → 0.8.0

package/README.md

@@ -148,7 +148,6 @@ Both evaluator classes provide the following convenience methods:
 
 We intend to support the full ODK XForms function library, but support is currently incomplete. The following functions are not yet supported (the `jr:` prefix is used by convention to refer to the JavaRosa namespace):
 
-- `pulldata`
 - `jr:choice-name`
 
 ### Non-browser environments

package/dist/adapter/interface/XPathChoiceNode.d.ts

@@ -0,0 +1,3 @@
+export interface XPathChoiceNode {
+    readonly getChoiceName: (value: string) => string | null;
+}

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

@@ -0,0 +1,14 @@
+import { StringFunction } from '../../evaluator/functions/StringFunction.ts';
+/**
+ * jr:choice-name function
+ * https://getodk.github.io/xforms-spec/#fn:jr:choice-name
+ *
+ * The first parameter is evaluated to the value to find the label for. Can be a string literal,
+ * or a xpath reference which resolves to a string.
+ * The second parameter is the xpath reference to the element which enumerates the choices,
+ * either by items or an itemset. Valid elements must implement the {@link XPathChoiceNode}
+ * interface.
+ * Returns the label which can be translated, calculated, and contain markup, for the given
+ * choice of the given element.
+ */
+export declare const choiceName: StringFunction;

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

@@ -1,10 +1,12 @@
 import { BooleanFunction } from '../../evaluator/functions/BooleanFunction.ts';
 import { StringFunction } from '../../evaluator/functions/StringFunction.ts';
+export declare const base64Decode: StringFunction;
 export declare const coalesce: StringFunction;
 export declare const concat: StringFunction;
 export declare const digest: StringFunction;
 export declare const endsWith: BooleanFunction;
 export declare const join: StringFunction;
+export declare const pulldata: StringFunction;
 export declare const regex: BooleanFunction;
 export declare const substr: StringFunction;
 export declare const uuid: StringFunction;

package/dist/index.d.ts

@@ -44,3 +44,4 @@ export type { XFormsItextTranslationElement, XFormsItextTranslationLanguage, XFo
 export type { XFormsSecondaryInstanceElement, XFormsSecondaryInstanceMap, } from './xforms/XFormsSecondaryInstances.ts';
 export { XFormsXPathEvaluator } from './xforms/XFormsXPathEvaluator.ts';
 export type { XFormsXPathEvaluatorOptions, XFormsXPathRootNode, } from './xforms/XFormsXPathEvaluator.ts';
+export type { XPathChoiceNode } from './adapter/interface/XPathChoiceNode.ts';

package/dist/index.js

@@ -7459,7 +7459,45 @@ const nodeSet = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   itext
 }, Symbol.toStringTag, { value: 'Module' }));
 
-const jr = new FunctionLibrary(JAVAROSA_NAMESPACE_URI, [...Object.values(nodeSet)]);
+const choiceName = new StringFunction(
+  "choice-name",
+  [
+    { arityType: "required", typeHint: "string" },
+    { arityType: "required", typeHint: "string" }
+  ],
+  (context, [nodeExpression, valueExpression]) => {
+    const node = nodeExpression.evaluate(context).toString();
+    const value = valueExpression.evaluate(context).toString();
+    const [contextNode] = context.contextNodes;
+    const { domProvider } = context;
+    let nodes;
+    if (contextNode && domProvider.isElement(contextNode)) {
+      nodes = context.evaluator.evaluateNodes(value, { contextNode });
+    } else {
+      nodes = context.evaluator.evaluateNodes(value);
+    }
+    const firstNode = nodes?.[0];
+    if (!firstNode) {
+      return "";
+    }
+    if (!("getChoiceName" in firstNode)) {
+      throw new Error(
+        `Evaluating 'jr:choice-name' on element '${value}' which has no possible choices.`
+      );
+    }
+    return firstNode.getChoiceName(node) ?? "";
+  }
+);
+
+const select$1 = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+  __proto__: null,
+  choiceName
+}, Symbol.toStringTag, { value: 'Module' }));
+
+const jr = new FunctionLibrary(JAVAROSA_NAMESPACE_URI, [
+  ...Object.values(nodeSet),
+  ...Object.values(select$1)
+]);
 
 const booleanFromString = new BooleanFunction(
   "boolean-from-string",
@@ -14890,6 +14928,10 @@ const hex = /*#__PURE__*/_mergeNamespaces({
   default: encHex
 }, [encHexExports]);
 
+const base64Decode$1 = (base64Input) => {
+  return new TextDecoder().decode(Uint8Array.from(atob(base64Input), (m) => m.charCodeAt(0)));
+};
+
 const toStrings = (context, expressions) => {
   return expressions.flatMap((arg) => {
     const result = arg.evaluate(context);
@@ -14901,6 +14943,17 @@ const toStrings = (context, expressions) => {
   });
 };
 
+const base64Decode = new StringFunction(
+  "base64-decode",
+  [{ arityType: "required", typeHint: "string" }],
+  (context, [base64Expression]) => {
+    try {
+      return base64Decode$1(base64Expression.evaluate(context).toString());
+    } catch {
+      return "";
+    }
+  }
+);
 const coalesce = new StringFunction(
   "coalesce",
   [
@@ -14990,6 +15043,23 @@ const join = new StringFunction(
     return strings.join(glue);
   }
 );
+const pulldata = new StringFunction(
+  "pulldata",
+  [
+    { arityType: "required", typeHint: "string" },
+    { arityType: "required", typeHint: "string" },
+    { arityType: "required", typeHint: "string" },
+    { arityType: "required", typeHint: "string" }
+  ],
+  (context, [instanceExpression, desiredElementExpression, queryElementExpression, queryExpression]) => {
+    const instanceId = instanceExpression.evaluate(context).toString();
+    const desiredElement = desiredElementExpression.evaluate(context).toString();
+    const queryElement = queryElementExpression.evaluate(context).toString();
+    const query = queryExpression.evaluate(context).toString();
+    const expr = `instance('${instanceId}')/root/item[${queryElement}='${query}']/${desiredElement}`;
+    return context.evaluator.evaluateString(expr);
+  }
+);
 const regex = new BooleanFunction(
   "regex",
   [
@@ -15068,11 +15138,13 @@ const uuid = new StringFunction(
 
 const string = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
+  base64Decode,
   coalesce,
   concat,
   digest,
   endsWith,
   join,
+  pulldata,
   regex,
   substr,
   uuid