@foxtware/mineral 0.1.9 → 0.1.10

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" }
+  }'
+*/

package/api/starshipit/starshipitGet.js

@@ -0,0 +1,146 @@
+const { credsFromPayload, ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+const { MAX_PER_PAGE } = require('../starshipit/starshipit.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const starshipitGetPacket = async (
+  creds,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+  } = {},
+) => {
+  return starshipitClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        page_size: perPage,
+        page_number: 1,
+        ...params,
+      },
+    },
+    context: {
+      creds,
+    },
+  });
+};
+
+const starshipitGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const {
+    page_number: currentPage,
+    page_size: pageSize,
+    total_records: totalCount,
+  } = response.data || {};
+
+  if (!currentPage || !pageSize || !totalCount) {
+    return [true];
+  }
+
+  const done = currentPage * pageSize >= totalCount;
+  if (done) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...options.params,
+        page_number: currentPage + 1,
+      },
+    },
+  }];
+};
+
+const starshipitGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    nodeName = 'results',
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const getter = new Getter(
+    {
+      args: [creds, url],
+      options: {
+        params,
+        perPage,
+      },
+    },
+    {
+      func: starshipitGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return response?.data?.[nodeName] ?? [];
+      },
+      paginator: starshipitGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitGet: (...args) => starshipitGet(false, ...args),
+  starshipitGetter: (...args) => starshipitGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "url": "/products",
+    "options": {
+      "nodeName": "products",
+      "limit": 10
+    }
+  }'
+*/

package/api/starshipit/starshipitOrderDelete.js

@@ -0,0 +1,102 @@
+// https://api-docs.starshipit.com/#c96bed4f-3a89-4e97-abaa-b1775cc7c5a7
+
+const { objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+const { starshipitOrderGet } = require('../starshipit/starshipitOrderGet');
+
+const orderIdentifierValidator = (orderIdentifier) => {
+  return objHasAny(orderIdentifier, [
+    'orderId',
+    'orderNumber',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderIdentifier', orderIdentifierValidator],
+]);
+
+const resolveOrderId = async (credsPayload, orderIdentifier) => {
+  const { orderId, orderNumber } = orderIdentifier;
+
+  if (orderId) {
+    return {
+      ok: true,
+      data: orderId,
+    };
+  }
+
+  const orderResponse = await starshipitOrderGet(credsPayload, { orderNumber });
+
+  if (!orderResponse?.ok) {
+    return orderResponse;
+  }
+
+  const resolvedOrderId = orderResponse?.data?.order_id;
+
+  if (!resolvedOrderId) {
+    return {
+      ok: false,
+      error: {
+        code: 'ORDER_NOT_FOUND',
+        message: 'No order ID found',
+      },
+    };
+  }
+
+  return {
+    ok: true,
+    data: resolvedOrderId,
+  };
+};
+
+const starshipitOrderDelete = async (
+  credsPayload,
+  orderIdentifier,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const orderIdResponse = await resolveOrderId(credsPayload, orderIdentifier);
+  if (!orderIdResponse?.ok) {
+    return orderIdResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders/delete',
+      method: 'delete',
+      params: {
+        order_id: orderIdResponse.data,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrderDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrderDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "orderIdentifier": { "orderId": "408418809" }
+  }'
+*/

package/api/starshipit/starshipitOrderGet.js

@@ -0,0 +1,74 @@
+const { objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const orderIdentifierValidator = (orderIdentifier) => {
+  return objHasAny(orderIdentifier, [
+    'orderId',
+    'orderNumber',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderIdentifier', orderIdentifierValidator],
+]);
+
+const starshipitOrderGet = async (
+  credsPayload,
+  orderIdentifier,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    orderId,
+    orderNumber,
+  } = orderIdentifier;
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders',
+      params: {
+        ...orderId && { order_id: orderId },
+        ...orderNumber && { order_number: orderNumber },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  return {
+    ...response,
+    data: response.data?.order ?? response.data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrderGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrderGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "orderIdentifier": { "orderId": 408418809 }
+  }'
+*/