@foxtware/mineral 1.0.5 → 1.0.7

package/api/shopify/shopifyStorefrontCartDeliveryAddressesAdd.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartDeliveryAddressesAdd
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['addresses'],
+]);
+
+const shopifyStorefrontCartDeliveryAddressesAdd = async (
+  credsPayload,
+  cartId,
+  addresses,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    addresses
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartDeliveryAddressesAdd',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        addresses: {
+          type: '[CartSelectableAddressInput!]!',
+          value: addresses,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartDeliveryAddressesAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartDeliveryAddressesAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "addresses": [{"address":{"deliveryAddress":{"address1":"1 Main St","city":"Sydney","countryCode":"AU","zip":"2000"}}}],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartDeliveryAddressesRemove.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartDeliveryAddressesRemove
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['addressIds'],
+]);
+
+const shopifyStorefrontCartDeliveryAddressesRemove = async (
+  credsPayload,
+  cartId,
+  addressIds,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    addressIds
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartDeliveryAddressesRemove',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        addressIds: {
+          type: '[ID!]!',
+          value: addressIds,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartDeliveryAddressesRemove,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartDeliveryAddressesRemove" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "addressIds": ["gid://shopify/CartSelectableAddress/xxx"],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartDeliveryAddressesReplace.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartDeliveryAddressesReplace
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['addresses'],
+]);
+
+const shopifyStorefrontCartDeliveryAddressesReplace = async (
+  credsPayload,
+  cartId,
+  addresses,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    addresses
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartDeliveryAddressesReplace',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        addresses: {
+          type: '[CartSelectableAddressInput!]!',
+          value: addresses,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartDeliveryAddressesReplace,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartDeliveryAddressesReplace" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "addresses": [{"address":{"deliveryAddress":{"address1":"1 Main St","city":"Sydney","countryCode":"AU","zip":"2000"}}}],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartDeliveryAddressesUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartDeliveryAddressesUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['addresses'],
+]);
+
+const shopifyStorefrontCartDeliveryAddressesUpdate = async (
+  credsPayload,
+  cartId,
+  addresses,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    addresses
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartDeliveryAddressesUpdate',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        addresses: {
+          type: '[CartSelectableAddressUpdateInput!]!',
+          value: addresses,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartDeliveryAddressesUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartDeliveryAddressesUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "addresses": [{"id":"gid://shopify/CartSelectableAddress/xxx","address":{"deliveryAddress":{"city":"Melbourne"}}}],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartDiscountCodesUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartDiscountCodesUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['discountCodes'],
+]);
+
+const shopifyStorefrontCartDiscountCodesUpdate = async (
+  credsPayload,
+  cartId,
+  discountCodes,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    discountCodes
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartDiscountCodesUpdate',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        discountCodes: {
+          type: '[String!]',
+          value: discountCodes,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartDiscountCodesUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartDiscountCodesUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "discountCodes": ["SAVE10"],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartGet.js

@@ -0,0 +1,100 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/cart
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+  lines(first: 50) {
+    edges {
+      node {
+        id
+        quantity
+        merchandise {
+          ... on ProductVariant {
+            id
+            title
+            product { id handle title }
+          }
+        }
+      }
+    }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+]);
+
+const shopifyStorefrontCartGet = async (
+  credsPayload,
+  cartId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontCart ($id: ID!)${ inContextDirective } {
+            cart(id: $id) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: { id: cartId },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.cart',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy"
+  }'
+*/

package/api/shopify/shopifyStorefrontCartGiftCardCodesAdd.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartGiftCardCodesAdd
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['giftCardCodes'],
+]);
+
+const shopifyStorefrontCartGiftCardCodesAdd = async (
+  credsPayload,
+  cartId,
+  giftCardCodes,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    giftCardCodes
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartGiftCardCodesAdd',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        giftCardCodes: {
+          type: '[String!]!',
+          value: giftCardCodes,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartGiftCardCodesAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartGiftCardCodesAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "giftCardCodes": ["ABCD-EFGH-IJKL"],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartGiftCardCodesRemove.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartGiftCardCodesRemove
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCartAttrs = `
+id
+  checkoutUrl
+  totalQuantity
+  note
+  cost {
+    totalAmount { amount currencyCode }
+    subtotalAmount { amount currencyCode }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cartId'],
+  ['appliedGiftCardIds'],
+]);
+
+const shopifyStorefrontCartGiftCardCodesRemove = async (
+  credsPayload,
+  cartId,
+  appliedGiftCardIds,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    appliedGiftCardIds
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartGiftCardCodesRemove',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        appliedGiftCardIds: {
+          type: '[ID!]!',
+          value: appliedGiftCardIds,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartGiftCardCodesRemove,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartGiftCardCodesRemove" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "appliedGiftCardIds": ["gid://shopify/AppliedGiftCard/xxx"],
+  }'
+*/