tonder-web-sdk 1.12.0-beta.1 → 1.12.0-beta.11

package/types/checkout.ts

@@ -0,0 +1,118 @@
+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;
+}
+
+export type IStartCheckoutRequestWithCard = IStartCheckoutRequestBase & {
+    card: any;
+    payment_method?: never;
+};
+
+export type IStartCheckoutRequestWithPaymentMethod =
+    IStartCheckoutRequestBase & {
+    card?: never;
+    payment_method: string;
+};
+
+export type IStartCheckoutRequest =
+    | IStartCheckoutRequestWithCard
+    | IStartCheckoutRequestWithPaymentMethod;
+
+export interface IStartCheckoutIdRequest {
+    checkout_id: string;
+}
+
+export interface IStartCheckoutErrorResponse {
+    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;
+        };
+    };
+    actions: IStartCheckoutActionResponse[];
+}
+
+export interface IStartCheckoutActionResponse {
+    name: string;
+    url: string;
+    method: string;
+}
+
+
+export interface IItem {
+    description: string;
+    quantity: number;
+    price_unit: number;
+    discount: number;
+    taxes: number;
+    product_reference: 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;
+}
+
+export interface ICardFields {
+    card_number: string;
+    cvv: string;
+    expiration_month: string;
+    expiration_year: string;
+    cardholder_name: string;
+}

package/types/common.ts

@@ -0,0 +1,26 @@
+import { ICustomer } from "./customer";
+
+export interface IInlineCheckoutBaseOptions {
+  mode?: "production" | "sandbox" | "stage" | "development";
+  apiKey: string;
+  returnUrl: string;
+  callBack?: (response: any) => void;
+}
+
+export interface IConfigureCheckout {
+  customer: ICustomer;
+}
+
+export interface IApiError {
+  code: string;
+  body: Record<string, string> | string;
+  name: string;
+  message: string;
+}
+
+export interface IPublicError {
+  status: string;
+  code: number;
+  message: string;
+  detail: Record<string, any> | string;
+}

package/types/customer.ts

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

package/types/index.d.ts

@@ -1,79 +1,11 @@
-export class InlineCheckout {
-  constructor(options: InlineCheckoutOptions);
-  configureCheckout(data: { customer?: Customer }): Promise<void>;
-  injectCheckout(): Promise<void>;
-  payment(): Promise<void>;
-  verify3dsTransaction(): Promise<void>;
-}
+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 class LiteInlineCheckout {
-  constructor(options: InlineLiteCheckoutOptions);
-  configureCheckout(data: { customer?: Customer }): void;
-  injectCheckout(): Promise<void>;
-  payment(): Promise<void>;
-  verify3dsTransaction(): Promise<void>;
-  getCustomerCards(authToken: string, businessId: string | number): Promise<CustomerCards>;
-  
-  /**
-   * Saves a card to a customer's account. This method can be used to add a new card
-   * or update an existing one.
-   * @param {string} authToken - The customer's authentication token.
-   * @param {string} businessId - The business primary key.
-   * @param {Object} card - The card information to be saved.
-   * @returns {Promise<Object>} A promise that resolves with the saved card data.
-   * @public
-   */
-  saveCustomerCard(authToken: string, businessId: string, card: { card_number: string; cvv: string; expiration_month: string; expiration_year: string; cardholder_name: string; }): Promise<void>;
-  removeCustomerCard(authToken: string, skyflowId: string, businessId: string): Promise<void>;
-  getCustomerAPMs(): Promise<void>;
-}
 
-
-export interface InlineCheckoutOptions {
-  mode?: string;
-  apiKey: string;
-  returnUrl: string;
-  renderPaymentButton?: boolean;
-  callBack?: (response: any) => void;
-  styles?: Record<string, string>;
-}
-
-export interface InlineLiteCheckoutOptions {
-  mode?: string;
-  apiKey: string;
-  returnUrl: string;
-  renderPaymentButton?: boolean;
-  callBack?: (response: any) => void;
-}
-
-
-export type Customer = {
-  firstName: string;
-  lastName: string;
-  country: string;
-  street: string;
-  city: string;
-  state: string;
-  postCode: string;
-  email: string;
-  phone: string;
-};
-
-
-interface CardFields {
-  card_number: string;
-  expiration_month: string;
-  expiration_year: string;
-  skyflow_id: string;
-  card_scheme: string;
-}
-
-interface Card {
-  fields: CardFields;
-}
-
-interface CustomerCards {
-  user_id: number;
-  cards: Card[];
-}

package/types/inlineCheckout.d.ts

@@ -0,0 +1,65 @@
+import {IConfigureCheckout, IInlineCheckoutBaseOptions} from "./common";
+import {IProcessPaymentRequest, IStartCheckoutResponse} from "./checkout";
+import {ITransaction} from "./transaction";
+
+export class InlineCheckout {
+    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 {Promise<void>}.
+     * @public
+     */
+    configureCheckout(data: IConfigureCheckout): 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>;
+
+    /**
+     * 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;
+}
+
+export interface IInlineCheckoutOptions extends IInlineCheckoutBaseOptions{
+    styles?: Record<string, string>;
+    renderPaymentButton?: boolean;
+}

package/types/liteInlineCheckout.d.ts

@@ -0,0 +1,96 @@
+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);
+
+    /**
+     * 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>;
+
+    /**
+     * 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>;
+
+    /**
+     * 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>;
+
+    /**
+     * 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[]>;
+}
+
+
+export interface IInlineLiteCheckoutOptions extends IInlineCheckoutBaseOptions {}

package/types/paymentMethod.ts

@@ -0,0 +1,24 @@
+export interface IPaymentMethodResponse {
+    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;
+}
+
+export interface IPaymentMethod {
+    id: string;
+    payment_method: string;
+    priority: number;
+    category: string;
+    icon: string;
+    label: string;
+}

package/types/transaction.ts

@@ -0,0 +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;
+        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;
+    };
+    issuing_country?: null | string;
+}