@foxtware/mineral 0.1.15 → 0.1.16

package/api/pipe17/pipe17ReturnsGet.js

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

package/api/printify/_example.get.js

@@ -0,0 +1,67 @@
+// https://developers.printify.com/#retrieve-a-list-of-products
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyGet, printifyGetter } = require('../printify/printifyGet');
+const { resolveShopIdFromCreds } = require('../printify/printify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const printifyThingsGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    shopId,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopIdFromCreds({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  const getterArgs = [
+    credsPayload,
+    `/shops/${ shopId }/products.json`,
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? printifyGetter(...getterArgs)
+    : printifyGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyThingsGet: (...args) => printifyThingsGet(false, ...args),
+  printifyThingsGetter: (...args) => printifyThingsGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/printifyThingsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "printify" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/printify/_example.js

@@ -0,0 +1,59 @@
+// https://developers.printify.com/#api-reference
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient, resolveShopIdFromCreds } = require('../printify/printify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['arg'],
+]);
+
+const FUNC = async (
+  credsPayload,
+  arg,
+  {
+    shopId,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    arg,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopIdFromCreds({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/shops/${ shopId }/things/${ arg }.json`,
+    },
+    context: { credsPayload },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  FUNC,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/FUNC" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "printify" },
+    "arg": "1234"
+  }'
+*/

package/api/printify/printify.constants.js

@@ -0,0 +1,8 @@
+const BASE_URL = 'https://api.printify.com/v1';
+// Printify list endpoints reject limit > 50 (API error 8150).
+const MAX_PER_PAGE = 50;
+
+module.exports = {
+  BASE_URL,
+  MAX_PER_PAGE,
+};

package/api/printify/printify.utils.js

@@ -0,0 +1,41 @@
+const { BASE_URL } = require('../printify/printify.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const { FetchClient, fetchClientCommonSteps, resolveFromCreds } = require('../utils');
+
+const resolveShopIdFromCreds = async ({ shopId, credsPayload, creds }) => {
+  if (shopId) {
+    return { ok: true, data: shopId };
+  }
+  return resolveFromCreds('SHOP_ID')({ credsPayload, creds });
+};
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        Authorization: `Bearer ${ API_KEY }`,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const printifyClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useAuthHeaders,
+    useBaseUrl(BASE_URL),
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  printifyClient,
+  resolveShopIdFromCreds,
+};

package/api/printify/printifyBlueprintGet.js

@@ -0,0 +1,60 @@
+// https://developers.printify.com/#retrieve-a-specific-blueprint
+
+const { ArgsWarden, actionSingleOrMultiple } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['blueprintId'],
+]);
+
+const printifyBlueprintGetSingle = async (
+  credsPayload,
+  blueprintId,
+) => {
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/catalog/blueprints/${ blueprintId }.json`,
+    },
+    context: { credsPayload },
+  });
+};
+
+const printifyBlueprintGet = async (
+  credsPayload,
+  blueprintId,
+  {
+    queueRunOptions,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    blueprintId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    blueprintId,
+    printifyBlueprintGetSingle,
+    (blueprintIdItem) => ({
+      args: [credsPayload, blueprintIdItem],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyBlueprintGet,
+  funcApiConfig,
+};

package/api/printify/printifyBlueprintPrintProviderVariantsGet.js

@@ -0,0 +1,77 @@
+// https://developers.printify.com/#retrieve-a-list-of-variants-for-a-blueprint-and-print-provider
+
+const { ArgsWarden, actionSingleOrMultiple, everyIfArray, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+
+const catalogQueryValidator = (catalogQuery) => {
+  return valueProvided(catalogQuery?.blueprintId)
+    && valueProvided(catalogQuery?.printProviderId);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['catalogQuery', (catalogQuery) => everyIfArray(catalogQueryValidator, catalogQuery)],
+]);
+
+const printifyBlueprintPrintProviderVariantsGetSingle = async (
+  credsPayload,
+  catalogQuery,
+  {
+    showOutOfStock,
+  } = {},
+) => {
+  const {
+    blueprintId,
+    printProviderId,
+  } = catalogQuery;
+
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/catalog/blueprints/${ blueprintId }/print_providers/${ printProviderId }/variants.json`,
+      params: {
+        ...(showOutOfStock && { 'show-out-of-stock': showOutOfStock }),
+      },
+    },
+    context: { credsPayload },
+  });
+};
+
+const printifyBlueprintPrintProviderVariantsGet = async (
+  credsPayload,
+  catalogQuery,
+  {
+    showOutOfStock,
+    queueRunOptions,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    catalogQuery,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    catalogQuery,
+    printifyBlueprintPrintProviderVariantsGetSingle,
+    (catalogQueryItem) => ({
+      args: [credsPayload, catalogQueryItem, { showOutOfStock }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyBlueprintPrintProviderVariantsGet,
+  funcApiConfig,
+};

package/api/printify/printifyBlueprintPrintProvidersGet.js

@@ -0,0 +1,60 @@
+// https://developers.printify.com/#retrieve-a-list-of-print-providers-for-a-blueprint
+
+const { ArgsWarden, actionSingleOrMultiple } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['blueprintId'],
+]);
+
+const printifyBlueprintPrintProvidersGetSingle = async (
+  credsPayload,
+  blueprintId,
+) => {
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/catalog/blueprints/${ blueprintId }/print_providers.json`,
+    },
+    context: { credsPayload },
+  });
+};
+
+const printifyBlueprintPrintProvidersGet = async (
+  credsPayload,
+  blueprintId,
+  {
+    queueRunOptions,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    blueprintId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    blueprintId,
+    printifyBlueprintPrintProvidersGetSingle,
+    (blueprintIdItem) => ({
+      args: [credsPayload, blueprintIdItem],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyBlueprintPrintProvidersGet,
+  funcApiConfig,
+};

package/api/printify/printifyBlueprintsGet.js

@@ -0,0 +1,38 @@
+// https://developers.printify.com/#retrieve-a-list-of-available-blueprints
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const printifyBlueprintsGet = async (
+  credsPayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/catalog/blueprints.json',
+    },
+    context: { credsPayload },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyBlueprintsGet,
+  funcApiConfig,
+};

package/api/printify/printifyGet.js

@@ -0,0 +1,154 @@
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+const { MAX_PER_PAGE } = require('../printify/printify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const printifyGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+  } = {},
+) => {
+  const {
+    page = 1,
+    ...restParams
+  } = params ?? {};
+
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url,
+      params: {
+        page,
+        limit: perPage,
+        ...restParams,
+      },
+    },
+    context: { credsPayload },
+  });
+};
+
+const printifyGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const body = response.data;
+  const {
+    current_page: currentPage,
+    last_page: lastPage,
+  } = body ?? {};
+
+  if (!currentPage || !lastPage) {
+    return [true];
+  }
+
+  const done = currentPage >= lastPage;
+  if (done) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...options.params,
+        page: currentPage + 1,
+      },
+    },
+  }];
+};
+
+const printifyGetDigester = (response) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  const body = response.data;
+
+  if (Array.isArray(body)) {
+    return body;
+  }
+
+  return body?.data ?? [];
+};
+
+const printifyGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        perPage,
+      },
+    },
+    {
+      func: printifyGetPacket,
+      digester: printifyGetDigester,
+      paginator: printifyGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyGet: (...args) => printifyGet(false, ...args),
+  printifyGetter: (...args) => printifyGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/printifyGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "printify" },
+    "url": "/shops.json",
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/printify/printifyImageUpload.js

@@ -0,0 +1,74 @@
+// https://developers.printify.com/#upload-a-new-image
+
+const { ArgsWarden, actionSingleOrMultiple, everyIfArray, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { printifyClient } = require('../printify/printify.utils');
+
+const uploadPayloadValidator = (uploadPayload) => {
+  return valueProvided(uploadPayload?.imageUrl)
+    && valueProvided(uploadPayload?.filename);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['uploadPayload', (uploadPayload) => everyIfArray(uploadPayloadValidator, uploadPayload)],
+]);
+
+const printifyImageUploadSingle = async (
+  credsPayload,
+  uploadPayload,
+) => {
+  const {
+    imageUrl,
+    filename,
+  } = uploadPayload;
+
+  return printifyClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/uploads/images.json',
+      body: {
+        url: imageUrl,
+        file_name: filename,
+      },
+    },
+    context: { credsPayload },
+  });
+};
+
+const printifyImageUpload = async (
+  credsPayload,
+  uploadPayload,
+  {
+    queueRunOptions,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    uploadPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    uploadPayload,
+    printifyImageUploadSingle,
+    (uploadPayloadItem) => ({
+      args: [credsPayload, uploadPayloadItem],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  printifyImageUpload,
+  funcApiConfig,
+};