@fat-zebra/sdk 1.0.2 → 1.0.3

package/src/sca/__tests__/index.test.ts

@@ -1,514 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import Sca, { ScaConfig, ScaRunProps } from '..'
-import {
-  Customer,
-  PaymentIntent,
-  PublicEvent,
-} from '../../shared/types'
-import { LocalStorageAccessTokenKey } from '../../shared/constants'
-import { mockRequest } from '../../../tests/helpers/api-gateway-mock'
-import * as nock from 'nock'
-import { CardinalManager } from '../cardinal'
-import { ChallengeWindowSize, EnrollSCARequest, ThreedsData } from '../types'
-import {
-  enrollmentScenarios,
-  EnrollmentScenario,
-} from '../scenarios'
-import GatewayClient from '../../shared/api-gateway-client'
-
-jest.mock('../cardinal')
-// mock module function
-const eventManager = require('../../shared/event-manager')
-eventManager.emit = jest.fn()
-
-interface ResponseOverride {
-  status: number
-  body: unknown
-}
-
-const mockCardinalManager = () => {
-  // @ts-ignore
-  CardinalManager.mockImplementation(() => {
-    return {
-      processBin: () => ['success'],
-      setup: () => true,
-      onPaymentSetupComplete: () => {
-        return {
-          sessionId: 'session_123'
-        }
-      },
-      onPaymentValidated: () => true,
-      continue: () => jest.fn()
-    }
-  })
-}
-
-const gatewayClient = new GatewayClient({
-  accessToken: "abc1234",
-  username: "TEST"
-})
-
-const scaTests = (config: ScaRunProps) => {
-  const { paymentIntent, cardToken, customer } = config
-
-  const requestCustomer = (customer: ScaRunProps['customer']): EnrollSCARequest['customer'] => {
-    let properties: EnrollSCARequest['customer'] = {};
-    if (!customer) return properties;
-    if (customer.firstName) properties.first_name = customer.firstName
-    if (customer.lastName) properties.last_name = customer.lastName
-    if (customer.email) properties.email = customer.email
-    if (customer.address) properties.address = customer.address
-    if (customer.city) properties.city = customer.city
-    if (customer.state) properties.state = customer.state
-    if (customer.postcode) properties.postcode = customer.postcode
-    if (customer.country) properties.country = customer.country
-    return properties
-  }
-
-  const enrollmentRequestBody: EnrollSCARequest = {
-    amount: paymentIntent.payment.amount,
-    card_token: cardToken,
-    currency: paymentIntent.payment.currency,
-    reference: paymentIntent.payment.reference,
-    hide_card_holder: paymentIntent.payment.hide_card_holder,
-    verification: paymentIntent.verification,
-    session_id: 'session_123',
-    challenge_window_size: ChallengeWindowSize.SIZE_FULL_PAGE,
-    customer: requestCustomer(customer),
-  }
-
-  const mockCreateSCASessionSuccess = () => {
-    mockRequest({
-      request: {
-        action: 'POST',
-        path: '/sca/session',
-        body: {
-          amount: paymentIntent.payment.amount,
-          currency: paymentIntent.payment.currency,
-          hide_card_holder: paymentIntent.payment.hide_card_holder,
-        }
-      },
-      response: {
-        status: 200,
-        body: {
-          data: {
-            jwt: 'thisisajwt'
-          }
-        }
-      }
-    })
-  }
-
-  const mockSCASession = (override?: ResponseOverride) => {
-    const responseBody = {
-      data: {
-        jwt: 'thisisajwt'
-      }
-    }
-
-    mockRequest({
-      request: {
-        action: 'POST',
-        path: '/sca/session',
-        body: {
-          amount: paymentIntent.payment.amount,
-          currency: paymentIntent.payment.currency,
-          hide_card_holder: paymentIntent.payment.hide_card_holder,
-        }
-      },
-      response: {
-        status: (override ? override.status : 200),
-        body: (override ? override.body : responseBody)
-      }
-    })
-  }
-
-  const mockSCAEnrollment = (override?: ResponseOverride) => {
-    const responseBody = {
-      data: {
-        action: {
-          proceed: true
-        },
-        version: '1.0',
-        enrolled: 'Y',
-        acs_url: '',
-        pareq: 'asdfasdf',
-        pares: '',
-        decision: 'ACCEPT',
-      }
-    }
-
-    mockRequest({
-      request: {
-        action: 'POST',
-        path: '/sca/enrollment',
-        body: enrollmentRequestBody
-      },
-      response: {
-        status: (override ? override.status : 200),
-        body: (override ? override.body : responseBody)
-      }
-    })
-  }
-
-  describe('SCA session failed', () => {
-    it('Emits fz.validation.error event with detail', async () => {
-
-      mockRequest({
-        request: {
-          action: 'POST',
-          path: '/sca/session',
-          body: {
-            amount: paymentIntent.payment.amount,
-            currency: paymentIntent.payment.currency,
-            hide_card_holder: paymentIntent.payment.hide_card_holder,
-          }
-        },
-        response: {
-          status: 422,
-          body: {
-            errors: ['Create SCA session error.']
-          }
-        }
-      })
-
-      mockSCAEnrollment()
-
-      const sca = new Sca({ gatewayClient })
-
-      await sca.run(config)
-
-      const eventDetail: any = {
-        detail: {
-          errors: ['FatZebra.3DS: JWT creation failed.'],
-          data: null
-        }
-      }
-      expect(eventManager.emit).toHaveBeenCalledTimes(1)
-      expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_ERROR)
-      expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-    })
-  })
-
-  describe('Bin processing failed', () => {
-    it('Emits fz.validation.error event without detail', async () => {
-      //@ts-ignore
-      CardinalManager.mockImplementation(() => {
-        return {
-          processBin: () => {
-            throw new Error('GG')
-          },
-          setup: () => true,
-          onPaymentSetupComplete: () => {
-            return {
-              sessionId: '123'
-            }
-          },
-          onPaymentValidated: () => true
-        }
-      })
-
-      mockCreateSCASessionSuccess()
-      mockSCAEnrollment()
-
-      const sca = new Sca({ gatewayClient })
-      sca.cardinal = new CardinalManager()
-      await sca.run(config)
-
-      const eventDetail: any = {
-        detail: {
-          errors: ['FatZebra.3DS: BIN verification failed.'],
-          data: null
-        }
-      }
-
-      expect(eventManager.emit).toHaveBeenCalledTimes(1)
-      expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_ERROR)
-      expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-    })
-  })
-
-  describe('3DS version 2', () => {
-    const scenarios = enrollmentScenarios.filter((item) => item.threedsVersion[0] == '2')
-
-    scenarios.forEach((scenario: EnrollmentScenario) => {
-      describe(`Enrollment: ${scenario.description}`, () => {
-        beforeEach(() => {
-          mockCardinalManager()
-          mockSCASession()
-          mockSCAEnrollment({
-            status: 200,
-            body: {
-              data: {
-                version: '2.1.0',
-                cavv: 'cavv',
-                eci: '05',
-                xid: 'xid',
-                pareq: 'pareq',
-                pares: scenario.pares,
-                enrolled: scenario.veresEnrolled,
-                reason_code: scenario.reasonCode,
-                directory_server_txn_id: 'txn123',
-                ucaf_collection_indicator: 'ucaf123',
-              }
-            }
-          })
-        })
-
-        it('SCA', async () => {
-          const sca = new Sca({ gatewayClient})
-          sca.cardinal = new CardinalManager()
-          const spy = jest.spyOn(sca.cardinal, 'continue')
-
-          await sca.run(config)
-
-          if (scenario.outcome.authenticationType === 'challenge') {
-            expect(spy).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit).toHaveBeenCalledTimes(0)
-            return
-          }
-
-          if (scenario.outcome.success) {
-            const eventDetail = {
-              detail: {
-                message: `FatZebra.3DS: 3DS success - ${scenario.description}.`,
-                data: {
-                  cavv: 'cavv',
-                  par: scenario.pares,
-                  sli: '05',
-                  xid: 'xid',
-                  ver: 'Y',
-                  threedsVersion: '2.1.0',
-                  directoryServerTxnId: 'txn123',
-                } as ThreedsData,
-              }
-            }
-            expect(eventManager.emit).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_SUCCESS)
-            expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-          } else {
-            const eventDetail = {
-              detail: {
-                errors: [`FatZebra.3DS: 3DS error - ${scenario.description}`],
-                data: {
-                  errorCode: scenario.outcome.errorCode
-                },
-              }
-            }
-            expect(eventManager.emit).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_ERROR)
-            expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-          }
-        })
-      })
-    })
-  })
-
-  describe('3DS version 1', () => {
-    const scenarios = enrollmentScenarios.filter((item) => item.threedsVersion[0] == '1')
-
-    scenarios.forEach((scenario: EnrollmentScenario) => {
-      describe(`Enrollment: ${scenario.description}`, () => {
-        beforeEach(() => {
-          mockCardinalManager()
-          mockSCASession()
-          mockSCAEnrollment({
-            status: 200,
-            body: {
-              data: {
-                version: '1.0.2',
-                cavv: 'cavv',
-                eci: '05',
-                xid: 'xid',
-                pareq: 'pareq',
-                pares: scenario.pares,
-                enrolled: scenario.veresEnrolled,
-                reason_code: scenario.reasonCode,
-                directory_server_txn_id: 'txn123',
-                ucaf_collection_indicator: 'ucaf123',
-              }
-            }
-          })
-        })
-
-        it('SCA', async () => {
-          const sca = new Sca({ gatewayClient })
-          sca.cardinal = new CardinalManager()
-          const spy = jest.spyOn(sca.cardinal, 'continue')
-
-          await sca.run(config)
-
-          if (scenario.outcome.authenticationType === 'challenge') {
-            expect(spy).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit).toHaveBeenCalledTimes(0)
-            return
-          }
-
-          if (scenario.outcome.success) {
-            const eventDetail = {
-              detail: {
-                message: `FatZebra.3DS: 3DS success - ${scenario.description}.`,
-                data: {
-                  cavv: 'cavv',
-                  par: scenario.pares,
-                  sli: '05',
-                  xid: 'xid',
-                  ver: scenario.veresEnrolled,
-                  threedsVersion: '1.0.2',
-                  directoryServerTxnId: 'txn123',
-                } as ThreedsData,
-              }
-            }
-            expect(eventManager.emit).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_SUCCESS)
-            expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-          } else {
-            const eventDetail = {
-              detail: {
-                errors: [`FatZebra.3DS: 3DS error - ${scenario.description}`],
-                data: {
-                  errorCode: scenario.outcome.errorCode
-                },
-              }
-            }
-            expect(eventManager.emit).toHaveBeenCalledTimes(1)
-            expect(eventManager.emit.mock.calls[0][0]).toBe(PublicEvent.SCA_ERROR)
-            expect(eventManager.emit.mock.calls[0][1]).toMatchObject(eventDetail.detail)
-          }
-        })
-      })
-    })
-  })
-}
-
-describe('Sca', () => {
-  beforeEach(() => {
-    jest.clearAllMocks()
-    nock.disableNetConnect()
-    nock.cleanAll()
-
-    mockCardinalManager()
-
-    localStorage.setItem(LocalStorageAccessTokenKey, 'TOKEN')
-  })
-
-  const bin = '400000'
-  const cardToken = 'token_12345'
-  const paymentIntent: PaymentIntent = {
-    payment: {
-      amount: 1000,
-      currency: 'AUD',
-      reference: 'ref_12345',
-      hide_card_holder: false,
-    },
-    verification: 'ver_12345'
-  }
-
-  describe('#run', () => {
-    describe('customer details: full', () => {
-      const customer: Customer = {
-        firstName: 'Ziggy',
-        lastName: 'Zebra',
-        email: 'ziggy.zebra@fatzebra.com',
-        address: '2/58-62 Kippax Street',
-        city: 'Surry Hills',
-        postcode: '2010',
-        state: 'NSW',
-        country: 'Australia'
-      }
-      const config = {
-        bin,
-        cardToken,
-        customer,
-        paymentIntent,
-      }
-
-      scaTests(config)
-    })
-
-    describe('customer details: partial', () => {
-      const customer: Customer = {
-        firstName: 'Ziggy',
-        lastName: '',
-        email: 'ziggy.zebra@fatzebra.com',
-        address: null,
-        city: undefined,
-        postcode: '',
-      }
-
-      const config = {
-        bin,
-        cardToken,
-        customer,
-        paymentIntent,
-      }
-
-      scaTests(config)
-    })
-
-    describe('customer details: empty', () => {
-      const customer: Customer = {}
-
-      const config = {
-        bin,
-        cardToken,
-        customer,
-        paymentIntent,
-      }
-
-      scaTests(config)
-    })
-
-    describe('no customer', () => {
-      const config = {
-        bin,
-        cardToken,
-        paymentIntent,
-      }
-
-      scaTests(config)
-    })
-  })
-
-  describe('#customerProperties', () => {
-    const sca = new Sca({ gatewayClient })
-
-    it('formats the property keys into snake_case', () => {
-      const customer: Customer = {
-        firstName: 'Ziggy',
-        lastName: 'Zebra',
-      }
-
-      const expectedProperties = {
-        first_name: 'Ziggy',
-        last_name: 'Zebra',
-      }
-
-      expect(sca.customerProperties(customer)).toEqual(expectedProperties)
-    })
-
-    it('only retains non-empty customer properties', () => {
-      const customer: Customer = {
-        firstName: 'Ziggy',
-        lastName: 'Zebra',
-        email: 'ziggy.zebra@fatzebra.com',
-        address: null,
-        city: null,
-        postcode: undefined,
-        state: undefined,
-        country: ''
-      }
-
-      const expectedProperties = {
-        first_name: 'Ziggy',
-        last_name: 'Zebra',
-        email: 'ziggy.zebra@fatzebra.com',
-      }
-
-      expect(sca.customerProperties(customer)).toEqual(expectedProperties)
-    })
-  })
-})

package/src/sca/cardinal.ts

@@ -1,136 +0,0 @@
-// https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/1409568/Configurations
-interface CardinalConfig {
-  timeout?: number
-  maxRequestRetries?: number
-  logging?: {
-    level: 'on' | 'off' | 'verbose'
-  }
-}
-
-interface CardinalContinueObject {
-  AcsUrl: string
-  Payload: string
-}
-
-interface CardinalOrderObject {
-  OrderDetails: {
-    TransactionId: string
-  }
-}
-
-interface CardinalSetupCompleteResponseData {
-  sessionId: string
-  modules: { module: string, loaded: boolean }[]
-}
-
-// https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/98315/Response+Objects
-interface PaymentValidatedResponseData {
-  Validated: boolean
-  ErrorNumber: number
-  ErrorDescription: string
-  ActionCode: 'SUCCESS' | 'NOACTION' | 'FAILURE' | 'ERROR'
-  Payment: {
-    OrderId: string
-    OrderNumber: string
-    ProcessorTransactionId: string
-    ReasonDescription: string
-  }
-}
-
-interface PaymentValidatedDTO {
-  processorTransactionId: string
-  jwt: string
-}
-
-enum CardinalWorkflow {
-  CCA = 'cca',
-  INIT = 'init',
-}
-
-enum CardinalPaymentEvent {
-  SETUP_COMPLETE = 'payments.setupComplete',
-  VALIDATED = 'payments.validated',
-}
-
-interface Cardinal {
-  configure(config: CardinalConfig): void
-  continue(
-    workflow: CardinalWorkflow,
-    data: CardinalContinueObject,
-    order: CardinalOrderObject
-  ): void
-  on(event: string, callback: (...data: any[]) => void): void
-  setup(workflow: CardinalWorkflow, data: any): void
-  trigger(event: string, cardBin: string): Promise<any>
-}
-
-interface ScaResult {
-  success: boolean
-  type: 'frictionless' | 'challenge' | 'none'
-  error: string
-}
-
-const defaultConfig = {
-  timeout: 8000,
-  maxRequestRetries: 3,
-  logging: {
-    level: 'on'
-  }
-}
-
-export default class CardinalManager {
-  private cardinal: Cardinal
-
-  constructor(config?: CardinalConfig) {
-    window.Cardinal.configure((config ? config : defaultConfig as CardinalConfig))
-  }
-
-  setup(jwt: any): void {
-    window.Cardinal.setup(CardinalWorkflow.INIT, { jwt })
-  }
-
-  onPaymentValidated(handler: (data: PaymentValidatedDTO, error: string) => void): void {
-    window.Cardinal.on('payments.validated', (data: PaymentValidatedResponseData, jwt: string) => {
-      if (data.ErrorDescription.toLowerCase() === 'success') {
-        handler({
-          processorTransactionId: data.Payment.ProcessorTransactionId,
-          jwt
-        }, null)
-      } else {
-        handler(null, data.ErrorDescription)
-      }
-    })
-  }
-
-  onPaymentSetupComplete(): Promise<CardinalSetupCompleteResponseData> {
-    return new Promise((resolve, reject) => {
-      window.Cardinal.on(CardinalPaymentEvent.SETUP_COMPLETE, (data: CardinalSetupCompleteResponseData) => {
-        resolve(data)
-      })
-    })
-  }
-
-  async processBin(bin: string): Promise<any> {
-    await window.Cardinal.trigger('bin.process', bin)
-  }
-
-  continue(acsUrl: string, pareq: string, transactionId: string) {
-    window.Cardinal.continue(
-      CardinalWorkflow.CCA,
-      {
-        AcsUrl: acsUrl,
-        Payload: pareq
-      },
-      {
-        OrderDetails: {
-          TransactionId: transactionId
-        }
-      }
-    )
-  }
-}
-
-export {
-  CardinalManager
-}
-export type { PaymentValidatedDTO }

package/src/sca/eci-mappings.ts

@@ -1,63 +0,0 @@
-// FatZebra only supports SLI 05, 06, 07 & 09.
-// https://docs.fatzebra.com/docs/3d-secure
-// Cardinal returns ECI(or SLI for MC) in the range of 01~07
-// https://cardinaldocs.atlassian.net/wiki/spaces/CCen/pages/903577725/EMV+3DS+2.0+Test+Cases
-const eciMappings: { vendorEci: string, fatzebraSli: string }[] = [
-  {
-    // Cards: Mastercard, CB Mastercard
-    // Test Case 2: Failed Frictionless Authentication
-    // Test Case 4: Unavailable Frictionless Authentication from the Issuer
-    // Test Case 5: Rejected Frictionless Authentication by the Issuer
-    // Test Case 6: Authentication Not Available on Lookup
-    // Test Case 7: Error on Lookup
-    // Test Case 9: Bypassed Authentication
-    // Test Case 11: Failed Step Up Authentication
-    // Test Case 12: Step Up Authentication is Unavailable
-    // Test Case 13: Error on Authentication
-    vendorEci: '00',
-    // Non-authenticated transaction - issuer not support. CAVV not present.
-    fatzebraSli: '07',
-  },
-  {
-    // Cards: Mastercard, CB Mastercard
-    // Test Case 3: Attempts Stand-In Frictionless Authentication
-    vendorEci: '01',
-    // Cards: Visa, American Express, Discover (Diners Club), CB Visa, ELO
-    // Secure, Non-authenticated transaction (XID present, CAVV not present)
-    fatzebraSli: '06',
-  },
-  {
-    // Cards: Mastercard, CB Mastercard
-    // Test Case 1: Successful Frictionless Authentication
-    // Test Case 10: Successful Step Up Authentication
-    vendorEci: '02',
-    // Cards: Visa, American Express, Discover (Diners Club), CB Visa, ELO
-    // Secure, Authenticated transaction with XID and CAVV present
-    fatzebraSli: '05',
-  },
-  {
-    vendorEci: '05',
-    // Secure, Authenticated transaction with XID and CAVV present
-    fatzebraSli: '05',
-  },
-  {
-    vendorEci: '06',
-    // Secure, Non-authenticated transaction (XID present, CAVV not present)
-    fatzebraSli: '06',
-  },
-  {
-    vendorEci: '07',
-    // Secure, Non-authenticated transaction (XID and CAVV not present). This is the default value.
-    fatzebraSli: '07',
-  },
-]
-
-const toFzSli = (vendorEci: string): string => {
-  const matched = eciMappings.find((item) => item.vendorEci == vendorEci)
-  return matched ? matched.fatzebraSli : vendorEci
-}
-
-export {
-  eciMappings,
-  toFzSli,
-}