@globalpayments/js 4.0.11 → 4.0.13

package/README.md

@@ -24,7 +24,7 @@ This plugin allows you to use online payments (eCommerce) features of a variety
 ## Usage
 
 ```html
-<script src="https://js.globalpay.com/4.0.11/globalpayments.js"></script>
+<script src="https://js.globalpay.com/4.0.13/globalpayments.js"></script>
 ```
 
 > Note: Installing via NPM will only provide TypeScript types for type-checking.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalpayments/js",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "author": "Heartland Developer Portal <developers@heartland.us>",
   "license": "GPL-2.0",
   "repository": {
@@ -17,10 +17,15 @@
     "clean": "rimraf dist",
     "cypress:open": "cypress open",
     "format": "prettier --write config/**/* src/**/* !src/assets/**/* !test/run.sh !test/run.ps1 test/fixtures/**/*.html",
-    "postbuild": "cross-os postbuild-cross",
+    
+    "postbuild": "xcopy src\\assets dist\\ /e/y/h && node bin/replace-gp-ref.js",
+
     "prebuild": "yarn test:lint && node bin/update-version.js",
     "prepublish": "yarn build",
+   
     "test": "cross-os test-cross",
+  
+
     "test:integration": "cypress run",
     "test:lint": "tslint --project tsconfig.json",
     "test:serve": "serve -p 7777"

package/types/apm/qr-code-payments/enums.d.ts

@@ -5,5 +5,6 @@ export declare const enum QRCodePaymentsInternalEvents {
 }
 export declare const enum QRCodePaymentsActions {
     RedirectAction = "REDIRECT",
-    RedirectInFrameAction = "REDIRECT_IN_FRAME"
+    RedirectInFrameAction = "REDIRECT_IN_FRAME",
+    PresentQRCodeAction = "PRESENT_QR_CODE"
 }

package/types/common/currency.d.ts

@@ -5,3 +5,4 @@ export declare const availableCurrencies: {
     code: string;
     symbol: string;
 }[];
+export declare const convertAmount: (amount: string, withoutDecimals?: boolean, decimalPlaces?: number) => string | void;

package/types/common/enums.d.ts

@@ -17,7 +17,8 @@ export declare enum HostedFieldValidationEvents {
     ValidatePassData = "hosted-field-validate-pass-data",
     ValidateForm = "hosted-field-validate-form",
     ValidateFormValid = "hosted-field-validate-form-valid",
-    ValidateFormInvalid = "hosted-field-validate-form-invalid"
+    ValidateFormInvalid = "hosted-field-validate-form-invalid",
+    ValidationCurrencyConversionShow = "hosted-field-validation-currency-conversion-show"
 }
 export declare enum CardFormFieldValidationTestEvents {
     CardNumber = "card-number-test",
@@ -25,3 +26,9 @@ export declare enum CardFormFieldValidationTestEvents {
     CardCvv = "card-cvv-test",
     CardHolderName = "card-holder-name-test"
 }
+export declare enum Environments {
+    Local = "local",
+    QA = "qa",
+    Sandbox = "sandbox",
+    Production = "production"
+}

package/types/common/helpers.d.ts

@@ -0,0 +1,4 @@
+export declare const DataEncoderHelper: {
+    encode: (data: string) => string;
+    decode: (encodedData: string) => string;
+};

package/types/common/html-element.d.ts

@@ -77,6 +77,19 @@ export declare const createHtmlCheckboxElement: (props?: {
     textContent?: string | undefined;
     checked: boolean;
 } | undefined) => HTMLInputElement;
+export declare const createHtmlRadioButtonElement: (props?: {
+    id?: string | undefined;
+    className?: string | undefined;
+    attributes?: {
+        [key: string]: string;
+    }[] | undefined;
+    name?: string | undefined;
+    labelText?: string | undefined;
+    additionalInfo?: string | undefined;
+    checked: boolean;
+    target?: string | undefined;
+    value?: string | undefined;
+} | undefined) => HTMLDivElement;
 export declare const createHtmlLabelElement: (props?: {
     id?: string | undefined;
     className?: string | undefined;
@@ -95,3 +108,17 @@ export declare const createHtmlIFrameElement: (props?: {
     }[] | undefined;
 } | undefined) => HTMLIFrameElement;
 export declare const changeCreditCardFormFieldsVisibility: (visible: boolean) => void;
+export declare const createToolTip: (props?: {
+    id?: string | undefined;
+    className?: string | undefined;
+    attributes?: {
+        [key: string]: string;
+    }[] | undefined;
+    ariaLabel?: string | undefined;
+    ariaDescribedBy?: string | undefined;
+    role?: string | undefined;
+    tabIndex?: string | undefined;
+    title?: string | undefined;
+    htmlContent?: string | undefined;
+} | undefined) => HTMLElement;
+export declare const createHtmlFromString: (htmlString: string) => DocumentFragment;

package/types/internal/built-in-validations/messages.d.ts

@@ -21,4 +21,7 @@ export declare const ValidationMessages: {
         NotValidCardHolderName: any;
         CharactersMoreThan100: any;
     };
+    CurrencyConversion: {
+        Required: any;
+    };
 };

package/types/internal/gateways/gp-api/action-query-currency-conversion.d.ts

@@ -0,0 +1,3 @@
+import { IDictionary } from "../../lib/util";
+declare const _default: (url: string, _env: string, data: IDictionary) => Promise<any>;
+export default _default;

package/types/internal/gateways/gp-api/index.d.ts

@@ -22,7 +22,8 @@ export declare const urls: {
     assetBaseUrl: (result: string) => string;
     tokenization: (prod: boolean) => string;
     queryInstallmentPlans: (prod: boolean) => string;
-    getQRCodePaymentMethodsUrl: (prod: boolean) => string;
+    queryCurrencyConversionUrl: () => string;
+    getQRCodePaymentMethodsUrl: () => string;
 };
 export declare const actions: IActions;
 export declare const requiredSettings: string[];

package/types/internal/gateways/index.d.ts

@@ -46,6 +46,9 @@ export interface ISuccess {
             id: string;
             reference: string;
         };
+        currencyConversion?: {
+            id: string;
+        };
     };
     methodName?: string;
     payerEmail?: string;
@@ -70,13 +73,15 @@ export interface IActions {
     tokenize: (url: string, env: string, data: IDictionary) => Promise<any>;
     validateData: (data: IDictionary) => IErrorReason[];
     queryInstallmentPlans?: (url: string, env: string, data: IDictionary) => Promise<any>;
+    queryCurrencyConversion?: (url: string, env: string, data: IDictionary) => Promise<any>;
     getQRCodePaymentMethods?: (url: string, env: string, data: IDictionary) => Promise<any>;
 }
 export interface IUrlGenerators {
     assetBaseUrl?: (result: string) => string;
     tokenization: (prod: boolean) => string;
     queryInstallmentPlans?: (prod: boolean) => string;
-    getQRCodePaymentMethodsUrl?: (prod: boolean) => string;
+    queryCurrencyConversionUrl?: () => string;
+    getQRCodePaymentMethodsUrl?: () => string;
 }
 export interface IGatewayModule {
     [key: string]: any;

package/types/internal/lib/card.d.ts

@@ -119,8 +119,37 @@ export default class Card {
      * availability of use installment plans.
      *
      * @param e
+     * @param fieldType
      */
     static validateInstallmentFields(e: Event, fieldType: string): void;
+    /**
+     * validateCurrencyConversionFields
+     *
+     * Validates a target element"s value based on the
+     * availability of use currency conversion.
+     *
+     * @param e
+     * @param fieldType
+     */
+    static validateCurrencyConversionFields(e: Event, fieldType: string): void;
+    /**
+     * currencyConversionFieldsValidatedEvent
+     *
+     * Post an event when an installment related card field is validated
+     *
+     * @param e
+     * @param fieldType
+     */
+    static currencyConversionFieldsValidatedEvent(e: Event, fieldType: string): void;
+    /**
+     * hideCurrencyConversionField
+     *
+     * Hides the currency conversion field component.
+     *
+     * @param e
+     * @param fieldType
+     */
+    static hideCurrencyConversionField(e: Event, fieldType: string): void;
     /**
      * postInstallmentFieldValidatedEvent
      *

package/types/internal/lib/currency-conversion/components/enums.d.ts

@@ -0,0 +1,5 @@
+export declare enum CurrencyConversionStyles {
+    CONTAINER = "currency-conversion-container",
+    MERCHANT_CURRENCY_ID = "merchant-currency",
+    CARD_CURRENCY_ID = "card-currency"
+}

package/types/internal/lib/currency-conversion/components/events.d.ts

@@ -0,0 +1,8 @@
+import { IframeField } from "../../../../ui";
+/**
+ * Sets event listeners for radio buttons within a radio group.
+ * This method handles click events on radio buttons to toggle their state.
+ * @param iframeField The iframe field associated with the radio group.
+ * @param fieldset The fieldset element containing the radio buttons.
+ */
+export declare const setRadioGroupEvents: (iframeField: IframeField, fieldset: HTMLElement) => void;

package/types/internal/lib/currency-conversion/components/template.d.ts

@@ -0,0 +1,7 @@
+import { IframeField } from "../../../../ui";
+/**
+ * Creates a radio group HTML element containing merchant and card currency radio buttons.
+ * @param iframeField The iframe field associated with the radio group.
+ * @param data The data used to populate the radio buttons.
+ */
+export declare const createRadioGroupHtmlElement: (iframeField: IframeField, data: any) => void;

package/types/internal/lib/currency-conversion/contracts/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const DCC_KEY = "currency-conversion";
+export declare const DCC_CONFIG_DEFAULT_CHANNEL = "CNP";
+export declare const DCC_CONFIG_DEFAULT_ENTRY_MODE = "ECOM";
+export declare const DCC_CONFIG_DEFAULT_TRANSACTION_TYPE = "SALE";
+export declare const DCC_AVAILABILITY_STATUS_KEY: string;

package/types/internal/lib/currency-conversion/contracts/enums.d.ts

@@ -0,0 +1,15 @@
+export declare enum CurrencyConversionEvents {
+    CurrencyConversionRequestStart = "currency-conversion-request-start",
+    CurrencyConversionRequestCompleted = "currency-conversion-request-completed",
+    CurrencyConversionRequestFailed = "currency-conversion-request-failed",
+    CurrencyConversionHide = "currency-conversion-validate-fields",
+    CurrencyConversionFieldsValidated = "currency-conversion-fields-validated",
+    CurrencyConversionRequestData = "currency-conversion-request-data",
+    CurrencyConversionAccumulateData = "currency-conversion-accumulate-data",
+    CurrencyConversionPassData = "currency-conversion-pass-data",
+    CurrencyConversionSendValue = "currency-conversion-send-value"
+}
+export declare enum CurrencyConversionStatus {
+    CurrencyConversionNotAvailable = "NOT_AVAILABLE",
+    CurrencyConversionAvailable = "AVAILABLE"
+}

package/types/internal/lib/currency-conversion/contracts/interfaces.d.ts

@@ -0,0 +1,13 @@
+export interface CurrencyConversionPaymentData {
+    id: string;
+    exchangeRate: string;
+    exchangeRateSource: string;
+    cardHolderAmount: string;
+    cardHolderCurrency: string;
+    merchantAmount: string;
+    merchantCurrency: string;
+    marginPercentageRate: string;
+    exchangeRateTimeCreated: string;
+    commissionPercentage: string;
+    currencyConversionAccepted: string;
+}

package/types/internal/lib/currency-conversion/requests/query-currency-conversion.d.ts

@@ -0,0 +1,3 @@
+import { IDictionary } from "../../util";
+declare const _default: (data: IDictionary) => Promise<unknown>;
+export default _default;

package/types/internal/lib/currency-conversion/utils/helpers.d.ts

@@ -0,0 +1,8 @@
+export declare const getCurrencyConversionAvailabilityStatus: () => boolean;
+export declare const setCurrencyConversionAvailabilityStatus: (availabilityStatus: boolean) => void;
+export declare const removeCurrencyConversionAvailabilityStatus: () => void;
+export declare const cleanUpCurrencyConversionAvailabilityStatus: () => void;
+export declare const handleCurrencyConversionValidationSetup: (fieldsToValidate: string[]) => void;
+export declare const hasCurrencyConversionSensitiveValueChanged: (fieldType: string, value: any) => boolean;
+export declare const removeCurrencyConversionPreviousValue: (fieldType: string) => void;
+export declare const cleanUpCurrencyConversionPreviousValue: () => void;

package/types/internal/lib/currency-conversion/utils/reset-currency-conversion.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resets the currency conversion by removing all children from the container,
+ * clearing the value of the payment field inside the iframe, and hiding validation messages.
+ * @param dccField The iframe field associated with the currency conversion.
+ */
+import { IframeField } from "../../../../ui";
+export declare const resetCurrencyConversion: (dccField: IframeField | undefined) => void;

package/types/internal/lib/detectLanguage.d.ts

@@ -1,3 +1,5 @@
 import { Language } from "./enums";
 export declare function setCurrentLanguage(lang?: Language): string;
 export declare function getCurrentLanguage(): string;
+export declare function getTranslationSet(language: string, featureSet: string): any;
+export declare function getTranslationLanguageSet(language: string): any;

package/types/internal/lib/enums.d.ts

@@ -1,8 +1,12 @@
+export declare enum ApiVersion {
+    default = "2021-03-22"
+}
 export declare enum Apm {
     ApplePay = "apple-pay",
     ClickToPay = "click-to-pay",
     GooglePay = "google-pay",
     OpenBankingPayment = "open-banking",
+    PayPal = "paypal",
     QRCodePayments = "qr-code-payments"
 }
 export declare enum ApmEvents {
@@ -34,10 +38,14 @@ export declare enum QRCodePaymentsProviderBrands {
 export declare enum OpenBanking {
     title = "Bank Payment"
 }
+export declare enum PayPal {
+    title = "PayPal Payment"
+}
 export declare enum ApmProviders {
     Alipay = "Alipay",
     AlipayHK = "AlipayHK",
     OpenBanking = "OPEN_BANKING",
+    PayPal = "PayPal",
     WeChat = "WeChat"
 }
 export declare enum QRCodePaymentsWeChatProviderBrands {

package/types/internal/lib/set-headers.d.ts

@@ -0,0 +1,7 @@
+export declare function setGpApiHeaders(): {
+    Accept: string;
+    Authorization: string;
+    "Content-Type": string;
+    "X-GP-Version": string;
+    "X-GP-Library": string;
+} | Headers;

package/types/internal/lib/styles/built-in-validations/simple.d.ts

@@ -7,6 +7,9 @@ export declare const fieldStyles: (assetBaseUrl: string) => {
         right: string;
         top: string;
     };
+    "#field-validation-wrapper": {
+        "margin-top": string;
+    };
     "@font-face": {
         "font-family": string;
         src: string;

package/types/internal/lib/styles/currency-conversion/common.d.ts

@@ -0,0 +1,191 @@
+declare const styles: () => {
+    ".secure-payment-form .currency-conversion-container": {
+        display: string;
+        "flex-direction": string;
+        "align-items": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion iframe": {
+        "min-height": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion fieldset": {
+        "font-family": string;
+        border: string;
+        margin: string;
+        padding: string;
+        display: string;
+        "flex-wrap": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion legend": {
+        "font-family": string;
+        border: number;
+        top: string;
+        margin: string;
+        padding: number;
+        display: string;
+        "font-size": string;
+        "font-weight": number;
+        position: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button": {
+        display: string;
+        "justify-content": string;
+        "align-items": string;
+        border: string;
+        padding: string;
+        "white-space": string;
+        height: string;
+        "margin-right": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button:last-child": {
+        "margin-right": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button:hover": {
+        "border-color": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion fieldset:focus-within > .radio-button": {
+        outline: string;
+        "outline-offset": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion fieldset.no-focus-outline .radio-button.checked": {
+        outline: string;
+        "outline-offset": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button.checked": {
+        background: string;
+        "border-color": string;
+        color: string;
+        outline: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button input[type='radio']": {
+        margin: string;
+        appearance: string;
+        "-webkit-appearance": string;
+        "-moz-appearance": string;
+        border: string;
+        "border-radius": string;
+        width: string;
+        height: string;
+        display: string;
+        position: string;
+        padding: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button input[type='radio']:checked": {
+        "background-color": string;
+        border: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button input[type='radio']:focus": {
+        outline: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .radio-button label": {
+        "font-family": string;
+        "font-size": string;
+        "font-weight": number;
+        display: string;
+        margin: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .card-currency-content": {
+        opacity: string;
+        visibility: boolean;
+        display: string;
+        "flex-direction": string;
+        "margin-left": string;
+        "align-items": string;
+        height: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .card-currency-content.visible": {
+        display: string;
+        opacity: string;
+        visibility: boolean;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .merchant-currency-content": {
+        opacity: string;
+        visibility: boolean;
+        display: string;
+        "flex-direction": string;
+        "margin-left": string;
+        "align-items": string;
+        height: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .merchant-currency-content.visible": {
+        display: string;
+        opacity: string;
+        visibility: boolean;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .additional-info": {
+        "font-family": string;
+        "font-size": string;
+        "font-weight": number;
+        margin: string;
+        display: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .additional-info p": {
+        margin: string;
+        "font-style": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip": {
+        width: string;
+        height: string;
+        "min-width": string;
+        "border-left": string;
+        display: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip:hover": {
+        "border-left": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip:focus": {
+        "border-left": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip-content": {
+        bottom: string;
+        right: string;
+        display: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip:hover .tooltip-content": {
+        display: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip-content p": {
+        margin: string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip-content p:last-child": {
+        "margin-bottom": string;
+    };
+    ".secure-payment-form .credit-card-currency-conversion .tooltip-content::before": {
+        left: string;
+        top: string;
+        right: string;
+        transform: string;
+        "border-width": string;
+        "border-style": string;
+        "border-color": string;
+    };
+    "@media only screen and (max-width: 768px)": {
+        ".secure-payment-form .currency-conversion-container": {
+            "flex-direction": string;
+            "align-items": string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion fieldset": {
+            "justify-content": string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion .radio-button": {
+            width: string;
+            "justify-content": string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion .radio-button:first-child": {
+            margin: string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion .card-currency-content": {
+            width: string;
+            "margin-top": string;
+            "margin-left": string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion .merchant-currency-content": {
+            width: string;
+            "margin-top": string;
+            "margin-left": string;
+        };
+        ".secure-payment-form .credit-card-currency-conversion .tooltip-content::before": {
+            right: string;
+        };
+    };
+};
+export default styles;