@foxtware/mineral 0.1.15 → 0.1.16

package/api/pipe17/pipe17ArrivalUpdate.js

@@ -0,0 +1,111 @@
+// https://apidoc.pipe17.com/#/operations/updateArrival
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+const { pipe17ArrivalGet } = require('../pipe17/pipe17ArrivalGet');
+
+const arrivalIdentifierValidator = (arrivalIdentifier) => {
+  return objHasAny(arrivalIdentifier, [
+    'arrivalId',
+    'extArrivalId',
+    'extArrivalApiId',
+    'extReferenceId',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['arrivalIdentifier', arrivalIdentifierValidator],
+  ['updatePayload'],
+]);
+
+const pipe17ArrivalUpdate = async (
+  credsPayload,
+  arrivalIdentifier,
+  updatePayload,
+  {
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    arrivalIdentifier,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  let { arrivalId } = arrivalIdentifier;
+
+  if (!arrivalId) {
+    const arrivalResponse = await pipe17ArrivalGet(
+      credsPayload,
+      arrivalIdentifier,
+      { fetchClient },
+    );
+
+    if (!arrivalResponse.ok) {
+      return arrivalResponse;
+    }
+
+    arrivalId = arrivalResponse.data?.arrivalId;
+  }
+
+  if (!arrivalId) {
+    return {
+      ok: false,
+      error: {
+        code: 'ARRIVAL_ID_NOT_FOUND',
+        message: 'Arrival ID not found',
+      },
+    };
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'put',
+      url: `/arrivals/${ arrivalId }`,
+      body: updatePayload,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  const arrival = response.data?.result?.arrival
+    ?? response.data?.arrival;
+  if (arrival !== undefined) {
+    return {
+      ...response,
+      data: arrival,
+    };
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17ArrivalUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17ArrivalUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "arrivalIdentifier": { "arrivalId": "d22afa93793be1f1" },
+    "updatePayload": { "senderName": "test" }
+  }'
+*/

package/api/pipe17/pipe17ArrivalsGet.js

@@ -0,0 +1,54 @@
+// https://apidoc.pipe17.com/#/operations/fetchArrivals
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const pipe17ArrivalsGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/arrivals',
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17ArrivalsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17ArrivalsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "options": { "params": { "count": 5 } }
+  }'
+*/

package/api/pipe17/pipe17FulfillmentGet.js

@@ -0,0 +1,69 @@
+// https://apidoc.pipe17.com/#/operations/fetchFulfillment
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17GetSingle } = require('../pipe17/pipe17.utils');
+
+const fulfillmentIdentifierValidator = (fulfillmentIdentifier) => {
+  return objHasAny(fulfillmentIdentifier, ['fulfillmentId', 'extFulfillmentId']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['fulfillmentIdentifier', fulfillmentIdentifierValidator],
+]);
+
+const resolveFulfillmentId = ({
+  fulfillmentId,
+  extFulfillmentId,
+}) => {
+  return fulfillmentId
+    || (extFulfillmentId ? `ext:${ extFulfillmentId }` : null);
+};
+
+const pipe17FulfillmentGet = async (
+  credsPayload,
+  fulfillmentIdentifier,
+  {
+    inspect = false,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    fulfillmentIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return pipe17GetSingle(
+    credsPayload,
+    '/fulfillments',
+    resolveFulfillmentId(fulfillmentIdentifier),
+    {
+      resultKey: 'fulfillment',
+      inspect,
+      fetchClient,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17FulfillmentGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17FulfillmentGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "fulfillmentIdentifier": { "fulfillmentId": "4ce308990d48d54f" }
+  }'
+*/

package/api/pipe17/pipe17FulfillmentsGet.js

@@ -0,0 +1,54 @@
+// https://apidoc.pipe17.com/#/operations/fetchFulfillments
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const pipe17FulfillmentsGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/fulfillments',
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17FulfillmentsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17FulfillmentsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "options": { "params": { "count": 5 } }
+  }'
+*/

package/api/pipe17/pipe17Get.js

@@ -0,0 +1,151 @@
+// https://apidoc.pipe17.com/
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+const { DEFAULT_PAGE_SIZE } = require('../pipe17/pipe17.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+  ['itemsKey'],
+]);
+
+const pipe17GetPacket = async (
+  credsPayload,
+  url,
+  itemsKey,
+  {
+    params,
+    count = DEFAULT_PAGE_SIZE,
+  } = {},
+) => {
+  return pipe17Client.fetch({
+    requestPayload: {
+      method: 'get',
+      url,
+      params: {
+        count,
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const pipe17GetPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const pagination = response.data?.result?.pagination
+    ?? response.data?.pagination;
+  if (!pagination) {
+    return [true];
+  }
+
+  const { last, pageSize } = pagination;
+  if (last) {
+    return [true];
+  }
+
+  const { params = {} } = options;
+  const skip = (params.skip ?? 0) + (pageSize ?? options.count ?? DEFAULT_PAGE_SIZE);
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...params,
+        skip,
+      },
+    },
+  }];
+};
+
+const pipe17Get = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  itemsKey,
+  {
+    params,
+    count = DEFAULT_PAGE_SIZE,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+    itemsKey,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url, itemsKey],
+      options: {
+        params,
+        count,
+      },
+    },
+    {
+      func: pipe17GetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return response.data?.result?.[itemsKey]
+          ?? response.data?.[itemsKey]
+          ?? [];
+      },
+      paginator: pipe17GetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17Get: (...args) => pipe17Get(false, ...args),
+  pipe17Getter: (...args) => pipe17Get(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17Get" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "url": "/locations",
+    "itemsKey": "locations",
+    "options": {
+      "count": 25,
+      "limit": 5
+    }
+  }'
+*/

package/api/pipe17/pipe17InventoryItemGet.js

@@ -0,0 +1,57 @@
+// https://apidoc.pipe17.com/#/operations/fetchInventory
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17GetSingle } = require('../pipe17/pipe17.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['inventoryItemId'],
+]);
+
+const pipe17InventoryItemGet = async (
+  credsPayload,
+  inventoryItemId,
+  {
+    inspect = false,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    inventoryItemId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return pipe17GetSingle(
+    credsPayload,
+    '/inventory',
+    inventoryItemId,
+    {
+      resultKey: 'inventory',
+      inspect,
+      fetchClient,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17InventoryItemGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17InventoryItemGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "inventoryItemId": "904e7f5e7a03df4f"
+  }'
+*/

package/api/pipe17/pipe17InventoryItemsGet.js

@@ -0,0 +1,54 @@
+// https://apidoc.pipe17.com/#/operations/listInventory
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const pipe17InventoryItemsGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/inventory',
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17InventoryItemsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17InventoryItemsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "options": { "params": { "count": 5 } }
+  }'
+*/

package/api/pipe17/pipe17JobCreate.js

@@ -0,0 +1,95 @@
+// https://apidoc.pipe17.com/#/operations/createJob
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+const { JOB_TYPES, JOB_SUBTYPES } = require('../pipe17/pipe17.constants');
+
+const jobTypeValidator = (type) => JOB_TYPES.includes(type);
+const jobSubTypeValidator = (subType) => JOB_SUBTYPES.includes(subType);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['type', jobTypeValidator],
+  ['subType', jobSubTypeValidator],
+]);
+
+const pipe17JobCreate = async (
+  credsPayload,
+  type,
+  subType,
+  {
+    contentType,
+    internal,
+    params,
+    state,
+    tags,
+    timeout,
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    type,
+    subType,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/jobs',
+      body: {
+        type,
+        subType,
+        ...contentType && { contentType },
+        ...internal && { internal },
+        ...params && { params },
+        ...state && { state },
+        ...tags && { tags },
+        ...timeout && { timeout },
+      },
+    },
+    context: { credsPayload },
+    inspect,
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  const job = response.data?.result?.job
+    ?? response.data?.job;
+  if (job !== undefined) {
+    return {
+      ...response,
+      data: job,
+    };
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17JobCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17JobCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "type": "report",
+    "subType": "orders",
+    "options": { "params": { "emails": ["test@example.com"] } }
+  }'
+*/

package/api/pipe17/pipe17JobGet.js

@@ -0,0 +1,70 @@
+// https://apidoc.pipe17.com/#/operations/fetchJob
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { pipe17Client } = require('../pipe17/pipe17.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['jobId'],
+]);
+
+const pipe17JobGet = async (
+  credsPayload,
+  jobId,
+  {
+    inspect = false,
+    fetchClient = pipe17Client,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    jobId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/jobs/${ jobId }`,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  const job = response.data?.result?.job
+    ?? response.data?.job;
+  if (job !== undefined) {
+    return {
+      ...response,
+      data: job,
+    };
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  pipe17JobGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/pipe17JobGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "pipe17" },
+    "jobId": "eb7586ac111d3afb"
+  }'
+*/