@openfn/language-kobotoolbox 4.0.0 → 4.1.0

package/ast.json

@@ -60,6 +60,16 @@
             "description": "getSubmissions('aXecHjmbATuF6iGFmvBLBX', { query: { _submission_time:{ $gte: \"2025-03-12T21:54:20\" } } });",
             "caption": "Get form submissions with a query"
           },
+          {
+            "title": "example",
+            "description": "getSubmissions('aXecHjmbATuF6iGFmvBLBX', { sort: { _submission_time: -1 } });",
+            "caption": "Get form submissions with sorting"
+          },
+          {
+            "title": "example",
+            "description": "getSubmissions('aXecHjmbATuF6iGFmvBLBX', { start: 10 });",
+            "caption": "Get form submissions with specific start index"
+          },
           {
             "title": "function",
             "description": null,
@@ -92,6 +102,18 @@
             "name": "options",
             "default": "{}"
           },
+          {
+            "title": "param",
+            "description": "Field and direction to sort submissions by.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "object"
+              }
+            },
+            "name": "options.sort"
+          },
           {
             "title": "param",
             "description": "Query options to filter the submissions. See query operators {@link http://docs.mongodb.org/manual/reference/operator/query/.}",
@@ -104,6 +126,19 @@
             },
             "name": "options.query"
           },
+          {
+            "title": "param",
+            "description": "The index of the first submission to return.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "number"
+              }
+            },
+            "name": "options.start",
+            "default": "0"
+          },
           {
             "title": "param",
             "description": "Maximum number of submissions to fetch. Pass Infinity to disable the limit and download all submissions",

package/dist/index.cjs

@@ -151,6 +151,9 @@ async function requestWithPagination(state, path, options = {}) {
   } while (shouldFetchMoreContent);
   return results;
 }
+function maybeStringify(query) {
+  return typeof query === "string" ? query : JSON.stringify(query);
+}
 
 // src/Adaptor.js
 var import_language_common3 = require("@openfn/language-common");
@@ -183,18 +186,18 @@ function getSubmissions(formId, options) {
       formId,
       options
     );
-    const { query, limit, pageSize } = resolvedOptions;
+    const { query, limit, pageSize, sort, start } = resolvedOptions;
     const path = `/assets/${resolvedFormId}/data/`;
     const qs = {};
     if (query) {
-      if (typeof query === "string") {
-        qs.query = query;
-      } else {
-        qs.query = JSON.stringify(query);
-      }
+      qs.query = maybeStringify(query);
+    }
+    if (sort) {
+      qs.sort = maybeStringify(sort);
     }
     const requestOptions = {
       query: { ...qs },
+      start,
       limit,
       pageSize
     };

package/dist/index.js

@@ -121,6 +121,9 @@ async function requestWithPagination(state, path, options = {}) {
   } while (shouldFetchMoreContent);
   return results;
 }
+function maybeStringify(query) {
+  return typeof query === "string" ? query : JSON.stringify(query);
+}
 
 // src/Adaptor.js
 import {
@@ -167,18 +170,18 @@ function getSubmissions(formId, options) {
       formId,
       options
     );
-    const { query, limit, pageSize } = resolvedOptions;
+    const { query, limit, pageSize, sort, start } = resolvedOptions;
     const path = `/assets/${resolvedFormId}/data/`;
     const qs = {};
     if (query) {
-      if (typeof query === "string") {
-        qs.query = query;
-      } else {
-        qs.query = JSON.stringify(query);
-      }
+      qs.query = maybeStringify(query);
+    }
+    if (sort) {
+      qs.sort = maybeStringify(sort);
     }
     const requestOptions = {
       query: { ...qs },
+      start,
       limit,
       pageSize
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/language-kobotoolbox",
   "label": "KoboToolbox",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "A KoboToolbox Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "repository": {

package/types/Adaptor.d.ts

@@ -29,18 +29,26 @@ export function getForms(): Operation;
  * getSubmissions('aXecHjmbATuF6iGFmvBLBX', { limit: Infinity });
  * @example <caption>Get form submissions with a query</caption>
  * getSubmissions('aXecHjmbATuF6iGFmvBLBX', { query: { _submission_time:{ $gte: "2025-03-12T21:54:20" } } });
+ * @example <caption>Get form submissions with sorting</caption>
+ * getSubmissions('aXecHjmbATuF6iGFmvBLBX', { sort: { _submission_time: -1 } });
+ * @example <caption>Get form submissions with specific start index</caption>
+ * getSubmissions('aXecHjmbATuF6iGFmvBLBX', { start: 10 });
  * @function
  * @public
  * @param {string} formId - Form Id to get the specific submissions
  * @param {object} [options={}] - Options to control the request
+ * @param {object} [options.sort] - Field and direction to sort submissions by.
  * @param {object} [options.query] - Query options to filter the submissions. See query operators {@link http://docs.mongodb.org/manual/reference/operator/query/.}
+ * @param {number} [options.start=0] - The index of the first submission to return.
  * @param {number} [options.limit=30000] - Maximum number of submissions to fetch. Pass Infinity to disable the limit and download all submissions
  * @param {number} [options.pageSize=10000] - Limits the size of each page of submissions. Maximum value is 30000.
  * @state data - an array of submission objects
  * @returns {Operation}
  */
 export function getSubmissions(formId: string, options?: {
+    sort?: object;
     query?: object;
+    start?: number;
     limit?: number;
     pageSize?: number;
 }): Operation;

package/types/util.d.ts

@@ -1,5 +1,6 @@
 export function prepareNextState(state: any, response: any): any;
 export function request(state: any, method: any, path: any, opts?: {}): Promise<any>;
 export function requestWithPagination(state: any, path: any, options?: {}): Promise<any[]>;
+export function maybeStringify(query: any): string;
 export const DEFAULT_LIMIT: 30000;
 export const DEFAULT_PAGE_SIZE: 10000;