@foxtware/mineral 0.1.8 → 0.1.10

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/shopifyTagsAdd.js

@@ -7,7 +7,7 @@ const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['gid'],
-  ['tags', Array],
+  ['tags', Array.isArray],
 ]);
 
 const defaultAttrs = 'id';

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/shopify/shopifyTagsRemove.js

@@ -7,7 +7,7 @@ const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['gid'],
-  ['tags', Array],
+  ['tags', Array.isArray],
 ]);
 
 const defaultAttrs = 'id';

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 = {

package/api/slack/slackMessagePost.js

@@ -1,6 +1,6 @@
 // https://docs.slack.dev/reference/methods/chat.postmessage
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { slackClient } = require('../slack/slack.utils');
 
@@ -36,8 +36,6 @@ const slackMessagePost = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     channelName,
     channelId,
@@ -50,15 +48,17 @@ const slackMessagePost = async (
   } = messagePayload;
 
   const response = await slackClient.fetch({
-    url: '/chat.postMessage',
-    method: 'post',
-    body: {
-      channel: channelId || channelName,
-      ...text && { text },
-      ...blocks && { blocks },
-      ...markdownText && { markdown_text: markdownText },
+    requestPayload: {
+      url: '/chat.postMessage',
+      method: 'post',
+      body: {
+        channel: channelId || channelName,
+        ...text && { text },
+        ...blocks && { blocks },
+        ...markdownText && { markdown_text: markdownText },
+      },
     },
-    context: { creds },
+    context: { credsPayload },
     inspect,
   });
 

package/api/starshipit/starshipit.constants.js

@@ -0,0 +1,8 @@
+const BASE_URL = 'https://api.starshipit.com/api';
+
+const MAX_PER_PAGE = 2000;
+
+module.exports = {
+  BASE_URL,
+  MAX_PER_PAGE,
+};

package/api/starshipit/starshipit.utils.js

@@ -0,0 +1,71 @@
+const { BASE_URL } = require('../starshipit/starshipit.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const interpretStarshipitResponse = async (state) => {
+  const { response } = state;
+
+  const { success, results, errors } = response.data;
+
+  if (!success) {
+    const firstError = errors?.[0];
+
+    // TODO: Consider removing data if errors
+    return {
+      response: {
+        ...response,
+        ok: false,
+        error: {
+          message: firstError?.message,
+          details: errors,
+        },
+      },
+      breakChain: true,
+    };
+  }
+
+  return {
+    response: {
+      ...response,
+      data: results ?? response.data,
+    },
+  };
+};
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const {
+    API_KEY,
+    SUB_KEY,
+  } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'StarShipIT-Api-Key': API_KEY,
+        'Ocp-Apim-Subscription-Key': SUB_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const starshipitClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    interpretStarshipitResponse,
+  ],
+});
+
+module.exports = {
+  starshipitClient,
+};

package/api/starshipit/starshipitAddressCreate.js

@@ -0,0 +1,77 @@
+// https://api-docs.starshipit.com/#f577d747-7227-432f-bbc2-d9e2db08578f
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['addressPayload'],
+]);
+
+const starshipitAddressCreate = async (
+  credsPayload,
+  addressPayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    addressPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/addressbook',
+      method: 'post',
+      body: {
+        address: addressPayload,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  const { id, address } = response.data || {};
+
+  return {
+    ...response,
+    data: {
+      id,
+      ...address,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitAddressCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitAddressCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "addressPayload": {
+      "name": "John Doe",
+      "street": "123 Main St",
+      "suburb": "Wherever",
+      "city": "Sydney",
+      "state": "NSW",
+      "post_code": "2000",
+      "country": "Australia"
+    }
+  }'
+*/

package/api/starshipit/starshipitAddressDelete.js

@@ -0,0 +1,55 @@
+// https://api-docs.starshipit.com/#0cd0b1b0-7ba4-4da3-8c94-67cb4e020a6d
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['addressId'],
+]);
+
+const starshipitAddressDelete = async (
+  credsPayload,
+  addressId,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    addressId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/addressbook/delete',
+      method: 'post',
+      body: {
+        address_ids: [addressId],
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitAddressDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitAddressDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "addressId": "14824686"
+  }'
+*/

package/api/starshipit/starshipitAddressUpdate.js

@@ -0,0 +1,69 @@
+// https://api-docs.starshipit.com/#4ff9ae6f-fadb-4c50-9087-467c2e336f93
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['addressId'],
+  ['updatePayload'],
+]);
+
+const starshipitAddressUpdate = async (
+  credsPayload,
+  addressId,
+  updatePayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    addressId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/addressbook/update',
+      method: 'post',
+      body: {
+        id: addressId,
+        address: updatePayload,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  return {
+    ...response,
+    data: response.data?.address ?? response.data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitAddressUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitAddressUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "addressId": 14824685,
+    "updatePayload": { "name": "Batman" }
+  }'
+*/

package/api/starshipit/starshipitAddressesGet.js

@@ -0,0 +1,52 @@
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitGet } = require('../starshipit/starshipitGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const starshipitAddressesGet = async (
+  credsPayload,
+  {
+    page = 1,
+    perPage,
+    sort,
+    sortDirection,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitGet(credsPayload, '/addressbook/filtered', {
+    nodeName: 'addresses',
+    params: {
+      ...page && { page },
+      ...perPage && { page_size: perPage },
+      ...sort && { sort },
+      ...sortDirection && { sort_direction: sortDirection },
+    },
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitAddressesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitAddressesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" }
+  }'
+*/