@foxtware/mineral 0.1.0

package/api/shopify/shopifyCustomerGet.js

@@ -0,0 +1,112 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/customer
+
+const { credsValidator } = require('../validators');
+const { objHasAny, credsFromPayload, ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+const { shopifyClient } = require('../shopify/shopify.utils');
+
+const defaultAttrs = 'id email';
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId', 
+    'customId', 
+    'email', 
+    'phone',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+]);
+
+const shopifyCustomerGet = async (
+  credsPayload,
+  customerIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, customerIdentifier });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    customerId,
+    customId,
+    email,
+    phone,
+  } = customerIdentifier;
+
+  if (!customerId) {
+
+    const creds = await credsFromPayload(credsPayload);
+
+    const query = `
+      query GetCustomerByIdentifier ($identifier: CustomerIdentifierInput!) {
+        customer: customerByIdentifier(identifier: $identifier) {
+          ${ attrs }
+        } 
+      }
+    `;
+
+    const variables = {
+      identifier: {
+        ...customId && { customId },
+        ...email && { emailAddress: email },
+        ...phone && { phoneNumber: phone },
+      },
+    };
+
+    const response = await shopifyClient.fetch({
+      method: 'post',
+      body: { query, variables },
+      context: {
+        creds,
+        apiVersion,
+        resultPath: 'data.customer',
+      },
+    });
+
+    return response;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'customer',
+    customerId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomerGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomerGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerIdentifier": { "customerId": "8575963103304" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyCustomerGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerIdentifier": { "email": "john+testing@whitefoxboutique.com" }
+  }'
+*/

package/api/shopify/shopifyCustomerMarketingConsentUpdateEmail.js

@@ -0,0 +1,84 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/customeremailmarketingconsentupdate
+
+const { credsValidator } = require('../validators');
+const { objHasAny, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const consentPayloadValidator = (consentPayload) => {
+  return objHasAny(consentPayload, [
+    'consentUpdatedAt',
+    'marketingOptInLevel',
+    'marketingState',
+    'sourceLocationId',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerId'],
+  ['consentPayload', consentPayloadValidator],
+]);
+
+const defaultReturnCustomerAttrs = 'email emailMarketingConsent { marketingState consentUpdatedAt marketingOptInLevel }';
+
+const shopifyCustomerMarketingConsentUpdateEmail = async (
+  credsPayload,
+  customerId,
+  consentPayload,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerId,
+    consentPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'customerEmailMarketingConsentUpdate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CustomerEmailMarketingConsentUpdateInput!',
+          value: {
+            customerId: `gid://shopify/Customer/${ customerId }`,
+            emailMarketingConsent: consentPayload,
+          },
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomerMarketingConsentUpdateEmail,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomerMarketingConsentUpdateEmail" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerId": "8575963103304",
+    "consentPayload": {
+      "marketingState": "UNSUBSCRIBED",
+      "marketingOptInLevel": "SINGLE_OPT_IN"
+    }
+  }'
+*/

package/api/shopify/shopifyCustomerUpdate.js

@@ -0,0 +1,75 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerId', Boolean],
+  ['updatePayload', Boolean],
+]);
+
+const defaultReturnCustomerAttrs = 'id email firstName lastName phone';
+
+const shopifyCustomerUpdate = async (
+  credsPayload,
+  customerId,
+  updatePayload,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'customerUpdate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CustomerInput!',
+          value: {
+            id: `gid://shopify/Customer/${ customerId }`,
+            ...updatePayload,
+          },
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomerUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomerUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerId": "8575963103304",
+    "updatePayload": {
+      "firstName": "Winston",
+      "lastName": "Churchill"
+    }
+  }'
+*/

package/api/shopify/shopifyCustomersGet.js

@@ -0,0 +1,50 @@
+const { credsFromPayload, Getter, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyCustomersGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'customer', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomersGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyCustomersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyGet.js

@@ -0,0 +1,309 @@
+const { credsFromPayload, Getter, capitaliseString, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyClient } = require('./shopify.utils');
+const { MAX_PER_PAGE } = require('./shopify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['resource'],
+]);
+
+const shopifyGetPacket = async (
+  // options on the main function can become args on the packet get if they have defaults
+  // TODO: Consider where defaults should lie
+  creds,
+  resource,
+  resources,
+  attrs,
+  {
+    apiVersion,
+
+    perPage = MAX_PER_PAGE,
+    cursor,
+    queries,
+    reverse,
+    savedSearchId,
+    sortKey,
+    roles,
+    names,
+    constraintStatus,
+    constraintSubtype,
+    namespace,
+    ownerType,
+    pinnedStatus,
+    ownerGid,
+    includeClosed,
+    includeLegacy,
+    type,
+    sku,
+    argumentTypeOverrides = {},
+  } = {},
+) => {
+
+  // Forgive me, this is a capital for legibility
+  const Resource = capitaliseString(resource);
+  const Resources = capitaliseString(resources);
+
+  const queryTypeDeclaration = [
+    '$first: Int!',
+    '$cursor: String',
+    ...queries ? ['$query: String,'] : [],
+    ...reverse !== undefined ? ['$reverse: Boolean,'] : [],
+    ...savedSearchId ? ['$savedSearchId: ID,'] : [],
+    ...sortKey ? [`$sortKey: ${ Resource }SortKeys,`] : [],
+    ...roles ? [`$roles: [${ Resource }Role!],`] : [],
+    ...names ? ['$names: [String!],'] : [],
+    ...constraintStatus ? ['$constraintStatus: MetafieldDefinitionConstraintStatus,'] : [],
+    ...constraintSubtype ? ['$constraintSubtype: MetafieldDefinitionConstraintSubtypeIdentifier,'] : [],
+    ...namespace ? ['$namespace: String,'] : [],
+    ...ownerType ? ['$ownerType: MetafieldOwnerType!,'] : [],
+    ...pinnedStatus ? ['$pinnedStatus: MetafieldDefinitionPinnedStatus,'] : [],
+    ...ownerGid ? ['$owner: ID!,'] : [],
+    ...includeClosed ? ['$includeClosed: Boolean,'] : [],
+    ...includeLegacy ? ['$includeLegacy: Boolean,'] : [],
+    ...type ? [`$type: ${ argumentTypeOverrides['type'] || 'String!' },`] : [],
+    ...sku ? ['$sku: String,'] : [],
+  ].join('\n');
+
+  const queryVariableDeclaration = [
+    'first: $first',
+    'after: $cursor',
+    ...queries ? ['query: $query'] : [],
+    ...reverse !== undefined ? ['reverse: $reverse'] : [],
+    ...savedSearchId ? ['savedSearchId: $savedSearchId'] : [],
+    ...sortKey ? ['sortKey: $sortKey'] : [],
+    ...roles ? ['roles: $roles'] : [],
+    ...names ? ['names: $names'] : [],
+    ...constraintStatus ? ['constraintStatus: $constraintStatus'] : [],
+    ...constraintSubtype ? ['constraintSubtype: $constraintSubtype'] : [],
+    ...namespace ? ['namespace: $namespace'] : [],
+    ...ownerType ? ['ownerType: $ownerType'] : [],
+    ...pinnedStatus ? ['pinnedStatus: $pinnedStatus'] : [],
+    ...ownerGid ? ['owner: $owner'] : [],
+    ...includeClosed ? ['includeClosed: $includeClosed'] : [],
+    ...includeLegacy ? ['includeLegacy: $includeLegacy'] : [],
+    ...type ? ['type: $type'] : [],
+    ...sku ? ['sku: $sku'] : [],
+  ].join('\n');
+
+  const variables = {
+    first: perPage,
+    cursor,
+    ...reverse !== undefined && { reverse },
+    ...queries && { query: queries.join(' AND ') },
+    ...savedSearchId && { savedSearchId: `gid://shopify/SavedSearch/${ savedSearchId }` },
+    ...sortKey && { sortKey },
+    ...roles && { roles },
+    ...names && { names },
+    ...constraintStatus && { constraintStatus },
+    ...constraintSubtype && { constraintSubtype },
+    ...namespace && { namespace },
+    ...ownerType && { ownerType },
+    ...pinnedStatus && { pinnedStatus },
+    ...ownerGid && { owner: ownerGid },
+    ...includeClosed && { includeClosed },
+    ...includeLegacy && { includeLegacy },
+    ...type && { type },
+    ...sku && { sku },
+  };
+
+  return await shopifyClient.fetch({
+    method: 'post',
+    body: {
+      query: `
+        query Get${ Resources } (
+          ${ queryTypeDeclaration }
+        ) {
+          ${ resources }(
+            ${ queryVariableDeclaration }
+          ) {
+            edges {
+              node {
+                ${ attrs }
+              }
+            }
+            pageInfo {
+              hasNextPage
+              endCursor
+            }
+          }
+        }
+      `,
+      variables,
+    },
+    context: {
+      creds,
+      apiVersion,
+      resultPath: `data.${ resources }`,
+    },
+  });
+};
+
+const shopifyGetPaginator = async (currentParams, response) => {
+
+  const { args, options } = currentParams;
+  
+  // Extract pagination info
+  const { ok, meta } = response;
+  const { pageInfo } = meta || {};
+  const { hasNextPage, endCursor } = pageInfo || {};
+
+  if (!ok) {
+    return [true];
+  }
+  
+  // Check if done
+  if (!hasNextPage) {
+    return [true];
+  }
+  
+  // Supplement params with pagination info
+  const paginatedParams = {
+    args,
+    options: { 
+      ...options,
+      cursor: endCursor,
+    },
+  };
+
+  return [false, paginatedParams];
+};
+
+const shopifyGetDigester = (response) => {
+  const { ok, data } = response;
+
+  if (!ok) {
+    return null; // TODO: Consider a way to break out as this is an error
+  }
+
+  return data;
+};
+
+const shopifyGet = async (
+  returnGetter, // Always bound
+
+  credsPayload,
+  resource,
+  {
+    apiVersion,
+
+    // Related to the actual query
+    perPage = 250,
+    cursor,
+    attrs = 'id',
+    queries,
+    reverse,
+    savedSearchId,
+    sortKey,
+    // https://shopify.dev/docs/api/admin-graphql/latest/queries/themes#arguments-names
+    roles,
+    names,
+    // https://shopify.dev/docs/api/admin-graphql/unstable/queries/metafielddefinitions
+    constraintStatus,
+    constraintSubtype,
+    namespace,
+    ownerType,
+    pinnedStatus,
+    // https://shopify.dev/docs/api/admin-graphql/unstable/queries/metafields#arguments-owner
+    ownerGid,
+    // https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentOrder#queries
+    includeClosed,
+    // https://shopify.dev/docs/api/admin-graphql/latest/queries/locations#arguments-includeLegacy
+    includeLegacy,
+    // https://shopify.dev/docs/api/admin-graphql/latest/queries/metaobjects
+    type,
+    // https://shopify.dev/docs/api/admin-graphql/latest/queries/inventoryItems
+    sku,
+    
+    // Helpers
+    resources = `${ resource }s`, // for when plural of the resource isn't `${ resource }s`
+    argumentTypeOverrides = {}, // for when a commonly-named API option is not just a single type, e.g. type being String vs CatalogType
+
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+    resource,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const getter = new Getter(
+    {
+      args: [
+        creds, 
+        resource, 
+        resources, 
+        attrs,
+      ],
+      options: {
+        apiVersion,
+        perPage,
+        cursor,
+        queries,
+        reverse,
+        savedSearchId,
+        sortKey,
+        roles,
+        names,
+        constraintStatus,
+        constraintSubtype,
+        namespace,
+        ownerType,
+        pinnedStatus,
+        ownerGid,
+        includeClosed,
+        includeLegacy,
+        type,
+        sku,
+        argumentTypeOverrides,
+      },
+    },
+    {
+      func: shopifyGetPacket,
+      digester: shopifyGetDigester,
+      paginator: shopifyGetPaginator,
+      ...getterOptions,
+    },
+  );
+  
+  if (returnGetter) {
+    return getter;
+  }
+
+  return await getter.run({ returnAll: true });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyGet: (...args) => shopifyGet(false, ...args),
+  shopifyGetter: (...args) => shopifyGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "resource": "customer"
+  }'
+
+curl -X POST "http://localhost:8000/shopifyGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "resource": "customer",
+    "options": {
+      "limit": 10
+    }
+  }'
+*/