@foxtware/mineral 0.1.15 → 0.1.17

package/api/etsy/etsyAllListingFilesGet.js

@@ -0,0 +1,69 @@
+// https://developers.etsy.com/documentation/reference/#operation/getAllListingFiles
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient, resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['listingId'],
+]);
+
+const etsyAllListingFilesGet = async (
+  credsPayload,
+  listingId,
+  {
+    shopId,
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    listingId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopId({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/shops/${ shopId }/listings/${ listingId }/files`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyAllListingFilesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyAllListingFilesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "listingId": "1234567890"
+  }'
+*/

package/api/etsy/etsyAllListingsGetActive.js

@@ -0,0 +1,88 @@
+// https://developers.etsy.com/documentation/reference/#operation/findAllListingsActive
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyGet, etsyGetter } = require('./etsyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyAllListingsGetActive = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    params: paramsOption,
+    perPage,
+    keywords,
+    sortOn,
+    sortOrder,
+    minPrice,
+    maxPrice,
+    taxonomyId,
+    shopLocation,
+    isSafe,
+    currency,
+    buyerCountry,
+    withAccessToken = false,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...paramsOption,
+    ...(keywords !== undefined && { keywords: keywords }),
+    ...(sortOn !== undefined && { sort_on: sortOn }),
+    ...(sortOrder !== undefined && { sort_order: sortOrder }),
+    ...(minPrice !== undefined && { min_price: minPrice }),
+    ...(maxPrice !== undefined && { max_price: maxPrice }),
+    ...(taxonomyId !== undefined && { taxonomy_id: taxonomyId }),
+    ...(shopLocation !== undefined && { shop_location: shopLocation }),
+    ...(isSafe !== undefined && { is_safe: isSafe }),
+    ...(currency !== undefined && { currency: currency }),
+    ...(buyerCountry !== undefined && { buyer_country: buyerCountry }),
+  };
+
+  const getterArgs = [
+    credsPayload,
+    `/application/listings/active`,
+    {
+      params,
+      perPage,
+      withAccessToken,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? etsyGetter(...getterArgs)
+    : etsyGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyAllListingsGetActive: (...args) => etsyAllListingsGetActive(false, ...args),
+  etsyAllListingsGetActiveGetter: (...args) => etsyAllListingsGetActive(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyAllListingsGetActive" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    }
+  }'
+*/

package/api/etsy/etsyAuthorizationCodeRequest.js

@@ -0,0 +1,124 @@
+// https://developers.etsy.com/documentation/essentials/authentication/#step-1-request-an-authorization-code
+
+const { execFile } = require('child_process');
+const { promisify } = require('util');
+const { v4: uuidv4 } = require('uuid');
+const crypto = require('crypto');
+const { OAUTH_CONNECT_URL, OAUTH_ALL_SCOPES } = require('./etsy.constants');
+const { credsValidator } = require('../validators');
+const { credsFromPayload, ArgsWarden } = require('../utils');
+
+const execFileAsync = promisify(execFile);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['redirectUrl'],
+]);
+
+const buildAuthorizationUrl = (params) => {
+  const search = new URLSearchParams(params).toString().replace(/\+/g, '%20');
+  return `${ OAUTH_CONNECT_URL }?${ search }`;
+};
+
+const generateRandomString = (length) => (
+  crypto
+    .randomBytes(Math.ceil(length * 3 / 4))
+    .toString('base64')
+    .slice(0, length)
+    .replace(/\+/g, '-')
+    .replace(/\//g, '_')
+);
+
+const generatePkce = () => {
+  const codeVerifier = generateRandomString(64);
+  const codeChallenge = crypto
+    .createHash('sha256')
+    .update(codeVerifier)
+    .digest('base64')
+    .replace(/\+/g, '-')
+    .replace(/\//g, '_')
+    .replace(/=+$/, '');
+
+  return {
+    codeVerifier,
+    codeChallenge,
+  };
+};
+
+const etsyAuthorizationCodeRequest = async (
+  credsPayload,
+  redirectUrl,
+  {
+    scopes = OAUTH_ALL_SCOPES,
+    openAuthUrl = false,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    redirectUrl,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+  const { API_KEY } = creds;
+
+  if (!API_KEY) {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_CREDS',
+        message: 'API_KEY is required.',
+      },
+    };
+  }
+
+  const state = uuidv4();
+  const { codeVerifier, codeChallenge } = generatePkce();
+
+  const url = buildAuthorizationUrl({
+    response_type: 'code',
+    client_id: API_KEY,
+    redirect_uri: redirectUrl,
+    scope: scopes.join(' '),
+    state,
+    code_challenge: codeChallenge,
+    code_challenge_method: 'S256',
+  });
+
+  if (openAuthUrl) {
+    // TODO: support non-Macs
+    await execFileAsync('open', [url]);
+  }
+
+  return {
+    ok: true,
+    data: {
+      state,
+      codeVerifier,
+      codeChallenge,
+      ...!openAuthUrl && { url },
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyAuthorizationCodeRequest,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyAuthorizationCodeRequest" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "etsy" },
+    "redirectUrl": "https://06b6-59-154-120-174.ngrok-free.app/log"
+  }'
+*/
+

package/api/etsy/etsyBuyerTaxonomyNodePropertiesGet.js

@@ -0,0 +1,62 @@
+// https://developers.etsy.com/documentation/reference/#operation/getPropertiesByBuyerTaxonomyId
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['taxonomyId'],
+]);
+
+const etsyBuyerTaxonomyNodePropertiesGet = async (
+  credsPayload,
+  taxonomyId,
+  {
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    taxonomyId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/buyer-taxonomy/nodes/${ taxonomyId }/properties`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: false,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyBuyerTaxonomyNodePropertiesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyBuyerTaxonomyNodePropertiesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "taxonomyId": "1"
+  }'
+*/

package/api/etsy/etsyBuyerTaxonomyNodesGet.js

@@ -0,0 +1,58 @@
+// https://developers.etsy.com/documentation/reference/#operation/getBuyerTaxonomyNodes
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyBuyerTaxonomyNodesGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/buyer-taxonomy/nodes`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: false,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyBuyerTaxonomyNodesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyBuyerTaxonomyNodesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    }
+  }'
+*/

package/api/etsy/etsyDraftListingCreate.js

@@ -0,0 +1,71 @@
+// https://developers.etsy.com/documentation/reference/#operation/createDraftListing
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient, resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['createPayload'],
+]);
+
+const etsyDraftListingCreate = async (
+  credsPayload,
+  createPayload,
+  {
+    shopId,
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    createPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopId({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/application/shops/${ shopId }/listings`,
+      body: createPayload,
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyDraftListingCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyDraftListingCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "createPayload": {
+      ...
+    }
+  }'
+*/

package/api/etsy/etsyFeaturedListingsByShopGet.js

@@ -0,0 +1,78 @@
+// https://developers.etsy.com/documentation/reference/#operation/getFeaturedListingsByShop
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyGet, etsyGetter } = require('./etsyGet');
+const { resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyFeaturedListingsByShopGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    shopId,
+    params: paramsOption,
+    perPage,
+    legacy,
+    withAccessToken = true,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopId({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  const params = {
+    ...paramsOption,
+    ...(legacy !== undefined && { legacy: legacy }),
+  };
+
+  const getterArgs = [
+    credsPayload,
+    `/application/shops/${ shopId }/listings/featured`,
+    {
+      params,
+      perPage,
+      withAccessToken,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? etsyGetter(...getterArgs)
+    : etsyGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyFeaturedListingsByShopGet: (...args) => etsyFeaturedListingsByShopGet(false, ...args),
+  etsyFeaturedListingsByShopGetter: (...args) => etsyFeaturedListingsByShopGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyFeaturedListingsByShopGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    }
+  }'
+*/

package/api/etsy/etsyGet.js

@@ -0,0 +1,150 @@
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { MAX_PER_PAGE } = require('./etsy.constants');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const etsyGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    withAccessToken = true,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url,
+      params: {
+        limit: perPage,
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+      withAccessToken,
+    },
+  });
+};
+
+const etsyGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const { count, results } = response.data ?? {};
+  const itemsOnPage = Array.isArray(results) ? results.length : 0;
+
+  if (count === undefined || !itemsOnPage) {
+    return [true];
+  }
+
+  const { options } = currentParams;
+  const offset = options?.params?.offset ?? 0;
+  const nextOffset = offset + itemsOnPage;
+  const done = nextOffset >= count;
+
+  if (done) {
+    return [true];
+  }
+
+  return [false, {
+    ...currentParams,
+    options: {
+      ...options,
+      params: {
+        ...options.params,
+        offset: nextOffset,
+      },
+    },
+  }];
+};
+
+const etsyGetDigester = (response) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  return response.data?.results ?? [];
+};
+
+const etsyGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    withAccessToken,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        perPage,
+        withAccessToken,
+        fetchClient,
+      },
+    },
+    {
+      func: etsyGetPacket,
+      digester: etsyGetDigester,
+      paginator: etsyGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyGet: (...args) => etsyGet(false, ...args),
+  etsyGetter: (...args) => etsyGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "url": "/application/shops/123456789/receipts"
+  }'
+*/