@foxtware/mineral 0.1.14 → 0.1.16

package/api/etsy/etsyListingsByListingIdsGet.js

@@ -0,0 +1,63 @@
+// https://developers.etsy.com/documentation/reference/#operation/getListingsByListingIds
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyListingsByListingIdsGet = 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/listings/batch`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyListingsByListingIdsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyListingsByListingIdsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "options": {
+      "params": {
+        "listing_ids": "1527825785"
+      }
+    }
+  }'
+*/

package/api/etsy/etsyListingsByShopReceiptGet.js

@@ -0,0 +1,82 @@
+// https://developers.etsy.com/documentation/reference/#operation/getListingsByShopReceipt
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyGet, etsyGetter } = require('./etsyGet');
+const { resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['receiptId'],
+]);
+
+const etsyListingsByShopReceiptGet = async (
+  returnGetter,
+
+  credsPayload,
+  receiptId,
+  {
+    shopId,
+    params: paramsOption,
+    perPage,
+    legacy,
+    withAccessToken = true,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    receiptId,
+  });
+  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 }/receipts/${ receiptId }/listings`,
+    {
+      params,
+      perPage,
+      withAccessToken,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? etsyGetter(...getterArgs)
+    : etsyGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyListingsByShopReceiptGet: (...args) => etsyListingsByShopReceiptGet(false, ...args),
+  etsyListingsByShopReceiptGetter: (...args) => etsyListingsByShopReceiptGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyListingsByShopReceiptGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "receiptId": "3759771968"
+  }'
+*/

package/api/etsy/etsyListingsByShopReturnPolicyGet.js

@@ -0,0 +1,69 @@
+// https://developers.etsy.com/documentation/reference/#operation/getListingsByShopReturnPolicy
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient, resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['returnPolicyId'],
+]);
+
+const etsyListingsByShopReturnPolicyGet = async (
+  credsPayload,
+  returnPolicyId,
+  {
+    shopId,
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    returnPolicyId,
+  });
+  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 }/policies/return/${ returnPolicyId }/listings`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyListingsByShopReturnPolicyGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyListingsByShopReturnPolicyGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "returnPolicyId": "123456789"
+  }'
+*/

package/api/etsy/etsyListingsInventoryByListingIdsGet.js

@@ -0,0 +1,63 @@
+// https://developers.etsy.com/documentation/reference/#operation/getListingsInventoryByListingIds
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyListingsInventoryByListingIdsGet = 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/listings/batch/inventory`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyListingsInventoryByListingIdsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyListingsInventoryByListingIdsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "options": {
+      "params": {
+        "listing_ids": "1527825785"
+      }
+    }
+  }'
+*/

package/api/etsy/etsyListingsShippingByListingIdsGet.js

@@ -0,0 +1,63 @@
+// https://developers.etsy.com/documentation/reference/#operation/getListingsShippingByListingIds
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyListingsShippingByListingIdsGet = 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/listings/batch/shipping`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyListingsShippingByListingIdsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyListingsShippingByListingIdsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "options": {
+      "params": {
+        "listing_ids": "1527825785"
+      }
+    }
+  }'
+*/

package/api/etsy/etsyMeGet.js

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

package/api/etsy/etsyOauthRedirectParse.js

@@ -0,0 +1,201 @@
+// https://developers.etsy.com/documentation/essentials/authentication/#step-2-grant-access
+
+const crypto = require('crypto');
+
+const usedOauthStates = new Set();
+
+const codeChallengeFromVerifier = (codeVerifier) => (
+  crypto
+    .createHash('sha256')
+    .update(codeVerifier)
+    .digest('base64')
+    .replace(/\+/g, '-')
+    .replace(/\//g, '_')
+    .replace(/=+$/, '')
+);
+
+const redirectOriginAndPath = (urlString) => {
+  const { origin, pathname } = new URL(urlString);
+  return `${ origin }${ pathname }`;
+};
+
+const validateCallbackTarget = (parsedUrl, expectedRedirectUrl) => {
+  if (!expectedRedirectUrl) {
+    return null;
+  }
+
+  const expected = redirectOriginAndPath(expectedRedirectUrl);
+  const actual = redirectOriginAndPath(parsedUrl.href);
+
+  if (actual !== expected) {
+    return {
+      ok: false,
+      error: {
+        code: 'REDIRECT_URL_MISMATCH',
+        message: 'Callback origin and path must exactly match the redirect_uri used in the authorization request (case-sensitive, no extra trailing slash).',
+        details: { expected, actual },
+      },
+    };
+  }
+
+  if (!expectedRedirectUrl.startsWith('https://')) {
+    return {
+      ok: false,
+      error: {
+        code: 'REDIRECT_URL_NOT_HTTPS',
+        message: 'Etsy redirect URIs must use https://.',
+      },
+    };
+  }
+
+  return null;
+};
+
+const validateState = (params, expectedState) => {
+  if (!expectedState) {
+    return {
+      ok: false,
+      error: {
+        code: 'MISSING_EXPECTED_STATE',
+        message: 'expectedState is required to validate the OAuth callback.',
+      },
+    };
+  }
+
+  const state = params.get('state');
+
+  if (!state) {
+    return {
+      ok: false,
+      error: {
+        code: 'MISSING_STATE',
+        message: 'Redirect URL has no state parameter.',
+      },
+    };
+  }
+
+  if (state !== expectedState) {
+    return {
+      ok: false,
+      error: {
+        code: 'STATE_MISMATCH',
+        message: 'State does not match the authorization request; halt authentication (CSRF).',
+        details: { expectedState, state },
+      },
+    };
+  }
+
+  if (usedOauthStates.has(state)) {
+    return {
+      ok: false,
+      error: {
+        code: 'STATE_ALREADY_USED',
+        message: 'This state was already consumed; start a new authorization request.',
+      },
+    };
+  }
+
+  return { ok: true, state };
+};
+
+const etsyOauthRedirectParse = ({
+  resultingUrl,
+  expectedState,
+  codeVerifier,
+  expectedCodeChallenge,
+  expectedRedirectUrl,
+}) => {
+
+  let parsedUrl;
+  try {
+    parsedUrl = new URL(resultingUrl);
+  } catch {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_REDIRECT_URL',
+        message: 'Could not parse the redirect URL.',
+      },
+    };
+  }
+
+  const targetError = validateCallbackTarget(parsedUrl, expectedRedirectUrl);
+  if (targetError) {
+    return targetError;
+  }
+
+  const params = parsedUrl.searchParams;
+
+  const stateResult = validateState(params, expectedState);
+  if (!stateResult.ok) {
+    return stateResult;
+  }
+
+  const { state } = stateResult;
+
+  const oauthError = params.get('error');
+  if (oauthError) {
+    return {
+      ok: false,
+      error: {
+        code: 'OAUTH_ERROR',
+        message: params.get('error_description') ?? oauthError,
+        details: {
+          error: oauthError,
+          errorUri: params.get('error_uri'),
+          state,
+        },
+      },
+    };
+  }
+
+  const code = params.get('code');
+  if (!code) {
+    return {
+      ok: false,
+      error: {
+        code: 'MISSING_CODE',
+        message: 'Redirect URL has no authorization code.',
+      },
+    };
+  }
+
+  if (!codeVerifier || !expectedCodeChallenge) {
+    return {
+      ok: false,
+      error: {
+        code: 'MISSING_PKCE',
+        message: 'codeVerifier and expectedCodeChallenge are required for this authorization flow.',
+      },
+    };
+  }
+
+  const challengeFromVerifier = codeChallengeFromVerifier(codeVerifier);
+  if (challengeFromVerifier !== expectedCodeChallenge) {
+    return {
+      ok: false,
+      error: {
+        code: 'PKCE_MISMATCH',
+        message: 'Code verifier does not match the code challenge from this authorization request.',
+      },
+    };
+  }
+
+  usedOauthStates.add(state);
+
+  return {
+    ok: true,
+    data: {
+      code,
+      state,
+      codeVerifier,
+      redirectUri: expectedRedirectUrl,
+      iss: params.get('iss'),
+    },
+  };
+};
+
+module.exports = {
+  etsyOauthRedirectParse,
+  codeChallengeFromVerifier,
+};

package/api/etsy/etsyPaymentAccountLedgerEntryPaymentsGet.js

@@ -0,0 +1,65 @@
+// https://developers.etsy.com/documentation/reference/#operation/getPaymentAccountLedgerEntryPayments
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient, resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyPaymentAccountLedgerEntryPaymentsGet = async (
+  credsPayload,
+  {
+    shopId,
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  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 }/payment-account/ledger-entries/payments`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyPaymentAccountLedgerEntryPaymentsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyPaymentAccountLedgerEntryPaymentsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    }
+  }'
+*/