@foxtware/mineral 0.1.0

package/api/validators.js

@@ -0,0 +1,12 @@
+const { objHasAny } = require('./utils');
+
+const credsValidator = (creds) => {
+  if (!objHasAny(creds, ['credsPath', 'credsObject', 'credsProvider'])) {
+    return false; // TODO: Consider returning [false, message]
+  }
+  return true;
+};
+
+module.exports = {
+  credsValidator,
+};

package/api/yotpo/yotpo.constants.js

@@ -0,0 +1,7 @@
+const BASE_URL = 'https://loyalty.yotpo.com/api';
+const DEFAULT_API_VERSION = 'v2';
+
+module.exports = {
+  BASE_URL,
+  DEFAULT_API_VERSION,
+};

package/api/yotpo/yotpo.utils.js

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

package/api/yotpo/yotpoCampaignsGet.js

@@ -0,0 +1,75 @@
+// https://loyaltyapi.yotpo.com/reference/get-active-campaigns
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const yotpoCampaignsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    withStatus,
+    customerIdentifier,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+  } = customerIdentifier ?? {};
+
+  const params = {
+    ...(withStatus !== undefined && { with_status: withStatus }),
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/campaigns',
+    params,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCampaignsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCampaignsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" }
+  }'
+
+curl -X POST "http://localhost:8000/yotpoCampaignsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "options": {
+      "withStatus": true,
+      "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" }
+    }
+  }'
+*/

package/api/yotpo/yotpoCustomerActionRecord.js

@@ -0,0 +1,95 @@
+// https://loyaltyapi.yotpo.com/reference/record-a-customer-action
+
+const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId',
+    'customerEmail',
+  ]);
+};
+
+const actionNameValidator = Boolean;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+  ['actionName', actionNameValidator],
+]);
+
+const yotpoCustomerActionRecord = async (
+  credsPayload,
+  customerIdentifier,
+  actionName,
+  {
+    apiVersion,
+    type = 'CustomAction',
+    ipAddress,
+    userAgent,
+    createdAt,
+    rewardPoints,
+    historyTitle,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+    actionName,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+  } = customerIdentifier;
+
+  const body = {
+    type,
+    action_name: actionName,
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(ipAddress && { ip_address: ipAddress }),
+    ...(userAgent && { user_agent: userAgent }),
+    ...(createdAt && { created_at: createdAt }),
+    ...(rewardPoints !== undefined && { reward_points: Number(rewardPoints) }),
+    ...(historyTitle && { history_title: historyTitle }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/actions',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerActionRecord,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerActionRecord" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" },
+    "actionName": "completed_survey"
+  }'
+*/

package/api/yotpo/yotpoCustomerAnniversaryGet.js

@@ -0,0 +1,60 @@
+// https://loyaltyapi.yotpo.com/reference/get-customer-anniversary
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerEmail'],
+]);
+
+const yotpoCustomerAnniversaryGet = async (
+  credsPayload,
+  customerEmail,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerEmail,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const response = await yotpoClient.fetch({
+    url: '/customer_anniversary',
+    params: {
+      customer_email: customerEmail,
+    },
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerAnniversaryGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerAnniversaryGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerEmail": "john@whitefoxboutique.com"
+  }'
+*/

package/api/yotpo/yotpoCustomerAnniversarySet.js

@@ -0,0 +1,78 @@
+// https://loyaltyapi.yotpo.com/reference/createupdate-customer-anniversary
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const dayValidator = Number;
+const monthValidator = Number;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerEmail'],
+  ['day', dayValidator],
+  ['month', monthValidator],
+]);
+
+const yotpoCustomerAnniversarySet = async (
+  credsPayload,
+  customerEmail,
+  day,
+  month,
+  {
+    apiVersion,
+    year,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerEmail,
+    day,
+    month,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const body = {
+    customer_email: customerEmail,
+    day: Number(day),
+    month: Number(month),
+    ...(year !== undefined && { year: Number(year) }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/customer_anniversary',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerAnniversarySet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerAnniversarySet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerEmail": "john@whitefoxboutique.com",
+    "day": 1,
+    "month": 7
+  }'
+*/

package/api/yotpo/yotpoCustomerBirthdaySet.js

@@ -0,0 +1,91 @@
+// https://loyaltyapi.yotpo.com/reference/set-customer-birthday
+
+const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId',
+    'customerEmail',
+  ]);
+};
+
+const dayValidator = Number;
+const monthValidator = Number;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+  ['day', dayValidator],
+  ['month', monthValidator],
+]);
+
+const yotpoCustomerBirthdaySet = async (
+  credsPayload,
+  customerIdentifier,
+  day,
+  month,
+  {
+    apiVersion,
+    year,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+    day,
+    month,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+  } = customerIdentifier;
+
+  const body = {
+    day: Number(day),
+    month: Number(month),
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(year !== undefined && { year: Number(year) }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/customer_birthdays',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerBirthdaySet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerBirthdaySet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" },
+    "day": 1,
+    "month": 7
+  }'
+*/

package/api/yotpo/yotpoCustomerGet.js

@@ -0,0 +1,104 @@
+// https://loyaltyapi.yotpo.com/reference/fetch-customer-details
+
+const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId',
+    'customerEmail',
+    'customerPhone',
+    'posAccountId',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+]);
+
+const yotpoCustomerGet = async (
+  credsPayload,
+  customerIdentifier,
+  {
+    apiVersion,
+    countryCodeIso,
+    withReferralCode,
+    withHistory,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+    customerPhone,
+    posAccountId,
+  } = customerIdentifier;
+
+  const params = {
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(customerPhone && { phone_number: customerPhone }),
+    ...(posAccountId && { pos_account_id: posAccountId }),
+    ...(countryCodeIso && { country_code_iso: countryCodeIso }),
+    ...(withReferralCode !== undefined && { with_referral_code: withReferralCode }),
+    ...(withHistory !== undefined && { with_history: withHistory }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/customers',
+    params,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsObject": {
+        "API_KEY": "xxx",
+        "GUID": "xxx"
+      }
+    },
+    "customerIdentifier": {
+      "customerEmail": "john@example.com"
+    },
+    "options": {
+      "withHistory": true
+    }
+  }'
+
+curl -X POST "http://localhost:8000/yotpoCustomerGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" }
+  }'
+*/

package/api/yotpo/yotpoCustomerPointsAdjust.js

@@ -0,0 +1,89 @@
+// https://loyaltyapi.yotpo.com/reference/adjust-a-customers-point-balance
+
+const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId', 
+    'customerEmail',
+  ]);
+};
+
+const pointsAmountValidator = Number;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+  ['pointsAmount', pointsAmountValidator],
+]);
+
+const yotpoCustomerPointsAdjust = async (
+  credsPayload,
+  customerIdentifier,
+  pointsAmount,
+  {
+    apiVersion,
+    applyAdjustmentToPointsEarned,
+    historyTitle,
+    visibleToCustomer = true,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+    pointsAmount,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+  } = customerIdentifier;
+
+  const body = {
+    point_adjustment_amount: Number(pointsAmount),
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(historyTitle && { history_title: historyTitle }),
+    ...(applyAdjustmentToPointsEarned !== undefined && { apply_adjustment_to_points_earned: applyAdjustmentToPointsEarned }),
+    visible_to_customer: visibleToCustomer,
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/points/adjust',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerPointsAdjust,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerPointsAdjust" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" },
+    "pointsAmount": 100
+  }'
+*/