@foxtware/mineral 1.0.4 → 1.0.7

package/api/shopify/shopifyShopGet.js

@@ -0,0 +1,68 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/shop
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+
+const defaultAttrs = `
+id
+  name
+  myshopifyDomain
+  primaryDomain { host url }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyShopGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'shop',
+    null,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyShopGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyShopGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyShopGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.staging" },
+    "options": {
+      "attrs": "id name metafield(namespace: \\"custom\\", key: \\"stores_audit\\") { id namespace key type value }"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontArticleGet.js

@@ -0,0 +1,86 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/article
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  handle
+  title
+  content
+  excerpt
+  publishedAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['articleId'],
+]);
+
+const shopifyStorefrontArticleGet = async (
+  credsPayload,
+  articleId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    articleId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+  const id = articleId.toString().startsWith('gid://')
+    ? articleId
+    : `gid://shopify/Article/${ articleId }`;
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontArticleById ($id: ID!)${ inContextDirective } {
+            article(id: $id) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: { id },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.article',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontArticleGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontArticleGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "articleId": "1234567890"
+  }'
+*/

package/api/shopify/shopifyStorefrontArticlesGet.js

@@ -0,0 +1,67 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/articles
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyStorefrontGet, shopifyStorefrontGetter } = require('./shopifyStorefrontGet');
+
+const defaultAttrs = `
+id
+  handle
+  title
+  publishedAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontArticlesGetInner = async (
+  returnGetter,
+  credsPayload,
+  {
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'article',
+    {
+      attrs,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyStorefrontGetter(...getterArgs)
+    : shopifyStorefrontGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontArticlesGet: (...args) => shopifyStorefrontArticlesGetInner(false, ...args),
+  shopifyStorefrontArticlesGetter: (...args) => shopifyStorefrontArticlesGetInner(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontArticlesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontBlogGet.js

@@ -0,0 +1,110 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/blog
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  handle
+  title
+`.trim();
+
+const identifierValidator = (identifier) => objHasAny(identifier, ['id', 'handle']);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['blogIdentifier', identifierValidator],
+]);
+
+const shopifyStorefrontBlogGet = async (
+  credsPayload,
+  blogIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    blogIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { id, handle } = blogIdentifier;
+  const inContextDirective = buildInContextDirective(inContext);
+
+  if (handle) {
+    return fetchClient.fetch({
+      requestPayload: {
+        method: 'post',
+        body: {
+          query: `
+            query StorefrontBlogByHandle ($handle: String!)${ inContextDirective } {
+              blog: blogByHandle(handle: $handle) {
+                ${ attrs }
+              }
+            }
+          `,
+          variables: { handle },
+        },
+      },
+      context: {
+        credsPayload,
+        apiVersion,
+        resultPath: 'data.blog',
+      },
+    });
+  }
+
+  const blogGid = id.toString().startsWith('gid://')
+    ? id
+    : `gid://shopify/Blog/${ id }`;
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontBlogById ($id: ID!)${ inContextDirective } {
+            blog(id: $id) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: { id: blogGid },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.blog',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontBlogGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontBlogGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "blogIdentifier": { "handle": "news" }
+  }'
+*/

package/api/shopify/shopifyStorefrontBlogsGet.js

@@ -0,0 +1,66 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/blogs
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyStorefrontGet, shopifyStorefrontGetter } = require('./shopifyStorefrontGet');
+
+const defaultAttrs = `
+id
+  handle
+  title
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontBlogsGetInner = async (
+  returnGetter,
+  credsPayload,
+  {
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'blog',
+    {
+      attrs,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyStorefrontGetter(...getterArgs)
+    : shopifyStorefrontGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontBlogsGet: (...args) => shopifyStorefrontBlogsGetInner(false, ...args),
+  shopifyStorefrontBlogsGetter: (...args) => shopifyStorefrontBlogsGetInner(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontBlogsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontCartAttributesUpdate.js

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

package/api/shopify/shopifyStorefrontCartBuyerIdentityUpdate.js

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

package/api/shopify/shopifyStorefrontCartCreate.js

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