@fat-zebra/sdk 1.5.10 → 1.5.11-beta.1

package/.github/workflows/ci.yml

@@ -8,7 +8,7 @@ env:
   PROD_CLOUDFRONT_ID: "E3348QX8Q2J4OV"
 on:
   push:
-    branches: ['main']    
+    branches: ['main']
     tags:
       - 'v*.*.*'           # prod tags e.g. v1.5.8
       - 'v*.*.*-beta.*'    # beta tags e.g. v1.5.8-beta.0
@@ -37,15 +37,11 @@ jobs:
     runs-on: ubuntu-latest
     env:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_CLOUDSMITH_REPO_PWD: ${{ secrets.CLOUDSMITH_API_KEY }}
     steps:
       - uses: actions/checkout@v4
       - uses: fatzebra/gh-workflows/build_npm@main
-        with:
-          credentials_json: |
-            {
-              "GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}",
-              "NPM_CLOUDSMITH_REPO_PWD": "${{ secrets.CLOUDSMITH_API_KEY }}"
-            }
       - name: Build (sandbox)
         run: npm run build:sandbox
       - uses: actions/upload-artifact@v4
@@ -62,15 +58,11 @@ jobs:
     runs-on: ubuntu-latest
     env:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_CLOUDSMITH_REPO_PWD: ${{ secrets.CLOUDSMITH_API_KEY }}
     steps:
       - uses: actions/checkout@v4
       - uses: fatzebra/gh-workflows/build_npm@main
-        with:
-          credentials_json: |
-            {
-              "GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}",
-              "NPM_CLOUDSMITH_REPO_PWD": "${{ secrets.CLOUDSMITH_API_KEY }}"
-            }
       - name: Build (production)
         run: npm run build:production
       - uses: actions/upload-artifact@v4
@@ -151,6 +143,15 @@ jobs:
             --id "${invalidation_id}"
           echo "Invalidation completed."
 
+  notify-sandbox-dispatch:
+    name: Notify (sandbox build)
+    needs: deploy-sandbox
+    if: github.ref_type == 'tag' && contains(github.ref_name, '-beta.')
+    uses: fatzebra/gh-workflows/.github/workflows/send_build_created.yml@main
+    with:
+      destination_repository: fatzebra/gazelle
+    secrets: inherit
+
   # Publish to npm for beta tags and production tags
   publish-npm-beta:
     runs-on: ubuntu-latest

package/.github/workflows/non-prod-ci.yml

@@ -35,15 +35,11 @@ jobs:
     runs-on: ubuntu-latest
     env:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_CLOUDSMITH_REPO_PWD: ${{ secrets.CLOUDSMITH_API_KEY }}
     steps:
       - uses: actions/checkout@v4
       - uses: fatzebra/gh-workflows/build_npm@main
-        with:
-          credentials_json: |
-            {
-              "GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}",
-              "NPM_CLOUDSMITH_REPO_PWD": "${{ secrets.CLOUDSMITH_API_KEY }}"
-            }
       - name: Build (staging)
         run: npm run build:staging
       - uses: actions/upload-artifact@v4

package/CODEOWNERS

@@ -0,0 +1 @@
+* @fatzebra/cx

package/README.dev.md

@@ -122,7 +122,7 @@ There are two npm build scripts in `package.json` for building javascript files.
 
 ## Deployment Pipeline
 
-The JS SDK gets built and delpoyed via buildkite https://buildkite.com/fat-zebra/fatzebra-js-sdk. The pipeline is defined in `.buildkite/pipeline.yml`
+The JS SDK gets built and delpoyed via github actions https://github.com/fatzebra/fatzebra-js/actions. The pipeline is defined in `.github/workflows/ci.yml`
 
 The deployed SDKs are available from the following URLs.
 
@@ -195,13 +195,16 @@ Staging is released automatically for each branch (on push)
 
 Sandbox deployment will trigger on the main branch and when pushing through a tag with beta in it.
 
-Running this on main will trigger sandbox deployment (as well as npm beta release): 
+Running this on main will trigger sandbox deployment (as well as npm beta release):
 
 ```shell
 git tag -a v1.5.10-beta.0 -m "Beta: 1.5.10-beta.0"
 git push origin v1.5.10-beta.0
 ```
 
+Additionally, the pipeline will trigger a cypress integration spec on sandbox which will run here: https://github.com/fatzebra/gazelle/actions
+Ensure this pipeline is green before deploying to production and then post a link of the outcome
+
 ## Production 
 
 Sandbox deployment will trigger on the main branch and when pushing through a tag WITHOUT beta in it.

package/dist/decorators.d.ts

@@ -0,0 +1 @@
+export declare function logMethod(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

package/dist/decorators.js

@@ -0,0 +1,35 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import axios from 'axios';
+import { getLoggerUsername, getTransactionReference } from "./logger-context";
+export function logMethod(target, propertyKey, descriptor) {
+    const originalMethod = descriptor.value;
+    const LOGGING_ENDPOINT = `${process.env.PAYNOW_BASE_URL}/log_sdk`;
+    descriptor.value = function (...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const username = getLoggerUsername();
+                const reference = getTransactionReference();
+                axios.post(LOGGING_ENDPOINT, {
+                    username,
+                    reference,
+                    method: propertyKey,
+                    arguments: args,
+                    timestamp: new Date().toISOString(),
+                });
+            }
+            catch (error) {
+                console.warn('Logging failed for sdk:', error);
+            }
+            return originalMethod.apply(this, args);
+        });
+    };
+    return descriptor;
+}

package/dist/hpp/hpp.d.ts

@@ -42,6 +42,7 @@ declare class Hpp {
     private customer;
     private username;
     private sca;
+    private newSca;
     private cardToken;
     private postMessageClient;
     private test;
@@ -49,6 +50,7 @@ declare class Hpp {
     private headlessLoaded;
     private headlessPreviouslyLoaded;
     private iframeLoaded;
+    private newThreedsFlow;
     constructor(config: HppModuleConfig);
     setListenersAndEmitReady(): void;
     load(config: HppLoadParams): void;

package/dist/hpp/hpp.js

@@ -1,9 +1,18 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import * as bridge from '../shared/bridge-client';
 import { LocalStorageAccessTokenKey } from '../shared/constants';
 import { emit, on } from '../shared/event-manager';
 import { PostMessageClient } from '../shared/post-message-client';
 import { BridgeEvent, PublicEvent, } from '../shared/types';
 import * as util from '../shared/util';
+import { logMethod } from "../decorators";
+import { setTransactionReference } from "../logger-context";
+import newSca from "../new_sca";
 const HPP_DEFAULT_OPTIONS = {
     enableSca: false,
     hideButton: false,
@@ -11,6 +20,7 @@ const HPP_DEFAULT_OPTIONS = {
 };
 class Hpp {
     constructor(config) {
+        this.newThreedsFlow = false;
         this.paymentIntent = config.paymentIntent;
         this.customer = config.customer;
         this.username = config.username;
@@ -20,25 +30,34 @@ class Hpp {
         this.headlessLoaded = false;
         this.headlessPreviouslyLoaded = false;
         this.iframeLoaded = false;
+        this.newSca = new newSca({ username: config.username, environment: process.env.API_ENV });
         this.postMessageClient = new PostMessageClient({
             channel: 'sca',
             target: this.iframe
         });
     }
     setListenersAndEmitReady() {
+        const message = {
+            channel: 'sca',
+            subject: BridgeEvent.READY,
+            data: {}
+        };
         if (this.headlessLoaded && this.iframeLoaded) {
             // initial headless load
             this.setCrossFramesEventListeners();
             this.setPublicEventListeners();
             emit(PublicEvent.HPP_READY);
+            this.iframe.contentWindow.postMessage(message, '*');
         }
         else if (this.headlessPreviouslyLoaded && this.iframeLoaded) {
+            this.iframe.contentWindow.postMessage(message, '*');
             // subsequent iframe loads after headless has been previously loaded
             // this caters for the SPA scenario
             emit(PublicEvent.HPP_READY);
         }
     }
     load(config) {
+        setTransactionReference(config.paymentIntent.payment.reference);
         this.hppOptions = config.options;
         const { el, isExisting } = bridge.load2(process.env.PAYNOW_BRIDGE_URL);
         this.headless = el;
@@ -112,6 +131,13 @@ class Hpp {
             if (this.hppOptions.tokenizeOnly)
                 return;
             if (this.hppOptions.enableSca) {
+                if (this.newThreedsFlow) {
+                    this.newSca.setup({ card_token: data.token, paymentIntent: this.paymentIntent }).then((data) => {
+                        console.log("result:", data);
+                        // continue with 3DS flow
+                    });
+                    return; // do not continue execution to old 3DS
+                }
                 this.sca.run({
                     cardToken: data.token,
                     customer: this.customer,
@@ -171,6 +197,9 @@ class Hpp {
                 data: data,
             });
         };
+        handlers[BridgeEvent.NEW_THREEDS_ENABLED] = (data) => {
+            this.newThreedsFlow = typeof data === "boolean" ? data : false;
+        };
         this.postMessageClient.setEventListeners(handlers);
     }
     setPublicEventListeners() {
@@ -204,4 +233,7 @@ class Hpp {
         this.headless.contentWindow.postMessage(message, '*');
     }
 }
+__decorate([
+    logMethod
+], Hpp.prototype, "createPurchase", null);
 export { Hpp, HPP_DEFAULT_OPTIONS, };

package/dist/logger-context.d.ts

@@ -0,0 +1,4 @@
+export declare function setLoggerUsername(username: string): void;
+export declare function setTransactionReference(reference: string): void;
+export declare function getLoggerUsername(): string | undefined;
+export declare function getTransactionReference(): string | undefined;

package/dist/logger-context.js

@@ -0,0 +1,14 @@
+let globalLoggerUsername;
+let globalTransactionReference;
+export function setLoggerUsername(username) {
+    globalLoggerUsername = username;
+}
+export function setTransactionReference(reference) {
+    globalTransactionReference = reference;
+}
+export function getLoggerUsername() {
+    return globalLoggerUsername;
+}
+export function getTransactionReference() {
+    return globalTransactionReference;
+}

package/dist/main.js

@@ -19,8 +19,10 @@ import { Hpp } from './hpp';
 import ClickToPay from './click_to_pay';
 import { validateApplePayLoadParams } from "./validation/validators/apple-pay-load-params-button-validator";
 import { ApplePay } from "./applepay";
+import { setLoggerUsername } from "./logger-context";
 export default class FatZebra {
     constructor(config) {
+        setLoggerUsername(config.username);
         this.fzConfig = config;
         window.MerchantUsername = config.username;
         this.gatewayClient = new GatewayClient({

package/dist/new_sca/index.d.ts

@@ -0,0 +1,11 @@
+import { Environment } from "../shared/env";
+import { setupProps, ThreeDSSetupResponse } from "../shared/new_gateway/types";
+declare class newSca {
+    private gatewayClient;
+    constructor({ username, environment }: {
+        username: string;
+        environment: Environment;
+    });
+    setup({ card_token, paymentIntent }: setupProps): Promise<ThreeDSSetupResponse>;
+}
+export default newSca;

package/dist/new_sca/index.js

@@ -0,0 +1,27 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import NewApiGatewayClient from "../shared/new_gateway/new-api-gateway-client";
+// The newSca class will handle the sca requests: setup, enrol, validate
+// The challenge flow will be handled in here
+class newSca {
+    constructor({ username, environment }) {
+        this.gatewayClient = new NewApiGatewayClient({
+            username,
+            environment
+        });
+    }
+    setup({ card_token, paymentIntent }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.gatewayClient.setup({ card_token, paymentIntent });
+            return result;
+        });
+    }
+}
+export default newSca;

package/dist/shared/new_gateway/new-api-gateway-client.d.ts

@@ -0,0 +1,16 @@
+import { AxiosResponse, AxiosInstance } from "axios";
+import { Environment } from "../env";
+import { setupProps } from "./types";
+export type GatewayClientProps = {
+    username: string;
+    environment?: Environment;
+};
+declare class NewGatewayClient {
+    username: string;
+    environment?: Environment;
+    client: AxiosInstance;
+    constructor({ username, environment }: GatewayClientProps);
+    /**************** SCA/3DS2 /****************/
+    setup({ card_token, paymentIntent }: setupProps): Promise<AxiosResponse<any, any, {}>>;
+}
+export default NewGatewayClient;

package/dist/shared/new_gateway/new-api-gateway-client.js

@@ -0,0 +1,42 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { RequestHeaderSdkVersion, RequestHeaderMerchantUsername, RequestTimeout, } from "../constants";
+import axios from "axios";
+import { getSdkVersionNumber } from "../util";
+import env, { Environment } from "../env";
+class NewGatewayClient {
+    constructor({ username, environment }) {
+        this.username = username;
+        this.environment = environment || Environment.sandbox;
+        const headers = {};
+        headers[RequestHeaderSdkVersion] = getSdkVersionNumber();
+        headers[RequestHeaderMerchantUsername] = this.username;
+        const client = axios.create({
+            baseURL: env[this.environment].apiUrl,
+            timeout: RequestTimeout,
+            headers,
+            responseType: "json",
+            transformResponse: [
+                function (response) {
+                    return typeof response === "string" ? JSON.parse(response) : response;
+                },
+            ]
+        });
+        this.client = client;
+    }
+    /**************** SCA/3DS2 /****************/
+    //
+    setup({ card_token, paymentIntent }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post("/three_d_secure/setup", Object.assign(Object.assign({ merchant_username: this.username, card_token }, paymentIntent.payment), { verification: paymentIntent.verification }));
+        });
+    }
+}
+export default NewGatewayClient;

package/dist/shared/new_gateway/types.d.ts

@@ -0,0 +1,27 @@
+import { PaymentIntent } from "../types";
+type ClientReferenceInformation = {
+    code: string;
+    partner?: {
+        developerId: string;
+    };
+};
+type ConsumerAuthenticationInformation = {
+    accessToken: string;
+    deviceDataCollectionUrl: string;
+    referenceId: string;
+    token: string;
+};
+interface ThreeDSSetupResponse {
+    data: {
+        clientReferenceInformation: ClientReferenceInformation;
+        consumerAuthenticationInformation: ConsumerAuthenticationInformation;
+        id: string;
+        status: "COMPLETED" | "PENDING" | "FAILED" | string;
+        submitTimeUtc: string;
+    };
+}
+type setupProps = {
+    card_token: string;
+    paymentIntent: PaymentIntent;
+};
+export type { ThreeDSSetupResponse, setupProps };

package/dist/shared/new_gateway/types.js

@@ -0,0 +1 @@
+export {};

package/dist/shared/types.d.ts

@@ -32,7 +32,9 @@ declare enum BridgeEvent {
     FORM_VALIDATION_ERROR = "fzi.form_validation_error",
     FORM_VALIDATION_SUCCESS = "fzi.form_validation_success",
     BIN_LOOKUP = "fzi.bin_lookup",
-    CLICK_TO_PAY_TOKENIZATION = "fzi.c2p.tc_res"
+    CLICK_TO_PAY_TOKENIZATION = "fzi.c2p.tc_res",
+    NEW_THREEDS_ENABLED = "fzi.new_threeds_enabled",
+    READY = "fzi.ready"
 }
 declare enum PaymentMethodType {
     CARD = "card",

package/dist/shared/types.js

@@ -34,6 +34,8 @@ var BridgeEvent;
     BridgeEvent["FORM_VALIDATION_SUCCESS"] = "fzi.form_validation_success";
     BridgeEvent["BIN_LOOKUP"] = "fzi.bin_lookup";
     BridgeEvent["CLICK_TO_PAY_TOKENIZATION"] = "fzi.c2p.tc_res";
+    BridgeEvent["NEW_THREEDS_ENABLED"] = "fzi.new_threeds_enabled";
+    BridgeEvent["READY"] = "fzi.ready";
 })(BridgeEvent || (BridgeEvent = {}));
 var PaymentMethodType;
 (function (PaymentMethodType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fat-zebra/sdk",
-  "version": "1.5.10",
+  "version": "1.5.11-beta.1",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -70,7 +70,7 @@
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.11.0",
+    "axios": "^1.12.0",
     "custom-event-polyfill": "^1.0.7",
     "ts-polyfill": "^3.8.2",
     "url-template": "^3.1.0"

package/tsconfig.json

@@ -6,6 +6,7 @@
     "noImplicitAny": true,
     "module": "commonjs",
     "esModuleInterop": true,
+    "experimentalDecorators": true,
     "resolveJsonModule": true,
     "jsx": "react",
     "target": "es5",

package/tsconfig.package.json

@@ -10,6 +10,7 @@
     "module": "esnext",
     "moduleResolution": "node",
     "resolveJsonModule": true,
+    "experimentalDecorators": true,
     "target": "es6",
     "lib": [
       "esnext",