@openfn/language-kobotoolbox 1.2.0 → 1.3.1

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/configuration-schema.json

@@ -7,20 +7,29 @@
             "default": "https://kf.kobotoolbox.org",
             "description": "Kobotoolbox URL",
             "format": "uri",
-            "minLength": 1
+            "minLength": 1,
+            "examples": [
+                "https://kf.kobotoolbox.org"
+            ]
         },
         "username": {
             "title": "Username",
             "type": "string",
             "description": "Kobotoolbox username",
-            "minLength": 1
+            "minLength": 1,
+            "examples": [
+                "test@openfn.org"
+            ]
         },
         "password": {
             "title": "Password",
             "type": "string",
             "description": "Kobotoolbox password",
             "writeOnly": true,
-            "minLength": 1
+            "minLength": 1,
+            "examples": [
+                "@some(!)Strongpassword"
+            ]
         },
         "apiVersion": {
             "title": "API Version",
@@ -31,7 +40,10 @@
                 "v1",
                 "v2"
             ],
-            "minLength": 1
+            "minLength": 1,
+            "examples": [
+                "v2"
+            ]
         }
     },
     "type": "object",

package/dist/index.cjs

@@ -28,6 +28,7 @@ __export(src_exports, {
   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,
@@ -48,6 +49,7 @@ __export(Adaptor_exports, {
   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,
@@ -110,6 +112,27 @@ 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;
@@ -123,6 +146,7 @@ var src_default = Adaptor_exports;
   field,
   fields,
   fn,
+  getDeploymentInfo,
   getForms,
   getSubmissions,
   http,

package/dist/index.js

@@ -15,6 +15,7 @@ __export(Adaptor_exports, {
   field: () => field,
   fields: () => fields,
   fn: () => fn,
+  getDeploymentInfo: () => getDeploymentInfo,
   getForms: () => getForms,
   getSubmissions: () => getSubmissions,
   http: () => http2,
@@ -94,6 +95,27 @@ 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;
@@ -107,6 +129,7 @@ export {
   field,
   fields,
   fn,
+  getDeploymentInfo,
   getForms,
   getSubmissions,
   http2 as http,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-kobotoolbox",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "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;
+/**
+ * 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";