@foxtware/mineral 1.0.5 → 1.0.7

package/api/shopify/shopifyStorefrontCustomerResetByUrl.js

@@ -0,0 +1,91 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerResetByUrl
+
+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],
+  ['resetUrl'],
+  ['password'],
+]);
+
+const shopifyStorefrontCustomerResetByUrl = async (
+  credsPayload,
+  resetUrl,
+  password,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    resetUrl,
+    password,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerResetByUrl',
+    {
+      mutationVariables: {
+        resetUrl: {
+          type: 'URL!',
+          value: resetUrl,
+        },
+        password: {
+          type: 'String!',
+          value: password,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerResetByUrl,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerResetByUrl" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "resetUrl": "https://example.com/account/reset/xxx/yyy",
+    "password": "NewSecurePass123"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerUpdate.js

@@ -0,0 +1,93 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerUpdate
+
+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],
+  ['customerAccessToken'],
+  ['customer'],
+]);
+
+const shopifyStorefrontCustomerUpdate = async (
+  credsPayload,
+  customerAccessToken,
+  customer,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+    returnAccessTokenAttrs = defaultReturnAccessTokenAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+    customer,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerUpdate',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+        customer: {
+          type: 'CustomerUpdateInput!',
+          value: customer,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx",
+    "customer": {
+      "firstName": "Jane"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontGet.js

@@ -0,0 +1,233 @@
+const { Getter, capitaliseString, ArgsWarden, getWithLocalCachedFile } = require('../utils');
+const { credsValidator } = require('../validators');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+const { MAX_PER_PAGE } = require('./shopify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['resource'],
+]);
+
+const shopifyStorefrontGetPacket = async (
+  credsPayload,
+  resource,
+  resources,
+  attrs,
+  {
+    apiVersion,
+    perPage = MAX_PER_PAGE,
+    cursor,
+    queries,
+    reverse,
+    sortKey,
+    type,
+    inContext,
+    sortKeyType,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const Resource = capitaliseString(resource);
+  const Resources = capitaliseString(resources);
+  const resolvedSortKeyType = sortKeyType || `${ Resource }SortKeys`;
+
+  const queryTypeDeclaration = [
+    '$first: Int!',
+    '$cursor: String',
+    ...queries ? ['$query: String'] : [],
+    ...reverse !== undefined ? ['$reverse: Boolean'] : [],
+    ...sortKey ? [`$sortKey: ${ resolvedSortKeyType }`] : [],
+    ...type ? ['$type: String!'] : [],
+  ].join('\n');
+
+  const queryVariableDeclaration = [
+    'first: $first',
+    'after: $cursor',
+    ...queries ? ['query: $query'] : [],
+    ...reverse !== undefined ? ['reverse: $reverse'] : [],
+    ...sortKey ? ['sortKey: $sortKey'] : [],
+    ...type ? ['type: $type'] : [],
+  ].join('\n');
+
+  const variables = {
+    first: perPage,
+    cursor,
+    ...reverse !== undefined && { reverse },
+    ...queries && { query: queries.join(' AND ') },
+    ...sortKey && { sortKey },
+    ...type && { type },
+  };
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontGet${ Resources } (
+            ${ queryTypeDeclaration }
+          )${ inContextDirective } {
+            ${ resources }(
+              ${ queryVariableDeclaration }
+            ) {
+              edges {
+                node {
+                  ${ attrs }
+                }
+              }
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+            }
+          }
+        `,
+        variables,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: `data.${ resources }`,
+    },
+  });
+};
+
+const shopifyStorefrontGetPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+  const { ok, meta } = response;
+  const { pageInfo } = meta || {};
+  const { hasNextPage, endCursor } = pageInfo || {};
+
+  if (!ok) {
+    return [true];
+  }
+
+  if (!hasNextPage) {
+    return [true];
+  }
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      cursor: endCursor,
+    },
+  }];
+};
+
+const shopifyStorefrontGetDigester = (response) => {
+  const { ok, data } = response;
+
+  if (!ok) {
+    return null;
+  }
+
+  return data;
+};
+
+const shopifyStorefrontGet = async (
+  returnGetter,
+
+  credsPayload,
+  resource,
+  {
+    apiVersion,
+    perPage = MAX_PER_PAGE,
+    cursor,
+    attrs = 'id',
+    queries,
+    reverse,
+    sortKey,
+    type,
+    inContext,
+    sortKeyType,
+    resources = `${ resource }s`,
+    useLocalCachedFile,
+    fetchClient = shopifyStorefrontClient,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    resource,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [
+        credsPayload,
+        resource,
+        resources,
+        attrs,
+      ],
+      options: {
+        apiVersion,
+        perPage,
+        cursor,
+        queries,
+        reverse,
+        sortKey,
+        type,
+        inContext,
+        sortKeyType,
+        fetchClient,
+      },
+    },
+    {
+      func: shopifyStorefrontGetPacket,
+      digester: shopifyStorefrontGetDigester,
+      paginator: shopifyStorefrontGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  return getWithLocalCachedFile(
+    useLocalCachedFile,
+    async () => {
+      const data = await getter.run({ returnAll: true });
+
+      return {
+        ok: true,
+        data,
+      };
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontGet: (...args) => shopifyStorefrontGet(false, ...args),
+  shopifyStorefrontGetter: (...args) => shopifyStorefrontGet(true, ...args),
+  shopifyStorefrontGetPaginator,
+  shopifyStorefrontGetDigester,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "resource": "product",
+    "options": {
+      "limit": 5,
+      "attrs": "id handle title"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontLocalizationGet.js

@@ -0,0 +1,98 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/localization
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  availableCountries {
+    isoCode
+    name
+    currency { isoCode symbol }
+  }
+  availableLanguages {
+    isoCode
+    name
+    endonymName
+  }
+  country {
+    isoCode
+    name
+    currency { isoCode symbol }
+  }
+  language {
+    isoCode
+    name
+  }
+  market {
+    id
+    handle
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontLocalizationGet = 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 StorefrontLocalization${ inContextDirective } {
+            localization {
+              ${ attrs }
+            }
+          }
+        `,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.localization',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontLocalizationGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontLocalizationGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "inContext": { "country": "AU", "language": "EN" }
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontLocationsGet.js

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

package/api/shopify/shopifyStorefrontMenuGet.js

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