@foxtware/mineral 0.1.30 → 0.1.32

package/api/peoplevox/peoplevoxItemEdit.js

@@ -0,0 +1,78 @@
+const { json2csv } = require('json-2-csv');
+const { credsValidator } = require('../validators');
+const { ensureArray, everyIfArray, ArgsWarden } = require('../utils');
+const { peoplevoxClient } = require('../peoplevox/peoplevox.utils');
+const { MAX_REQUEST_ITEMS } = require('../peoplevox/peoplevox.constants');
+
+const itemPayloadValidator = (itemPayload) => itemPayload?.ItemCode;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['itemPayload', (item) => everyIfArray(itemPayloadValidator, item)],
+]);
+
+const peoplevoxItemEdit = async (
+  credsPayload,
+  itemPayload,
+  {
+    fetchClient = peoplevoxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    itemPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const csvData = await json2csv(ensureArray(itemPayload));
+
+  if (csvData.length > MAX_REQUEST_ITEMS) {
+    return {
+      ok: false,
+      error: {
+        code: 'MAX_REQUEST_ITEMS_EXCEEDED',
+        message: `Max request items exceeded. Max is ${ MAX_REQUEST_ITEMS }.`,
+      },
+    };
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        saveRequest: {
+          TemplateName: 'Item types',
+          CsvData: csvData,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      action: 'SaveData',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  peoplevoxItemEdit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/peoplevoxItemEdit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "peoplevox" },
+    "itemPayload": {
+      "ItemCode": "100335-CHC-L",
+      "Attribute7": "ATTR7"
+    }
+  }'
+*/

package/api/peoplevox/peoplevoxReportGet.js

@@ -1,5 +1,5 @@
 const { credsValidator } = require('../validators');
-const { ArgsWarden } = require('../utils');
+const { ArgsWarden, getWithLocalCachedFile } = require('../utils');
 const { peoplevoxClient } = require('../peoplevox/peoplevox.utils');
 
 const argsWarden = new ArgsWarden([
@@ -17,6 +17,7 @@ const peoplevoxReportGet = async (
     orderBy,
     columns,
     fetchClient = peoplevoxClient,
+    useLocalCachedFile,
   } = {},
 ) => {
 
@@ -28,27 +29,28 @@ const peoplevoxReportGet = async (
     return rejectResponse;
   }
 
-  const reportGetResponse = await fetchClient.fetch({
-    requestPayload: {
-      method: 'post',
-      body: {
-        getReportRequest: {
-          TemplateName: reportName,
-          ...(searchClause ? { SearchClause: searchClause } : {}),
-          ...(perPage ? { ItemsPerPage: perPage } : {}),
-          ...(filter ? { FilterClause: filter } : {}),
-          ...(orderBy ? { OrderBy: orderBy } : {}),
-          ...(columns ? { Columns: columns.join(',') } : {}),
+  return getWithLocalCachedFile(
+    useLocalCachedFile,
+    () => fetchClient.fetch({
+      requestPayload: {
+        method: 'post',
+        body: {
+          getReportRequest: {
+            TemplateName: reportName,
+            ...(searchClause ? { SearchClause: searchClause } : {}),
+            ...(perPage ? { ItemsPerPage: perPage } : {}),
+            ...(filter ? { FilterClause: filter } : {}),
+            ...(orderBy ? { OrderBy: orderBy } : {}),
+            ...(columns ? { Columns: columns.join(',') } : {}),
+          },
         },
       },
-    },
-    context: {
-      credsPayload,
-      action: 'GetReportData',
-    },
-  });
-
-  return reportGetResponse;
+      context: {
+        credsPayload,
+        action: 'GetReportData',
+      },
+    }),
+  );
 };
 
 const funcApiConfig = {

package/api/shopify/shopifyGet.js

@@ -1,4 +1,4 @@
-const { Getter, capitaliseString, ArgsWarden } = require('../utils');
+const { Getter, capitaliseString, ArgsWarden, getWithLocalCachedFile } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 const { MAX_PER_PAGE } = require('./shopify.constants');
@@ -221,6 +221,7 @@ const shopifyGet = async (
     resources = `${ resource }s`, // for when plural of the resource isn't `${ resource }s`
     argumentTypeOverrides = {}, // for when a commonly-named API option is not just a single type, e.g. type being String vs CatalogType
 
+    useLocalCachedFile,
     ...getterOptions // e.g. limit
   } = {},
 ) => {
@@ -276,12 +277,17 @@ const shopifyGet = async (
     return getter;
   }
 
-  const data = await getter.run({ returnAll: true });
+  return getWithLocalCachedFile(
+    useLocalCachedFile,
+    async () => {
+      const data = await getter.run({ returnAll: true });
 
-  return {
-    ok: true,
-    data,
-  };
+      return {
+        ok: true,
+        data,
+      };
+    },
+  );
 };
 
 const funcApiConfig = {

package/api/starshipit/starshipitGet.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, ArgsWarden, Getter } = require('../utils');
+const { credsFromPayload, ArgsWarden, Getter, getWithLocalCachedFile } = require('../utils');
 const { credsValidator } = require('../validators');
 const { starshipitClient } = require('../starshipit/starshipit.utils');
 const { MAX_PER_PAGE } = require('../starshipit/starshipit.constants');
@@ -74,6 +74,7 @@ const starshipitGet = async (
     params,
     perPage = MAX_PER_PAGE,
     nodeName = 'results',
+    useLocalCachedFile,
     ...getterOptions
   } = {},
 ) => {
@@ -114,12 +115,17 @@ const starshipitGet = async (
     return getter;
   }
 
-  const data = await getter.run({ returnAll: true });
+  return getWithLocalCachedFile(
+    useLocalCachedFile,
+    async () => {
+      const data = await getter.run({ returnAll: true });
 
-  return {
-    ok: true,
-    data,
-  };
+      return {
+        ok: true,
+        data,
+      };
+    },
+  );
 };
 
 const funcApiConfig = {

package/api/stylearcade/stylearcadeGet.js

@@ -1,4 +1,4 @@
-const { ArgsWarden, Getter, valueProvided } = require('../utils');
+const { ArgsWarden, Getter, getWithLocalCachedFile, valueProvided } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stylearcadeClient } = require('../stylearcade/stylearcade.utils');
 const { MAX_PER_PAGE } = require('../stylearcade/stylearcade.constants');
@@ -74,6 +74,7 @@ const stylearcadeGet = async (
     perPage = MAX_PER_PAGE,
     nodeName = 'records',
     url = '/export',
+    useLocalCachedFile,
     ...getterOptions
   } = {},
 ) => {
@@ -106,12 +107,17 @@ const stylearcadeGet = async (
     return getter;
   }
 
-  const data = await getter.run({ returnAll: true });
+  return getWithLocalCachedFile(
+    useLocalCachedFile,
+    async () => {
+      const data = await getter.run({ returnAll: true });
 
-  return {
-    ok: true,
-    data,
-  };
+      return {
+        ok: true,
+        data,
+      };
+    },
+  );
 };
 
 const funcApiConfig = {

package/api/utils.js

@@ -32,6 +32,33 @@ const normalise = (value) => (value || '').toString().trim().toLowerCase();
 
 const valueProvided = (value) => value !== undefined && value !== null;
 
+const getWithLocalCachedFile = async (
+  filename,
+  getFunction,
+) => {
+  if (!filename || HOSTED) {
+    return getFunction();
+  }
+
+  const directory = `${ getWorkspace() }/api/_temp`;
+  const filepath = `${ directory }/${ filename }`;
+
+  try {
+    const cachedFile = await fs.readFile(filepath, 'utf8');
+    return JSON.parse(cachedFile);
+  } catch (error) {
+    if (error.code !== 'ENOENT') {
+      throw error;
+    }
+  }
+
+  const response = await getFunction();
+  await fs.mkdir(directory, { recursive: true });
+  await fs.writeFile(filepath, JSON.stringify(response, null, 2), 'utf8');
+
+  return response;
+};
+
 const credsByPath = (credsPath, credsObject) => {
   const pathNodes = pathAsArray(credsPath);
 
@@ -1448,6 +1475,10 @@ const objectPropsTranslate = (
   return translatedObj;
 };
 
+const randomArrayItem = (array) => {
+  return array[Math.floor(Math.random() * array.length)];
+};
+
 module.exports = {
   wait,
   timeMs,
@@ -1456,6 +1487,7 @@ module.exports = {
   capitaliseString,
   normalise,
   credsFromPayload,
+  getWithLocalCachedFile,
   resolveFromCreds,
   customFetch,
   logDeep,
@@ -1491,4 +1523,5 @@ module.exports = {
   surveyObject,
   diffObjects,
   objectPropsTranslate,
+  randomArrayItem,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxtware/mineral",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "bin": {
     "mineral": "bin/mineral.js"
   },