@foxtware/mineral 0.1.9 → 0.1.11

package/api/github/githubReposGet.js

@@ -0,0 +1,69 @@
+// https://docs.github.com/en/rest/repos/repos#list-repositories-for-the-authenticated-user
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubGet } = require('../github/githubGet');
+const { MAX_PER_PAGE } = require('../github/github.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const githubReposGet = async (
+  credsPayload,
+  {
+    org,
+    type,
+    sort,
+    direction,
+    perPage,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const url = org ? `/orgs/${ org }/repos` : '/user/repos';
+
+  const params = {
+    ...type && { type },
+    ...sort && { sort },
+    ...direction && { direction },
+  };
+
+  return githubGet(credsPayload, url, {
+    params,
+    perPage: perPage ?? MAX_PER_PAGE,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubReposGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubReposGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" }
+  }'
+
+curl -X POST "http://localhost:8000/githubReposGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "options": {
+      "org": "GorgonFreeman",
+      "limit": 10
+    }
+  }'
+*/

package/api/github/githubUserGet.js

@@ -0,0 +1,64 @@
+// https://docs.github.com/en/rest/users/users#get-the-authenticated-user
+// https://docs.github.com/en/rest/users/users#get-a-user
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const githubUserGet = async (
+  credsPayload,
+  {
+    username,
+    params,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const url = username ? `/users/${ username }` : '/user';
+
+  return githubClient.fetch({
+    requestPayload: {
+      url,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubUserGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubUserGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" }
+  }'
+
+curl -X POST "http://localhost:8000/githubUserGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "options": {
+      "username": "GorgonFreeman"
+    }
+  }'
+*/

package/api/linear/linear.utils.js

@@ -1,11 +1,11 @@
 const { LINEAR_GRAPHQL_URL } = require('../linear/linear.constants');
+const { resolveCreds } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
   fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
   const { API_KEY } = creds;
@@ -16,7 +16,6 @@ const addUrlAndAuthHeaders = async (state) => {
       url: requestPayload.url || LINEAR_GRAPHQL_URL,
       method: requestPayload.method || 'post',
       headers: {
-        'Content-Type': 'application/json',
         Authorization: API_KEY,
         ...requestPayload.headers,
       },
@@ -24,18 +23,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const linearClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const linearClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-  fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
-]);
-
 const linearClient = new FetchClient({
-  requestPreparer: linearClientRequestPreparer,
-  responseInterpreter: linearClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
+  ],
 });
 
 module.exports = {

package/api/linear/linearIssuesGet.js

@@ -1,6 +1,6 @@
 // https://linear.app/developers/graphql
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { linearClient } = require('../linear/linear.utils');
 
@@ -24,15 +24,14 @@ const linearIssuesGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const filter = teamId
     ? { team: { id: { eq: teamId } } }
     : undefined;
 
   const response = await linearClient.fetch({
-    body: {
-      query: `
+    requestPayload: {
+      body: {
+        query: `
         query IssuesGet($first: Int!, $filter: IssueFilter) {
           issues(first: $first, filter: $filter) {
             nodes {
@@ -58,12 +57,13 @@ const linearIssuesGet = async (
           }
         }
       `,
-      variables: {
-        first,
-        ...(filter && { filter }),
+        variables: {
+          first,
+          ...(filter && { filter }),
+        },
       },
     },
-    context: { creds },
+    context: { credsPayload },
     inspect,
   });
 

package/api/logiwa/logiwa.utils.js

@@ -1,31 +1,37 @@
 const { DEFAULT_API_VERSION } = require('../logiwa/logiwa.constants');
 const { logiwaAuthGet } = require('../logiwa/logiwaAuthGet');
+const { resolveCreds } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
   appendUrlToBase,
-  credsFromPayload,
   fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useUrlAndAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
-  const { credsPayload, apiVersion = DEFAULT_API_VERSION } = context;
-
-  const creds = context.creds ?? await credsFromPayload(credsPayload);
-  const authResponse = await logiwaAuthGet(credsPayload);
-  const { data } = authResponse;
-  const { token } = data;
-
-  // TODO: Handle failed auth
-
+  const {
+    apiVersion = DEFAULT_API_VERSION,
+    creds,
+  } = context;
+
+  const authResponse = await logiwaAuthGet(
+    { credsObject: creds }, 
+    { apiVersion },
+  );
+
+  if (!authResponse?.ok) {
+    return {
+      breakChain: true,
+      response: authResponse,
+    };
+  }
+
+  const { token } = authResponse.data;
   const { BASE_URL } = creds;
 
   return {
-    context: {
-      creds,
-    },
     requestPayload: {
+      ...requestPayload,
       url: appendUrlToBase(`${ BASE_URL }/${ apiVersion }`, requestPayload.url),
       headers: {
         Authorization: `Bearer ${ token }`,
@@ -35,17 +41,13 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const logiwaClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const logiwaClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const logiwaClient = new FetchClient({
-  requestPreparer: logiwaClientRequestPreparer,
-  responseInterpreter: logiwaClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useUrlAndAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {

package/api/logiwa/logiwaInventoriesGet.js

@@ -39,9 +39,11 @@ const logiwaInventoriesGet = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Inventory/list/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Inventory/list/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaOrderGet.js

@@ -26,8 +26,10 @@ const logiwaOrderGet = async (
   }
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/ShipmentOrder/${ orderId }`,
+    requestPayload: {
+      method: 'get',
+      url: `/ShipmentOrder/${ orderId }`,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaOrdersGet.js

@@ -57,9 +57,11 @@ const logiwaOrdersGet = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/ShipmentOrder/list/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/ShipmentOrder/list/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaProductGet.js

@@ -26,8 +26,10 @@ const logiwaProductGet = async (
   }
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Product/detail/${ productId }`,
+    requestPayload: {
+      method: 'get',
+      url: `/Product/detail/${ productId }`,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaProductsGet.js

@@ -45,9 +45,11 @@ const logiwaProductsGet = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Product/list/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Product/list/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaReportGetAvailableToPromise.js

@@ -100,9 +100,11 @@ const logiwaReportGetAvailableToPromiseSingle = async (
   }
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Report/AvailableToPromise/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Report/AvailableToPromise/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaReportGetInventoryCalculation.js

@@ -33,9 +33,11 @@ const logiwaReportGetInventoryCalculation = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Report/InventoryCalculation/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Report/InventoryCalculation/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaReportGetInventorySnapshot.js

@@ -37,9 +37,11 @@ const logiwaReportGetInventorySnapshot = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Report/InventorySnapshot/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Report/InventorySnapshot/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaReportGetTotalInventory.js

@@ -43,9 +43,11 @@ const logiwaReportGetTotalInventory = async (
   };
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Report/TotalInventory/i/${ page }/s/${ perPage }`,
-    params,
+    requestPayload: {
+      method: 'get',
+      url: `/Report/TotalInventory/i/${ page }/s/${ perPage }`,
+      params,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaWebhookStatusGet.js

@@ -26,8 +26,10 @@ const logiwaWebhookStatusGet = async (
   }
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: `/Webhook/status/${ subscriptionId }`,
+    requestPayload: {
+      method: 'get',
+      url: `/Webhook/status/${ subscriptionId }`,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaWebhookSubscribe.js

@@ -30,12 +30,14 @@ const logiwaWebhookSubscribe = async (
   }
 
   return logiwaClient.fetch({
-    method: 'post',
-    url: '/Webhook/create',
-    body: {
-      topic,
-      address: url,
-      ...(clientIdentifier ? { clientIdentifier } : { ignoreClient: true }),
+    requestPayload: {
+      method: 'post',
+      url: '/Webhook/create',
+      body: {
+        topic,
+        address: url,
+        ...(clientIdentifier ? { clientIdentifier } : { ignoreClient: true }),
+      },
     },
     context: {
       credsPayload,

package/api/logiwa/logiwaWebhookUnsubscribe.js

@@ -26,8 +26,10 @@ const logiwaWebhookUnsubscribe = async (
   }
 
   return logiwaClient.fetch({
-    method: 'delete',
-    url: `/Webhook/unsubscribe/${ subscriptionId }`,
+    requestPayload: {
+      method: 'delete',
+      url: `/Webhook/unsubscribe/${ subscriptionId }`,
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/logiwa/logiwaWebhooksGet.js

@@ -21,8 +21,10 @@ const logiwaWebhooksGet = async (
   }
 
   return logiwaClient.fetch({
-    method: 'get',
-    url: '/Webhook/list',
+    requestPayload: {
+      method: 'get',
+      url: '/Webhook/list',
+    },
     context: {
       credsPayload,
       apiVersion,

package/api/loop/loop.utils.js

@@ -1,13 +1,12 @@
 const { LOOP_API_BASE_URL } = require('../loop/loop.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
-  appendUrlToBase,
   fetchClientCommonSteps,
 } = require('../utils');
 
 // TODO: Allow creds failure (e.g. missing API_KEY → INVALID_CREDS before fetch)
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
   const { API_KEY } = creds;
@@ -15,9 +14,7 @@ const addUrlAndAuthHeaders = async (state) => {
   return {
     requestPayload: {
       ...requestPayload,
-      url: appendUrlToBase(LOOP_API_BASE_URL, requestPayload.url),
       headers: {
-        'Content-Type': 'application/json',
         'X-Authorization': API_KEY,
         ...requestPayload.headers,
       },
@@ -25,17 +22,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const loopClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const loopClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const loopClient = new FetchClient({
-  requestPreparer: loopClientRequestPreparer,
-  responseInterpreter: loopClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(LOOP_API_BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {

package/api/loop/loopGet.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, ArgsWarden, Getter } = require('../utils');
+const { ArgsWarden, Getter } = require('../utils');
 const { credsValidator } = require('../validators');
 const { loopClient } = require('../loop/loop.utils');
 const { MAX_PER_PAGE } = require('../loop/loop.constants');
@@ -9,7 +9,7 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const loopGetPacket = async (
-  creds,
+  credsPayload,
   url,
   {
     params,
@@ -18,16 +18,18 @@ const loopGetPacket = async (
   } = {},
 ) => {
   return loopClient.fetch({
-    url,
-    ...(paginate && {
-      params: {
-        paginate: true,
-        pageSize: perPage,
-        ...params,
-      },
-    }),
+    requestPayload: {
+      url,
+      ...(paginate && {
+        params: {
+          paginate: true,
+          pageSize: perPage,
+          ...params,
+        },
+      }),
+    },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };
@@ -44,10 +46,10 @@ const loopGetPaginator = async (currentParams, response) => {
     return [true];
   }
 
-  const [creds] = args;
+  const [credsPayload] = args;
 
   return [false, {
-    args: [creds, nextPageUrl],
+    args: [credsPayload, nextPageUrl],
     options: {
       paginate: false,
     },
@@ -75,13 +77,9 @@ const loopGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
-  let firstError = null;
-
   const getter = new Getter(
     {
-      args: [creds, url],
+      args: [credsPayload, url],
       options: {
         params,
         perPage,
@@ -91,7 +89,6 @@ const loopGet = async (
       func: loopGetPacket,
       digester: (response) => {
         if (!response?.ok) {
-          firstError = response;
           return [];
         }
 
@@ -112,11 +109,10 @@ const loopGet = async (
 
   const data = await getter.run({ returnAll: true });
 
-  if (firstError) {
-    return firstError;
-  }
-
-  return data;
+  return {
+    ok: true,
+    data,
+  };
 };
 
 const funcApiConfig = {

package/api/loop/loopReturnGet.js

@@ -1,6 +1,6 @@
 // https://docs.loopreturns.com/api-reference/latest/return-data/get-return-details
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { loopClient } = require('../loop/loop.utils');
 
@@ -37,8 +37,6 @@ const loopReturnGet = async (
     orderName,
   } = returnIdentifier;
 
-  const creds = await credsFromPayload(credsPayload);
-
   const params = {
     ...returnId && { return_id: returnId },
     ...orderId && { order_id: orderId },
@@ -46,10 +44,12 @@ const loopReturnGet = async (
   };
 
   return loopClient.fetch({
-    url: '/warehouse/return/details',
-    params,
+    requestPayload: {
+      url: '/warehouse/return/details',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
     },
   });
 };