@foxtware/mineral 0.1.9 → 0.1.10

package/api/starshipit/starshipitOrderUpdate.js

@@ -0,0 +1,109 @@
+// https://api-docs.starshipit.com/#c96bed4f-3a89-4e97-abaa-b1775cc7c5a7
+
+const { objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+const { starshipitOrderGet } = require('../starshipit/starshipitOrderGet');
+
+const orderIdentifierValidator = (orderIdentifier) => {
+  return objHasAny(orderIdentifier, [
+    'orderId',
+    'orderNumber',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderIdentifier', orderIdentifierValidator],
+  ['updatePayload'],
+]);
+
+const resolveOrderId = async (credsPayload, orderIdentifier) => {
+  const { orderId, orderNumber } = orderIdentifier;
+
+  if (orderId) {
+    return {
+      ok: true,
+      data: orderId,
+    };
+  }
+
+  const orderResponse = await starshipitOrderGet(credsPayload, { orderNumber });
+
+  if (!orderResponse?.ok) {
+    return orderResponse;
+  }
+
+  const resolvedOrderId = orderResponse?.data?.order_id;
+
+  if (!resolvedOrderId) {
+    return {
+      ok: false,
+      error: {
+        code: 'ORDER_NOT_FOUND',
+        message: 'No order ID found',
+      },
+    };
+  }
+
+  return {
+    ok: true,
+    data: resolvedOrderId,
+  };
+};
+
+const starshipitOrderUpdate = async (
+  credsPayload,
+  orderIdentifier,
+  updatePayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderIdentifier,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const orderIdResponse = await resolveOrderId(credsPayload, orderIdentifier);
+  if (!orderIdResponse?.ok) {
+    return orderIdResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders',
+      method: 'put',
+      body: {
+        order: {
+          order_id: orderIdResponse.data,
+          ...updatePayload,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrderUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrderUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "orderIdentifier": { "orderNumber": "7029471248456" },
+    "updatePayload": { "destination": { "name": "Big Dog" } }
+  }'
+*/

package/api/starshipit/starshipitOrdersListShipped.js

@@ -0,0 +1,64 @@
+// https://api-docs.starshipit.com/#abbdf631-21c8-472b-b2e7-b1b68b01f6d0
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const starshipitOrdersListShipped = async (
+  credsPayload,
+  {
+    sinceLastUpdated,
+    idsOnly,
+    perPage,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders/shipped',
+      params: {
+        ...sinceLastUpdated && { since_last_updated: sinceLastUpdated },
+        ...idsOnly && { ids_only: idsOnly },
+        ...perPage && { limit: perPage },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  return {
+    ...response,
+    data: response.data?.orders || response.data?.order_ids || response.data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrdersListShipped,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrdersListShipped" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" }
+  }'
+*/

package/api/starshipit/starshipitProductAdd.js

@@ -0,0 +1,100 @@
+// https://api-docs.starshipit.com/#8cfbd1b2-bd08-4cec-966f-7104cc147aee
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sku'],
+]);
+
+const starshipitProductAdd = async (
+  credsPayload,
+  sku,
+  {
+    title,
+    customsDescription,
+    description,
+    country,
+    weight,
+    height,
+    length,
+    width,
+    hsCode,
+    color,
+    size,
+    barcode,
+    binLocation,
+    brand,
+    usage,
+    material,
+    model,
+    mid,
+    price,
+    dangerousGoodsType,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sku,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/products',
+      method: 'post',
+      body: {
+        product: {
+          sku,
+          ...title && { title },
+          ...customsDescription && { customs_description: customsDescription },
+          ...description && { description },
+          ...country && { country },
+          ...weight && { weight },
+          ...height && { height },
+          ...length && { length },
+          ...width && { width },
+          ...hsCode && { hs_code: hsCode },
+          ...color && { color },
+          ...size && { size },
+          ...barcode && { barcode },
+          ...binLocation && { bin_location: binLocation },
+          ...brand && { brand },
+          ...usage && { usage },
+          ...material && { material },
+          ...model && { model },
+          ...mid && { mid },
+          ...price && { price },
+          ...dangerousGoodsType && { dangerous_goods_type: dangerousGoodsType },
+        },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "sku": "WFAL48-1-S",
+    "options": { "title": "Example Product" }
+  }'
+*/

package/api/starshipit/starshipitProductsDelete.js

@@ -0,0 +1,57 @@
+// https://api-docs.starshipit.com/#5edb43f1-432b-4d1a-bb31-e05db0c879e3
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const productIdsValidator = (productIds) => Array.isArray(productIds) && productIds.length > 0;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIds', productIdsValidator],
+]);
+
+const starshipitProductsDelete = async (
+  credsPayload,
+  productIds,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIds,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/products/delete',
+      method: 'delete',
+      body: {
+        product_ids: productIds,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductsDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductsDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "productIds": [5585356]
+  }'
+*/

package/api/starshipit/starshipitProductsGet.js

@@ -0,0 +1,49 @@
+// https://api-docs.starshipit.com/#ccf0f10f-e370-45c0-ba5c-13bfaac80ca6
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitGet } = require('../starshipit/starshipitGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const starshipitProductsGet = async (
+  credsPayload,
+  {
+    searchTerm,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitGet(credsPayload, '/products', {
+    nodeName: 'products',
+    params: {
+      ...searchTerm && { search_term: searchTerm },
+    },
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "options": { "searchTerm": "WFAL48-1-S" }
+  }'
+*/

package/api/starshipit/starshipitTrackingGet.js

@@ -0,0 +1,69 @@
+// https://api-docs.starshipit.com/#05a846b9-0128-4dd3-80e4-e6008aef9b94
+
+const { objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const trackingIdentifierValidator = (trackingIdentifier) => {
+  return objHasAny(trackingIdentifier, [
+    'trackingNumber',
+    'orderNumber',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['trackingIdentifier', trackingIdentifierValidator],
+]);
+
+const starshipitTrackingGet = async (
+  credsPayload,
+  trackingIdentifier,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    trackingIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    trackingNumber,
+    orderNumber,
+  } = trackingIdentifier;
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/track',
+      params: {
+        ...trackingNumber && { tracking_number: trackingNumber },
+        ...orderNumber && { order_number: orderNumber },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitTrackingGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitTrackingGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.wf" },
+    "trackingIdentifier": { "orderNumber": "7726760919112" }
+  }'
+*/

package/api/stripe/_example.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -17,13 +17,13 @@ const FUNC = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/things',
-    method: 'post',
-    body: { arg },
-    context: { creds },
+    requestPayload: {
+      url: '/things',
+      method: 'post',
+      body: { arg },
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripe.utils.js

@@ -1,12 +1,11 @@
 const { BASE_URL } = require('../stripe/stripe.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
-  appendUrlToBase,
   fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
   const { API_KEY } = creds;
@@ -18,7 +17,6 @@ const addUrlAndAuthHeaders = async (state) => {
   return {
     requestPayload: {
       ...requestPayload,
-      url: appendUrlToBase(BASE_URL, requestPayload.url),
       headers: {
         'Content-Type': 'application/x-www-form-urlencoded',
         Authorization: `Bearer ${ API_KEY }`,
@@ -29,17 +27,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const stripeClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const stripeClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const stripeClient = new FetchClient({
-  requestPreparer: stripeClientRequestPreparer,
-  responseInterpreter: stripeClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {

package/api/stripe/stripeCardTokenCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/tokens/create_card
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -31,18 +31,18 @@ const stripeCardTokenCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/tokens',
-    method: 'post',
-    body: {
-      'card[number]': cardNumber,
-      'card[exp_month]': expiryMonth,
-      'card[exp_year]': expiryYear,
-      'card[cvc]': cvc,
+    requestPayload: {
+      url: '/tokens',
+      method: 'post',
+      body: {
+        'card[number]': cardNumber,
+        'card[exp_month]': expiryMonth,
+        'card[exp_year]': expiryYear,
+        'card[cvc]': cvc,
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeCapture.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/capture
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -25,17 +25,17 @@ const stripeChargeCapture = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/charges/${ chargeId }/capture`,
-    method: 'post',
-    ...(amountCents && {
-      body: {
-        amount: amountCents,
-      },
-    }),
-    context: { creds },
+    requestPayload: {
+      url: `/charges/${ chargeId }/capture`,
+      method: 'post',
+      ...(amountCents && {
+        body: {
+          amount: amountCents,
+        },
+      }),
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/create
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -31,18 +31,18 @@ const stripeChargeCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/charges',
-    method: 'post',
-    body: {
-      amount: amountCents,
-      currency,
-      source,
-      description,
+    requestPayload: {
+      url: '/charges',
+      method: 'post',
+      body: {
+        amount: amountCents,
+        currency,
+        source,
+        description,
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeChargeGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/charges/${ chargeId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/charges/${ chargeId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargesGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/list
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -20,12 +20,12 @@ const stripeChargesGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/charges',
-    params,
-    context: { creds },
+    requestPayload: {
+      url: '/charges',
+      params,
+    },
+    context: { credsPayload },
   });
 
   return response;