@fat-zebra/sdk 1.0.6 → 1.2.2

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

@@ -7,10 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { RequestHeaderSdkVersion, RequestHeaderMerchantUsername, RequestTimeout, } from "./constants";
+import { RequestHeaderSdkVersion, RequestHeaderMerchantUsername, RequestTimeout, LongRequestTimeout, } from "./constants";
 import axios from "axios";
 import { getSdkVersionNumber } from "./util";
-import * as env from "../shared/env";
+const baseUrl = process.env.API_GATEWAY_URL;
 class GatewayClient {
     constructor({ accessToken, username }) {
         const headers = {};
@@ -18,7 +18,7 @@ class GatewayClient {
         headers[RequestHeaderSdkVersion] = getSdkVersionNumber();
         headers[RequestHeaderMerchantUsername] = username;
         this.client = axios.create({
-            baseURL: env.apiUrl,
+            baseURL: baseUrl,
             timeout: RequestTimeout,
             headers,
             responseType: "json",
@@ -57,5 +57,39 @@ class GatewayClient {
             return this.client.get(`/credit_cards/${data.card_token}`);
         });
     }
+    /**************** PayPal /****************/
+    createPayPalOrder(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post("/paypal/orders", data, {
+                timeout: LongRequestTimeout,
+            });
+        });
+    }
+    capturePayPalOrder(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post(`/paypal/orders/${data.id}/capture`, null, {
+                timeout: LongRequestTimeout,
+            });
+        });
+    }
+    authorizePayPalOrder(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post(`/paypal/orders/${data.id}/authorize`, null, {
+                timeout: LongRequestTimeout,
+            });
+        });
+    }
+    createPayPalBillingAgreement(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post("/paypal/billing_agreements", data, {
+                timeout: LongRequestTimeout,
+            });
+        });
+    }
+    approvePayPalBillingAgreement(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.post(`/paypal/billing_agreements/${data.id}/approve`, null, { timeout: LongRequestTimeout });
+        });
+    }
 }
 export default GatewayClient;

package/dist/shared/env.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";
+declare const payNowUrl = "http://paynow.test:3004";
 declare const songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
 export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

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

@@ -0,0 +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 songbirdUrl = "https://songbirdstag.cardinalcommerce.com/edge/v1/songbird.js";
+export { bridgeUrl, apiUrl, payNowUrl, songbirdUrl };

package/dist/shared/env.development.js

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

package/dist/shared/env.js

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

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

@@ -26,4 +26,4 @@ interface ErrorEventDetail {
 declare const emit: (event: PublicEvent, data: SuccessEventDetail | ErrorEventDetail, target?: HTMLElement | Window) => void;
 declare const on: (event: PublicEvent, callback: (e: any) => void, target?: HTMLElement | Window) => void;
 export { emit, on };
-export type { EventData };
+export type { EventData, SuccessEventDetail, ErrorEventDetail };

package/dist/shared/event-manager.js

@@ -1,4 +1,3 @@
-// TODO: CustomEvent requires polyfill for IE.
 const emit = (event, data, target = window) => {
     target.dispatchEvent(new CustomEvent(event, { detail: data }));
 };

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

@@ -44,5 +44,5 @@ declare class PostMessageClient {
     setEventListenersLegacy(handlers: EventHandlers): void;
     send(message: PostMessage | PostMessageLegacy): void;
 }
-export { PostMessageClient };
+export { PostMessageClient, };
 export type { CreateCardTokenPostMessageData, CreatePurchasePostMessageData, PostMessage, PostMessageLegacy, PostMessageClientConfig };

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

@@ -8,8 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { NODE_ENV } from '../shared/types';
-import * as env from "./env";
-const domain = env.payNowUrl;
+const domain = process.env.PAYNOW_BASE_URL;
 // NODE_ENV is introduced to PostMessageClient purely for the purpose of bypassing security
 // check on the postMessage event between parent and child frames. Unforunately there is
 // no workaround to override event origin due to lack of support in existing test framework.
@@ -67,4 +66,4 @@ class PostMessageClient {
         this.target.contentWindow.postMessage(message, domain);
     }
 }
-export { PostMessageClient };
+export { PostMessageClient, };

package/dist/shared/types.d.ts

@@ -1,3 +1,4 @@
+import { PayPalPaymentMethod } from '../paypal/types';
 declare enum NODE_ENV {
     LOCALDEV = "localdev",
     PRODUCTION = "production",
@@ -15,6 +16,10 @@ declare enum PublicEvent {
     TOKENIZATION_ERROR = "fz.tokenization.error",
     PAYMENT_SUCCESS = "fz.payment.success",
     PAYMENT_ERROR = "fz.payment.error",
+    PAYPAL_CANCEL = "fz.paypal.cancel",
+    PAYPAL_SUCCESS = "fz.paypal.success",
+    PAYPAL_ERROR = "fz.paypal.error",
+    PAYPAL_PROCESSESING = "fz.paypal.processing",
     BIN_LOOKUP = "fz.bin.lookup"
 }
 declare enum BridgeEvent {
@@ -29,7 +34,9 @@ declare enum BridgeEvent {
 }
 declare enum PaymentMethodType {
     CARD = "card",
-    CARD_ON_FILE = "card_on_file"
+    CARD_ON_FILE = "card_on_file",
+    PAYPAL_ORDER = "paypal_order",
+    PAYPAL_BILLING = "paypal_billing"
 }
 interface Card {
     number: string;
@@ -65,7 +72,7 @@ interface Payment {
     amount: number;
     currency: string;
     reference: string;
-    hide_card_holder?: boolean;
+    hide_card_holder: boolean;
 }
 interface PaymentIntent {
     payment: Payment;
@@ -73,36 +80,40 @@ interface PaymentIntent {
 }
 interface PaymentMethod {
     type?: PaymentMethodType;
-    data: Card | CardOnFile;
+    data: Card | CardOnFile | PayPalPaymentMethod;
 }
 interface ValidationResult {
     valid: boolean;
     errors: string[];
 }
-type TokenizeCardResponse = {
-    bin: string;
-    token: string;
-    errors?: Array<string>;
-};
 type Callback = (event: any) => void;
-type Handlers = Partial<Record<PublicEvent, Callback>>;
-export type VerificationConfig = {
+type Handlers = Partial<Record<PublicEvent, Callback | null>>;
+export type PaymentConfig = {
+    username: string;
     accessToken: string;
     paymentIntent: PaymentIntent;
-    verification: string;
-    options?: Options;
+    options: OptionalUrlValues;
 };
-export type PaymentConfig = {
-    accessToken: string;
-    payment: PaymentIntent;
-    options: Options;
+export type OptionalUrlValues = {
+    hide_card_holder?: string;
+    return_path?: string;
+    card_types?: Array<string>;
+    surcharge_enabled?: string;
+    sca_enabled?: boolean;
+    css?: string;
+    css_signature?: string;
+    tokenize_only?: boolean;
 };
-type Options = Partial<{
-    css: string;
-    cssSignature: string;
-    enableSca: boolean;
-    tokenizeOnly: boolean;
-}>;
+declare global {
+    interface Window {
+        ApplePaySession: any;
+        Cardinal: any;
+        FatZebra: any;
+        paypal: any;
+        HPP: any;
+        MerchantUsername: string;
+    }
+}
 export type TransactionPayload = {
     transactionId: string;
     responseCode: string;
@@ -130,14 +141,10 @@ export type CreatePaymentResponse = {
     v: TransactionPayload["verification"];
     errors?: Array<string>;
 };
-declare global {
-    interface Window {
-        ApplePaySession: any;
-        Cardinal: any;
-        FatZebra: any;
-        HPP: any;
-        MerchantUsername: string;
-    }
-}
-export { BridgeEvent, PublicEvent, NODE_ENV, PaymentMethodType };
-export type { Card, CardOnFile, Customer, CustomerSnakeCase, Handlers, Payment, PaymentIntent, PaymentMethod, TokenizeCardResponse, ValidationResult };
+type TokenizeCardResponse = {
+    bin: string;
+    token: string;
+    errors?: Array<string>;
+};
+export { BridgeEvent, PublicEvent, NODE_ENV, PaymentMethodType, };
+export type { PaymentMethod, PaymentIntent, Payment, Card, CardOnFile, CustomerSnakeCase, Customer, Handlers, ValidationResult, TokenizeCardResponse, };

package/dist/shared/types.js

@@ -17,6 +17,10 @@ var PublicEvent;
     PublicEvent["TOKENIZATION_ERROR"] = "fz.tokenization.error";
     PublicEvent["PAYMENT_SUCCESS"] = "fz.payment.success";
     PublicEvent["PAYMENT_ERROR"] = "fz.payment.error";
+    PublicEvent["PAYPAL_CANCEL"] = "fz.paypal.cancel";
+    PublicEvent["PAYPAL_SUCCESS"] = "fz.paypal.success";
+    PublicEvent["PAYPAL_ERROR"] = "fz.paypal.error";
+    PublicEvent["PAYPAL_PROCESSESING"] = "fz.paypal.processing";
     PublicEvent["BIN_LOOKUP"] = "fz.bin.lookup";
 })(PublicEvent || (PublicEvent = {}));
 var BridgeEvent;
@@ -34,5 +38,7 @@ var PaymentMethodType;
 (function (PaymentMethodType) {
     PaymentMethodType["CARD"] = "card";
     PaymentMethodType["CARD_ON_FILE"] = "card_on_file";
+    PaymentMethodType["PAYPAL_ORDER"] = "paypal_order";
+    PaymentMethodType["PAYPAL_BILLING"] = "paypal_billing";
 })(PaymentMethodType || (PaymentMethodType = {}));
-export { BridgeEvent, PublicEvent, NODE_ENV, PaymentMethodType };
+export { BridgeEvent, PublicEvent, NODE_ENV, PaymentMethodType, };

package/dist/validation/index.d.ts

@@ -0,0 +1,3 @@
+export { validateHppLoadParams } from './validators/hpp-load-params-validator';
+export { validateVerifyCardParams } from './validators/verify-card-params-validator';
+export { toHumanizedErrors } from './validation-helper';

package/dist/validation/index.js

@@ -0,0 +1,3 @@
+export { validateHppLoadParams } from './validators/hpp-load-params-validator';
+export { validateVerifyCardParams } from './validators/verify-card-params-validator';
+export { toHumanizedErrors } from './validation-helper';

package/dist/validation/schemas/customer.json

@@ -0,0 +1,38 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/customer.json",
+    "type": "object",
+    "definitions": {
+        "Customer": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "firstName": {
+                    "type": "string"
+                },
+                "lastName": {
+                    "type": "string"
+                },
+                "email": {
+                    "type": "string",
+                    "format": "email"
+                },
+                "address": {
+                    "type": "string"
+                },
+                "city": {
+                    "type": "string"
+                },
+                "postcode": {
+                    "type": "string"
+                },
+                "state": {
+                    "type": "string"
+                },
+                "country": {
+                    "type": "string"
+                }
+            },
+            "required": []
+        }
+    }
+}

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

@@ -0,0 +1,40 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/hpp-load-params.json",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "containerId",
+        "paymentIntent"
+    ],
+    "properties": {
+        "version": {
+            "type": "number"
+        },
+        "containerId": {
+            "type": "string"
+        },
+        "customer": {
+            "$ref": "customer.json#/definitions/Customer"
+        },
+        "paymentIntent": {
+            "$ref": "payment-intent.json#/definitions/PaymentIntent"
+        },
+        "options": {
+            "$ref": "hpp-options.json#/definitions/HppOptions"
+        }
+    },
+    "if": {
+        "properties": {
+            "options": {
+                "propertes": {
+                    "tokenizeOnly": {
+                        "boolean": true
+                    }
+                }
+            }
+        }
+    },
+    "else": {
+        "required": []
+    }
+}

package/dist/validation/schemas/hpp-options.json

@@ -0,0 +1,48 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/hpp-options.json",
+    "type": "object",
+    "definitions": {
+        "HppOptions": {
+            "type": "object",
+            "properties": {
+                "buttonText": {
+                    "type": "string"
+                },
+                "cards": {
+                    "type": "string"
+                },
+                "challengeWindowSize": {
+                    "type": "string",
+                    "enum": ["01", "02", "03", "04", "05"]
+                },
+                "css": {
+                    "type": "string"
+                },
+                "cssSignature": {
+                    "type": "string"
+                },
+                "enableSca": {
+                    "type": "boolean"
+                },
+                "hideButton": {
+                    "type": "boolean"
+                },
+                "hideLogos": {
+                    "type": "boolean"
+                },
+                "logoUrl": {
+                    "type": "string"
+                },
+                "showEmail": {
+                    "type": "boolean"
+                },
+                "showExtras": {
+                    "type": "boolean"
+                },
+                "tokenizeOnly": {
+                    "type": "boolean"
+                }
+            }
+        }
+    }
+}

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

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

package/dist/validation/schemas/payment-method.json

@@ -0,0 +1,83 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/payment-method.json",
+    "type": "object",
+    "definitions": {
+        "PaymentMethod": {
+            "type": "object",
+            "oneOff": [{
+                    "properties": {
+                        "type:": {
+                            "const": "card"
+                        },
+                        "data": {
+                            "type": "object",
+                            "properties": {
+                                "number": {
+                                    "type": "string"
+                                },
+                                "holder": {
+                                    "type": "string"
+                                },
+                                "expiryMonth": {
+                                    "type": "string",
+                                    "enum": [
+                                        "01",
+                                        "02",
+                                        "03",
+                                        "04",
+                                        "05",
+                                        "06",
+                                        "07",
+                                        "08",
+                                        "09",
+                                        "10",
+                                        "11",
+                                        "12"
+                                    ]
+                                },
+                                "expiryYear": {
+                                    "type": "string",
+                                    "maxLength": 4
+                                },
+                                "cvv": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "number",
+                                "holder",
+                                "expiryMonth",
+                                "expiryYear",
+                                "cvv"
+                            ]
+                        }
+                    },
+                    "required": [
+                        "type",
+                        "data"
+                    ]
+                }, {
+                    "properties": {
+                        "type:": {
+                            "const": "card_on_file"
+                        },
+                        "data": {
+                            "type": "object",
+                            "properties": {
+                                "token": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "token"
+                            ]
+                        }
+                    },
+                    "required": [
+                        "type",
+                        "data"
+                    ]
+                }]
+        }
+    }
+}

package/dist/validation/schemas/verify-card-options.json

@@ -0,0 +1,15 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/verify-card-options.json",
+    "type": "object",
+    "definitions": {
+        "VerifyCardOptions": {
+            "type": "object",
+            "properties": {
+                "challengeWindowSize": {
+                    "type": "string",
+                    "enum": ["01", "02", "03", "04", "05"]
+                }
+            }
+        }
+    }
+}

package/dist/validation/schemas/verify-card-params.json

@@ -0,0 +1,24 @@
+{
+    "$id": "https://www.fatzebra.com/schemas/hpp-load-params.json",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "customer",
+        "paymentIntent",
+        "paymentMethod"
+    ],
+    "properties": {
+        "customer": {
+            "$ref": "customer.json#/definitions/Customer"
+        },
+        "paymentIntent": {
+            "$ref": "payment-intent.json#/definitions/PaymentIntent"
+        },
+        "paymentMethod": {
+            "$ref": "payment-method.json#/definitions/PaymentMethod"
+        },
+        "options": {
+            "$ref": "verify-card-options.json#/definitions/VerifyCardOptions"
+        }
+    }
+}

package/dist/validation/validation-helper.d.ts

@@ -0,0 +1,3 @@
+import { ErrorObject } from 'ajv';
+declare const toHumanizedErrors: (errors: ErrorObject[]) => string[];
+export { toHumanizedErrors };

package/dist/validation/validation-helper.js

@@ -0,0 +1,6 @@
+const toHumanizedErrors = (errors) => {
+    return errors.map((e) => {
+        return e.dataPath == '' ? e.message : `${e.dataPath} ${e.message}`;
+    });
+};
+export { toHumanizedErrors };

package/dist/validation/validators/hpp-load-params-validator.d.ts

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

package/dist/validation/validators/hpp-load-params-validator.js

@@ -0,0 +1,14 @@
+import Ajv from 'ajv';
+import customerSchema from '../schemas/customer.json';
+import paymentIntentSchema from '../schemas/payment-intent.json';
+import hppOptionsSchema from '../schemas/hpp-options.json';
+import hppLoadParamsSchema from '../schemas/hpp-load-params.json';
+const validator = new Ajv({
+    allErrors: true,
+    jsonPointers: true,
+})
+    .addSchema(customerSchema)
+    .addSchema(paymentIntentSchema)
+    .addSchema(hppOptionsSchema)
+    .compile(hppLoadParamsSchema);
+export { validator as validateHppLoadParams };

package/dist/validation/validators/verify-card-params-validator.d.ts

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

package/dist/validation/validators/verify-card-params-validator.js

@@ -0,0 +1,16 @@
+import Ajv from 'ajv';
+import customerSchema from '../schemas/customer.json';
+import paymentIntentSchema from '../schemas/payment-intent.json';
+import paymentMethodSchema from "../schemas/payment-method.json";
+import verifyCardOptionsSchema from "../schemas/verify-card-options.json";
+import verifyCardParamsSchema from "../schemas/verify-card-params.json";
+const validator = new Ajv({
+    allErrors: true,
+    jsonPointers: true,
+})
+    .addSchema(customerSchema)
+    .addSchema(paymentIntentSchema)
+    .addSchema(paymentMethodSchema)
+    .addSchema(verifyCardOptionsSchema)
+    .compile(verifyCardParamsSchema);
+export { validator as validateVerifyCardParams };

package/docker-compose.yml

@@ -0,0 +1,16 @@
+# docker-compose.yaml
+version: "3"
+services:
+  merchant:
+    image: webpack
+    build:
+      context: .
+    ports:
+      - 8080:8080
+      - 3000:3000
+    volumes:
+      - .:/bindmount:rw
+      # The volume is effectively hiding node_modules from the host and must be in this order
+      - node_modules:/src/node_modules
+volumes:
+  node_modules: