@foxtware/mineral 0.1.8 → 0.1.10

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

package/api/starshipit/starshipitOrderUpdate.js

@@ -0,0 +1,109 @@
+// 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],
+  ['updatePayload'],
+]);
+
+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 starshipitOrderUpdate = async (
+  credsPayload,
+  orderIdentifier,
+  updatePayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderIdentifier,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const orderIdResponse = await resolveOrderId(credsPayload, orderIdentifier);
+  if (!orderIdResponse?.ok) {
+    return orderIdResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders',
+      method: 'put',
+      body: {
+        order: {
+          order_id: orderIdResponse.data,
+          ...updatePayload,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrderUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrderUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "orderIdentifier": { "orderNumber": "7029471248456" },
+    "updatePayload": { "destination": { "name": "Big Dog" } }
+  }'
+*/

package/api/starshipit/starshipitOrdersListShipped.js

@@ -0,0 +1,64 @@
+// https://api-docs.starshipit.com/#abbdf631-21c8-472b-b2e7-b1b68b01f6d0
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const starshipitOrdersListShipped = async (
+  credsPayload,
+  {
+    sinceLastUpdated,
+    idsOnly,
+    perPage,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/orders/shipped',
+      params: {
+        ...sinceLastUpdated && { since_last_updated: sinceLastUpdated },
+        ...idsOnly && { ids_only: idsOnly },
+        ...perPage && { limit: perPage },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  return {
+    ...response,
+    data: response.data?.orders || response.data?.order_ids || response.data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitOrdersListShipped,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitOrdersListShipped" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" }
+  }'
+*/

package/api/starshipit/starshipitProductAdd.js

@@ -0,0 +1,100 @@
+// https://api-docs.starshipit.com/#8cfbd1b2-bd08-4cec-966f-7104cc147aee
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sku'],
+]);
+
+const starshipitProductAdd = async (
+  credsPayload,
+  sku,
+  {
+    title,
+    customsDescription,
+    description,
+    country,
+    weight,
+    height,
+    length,
+    width,
+    hsCode,
+    color,
+    size,
+    barcode,
+    binLocation,
+    brand,
+    usage,
+    material,
+    model,
+    mid,
+    price,
+    dangerousGoodsType,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sku,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/products',
+      method: 'post',
+      body: {
+        product: {
+          sku,
+          ...title && { title },
+          ...customsDescription && { customs_description: customsDescription },
+          ...description && { description },
+          ...country && { country },
+          ...weight && { weight },
+          ...height && { height },
+          ...length && { length },
+          ...width && { width },
+          ...hsCode && { hs_code: hsCode },
+          ...color && { color },
+          ...size && { size },
+          ...barcode && { barcode },
+          ...binLocation && { bin_location: binLocation },
+          ...brand && { brand },
+          ...usage && { usage },
+          ...material && { material },
+          ...model && { model },
+          ...mid && { mid },
+          ...price && { price },
+          ...dangerousGoodsType && { dangerous_goods_type: dangerousGoodsType },
+        },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "sku": "WFAL48-1-S",
+    "options": { "title": "Example Product" }
+  }'
+*/

package/api/starshipit/starshipitProductsDelete.js

@@ -0,0 +1,57 @@
+// https://api-docs.starshipit.com/#5edb43f1-432b-4d1a-bb31-e05db0c879e3
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const productIdsValidator = (productIds) => Array.isArray(productIds) && productIds.length > 0;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIds', productIdsValidator],
+]);
+
+const starshipitProductsDelete = async (
+  credsPayload,
+  productIds,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIds,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitClient.fetch({
+    requestPayload: {
+      url: '/products/delete',
+      method: 'delete',
+      body: {
+        product_ids: productIds,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductsDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductsDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "productIds": [5585356]
+  }'
+*/

package/api/starshipit/starshipitProductsGet.js

@@ -0,0 +1,49 @@
+// https://api-docs.starshipit.com/#ccf0f10f-e370-45c0-ba5c-13bfaac80ca6
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitGet } = require('../starshipit/starshipitGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const starshipitProductsGet = async (
+  credsPayload,
+  {
+    searchTerm,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return starshipitGet(credsPayload, '/products', {
+    nodeName: 'products',
+    params: {
+      ...searchTerm && { search_term: searchTerm },
+    },
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitProductsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.acc" },
+    "options": { "searchTerm": "WFAL48-1-S" }
+  }'
+*/