@openfn/language-kobotoolbox 2.2.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": [
@@ -480,7 +533,7 @@
         "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.\nSee the usage guide at @{link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}",
+        "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",
@@ -538,6 +591,15 @@
             },
             "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,

package/dist/index.cjs

@@ -29,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,
@@ -51,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,
@@ -149,6 +151,7 @@ var src_default = Adaptor_exports;
   field,
   fields,
   fn,
+  fnIf,
   getDeploymentInfo,
   getForms,
   getSubmissions,

package/dist/index.js

@@ -16,6 +16,7 @@ __export(Adaptor_exports, {
   field: () => field,
   fields: () => fields,
   fn: () => fn,
+  fnIf: () => fnIf,
   getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
@@ -39,6 +40,7 @@ import {
   field,
   fields,
   fn,
+  fnIf,
   http as http2,
   lastReferenceValue,
   merge,
@@ -132,6 +134,7 @@ export {
   field,
   fields,
   fn,
+  fnIf,
   getDeploymentInfo,
   getForms,
   getSubmissions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-kobotoolbox",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "A Kobo Toolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {
@@ -17,7 +17,7 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "^1.13.0"
+    "@openfn/language-common": "^1.14.0"
   },
   "devDependencies": {
     "assertion-error": "^1.0.1",

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 { alterState, cursor, dataPath, dataValue, each, field, fields, fn, 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";