@foxtware/mineral 1.0.5 → 1.0.7

package/api/shopify/shopifyStorefrontMetaobjectGet.js

@@ -0,0 +1,126 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/metaobject
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  handle
+  type
+  updatedAt
+  fields {
+    key
+    value
+    type
+  }
+`.trim();
+
+const identifierValidator = (identifier) => {
+  if (!identifier || typeof identifier !== 'object') {
+    return false;
+  }
+  if (identifier.id) {
+    return true;
+  }
+  return Boolean(identifier.handle?.handle && identifier.handle?.type);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metaobjectIdentifier', identifierValidator],
+]);
+
+const shopifyStorefrontMetaobjectGet = async (
+  credsPayload,
+  metaobjectIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metaobjectIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { id, handle } = metaobjectIdentifier;
+  const inContextDirective = buildInContextDirective(inContext);
+
+  if (handle) {
+    return fetchClient.fetch({
+      requestPayload: {
+        method: 'post',
+        body: {
+          query: `
+            query StorefrontMetaobjectByHandle ($handle: MetaobjectHandleInput!)${ inContextDirective } {
+              metaobject(handle: $handle) {
+                ${ attrs }
+              }
+            }
+          `,
+          variables: { handle },
+        },
+      },
+      context: {
+        credsPayload,
+        apiVersion,
+        resultPath: 'data.metaobject',
+      },
+    });
+  }
+
+  const metaobjectGid = id.toString().startsWith('gid://')
+    ? id
+    : `gid://shopify/Metaobject/${ id }`;
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontMetaobjectById ($id: ID!)${ inContextDirective } {
+            metaobject(id: $id) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: { id: metaobjectGid },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.metaobject',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontMetaobjectGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontMetaobjectGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectIdentifier": {
+      "handle": { "type": "size_chart", "handle": "mens-tees" }
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontMetaobjectsGet.js

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

package/api/shopify/shopifyStorefrontMutationDo.js

@@ -0,0 +1,103 @@
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['mutationName'],
+]);
+
+const shopifyStorefrontMutationDo = async (
+  credsPayload,
+  mutationName,
+  {
+    mutationVariables = {},
+    returnSchema = '',
+    apiVersion,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+    ...clientOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    mutationName,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const isCustomerMutation = mutationName.startsWith('customer');
+  const errorField = isCustomerMutation ? 'customerUserErrors' : 'userErrors';
+
+  if (!returnSchema?.includes(errorField)) {
+    returnSchema += ` ${ errorField } { field message }`;
+  }
+
+  const argumentEntries = Object.entries(mutationVariables);
+  const inContextDirective = buildInContextDirective(inContext);
+  const variableDefs = argumentEntries
+    .map(([name, { type }]) => `$${ name }: ${ type }`)
+    .join(', ');
+  const argumentUses = argumentEntries
+    .map(([name]) => `${ name }: $${ name }`)
+    .join(', ');
+
+  const mutation = `
+    mutation ${ mutationName }${ variableDefs ? `(${ variableDefs })` : '' }${ inContextDirective } {
+      ${ mutationName }${ argumentUses ? `(${ argumentUses })` : '' } {
+        ${ returnSchema }
+      }
+    }
+  `;
+
+  const variables = Object.fromEntries(
+    argumentEntries.map(([name, { value }]) => [name, value]),
+  );
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: { query: mutation, variables },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: `data.${ mutationName }`,
+    },
+    ...clientOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontMutationDo,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontMutationDo" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "mutationName": "cartCreate",
+    "options": {
+      "mutationVariables": {
+        "input": {
+          "type": "CartInput",
+          "value": {
+            "lines": [{ "merchandiseId": "gid://shopify/ProductVariant/123", "quantity": 1 }]
+          }
+        }
+      },
+      "returnSchema": "cart { id checkoutUrl }"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontNodeGet.js

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

package/api/shopify/shopifyStorefrontNodesGet.js

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

package/api/shopify/shopifyStorefrontPageGet.js

@@ -0,0 +1,93 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/page
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+id
+  handle
+  title
+  body
+  bodySummary
+`.trim();
+
+const identifierValidator = (identifier) => objHasAny(identifier, ['id', 'handle']);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['pageIdentifier', identifierValidator],
+]);
+
+const shopifyStorefrontPageGet = async (
+  credsPayload,
+  pageIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    pageIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { id, handle } = pageIdentifier;
+  const inContextDirective = buildInContextDirective(inContext);
+
+  const useHandle = Boolean(handle);
+  const queryName = useHandle ? 'StorefrontPageByHandle' : 'StorefrontPageById';
+  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/Page/${ id }` };
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query ${ queryName } (${ argDecl })${ inContextDirective } {
+            page(${ argUse }) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.page',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontPageGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontPageGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "pageIdentifier": { "handle": "example" }
+  }'
+*/

package/api/shopify/shopifyStorefrontPagesGet.js

@@ -0,0 +1,66 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/pages
+
+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 shopifyStorefrontPagesGetInner = async (
+  returnGetter,
+  credsPayload,
+  {
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'page',
+    {
+      attrs,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyStorefrontGetter(...getterArgs)
+    : shopifyStorefrontGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontPagesGet: (...args) => shopifyStorefrontPagesGetInner(false, ...args),
+  shopifyStorefrontPagesGetter: (...args) => shopifyStorefrontPagesGetInner(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontPagesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontPaymentSettingsGet.js

@@ -0,0 +1,79 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/paymentSettings
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  acceptedCardBrands
+  cardVaultUrl
+  countryCode
+  currencyCode
+  enabledPresentmentCurrencies
+  shopifyPaymentsAccountId
+  supportedDigitalWallets
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontPaymentSettingsGet = 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 StorefrontPaymentSettings${ inContextDirective } {
+            paymentSettings {
+              ${ attrs }
+            }
+          }
+        `,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.paymentSettings',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontPaymentSettingsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontPaymentSettingsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+*/