@foxtware/mineral 1.0.5 → 1.0.7

package/api/shopify/shopifyStorefrontCustomerAddressCreate.js

@@ -0,0 +1,94 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAddressCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnAddressAttrs = `
+id
+  address1
+  address2
+  city
+  company
+  country
+  firstName
+  lastName
+  phone
+  province
+  zip
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+  ['address'],
+]);
+
+const shopifyStorefrontCustomerAddressCreate = async (
+  credsPayload,
+  customerAccessToken,
+  address,
+  {
+    apiVersion,
+    returnAddressAttrs = defaultReturnAddressAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+    address,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAddressCreate',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+        address: {
+          type: 'MailingAddressInput!',
+          value: address,
+        },
+      },
+      returnSchema: `
+        customerAddress { ${ returnAddressAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAddressCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAddressCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx",
+    "address": {
+      "address1": "1 Main St",
+      "city": "Sydney",
+      "country": "Australia",
+      "zip": "2000"
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerAddressDelete.js

@@ -0,0 +1,78 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAddressDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+  ['addressId'],
+]);
+
+const shopifyStorefrontCustomerAddressDelete = async (
+  credsPayload,
+  customerAccessToken,
+  addressId,
+  {
+    apiVersion,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+    addressId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const id = addressId.toString().startsWith('gid://')
+    ? addressId
+    : `gid://shopify/MailingAddress/${ addressId }?model_name=CustomerAddress`;
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAddressDelete',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+        id: {
+          type: 'ID!',
+          value: id,
+        },
+      },
+      returnSchema: `
+        deletedCustomerAddressId
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAddressDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAddressDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx",
+    "addressId": "gid://shopify/MailingAddress/123?model_name=CustomerAddress"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerAddressUpdate.js

@@ -0,0 +1,101 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerAddressUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnAddressAttrs = `
+id
+  address1
+  address2
+  city
+  company
+  country
+  firstName
+  lastName
+  phone
+  province
+  zip
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+  ['addressId'],
+  ['address'],
+]);
+
+const shopifyStorefrontCustomerAddressUpdate = async (
+  credsPayload,
+  customerAccessToken,
+  addressId,
+  address,
+  {
+    apiVersion,
+    returnAddressAttrs = defaultReturnAddressAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+    addressId,
+    address,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const id = addressId.toString().startsWith('gid://')
+    ? addressId
+    : `gid://shopify/MailingAddress/${ addressId }?model_name=CustomerAddress`;
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerAddressUpdate',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+        id: {
+          type: 'ID!',
+          value: id,
+        },
+        address: {
+          type: 'MailingAddressInput!',
+          value: address,
+        },
+      },
+      returnSchema: `
+        customerAddress { ${ returnAddressAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerAddressUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerAddressUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx",
+    "addressId": "gid://shopify/MailingAddress/123?model_name=CustomerAddress",
+    "address": { "city": "Melbourne" }
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerCreate.js

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

package/api/shopify/shopifyStorefrontCustomerDefaultAddressUpdate.js

@@ -0,0 +1,89 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerDefaultAddressUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnCustomerAttrs = `
+id
+  email
+  firstName
+  lastName
+  displayName
+  phone
+  defaultAddress { id address1 city }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+  ['addressId'],
+]);
+
+const shopifyStorefrontCustomerDefaultAddressUpdate = async (
+  credsPayload,
+  customerAccessToken,
+  addressId,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+    addressId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const id = addressId.toString().startsWith('gid://')
+    ? addressId
+    : `gid://shopify/MailingAddress/${ addressId }?model_name=CustomerAddress`;
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'customerDefaultAddressUpdate',
+    {
+      mutationVariables: {
+        customerAccessToken: {
+          type: 'String!',
+          value: customerAccessToken,
+        },
+        addressId: {
+          type: 'ID!',
+          value: id,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerDefaultAddressUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerDefaultAddressUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx",
+    "addressId": "gid://shopify/MailingAddress/123?model_name=CustomerAddress"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerGet.js

@@ -0,0 +1,92 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/customer
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  firstName
+  lastName
+  displayName
+  email
+  phone
+  acceptsMarketing
+  createdAt
+  updatedAt
+  defaultAddress {
+    id
+    address1
+    city
+    country
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerAccessToken'],
+]);
+
+const shopifyStorefrontCustomerGet = async (
+  credsPayload,
+  customerAccessToken,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerAccessToken,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontCustomer ($customerAccessToken: String!)${ inContextDirective } {
+            customer(customerAccessToken: $customerAccessToken) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: { customerAccessToken },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.customer',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerAccessToken": "shcat_xxx"
+  }'
+*/

package/api/shopify/shopifyStorefrontCustomerRecover.js

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

package/api/shopify/shopifyStorefrontCustomerReset.js

@@ -0,0 +1,98 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/customerReset
+
+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 shopifyStorefrontCustomerReset = 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,
+    'customerReset',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: id,
+        },
+        input: {
+          type: 'CustomerResetInput!',
+          value: input,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+        customerAccessToken { ${ returnAccessTokenAttrs } }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontCustomerReset,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontCustomerReset" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerId": "1234567890",
+    "input": {
+      "resetToken": "token",
+      "password": "NewSecurePass123"
+    }
+  }'
+*/