@foxtware/mineral 0.1.14 → 0.1.16

package/api/notion/notion.utils.js

@@ -0,0 +1,44 @@
+const {
+  NOTION_API_BASE_URL,
+  DEFAULT_NOTION_VERSION,
+} = require('../notion/notion.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const {
+    API_KEY,
+    NOTION_VERSION,
+  } = creds;
+  const notionVersion = NOTION_VERSION ?? DEFAULT_NOTION_VERSION;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        Authorization: `Bearer ${ API_KEY }`,
+        'Notion-Version': notionVersion,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const notionClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(NOTION_API_BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  notionClient,
+};

package/api/notion/notionGet.js

@@ -0,0 +1,146 @@
+// https://developers.notion.com/reference/get-self
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { notionClient } = require('../notion/notion.utils');
+const { MAX_PER_PAGE } = require('../notion/notion.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const digResults = (data, resultsKey) => {
+  if (resultsKey) {
+    return data?.[resultsKey] ?? [];
+  }
+
+  if (Array.isArray(data)) {
+    return data;
+  }
+
+  const arrayEntry = Object.entries(data || {}).find(([, value]) => Array.isArray(value));
+  return arrayEntry ? arrayEntry[1] : [];
+};
+
+const notionGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+  } = {},
+) => {
+  return notionClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        page_size: Math.min(perPage, MAX_PER_PAGE),
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const notionGetPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const nextCursor = response?.data?.next_cursor;
+  if (!nextCursor) {
+    return [true];
+  }
+
+  const { params = {} } = options;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...params,
+        start_cursor: nextCursor,
+      },
+    },
+  }];
+};
+
+const notionGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    resultsKey,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        perPage,
+      },
+    },
+    {
+      func: notionGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return digResults(response.data, resultsKey);
+      },
+      paginator: notionGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  notionGet: (...args) => notionGet(false, ...args),
+  notionGetter: (...args) => notionGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/notionGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "notion" },
+    "url": "/users/me"
+  }'
+*/

package/api/peoplevox/_example.js

@@ -12,7 +12,10 @@ const FUNC = async (
   salesOrderNumber,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, salesOrderNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    salesOrderNumber,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/peoplevox/peoplevox.sessions.js

@@ -48,7 +48,36 @@ const setSessionId = async (credsPayload, sessionId) => {
   SESSION_IDS.set(CLIENT_ID, sessionId);
 };
 
+const withPeoplevoxSession = async (fetchPayload, next) => {
+  const { context = {} } = fetchPayload;
+  const { credsPayload } = context;
+
+  const sessionIdResponse = await getSessionId(credsPayload);
+
+  if (!sessionIdResponse.ok) {
+    return sessionIdResponse;
+  }
+
+  const sessionId = sessionIdResponse.data;
+
+  const response = await next({
+    ...fetchPayload,
+    context: {
+      ...context,
+      sessionId,
+    },
+  });
+
+  if (response.ok) {
+    await setSessionId(credsPayload, sessionId);
+  }
+
+  // TODO: Check if it was an auth error, and try another auth method if so
+  return response;
+};
+
 module.exports = {
   getSessionId,
   setSessionId,
+  withPeoplevoxSession,
 };

package/api/peoplevox/peoplevox.utils.js

@@ -6,7 +6,7 @@ const {
   appendUrlToBase,
   logDeep,
 } = require('../utils');
-const { getSessionId, setSessionId } = require('../peoplevox/peoplevox.sessions');
+const { withPeoplevoxSession } = require('../peoplevox/peoplevox.sessions');
 
 const xml2jsBuilder = new xml2js.Builder({
   headless: true,
@@ -183,45 +183,11 @@ const peoplevoxClient = new FetchClient({
     unwrapSingleDetail,
     hoistDetail,
   ],
+  layers: [
+    withPeoplevoxSession,
+  ],
 });
 
-const fetchWithoutAuth = peoplevoxClient.fetch.bind(peoplevoxClient);
-
-peoplevoxClient.fetch = async ({
-  requestPayload,
-  context = {},
-  inspect = false,
-}) => {
-  const { credsPayload } = context;
-
-  const sessionIdResponse = await getSessionId(credsPayload);
-
-  const {
-    ok: sessionIdOk,
-    data: sessionId,
-  } = sessionIdResponse;
-
-  if (!sessionIdOk) {
-    return sessionIdResponse;
-  }
-
-  const response = await fetchWithoutAuth({
-    requestPayload,
-    context: {
-      ...context,
-      sessionId,
-    },
-    inspect,
-  });
-
-  if (response.ok) {
-    await setSessionId(credsPayload, sessionId);
-  }
-
-  // TODO: Check if it was an auth error, and try another auth method if so
-  return response;
-};
-
 module.exports = {
   peoplevoxClient,
 };

package/api/peoplevox/peoplevoxAuthGet.js

@@ -9,7 +9,9 @@ const peoplevoxAuthGet = async (
   credsPayload,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/peoplevox/peoplevoxGetSingle.js

@@ -16,7 +16,9 @@ const peoplevoxGetSingle = async (
   credsPayload,
   templateName,
   searchParameters = {},
-  options = {},
+  {
+    fetchClient = peoplevoxClient,
+  } = {},
 ) => {
 
   const rejectResponse = await argsWarden.responseIfRejectingArgs({
@@ -31,7 +33,7 @@ const peoplevoxGetSingle = async (
   const { searchClause, id, idName } = searchParameters;
   const resolvedSearchClause = searchClause || `${ idName }.Equals("${ id }")`;
 
-  const response = await peoplevoxClient.fetch({
+  const response = await fetchClient.fetch({
     requestPayload: {
       method: 'post',
       body: {

package/api/peoplevox/peoplevoxOrderEdit.js

@@ -14,9 +14,15 @@ const argsWarden = new ArgsWarden([
 const peoplevoxOrderEdit = async (
   credsPayload,
   orderPayload,
+  {
+    fetchClient = peoplevoxClient,
+  } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }
@@ -36,7 +42,7 @@ const peoplevoxOrderEdit = async (
     };
   }
 
-  return peoplevoxClient.fetch({
+  return fetchClient.fetch({
     requestPayload: {
       method: 'post',
       body: {

package/api/peoplevox/peoplevoxOrderGet.js

@@ -10,9 +10,13 @@ const argsWarden = new ArgsWarden([
 const peoplevoxOrderGet = async (
   credsPayload,
   salesOrderNumber,
+  options = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, salesOrderNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    salesOrderNumber,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }
@@ -24,6 +28,7 @@ const peoplevoxOrderGet = async (
       id: salesOrderNumber,
       idName: 'SalesOrderNumber',
     },
+    options,
   );
 };
 

package/api/peoplevox/peoplevoxReportGet.js

@@ -16,15 +16,19 @@ const peoplevoxReportGet = async (
     filter,
     orderBy,
     columns,
+    fetchClient = peoplevoxClient,
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, reportName });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    reportName,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  const reportGetResponse = await peoplevoxClient.fetch({
+  const reportGetResponse = await fetchClient.fetch({
     requestPayload: {
       method: 'post',
       body: {

package/api/pipe17/docs.md

@@ -0,0 +1,8 @@
+# Pipe17
+
+- [API references (Help Center)](https://support.pipe17.com/hc/en-us/articles/43018622147995-Pipe17-API-References)
+- [API documentation](https://apidoc.pipe17.com/)
+- [Custom integration introduction](https://support.pipe17.com/hc/en-us/articles/26518046517403-Introduction-to-building-a-Custom-Integration-to-Pipe17)
+- [Webhooks](https://support.pipe17.com/hc/en-us/articles/7179468225819-Getting-started-with-Pipe17-Webhooks)
+
+Versioned REST JSON under `https://api-v3.pipe17.com/api/v3`, authenticated with an organization or integration API key in the `X-Pipe17-Key` header (keys from Settings → API Keys or from a registered custom connector), covering orders, products, inventory, fulfillments, shipments, locations, connectors, and webhooks.

package/api/pipe17/pipe17.constants.js

@@ -0,0 +1,47 @@
+const PIPE17_API_BASE_URL = 'https://api-v3.pipe17.com/api/v3';
+
+const PIPE17_API_SANDBOX_BASE_URL = 'https://api-v3.develop.pipe17.com/api/v3';
+
+const DEFAULT_PAGE_SIZE = 100;
+
+const JOB_TYPES = [
+  'report',
+  'import',
+  'prepare',
+  'update',
+  'delete',
+  'export',
+  'automation',
+  'sync',
+];
+
+const JOB_SUBTYPES = [
+  'inventory',
+  'replenishment',
+  'oos_sku_on_order',
+  'open_orders',
+  'purchases',
+  'transfers',
+  'arrivals',
+  'receipts',
+  'products',
+  'organizations',
+  'orders',
+  'shipments',
+  'fulfillments',
+  'locations',
+  'shipping_methods',
+  'returns',
+  'exceptions',
+  'lookup_objects',
+  'statements',
+  'users',
+];
+
+module.exports = {
+  PIPE17_API_BASE_URL,
+  PIPE17_API_SANDBOX_BASE_URL,
+  DEFAULT_PAGE_SIZE,
+  JOB_TYPES,
+  JOB_SUBTYPES,
+};

package/api/pipe17/pipe17.utils.js

@@ -0,0 +1,123 @@
+const {
+  PIPE17_API_BASE_URL,
+} = require('../pipe17/pipe17.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const usePipe17BaseUrl = async (state) => {
+  const { creds } = state.context;
+  return useBaseUrl(creds.BASE_URL ?? PIPE17_API_BASE_URL)(state);
+};
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  if (!API_KEY) {
+    return {
+      breakChain: true,
+      response: {
+        ok: false,
+        error: {
+          code: 'INVALID_CREDS',
+          message: 'API_KEY is required.',
+        },
+      },
+    };
+  }
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'X-Pipe17-Key': API_KEY,
+        Accept: 'application/json',
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const interpretPipe17Response = async (state) => {
+  const { response } = state;
+
+  if (!response?.ok) {
+    return {};
+  }
+
+  const { success, result, errors } = response.data || {};
+
+  if (success === false) {
+    return {
+      response: {
+        ok: false,
+        error: {
+          code: 'PIPE17_API_ERROR',
+          details: result ?? errors ?? response.data,
+        },
+      },
+      breakChain: true,
+    };
+  }
+
+  return {};
+};
+
+const pipe17Client = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    usePipe17BaseUrl,
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    interpretPipe17Response,
+  ],
+});
+
+const pipe17GetSingle = async (
+  credsPayload,
+  collectionPath,
+  id,
+  {
+    resultKey,
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `${ collectionPath }/${ id }`,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  const resolvedResultKey = resultKey ?? collectionPath.replace(/^\//, '').replace(/s$/, '');
+  const entity = response.data?.result?.[resolvedResultKey]
+    ?? response.data?.[resolvedResultKey];
+
+  if (entity !== undefined) {
+    return {
+      ...response,
+      data: entity,
+    };
+  }
+
+  return response;
+};
+
+module.exports = {
+  pipe17Client,
+  interpretPipe17Response,
+  pipe17GetSingle,
+};

package/api/pipe17/pipe17ArrivalGet.js

@@ -0,0 +1,78 @@
+// https://apidoc.pipe17.com/#/operations/fetchArrival
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17GetSingle } = require('../pipe17/pipe17.utils');
+
+const arrivalIdentifierValidator = (arrivalIdentifier) => {
+  return objHasAny(arrivalIdentifier, [
+    'arrivalId',
+    'extArrivalId',
+    'extArrivalApiId',
+    'extReferenceId',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['arrivalIdentifier', arrivalIdentifierValidator],
+]);
+
+const resolveArrivalId = ({
+  arrivalId,
+  extArrivalId,
+  extArrivalApiId,
+  extReferenceId,
+}) => {
+  return arrivalId
+    || (extArrivalId ? `ext:${ extArrivalId }` : null)
+    || (extArrivalApiId ? `api:${ extArrivalApiId }` : null)
+    || (extReferenceId ? `ref:${ extReferenceId }` : null);
+};
+
+const pipe17ArrivalGet = async (
+  credsPayload,
+  arrivalIdentifier,
+  {
+    inspect = false,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    arrivalIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return pipe17GetSingle(
+    credsPayload,
+    '/arrivals',
+    resolveArrivalId(arrivalIdentifier),
+    {
+      resultKey: 'arrival',
+      inspect,
+      fetchClient,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17ArrivalGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17ArrivalGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "arrivalIdentifier": { "arrivalId": "d22afa93793be1f1" }
+  }'
+*/