@foxtware/mineral 0.1.14 → 0.1.16

package/api/upstash/upstashExists.js

@@ -12,7 +12,10 @@ const upstashExists = async (
   key,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, key });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    key,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/upstash/upstashGet.js

@@ -12,7 +12,10 @@ const upstashGet = async (
   key,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, key });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    key,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/utils.js

@@ -20,6 +20,8 @@ const objHasAny = (obj, keys) => {
 const capitaliseString = (string) => `${ string[0].toUpperCase() }${ string.slice(1) }`;
 const sentenceCaseString = (string) => `${ string[0].toLowerCase() }${ string.slice(1) }`;
 
+const normalise = (value) => (value || '').toString().trim().toLowerCase();
+
 const credsByPath = (credsPath, credsObject) => {
   const pathNodes = pathAsArray(credsPath);
 
@@ -86,6 +88,36 @@ const credsFromPayload = async (credsPayload) => {
   return false;
 };
 
+const resolveFromCreds = (credsKey) => {
+  const keys = [].concat(credsKey);
+
+  return async ({
+    credsPayload,
+    creds,
+  }) => {
+    if (!creds) {
+      creds = await credsFromPayload(credsPayload);
+    }
+    const values = keys.map((key) => creds?.[key]);
+    const missing = keys.filter((key, index) => !valueProvided(values[index]));
+
+    if (missing.length) {
+      return {
+        ok: false,
+        error: {
+          code: 'INVALID_ARGS',
+          message: `${ missing.join(', ') } not in creds, so needs to be otherwise supplied`,
+        },
+      };
+    }
+
+    return {
+      ok: true,
+      data: Array.isArray(credsKey) ? values : values[0],
+    };
+  };
+};
+
 const xmlResponseParser = (parserOptions = {}) => {
   const parser = new xml2js.Parser({
     explicitArray: false,
@@ -130,6 +162,10 @@ const bodyPassesThrough = (body) => {
     return true;
   }
 
+  if (body instanceof URLSearchParams) {
+    return true;
+  }
+
   return typeof body.getHeaders === 'function';
 };
 
@@ -179,14 +215,14 @@ const customFetch = async (url, {
       });
 
       const responseContentType = response.headers.get('content-type');
-      !HOSTED && console.log('responseContentType', responseContentType);
+      // !HOSTED && console.log('responseContentType', responseContentType);
 
       if (!responseParser) {
         responseParser = getResponseParser(responseContentType);
       }
 
       const parsedResponse = await responseParser(response);
-      !HOSTED && logDeep({ parsedResponse });
+      // !HOSTED && logDeep({ parsedResponse });
 
       if (response.ok) {
         return {
@@ -448,11 +484,13 @@ class Chain {
 class FetchClient {
   constructor({
     pipeline = ['fetch'], // an array of functions that transform the request and response, including a string 'fetch' step.
+    layers = [], // (payload, next) => …; first layer is innermost around the pipeline
   } = {}) {
     if (!this.pipelineHasFetchStep(pipeline)) {
       throw new Error('Pipeline must have a fetch step');
     }
     this.pipeline = pipeline;
+    this.layers = layers;
   }
 
   pipelineHasFetchStep = (pipeline) => {
@@ -470,7 +508,7 @@ class FetchClient {
     };
   }
 
-  async fetch({
+  async #fetchCore({
     // url, body, etc.
     requestPayload,
 
@@ -484,8 +522,8 @@ class FetchClient {
     const { pipeline } = this;
 
     const pipelineChain = new Chain(pipeline.map(step => {
-      return step === 'fetch' 
-        ? this.#fetch 
+      return step === 'fetch'
+        ? this.#fetch
         : step;
     }));
 
@@ -497,9 +535,49 @@ class FetchClient {
 
     return state.response;
   }
+
+  async fetch(fetchPayload = {}) {
+    let layeredFetch = (payload) => this.#fetchCore(payload);
+
+    for (const layer of this.layers) {
+      const currentNext = layeredFetch;
+      layeredFetch = (payload) => layer(payload, currentNext);
+    }
+
+    return layeredFetch(fetchPayload);
+  }
+
+  /* Example layer
+
+  const withDressColours = async (payload, next) => {
+
+    let response = await next({
+      ...payload,
+      headers: { ...payload.headers, dress: 'blue/white' },
+    });
+
+    if (!response.ok) {
+      console.warn('blue/white failed, retrying with black/gold');
+      response = await next({
+        ...payload,
+        headers: { ...payload.headers, dress: 'black/gold' },
+      });
+    }
+
+    return response;
+
+  };
+
+  new FetchClient({ pipeline, layers: [withDressColours] });
+
+  */
 }
 
 const fetchClientCommonSteps = {
+  unwrapData: async (state) => {
+    const { response } = state;
+    return { response: response?.data || response };
+  },
   stripEdgesAndNodes: async (state) => {
     const { response } = state;
 
@@ -1043,7 +1121,7 @@ class Getter extends EventEmitter {
         paginatedParams.options,
       );
 
-      logDeep(response);
+      // logDeep(response);
 
       let items;
       if (digester) {
@@ -1155,7 +1233,9 @@ module.exports = {
   timeMs,
   objHasAny,
   capitaliseString,
+  normalise,
   credsFromPayload,
+  resolveFromCreds,
   customFetch,
   logDeep,
   askQuestion,

package/api/workable/workableJobsGet.js

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

package/api/yotpo/yotpoCampaignsGet.js

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

package/api/yotpo/yotpoCustomersRecentGet.js

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

package/api/yotpo/yotpoRedemptionOptionsGet.js

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

package/api/yotpo/yotpoVipTiersGet.js

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

package/hosting/copyCredsToEnv.js

@@ -54,9 +54,9 @@ const filterCredsByPaths = (creds, includeCredsPaths) => {
 
 const copyCredsToEnv = (workspace, options = {}) => {
   const { includeCredsPaths } = options;
-  const normalizedWorkspace = workspace.replace(/\/$/, '');
-  const credsPath = `${ normalizedWorkspace }/.creds.yml`;
-  const envPath = `${ normalizedWorkspace }/.env`;
+  const normalisedWorkspace = workspace.replace(/\/$/, '');
+  const credsPath = `${ normalisedWorkspace }/.creds.yml`;
+  const envPath = `${ normalisedWorkspace }/.env`;
 
   if (!fs.existsSync(credsPath)) {
     throw new Error(`Missing .creds.yml in workspace: ${ workspace }`);

package/hosting/handlerPaths.js

@@ -2,11 +2,11 @@ const MINERAL_ROOT = `${ __dirname }/..`;
 const MINERAL_API_DIR = `${ MINERAL_ROOT }/api`;
 
 const getRequirePathForHandler = (handler, workspace) => {
-  const normalizedWorkspace = workspace.replace(/\/$/, '');
+  const normalisedWorkspace = workspace.replace(/\/$/, '');
   const { filePath } = handler;
 
-  if (filePath.startsWith(`${ normalizedWorkspace }/`)) {
-    return `./${ filePath.slice(normalizedWorkspace.length + 1) }`;
+  if (filePath.startsWith(`${ normalisedWorkspace }/`)) {
+    return `./${ filePath.slice(normalisedWorkspace.length + 1) }`;
   }
 
   if (filePath.startsWith(`${ MINERAL_API_DIR }/`)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxtware/mineral",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "bin": {
     "mineral": "bin/mineral.js"
   },
@@ -23,6 +23,7 @@
     "@upstash/redis": "^1.28.4",
     "csvtojson": "^2.0.14",
     "dotenv": "^17.2.0",
+    "googleapis": "^165.0.0",
     "json-2-csv": "^5.5.9",
     "xml2js": "^0.6.2",
     "yaml": "^2.9.0"

package/server.js

@@ -78,7 +78,7 @@ const directoriesToScan = ({
   return [MINERAL_API_DIR, ...extraDirs];
 };
 
-const addHandlerFromFile = (filePath, handlers) => {
+const addHandlerFromFile = (filePath, handlers, apiScanRoot) => {
   const moduleExports = require(filePath);
   if (!moduleExports || typeof moduleExports !== 'object') {
     return;
@@ -96,12 +96,14 @@ const addHandlerFromFile = (filePath, handlers) => {
   });
 
   const route = `/${ routeName }`;
-  if (handlers.has(route)) {
-    const existing = handlers.get(route);
+  const existing = handlers.get(route);
+
+  if (existing && existing.apiScanRoot === apiScanRoot) {
     throw new Error(`Duplicate route '${ route }' from ${ filePath } and ${ existing.filePath }`);
   }
 
   handlers.set(route, {
+    apiScanRoot,
     filePath,
     routeName,
     handler: funcApiConfig ? funcApi(handlerFn, funcApiConfig) : handlerFn,
@@ -112,9 +114,9 @@ const addHandlerFromFile = (filePath, handlers) => {
 const loadHandlers = (config) => {
   const handlers = new Map();
 
-  for (const directory of directoriesToScan(config)) {
-    for (const filePath of listJsFiles(directory)) {
-      addHandlerFromFile(filePath, handlers);
+  for (const apiScanRoot of directoriesToScan(config)) {
+    for (const filePath of listJsFiles(apiScanRoot)) {
+      addHandlerFromFile(filePath, handlers, apiScanRoot);
     }
   }
 

package/server.utils.js

@@ -3,7 +3,7 @@ const { HOSTED } = require('./api/constants');
 const { StringDecoder } = require('string_decoder');
 
 const respondJson = (res, statusCode, payload) => {
-  !HOSTED && logDeep(payload);
+  // !HOSTED && logDeep(payload);
   const body = JSON.stringify(payload);
   res.writeHead(statusCode, {
     'Content-Type': 'application/json',