tonder-web-sdk 1.16.1 → 1.16.3

package/types/checkout.d.ts

@@ -1,118 +1,116 @@
-import {ICustomer} from "./customer";
+import { ICustomer } from "./customer";
 
 export interface IStartCheckoutRequestBase {
-    name: any;
-    last_name: string;
-    email_client: any;
-    phone_number: any;
-    return_url?: string;
-    id_product: string;
-    quantity_product: number;
-    id_ship: string;
-    instance_id_ship: string;
-    amount: any;
-    title_ship: string;
-    description: string;
-    device_session_id: any;
-    token_id: string;
-    order_id: any;
-    business_id: any;
-    payment_id: any;
-    source: string;
-    browser_info?: any;
-    metadata: any;
-    currency: string;
+  name: any;
+  last_name: string;
+  email_client: any;
+  phone_number: any;
+  return_url?: string;
+  id_product: string;
+  quantity_product: number;
+  id_ship: string;
+  instance_id_ship: string;
+  amount: any;
+  title_ship: string;
+  description: string;
+  device_session_id: any;
+  token_id: string;
+  order_id: any;
+  business_id: any;
+  payment_id: any;
+  source: string;
+  browser_info?: any;
+  metadata: any;
+  currency: string;
 }
 
 export type IStartCheckoutRequestWithCard = IStartCheckoutRequestBase & {
-    card: any;
-    payment_method?: never;
+  card: any;
+  payment_method?: never;
 };
 
-export type IStartCheckoutRequestWithPaymentMethod =
-    IStartCheckoutRequestBase & {
-    card?: never;
-    payment_method: string;
+export type IStartCheckoutRequestWithPaymentMethod = IStartCheckoutRequestBase & {
+  card?: never;
+  payment_method: string;
 };
 
 export type IStartCheckoutRequest =
-    | IStartCheckoutRequestWithCard
-    | IStartCheckoutRequestWithPaymentMethod;
+  | IStartCheckoutRequestWithCard
+  | IStartCheckoutRequestWithPaymentMethod;
 
 export interface IStartCheckoutIdRequest {
-    checkout_id: string;
+  checkout_id: string;
 }
 
 export interface IStartCheckoutErrorResponse {
-    status: string;
-    message: string;
-    psp_response: [
-        {
-            status: number;
-            response: Object;
-        },
-    ];
-    checkout_id: string;
-    is_route_finished: boolean;
+  status: string;
+  message: string;
+  psp_response: [
+    {
+      status: number;
+      response: Object;
+    },
+  ];
+  checkout_id: string;
+  is_route_finished: boolean;
 }
 
 export interface IStartCheckoutResponse {
-    status: string;
-    message: string;
-    psp_response: Record<string, any>;
-    checkout_id: string;
-    is_route_finished: Boolean;
-    transaction_status: string;
-    transaction_id: number;
-    payment_id: number;
-    provider: string;
-    next_action: {
-        redirect_to_url: {
-            url: string;
-            return_url: string;
-            verify_transaction_status_url: string;
-        };
-        iframe_resources?: {
-            iframe: string;
-        };
+  status: string;
+  message: string;
+  psp_response: Record<string, any>;
+  checkout_id: string;
+  is_route_finished: Boolean;
+  transaction_status: string;
+  transaction_id: number;
+  payment_id: number;
+  provider: string;
+  next_action: {
+    redirect_to_url: {
+      url: string;
+      return_url: string;
+      verify_transaction_status_url: string;
     };
-    actions: IStartCheckoutActionResponse[];
+    iframe_resources?: {
+      iframe: string;
+    };
+  };
+  actions: IStartCheckoutActionResponse[];
 }
 
 export interface IStartCheckoutActionResponse {
-    name: string;
-    url: string;
-    method: string;
+  name: string;
+  url: string;
+  method: string;
 }
 
-
 export interface IItem {
-    description: string;
-    quantity: number;
-    price_unit: number;
-    discount: number;
-    taxes: number;
-    product_reference: string | number;
-    name: string;
-    amount_total: number;
+  description: string;
+  quantity: number;
+  price_unit: number;
+  discount: number;
+  taxes: number;
+  product_reference: string | number;
+  name: string;
+  amount_total: number;
 }
 
 export interface IProcessPaymentRequest {
-    customer: ICustomer;
-    cart: {
-        total: string | number;
-        items: IItem[];
-    };
-    metadata?: Record<string, any>;
-    currency?: string;
-    payment_method?: string;
-    card?: ICardFields | string;
+  customer: ICustomer;
+  cart: {
+    total: string | number;
+    items: IItem[];
+  };
+  metadata?: Record<string, any>;
+  currency?: string;
+  payment_method?: string;
+  card?: ICardFields | string;
 }
 
 export interface ICardFields {
-    card_number: string;
-    cvv: string;
-    expiration_month: string;
-    expiration_year: string;
-    cardholder_name: string;
-}
+  card_number: string;
+  cvv: string;
+  expiration_month: string;
+  expiration_year: string;
+  cardholder_name: string;
+}

package/types/common.d.ts

@@ -1,5 +1,5 @@
 import { ICustomer } from "./customer";
-import {IProcessPaymentRequest} from "./checkout";
+import { IProcessPaymentRequest } from "./checkout";
 
 export interface IInlineCheckoutBaseOptions {
   mode?: "production" | "sandbox" | "stage" | "development";
@@ -8,7 +8,7 @@ export interface IInlineCheckoutBaseOptions {
   callBack?: (response: any) => void;
 }
 
-export interface IConfigureCheckout extends IProcessPaymentRequest{
+export interface IConfigureCheckout extends Partial<IProcessPaymentRequest> {
   customer: ICustomer;
   secureToken: string;
 }
@@ -26,3 +26,5 @@ export interface IPublicError {
   message: string;
   detail: Record<string, any> | string;
 }
+
+export interface IBaseCallback {}

package/types/customer.d.ts

@@ -1,12 +1,12 @@
 export type ICustomer = {
-    firstName: string;
-    lastName: string;
-    country?: string;
-    street?: string;
-    city?: string;
-    state?: string;
-    postCode?: string;
-    email: string;
-    phone?: string;
-    address?: string;
+  firstName: string;
+  lastName: string;
+  country?: string;
+  street?: string;
+  city?: string;
+  state?: string;
+  postCode?: string;
+  email: string;
+  phone?: string;
+  address?: string;
 };

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;
+}