@foxtware/mineral 0.1.9 → 0.1.10

package/api/shopify/shopifyBulkOperationRunMutation.js

@@ -0,0 +1,83 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkOperationRunMutation
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('./shopifyMutationDo');
+
+const defaultReturnAttrs = `
+  id
+  type
+  status
+  objectCount
+  url
+`;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['mutation'],
+  ['stagedUploadPath'],
+]);
+
+const shopifyBulkOperationRunMutation = async (
+  credsPayload,
+  mutation,
+  stagedUploadPath,
+  {
+    apiVersion,
+    returnAttrs = defaultReturnAttrs,
+    clientIdentifier,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    mutation,
+    stagedUploadPath,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'bulkOperationRunMutation',
+    {
+      mutationVariables: {
+        mutation: {
+          type: 'String!',
+          value: mutation,
+        },
+        stagedUploadPath: {
+          type: 'String!',
+          value: stagedUploadPath,
+        },
+        ...clientIdentifier && {
+          clientIdentifier: {
+            type: 'String',
+            value: clientIdentifier,
+          },
+        },
+      },
+      returnSchema: `bulkOperation { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkOperationRunMutation,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkOperationRunMutation" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "arg": "1234"
+  }'
+*/

package/api/shopify/shopifyCheckoutAndAccountsConfigurationUpdate.js

@@ -0,0 +1,79 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/checkoutAndAccountsConfigurationUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['configurationId'],
+  ['updatePayload'],
+]);
+
+const defaultReturnConfigurationAttrs = 'id name isPublished updatedAt';
+
+const shopifyCheckoutAndAccountsConfigurationUpdate = async (
+  credsPayload,
+  configurationId,
+  updatePayload,
+  {
+    apiVersion,
+    returnConfigurationAttrs = defaultReturnConfigurationAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    configurationId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'checkoutAndAccountsConfigurationUpdate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/CheckoutAndAccountsConfiguration/${ configurationId }`,
+        },
+        configuration: {
+          type: 'CheckoutAndAccountsConfigurationInput!',
+          value: updatePayload,
+        },
+      },
+      returnSchema: `configuration { ${ returnConfigurationAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCheckoutAndAccountsConfigurationUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCheckoutAndAccountsConfigurationUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "configurationId": "123456789",
+    "updatePayload": {
+      "branding": {
+        "designTokens": {
+          "cornerRadius": {
+            "large": "LARGE"
+          }
+        }
+      }
+    }
+  }'
+*/

package/api/shopify/shopifyCollectionGet.js

@@ -1,7 +1,7 @@
 // https://shopify.dev/docs/api/admin-graphql/latest/queries/collection
 
 const { credsValidator } = require('../validators');
-const { ArgsWarden, objHasAny, credsFromPayload } = require('../utils');
+const { ArgsWarden, objHasAny } = require('../utils');
 const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
 const { shopifyClient } = require('../shopify/shopify.utils');
 
@@ -42,8 +42,6 @@ const shopifyCollectionGet = async (
 
   if (!id) {
 
-    const creds = await credsFromPayload(credsPayload);
-
     const query = `
       query GetCollectionByIdentifier ($identifier: CollectionIdentifierInput!) {
         collection: collectionByIdentifier(identifier: $identifier) {
@@ -60,10 +58,12 @@ const shopifyCollectionGet = async (
     };
 
     const response = await shopifyClient.fetch({
-      method: 'post',
-      body: { query, variables },
+      requestPayload: {
+        method: 'post',
+        body: { query, variables },
+      },
       context: {
-        creds,
+        credsPayload,
         apiVersion,
         resultPath: 'data.collection',
       },

package/api/shopify/shopifyCustomerGet.js

@@ -1,7 +1,7 @@
 // https://shopify.dev/docs/api/admin-graphql/latest/queries/customer
 
 const { credsValidator } = require('../validators');
-const { objHasAny, credsFromPayload, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
 const { shopifyClient } = require('../shopify/shopify.utils');
 
@@ -44,8 +44,6 @@ const shopifyCustomerGet = async (
 
   if (!customerId) {
 
-    const creds = await credsFromPayload(credsPayload);
-
     const query = `
       query GetCustomerByIdentifier ($identifier: CustomerIdentifierInput!) {
         customer: customerByIdentifier(identifier: $identifier) {
@@ -63,10 +61,12 @@ const shopifyCustomerGet = async (
     };
 
     const response = await shopifyClient.fetch({
-      method: 'post',
-      body: { query, variables },
+      requestPayload: {
+        method: 'post',
+        body: { query, variables },
+      },
       context: {
-        creds,
+        credsPayload,
         apiVersion,
         resultPath: 'data.customer',
       },

package/api/shopify/shopifyGet.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, Getter, capitaliseString, ArgsWarden } = require('../utils');
+const { Getter, capitaliseString, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 const { MAX_PER_PAGE } = require('./shopify.constants');
@@ -11,7 +11,7 @@ const argsWarden = new ArgsWarden([
 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,
+  credsPayload,
   resource,
   resources,
   attrs,
@@ -108,9 +108,10 @@ const shopifyGetPacket = async (
   };
 
   return await shopifyClient.fetch({
-    method: 'post',
-    body: {
-      query: `
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
         query Get${ Resources } (
           ${ queryTypeDeclaration }
         ) {
@@ -129,10 +130,11 @@ const shopifyGetPacket = async (
           }
         }
       `,
-      variables,
+        variables,
+      },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ resources }`,
     },
@@ -231,14 +233,12 @@ const shopifyGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const getter = new Getter(
     {
       args: [
-        creds, 
-        resource, 
-        resources, 
+        credsPayload,
+        resource,
+        resources,
         attrs,
       ],
       options: {
@@ -276,7 +276,12 @@ const shopifyGet = async (
     return getter;
   }
 
-  return await getter.run({ returnAll: true });
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
 };
 
 const funcApiConfig = {

package/api/shopify/shopifyGetSingle.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, capitaliseString, ArgsWarden } = require('../utils');
+const { capitaliseString, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 
@@ -35,8 +35,6 @@ const shopifyGetSingle = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const Resource = capitaliseString(resource);
   const usesId = !resourcesNotRequiringId.includes(resource);
 
@@ -49,15 +47,17 @@ const shopifyGetSingle = async (
   `;
 
   const response = await shopifyClient.fetch({
-    method: 'post',
-    body: {
-      query,
-      variables: {
-        ...(usesId ? { id: `gid://shopify/${ gidType || Resource }/${ id }` } : {}),
+    requestPayload: {
+      method: 'post',
+      body: {
+        query,
+        variables: {
+          ...(usesId ? { id: `gid://shopify/${ gidType || Resource }/${ id }` } : {}),
+        },
       },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ resource }`,
     },

package/api/shopify/shopifyMutationDo.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, logDeep, ArgsWarden } = require('../utils');
+const { logDeep, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 
@@ -27,8 +27,6 @@ const shopifyMutationDo = async (
     returnSchema += ' userErrors { field message }';
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const mutation = `
     mutation ${ mutationName }(${ Object.entries(mutationVariables).map(([name, { type }]) => `$${ name }: ${ type }`).join(', ') }) {
       ${ mutationName }(${ Object.keys(mutationVariables).map(name => `${ name }: $${ name }`).join(', ') }) {
@@ -47,10 +45,12 @@ const shopifyMutationDo = async (
   }
 
   const response = await shopifyClient.fetch({
-    method: 'post',
-    body: { query: mutation, variables },
+    requestPayload: {
+      method: 'post',
+      body: { query: mutation, variables },
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ mutationName }`,
     },

package/api/shopify/shopifyOrdersGet.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, logDeep, ArgsWarden } = require('../utils');
+const { logDeep, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 
@@ -21,12 +21,11 @@ const shopifyOrdersGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await shopifyClient.fetch({
-    method: 'post',
-    body: {
-      query: `
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
         query OrdersGet(
           $first: Int!,
           $after: String,
@@ -49,14 +48,15 @@ const shopifyOrdersGet = async (
           }
         }
       `,
-      variables: {
-        first,
-        after,
-        query,
+        variables: {
+          first,
+          after,
+          query,
+        },
       },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: 'data.orders',
     },

package/api/shopify/shopifyStagedUploadCreate.js

@@ -0,0 +1,96 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/stagedUploadsCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, ensureArray, everyIfArray } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const defaultReturnAttrs = `
+  url
+  resourceUrl
+  parameters {
+    name
+    value
+  }
+`;
+
+const stagedUploadInputItemValidator = ({
+  resource,
+  filename,
+  mimeType,
+} = {}) => Boolean(resource && filename && mimeType);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['stagedUploadInput', (i) => everyIfArray(stagedUploadInputItemValidator, i)],
+]);
+
+const shopifyStagedUploadCreate = async (
+  credsPayload,
+  stagedUploadInput,
+  {
+    apiVersion,
+    returnAttrs = defaultReturnAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    stagedUploadInput,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const input = ensureArray(stagedUploadInput).map(({
+    resource,
+    filename,
+    mimeType,
+    fileSize,
+    httpMethod,
+  }) => ({
+    resource,
+    filename,
+    mimeType,
+    ...fileSize && { fileSize: String(fileSize) },
+    ...httpMethod && { httpMethod },
+  }));
+
+  return shopifyMutationDo(
+    credsPayload,
+    'stagedUploadsCreate',
+    {
+      mutationVariables: {
+        input: {
+          type: '[StagedUploadInput!]!',
+          value: input,
+        },
+      },
+      returnSchema: `stagedTargets { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStagedUploadCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStagedUploadCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "stagedUploadInput": {
+      "resource": "BULK_MUTATION_VARIABLES",
+      "filename": "inputs.jsonl",
+      "mimeType": "text/jsonl",
+      "httpMethod": "POST"
+    }
+  }'
+  }'
+*/

package/api/shopify/shopifyTagsAddBulk.js

@@ -0,0 +1,90 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsAdd
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyBulkMutationDo } = require('./shopifyBulkMutationDo');
+
+const tagsAddBulkMutation = `
+  mutation call($id: ID!, $tags: [String!]!) {
+    tagsAdd(id: $id, tags: $tags) {
+      node {
+        id
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+`.trim();
+
+const tagsAddBulkUserErrors = (bulkResult) => {
+  return bulkResult?.data?.tagsAdd?.userErrors
+    || bulkResult?.tagsAdd?.userErrors
+    || [];
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['gids', Array.isArray],
+  ['tags', Array.isArray],
+]);
+
+const shopifyTagsAddBulk = async (
+  credsPayload,
+  gids,
+  tags,
+  {
+    apiVersion,
+    clientIdentifier,
+    waitForResult = true,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    gids,
+    tags,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyBulkMutationDo(
+    credsPayload,
+    {
+      mutation: tagsAddBulkMutation,
+      input: {
+        data: gids.map((gid) => ({
+          id: gid,
+          tags,
+        })),
+      },
+    },
+    {
+      apiVersion,
+      clientIdentifier,
+      waitForResult,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyTagsAddBulk,
+  tagsAddBulkUserErrors,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyTagsAddBulk" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "gids": ["gid://shopify/Customer/123"],
+    "tags": ["aug26_migration"]
+  }'
+*/

package/api/slack/slack.utils.js

@@ -1,25 +1,20 @@
 const { SLACK_API_BASE_URL } = require('../slack/slack.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
-  appendUrlToBase,
   fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
-  const {
-    BOT_TOKEN,
-  } = creds;
+  const { BOT_TOKEN } = creds;
 
   return {
     requestPayload: {
       ...requestPayload,
       method: requestPayload.method || 'post',
-      url: appendUrlToBase(SLACK_API_BASE_URL, requestPayload.url),
       headers: {
-        'Content-Type': 'application/json',
         Authorization: `Bearer ${ BOT_TOKEN }`,
         ...requestPayload.headers,
       },
@@ -27,18 +22,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-
-const slackClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const slackClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const slackClient = new FetchClient({
-  requestPreparer: slackClientRequestPreparer,
-  responseInterpreter: slackClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(SLACK_API_BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {