@beauraines/node-helpers 4.0.3 → 4.0.4

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [4.0.3](https://github.com/beauraines/node-helpers/compare/v4.0.1...v4.0.3) (2023-07-16)
+### [4.0.4](https://github.com/beauraines/node-helpers/compare/v4.0.1...v4.0.4) (2023-07-16)
 
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {

package/src/callAPI.js

@@ -0,0 +1,147 @@
+const fetch = require('node-fetch')
+
+
+// TODO query string builder?
+// Other than JSON responses?
+
+/**
+ * Makes a GET request
+ * 
+ * @param {string} url URL for request
+ * @param {object} [headers] Headers object
+ * @returns {Promise} JSON response
+ * @throws {Error} if response is not okay 
+ */
+const getRequest = async (url,headers) => {
+    const response = await fetch(url,{
+        method: 'GET',
+        headers,
+    });
+
+    let responseBody
+    if (response.ok) {
+        responseBody = await response.json()
+    } else {
+        throw new Error(response.statusText)
+    }
+    return responseBody
+}
+
+/**
+ * Makes a GET request
+ * 
+ * @param {string} url URL for request
+ * @param {object} [headers] Headers object
+ * @returns {Promise} Blob response
+ * @throws {Error} if response is not okay 
+ */
+const getRequestBlob = async (url,headers) => {
+    const response = await fetch(url,{
+        method: 'GET',
+        headers
+    });
+
+    let responseBody
+    if (response.ok) {
+        responseBody = await response.blob()
+    } else {
+        throw new Error(response.statusText)
+    }
+    return responseBody
+}
+
+/**
+ * Makes synchronous POST request to a specified URL using Bearer Token authorization and
+ * returns the JSON response
+ * 
+ * @param {string} url
+ * @param {object} requestBody
+ * @param {string} token
+ * @param {object} [headers]
+ * @returns {object}
+ * @throws {Error} if the response is not OK
+ */
+const postRequest = async (url,requestBody,token,headers) => {
+    const response = await fetch(url,{
+        method: 'POST',
+        headers: {
+            'Authorization': 'Bearer ' + token,
+            'Content-Type': 'application/json',
+            ... headers
+        },
+        body: JSON.stringify(requestBody)
+    });
+
+    let responseBody
+    if (response.ok) {
+        responseBody = await response.json()
+    } else {
+        throw new Error(response.statusText)
+    }
+    return responseBody
+}
+
+/**
+ * Makes synchronous POST request to a specified URL using Bearer Token authorization and
+ * returns the JSON response
+ * 
+ * @param url {string}
+ * @param requestBody {object}
+ * @param token {string}
+ * @param [headers] {object}
+ * @returns {object}
+ * @throws {Error} if the response is not OK
+ */
+const postRequestPaginated = async (url,requestBody,token,headers) => {
+    let responseBody = await postRequest(url,requestBody,token,headers)
+    if (responseBody.totalCount < responseBody.pageSize) {
+        return responseBody
+    }
+
+    let requestBodies = []
+    // TODO make these pagination properties arguments
+    let pageSize = responseBody.pageSize
+    let total = responseBody.totalCount
+    let start = responseBody.start
+    let end = responseBody.end
+    let totalPages = 1
+    while (end < total) {
+        requestBodies.push(
+            {
+                ... requestBody,
+                start: start + pageSize,
+                end: end + pageSize
+            }
+        )
+        totalPages++
+    }
+
+    let paginatedResponseBodyPromises = []
+    for (const requestBody of requestBodies) {
+        let paginatedResponseBody = postRequest(url,requestBody,token,headers)
+        paginatedResponseBodyPromises.concat(paginatedResponseBody)
+    }
+    
+    let paginatedResponseBodies = await Promise.all(paginatedResponseBodyPromises);
+    for ( const body of paginatedResponseBodies ) {
+        responseBody.data.concat(body.data)
+    }
+
+    // TODO update the pagination properties to show all data returned
+    responseBody.start = 1,
+    responseBody.end = end
+    responseBody.totalPages = totalPages
+    responseBody.pageSize = 500
+    if (responseBody.totalCount != responseBody.data.length) {
+        throw new Error('Response data does not equql total records') 
+    }
+    
+    return responseBody
+}
+
+module.exports = {
+    getRequest,
+    getRequestBlob, 
+    postRequest, 
+    postRequestPaginated
+}