@foxtware/mineral 0.1.9 → 0.1.10

package/api/utils.js

@@ -108,6 +108,30 @@ const getResponseParser = (contentType) => {
   return (res) => res.text(); // safe default
 };
 
+const objectToFormData = (object) => {
+  const formData = new FormData();
+  for (const [key, value] of Object.entries(object)) {
+    formData.append(key, value);
+  }
+  return formData;
+};
+
+const bodyPassesThrough = (body) => {
+  if (body == null) {
+    return false;
+  }
+
+  if (typeof body === 'string') {
+    return true;
+  }
+
+  if (body instanceof FormData) {
+    return true;
+  }
+
+  return typeof body.getHeaders === 'function';
+};
+
 const customFetch = async (url, {
   method = 'get',
   headers = {},
@@ -123,7 +147,11 @@ const customFetch = async (url, {
     headers['x-request-id'] = String(Date.now());
   }
 
-  if (body && !headers['Content-Type']) {
+  if (body?.getHeaders) {
+    Object.assign(headers, body.getHeaders());
+  }
+
+  if (body && !headers['Content-Type'] && !bodyPassesThrough(body)) {
     headers['Content-Type'] = 'application/json';
   }
 
@@ -142,11 +170,11 @@ const customFetch = async (url, {
       const response = await fetch(url, {
         method,
         headers,
-        ...body 
-          ? { body: typeof body === 'string' 
-              ? body 
-              : JSON.stringify(body) 
-          } : {},
+        ...body && {
+          body: bodyPassesThrough(body)
+            ? body
+            : JSON.stringify(body),
+        },
       });
 
       const responseContentType = response.headers.get('content-type');
@@ -416,132 +444,58 @@ class Chain {
   }
 }
 
-// TODO: client wrapper enabling auth and retrying with different auth
-
 class FetchClient {
   constructor({
-    context, // necessary data for preparer and interpreters to refer to    
-    requestPreparer, // a function that updates requests before sending
-    responseInterpreter, // a function that transforms responses to report back
+    pipeline = ['fetch'], // an array of functions that transform the request and response, including a string 'fetch' step.
   } = {}) {
-    this.context = context;
-    this.requestPreparer = requestPreparer; // can be a Chain
-    this.responseInterpreter = responseInterpreter; // can be a Chain  
-    this.layers = [];
-  }
-
-  async #fetch({
-    url,
-
-    // customFetch payload
-    method,
-    headers,
-    params,
-    body,
-    
-    responseInterpreter,
-
-    context = {},
-    inspect = false,
-  } = {}) {
-
-    let mergedContext = {
-      ...(this.context ?? {}),
-      ...(context ?? {}),
-    };
-    inspect && logDeep({ mergedContext });
-    inspect && await askQuestion('?');
-
-    let requestPayload = {
-      url,
-      ...(method ? { method } : {}),
-      ...(headers ? { headers } : {}),
-      ...(params ? { params } : {}),
-      ...(body ? { body } : {}),
-    };
-    inspect && logDeep({ requestPayload });
-    inspect && await askQuestion('?');
-
-    if (this.requestPreparer) {
-      if (this.requestPreparer.run) {
-        ({ requestPayload, context: mergedContext } = await this.requestPreparer.run(
-          { requestPayload, context: mergedContext },
-          { inspect },
-        ));
-      } else {
-        const result = await this.requestPreparer(requestPayload, mergedContext);
-        if (result) {
-          requestPayload = result;
-        }
-      }
-    }
-    inspect && logDeep({ requestPayload, mergedContext });
-    inspect && await askQuestion('?');
-
-    let response = await customFetch(
-      requestPayload.url,
-      requestPayload,
-    );
-    inspect && logDeep({ response });
-    inspect && await askQuestion('?');
-    
-    const usedResponseInterpreter = responseInterpreter || this.responseInterpreter;
-    if (usedResponseInterpreter) {
-      if (usedResponseInterpreter.run) {
-        ({ response, context: mergedContext } = await usedResponseInterpreter.run(
-          { response, context: mergedContext },
-          { inspect },
-        ));
-      } else {
-        response = await usedResponseInterpreter(response, mergedContext);
-      }
+    if (!this.pipelineHasFetchStep(pipeline)) {
+      throw new Error('Pipeline must have a fetch step');
     }
-    inspect && logDeep({ response });
-    inspect && await askQuestion('?');
-
-    return response;
+    this.pipeline = pipeline;
   }
 
-  use(layer) {
-    this.layers.push(layer);
+  pipelineHasFetchStep = (pipeline) => {
+    return pipeline.find(step => step === 'fetch');
   }
 
-  async fetch(fetchPayload) {
-    const coreFetch = (payload) => this.#fetch(payload);
-  
-    let layeredFetch = coreFetch;
-    for (const layer of [...this.layers].reverse()) {
-      const currentNext = layeredFetch; // capture this iteration's `next`
-      layeredFetch = (payload) => layer(payload, currentNext);
-    }
-  
-    return await layeredFetch(fetchPayload);
-  }
+  async #fetch(state) {
+    const { requestPayload } = state;
 
-  /* Example layer
+    return {
+      response: await customFetch(
+        requestPayload.url,
+        requestPayload,
+      ),
+    };
+  }
 
-  const withDressColours = async (payload, next) => {
+  async fetch({
+    // url, body, etc.
+    requestPayload,
 
-    let response = await next({
-      ...payload,
-      headers: { ...payload.headers, dress: 'blue/white' },
-    });
+    // additional information to inform behaviour
+    context,
 
-    if (!response.ok) {
-      console.warn('blue/white failed, retrying with black/gold');
-      response = await next({
-        ...payload,
-        headers: { ...payload.headers, dress: 'black/gold' },
-      });
-    }
+    // options for the fetch itself, as opposed to data it uses
+    inspect = false,
+  } = {}) {
 
-    return response;
+    const { pipeline } = this;
 
-  };
+    const pipelineChain = new Chain(pipeline.map(step => {
+      return step === 'fetch' 
+        ? this.#fetch 
+        : step;
+    }));
 
-  client.use(withDressColours);
+    // fetch step will add response to this, for subsequent steps
+    const state = await pipelineChain.run({
+      requestPayload,
+      context,
+    }, { inspect });
 
-  */
+    return state.response;
+  }
 }
 
 const fetchClientCommonSteps = {
@@ -652,6 +606,17 @@ const ensureArray = (value) => {
   return [value];
 };
 
+const objectArrayToJsonl = (objects) => {
+  return objects.map((object) => JSON.stringify(object)).join('\n');
+};
+
+const jsonlToObjectArray = (jsonl) => {
+  return jsonl
+    .split('\n')
+    .filter((line) => line.trim())
+    .map((line) => JSON.parse(line));
+};
+
 const everyIfArray = (func, value) => {
   if (Array.isArray(value)) {
     if (value.length === 0) {
@@ -1199,7 +1164,10 @@ module.exports = {
   Chain,
   FetchClient,
   fetchClientCommonSteps,
+  objectToFormData,
   ensureArray,
+  objectArrayToJsonl,
+  jsonlToObjectArray,
   everyIfArray,
   simpleSort,
   arrayToChunks,
@@ -1213,4 +1181,4 @@ module.exports = {
   sentenceCaseString,
   ArgsWarden,
   gidToId,
-};
+};

package/api/validators.js

@@ -9,4 +9,4 @@ const credsValidator = (creds) => {
 
 module.exports = {
   credsValidator,
-};
+};

package/api/workable/workable.utils.js

@@ -1,12 +1,12 @@
+const { resolveCreds } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
   appendUrlToBase,
   fetchClientCommonSteps,
 } = require('../utils');
 
 // TODO: Allow creds failure (e.g. missing BASE_URL / ACCESS_TOKEN → INVALID_CREDS before fetch)
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
   const {
@@ -19,7 +19,6 @@ const addUrlAndAuthHeaders = async (state) => {
       ...requestPayload,
       url: appendUrlToBase(BASE_URL, requestPayload.url),
       headers: {
-        'Content-Type': 'application/json',
         Accept: 'application/json',
         Authorization: `Bearer ${ ACCESS_TOKEN }`,
         ...requestPayload.headers,
@@ -28,17 +27,13 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const workableClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const workableClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const workableClient = new FetchClient({
-  requestPreparer: workableClientRequestPreparer,
-  responseInterpreter: workableClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {

package/api/workable/workableGet.js

@@ -1,6 +1,6 @@
 // https://workable.readme.io/reference/jobs
 
-const { credsFromPayload, ArgsWarden, Getter } = require('../utils');
+const { ArgsWarden, Getter } = require('../utils');
 const { credsValidator } = require('../validators');
 const { workableClient } = require('../workable/workable.utils');
 const { MAX_PER_PAGE } = require('../workable/workable.constants');
@@ -20,7 +20,7 @@ const digResults = (data, resultsKey) => {
 };
 
 const workableGetPacket = async (
-  creds,
+  credsPayload,
   url,
   {
     params,
@@ -28,13 +28,15 @@ const workableGetPacket = async (
   } = {},
 ) => {
   return workableClient.fetch({
-    url,
-    params: {
-      limit: Math.min(perPage, MAX_PER_PAGE),
-      ...params,
+    requestPayload: {
+      url,
+      params: {
+        limit: Math.min(perPage, MAX_PER_PAGE),
+        ...params,
+      },
     },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };
@@ -83,11 +85,9 @@ const workableGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const getter = new Getter(
     {
-      args: [creds, url],
+      args: [credsPayload, url],
       options: {
         params,
         perPage,
@@ -111,7 +111,12 @@ const workableGet = async (
     return getter;
   }
 
-  return getter.run({ returnAll: true });
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
 };
 
 const funcApiConfig = {

package/api/workable/workableJobCandidateCreate.js

@@ -1,6 +1,6 @@
 // https://workable.readme.io/reference/job-candidates-create
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { workableClient } = require('../workable/workable.utils');
 
@@ -33,18 +33,18 @@ const workableJobCandidateCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   return workableClient.fetch({
-    url: `/jobs/${ shortcode }/candidates`,
-    method: 'post',
-    body: {
-      sourced,
-      ...stage !== undefined && { stage },
-      candidate,
+    requestPayload: {
+      url: `/jobs/${ shortcode }/candidates`,
+      method: 'post',
+      body: {
+        sourced,
+        ...stage !== undefined && { stage },
+        candidate,
+      },
     },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };

package/api/workable/workableJobGet.js

@@ -1,6 +1,6 @@
 // https://workable.readme.io/reference/jobsshortcode
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { workableClient } = require('../workable/workable.utils');
 
@@ -23,12 +23,12 @@ const workableJobGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   return workableClient.fetch({
-    url: `/jobs/${ shortcode }`,
+    requestPayload: {
+      url: `/jobs/${ shortcode }`,
+    },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };

package/api/workable/workableJobMembersGet.js

@@ -1,6 +1,6 @@
 // https://workable.readme.io/reference/job-members
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { workableClient } = require('../workable/workable.utils');
 
@@ -23,12 +23,12 @@ const workableJobMembersGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   return workableClient.fetch({
-    url: `/jobs/${ shortcode }/members`,
+    requestPayload: {
+      url: `/jobs/${ shortcode }/members`,
+    },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };

package/api/workable/workableJobStagesGet.js

@@ -1,6 +1,6 @@
 // https://workable.readme.io/reference/job-stages
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { workableClient } = require('../workable/workable.utils');
 
@@ -23,12 +23,12 @@ const workableJobStagesGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   return workableClient.fetch({
-    url: `/jobs/${ shortcode }/stages`,
+    requestPayload: {
+      url: `/jobs/${ shortcode }/stages`,
+    },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };

package/api/yotpo/yotpo.utils.js

@@ -1,17 +1,17 @@
-const { 
-  BASE_URL, 
-  DEFAULT_API_VERSION, 
+const {
+  BASE_URL,
+  DEFAULT_API_VERSION,
 } = require('../yotpo/yotpo.constants');
-const { 
-  FetchClient, 
-  Chain, 
-  appendUrlToBase, 
-  fetchClientCommonSteps, 
+const { resolveCreds } = require('../pipelineSteps');
+const {
+  FetchClient,
+  appendUrlToBase,
+  fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useUrlAndAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
-  const { creds, apiVersion = DEFAULT_API_VERSION } = context;
+  const { apiVersion = DEFAULT_API_VERSION, creds } = context;
   const { API_KEY, GUID } = creds;
 
   return {
@@ -19,7 +19,6 @@ const addUrlAndAuthHeaders = async (state) => {
       ...requestPayload,
       url: appendUrlToBase(`${ BASE_URL }/${ apiVersion }`, requestPayload.url),
       headers: {
-        'Content-Type': 'application/json',
         'x-api-key': API_KEY,
         'x-guid': GUID,
         ...requestPayload.headers,
@@ -28,18 +27,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const yotpoClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const yotpoClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-  fetchClientCommonSteps.digToPath,
-]);
-
 const yotpoClient = new FetchClient({
-  requestPreparer: yotpoClientRequestPreparer,
-  responseInterpreter: yotpoClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useUrlAndAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    fetchClientCommonSteps.digToPath,
+  ],
 });
 
 module.exports = {

package/api/yotpo/yotpoCampaignsGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/get-active-campaigns
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -22,8 +22,6 @@ const yotpoCampaignsGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -36,10 +34,12 @@ const yotpoCampaignsGet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/campaigns',
-    params,
+    requestPayload: {
+      url: '/campaigns',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerActionRecord.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/record-a-customer-action
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -43,8 +43,6 @@ const yotpoCustomerActionRecord = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -63,11 +61,13 @@ const yotpoCustomerActionRecord = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/actions',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/actions',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerAnniversaryGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/get-customer-anniversary
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -25,15 +25,15 @@ const yotpoCustomerAnniversaryGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await yotpoClient.fetch({
-    url: '/customer_anniversary',
-    params: {
-      customer_email: customerEmail,
+    requestPayload: {
+      url: '/customer_anniversary',
+      params: {
+        customer_email: customerEmail,
+      },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerAnniversarySet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/createupdate-customer-anniversary
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -35,8 +35,6 @@ const yotpoCustomerAnniversarySet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const body = {
     customer_email: customerEmail,
     day: Number(day),
@@ -45,11 +43,13 @@ const yotpoCustomerAnniversarySet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customer_anniversary',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/customer_anniversary',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });