@openfn/language-kobotoolbox 4.1.1 → 4.2.0

package/ast.json

@@ -879,6 +879,125 @@
         ]
       },
       "valid": false
+    },
+    {
+      "name": "as",
+      "params": [
+        "key",
+        "operation"
+      ],
+      "docs": {
+        "description": "Run an operation and save the result to a custom key in state instead of overwriting state.data.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "example",
+            "description": "as('cceData', collections.get('cce-data-dhis2', { key: `*:*:${$.syncedAt}*` }));",
+            "caption": "Fetch cce-data from collections and store them under state.cceData"
+          },
+          {
+            "title": "param",
+            "description": "The state key to assign the result of the operation to.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "key"
+          },
+          {
+            "title": "param",
+            "description": " An operation that returns a new state object with a `data` property",
+            "type": {
+              "type": "NameExpression",
+              "name": "function"
+            },
+            "name": "operation"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
+    {
+      "name": "map",
+      "params": {},
+      "docs": {
+        "description": "Iterates over a collection of items and returns a new array of mapped values,\nlike Javascript's `Array.map()` function.\n\nEach item in the source array will be passed into the callback function. The returned value\nwill be added to the new array. The callback is passed the original item, the current index\nin the source array (ie, the nth item number), and the state object.\n\nWrites a new array to `state.data` with transformed values.c array.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "example",
+            "description": "map($.items', (data, index, state) => {\n  return {\n    id: index + 1,\n    name: data.name,\n    createdAt: state.cursor,\n  };\n});",
+            "caption": "Transform an array of items in state"
+          },
+          {
+            "title": "example",
+            "description": "map($.items, async (data, index, state) => {\n  const userInfo = await fetchUserInfo(data.userId);\n  return {\n    id: index + 1,\n    name: data.name,\n    extra: userInfo,\n  };\n});",
+            "caption": "Map items asynchronously (e.g. fetch extra info)"
+          },
+          {
+            "title": "param",
+            "description": "An array of items or a a JSONPath string which points to an array of items.",
+            "type": {
+              "type": "UnionType",
+              "elements": [
+                {
+                  "type": "NameExpression",
+                  "name": "string"
+                },
+                {
+                  "type": "NameExpression",
+                  "name": "Array"
+                }
+              ]
+            },
+            "name": "path"
+          },
+          {
+            "title": "param",
+            "description": "The mapping function, invoked with `(data, index, state)` for each item in the array.",
+            "type": {
+              "type": "NameExpression",
+              "name": "function"
+            },
+            "name": "callback"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "State"
+            }
+          }
+        ]
+      },
+      "valid": false
     }
   ]
 }

package/dist/index.cjs

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   alterState: () => import_language_common3.alterState,
+  as: () => import_language_common3.as,
   cursor: () => import_language_common3.cursor,
   dataPath: () => import_language_common3.dataPath,
   dataValue: () => import_language_common3.dataValue,
@@ -36,6 +37,7 @@ __export(src_exports, {
   group: () => import_language_common3.group,
   http: () => http_exports,
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
+  map: () => import_language_common3.map,
   merge: () => import_language_common3.merge,
   sourceValue: () => import_language_common3.sourceValue
 });
@@ -45,6 +47,7 @@ module.exports = __toCommonJS(src_exports);
 var Adaptor_exports = {};
 __export(Adaptor_exports, {
   alterState: () => import_language_common3.alterState,
+  as: () => import_language_common3.as,
   cursor: () => import_language_common3.cursor,
   dataPath: () => import_language_common3.dataPath,
   dataValue: () => import_language_common3.dataValue,
@@ -59,6 +62,7 @@ __export(Adaptor_exports, {
   getSubmissions: () => getSubmissions,
   group: () => import_language_common3.group,
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
+  map: () => import_language_common3.map,
   merge: () => import_language_common3.merge,
   sourceValue: () => import_language_common3.sourceValue
 });
@@ -305,6 +309,7 @@ var src_default = Adaptor_exports;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   alterState,
+  as,
   cursor,
   dataPath,
   dataValue,
@@ -320,6 +325,7 @@ var src_default = Adaptor_exports;
   group,
   http,
   lastReferenceValue,
+  map,
   merge,
   sourceValue
 });

package/dist/index.js

@@ -8,6 +8,7 @@ var __export = (target, all) => {
 var Adaptor_exports = {};
 __export(Adaptor_exports, {
   alterState: () => alterState,
+  as: () => as,
   cursor: () => cursor,
   dataPath: () => dataPath,
   dataValue: () => dataValue,
@@ -22,6 +23,7 @@ __export(Adaptor_exports, {
   getSubmissions: () => getSubmissions,
   group: () => group,
   lastReferenceValue: () => lastReferenceValue,
+  map: () => map,
   merge: () => merge,
   sourceValue: () => sourceValue
 });
@@ -128,6 +130,7 @@ function maybeStringify(query) {
 // src/Adaptor.js
 import {
   alterState,
+  as,
   cursor,
   dataPath,
   dataValue,
@@ -138,6 +141,7 @@ import {
   fnIf,
   group,
   lastReferenceValue,
+  map,
   merge,
   sourceValue
 } from "@openfn/language-common";
@@ -288,6 +292,7 @@ function put(path, data, options) {
 var src_default = Adaptor_exports;
 export {
   alterState,
+  as,
   cursor,
   dataPath,
   dataValue,
@@ -304,6 +309,7 @@ export {
   group,
   http_exports as http,
   lastReferenceValue,
+  map,
   merge,
   sourceValue
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/language-kobotoolbox",
   "label": "KoboToolbox",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "A KoboToolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {
@@ -18,7 +18,7 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "2.5.0"
+    "@openfn/language-common": "3.0.0"
   },
   "devDependencies": {
     "assertion-error": "^1.0.1",

package/types/Adaptor.d.ts

@@ -63,4 +63,4 @@ export function getSubmissions(formId: string, options?: {
  * @returns {Operation}
  */
 export function getDeploymentInfo(formId: string): Operation;
-export { alterState, cursor, dataPath, dataValue, each, field, fields, fn, fnIf, group, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+export { alterState, as, cursor, dataPath, dataValue, each, field, fields, fn, fnIf, group, lastReferenceValue, map, merge, sourceValue } from "@openfn/language-common";