@sails-pay/bachs 0.0.5 → 0.0.7

package/helpers/parameters.js

@@ -37,7 +37,8 @@ module.exports = {
   BACHS_SUCCESS_URL: {
     type: 'string',
     friendlyName: 'Success URL',
-    description: 'Default URL Bachs redirects to after pure checkout payment.'
+    description:
+      'Default URL Bachs redirects to after payment. Alias for returnUrl.'
   },
   BACHS_CANCEL_URL: {
     type: 'string',

package/helpers/payloads.js

@@ -65,6 +65,7 @@ function buildProductCart(items) {
 function buildCheckoutSessionPayload(inputs, adapterConfig = {}) {
   const productCollectionId =
     inputs.productCollectionId || inputs.productCollection
+  const productCart = buildProductCart(inputs.items)
   const checkoutData = inputs.checkoutData || {}
   const returnUrl =
     inputs.returnUrl ||
@@ -74,14 +75,20 @@ function buildCheckoutSessionPayload(inputs, adapterConfig = {}) {
 
   return withoutUndefined({
     customer: buildCustomerPayload(inputs),
-    product_cart: buildProductCart(inputs.items),
+    product_cart: productCart,
     product_collection_id: productCollectionId,
+    // A session prices itself with products or with a raw amount, never both.
+    pricing:
+      productCart || productCollectionId
+        ? undefined
+        : buildPricingPayload(inputs),
     billing_currency: inputs.billingCurrency,
     allowed_payment_method_types: inputs.allowedPaymentMethodTypes,
     return_url: returnUrl,
     cancel_url: inputs.cancelUrl || adapterConfig.cancelUrl,
     reference: inputs.reference,
     metadata: inputs.metadata || checkoutData.custom,
+    expires_in_minutes: inputs.expiresInMinutes,
     transfer_data: inputs.connect && {
       destination: inputs.connect.destination
     },
@@ -129,32 +136,6 @@ function buildPricingPayload(inputs) {
   })
 }
 
-function buildPureCheckoutPayload(inputs, adapterConfig = {}) {
-  const checkoutData = inputs.checkoutData || {}
-  const customer = inputs.customer || {}
-
-  return withoutUndefined({
-    pricing: buildPricingPayload(inputs),
-    customer_email:
-      inputs.customerEmail ||
-      inputs.email ||
-      customer.email ||
-      checkoutData.email,
-    customer_name:
-      inputs.customerName || inputs.name || customer.name || checkoutData.name,
-    success_url:
-      inputs.successUrl ||
-      inputs.returnUrl ||
-      adapterConfig.successUrl ||
-      adapterConfig.returnUrl,
-    cancel_url: inputs.cancelUrl || adapterConfig.cancelUrl,
-    reference: inputs.reference,
-    metadata: inputs.metadata || checkoutData.custom,
-    expires_in_minutes: inputs.expiresInMinutes,
-    simulated_outcome: inputs.simulatedOutcome
-  })
-}
-
 function buildRefundPayload(inputs) {
   return withoutUndefined({
     charge_id: inputs.chargeId,
@@ -170,7 +151,6 @@ function buildRefundPayload(inputs) {
 
 module.exports = {
   buildCheckoutSessionPayload,
-  buildPureCheckoutPayload,
   buildRefundPayload,
   buildProductCart,
   buildCustomerPayload,

package/helpers/validate-checkout-connect.js

@@ -20,7 +20,7 @@ function validateCheckoutConnect(connect, { isCheckoutSession }) {
   if (!isCheckoutSession) {
     return invalid(
       'connect',
-      'is only supported on product checkout sessions (items or productCollectionId).'
+      'is only supported on checkout sessions (items, productCollectionId, or pricing).'
     )
   }
 

package/machines/checkout.js

@@ -1,8 +1,5 @@
 const fetch = require('../helpers/fetch')
-const {
-  buildCheckoutSessionPayload,
-  buildPureCheckoutPayload
-} = require('../helpers/payloads')
+const { buildCheckoutSessionPayload } = require('../helpers/payloads')
 const validateCheckoutItems = require('../helpers/validate-checkout-items')
 const validateCheckoutConnect = require('../helpers/validate-checkout-connect')
 const parameters = require('../helpers/parameters')
@@ -46,8 +43,7 @@ module.exports = require('machine').build({
     },
     successUrl: {
       type: 'string',
-      description:
-        'URL Bachs redirects to after a pure checkout payment. Maps to success_url.'
+      description: 'Alias for returnUrl.'
     },
     cancelUrl: parameters.BACHS_CANCEL_URL,
     customer: {
@@ -96,23 +92,27 @@ module.exports = require('machine').build({
     },
     pricing: {
       type: 'ref',
-      description: 'Pure Checkout pricing object.'
+      description:
+        'Pricing for a checkout that sets its own price, instead of products.'
     },
     amount: {
       type: 'string',
-      description: 'Pure Checkout amount, e.g. "50.00".'
+      description:
+        'Amount for a checkout that sets its own price, e.g. "50.00".'
     },
     currency: {
       type: 'string',
-      description: 'Pure Checkout currency, e.g. "USD" or "NGN".'
+      description:
+        'Currency for a checkout that sets its own price, e.g. "USD" or "NGN".'
     },
     currencyOptions: {
       type: 'ref',
-      description: 'Pure Checkout per-currency amount overrides.'
+      description:
+        'Per-currency amount overrides for a checkout that sets its own price.'
     },
     expiresInMinutes: {
       type: 'number',
-      description: 'Pure Checkout expiry in minutes.'
+      description: 'Checkout expiry in minutes.'
     },
     simulatedOutcome: {
       type: 'string',
@@ -147,9 +147,17 @@ module.exports = require('machine').build({
     const hasProductCollection = Boolean(
       inputs.productCollectionId || inputs.productCollection
     )
-    const shouldUseCheckoutSession = hasItems || hasProductCollection
+    const hasPricing = Boolean(
+      inputs.pricing || inputs.amount !== undefined || inputs.currency
+    )
+    // Bachs checks out through sessions. A session takes products or a raw
+    // price, and it permits a split rather than requiring one, so a checkout
+    // that states its own amount and currency belongs here whether or not it
+    // pays a connected account.
+    const shouldUseCheckoutSession =
+      hasItems || hasProductCollection || hasPricing
 
-    if (shouldUseCheckoutSession && hasItems === hasProductCollection) {
+    if (hasItems && hasProductCollection) {
       return exits.invalidRequest({
         message:
           'Provide exactly one of items or productCollectionId for a Bachs checkout session.'
@@ -174,20 +182,21 @@ module.exports = require('machine').build({
       }
     }
 
-    const path = shouldUseCheckoutSession ? '/checkout-sessions' : '/checkouts'
-    const payload = shouldUseCheckoutSession
-      ? buildCheckoutSessionPayload(inputs, adapterConfig)
-      : buildPureCheckoutPayload(inputs, adapterConfig)
+    const payload = buildCheckoutSessionPayload(inputs, adapterConfig)
 
-    if (!shouldUseCheckoutSession && !payload.pricing) {
+    if (
+      !payload.product_cart &&
+      !payload.product_collection_id &&
+      !payload.pricing
+    ) {
       return exits.invalidRequest({
         message:
-          'Provide product items/productCollectionId or pure checkout pricing.'
+          'Provide items, productCollectionId, or pricing for a Bachs checkout.'
       })
     }
 
     try {
-      const checkout = await fetch(path, {
+      const checkout = await fetch('/checkout-sessions', {
         method: 'POST',
         apiKey: inputs.apiKey || adapterConfig.apiKey,
         baseUrl: inputs.baseUrl || adapterConfig.baseUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sails-pay/bachs",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Bachs adapter for Sails Pay",
   "main": "adapter.js",
   "scripts": {

package/test/checkout.test.js

@@ -112,7 +112,7 @@ test('checkout sends custom pricing and the buyer-selected amount', async () =>
   })
 })
 
-test('checkout preserves pure checkout behavior', async () => {
+test('checkout prices itself with amount and currency', async () => {
   const calls = []
 
   fetch.setFetchImplementation(async (url, options) => {
@@ -137,9 +137,13 @@ test('checkout preserves pure checkout behavior', async () => {
   })
 
   assert.equal(checkoutUrl, 'https://pay.bachs.io/c/pure')
-  assert.equal(calls[0].url, 'https://sandbox-api.bachs.io/v1/checkouts')
+  assert.equal(
+    calls[0].url,
+    'https://sandbox-api.bachs.io/v1/checkout-sessions'
+  )
   assert.equal(calls[0].options.headers['Idempotency-Key'], 'pure_123')
   assert.deepEqual(JSON.parse(calls[0].options.body), {
+    customer: {},
     pricing: {
       currency: 'USD',
       amount: '42.00'
@@ -405,6 +409,73 @@ test('checkout splits a checkout session with a connected account', async () =>
   assert.equal(body.connect, undefined)
 })
 
+test('checkout splits a product-less checkout session', async () => {
+  const calls = []
+
+  fetch.setFetchImplementation(async (url, options) => {
+    calls.push({ url, options })
+
+    return {
+      ok: true,
+      status: 201,
+      statusText: 'Created',
+      text: async () =>
+        JSON.stringify({ checkout_url: 'https://pay.bachs.io/c/raw-split' })
+    }
+  })
+
+  const checkoutUrl = await checkout({
+    apiKey: 'sk_sandbox_123',
+    amount: '10500.00',
+    currency: 'NGN',
+    billingCurrency: 'NGN',
+    customer: { email: 'sponsor@example.com' },
+    reference: 'sponsorship_2',
+    connect: { destination: 'acct_123', platformFee: '500.00' }
+  })
+
+  assert.equal(checkoutUrl, 'https://pay.bachs.io/c/raw-split')
+  assert.equal(
+    calls[0].url,
+    'https://sandbox-api.bachs.io/v1/checkout-sessions'
+  )
+
+  const body = JSON.parse(calls[0].options.body)
+  assert.deepEqual(body.pricing, { currency: 'NGN', amount: '10500.00' })
+  assert.deepEqual(body.transfer_data, { destination: 'acct_123' })
+  assert.equal(body.platform_fee, '500.00')
+  assert.equal(body.billing_currency, 'NGN')
+  assert.equal('product_cart' in body, false)
+})
+
+test('a self-priced checkout without connect still uses a checkout session', async () => {
+  const calls = []
+
+  fetch.setFetchImplementation(async (url, options) => {
+    calls.push({ url, options })
+
+    return {
+      ok: true,
+      status: 201,
+      statusText: 'Created',
+      text: async () =>
+        JSON.stringify({ checkout_url: 'https://pay.bachs.io/c/raw' })
+    }
+  })
+
+  await checkout({
+    apiKey: 'sk_sandbox_123',
+    amount: '10500.00',
+    currency: 'NGN',
+    customer: { email: 'sponsor@example.com' }
+  })
+
+  assert.equal(
+    calls[0].url,
+    'https://sandbox-api.bachs.io/v1/checkout-sessions'
+  )
+})
+
 test('checkout without connect sends no split fields', async () => {
   const calls = []
 
@@ -437,16 +508,6 @@ const invalidConnectCases = [
     field: 'connect',
     message: /must be an object/
   },
-  {
-    name: 'connect on a pure checkout',
-    inputs: {
-      amount: '10500.00',
-      currency: 'NGN',
-      connect: { destination: 'acct_123', platformFee: '500.00' }
-    },
-    field: 'connect',
-    message: /only supported on product checkout sessions/
-  },
   {
     name: 'connect without a destination',
     inputs: {

package/test/payloads.test.js

@@ -2,7 +2,6 @@ const test = require('node:test')
 const assert = require('node:assert/strict')
 const {
   buildCheckoutSessionPayload,
-  buildPureCheckoutPayload,
   buildRefundPayload,
   buildProductCart,
   normalizePricing
@@ -216,77 +215,6 @@ test('buildCheckoutSessionPayload maps productCollectionId and configured return
   })
 })
 
-test('buildPureCheckoutPayload maps amount checkout inputs to Bachs snake case', () => {
-  const payload = buildPureCheckoutPayload(
-    {
-      amount: '50.00',
-      currency: 'USD',
-      currencyOptions: {
-        NGN: '75000.00'
-      },
-      email: 'customer@example.com',
-      name: 'Jane Doe',
-      successUrl: 'https://example.com/success',
-      cancelUrl: 'https://example.com/cancel',
-      reference: 'order_9876',
-      metadata: {
-        orderId: '9876'
-      },
-      expiresInMinutes: 30,
-      simulatedOutcome: 'success'
-    },
-    {}
-  )
-
-  assert.deepEqual(payload, {
-    pricing: {
-      currency: 'USD',
-      amount: '50.00',
-      currency_options: {
-        NGN: '75000.00'
-      }
-    },
-    customer_email: 'customer@example.com',
-    customer_name: 'Jane Doe',
-    success_url: 'https://example.com/success',
-    cancel_url: 'https://example.com/cancel',
-    reference: 'order_9876',
-    metadata: {
-      orderId: '9876'
-    },
-    expires_in_minutes: 30,
-    simulated_outcome: 'success'
-  })
-})
-
-test('buildPureCheckoutPayload reuses advanced pricing normalization', () => {
-  const payload = buildPureCheckoutPayload({
-    pricing: {
-      type: 'custom',
-      currency: 'USD',
-      presetAmount: '10.00',
-      minimumAmount: '5.00',
-      maximumAmount: '100.00'
-    },
-    currencyOptions: {
-      NGN: '15000.00'
-    }
-  })
-
-  assert.deepEqual(payload, {
-    pricing: {
-      currency: 'USD',
-      price_type: 'custom',
-      preset_amount: '10.00',
-      minimum_amount: '5.00',
-      maximum_amount: '100.00',
-      currency_options: {
-        NGN: '15000.00'
-      }
-    }
-  })
-})
-
 test('buildRefundPayload maps refund inputs to Bachs snake case', () => {
   const payload = buildRefundPayload({
     chargeId: 'chr_123',