@foxtware/mineral 0.1.15 → 0.1.16

package/api/google/googlesheetsSpreadsheetSheetAdd.js

@@ -0,0 +1,150 @@
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleSheets, googleApiCall } = require('../google/google.utils');
+const { googlesheetsSpreadsheetTrim } = require('../google/googlesheetsSpreadsheetTrim');
+
+const spreadsheetIdentifierValidator = (spreadsheetIdentifier) => {
+  return objHasAny(spreadsheetIdentifier, ['spreadsheetId']);
+};
+
+const dataValidator = (data) => {
+  return objHasAny(data, ['objArray']) && Array.isArray(data.objArray);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['spreadsheetIdentifier', spreadsheetIdentifierValidator],
+  ['data', dataValidator],
+]);
+
+const googlesheetsSpreadsheetSheetAdd = async (
+  credsPayload,
+  spreadsheetIdentifier,
+  data,
+  {
+    sheetName = String(Date.now()),
+    trim = true,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    spreadsheetIdentifier,
+    data,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { spreadsheetId } = spreadsheetIdentifier;
+  const { objArray } = data;
+
+  const { client, error } = await getGoogleSheets(credsPayload);
+
+  if (error) {
+    return error;
+  }
+
+  const allKeys = new Set();
+  for (const obj of objArray) {
+    if (obj && typeof obj === 'object') {
+      Object.keys(obj).forEach((key) => allKeys.add(key));
+    }
+  }
+  const headers = Array.from(allKeys);
+
+  if (!headers.length) {
+    return {
+      ok: false,
+      error: {
+        code: 'EMPTY_OBJ_ARRAY',
+        message: 'objArray contains no valid objects with keys',
+      },
+    };
+  }
+
+  const values = [
+    headers,
+    ...objArray.map((obj) => {
+      return headers.map((header) => {
+        const value = obj?.[header];
+        return value === null || value === undefined ? '' : value;
+      });
+    }),
+  ];
+
+  const batchUpdateResponse = await googleApiCall(() => client.spreadsheets.batchUpdate({
+    spreadsheetId,
+    requestBody: {
+      requests: [
+        {
+          addSheet: {
+            properties: {
+              title: String(sheetName),
+            },
+          },
+        },
+      ],
+    },
+  }));
+
+  if (!batchUpdateResponse.ok) {
+    return batchUpdateResponse;
+  }
+
+  const newSheetId = batchUpdateResponse.data.replies[0].addSheet.properties.sheetId;
+
+  const updateResponse = await googleApiCall(() => client.spreadsheets.values.update({
+    spreadsheetId,
+    range: `${ sheetName }!A1`,
+    valueInputOption: 'RAW',
+    requestBody: {
+      values,
+    },
+  }));
+
+  if (!updateResponse.ok) {
+    return updateResponse;
+  }
+
+  if (trim) {
+    googlesheetsSpreadsheetTrim(
+      credsPayload,
+      spreadsheetIdentifier,
+    );
+  }
+
+  const sheetUrl = `https://docs.google.com/spreadsheets/d/${ spreadsheetId }/edit#gid=${ newSheetId }`;
+
+  return {
+    ok: true,
+    data: {
+      sheetId: newSheetId,
+      sheetName: String(sheetName),
+      sheetUrl,
+      rowsAdded: values.length,
+      columnsAdded: headers.length,
+      updateResponse: updateResponse.data,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googlesheetsSpreadsheetSheetAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googlesheetsSpreadsheetSheetAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "spreadsheetIdentifier": { "spreadsheetId": "ABC123" },
+    "data": { "objArray": [{ "fruit": "apple", "colour": "red" }] },
+    "options": { "sheetName": "Fruits" }
+  }'
+*/

package/api/google/googlesheetsSpreadsheetSheetGetData.js

@@ -0,0 +1,159 @@
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleSheets, googleApiCall } = require('../google/google.utils');
+
+const spreadsheetIdentifierValidator = (spreadsheetIdentifier) => {
+  return objHasAny(spreadsheetIdentifier, ['spreadsheetId']);
+};
+
+const sheetIdentifierValidator = (sheetIdentifier) => {
+  return objHasAny(sheetIdentifier, ['sheetName', 'sheetId', 'sheetIndex']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['spreadsheetIdentifier', spreadsheetIdentifierValidator],
+  ['sheetIdentifier', sheetIdentifierValidator],
+]);
+
+const googlesheetsSpreadsheetSheetGetData = async (
+  credsPayload,
+  spreadsheetIdentifier,
+  sheetIdentifier,
+  {
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    spreadsheetIdentifier,
+    sheetIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { spreadsheetId } = spreadsheetIdentifier;
+  const {
+    sheetName,
+    sheetId,
+    sheetIndex,
+  } = sheetIdentifier;
+
+  const { client, error } = await getGoogleSheets(credsPayload);
+
+  if (error) {
+    return error;
+  }
+
+  const spreadsheetResponse = await googleApiCall(() => client.spreadsheets.get({
+    spreadsheetId,
+  }));
+
+  if (!spreadsheetResponse.ok) {
+    return spreadsheetResponse;
+  }
+
+  const sheetsArray = spreadsheetResponse.data?.sheets;
+
+  if (!sheetsArray?.length) {
+    return {
+      ok: false,
+      error: {
+        code: 'NO_SHEETS',
+        message: 'No sheets found in spreadsheet',
+      },
+    };
+  }
+
+  let resolvedSheetName = sheetName;
+
+  if (!resolvedSheetName) {
+    if (sheetId !== undefined) {
+      const sheet = sheetsArray.find((s) => s.properties.sheetId === sheetId);
+      if (!sheet) {
+        return {
+          ok: false,
+          error: {
+            code: 'SHEET_NOT_FOUND',
+            message: `Sheet with ID ${ sheetId } not found`,
+          },
+        };
+      }
+      resolvedSheetName = sheet.properties.title;
+    } else if (sheetIndex !== undefined) {
+      if (sheetIndex < 0 || sheetIndex >= sheetsArray.length) {
+        return {
+          ok: false,
+          error: {
+            code: 'SHEET_INDEX_OUT_OF_RANGE',
+            message: `Sheet index ${ sheetIndex } is out of range (0-${ sheetsArray.length - 1 })`,
+          },
+        };
+      }
+      resolvedSheetName = sheetsArray[sheetIndex].properties.title;
+    } else {
+      resolvedSheetName = sheetsArray[0].properties.title;
+    }
+  }
+
+  const valuesResponse = await googleApiCall(() => client.spreadsheets.values.get({
+    spreadsheetId,
+    range: `'${ resolvedSheetName }'!A:ZZ`,
+  }));
+
+  if (!valuesResponse.ok) {
+    return valuesResponse;
+  }
+
+  const values = valuesResponse.data?.values;
+
+  if (!values?.length) {
+    return {
+      ok: true,
+      data: [],
+    };
+  }
+
+  const headers = values[0] || [];
+
+  if (!headers.length) {
+    return {
+      ok: true,
+      data: [],
+    };
+  }
+
+  const dataRows = values.slice(1);
+  const data = dataRows.map((row) => {
+    const obj = {};
+    headers.forEach((header, index) => {
+      obj[header] = row[index] !== undefined ? row[index] : '';
+    });
+    return obj;
+  });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googlesheetsSpreadsheetSheetGetData,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googlesheetsSpreadsheetSheetGetData" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "spreadsheetIdentifier": { "spreadsheetId": "ABC123" },
+    "sheetIdentifier": { "sheetName": "Sheet 1" }
+  }'
+*/

package/api/google/googlesheetsSpreadsheetTrim.js

@@ -0,0 +1,239 @@
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleSheets, googleApiCall } = require('../google/google.utils');
+
+const spreadsheetIdentifierValidator = (spreadsheetIdentifier) => {
+  return objHasAny(spreadsheetIdentifier, ['spreadsheetId']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['spreadsheetIdentifier', spreadsheetIdentifierValidator],
+]);
+
+const googlesheetsSpreadsheetTrim = async (
+  credsPayload,
+  spreadsheetIdentifier,
+  {
+  } = {},
+) => {
+  const { client, error } = await getGoogleSheets(credsPayload);
+
+  if (error) {
+    return error;
+  }
+
+  const spreadsheetResponse = await googleApiCall(() => client.spreadsheets.get({
+    spreadsheetId,
+  }));
+
+  if (!spreadsheetResponse.ok) {
+    return spreadsheetResponse;
+  }
+
+  const sheetsArray = spreadsheetResponse.data?.sheets;
+
+  if (!sheetsArray?.length) {
+    return {
+      ok: true,
+      data: {
+        message: 'No sheets found in spreadsheet',
+        trimmed: [],
+      },
+    };
+  }
+
+  const sheetsToProcess = sheetsArray
+    .map((sheet) => {
+      const { properties } = sheet;
+      const { sheetId, title: sheetTitle, gridProperties } = properties;
+      const { rowCount, columnCount } = gridProperties || {};
+
+      if (!rowCount || !columnCount) {
+        return null;
+      }
+
+      return {
+        sheetId,
+        sheetTitle,
+        rowCount,
+        columnCount,
+      };
+    })
+    .filter(Boolean);
+
+  if (!sheetsToProcess.length) {
+    return {
+      ok: true,
+      data: {
+        message: 'No sheets with valid grid properties found',
+        sheetsProcessed: sheetsArray.length,
+        sheetsTrimmed: 0,
+        sheetResults: [],
+      },
+    };
+  }
+
+  const batchValuesResponse = await googleApiCall(() => client.spreadsheets.values.batchGet({
+    spreadsheetId,
+    ranges: sheetsToProcess.map((sheet) => `${ sheet.sheetTitle }!A:ZZ`),
+  }));
+
+  if (!batchValuesResponse.ok) {
+    return batchValuesResponse;
+  }
+
+  const { valueRanges } = batchValuesResponse.data;
+
+  const trimRequests = [];
+  const sheetResults = [];
+
+  for (let i = 0; i < sheetsToProcess.length; i++) {
+    const sheet = sheetsToProcess[i];
+    const { sheetId, sheetTitle, rowCount, columnCount } = sheet;
+    const valueRange = valueRanges[i];
+    const { values } = valueRange || {};
+
+    if (!values || values.length === 0) {
+      if (rowCount > 1) {
+        trimRequests.push({
+          deleteDimension: {
+            range: {
+              sheetId,
+              dimension: 'ROWS',
+              startIndex: 1,
+            },
+          },
+        });
+      }
+      if (columnCount > 1) {
+        trimRequests.push({
+          deleteDimension: {
+            range: {
+              sheetId,
+              dimension: 'COLUMNS',
+              startIndex: 1,
+            },
+          },
+        });
+      }
+      if (rowCount > 1 || columnCount > 1) {
+        sheetResults.push({
+          sheetTitle,
+          sheetId,
+          trimmed: true,
+          originalRows: rowCount,
+          originalColumns: columnCount,
+          newRows: 1,
+          newColumns: 1,
+        });
+      } else {
+        sheetResults.push({
+          sheetTitle,
+          sheetId,
+          trimmed: false,
+          message: 'No trimming needed',
+        });
+      }
+      continue;
+    }
+
+    let maxRows = values.length;
+    let maxCols = 0;
+    for (const row of values) {
+      if (row && row.length > maxCols) {
+        maxCols = row.length;
+      }
+    }
+
+    maxRows = Math.max(1, maxRows);
+    maxCols = Math.max(1, maxCols);
+
+    if (rowCount > maxRows) {
+      trimRequests.push({
+        deleteDimension: {
+          range: {
+            sheetId,
+            dimension: 'ROWS',
+            startIndex: maxRows,
+          },
+        },
+      });
+    }
+
+    if (columnCount > maxCols) {
+      trimRequests.push({
+        deleteDimension: {
+          range: {
+            sheetId,
+            dimension: 'COLUMNS',
+            startIndex: maxCols,
+          },
+        },
+      });
+    }
+
+    if (rowCount > maxRows || columnCount > maxCols) {
+      sheetResults.push({
+        sheetTitle,
+        sheetId,
+        trimmed: true,
+        originalRows: rowCount,
+        originalColumns: columnCount,
+        newRows: maxRows,
+        newColumns: maxCols,
+      });
+    } else {
+      sheetResults.push({
+        sheetTitle,
+        sheetId,
+        trimmed: false,
+        message: 'No trimming needed',
+      });
+    }
+  }
+
+  let batchUpdateResult = null;
+  if (trimRequests.length > 0) {
+    const batchUpdateResponse = await googleApiCall(() => client.spreadsheets.batchUpdate({
+      spreadsheetId,
+      requestBody: {
+        requests: trimRequests,
+      },
+    }));
+
+    if (!batchUpdateResponse.ok) {
+      return batchUpdateResponse;
+    }
+
+    batchUpdateResult = batchUpdateResponse.data;
+  }
+
+  return {
+    ok: true,
+    data: {
+      sheetsProcessed: sheetsArray.length,
+      sheetsTrimmed: sheetResults.filter((s) => s.trimmed).length,
+      sheetResults,
+      batchUpdateResult,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googlesheetsSpreadsheetTrim,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googlesheetsSpreadsheetTrim" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "spreadsheetIdentifier": { "spreadsheetId": "ABC123" }
+  }'
+*/

package/api/gorgias/docs.md

@@ -0,0 +1,7 @@
+# Gorgias
+
+- [Developer documentation](https://developers.gorgias.com/)
+- [API reference](https://developers.gorgias.com/reference/introduction)
+- [REST API credentials (helpdesk)](https://docs.gorgias.com/en-US/rest-api-208286)
+
+Per-helpdesk REST JSON at `https://{subdomain}.gorgias.com/api/` over standard HTTP verbs, using HTTP Basic Auth (account email as username, API key as password) with cursor-based pagination and rate-limit headers.

package/api/logiwa/logiwaAuthGet.js

@@ -15,7 +15,9 @@ const logiwaAuthGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaInventoriesGet.js

@@ -24,7 +24,9 @@ const logiwaInventoriesGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaOrdersGet.js

@@ -33,7 +33,9 @@ const logiwaOrdersGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaProductsGet.js

@@ -27,7 +27,9 @@ const logiwaProductsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaReportGetInventorySnapshot.js

@@ -23,7 +23,9 @@ const logiwaReportGetInventorySnapshot = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaReportGetTotalInventory.js

@@ -26,7 +26,9 @@ const logiwaReportGetTotalInventory = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/logiwa/logiwaWebhooksGet.js

@@ -15,7 +15,9 @@ const logiwaWebhooksGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/loop/loopAllowlistItemsGet.js

@@ -13,7 +13,9 @@ const loopAllowlistItemsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/loop/loopBlocklistItemsGet.js

@@ -13,7 +13,9 @@ const loopBlocklistItemsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/loop/loopDestinationsGet.js

@@ -13,7 +13,9 @@ const loopDestinationsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/loop/loopReturnsGet.js

@@ -13,7 +13,9 @@ const loopReturnsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/notion/docs.md

@@ -0,0 +1,6 @@
+# Notion
+
+- [Developer documentation](https://developers.notion.com/)
+- [Authorization](https://developers.notion.com/docs/authorization)
+
+REST JSON at `https://api.notion.com/v1` scoped to shared pages/databases via integration tokens, requiring `Authorization: Bearer` plus a dated `Notion-Version` header on every request.

package/api/notion/notion.constants.js

@@ -0,0 +1,9 @@
+const NOTION_API_BASE_URL = 'https://api.notion.com/v1';
+const DEFAULT_NOTION_VERSION = '2022-06-28';
+const MAX_PER_PAGE = 100;
+
+module.exports = {
+  NOTION_API_BASE_URL,
+  DEFAULT_NOTION_VERSION,
+  MAX_PER_PAGE,
+};