@foxtware/mineral 0.1.15 → 0.1.16

package/api/shopify/shopifyCatalogsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyCatalogsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'catalog', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'catalog', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyCatalogsGet,
+  shopifyCatalogsGet: (...args) => shopifyCatalogsGet(false, ...args),
+  shopifyCatalogsGetter: (...args) => shopifyCatalogsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyChannelsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyChannelsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'channel', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'channel', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyChannelsGet,
+  shopifyChannelsGet: (...args) => shopifyChannelsGet(false, ...args),
+  shopifyChannelsGetter: (...args) => shopifyChannelsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyCheckoutAndAccountsConfigurationsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyCheckoutAndAccountsConfigurationsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'checkoutAndAccountsConfiguration', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'checkoutAndAccountsConfiguration', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyCheckoutAndAccountsConfigurationsGet,
+  shopifyCheckoutAndAccountsConfigurationsGet: (...args) => shopifyCheckoutAndAccountsConfigurationsGet(false, ...args),
+  shopifyCheckoutAndAccountsConfigurationsGetter: (...args) => shopifyCheckoutAndAccountsConfigurationsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyCollectionGet.js

@@ -29,7 +29,10 @@ const shopifyCollectionGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, collectionIdentifier });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    collectionIdentifier,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyCollectionsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyCollectionsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'collection', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'collection', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyCollectionsGet,
+  shopifyCollectionsGet: (...args) => shopifyCollectionsGet(false, ...args),
+  shopifyCollectionsGetter: (...args) => shopifyCollectionsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyCustomerCreate.js

@@ -22,8 +22,8 @@ const shopifyCustomerCreate = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
-    credsPayload, 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
     customerInput,
   });
   if (rejectResponse) {

package/api/shopify/shopifyCustomerGet.js

@@ -30,7 +30,10 @@ const shopifyCustomerGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, customerIdentifier });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyCustomerMarketingConsentUpdateSms.js

@@ -0,0 +1,84 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSmsMarketingConsentUpdate
+
+const { credsValidator } = require('../validators');
+const { objHasAny, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const consentPayloadValidator = (consentPayload) => {
+  return objHasAny(consentPayload, [
+    'consentUpdatedAt',
+    'marketingOptInLevel',
+    'marketingState',
+    'sourceLocationId',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerId'],
+  ['consentPayload', consentPayloadValidator],
+]);
+
+const defaultReturnCustomerAttrs = 'phone smsMarketingConsent { marketingState consentUpdatedAt marketingOptInLevel }';
+
+const shopifyCustomerMarketingConsentUpdateSms = async (
+  credsPayload,
+  customerId,
+  consentPayload,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerId,
+    consentPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'customerSmsMarketingConsentUpdate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CustomerSmsMarketingConsentUpdateInput!',
+          value: {
+            customerId: `gid://shopify/Customer/${ customerId }`,
+            smsMarketingConsent: consentPayload,
+          },
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomerMarketingConsentUpdateSms,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomerMarketingConsentUpdateSms" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerId": "8575963103304",
+    "consentPayload": {
+      "marketingState": "UNSUBSCRIBED",
+      "marketingOptInLevel": "SINGLE_OPT_IN"
+    }
+  }'
+*/

package/api/shopify/shopifyCustomersGet.js

@@ -1,28 +1,40 @@
 // https://shopify.dev/docs/api/admin-graphql/latest/queries/customers
 
-const { credsFromPayload, Getter, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyCustomersGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'customer', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'customer', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyCustomersGet,
+  shopifyCustomersGet: (...args) => shopifyCustomersGet(false, ...args),
+  shopifyCustomersGetter: (...args) => shopifyCustomersGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyDecodeSessionToken.js

@@ -20,7 +20,7 @@ const base64UrlDecodeJson = (input) => {
   return JSON.parse(Buffer.from(`${ base64 }${ padding }`, 'base64').toString('utf8'));
 };
 
-const normalizeSessionToken = (sessionToken) => {
+const normaliseSessionToken = (sessionToken) => {
   const trimmedToken = sessionToken.trim();
 
   if (trimmedToken.toLowerCase().startsWith('bearer ')) {
@@ -116,7 +116,7 @@ const shopifyDecodeSessionToken = async (
     };
   }
 
-  const token = normalizeSessionToken(sessionToken);
+  const token = normaliseSessionToken(sessionToken);
   const decoded = decodeSessionTokenPayload(token);
 
   if (!decoded) {

package/api/shopify/shopifyDeliveryCustomizationsGet.js

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

package/api/shopify/shopifyDeliveryProfilesGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyDeliveryProfilesGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'deliveryProfile', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'deliveryProfile', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyDeliveryProfilesGet,
+  shopifyDeliveryProfilesGet: (...args) => shopifyDeliveryProfilesGet(false, ...args),
+  shopifyDeliveryProfilesGetter: (...args) => shopifyDeliveryProfilesGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyDiscountNodesGet.js

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

package/api/shopify/shopifyDisputesGet.js

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

package/api/shopify/shopifyDraftOrdersGet.js

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

package/api/shopify/shopifyEventsGet.js

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

package/api/shopify/shopifyFilesGet.js

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

package/api/shopify/shopifyFulfillmentOrdersGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyFulfillmentOrdersGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'fulfillmentOrder', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'fulfillmentOrder', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyFulfillmentOrdersGet,
+  shopifyFulfillmentOrdersGet: (...args) => shopifyFulfillmentOrdersGet(false, ...args),
+  shopifyFulfillmentOrdersGetter: (...args) => shopifyFulfillmentOrdersGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyGet.js

@@ -225,7 +225,7 @@ const shopifyGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
     resource,
   });

package/api/shopify/shopifyGiftCardCreate.js

@@ -29,7 +29,10 @@ const shopifyGiftCardCreate = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, giftCardInput });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    giftCardInput,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyGiftCardDeactivate.js

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

package/api/shopify/shopifyGiftCardsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyGiftCardsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'giftCard', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'giftCard', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyGiftCardsGet,
+  shopifyGiftCardsGet: (...args) => shopifyGiftCardsGet(false, ...args),
+  shopifyGiftCardsGetter: (...args) => shopifyGiftCardsGet(true, ...args),
   funcApiConfig,
 };