feat:process-records-utility (#284)

.changeset/angry-ears-boil.md

@@ -0,0 +1,5 @@
+---
+'@flatfile/util-common': patch
+---
+
+Added a utility to process all records

utils/common/package.json

@@ -22,5 +22,8 @@
     "url": "https://github.com/FlatFilers/flatfile-plugins.git",
     "directory": "utils/common"
   },
-  "license": "ISC"
+  "license": "ISC",
+  "dependencies": {
+    "@flatfile/api": "^1.5.32"
+  }
 }

utils/common/src/index.ts

@@ -1,2 +1,3 @@
 export * from './async.batch'
 export * from './logging.helper'
+export * from './process.records'

utils/common/src/process.records.ts

@@ -0,0 +1,28 @@
+import api, { Flatfile } from '@flatfile/api'
+
+export async function processRecords<R>(
+  sheetId: string,
+  callback: (records: Flatfile.RecordsWithLinks) => R,
+  recordGetOptions?: Omit<Flatfile.records.GetRecordsRequest, 'pageNumber'>
+): Promise<R[]> {
+  let pageNumber = 1
+  const results: R[] = []
+
+  while (true) {
+    const {
+      data: { records },
+    } = await api.records.get(sheetId, {
+      ...recordGetOptions,
+      pageNumber: pageNumber++,
+    })
+
+    if (records.length === 0) {
+      break
+    }
+
+    const result = callback(records)
+    results.push(result)
+  }
+
+  return results
+}