@foxtware/mineral 1.0.4 → 1.0.7

package/api/shopify/shopifyStorefrontCartGiftCardCodesUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartGiftCardCodesUpdate
+
+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 shopifyStorefrontCartGiftCardCodesUpdate = async (
+  credsPayload,
+  cartId,
+  giftCardCodes,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    giftCardCodes
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartGiftCardCodesUpdate',
+    {
+      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 = {
+  shopifyStorefrontCartGiftCardCodesUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartGiftCardCodesUpdate" \
+  -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/shopifyStorefrontCartLinesAdd.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesAdd
+
+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'],
+  ['lines'],
+]);
+
+const shopifyStorefrontCartLinesAdd = async (
+  credsPayload,
+  cartId,
+  lines,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    lines
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartLinesAdd',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        lines: {
+          type: '[CartLineInput!]!',
+          value: lines,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartLinesAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartLinesAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "lines": [{"merchandiseId":"gid://shopify/ProductVariant/123","quantity":1}],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartLinesRemove.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesRemove
+
+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'],
+  ['lineIds'],
+]);
+
+const shopifyStorefrontCartLinesRemove = async (
+  credsPayload,
+  cartId,
+  lineIds,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    lineIds
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartLinesRemove',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        lineIds: {
+          type: '[ID!]!',
+          value: lineIds,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartLinesRemove,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartLinesRemove" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "lineIds": ["gid://shopify/CartLine/xxx"],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartLinesUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesUpdate
+
+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'],
+  ['lines'],
+]);
+
+const shopifyStorefrontCartLinesUpdate = async (
+  credsPayload,
+  cartId,
+  lines,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    lines
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartLinesUpdate',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        lines: {
+          type: '[CartLineUpdateInput!]!',
+          value: lines,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartLinesUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartLinesUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "lines": [{"id":"gid://shopify/CartLine/xxx","quantity":2}],
+  }'
+*/

package/api/shopify/shopifyStorefrontCartMetafieldDelete.js

@@ -0,0 +1,69 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartMetafieldDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['input'],
+]);
+
+const shopifyStorefrontCartMetafieldDelete = async (
+  credsPayload,
+  input,
+  {
+    apiVersion,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartMetafieldDelete',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CartMetafieldDeleteInput!',
+          value: input,
+        },
+      },
+      returnSchema: `
+        deletedId
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartMetafieldDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartMetafieldDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "input": {
+      "ownerId": "gid://shopify/Cart/c1-xxx?key=yyy",
+      "key": "custom.note"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontCartMetafieldsSet.js

@@ -0,0 +1,80 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartMetafieldsSet
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnMetafieldAttrs = `
+  id
+  namespace
+  key
+  value
+  type
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metafields'],
+]);
+
+const shopifyStorefrontCartMetafieldsSet = async (
+  credsPayload,
+  metafields,
+  {
+    apiVersion,
+    returnMetafieldAttrs = defaultReturnMetafieldAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metafields,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartMetafieldsSet',
+    {
+      mutationVariables: {
+        metafields: {
+          type: '[CartMetafieldsSetInput!]!',
+          value: metafields,
+        },
+      },
+      returnSchema: `
+        metafields { ${ returnMetafieldAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartMetafieldsSet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartMetafieldsSet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metafields": [{
+      "ownerId": "gid://shopify/Cart/c1-xxx?key=yyy",
+      "key": "custom.note",
+      "type": "single_line_text_field",
+      "value": "hello"
+    }]
+  }'
+*/

package/api/shopify/shopifyStorefrontCartNoteUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartNoteUpdate
+
+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'],
+  ['note'],
+]);
+
+const shopifyStorefrontCartNoteUpdate = async (
+  credsPayload,
+  cartId,
+  note,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    note
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartNoteUpdate',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        note: {
+          type: 'String!',
+          value: note,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartNoteUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartNoteUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "note": "Please gift wrap",
+  }'
+*/

package/api/shopify/shopifyStorefrontCartSelectedDeliveryOptionsUpdate.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/cartSelectedDeliveryOptionsUpdate
+
+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'],
+  ['selectedDeliveryOptions'],
+]);
+
+const shopifyStorefrontCartSelectedDeliveryOptionsUpdate = async (
+  credsPayload,
+  cartId,
+  selectedDeliveryOptions,
+  {
+    apiVersion,
+    returnCartAttrs = defaultReturnCartAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cartId,
+    selectedDeliveryOptions
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'cartSelectedDeliveryOptionsUpdate',
+    {
+      mutationVariables: {
+        cartId: {
+          type: 'ID!',
+          value: cartId,
+        },
+        selectedDeliveryOptions: {
+          type: '[CartSelectedDeliveryOptionInput!]!',
+          value: selectedDeliveryOptions,
+        },
+      },
+      returnSchema: `
+        cart { ${ returnCartAttrs } }
+        warnings { code message }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCartSelectedDeliveryOptionsUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCartSelectedDeliveryOptionsUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "cartId": "gid://shopify/Cart/c1-xxx?key=yyy",
+    "selectedDeliveryOptions": [{"deliveryGroupId":"gid://shopify/CartDeliveryGroup/xxx","deliveryOptionHandle":"standard"}],
+  }'
+*/