@foxtware/mineral 0.1.29 → 0.1.31

package/api/paypal/paypalAccessTokenGet.js

@@ -0,0 +1,81 @@
+// https://developer.paypal.com/api/rest/authentication/
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  resolveAccessToken,
+  baseUrlForCreds,
+  getClientCredentialsToken,
+} = require('../paypal/paypal.utils');
+const { resolveCreds } = require('../pipelineSteps');
+const { credsFromPayload } = require('../utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+/**
+ * Resolve (and cache) a PayPal access token for the given creds.
+ * Useful for debugging auth or for callers that need the raw token.
+ */
+const paypalAccessTokenGet = async (
+  credsPayload,
+  {
+    forceRefresh = false,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  try {
+    const creds = await credsFromPayload(credsPayload);
+
+    if (forceRefresh && creds?.CLIENT_ID) {
+      const { clientCredentialsTokenCache } = require('../paypal/paypal.utils');
+      const env = (creds.SANDBOX === true || creds.SANDBOX === 'true'
+        || creds.ENVIRONMENT === 'sandbox' || creds.MODE === 'sandbox')
+        ? 'sandbox'
+        : 'live';
+      clientCredentialsTokenCache.delete(`${ env }:${ creds.CLIENT_ID }`);
+    }
+
+    const accessToken = await resolveAccessToken(creds);
+    return {
+      ok: true,
+      data: {
+        access_token: accessToken,
+        base_url: baseUrlForCreds(creds),
+      },
+    };
+  } catch (err) {
+    return {
+      ok: false,
+      error: {
+        code: 'PAYPAL_AUTH_FAILED',
+        message: err.message || String(err),
+      },
+    };
+  }
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalAccessTokenGet,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalAccessTokenGet" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" }
+    }'
+*/

package/api/paypal/paypalAuthorizationCapture.js

@@ -0,0 +1,75 @@
+// https://developer.paypal.com/docs/api/payments/v2/#authorizations_capture
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['authorizationId'],
+]);
+
+const paypalAuthorizationCapture = async (
+  credsPayload,
+  authorizationId,
+  {
+    capture,
+    prefer = 'return=representation',
+    requestId,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    authorizationId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const headers = {
+    Prefer: prefer,
+  };
+  if (requestId) {
+    headers['PayPal-Request-Id'] = requestId;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/v2/payments/authorizations/${ encodeURIComponent(authorizationId) }/capture`,
+      headers,
+      body: capture !== undefined ? capture : {},
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalAuthorizationCapture,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalAuthorizationCapture" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "authorizationId": "0VF52814937998046",
+      "options": {
+        "capture": {
+          "amount": { "value": "10.00", "currency_code": "USD" },
+          "final_capture": true
+        }
+      }
+    }'
+*/

package/api/paypal/paypalAuthorizationGet.js

@@ -0,0 +1,57 @@
+// https://developer.paypal.com/docs/api/payments/v2/#authorizations_get
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['authorizationId'],
+]);
+
+const paypalAuthorizationGet = async (
+  credsPayload,
+  authorizationId,
+  {
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    authorizationId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/payments/authorizations/${ encodeURIComponent(authorizationId) }`,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalAuthorizationGet,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalAuthorizationGet" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "authorizationId": "0VF52814937998046"
+    }'
+*/

package/api/paypal/paypalBalancesGet.js

@@ -0,0 +1,65 @@
+// https://developer.paypal.com/docs/api/transaction-search/v1/#balances_get
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+/**
+ * List balances for the account. Optional asOfTime is ISO-8601.
+ */
+const paypalBalancesGet = async (
+  credsPayload,
+  {
+    asOfTime,
+    currencyCode,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/v1/reporting/balances',
+      params: {
+        ...(asOfTime ? { as_of_time: asOfTime } : {}),
+        ...(currencyCode ? { currency_code: currencyCode } : {}),
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalBalancesGet,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalBalancesGet" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "options": {
+        "currencyCode": "USD"
+      }
+    }'
+*/

package/api/paypal/paypalCaptureGet.js

@@ -0,0 +1,57 @@
+// https://developer.paypal.com/docs/api/payments/v2/#captures_get
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['captureId'],
+]);
+
+const paypalCaptureGet = async (
+  credsPayload,
+  captureId,
+  {
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    captureId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/payments/captures/${ encodeURIComponent(captureId) }`,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalCaptureGet,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalCaptureGet" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "captureId": "2GG279541U471931P"
+    }'
+*/

package/api/paypal/paypalCaptureRefund.js

@@ -0,0 +1,78 @@
+// https://developer.paypal.com/docs/api/payments/v2/#captures_refund
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['captureId'],
+]);
+
+/**
+ * Refund a captured payment. Optional `refund` body can include amount,
+ * invoice_id, note_to_payer, etc. Omit body (or pass {}) for a full refund.
+ */
+const paypalCaptureRefund = async (
+  credsPayload,
+  captureId,
+  {
+    refund,
+    prefer = 'return=representation',
+    requestId,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    captureId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const headers = {
+    Prefer: prefer,
+  };
+  if (requestId) {
+    headers['PayPal-Request-Id'] = requestId;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/v2/payments/captures/${ encodeURIComponent(captureId) }/refund`,
+      headers,
+      body: refund !== undefined ? refund : {},
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalCaptureRefund,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalCaptureRefund" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "captureId": "2GG279541U471931P",
+      "options": {
+        "refund": {
+          "amount": { "value": "10.00", "currency_code": "USD" }
+        }
+      }
+    }'
+*/

package/api/paypal/paypalOrderAuthorize.js

@@ -0,0 +1,69 @@
+// https://developer.paypal.com/docs/api/orders/v2/#orders_authorize
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderId'],
+]);
+
+const paypalOrderAuthorize = async (
+  credsPayload,
+  orderId,
+  {
+    body,
+    prefer = 'return=representation',
+    requestId,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const headers = {
+    Prefer: prefer,
+  };
+  if (requestId) {
+    headers['PayPal-Request-Id'] = requestId;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/v2/checkout/orders/${ encodeURIComponent(orderId) }/authorize`,
+      headers,
+      ...(body !== undefined ? { body } : { body: {} }),
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalOrderAuthorize,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalOrderAuthorize" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "orderId": "5O190127TN364715T"
+    }'
+*/

package/api/paypal/paypalOrderCapture.js

@@ -0,0 +1,69 @@
+// https://developer.paypal.com/docs/api/orders/v2/#orders_capture
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderId'],
+]);
+
+const paypalOrderCapture = async (
+  credsPayload,
+  orderId,
+  {
+    body,
+    prefer = 'return=representation',
+    requestId,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const headers = {
+    Prefer: prefer,
+  };
+  if (requestId) {
+    headers['PayPal-Request-Id'] = requestId;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/v2/checkout/orders/${ encodeURIComponent(orderId) }/capture`,
+      headers,
+      ...(body !== undefined ? { body } : { body: {} }),
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalOrderCapture,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalOrderCapture" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "orderId": "5O190127TN364715T"
+    }'
+*/

package/api/paypal/paypalOrderCreate.js

@@ -0,0 +1,81 @@
+// https://developer.paypal.com/docs/api/orders/v2/#orders_create
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['order'],
+]);
+
+/**
+ * Create a PayPal order.
+ * `order` is the full Orders v2 create payload, e.g.:
+ * {
+ *   intent: 'CAPTURE',
+ *   purchase_units: [{ amount: { currency_code: 'USD', value: '10.00' } }],
+ * }
+ */
+const paypalOrderCreate = async (
+  credsPayload,
+  order,
+  {
+    prefer = 'return=representation',
+    requestId,
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    order,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const headers = {
+    Prefer: prefer,
+  };
+  if (requestId) {
+    headers['PayPal-Request-Id'] = requestId;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/v2/checkout/orders',
+      headers,
+      body: order,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalOrderCreate,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalOrderCreate" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "order": {
+        "intent": "CAPTURE",
+        "purchase_units": [{
+          "amount": { "currency_code": "USD", "value": "10.00" }
+        }]
+      }
+    }'
+*/

package/api/paypal/paypalOrderGet.js

@@ -0,0 +1,57 @@
+// https://developer.paypal.com/docs/api/orders/v2/#orders_get
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { paypalClient } = require('../paypal/paypal.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderId'],
+]);
+
+const paypalOrderGet = async (
+  credsPayload,
+  orderId,
+  {
+    fetchClient = paypalClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/checkout/orders/${ encodeURIComponent(orderId) }`,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  paypalOrderGet,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/paypalOrderGet" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "paypal" },
+      "orderId": "5O190127TN364715T"
+    }'
+*/