@foxtware/mineral 1.0.4 → 1.0.7

package/api/shopify/shopifyStorefrontCollectionGet.js

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

package/api/shopify/shopifyStorefrontCollectionsGet.js

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

package/api/shopify/shopifyStorefrontCustomerAccessTokenCreate.js

@@ -0,0 +1,75 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnAccessTokenAttrs = `
+accessToken
+  expiresAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['input'],
+]);
+
+const shopifyStorefrontCustomerAccessTokenCreate = async (
+  credsPayload,
+  input,
+  {
+    apiVersion,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAccessTokenCreate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CustomerAccessTokenCreateInput!',
+          value: input,
+        },
+      },
+      returnSchema: `
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAccessTokenCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAccessTokenCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "input": {
+      "email": "buyer@example.com",
+      "password": "SecurePass123"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerAccessTokenCreateWithMultipass.js

@@ -0,0 +1,72 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreateWithMultipass
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnAccessTokenAttrs = `
+accessToken
+  expiresAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['multipassToken'],
+]);
+
+const shopifyStorefrontCustomerAccessTokenCreateWithMultipass = async (
+  credsPayload,
+  multipassToken,
+  {
+    apiVersion,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    multipassToken,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAccessTokenCreateWithMultipass',
+    {
+      mutationVariables: {
+        multipassToken: {
+          type: 'String!',
+          value: multipassToken,
+        },
+      },
+      returnSchema: `
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAccessTokenCreateWithMultipass,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAccessTokenCreateWithMultipass" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "multipassToken": "multipass-token-here"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerAccessTokenDelete.js

@@ -0,0 +1,67 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+]);
+
+const shopifyStorefrontCustomerAccessTokenDelete = async (
+  credsPayload,
+  customerAccessToken,
+  {
+    apiVersion,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAccessTokenDelete',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+      },
+      returnSchema: `
+        deletedAccessToken
+        deletedCustomerAccessTokenId
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAccessTokenDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAccessTokenDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerAccessTokenRenew.js

@@ -0,0 +1,72 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenRenew
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnAccessTokenAttrs = `
+accessToken
+  expiresAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+]);
+
+const shopifyStorefrontCustomerAccessTokenRenew = async (
+  credsPayload,
+  customerAccessToken,
+  {
+    apiVersion,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAccessTokenRenew',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+      },
+      returnSchema: `
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAccessTokenRenew,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAccessTokenRenew" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerActivate.js

@@ -0,0 +1,98 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerActivate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCustomerAttrs = `
+id
+  email
+  firstName
+  lastName
+  displayName
+  phone
+`.trim();
+
+const defaultReturnAccessTokenAttrs = `
+accessToken
+  expiresAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerId'],
+  ['input'],
+]);
+
+const shopifyStorefrontCustomerActivate = async (
+  credsPayload,
+  customerId,
+  input,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerId,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const id = customerId.toString().startsWith('gid://')
+    ? customerId
+    : `gid://shopify/Customer/${ customerId }`;
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerActivate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: id,
+        },
+        input: {
+          type: 'CustomerActivateInput!',
+          value: input,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerActivate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerActivate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerId": "1234567890",
+    "input": {
+      "activationToken": "token",
+      "password": "SecurePass123"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerActivateByUrl.js

@@ -0,0 +1,91 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerActivateByUrl
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCustomerAttrs = `
+id
+  email
+  firstName
+  lastName
+  displayName
+  phone
+`.trim();
+
+const defaultReturnAccessTokenAttrs = `
+accessToken
+  expiresAt
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['activationUrl'],
+  ['password'],
+]);
+
+const shopifyStorefrontCustomerActivateByUrl = async (
+  credsPayload,
+  activationUrl,
+  password,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    activationUrl,
+    password,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerActivateByUrl',
+    {
+      mutationVariables: {
+        activationUrl: {
+          type: 'URL!',
+          value: activationUrl,
+        },
+        password: {
+          type: 'String!',
+          value: password,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerActivateByUrl,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerActivateByUrl" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "activationUrl": "https://example.com/account/activate/xxx/yyy",
+    "password": "SecurePass123"
+  }'
+*/