tonder-web-sdk 1.16.1 → 1.16.6-beta.DEV-1433.1

package/types/index.d.ts

@@ -1,11 +1,9 @@
-export * from './card';
-export * from './checkout';
-export * from './common';
-export * from './customer';
-export * from './transaction';
-export * from './paymentMethod';
-export * from './inlineCheckout';
-export * from './liteInlineCheckout';
-export * from './validations';
-
-
+export * from "./card";
+export * from "./checkout";
+export * from "./common";
+export * from "./customer";
+export * from "./transaction";
+export * from "./paymentMethod";
+export * from "./inlineCheckout";
+export * from "./liteInlineCheckout";
+export * from "./validations";

package/types/inlineCheckout.d.ts

@@ -1,74 +1,94 @@
-import {IConfigureCheckout, IInlineCheckoutBaseOptions} from "./common";
-import {IProcessPaymentRequest, IStartCheckoutResponse} from "./checkout";
-import {ITransaction} from "./transaction";
+import { IBaseCallback, IConfigureCheckout, IInlineCheckoutBaseOptions } from "./common";
+import { IProcessPaymentRequest, IStartCheckoutResponse } from "./checkout";
+import { ITransaction } from "./transaction";
 
 export class InlineCheckout {
-    constructor(options: IInlineCheckoutOptions);
+  constructor(options: IInlineCheckoutOptions);
 
-    /**
-     * The configureCheckout function allows you to set initial information, such as the customer's email, which is used to retrieve a list of saved cards.
-     * @param {import("../types").IConfigureCheckout} data - Configuration data including customer information and potentially other settings.
-     * @returns {void}.
-     * @public
-     */
-    configureCheckout(data: IConfigureCheckout): void;
+  /**
+   * The configureCheckout function allows you to set initial information, such as the customer's email, which is used to retrieve a list of saved cards.
+   * @param {import("../types").IConfigureCheckout} data - Configuration data including customer information and potentially other settings.
+   * @returns {void}.
+   * @public
+   */
+  configureCheckout(data: IConfigureCheckout): void;
 
-    /**
-     * Injects the checkout into the DOM and initializes it.
-     * Checks for an existing container and sets up an observer if needed.
-     * @returns {void}
-     * @public
-     */
-    injectCheckout(): Promise<void>;
+  /**
+   * Injects the checkout into the DOM and initializes it.
+   * Checks for an existing container and sets up an observer if needed.
+   * @returns {void}
+   * @public
+   */
+  injectCheckout(): Promise<void>;
 
-    /**
-     * Processes a payment.
-     * @param {import("../types").IProcessPaymentRequest} data - Payment data including customer, cart, and other relevant information.
-     * @returns {Promise<import("../types").IStartCheckoutResponse>} A promise that resolves with the payment response or 3DS redirect or is rejected with an error.
-     *
-     * @throws {Error} Throws an error if the checkout process fails. The error object contains
-     * additional `details` property with the response from the server if available.
-     * @property {import("../types").IStartCheckoutErrorResponse} error.details - The response body from the server when an error occurs.
-     *
-     * @public
-     */
-    payment(data: IProcessPaymentRequest): Promise<IStartCheckoutResponse>;
+  /**
+   * Processes a payment.
+   * @param {import("../types").IProcessPaymentRequest} data - Payment data including customer, cart, and other relevant information.
+   * @returns {Promise<import("../types").IStartCheckoutResponse>} A promise that resolves with the payment response or 3DS redirect or is rejected with an error.
+   *
+   * @throws {Error} Throws an error if the checkout process fails. The error object contains
+   * additional `details` property with the response from the server if available.
+   * @property {import("../types").IStartCheckoutErrorResponse} error.details - The response body from the server when an error occurs.
+   *
+   * @public
+   */
+  payment(data: IProcessPaymentRequest): Promise<IStartCheckoutResponse>;
 
-    /**
-     * Verifies the 3DS transaction status.
-     * @returns {Promise<import("../types").ITransaction | void>} The result of the 3DS verification and checkout resumption.
-     * @public
-     */
-    verify3dsTransaction(): Promise<ITransaction | void>;
+  /**
+   * Verifies the 3DS transaction status.
+   * @returns {Promise<import("../types").ITransaction | void>} The result of the 3DS verification and checkout resumption.
+   * @public
+   */
+  verify3dsTransaction(): Promise<ITransaction | void>;
 
-    /**
-     * Removes the checkout from the DOM and cleans up associated resources.
-     *
-     * This method performs the following actions:
-     * 1. Resets the injection status flags for the checkout, cards, and APMs.
-     * 2. Aborts any ongoing requests using the AbortController.
-     * 3. Creates a new AbortController for future use.
-     * 4. Clears any existing injection intervals.
-     *
-     * Note: This method should be called when you want to completely remove
-     * the checkout from the page and reset its state.
-     *
-     * @returns {void}
-     * @public
-     */
-    removeCheckout(): void;
+  /**
+   * Removes the checkout from the DOM and cleans up associated resources.
+   *
+   * This method performs the following actions:
+   * 1. Resets the injection status flags for the checkout, cards, and APMs.
+   * 2. Aborts any ongoing requests using the AbortController.
+   * 3. Creates a new AbortController for future use.
+   * 4. Clears any existing injection intervals.
+   *
+   * Note: This method should be called when you want to completely remove
+   * the checkout from the page and reset its state.
+   *
+   * @returns {void}
+   * @public
+   */
+  removeCheckout(): void;
 }
 
 export type CustomizationOptions = {
-    saveCards?: {
-        showSaveCardOption?: boolean;
-        showSaved?: boolean;
-        autoSave?: boolean;
-    }
+  displayMode?: "light" | "dark";
+  saveCards?: {
+    showSaveCardOption?: boolean;
+    showSaved?: boolean;
+    autoSave?: boolean;
+  };
+  paymentButton?: {
+    show?: boolean;
+    text?: string;
+    showAmount?: boolean;
+  };
+  cancelButton?: {
+    show?: boolean;
+    text?: string;
+  };
+  paymentMethods?: {
+    show?: boolean;
+  };
+  cardForm?: {
+    show?: boolean;
+  };
+  showMessages?: boolean;
+};
+export interface IInlineCallbacks extends IBaseCallback {
+  onCancel?: () => Promise<void>;
 }
 
-export interface IInlineCheckoutOptions extends IInlineCheckoutBaseOptions{
-    styles?: Record<string, string>;
-    renderPaymentButton?: boolean;
-    customization?: CustomizationOptions;
+export interface IInlineCheckoutOptions extends IInlineCheckoutBaseOptions {
+  styles?: Record<string, string>;
+  customization?: CustomizationOptions;
+  callbacks?: IInlineCallbacks;
 }

package/types/liteInlineCheckout.d.ts

@@ -1,96 +1,91 @@
-import {IConfigureCheckout, IInlineCheckoutBaseOptions} from "./common";
-import {ICustomerCardsResponse, ISaveCardRequest, ISaveCardResponse} from "./card";
-import {IPaymentMethod} from "./paymentMethod";
-import {IProcessPaymentRequest, IStartCheckoutResponse} from "./checkout";
-import {ITransaction} from "./transaction";
+import { IConfigureCheckout, IInlineCheckoutBaseOptions } from "./common";
+import { ICustomerCardsResponse, ISaveCardRequest, ISaveCardResponse } from "./card";
+import { IPaymentMethod } from "./paymentMethod";
+import { IProcessPaymentRequest, IStartCheckoutResponse } from "./checkout";
+import { ITransaction } from "./transaction";
 
 export class LiteInlineCheckout {
-    constructor(options: IInlineLiteCheckoutOptions);
+  constructor(options: IInlineLiteCheckoutOptions);
 
-    /**
-     * The configureCheckout function allows you to set initial information, such as the customer's email, which is used to retrieve a list of saved cards.
-     * @param {import("../types").IConfigureCheckout} data - Configuration data including customer information and potentially other settings.
-     * @returns {Promise<void>}.
-     * @public
-     */
-    configureCheckout(data: IConfigureCheckout): void;
+  /**
+   * The configureCheckout function allows you to set initial information, such as the customer's email, which is used to retrieve a list of saved cards.
+   * @param {import("../types").IConfigureCheckout} data - Configuration data including customer information and potentially other settings.
+   * @returns {Promise<void>}.
+   * @public
+   */
+  configureCheckout(data: IConfigureCheckout): void;
 
-    /**
-     * Initializes and prepares the checkout for use.
-     * This method set up the initial environment.
-     * @returns {Promise<void>} A promise that resolves when the checkout has been initialized.
-     * @throws {Error} If there's any problem during the checkout initialization.
-     * @public
-     */
-    injectCheckout(): Promise<void>;
+  /**
+   * Initializes and prepares the checkout for use.
+   * This method set up the initial environment.
+   * @returns {Promise<void>} A promise that resolves when the checkout has been initialized.
+   * @throws {Error} If there's any problem during the checkout initialization.
+   * @public
+   */
+  injectCheckout(): Promise<void>;
 
-    /**
-     * Processes a payment.
-     * @param {import("../types").IProcessPaymentRequest} data - Payment data including customer, cart, and other relevant information.
-     * @returns {Promise<import("../types").IStartCheckoutResponse>} A promise that resolves with the payment response or 3DS redirect or is rejected with an error.
-     *
-     * @throws {Error} Throws an error if the checkout process fails. The error object contains
-     * additional `details` property with the response from the server if available.
-     * @property {import("../types").IStartCheckoutErrorResponse} error.details - The response body from the server when an error occurs.
-     *
-     * @public
-     */
-    payment(data: IProcessPaymentRequest): Promise<IStartCheckoutResponse>;
+  /**
+   * Processes a payment.
+   * @param {import("../types").IProcessPaymentRequest} data - Payment data including customer, cart, and other relevant information.
+   * @returns {Promise<import("../types").IStartCheckoutResponse>} A promise that resolves with the payment response or 3DS redirect or is rejected with an error.
+   *
+   * @throws {Error} Throws an error if the checkout process fails. The error object contains
+   * additional `details` property with the response from the server if available.
+   * @property {import("../types").IStartCheckoutErrorResponse} error.details - The response body from the server when an error occurs.
+   *
+   * @public
+   */
+  payment(data: IProcessPaymentRequest): Promise<IStartCheckoutResponse>;
 
-    /**
-     * Verifies the 3DS transaction status.
-     * @returns {Promise<import("../types").ITransaction | void>} The result of the 3DS verification and checkout resumption.
-     * @public
-     */
-    verify3dsTransaction(): Promise<ITransaction | void>;
+  /**
+   * Verifies the 3DS transaction status.
+   * @returns {Promise<import("../types").ITransaction | void>} The result of the 3DS verification and checkout resumption.
+   * @public
+   */
+  verify3dsTransaction(): Promise<ITransaction | void>;
 
-    /**
-     * Retrieves the list of cards associated with a customer.
-     * @returns {Promise<import("../types").ICustomerCardsResponse>} A promise that resolves with the customer's card data.
-     *
-     * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
-     *
-     * @public
-     */
-    getCustomerCards(): Promise<ICustomerCardsResponse>;
+  /**
+   * Retrieves the list of cards associated with a customer.
+   * @returns {Promise<import("../types").ICustomerCardsResponse>} A promise that resolves with the customer's card data.
+   *
+   * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  getCustomerCards(): Promise<ICustomerCardsResponse>;
 
-    /**
-     * Saves a card to a customer's account. This method can be used to add a new card
-     * or update an existing one.
-     * @param {import("../types").ISaveCardRequest} card - The card information to be saved.
-     * @returns {Promise<import("../types").ISaveCardResponse>} A promise that resolves with the saved card data.
-     *
-     * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
-     *
-     * @public
-     */
-    saveCustomerCard(
-        card: ISaveCardRequest,
-    ): Promise<ISaveCardResponse>;
+  /**
+   * Saves a card to a customer's account. This method can be used to add a new card
+   * or update an existing one.
+   * @param {import("../types").ISaveCardRequest} card - The card information to be saved.
+   * @returns {Promise<import("../types").ISaveCardResponse>} A promise that resolves with the saved card data.
+   *
+   * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  saveCustomerCard(card: ISaveCardRequest): Promise<ISaveCardResponse>;
 
-    /**
-     * Removes a card from a customer's account.
-     * @param {string} skyflowId - The unique identifier of the card to be deleted.
-     * @returns {Promise<string>} A promise that resolves when the card is successfully deleted.
-     *
-     * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
-     *
-     * @public
-     */
-    removeCustomerCard(
-        skyflowId: string,
-    ): Promise<void>;
+  /**
+   * Removes a card from a customer's account.
+   * @param {string} skyflowId - The unique identifier of the card to be deleted.
+   * @returns {Promise<string>} A promise that resolves when the card is successfully deleted.
+   *
+   * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  removeCustomerCard(skyflowId: string): Promise<void>;
 
-    /**
-     * Retrieves the list of available Alternative Payment Methods (APMs).
-     * @returns {Promise<import("../types").IPaymentMethod[]>} A promise that resolves with the list of APMs.
-     *
-     * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
-     *
-     * @public
-     */
-    getCustomerPaymentMethods(): Promise<IPaymentMethod[]>;
+  /**
+   * Retrieves the list of available Alternative Payment Methods (APMs).
+   * @returns {Promise<import("../types").IPaymentMethod[]>} A promise that resolves with the list of APMs.
+   *
+   * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  getCustomerPaymentMethods(): Promise<IPaymentMethod[]>;
 }
 
-
 export interface IInlineLiteCheckoutOptions extends IInlineCheckoutBaseOptions {}

package/types/paymentMethod.d.ts

@@ -1,24 +1,24 @@
 export interface IPaymentMethodResponse {
-    count: number;
-    next: string | null;
-    previous: string | null;
-    results: ITonderPaymentMethod[];
+  count: number;
+  next: string | null;
+  previous: string | null;
+  results: ITonderPaymentMethod[];
 }
 
 export interface ITonderPaymentMethod {
-    pk: string;
-    payment_method: string;
-    priority: number;
-    category: string;
-    unavailable_countries: string[];
-    status: string;
+  pk: string;
+  payment_method: string;
+  priority: number;
+  category: string;
+  unavailable_countries: string[];
+  status: string;
 }
 
 export interface IPaymentMethod {
-    id: string;
-    payment_method: string;
-    priority: number;
-    category: string;
-    icon: string;
-    label: string;
-}
+  id: string;
+  payment_method: string;
+  priority: number;
+  category: string;
+  icon: string;
+  label: string;
+}

package/types/transaction.d.ts

@@ -1,101 +1,101 @@
 export interface ITransaction {
+  id: number;
+  provider: string;
+  country: string;
+  currency_code: string;
+  transaction_status: string;
+  created: string;
+  modified: string;
+  operation_date: string;
+  transaction_reference: string;
+  transaction_type: string;
+  status: string;
+  amount: string;
+  related_transaction_reference?: null | string;
+  reason?: null | string;
+  is_refunded?: null | boolean;
+  is_disputed?: null | boolean;
+  number_of_payment_attempts: number;
+  card_brand?: null | string;
+  number_of_installments: number;
+  payment?: {
     id: number;
-    provider: string;
-    country: string;
-    currency_code: string;
-    transaction_status: string;
     created: string;
     modified: string;
-    operation_date: string;
-    transaction_reference: string;
-    transaction_type: string;
-    status: string;
     amount: string;
-    related_transaction_reference?: null | string;
-    reason?: null | string;
-    is_refunded?: null | boolean;
-    is_disputed?: null | boolean;
-    number_of_payment_attempts: number;
-    card_brand?: null | string;
-    number_of_installments: number;
-    payment?: {
-        id: number;
-        created: string;
-        modified: string;
-        amount: string;
-        status: string;
-        date: string;
-        paid_date: null | string;
-        source: null | string;
-        customer_order_reference: null | string;
-        client: number;
-        business: number;
-        shipping_address?: null | string;
-        billing_address?: null | string;
-        order: number;
-    };
-    checkout: {
-        id: string;
-        created: string;
-        modified: string;
-        checkout_data: {
-            name: string;
-            amount: number;
-            source: string;
-            id_ship: string;
-            currency: string;
-            order_id: number;
-            token_id: string;
-            last_name: string;
-            id_product: string;
-            ip_address: string;
-            payment_id: number;
-            return_url: string;
-            title_ship: string;
-            business_id: number;
-            checkout_id: string;
-            description: string;
-            browser_info: {
-                language: string;
-                time_zone: number;
-                user_agent: string;
-                color_depth: number;
-                screen_width: number;
-                screen_height: number;
-                javascript_enabled: boolean;
-            };
-            email_client: string;
-            phone_number: string;
-            instance_id_ship: string;
-            quantity_product: number;
-            device_session_id: null | string;
-            number_of_payment_attempts: number;
-        };
-        number_of_payment_attempts: number;
-        tried_psps: string[];
-        rejected_transactions: string[];
-        routing_step: number;
-        route_length: number;
-        last_status: string;
-        ip_address: string;
-        is_dynamic_routing: boolean;
-        is_route_finished: boolean;
-        business: number;
-        payment: number;
-    };
-    currency: {
-        id: number;
-        name: string;
-        code: string;
-        symbol: string;
-        country: null | string;
-    };
-    payment_method?: null | {
-        id: number;
-        name: string;
-        display_name: string;
-        category: string;
-        is_apm: boolean;
+    status: string;
+    date: string;
+    paid_date: null | string;
+    source: null | string;
+    customer_order_reference: null | string;
+    client: number;
+    business: number;
+    shipping_address?: null | string;
+    billing_address?: null | string;
+    order: number;
+  };
+  checkout: {
+    id: string;
+    created: string;
+    modified: string;
+    checkout_data: {
+      name: string;
+      amount: number;
+      source: string;
+      id_ship: string;
+      currency: string;
+      order_id: number;
+      token_id: string;
+      last_name: string;
+      id_product: string;
+      ip_address: string;
+      payment_id: number;
+      return_url: string;
+      title_ship: string;
+      business_id: number;
+      checkout_id: string;
+      description: string;
+      browser_info: {
+        language: string;
+        time_zone: number;
+        user_agent: string;
+        color_depth: number;
+        screen_width: number;
+        screen_height: number;
+        javascript_enabled: boolean;
+      };
+      email_client: string;
+      phone_number: string;
+      instance_id_ship: string;
+      quantity_product: number;
+      device_session_id: null | string;
+      number_of_payment_attempts: number;
     };
-    issuing_country?: null | string;
+    number_of_payment_attempts: number;
+    tried_psps: string[];
+    rejected_transactions: string[];
+    routing_step: number;
+    route_length: number;
+    last_status: string;
+    ip_address: string;
+    is_dynamic_routing: boolean;
+    is_route_finished: boolean;
+    business: number;
+    payment: number;
+  };
+  currency: {
+    id: number;
+    name: string;
+    code: string;
+    symbol: string;
+    country: null | string;
+  };
+  payment_method?: null | {
+    id: number;
+    name: string;
+    display_name: string;
+    category: string;
+    is_apm: boolean;
+  };
+  issuing_country?: null | string;
 }