@fat-zebra/sdk 1.5.5 → 1.5.6

package/dist/sandbox/fatzebra.js.LICENSE.txt

@@ -0,0 +1 @@
+/** @license URI.js v4.4.1 (c) 2011 Gary Court. License: http://github.com/garycourt/uri-js */

package/dist/sca/index.js

@@ -93,8 +93,8 @@ class Sca {
             this._cardinal.setup(cardinalJwt);
         });
     }
-    perform3DS({ sessionID }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    perform3DS(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ sessionID }) {
             this.sessionId = sessionID;
             // Register handler. Called after OTP is entered on challenge prompt.
             this._cardinal.onPaymentValidated((data, error) => __awaiter(this, void 0, void 0, function* () {
@@ -178,6 +178,8 @@ class Sca {
                 session_id: this.sessionId,
                 challenge_window_size: this.challengeWindowSize,
                 hide_card_holder: this.paymentIntent.payment.hide_card_holder,
+                screen_height: window.screen.height,
+                screen_width: window.screen.width,
                 customer: this.customerProperties(this.customer),
             })).data;
         });

package/dist/sca/scenarios/enrollment.js

@@ -21,7 +21,7 @@ const enrollmentScenarios = [
         veresEnrolled: VEResEnrolled.BYPASSED,
         pares: null,
         outcome: {
-            success: false,
+            success: false, // no liability shift
             authenticationType: 'bypass',
             errorCode: ScaErrorCode.BYPASSED_AUTHENTICATION
         },
@@ -34,7 +34,7 @@ const enrollmentScenarios = [
         veresEnrolled: VEResEnrolled.UNABLE,
         pares: null,
         outcome: {
-            success: false,
+            success: false, // no liability shift
             errorCode: ScaErrorCode.AUTHENTICATION_NOT_AVAILABLE_ON_LOOKUP
         }
     },

package/dist/sca/scenarios/validation.js

@@ -34,7 +34,7 @@ const validationScenarios = [
         pares: PARes.CANCELED,
         outcome: {
             authenticationType: 'challenge',
-            success: false,
+            success: false, // no liability shift
             errorCode: ScaErrorCode.UNSUCCESSFUL_STEPUP_AUTHENTICATION
         }
     },
@@ -47,7 +47,7 @@ const validationScenarios = [
         pares: PARes.NOT_COMPLETED,
         outcome: {
             authenticationType: 'challenge',
-            success: false,
+            success: false, // no liability shift
             errorCode: ScaErrorCode.UNAVAILABLE_STEPUP_AUTHENTICATION
         }
     },
@@ -126,7 +126,7 @@ const validationScenarios = [
         pares: null,
         outcome: {
             authenticationType: 'challenge',
-            success: false,
+            success: false, // no liability shift
             errorCode: ScaErrorCode.UNSUCCESSFUL_STEPUP_AUTHENTICATION
         }
     },

package/dist/sca/types.d.ts

@@ -40,6 +40,8 @@ interface EnrollSCARequest {
     session_id: string;
     challenge_window_size: ChallengeWindowSize;
     hide_card_holder: boolean;
+    screen_height: number;
+    screen_width: number;
     customer?: {
         first_name?: string;
         last_name?: string;

package/dist/shared/env.development.d.ts

@@ -1,5 +1,5 @@
-declare const bridgeUrl = "http://paynow.test";
-declare const apiUrl = "http://api.test:3002/sdk";
-declare const payNowUrl = "http://paynow.test:3004";
+declare const bridgeUrl = "https://paynow.test";
+declare const apiUrl = "https://api.test/sdk";
+declare const payNowUrl = "https://paynow.test";
 declare const songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
 export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

package/dist/shared/env.development.js

@@ -1,5 +1,5 @@
-const bridgeUrl = "http://paynow.test";
-const apiUrl = "http://api.test:3002/sdk";
-const payNowUrl = "http://paynow.test:3004";
+const bridgeUrl = "https://paynow.test";
+const apiUrl = "https://api.test/sdk";
+const payNowUrl = "https://paynow.test";
 const songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
 export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

package/dist/shared/envs/local.d.ts

@@ -1,5 +1,5 @@
-declare const bridgeUrl = "http://paynow.test";
-declare const apiUrl = "http://api.test:3002/sdk";
-declare const payNowUrl = "http://paynow.test:3004";
+declare const bridgeUrl = "https://paynow.test";
+declare const apiUrl = "https://api.test:3002/sdk";
+declare const payNowUrl = "https://paynow.test";
 declare const songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
 export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

package/dist/shared/envs/local.js

@@ -1,5 +1,5 @@
-const bridgeUrl = "http://paynow.test";
-const apiUrl = "http://api.test:3002/sdk";
-const payNowUrl = "http://paynow.test:3004";
+const bridgeUrl = "https://paynow.test";
+const apiUrl = "https://api.test:3002/sdk";
+const payNowUrl = "https://paynow.test";
 const songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
 export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

package/dist/shared/event-manager.d.ts

@@ -23,7 +23,7 @@ interface ErrorEventDetail {
     errors: string[];
     data: any;
 }
-declare const emit: (event: PublicEvent, data: SuccessEventDetail | ErrorEventDetail, target?: HTMLElement | Window) => void;
+declare const emit: (event: PublicEvent, data?: SuccessEventDetail | ErrorEventDetail, target?: HTMLElement | Window) => void;
 declare const off: (event: PublicEvent, callback: (e: any) => void, target?: HTMLElement | Window) => void;
 declare const onOnce: (event: PublicEvent, callback: (e: any) => void, target?: HTMLElement | Window) => void;
 declare const on: (event: PublicEvent, callback: (e: any) => void, target?: HTMLElement | Window) => void;

package/dist/shared/post-message-client.d.ts

@@ -1,3 +1,4 @@
+import { Environment } from "./env";
 interface PostMessage {
     channel: string;
     subject: string;
@@ -11,6 +12,7 @@ interface PostMessageLegacy {
 }
 interface PostMessageClientConfig {
     channel: string;
+    environment?: Environment;
     target?: HTMLIFrameElement;
 }
 interface EventHandlers {

package/dist/shared/post-message-client.js

@@ -11,7 +11,7 @@ import env, { Environment } from "./env";
 class PostMessageClient {
     constructor(config) {
         this.channel = config.channel;
-        this.fzEnv = process.env.API_ENV;
+        this.fzEnv = config.environment || process.env.API_ENV;
         this.domain = env[this.fzEnv].payNowUrl;
         this.target = config.target;
     }

package/dist/shared/types.d.ts

@@ -1,5 +1,10 @@
 import { Environment } from './env';
+import { MerchantCapability, SupportedNetwork } from "../applepay/clients/apple-pay-client";
+declare enum Channel {
+    CLICK_TO_PAY = "click_to_pay"
+}
 declare enum PublicEvent {
+    HPP_READY = "fz.ready",
     FORM_VALIDATION_ERROR = "fz.form_validation.error",
     FORM_VALIDATION_SUCCESS = "fz.form_validation.success",
     VALIDATION_ERROR = "fz.validation.error",
@@ -11,7 +16,10 @@ declare enum PublicEvent {
     PAYMENT_ERROR = "fz.payment.error",
     BIN_LOOKUP = "fz.bin.lookup",
     CLICK_TO_PAY_TOKENIZATION_SUCCESS = "fz.click_to_pay.tokenization.success",
-    CLICK_TO_PAY_TOKENIZATION_ERROR = "fz.click_to_pay.tokenization.error"
+    CLICK_TO_PAY_TOKENIZATION_ERROR = "fz.click_to_pay.tokenization.error",
+    CLICK_TO_PAY_RESIZE = "fz.click_to_pay.resize",
+    CLICK_TO_PAY_DCF_LOADED = "fz.click_to_pay.dcf",
+    CLICK_TO_PAY_MRT = "fz.click_to_pay.mrt"
 }
 declare enum BridgeEvent {
     TOKENIZE_CARD_REQUEST = "fzi.tc_req",
@@ -22,7 +30,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",
+    CLICK_TO_PAY_REQUEST_MRT = "fzi.c2p.mrt_req",
+    CLICK_TO_PAY_RETURN_MRT = "fzi.c2p.mrt_ret"
 }
 declare enum PaymentMethodType {
     CARD = "card",
@@ -85,16 +95,25 @@ export type PaymentConfig = {
     paymentIntent: PaymentIntent;
     options: OptionalUrlValues;
 };
+export type ApplePayButtonType = 'buy' | 'donate' | 'plain' | 'set-up' | 'book' | 'check-out' | 'subscribe' | 'add-money' | 'contribute' | 'order' | 'reload' | 'rent' | 'support' | 'tip' | 'top-up' | 'continue';
+export type ApplePayButtonStyle = 'black' | 'white' | 'white-outline';
+export type ApplePayButtonLocale = 'ar-AB' | 'ca-ES' | 'cs-CZ' | 'da-DK' | 'de-DE' | 'el-GR' | 'en-AU' | 'en-GB' | 'en-US' | 'es-ES' | 'es-MX' | 'fi-FI' | 'fr-CA' | 'fr-FR' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'ms-MY' | 'nb-NO' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sv-SE' | 'th-TH' | 'tr-TR' | 'uk-UA' | 'vi-VN' | 'zh-CN' | 'zh-HK' | 'zh-TW';
 export type OptionalUrlValues = {
     hide_card_holder?: boolean;
     hide_button?: boolean;
     return_path?: string;
+    allowed_card_networks?: Array<SupportedNetwork>;
+    allowed_card_types?: Array<MerchantCapability>;
+    domain_name?: string;
     card_types?: Array<string>;
     surcharge_enabled?: string;
     sca_enabled?: boolean;
     css?: string;
     css_signature?: string;
     tokenize_only?: boolean;
+    apple_button_style?: ApplePayButtonStyle;
+    apple_button_type?: ApplePayButtonType;
+    apple_button_locale?: ApplePayButtonLocale;
 };
 declare global {
     interface Window {
@@ -102,6 +121,7 @@ declare global {
         Cardinal: any;
         FatZebra: any;
         HPP: any;
+        ApplePayButton: any;
         MerchantUsername: string;
     }
 }
@@ -137,5 +157,10 @@ type TokenizeCardResponse = {
     token: string;
     errors?: Array<string>;
 };
-export { BridgeEvent, PublicEvent, PaymentMethodType, };
-export type { PaymentMethod, PaymentIntent, Payment, Card, CardOnFile, CustomerSnakeCase, Customer, Handlers, ValidationResult, TokenizeCardResponse, };
+type ApplePayPaymentResponse = {
+    message: string;
+    errors?: Array<string>;
+    data?: string;
+};
+export { Channel, BridgeEvent, PublicEvent, PaymentMethodType, };
+export type { PaymentMethod, PaymentIntent, Payment, Card, CardOnFile, CustomerSnakeCase, Customer, Handlers, ValidationResult, TokenizeCardResponse, ApplePayPaymentResponse };

package/dist/shared/types.js

@@ -1,5 +1,10 @@
+var Channel;
+(function (Channel) {
+    Channel["CLICK_TO_PAY"] = "click_to_pay";
+})(Channel || (Channel = {}));
 var PublicEvent;
 (function (PublicEvent) {
+    PublicEvent["HPP_READY"] = "fz.ready";
     PublicEvent["FORM_VALIDATION_ERROR"] = "fz.form_validation.error";
     PublicEvent["FORM_VALIDATION_SUCCESS"] = "fz.form_validation.success";
     PublicEvent["VALIDATION_ERROR"] = "fz.validation.error";
@@ -12,6 +17,9 @@ var PublicEvent;
     PublicEvent["BIN_LOOKUP"] = "fz.bin.lookup";
     PublicEvent["CLICK_TO_PAY_TOKENIZATION_SUCCESS"] = "fz.click_to_pay.tokenization.success";
     PublicEvent["CLICK_TO_PAY_TOKENIZATION_ERROR"] = "fz.click_to_pay.tokenization.error";
+    PublicEvent["CLICK_TO_PAY_RESIZE"] = "fz.click_to_pay.resize";
+    PublicEvent["CLICK_TO_PAY_DCF_LOADED"] = "fz.click_to_pay.dcf";
+    PublicEvent["CLICK_TO_PAY_MRT"] = "fz.click_to_pay.mrt";
 })(PublicEvent || (PublicEvent = {}));
 var BridgeEvent;
 (function (BridgeEvent) {
@@ -24,10 +32,12 @@ 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["CLICK_TO_PAY_REQUEST_MRT"] = "fzi.c2p.mrt_req";
+    BridgeEvent["CLICK_TO_PAY_RETURN_MRT"] = "fzi.c2p.mrt_ret";
 })(BridgeEvent || (BridgeEvent = {}));
 var PaymentMethodType;
 (function (PaymentMethodType) {
     PaymentMethodType["CARD"] = "card";
     PaymentMethodType["CARD_ON_FILE"] = "card_on_file";
 })(PaymentMethodType || (PaymentMethodType = {}));
-export { BridgeEvent, PublicEvent, PaymentMethodType, };
+export { Channel, BridgeEvent, PublicEvent, PaymentMethodType, };

package/dist/validation/schemas/applepay/load-params.json

@@ -0,0 +1,31 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/applepay/load-params.json",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "containerId",
+        "paymentIntent"
+    ],
+    "properties": {
+        "containerId": {
+            "type": "string"
+        },
+        "environment": {
+            "type": "string",
+            "enum": [
+                "local",
+                "test",
+                "development",
+                "staging",
+                "sandbox",
+                "production"
+            ]
+        },
+        "paymentIntent": {
+            "$ref": "payment-intent.json#/definitions/PaymentIntent"
+        },
+        "options": {
+            "$ref": "options.json#/definitions/Options"
+        }
+    }
+}

package/dist/validation/schemas/applepay/options.json

@@ -0,0 +1,115 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/applepay/options.json",
+    "type": "object",
+    "definitions": {
+        "Options": {
+            "type": "object",
+            "properties": {
+                "allowed_card_networks": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "amex",
+                            "chinaUnionPay",
+                            "discover",
+                            "jcb",
+                            "maestro",
+                            "masterCard",
+                            "visa"
+                        ]
+                    }
+                },
+                "allowed_card_types": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "supports3DS",
+                            "supportsCredit",
+                            "supportsDebit",
+                            "supportsEMV"
+                        ]
+                    }
+                },
+                "apple_button_type": {
+                    "type": "string",
+                    "enum": [
+                        "buy",
+                        "donate",
+                        "plain",
+                        "set-up",
+                        "book",
+                        "check-out",
+                        "subscribe",
+                        "add-money",
+                        "contribute",
+                        "order",
+                        "reload",
+                        "rent",
+                        "support",
+                        "tip",
+                        "top-up",
+                        "continue"
+                    ]
+                },
+                "apple_button_style": {
+                    "type": "string",
+                    "enum": [
+                        "black",
+                        "white",
+                        "white-outline"
+                    ]
+                },
+                "apple_button_locale": {
+                    "type": "string",
+                    "enum": [
+                        "ar-AB",
+                        "ca-ES",
+                        "cs-CZ",
+                        "da-DK",
+                        "de-DE",
+                        "el-GR",
+                        "en-AU",
+                        "en-GB",
+                        "en-US",
+                        "es-ES",
+                        "es-MX",
+                        "fi-FI",
+                        "fr-CA",
+                        "fr-FR",
+                        "he-IL",
+                        "hi-IN",
+                        "hr-HR",
+                        "hu-HU",
+                        "id-ID",
+                        "it-IT",
+                        "ja-JP",
+                        "ko-KR",
+                        "ms-MY",
+                        "nb-NO",
+                        "nl-NL",
+                        "pl-PL",
+                        "pt-BR",
+                        "pt-PT",
+                        "ro-RO",
+                        "ru-RU",
+                        "sk-SK",
+                        "sv-SE",
+                        "th-TH",
+                        "tr-TR",
+                        "uk-UA",
+                        "vi-VN",
+                        "zh-CN",
+                        "zh-HK",
+                        "zh-TW"
+                    ]
+                },
+                "domain_name": {
+                    "type": "string"
+                }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/dist/validation/schemas/applepay/payment-intent.json

@@ -0,0 +1,42 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/applepay/payment-intent.json",
+    "type": "object",
+    "additionalProperties": false,
+    "definitions": {
+        "PaymentIntent": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "payment": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "amount",
+                        "currency",
+                        "reference"
+                    ],
+                    "properties": {
+                        "amount": {
+                            "type": "number",
+                            "minimum": 0
+                        },
+                        "currency": {
+                            "type": "string"
+                        },
+                        "reference": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "verification": {
+                    "type": "string",
+                    "minLength": 5
+                }
+            },
+            "required": [
+                "payment",
+                "verification"
+            ]
+        }
+    }
+}

package/dist/validation/schemas/click-to-pay/options.json

@@ -5,17 +5,47 @@
         "Options": {
             "type": "object",
             "properties": {
-                "hideConfirmButton": {
+                "auth": {
                     "type": "boolean"
                 },
-                "tokenizeOnly": {
-                    "type": "boolean"
+                "cardListButtonText": {
+                    "type": "string"
                 },
                 "css": {
                     "type": "string"
                 },
                 "cssSignature": {
                     "type": "string"
+                },
+                "displayName": {
+                    "type": "string"
+                },
+                "hideConfirmButton": {
+                    "type": "boolean"
+                },
+                "hideManualEntryLink": {
+                    "type": "boolean"
+                },
+                "mrt": {
+                    "type": "string"
+                },
+                "returnPath": {
+                    "type": "string"
+                },
+                "returnTarget": {
+                    "type": "string"
+                },
+                "saveCard": {
+                    "type": "boolean"
+                },
+                "sharedData": {
+                    "type": "string"
+                },
+                "submitPaymentButtonText": {
+                    "type": "string"
+                },
+                "tokenizeOnly": {
+                    "type": "boolean"
                 }
             }
         }

package/dist/validation/validators/apple-pay-load-params-button-validator.d.ts

@@ -0,0 +1,3 @@
+import Ajv from 'ajv';
+declare const validator: Ajv.ValidateFunction;
+export { validator as validateApplePayLoadParams };

package/dist/validation/validators/apple-pay-load-params-button-validator.js

@@ -0,0 +1,12 @@
+import Ajv from 'ajv';
+import paymentIntentSchema from '../schemas/applepay/payment-intent.json';
+import optionsSchema from '../schemas/applepay/options.json';
+import loadParams from '../schemas/applepay/load-params.json';
+const validator = new Ajv({
+    allErrors: true,
+    jsonPointers: true,
+})
+    .addSchema(paymentIntentSchema)
+    .addSchema(optionsSchema)
+    .compile(loadParams);
+export { validator as validateApplePayLoadParams };

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.5.4";
+export declare const version = "1.5.6";

package/dist/version.js

@@ -1 +1 @@
-export const version = '1.5.4';
+export const version = '1.5.6';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fat-zebra/sdk",
-  "version": "1.5.5",
+  "version": "1.5.6",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -23,6 +23,7 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@inquirer/prompts": "^5.3.8",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.0.0",
     "@testing-library/react-hooks": "^8.0.1",
@@ -30,6 +31,7 @@
     "@types/ajv": "^1.0.0",
     "@types/axios": "^0.14.0",
     "@types/dotenv": "^8.2.0",
+    "@types/inquirer": "^9.0.7",
     "@types/jest": "^24.0.23",
     "@types/jsdom": "^21.1.1",
     "@types/nock": "^11.1.0",
@@ -40,7 +42,6 @@
     "dotenv-webpack": "^8.0.0",
     "ejs": "^3.0.1",
     "html-webpack-plugin": "^5.3.1",
-    "inquirer": "^10.0.1",
     "jest": "^29.6.1",
     "jest-environment-jsdom": "^29.6.1",
     "jest-localstorage-mock": "^2.4.22",
@@ -71,4 +72,4 @@
     "react": ">= 16",
     "react-dom": ">= 16"
   }
-}
+}