@foxtware/mineral 1.0.4 → 1.0.7

package/api/shopify/shopifyStorefrontPredictiveSearch.js

@@ -0,0 +1,138 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/predictiveSearch
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  products {
+    id
+    handle
+    title
+  }
+  collections {
+    id
+    handle
+    title
+  }
+  pages {
+    id
+    handle
+    title
+  }
+  articles {
+    id
+    handle
+    title
+  }
+  queries {
+    text
+    styledText
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const shopifyStorefrontPredictiveSearch = async (
+  credsPayload,
+  query,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    limit,
+    limitScope,
+    types,
+    searchableFields,
+    unavailableProducts,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  const queryTypeDeclaration = [
+    '$query: String!',
+    ...limit !== undefined ? ['$limit: Int'] : [],
+    ...limitScope ? ['$limitScope: PredictiveSearchLimitScope'] : [],
+    ...types ? ['$types: [PredictiveSearchType!]'] : [],
+    ...searchableFields ? ['$searchableFields: [SearchableField!]'] : [],
+    ...unavailableProducts ? ['$unavailableProducts: SearchUnavailableProductsType'] : [],
+  ].join('\n');
+
+  const queryVariableDeclaration = [
+    'query: $query',
+    ...limit !== undefined ? ['limit: $limit'] : [],
+    ...limitScope ? ['limitScope: $limitScope'] : [],
+    ...types ? ['types: $types'] : [],
+    ...searchableFields ? ['searchableFields: $searchableFields'] : [],
+    ...unavailableProducts ? ['unavailableProducts: $unavailableProducts'] : [],
+  ].join('\n');
+
+  const variables = {
+    query,
+    ...limit !== undefined && { limit },
+    ...limitScope && { limitScope },
+    ...types && { types },
+    ...searchableFields && { searchableFields },
+    ...unavailableProducts && { unavailableProducts },
+  };
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontPredictiveSearch (
+            ${ queryTypeDeclaration }
+          )${ inContextDirective } {
+            predictiveSearch(
+              ${ queryVariableDeclaration }
+            ) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.predictiveSearch',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontPredictiveSearch,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontPredictiveSearch" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "query": "dress",
+    "options": { "limit": 5, "types": ["PRODUCT"] }
+  }'
+*/

package/api/shopify/shopifyStorefrontProductGet.js

@@ -0,0 +1,94 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/product
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+id
+  handle
+  title
+  availableForSale
+  productType
+  vendor
+`.trim();
+
+const identifierValidator = (identifier) => objHasAny(identifier, ['id', 'handle']);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIdentifier', identifierValidator],
+]);
+
+const shopifyStorefrontProductGet = async (
+  credsPayload,
+  productIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { id, handle } = productIdentifier;
+  const inContextDirective = buildInContextDirective(inContext);
+
+  const useHandle = Boolean(handle);
+  const queryName = useHandle ? 'StorefrontProductByHandle' : 'StorefrontProductById';
+  const argDecl = useHandle ? '$handle: String!' : '$id: ID!';
+  const argUse = useHandle ? 'handle: $handle' : 'id: $id';
+  const variables = useHandle
+    ? { handle }
+    : { id: id.toString().startsWith('gid://') ? id : `gid://shopify/Product/${ id }` };
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query ${ queryName } (${ argDecl })${ inContextDirective } {
+            product(${ argUse }) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.product',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontProductGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontProductGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "productIdentifier": { "handle": "offstage-hoodie-moon" }
+  }'
+*/

package/api/shopify/shopifyStorefrontProductRecommendationsGet.js

@@ -0,0 +1,112 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/productRecommendations
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  handle
+  title
+  availableForSale
+`.trim();
+
+const identifierValidator = (identifier) => objHasAny(identifier, ['productId', 'productHandle']);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIdentifier', identifierValidator],
+]);
+
+const shopifyStorefrontProductRecommendationsGet = async (
+  credsPayload,
+  productIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    intent,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { productId, productHandle } = productIdentifier;
+  const inContextDirective = buildInContextDirective(inContext);
+
+  const queryTypeDeclaration = [
+    ...productHandle ? ['$productHandle: String'] : [],
+    ...productId ? ['$productId: ID'] : [],
+    ...intent ? ['$intent: ProductRecommendationIntent'] : [],
+  ].join('\n');
+
+  const queryVariableDeclaration = [
+    ...productHandle ? ['productHandle: $productHandle'] : [],
+    ...productId ? ['productId: $productId'] : [],
+    ...intent ? ['intent: $intent'] : [],
+  ].join('\n');
+
+  const variables = {
+    ...productHandle && { productHandle },
+    ...productId && {
+      productId: productId.toString().startsWith('gid://')
+        ? productId
+        : `gid://shopify/Product/${ productId }`,
+    },
+    ...intent && { intent },
+  };
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontProductRecommendations (
+            ${ queryTypeDeclaration }
+          )${ inContextDirective } {
+            productRecommendations(
+              ${ queryVariableDeclaration }
+            ) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.productRecommendations',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontProductRecommendationsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontProductRecommendationsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "productIdentifier": { "productHandle": "offstage-hoodie-moon" },
+    "options": { "intent": "RELATED" }
+  }'
+*/

package/api/shopify/shopifyStorefrontProductTagsGet.js

@@ -0,0 +1,80 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/productTags
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { MAX_PER_PAGE } = require('./shopify.constants');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontProductTagsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    first = MAX_PER_PAGE,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontProductTagsGet ($first: Int!)${ inContextDirective } {
+            productTags(first: $first) {
+              edges {
+                node
+              }
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+            }
+          }
+        `,
+        variables: {
+          first,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.productTags',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontProductTagsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontProductTagsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": { "first": 50 }
+  }'
+*/

package/api/shopify/shopifyStorefrontProductTypesGet.js

@@ -0,0 +1,80 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/productTypes
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { MAX_PER_PAGE } = require('./shopify.constants');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontProductTypesGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    first = MAX_PER_PAGE,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontProductTypesGet ($first: Int!)${ inContextDirective } {
+            productTypes(first: $first) {
+              edges {
+                node
+              }
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+            }
+          }
+        `,
+        variables: {
+          first,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.productTypes',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontProductTypesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontProductTypesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": { "first": 50 }
+  }'
+*/

package/api/shopify/shopifyStorefrontProductsGet.js

@@ -0,0 +1,76 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/products
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyStorefrontGet, shopifyStorefrontGetter } = require('./shopifyStorefrontGet');
+
+const defaultAttrs = `
+id
+  handle
+  title
+  availableForSale
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontProductsGetInner = async (
+  returnGetter,
+  credsPayload,
+  {
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'product',
+    {
+      attrs,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyStorefrontGetter(...getterArgs)
+    : shopifyStorefrontGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontProductsGet: (...args) => shopifyStorefrontProductsGetInner(false, ...args),
+  shopifyStorefrontProductsGetter: (...args) => shopifyStorefrontProductsGetInner(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "attrs": "id handle title description descriptionHtml availableForSale productType vendor tags createdAt updatedAt publishedAt onlineStoreUrl isGiftCard requiresSellingPlan totalInventory seo { title description } featuredImage { id url altText width height } priceRange { minVariantPrice { amount currencyCode } maxVariantPrice { amount currencyCode } } compareAtPriceRange { minVariantPrice { amount currencyCode } maxVariantPrice { amount currencyCode } } options { id name values } images(first: 5) { edges { node { id url altText width height } } } media(first: 5) { edges { node { mediaContentType ... on MediaImage { id image { url altText width height } } } } } variants(first: 20) { edges { node { id title sku barcode availableForSale quantityAvailable currentlyNotInStock requiresComponents selectedOptions { name value } image { id url altText width height } price { amount currencyCode } compareAtPrice { amount currencyCode } unitPrice { amount currencyCode } weight weightUnit } } } sellingPlanGroups(first: 5) { edges { node { name sellingPlans(first: 5) { edges { node { id name description options { name value } } } } } } } category { id name ancestors { id name } } metafields(identifiers: [{namespace: \"shopify\", key: \"color-pattern\"}, {namespace: \"shopify\", key: \"target-gender\"}, {namespace: \"shopify\", key: \"age-group\"}, {namespace: \"shopify\", key: \"fabric\"}, {namespace: \"shopify\", key: \"neckline\"}, {namespace: \"shopify\", key: \"sleeve-length-type\"}, {namespace: \"shopify\", key: \"clothing-features\"}, {namespace: \"shopify\", key: \"dress-occasion\"}]) { id namespace key type value }"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyStorefrontProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "attrs": "id handle title description descriptionHtml availableForSale productType vendor tags createdAt updatedAt publishedAt onlineStoreUrl isGiftCard requiresSellingPlan totalInventory seo { title description } featuredImage { id url altText width height } priceRange { minVariantPrice { amount currencyCode } maxVariantPrice { amount currencyCode } } compareAtPriceRange { minVariantPrice { amount currencyCode } maxVariantPrice { amount currencyCode } } options { id name values } images(first: 5) { edges { node { id url altText width height } } } media(first: 5) { edges { node { mediaContentType ... on MediaImage { id image { url altText width height } } } } } variants(first: 20) { edges { node { id title sku barcode availableForSale quantityAvailable currentlyNotInStock requiresComponents selectedOptions { name value } image { id url altText width height } price { amount currencyCode } compareAtPrice { amount currencyCode } unitPrice { amount currencyCode } weight weightUnit } } } sellingPlanGroups(first: 5) { edges { node { name sellingPlans(first: 5) { edges { node { id name description options { name value } } } } } } } category { id name ancestors { id name } } metafields(identifiers: [{namespace: \"shopify\", key: \"color-pattern\"}, {namespace: \"shopify\", key: \"target-gender\"}, {namespace: \"shopify\", key: \"age-group\"}, {namespace: \"shopify\", key: \"fabric\"}, {namespace: \"shopify\", key: \"neckline\"}, {namespace: \"shopify\", key: \"sleeve-length-type\"}, {namespace: \"shopify\", key: \"clothing-features\"}, {namespace: \"shopify\", key: \"dress-occasion\"}]) { id namespace key type value }"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontPublicApiVersionsGet.js

@@ -0,0 +1,75 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/publicApiVersions
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  handle
+  displayName
+  supported
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontPublicApiVersionsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontPublicApiVersions${ inContextDirective } {
+            publicApiVersions {
+              ${ attrs }
+            }
+          }
+        `,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.publicApiVersions',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontPublicApiVersionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontPublicApiVersionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+*/

package/api/shopify/shopifyStorefrontSearch.js

@@ -2,7 +2,10 @@
 
 const { credsValidator } = require('../validators');
 const { ArgsWarden } = require('../utils');
-const { shopifyStorefrontClient } = require('./shopify.utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
 const { MAX_PER_PAGE } = require('./shopify.constants');
 
 const defaultAttrs = `
@@ -42,6 +45,7 @@ const shopifyStorefrontSearch = async (
     prefix,
     productFilters,
     unavailableProducts,
+    inContext,
     fetchClient = shopifyStorefrontClient,
   } = {},
 ) => {
@@ -54,6 +58,8 @@ const shopifyStorefrontSearch = async (
     return rejectResponse;
   }
 
+  const inContextDirective = buildInContextDirective(inContext);
+
   const queryTypeDeclaration = [
     '$query: String!',
     '$first: Int!',
@@ -97,7 +103,7 @@ const shopifyStorefrontSearch = async (
         query: `
           query StorefrontSearch (
             ${ queryTypeDeclaration }
-          ) {
+          )${ inContextDirective } {
             search(
               ${ queryVariableDeclaration }
             ) {