@openfn/language-kobotoolbox 2.1.0 → 2.3.0

package/ast.json

@@ -99,6 +99,59 @@
       },
       "valid": true
     },
+    {
+      "name": "fnIf",
+      "params": [
+        "condition",
+        "operation"
+      ],
+      "docs": {
+        "description": "A custom operation that will only execute the function if the condition returns true",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "fnIf((state) => state?.data?.name, get(\"https://example.com\"));"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "The condition that returns true",
+            "type": {
+              "type": "NameExpression",
+              "name": "Boolean"
+            },
+            "name": "condition"
+          },
+          {
+            "title": "param",
+            "description": "The operation needed to be executed.",
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            },
+            "name": "operation"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
     {
       "name": "sourceValue",
       "params": [
@@ -472,6 +525,92 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "cursor",
+      "params": [
+        "value",
+        "options"
+      ],
+      "docs": {
+        "description": "Sets a cursor property on state.\nSupports natural language dates like `now`, `today`, `yesterday`, `n hours ago`, `n days ago`, and `start`,\nwhich will be converted relative to the environment (ie, the Lightning or CLI locale). Custom timezones\nare not yet supported.\nYou can provide a formatter to customise the final cursor value, which is useful for normalising\ndifferent inputs. The custom formatter runs after natural language date conversion.\nSee the usage guide at {@link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "cursor($.cursor, { defaultValue: 'today' })",
+            "caption": "Use a cursor from state if present, or else use the default value"
+          },
+          {
+            "title": "example",
+            "description": "cursor(22)",
+            "caption": "Use a pagination cursor"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "the cursor value. Usually an ISO date, natural language date, or page number",
+            "type": {
+              "type": "NameExpression",
+              "name": "any"
+            },
+            "name": "value"
+          },
+          {
+            "title": "param",
+            "description": "options to control the cursor.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "options"
+          },
+          {
+            "title": "param",
+            "description": "set the cursor key. Will persist through the whole run.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "options.key"
+          },
+          {
+            "title": "param",
+            "description": "the value to use if value is falsy",
+            "type": {
+              "type": "NameExpression",
+              "name": "any"
+            },
+            "name": "options.defaultValue"
+          },
+          {
+            "title": "param",
+            "description": "custom formatter for the final cursor value",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "options.format"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "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_common2.alterState,
+  cursor: () => import_language_common2.cursor,
   dataPath: () => import_language_common2.dataPath,
   dataValue: () => import_language_common2.dataValue,
   default: () => src_default,
@@ -28,6 +29,7 @@ __export(src_exports, {
   field: () => import_language_common2.field,
   fields: () => import_language_common2.fields,
   fn: () => import_language_common2.fn,
+  fnIf: () => import_language_common2.fnIf,
   getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
@@ -42,6 +44,7 @@ module.exports = __toCommonJS(src_exports);
 var Adaptor_exports = {};
 __export(Adaptor_exports, {
   alterState: () => import_language_common2.alterState,
+  cursor: () => import_language_common2.cursor,
   dataPath: () => import_language_common2.dataPath,
   dataValue: () => import_language_common2.dataValue,
   each: () => import_language_common2.each,
@@ -49,6 +52,7 @@ __export(Adaptor_exports, {
   field: () => import_language_common2.field,
   fields: () => import_language_common2.fields,
   fn: () => import_language_common2.fn,
+  fnIf: () => import_language_common2.fnIf,
   getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
@@ -139,6 +143,7 @@ var src_default = Adaptor_exports;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   alterState,
+  cursor,
   dataPath,
   dataValue,
   each,
@@ -146,6 +151,7 @@ var src_default = Adaptor_exports;
   field,
   fields,
   fn,
+  fnIf,
   getDeploymentInfo,
   getForms,
   getSubmissions,

package/dist/index.js

@@ -8,6 +8,7 @@ var __export = (target, all) => {
 var Adaptor_exports = {};
 __export(Adaptor_exports, {
   alterState: () => alterState,
+  cursor: () => cursor,
   dataPath: () => dataPath,
   dataValue: () => dataValue,
   each: () => each,
@@ -15,6 +16,7 @@ __export(Adaptor_exports, {
   field: () => field,
   fields: () => fields,
   fn: () => fn,
+  fnIf: () => fnIf,
   getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
@@ -30,13 +32,15 @@ import {
   http
 } from "@openfn/language-common";
 import {
-  fn,
   alterState,
+  cursor,
   dataPath,
   dataValue,
   each,
   field,
   fields,
+  fn,
+  fnIf,
   http as http2,
   lastReferenceValue,
   merge,
@@ -121,6 +125,7 @@ function getDeploymentInfo(params, callback) {
 var src_default = Adaptor_exports;
 export {
   alterState,
+  cursor,
   dataPath,
   dataValue,
   src_default as default,
@@ -129,6 +134,7 @@ export {
   field,
   fields,
   fn,
+  fnIf,
   getDeploymentInfo,
   getForms,
   getSubmissions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-kobotoolbox",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "A Kobo Toolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {
@@ -17,10 +17,9 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "^1.8.1"
+    "@openfn/language-common": "^1.14.0"
   },
   "devDependencies": {
-    "@openfn/buildtools": "^1.0.2",
     "assertion-error": "^1.0.1",
     "chai": "^3.4.0",
     "deep-eql": "^0.1.3",

package/types/Adaptor.d.ts

@@ -51,4 +51,4 @@ export function getSubmissions(params: object, callback: Function): Operation;
  * @returns {Operation}
  */
 export function getDeploymentInfo(params: object, callback: Function): Operation;
-export { fn, alterState, dataPath, dataValue, each, field, fields, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+export { alterState, cursor, dataPath, dataValue, each, field, fields, fn, fnIf, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";