@openfn/language-kobotoolbox 1.1.1 → 1.3.0

package/README.md

@@ -1,4 +1,4 @@
-# Language KoboToolbox [![Build Status](https://travis-ci.org/OpenFn/language-kobotoolbox.svg?branch=master)](https://travis-ci.org/OpenFn/language-kobotoolbox)
+# Language KoboToolbox
 
 Language Pack for building expressions and operations to interact with the
 [TEMPLATE] API.
@@ -43,7 +43,8 @@ getSubmissions(
 
 ## Development
 
-Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the `Getting Started` guide inside to get set up.
+Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
+`Getting Started` guide inside to get set up.
 
 Run tests using `pnpm run test` or `pnpm run test:watch`
 

package/ast.json

@@ -56,6 +56,49 @@
   ],
   "exports": [],
   "common": [
+    {
+      "name": "fn",
+      "params": [
+        "func"
+      ],
+      "docs": {
+        "description": "Creates a custom step (or operation) for more flexible job writing.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "fn(state => {\n  // do some things to state\n  return state;\n});"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "is the function",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "func"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
     {
       "name": "sourceValue",
       "params": [

package/dist/index.cjs

@@ -19,8 +19,22 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.js
 var src_exports = {};
 __export(src_exports, {
-  Adaptor: () => Adaptor_exports,
-  default: () => src_default
+  alterState: () => import_language_common2.alterState,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  default: () => src_default,
+  each: () => import_language_common2.each,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  getDeploymentInfo: () => getDeploymentInfo,
+  getForms: () => getForms,
+  getSubmissions: () => getSubmissions,
+  http: () => import_language_common2.http,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -34,6 +48,8 @@ __export(Adaptor_exports, {
   execute: () => execute,
   field: () => import_language_common2.field,
   fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
   http: () => import_language_common2.http,
@@ -96,10 +112,45 @@ function getSubmissions(params, callback) {
     });
   };
 }
+function getDeploymentInfo(params, callback) {
+  return (state) => {
+    params = (0, import_language_common.expandReferences)(params)(state);
+    const { baseURL, apiVersion, username, password } = state.configuration;
+    const { formId } = params;
+    const url = `${baseURL}/api/${apiVersion}/assets/${formId}/deployment/?format=json`;
+    const auth = { username, password };
+    const config = {
+      url,
+      params: params.query,
+      auth
+    };
+    return import_language_common.http.get(config)(state).then((response) => {
+      console.log("\u2713", "deployment information fetched.");
+      const nextState = (0, import_language_common.composeNextState)(state, response.data);
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
 
 // src/index.js
 var src_default = Adaptor_exports;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Adaptor
+  alterState,
+  dataPath,
+  dataValue,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  getDeploymentInfo,
+  getForms,
+  getSubmissions,
+  http,
+  lastReferenceValue,
+  merge,
+  sourceValue
 });

package/dist/index.js

@@ -14,6 +14,8 @@ __export(Adaptor_exports, {
   execute: () => execute,
   field: () => field,
   fields: () => fields,
+  fn: () => fn,
+  getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
   http: () => http2,
@@ -28,6 +30,7 @@ import {
   http
 } from "@openfn/language-common";
 import {
+  fn,
   alterState,
   dataPath,
   dataValue,
@@ -92,10 +95,45 @@ function getSubmissions(params, callback) {
     });
   };
 }
+function getDeploymentInfo(params, callback) {
+  return (state) => {
+    params = expandReferences(params)(state);
+    const { baseURL, apiVersion, username, password } = state.configuration;
+    const { formId } = params;
+    const url = `${baseURL}/api/${apiVersion}/assets/${formId}/deployment/?format=json`;
+    const auth = { username, password };
+    const config = {
+      url,
+      params: params.query,
+      auth
+    };
+    return http.get(config)(state).then((response) => {
+      console.log("\u2713", "deployment information fetched.");
+      const nextState = composeNextState(state, response.data);
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
 
 // src/index.js
 var src_default = Adaptor_exports;
 export {
-  Adaptor_exports as Adaptor,
-  src_default as default
+  alterState,
+  dataPath,
+  dataValue,
+  src_default as default,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  getDeploymentInfo,
+  getForms,
+  getSubmissions,
+  http2 as http,
+  lastReferenceValue,
+  merge,
+  sourceValue
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-kobotoolbox",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "A Kobo Toolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {

package/types/Adaptor.d.ts

@@ -38,4 +38,17 @@ export function getForms(params: object, callback: Function): Operation;
  * @returns {Operation}
  */
 export function getSubmissions(params: object, callback: Function): Operation;
-export { alterState, dataPath, dataValue, each, field, fields, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+/**
+ * Get deployment information for a specific form
+ * @example
+ * getDeploymentInfo({formId: 'aXecHjmbATuF6iGFmvBLBX'}, state => {
+ *   console.log(state.data);
+ *   return state;
+ * });
+ * @function
+ * @param {object} params - Form Id and data to make the fetch or filter
+ * @param {function} callback - (Optional) Callback function to execute after fetching form deployment information
+ * @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";

package/types/index.d.ts

@@ -1,3 +1,3 @@
-export { Adaptor };
 export default Adaptor;
+export * from "./Adaptor";
 import * as Adaptor from "./Adaptor";