@openfn/language-kobotoolbox 1.0.4 → 1.1.0

package/README.md

@@ -21,7 +21,7 @@ Language Pack for building expressions and operations to interact with the
 #### Get the list of forms
 
 ```js
-getForms(state => {
+getForms({}, state => {
   console.log(state.data);
   return state;
 });
@@ -33,8 +33,7 @@ A query can be used to filter results.
 
 ```js
 getSubmissions(
-  'aXecHjmbATuF6iGFmvBLBX',
-  { query: { end: { $gte: '2020-11-20' } } },
+  { formId: 'aXecHjmbATuF6iGFmvBLBX', query: { end: { $gte: '2020-11-20' } } },
   state => {
     console.log(state.data);
     return state;
@@ -44,8 +43,10 @@ getSubmissions(
 
 ## Development
 
-Clone the repo, run `npm install`.
+Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the `Getting Started` guide inside to get set up.
 
-Run tests using `npm run test` or `npm run test:watch`
+Run tests using `pnpm run test` or `pnpm run test:watch`
 
-Build the project using `make`.
+Build the project using `pnpm build`.
+
+To just build the docs run `pnpm build docs`

package/configuration-schema.json

@@ -0,0 +1,45 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "properties": {
+        "baseURL": {
+            "title": "Base URL",
+            "type": "string",
+            "default": "https://kf.kobotoolbox.org",
+            "description": "Kobotoolbox URL",
+            "format": "uri",
+            "minLength": 1
+        },
+        "username": {
+            "title": "Username",
+            "type": "string",
+            "description": "Kobotoolbox username",
+            "minLength": 1
+        },
+        "password": {
+            "title": "Password",
+            "type": "string",
+            "description": "Kobotoolbox password",
+            "writeOnly": true,
+            "minLength": 1
+        },
+        "apiVersion": {
+            "title": "API Version",
+            "type": "string",
+            "default": "v2",
+            "description": "Kobotoolbox API version to use",
+            "enum": [
+                "v1",
+                "v2"
+            ],
+            "minLength": 1
+        }
+    },
+    "type": "object",
+    "additionalProperties": true,
+    "required": [
+        "username",
+        "baseURL",
+        "password",
+        "apiVersion"
+    ]
+}

package/dist/index.cjs

@@ -0,0 +1,105 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  Adaptor: () => Adaptor_exports,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  alterState: () => import_language_common2.alterState,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  each: () => import_language_common2.each,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  getForms: () => getForms,
+  getSubmissions: () => getSubmissions,
+  http: () => import_language_common2.http,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue
+});
+var import_language_common = require("@openfn/language-common");
+var import_language_common2 = require("@openfn/language-common");
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return (0, import_language_common.execute)(...operations)({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function getForms(params, callback) {
+  return (state) => {
+    params = (0, import_language_common.expandReferences)(params)(state);
+    const { baseURL, apiVersion, username, password } = state.configuration;
+    const url = `${baseURL}/api/${apiVersion}/assets/?format=json`;
+    const auth = { username, password };
+    const config = {
+      url,
+      params,
+      auth
+    };
+    return import_language_common.http.get(config)(state).then((response) => {
+      console.log("\u2713", response.data.count, "forms fetched.");
+      const nextState = (0, import_language_common.composeNextState)(state, response.data);
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function getSubmissions(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}/data/?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", response.data.count, "submissions 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
+});

package/dist/index.js

@@ -0,0 +1,101 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  alterState: () => alterState,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  each: () => each,
+  execute: () => execute,
+  field: () => field,
+  fields: () => fields,
+  getForms: () => getForms,
+  getSubmissions: () => getSubmissions,
+  http: () => http2,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  sourceValue: () => sourceValue
+});
+import {
+  execute as commonExecute,
+  composeNextState,
+  expandReferences,
+  http
+} from "@openfn/language-common";
+import {
+  alterState,
+  dataPath,
+  dataValue,
+  each,
+  field,
+  fields,
+  http as http2,
+  lastReferenceValue,
+  merge,
+  sourceValue
+} from "@openfn/language-common";
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return commonExecute(...operations)({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function getForms(params, callback) {
+  return (state) => {
+    params = expandReferences(params)(state);
+    const { baseURL, apiVersion, username, password } = state.configuration;
+    const url = `${baseURL}/api/${apiVersion}/assets/?format=json`;
+    const auth = { username, password };
+    const config = {
+      url,
+      params,
+      auth
+    };
+    return http.get(config)(state).then((response) => {
+      console.log("\u2713", response.data.count, "forms fetched.");
+      const nextState = composeNextState(state, response.data);
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function getSubmissions(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}/data/?format=json`;
+    const auth = { username, password };
+    const config = {
+      url,
+      params: params.query,
+      auth
+    };
+    return http.get(config)(state).then((response) => {
+      console.log("\u2713", response.data.count, "submissions 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
+};

package/package.json

@@ -1,39 +1,45 @@
 {
   "name": "@openfn/language-kobotoolbox",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "A Kobo Toolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {
     "type": "git",
-    "url": "https://github.com/openfn/language-kobotoolbox.git"
-  },
-  "main": "lib/index.js",
-  "scripts": {
-    "build": "make",
-    "test": "mocha --require @babel/register",
-    "test:watch": "mocha -w --require @babel/register"
+    "url": "https://github.com/openfn/adaptors.git"
   },
+  "main": "dist/index.cjs",
   "author": "Open Function Group",
   "license": "LGPLv3",
   "files": [
-    "lib/"
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "1.1.0"
+    "@openfn/language-common": "1.7.4"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-function-bind": "^7.8.3",
-    "@babel/preset-env": "^7.9.5",
-    "@babel/preset-stage-0": "^7.8.3",
-    "@babel/register": "^7.9.0",
+    "@openfn/buildtools": "^1.0.2",
     "assertion-error": "^1.0.1",
     "chai": "^3.4.0",
     "deep-eql": "^0.1.3",
-    "jsdoc": "^3.6.6",
+    "esno": "^0.16.3",
     "mocha": "^7.1.1",
     "nock": "^12.0.3",
-    "sinon": "^1.17.2"
+    "rimraf": "^3.0.2"
+  },
+  "type": "module",
+  "types": "types/index.d.ts",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "scripts": {
+    "build": "pnpm clean && build-adaptor kobotoolbox",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rimraf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist"
   }
-}
+}

package/types/Adaptor.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute`, and prepends initial state for http.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @function
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+export function execute(...operations: Operations): Operation;
+/**
+ * Make a request to get the list of forms
+ * @public
+ * @example
+ * getForms({}, state => {
+ *    console.log(state.data);
+ *    return state;
+ * });
+ * @function
+ * @param {object} params - Query, Headers and Authentication parameters
+ * @param {function} callback - (Optional) Callback function to execute after fetching form list
+ * @returns {Operation}
+ */
+export function getForms(params: object, callback: Function): Operation;
+/**
+ * Get submissions for a specific form
+ * @example
+ * getSubmissions({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 submissions
+ * @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";

package/types/index.d.ts

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

package/lib/Adaptor.js

@@ -1,190 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.execute = execute;
-exports.getForms = getForms;
-exports.getSubmissions = getSubmissions;
-Object.defineProperty(exports, "alterState", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.alterState;
-  }
-});
-Object.defineProperty(exports, "dataPath", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.dataPath;
-  }
-});
-Object.defineProperty(exports, "dataValue", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.dataValue;
-  }
-});
-Object.defineProperty(exports, "each", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.each;
-  }
-});
-Object.defineProperty(exports, "field", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.field;
-  }
-});
-Object.defineProperty(exports, "fields", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.fields;
-  }
-});
-Object.defineProperty(exports, "http", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.http;
-  }
-});
-Object.defineProperty(exports, "lastReferenceValue", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.lastReferenceValue;
-  }
-});
-Object.defineProperty(exports, "merge", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.merge;
-  }
-});
-Object.defineProperty(exports, "sourceValue", {
-  enumerable: true,
-  get: function get() {
-    return _languageCommon.sourceValue;
-  }
-});
-
-var _languageCommon = require("@openfn/language-common");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-/**
- * Execute a sequence of operations.
- * Wraps `language-common/execute`, and prepends initial state for http.
- * @example
- * execute(
- *   create('foo'),
- *   delete('bar')
- * )(state)
- * @function
- * @param {Operations} operations - Operations to be performed.
- * @returns {Operation}
- */
-function execute() {
-  for (var _len = arguments.length, operations = new Array(_len), _key = 0; _key < _len; _key++) {
-    operations[_key] = arguments[_key];
-  }
-
-  var initialState = {
-    references: [],
-    data: null
-  };
-  return function (state) {
-    return _languageCommon.execute.apply(void 0, operations)(_objectSpread(_objectSpread({}, initialState), state));
-  };
-}
-/**
- * Make a request to get the list of forms
- * @public
- * @example
- * getForms(state => {
- *    console.log(state.data);
- *    return state;
- * });
- * @function
- * @param {function} callback - callback to execute after fetching form list
- * @returns {Operation}
- */
-
-
-function getForms(callback) {
-  return function (state) {
-    var _state$configuration = state.configuration,
-        baseURL = _state$configuration.baseURL,
-        apiVersion = _state$configuration.apiVersion,
-        username = _state$configuration.username,
-        password = _state$configuration.password;
-    return _languageCommon.http.get({
-      baseURL: baseURL,
-      url: "api/".concat(apiVersion, "/assets/?format=json"),
-      auth: {
-        username: username,
-        password: password
-      }
-    })(state).then(function (response) {
-      console.log('✓', response.data.count, 'forms fetched.');
-      var nextState = (0, _languageCommon.composeNextState)(state, response.data);
-      if (callback) return callback(nextState);
-      return nextState;
-    })["catch"](function (error) {
-      console.log(error);
-      return error;
-    });
-  };
-}
-/**
- * Get submissions for a specific form
- * @example
- * getSubmissions('aXecHjmbATuF6iGFmvBLBX', {}, state => {
- *   console.log(state.data);
- *   return state;
- * });
- * @function
- * @param {string} formId - id of the form
- * @param {object} params - data to make the fetch or filter
- * @param {function} callback - callback to execute after fetching form submissions.
- * @returns {Operation}
- */
-
-
-function getSubmissions(formId, params, callback) {
-  return function (state) {
-    var _state$configuration2 = state.configuration,
-        baseURL = _state$configuration2.baseURL,
-        apiVersion = _state$configuration2.apiVersion,
-        username = _state$configuration2.username,
-        password = _state$configuration2.password;
-
-    var _expandReferences = (0, _languageCommon.expandReferences)(params)(state),
-        body = _expandReferences.body,
-        headers = _expandReferences.headers,
-        query = _expandReferences.query;
-
-    return _languageCommon.http.get({
-      baseURL: baseURL,
-      url: "api/".concat(apiVersion, "/assets/").concat(formId, "/data/?format=json"),
-      auth: {
-        username: username,
-        password: password
-      },
-      params: {
-        query: JSON.stringify(query)
-      }
-    })(state).then(function (response) {
-      console.log('✓', response.data.count, 'submissions fetched.');
-      var nextState = (0, _languageCommon.composeNextState)(state, response.data);
-      if (callback) return callback(nextState);
-      return nextState;
-    })["catch"](function (error) {
-      console.log(error);
-      return error;
-    });
-  };
-}

package/lib/index.js

@@ -1,19 +0,0 @@
-"use strict";
-
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Adaptor = exports["default"] = void 0;
-
-var Adaptor = _interopRequireWildcard(require("./Adaptor"));
-
-exports.Adaptor = Adaptor;
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-var _default = Adaptor;
-exports["default"] = _default;