@netceterapx/click-to-pay-sdk 2.4.2 → 2.6.0

package/index.d.ts

@@ -1,20 +1,298 @@
-export declare interface AmexInitParams {
+declare enum AmexCheckoutTypeEnum {
+    WITHIN_CHECKOUT = "withinCheckout",
+    PAYMENT_SETTING = "paymentSetting"
+}
+
+declare type AmexCustomInputData = {
+    /**
+     * For Embedded checkout checkoutType will be sent:
+     * - “checkoutType”: “withinCheckout” -- Continue as Guest is shown on DCF
+     * - “checkoutType”:”paymentSetting” -- Continue as Guest is not shown on DCF
+     */
+    checkoutType: AmexCheckoutTypeEnum;
+};
+
+export declare enum AmexDpaApplicationTypeEnum {
+    WEB_BROWSER = "WEB_BROWSER",
+    MOBILE_APP = "MOBILE_APP",
+    IOT_DEVICE = "IOT_DEVICE",
+    OTHER = "OTHER"
+}
+
+export declare enum AmexDpaBillingPreferenceEnum {
+    ALL = "ALL",
+    POSTAL_COUNTRY = "POSTAL_COUNTRY",
+    NONE = "NONE"
+}
+
+export declare type AmexDpaData = {
+    /**
+     * Display name of the DPA.
+     * Ex. ‘Disney Online’.
+     */
+    dpaPresentationName?: string;
+    /**
+     * Website URL.
+     * Example: ‘http://www.disneyonline.com’
+     */
+    dpaUri?: string;
+    /**
+     * URI of the logo of the DPA.
+     */
+    dpaLogoUri?: string;
+    /**
+     * Legal name of registered DPA.
+     */
+    dpaName: string;
+    /**
+     * DPA’s contact email address.
+     */
+    dpaEmailAddress?: string;
+    /**
+     * DPA’s contact phone number.
+     */
+    dpaPhoneNumber?: string;
+    /**
+     * DPA’s support contact email address.
+     */
+    dpaSupportEmailAddress?: string;
+    /**
+     * DPA’s support contact phone number.
+     */
+    dpaSupportPhoneNumber?: string;
+    /**
+     * DPA’s support URI.
+     */
+    dpaSupportUri?: string;
+    /**
+     * Type of DPA.
+     * Valid values for enum:
+     * • WEB_BROWSER
+     * • MOBILE_APP
+     * • IOT_DEVICE
+     * • OTHER
+     */
+    dpaApplicationType?: AmexDpaApplicationTypeEnum;
+};
+
+export declare enum AmexDpaShippingPreferenceEnum {
+    ALL = "ALL",
+    POSTAL_COUNTRY = "POSTAL_COUNTRY",
+    NONE = "NONE"
+}
+
+export declare type AmexDpaTransactionOptions = {
+    /**
+     * DPA’s preferred locale.
+     */
+    dpaLocale?: string;
+    /**
+     * Billing Restrictions.
+     * Array of country codes - Payments from all the listed billing countries are accepted.
+     * Format: ISO 3166-1 alpha-2
+     * Example: ["US","CA","AU"]
+     * If this list is empty, then it means all countries are accepted.
+     */
+    dpaAcceptedBillingCountries?: string[];
+    /**
+     * Shipping restrictions.
+     * Array of country codes - Shipping region country codes that limits the selection of eligible shipping addresses.
+     * Format: ISO 3166-1 alpha-2
+     * Example: ["US","CA","AU"]
+     * If this list is empty, then it means all countries are accepted.
+     */
+    dpaAcceptedShippingCountries?: string[];
+    /**
+     * Verbosity of address required by the DPA.
+     * Valid values for enum:
+     * • ALL
+     * • POSTAL_COUNTRY
+     * • NONE
+     * If not provided, the default is ‘ALL’
+     */
+    dpaBillingPreference?: AmexDpaBillingPreferenceEnum;
+    /**
+     * Whether DSA wants to have shipping address collected.
+     * Valid values for enum:
+     * • ALL
+     * • POSTAL_COUNTRY
+     * • NONE
+     * If not provided, the default is ‘ALL’
+     */
+    dpaShippingPreference?: AmexDpaShippingPreferenceEnum;
+    /**
+     * Default is true.
+     */
+    consumerNameRequested?: boolean;
+    /**
+     * Default is true.
+     */
+    consumerEmailAddressRequested?: boolean;
+    /**
+     * Default is true.
+     */
+    consumerPhoneNumberRequested?: boolean;
+    /**
+     * Payment options requested by the DPA.
+     */
+    paymentOptions?: AmexPaymentOptions[];
+    /**
+     * To indicate to the user if payment will be processed after selection
+     * or if only data returned to SRCi/merchant to confirm first.
+     * Valid values for enum:
+     * • PAY: Should be used if merchant does not have a summary page and wants payment for transaction
+     * to be processed immediately. Consumer is not brought to any merchant summary page.
+     * Amex DCF is last action taken by consumer.
+     * • CONTINUE: Should be used to redirect the consumer back to a merchant summary page
+     * where consumer can verify their purchase before transaction is finalized and payment is made.
+     * The default value is ‘CONTINUE’.
+     */
+    reviewAction?: AmexReviewActionEnum;
+    /**
+     * Review message to go with action.
+     */
+    checkoutDescription?: string;
+    /**
+     * Type of the transaction.
+     * Valid values for enum:
+     * • PURCHASE
+     * • BILL_PAYMENT
+     * • MONEY_TRANSFER
+     * If not provided, the default value is ‘PURCHASE’
+     */
+    transactionType?: AmexTransactionTypeEnum;
+    /**
+     * Type of order.
+     * Valid values for enum:
+     * • REAUTHORIZATION
+     * • RECURRING
+     * • INSTALLMENT
+     */
+    orderType?: AmexOrderTypeEnum;
+    /**
+     * Amount of the transaction.
+     */
+    transactionAmount?: AmexTransactionAmount;
+    /**
+     * Merchant’s 3DS preferences.
+     * Valid values for enum:
+     * • NONE
+     * • SELF
+     * • ONBEHALF
+     */
+    threeDsPreference: AmexThreeDsPreferenceEnum;
+    /**
+     * Merchant’s 3DS input data.
+     * Conditionality: Must be supplied if 3DS is to be performed by SRC System.
+     */
+    threeDsInputData?: AmexThreeDsInputData;
+    /**
+     * The order identifier generated by the DPA.
+     */
+    merchantOrderId?: string;
+    /**
+     * MCC of the merchant.
+     * Conditionality: Required if 3DS is requested.
+     */
+    merchantCategoryCode?: string;
+    /**
+     * Country code of the merchant.
+     * Conditionality: Required if 3DS is requested.
+     */
+    merchantCountryCode?: string;
+    /**
+     * Extensible container that allows DPA to pass network-specific set of data to SRC System.
+     * For Embedded checkout checkoutType will be sent:
+     * - “checkoutType”: “withinCheckout” --- Continue as Guest is shown on DCF
+     * - “checkoutType”:”paymentSetting” --- Continue as Guest is not shown on DCF
+     */
+    customInputData?: AmexCustomInputData;
+};
+
+declare enum AmexDynamicDataTypeEnum {
+    DYNAMIC_CARD_SECURITY_CODE = "DYNAMIC_CARD_SECURITY_CODE"
+}
+
+export declare type AmexInitConfiguration = {
     /**
-     * A unique id used to track the user journey. This is used for
-     * analytics to be able to correlate a single user "session" from
-     * button impression to the end of the transaction.
-     * This field may be created on the merchant page by the SRC
-     * Initiator and need to be passed-through to all the networks (SRC
-     * Systems). It is passed all the way to the DCFs as well.
+     * SRCI identifier. This is generated by the SRC System during onboarding.
      */
     srcInitiatorId: string;
     /**
-     * SRCI identifier. This is generated by the SRC System during
-     * onboarding.
+     * DpaData data should be provided to SRC system if srcDpaId is not provided.
+     */
+    dpaData?: AmexDpaData;
+    /**
+     * DPA configuration data that can override any configuration set before.
+     */
+    dpaTransactionOptions?: AmexDpaTransactionOptions;
+};
+
+export declare enum AmexOrderTypeEnum {
+    REAUTHORIZATION = "REAUTHORIZATION",
+    RECURRING = "RECURRING",
+    INSTALLMENT = "INSTALLMENT"
+}
+
+export declare type AmexPaymentOptions = {
+    /**
+     * If not provided, in the response PAN payload will be provided.
+     * If provided but issuer doesn’t support tokenization in that case
+     * PAN payload will be provided in the response.
+     */
+    dynamicDataType?: AmexDynamicDataTypeEnum;
+    /**
+     * Requested “Time to Live” (expiry period) of the dynamic data,
+     * specified in minutes.
+     */
+    dpaDynamicDataTtlMinutes?: string;
+};
+
+export declare enum AmexReviewActionEnum {
+    PAY = "PAY",
+    CONTINUE = "CONTINUE"
+}
+
+export declare type AmexThreeDsInputData = {
+    /**
+     * The ID assigned to the merchant for authentication request to initiate 3DS with MPI.
+     */
+    requestorId: string;
+    /**
+     * Merchant’s Acquirer ID.
+     */
+    acquirerId: string;
+    /**
+     * Acquirer’s Merchant ID.
      */
-    srciTransactionId: string;
-    dpaData: DpaData;
-    dpaTransactionOptions: DpaTransactionOptions;
+    acquirerMid: string;
+};
+
+export declare enum AmexThreeDsPreferenceEnum {
+    NONE = "NONE",
+    SELF = "SELF",
+    ONBEHALF = "ONBEHALF"
+}
+
+export declare type AmexTransactionAmount = {
+    /**
+     * The amount of the transaction.
+     * Example: 99.95
+     * Conditionality: Required if 3DS is requested
+     */
+    transactionAmount?: number;
+    /**
+     * Currency in which the transaction amount is expressed.
+     * Format: ISO 4217 three-digit currency code.
+     * Conditionality: Required if amount is present and 3DS is requested.
+     */
+    transactionCurrencyCode?: string;
+};
+
+export declare enum AmexTransactionTypeEnum {
+    PURCHASE = "PURCHASE",
+    BILL_PAYMENT = "BILL_PAYMENT",
+    MONEY_TRANSFER = "MONEY_TRANSFER"
 }
 
 export declare enum ButtonStyle {
@@ -38,7 +316,7 @@ export declare interface Config {
     iframe?: ConfigIframe;
     mastercard?: MastercardInitConfiguration;
     visa?: VisaInitConfiguration;
-    amex?: Omit<AmexInitParams, 'srciTransactionId'>;
+    amex?: AmexInitConfiguration;
 }
 
 export declare interface ConfigIframe {
@@ -66,6 +344,10 @@ export declare interface ConsumerStatusEvent {
      * Gives a list of Schemes that the user has a profile in.
      */
     hasProfileInSchemes: CreditCardBrand[];
+    /**
+     * Informs whether consumer has successfully completed identity validation.
+     */
+    hasBeenValidated: boolean;
     /**
      * Informs whether the manual card entry form should be open by default.
      * Is true when the consumer doesn't have a profile or has a profile but no cards.
@@ -94,25 +376,9 @@ export declare enum DcfOpeningBehaviour {
     POPUP = "popup"
 }
 
-export declare interface DpaData {
-    /**
-     * Display name of the DPA.
-     * Ex. ‘Disney Online’.
-     */
-    dpaPresentationName: string;
-    /**
-     * Website URL
-     * Ex. ‘http://www.disneyonline.com’
-     */
-    dpaUri?: string;
-    /**
-     * Undocumented parameter.
-     */
-    dpaName: string;
-}
-
-export declare interface DpaTransactionOptions {
-    threeDsPreference: ThreeDsPreference;
+export declare enum DebugLogs {
+    TRUE = "true",
+    FALSE = "false"
 }
 
 export declare enum EnablePerformanceMeasurement {
@@ -178,6 +444,8 @@ export declare enum IsPanInPayButton {
     FALSE = "false"
 }
 
+declare type JWT = string;
+
 /**
  * Supported languages.
  */
@@ -405,6 +673,11 @@ export declare type MastercardInitConfiguration = {
      * May be provided, as required, to dynamically update previously registered DPA Data, e.g., presentation name.
      */
     dpaData?: MastercardDpaData;
+    /**
+     * This is the JWT token stored by the integrator on the consumer device.
+     * This token is stored in a first party cookie by the integrator and used to recognize the consumer in the browser.
+     */
+    recognitionToken?: JWT;
 };
 
 export declare type MastercardPaymentOptions = {
@@ -434,28 +707,6 @@ export declare type MastercardTransactionAmount = {
     transactionCurrencyCode: string;
 };
 
-/**
- * Merchant provides configuration for modifying component.
- */
-export declare interface MerchantConfig {
-    isExpanded: IsExpanded;
-    locale: LANG;
-    email: string | undefined;
-    dcfOpeningBehaviour: DcfOpeningBehaviour;
-    dpaPresentationName: string | undefined;
-    transactionAmount: TransactionAmount;
-    isPanInPayButton: IsPanInPayButton;
-    buttonStyle: ButtonStyle;
-    hidePayButton: HidePayButton;
-    enablePerformanceMeasurement: EnablePerformanceMeasurement;
-}
-
-export declare const messageTimeout = 3000;
-
-export declare enum OrchestratorErrorReason {
-    NOT_AUTHENTICATED = "NOT_AUTHENTICATED"
-}
-
 export declare type ProfileDetails = {
     firstName: string;
     lastName: string;
@@ -514,12 +765,6 @@ export declare enum Sandbox {
     FALSE = "false"
 }
 
-export declare enum ThreeDsPreference {
-    'NONE' = "NONE",
-    'SELF' = "SELF",
-    'ONBEHALF' = "ONBEHALF"
-}
-
 export declare type TransactionAmount = {
     /**
      * Amount associated with transaction.
@@ -863,25 +1108,38 @@ export declare type VisaThreeDsInputData = {
 };
 
 export declare type VisaThreeDSOptions = {
+    /**
+     * Flag to indicate if 3DS provided by Visa SRC System should be suppressed or not.
+     * Default: false
+     */
+    suppressThreeDS?: boolean;
     /**
      * SRCi-provided authentication reasons used by the SRC System to perform authentication.
      * Valid values for enum:
      * • TRANSACTION_AUTHENTICATION
      * • NOT_PREFERRED
+     *
+     * Conditionality: required if 'suppressThreeDS' is not provided or false.
      */
-    authenticationReason: VisaAuthenticationReasonEnum;
+    authenticationReason?: VisaAuthenticationReasonEnum;
     /**
      * Acquirer-assigned Merchant identifier.
+     *
+     * Conditionality: required if 'suppressThreeDS' is not provided or false.
      */
-    acquirerMerchantId: string;
+    acquirerMerchantId?: string;
     /**
      * Acquirer identification code as assigned by the Directory Server.
+     *
+     * Conditionality: required if 'suppressThreeDS' is not provided or false.
      */
-    acquirerBIN: string;
+    acquirerBIN?: string;
     /**
      * Merchant name assigned by the Acquirer or Payment System.
+     *
+     * Conditionality: required if 'suppressThreeDS' is not provided or false.
      */
-    merchantName: string;
+    merchantName?: string;
     /**
      * A challenge indicator value related to 3DS authentication.
      * Valid values:
@@ -894,8 +1152,10 @@ export declare type VisaThreeDSOptions = {
      * • 07 - No challenge requested (strong consumer authentication is already performed)
      * • 08 - No challenge requested (utilize trust list exemption if no challenge required)
      * • 09 - Challenge requested (trust list prompt requested if challenge required)
+     *
+     * Conditionality: required if 'suppressThreeDS' is not provided or false.
      */
-    challengeIndicator: VisaThreeDSChallengeIndicator;
+    challengeIndicator?: VisaThreeDSChallengeIndicator;
 };
 
 export declare type VisaTransactionAmount = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netceterapx/click-to-pay-sdk",
-  "version": "2.4.2",
+  "version": "2.6.0",
   "description": "Click-to-pay web-SDK for supporting SecureRemoteCommerce on web platforms",
   "main": "build/click-to-pay-sdk.es.js",
   "license": "MIT",
@@ -29,60 +29,67 @@
     "registry": "https://registry.npmjs.org"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.1",
-    "@rollup/plugin-alias": "^5.0.0",
-    "@rollup/plugin-commonjs": "^25.0.0",
-    "@rollup/plugin-node-resolve": "^15.1.0",
-    "@rollup/plugin-replace": "^5.0.2",
-    "@rollup/plugin-typescript": "^11.1.1",
-    "@rollup/plugin-url": "^8.0.1",
-    "@sveltejs/vite-plugin-svelte": "^2.4.2",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/svelte": "^3.2.2",
-    "@tsconfig/svelte": "^4.0.1",
-    "@types/uuid": "^9.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
-    "@vitest/coverage-v8": "^0.32.2",
-    "babel-loader": "^9.1.2",
-    "eslint": "^8.41.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-svelte": "^2.30.0",
-    "jsdom": "^22.1.0",
+    "@babel/core": "^7.25.2",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.10.0",
+    "@rollup/plugin-alias": "^5.1.0",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.7",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@rollup/plugin-url": "^8.0.2",
+    "@sveltejs/vite-plugin-svelte": "^3.1.2",
+    "@testing-library/jest-dom": "^6.5.0",
+    "@testing-library/svelte": "^5.2.1",
+    "@tsconfig/svelte": "^5.0.4",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.5.5",
+    "@types/postcss-url": "^10.0.4",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.5.0",
+    "@typescript-eslint/parser": "^8.5.0",
+    "@vitest/coverage-v8": "^2.1.1",
+    "babel-loader": "^9.2.1",
+    "eslint": "^9.10.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-svelte": "^2.44.0",
+    "globals": "^15.9.0",
+    "jsdom": "^25.0.0",
     "path-browserify": "^1.0.1",
-    "postcss": "^8.4.24",
+    "postcss": "^8.4.47",
     "postcss-url": "^10.1.3",
-    "prettier": "^2.8.8",
-    "prettier-plugin-svelte": "^2.10.1",
-    "rollup": "^2.66.1",
-    "rollup-plugin-copy": "^3.4.0",
-    "rollup-plugin-css-only": "^4.3.0",
-    "rollup-plugin-svelte": "^7.1.5",
+    "prettier": "^3.3.3",
+    "prettier-plugin-svelte": "^3.2.6",
+    "rollup": "^4.21.3",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-css-only": "^4.5.2",
+    "rollup-plugin-svelte": "^7.2.2",
     "rollup-plugin-terser": "^7.0.2",
-    "shadow-dom-testing-library": "^1.11.0",
+    "shadow-dom-testing-library": "^1.11.3",
     "shelljs": "^0.8.5",
     "sirv-cli": "^2.0.2",
     "stream-browserify": "^3.0.0",
-    "stylelint": "^15.6.2",
-    "stylelint-config-standard": "^33.0.0",
-    "svelte": "^3.59.1",
-    "svelte-check": "^3.4.3",
-    "svelte-htm": "^1.2.0",
-    "svelte-loader": "^3.1.8",
-    "svelte-preprocess": "^5.0.4",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.6.0",
-    "typescript": "^5.0.2",
-    "vite": "^4.3.9",
+    "stylelint": "^16.9.0",
+    "stylelint-config-standard": "^36.0.1",
+    "svelte": "^4.2.19",
+    "svelte-check": "^4.0.2",
+    "svelte-eslint-parser": "^0.41.1",
+    "svelte-loader": "^3.2.3",
+    "svelte-preprocess": "^6.0.2",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.7.0",
+    "typescript": "5.5.4",
+    "typescript-eslint": "^8.6.0",
+    "vite": "^5.4.5",
+    "vite-plugin-dts": "^4.2.1",
     "vite-plugin-eslint": "^1.8.1",
-    "vitest": "^0.32.2"
+    "vitest": "^2.1.1"
   },
   "dependencies": {
-    "final-form": "^4.20.9",
-    "jose": "^4.14.4",
+    "final-form": "^4.20.10",
+    "jose": "^5.9.2",
     "svelte-final-form": "^1.2.3",
-    "uuid": "^9.0.0",
-    "vite-plugin-dts": "^3.7.2"
+    "uuid": "^10.0.0"
   }
 }