@tonder.io/ionic-lite-sdk 0.0.35-beta.0 → 0.0.35-beta.10

package/src/types/liteInlineCheckout.d.ts

@@ -1,183 +1,224 @@
-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 {APM} from "./commons";
-import {ErrorResponse} from "../classes/errorResponse";
+import { IConfigureCheckout, IInlineCheckoutBaseOptions } from "./commons";
 import {
-    CreateOrderRequest,
-    CreatePaymentRequest,
-    RegisterCustomerCardRequest,
-    StartCheckoutFullRequest,
-    StartCheckoutIdRequest,
-    StartCheckoutRequest
+  ICustomerCardsResponse,
+  ISaveCardRequest,
+  ISaveCardResponse,
+} from "./card";
+import { IPaymentMethod } from "./paymentMethod";
+import { IProcessPaymentRequest, IStartCheckoutResponse } from "./checkout";
+import { ITransaction } from "./transaction";
+import { APM } from "./commons";
+import { ErrorResponse } from "../classes/errorResponse";
+import {
+  CreateOrderRequest,
+  CreatePaymentRequest,
+  RegisterCustomerCardRequest,
+  StartCheckoutFullRequest,
+  StartCheckoutIdRequest,
+  StartCheckoutRequest,
+  TokensRequest,
 } from "./requests";
 import {
-    CreateOrderResponse,
-    CreatePaymentResponse, CustomerRegisterResponse, GetBusinessResponse,
-    RegisterCustomerCardResponse,
-    StartCheckoutResponse
+  CreateOrderResponse,
+  CreatePaymentResponse,
+  CustomerRegisterResponse,
+  GetBusinessResponse,
+  RegisterCustomerCardResponse,
+  StartCheckoutResponse,
 } from "./responses";
 
-export class ILiteInlineCheckout {
-    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<string>;
-
-    /**
-     * 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 business information.
-     * @returns {Promise<import("../types").GetBusinessResponse>} A promise that resolves with the business information.
-     *
-     * @throws {import("../types").IPublicError} Throws an error object if the operation fails.
-     *
-     * @public
-     */
-    getBusiness(): Promise<GetBusinessResponse>;
-
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * It is no longer necessary to use this method as customer registration is now automatically handled
-     * during the payment process or when using card management methods.
-     */
-    async customerRegister(email: string): Promise<CustomerRegisterResponse | ErrorResponse>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * It is no longer necessary to use this method as order creation is now automatically
-     * handled when making a payment through the `payment` function.
-     */
-    async createOrder(orderItems: CreateOrderRequest): Promise<CreateOrderResponse | ErrorResponse>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * It is no longer necessary to use this method as payment creation is now automatically
-     * handled when making a payment through the `payment` function.
-     */
-    async createPayment(paymentItems: CreatePaymentRequest): Promise<CreatePaymentResponse | ErrorResponse>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * Use the {@link payment} method
-     */
-    async startCheckoutRouter(routerData: StartCheckoutRequest | StartCheckoutIdRequest): Promise<StartCheckoutResponse | ErrorResponse | undefined>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * Use the {@link payment} method
-     */
-    async startCheckoutRouterFull(routerFullData: StartCheckoutFullRequest): Promise<StartCheckoutResponse | ErrorResponse | undefined>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * Use the {@link saveCustomerCard} method
-     */
-    async registerCustomerCard(customerToken: string, data: RegisterCustomerCardRequest): Promise<RegisterCustomerCardResponse | ErrorResponse>
-
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * Use the {@link removeCustomerCard} method
-     */
-    async deleteCustomerCard(customerToken: string, skyflowId: string = ""): Promise<Boolean | ErrorResponse>
-
-    // TODO: DEPRECATED
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     * Use the {@link getCustomerPaymentMethods} method
-     */
-    async getActiveAPMs(): Promise<APM[]>;
+export class LiteCheckout {
+  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("./index").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("./index").IProcessPaymentRequest} data - Payment data including customer, cart, and other relevant information.
+   * @returns {Promise<import("./index").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("./index").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("./index").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("./index").ICustomerCardsResponse>} A promise that resolves with the customer's card data.
+   *
+   * @throws {import("./index").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("./index").ISaveCardRequest} card - The card information to be saved.
+   * @returns {Promise<import("./index").ISaveCardResponse>} A promise that resolves with the saved card data.
+   *
+   * @throws {import("./index").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("./index").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  removeCustomerCard(skyflowId: string): Promise<string>;
+
+  /**
+   * Retrieves the list of available Alternative Payment Methods (APMs).
+   * @returns {Promise<import("./index").IPaymentMethod[]>} A promise that resolves with the list of APMs.
+   *
+   * @throws {import("./index").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  getCustomerPaymentMethods(): Promise<IPaymentMethod[]>;
+
+  /**
+   * Retrieves the business information.
+   * @returns {Promise<import("./index").GetBusinessResponse>} A promise that resolves with the business information.
+   *
+   * @throws {import("./index").IPublicError} Throws an error object if the operation fails.
+   *
+   * @public
+   */
+  getBusiness(): Promise<GetBusinessResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * It is no longer necessary to use this method as customer registration is now automatically handled
+   * during the payment process or when using card management methods.
+   */
+  customerRegister(
+    email: string,
+  ): Promise<CustomerRegisterResponse | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * It is no longer necessary to use this method as order creation is now automatically
+   * handled when making a payment through the `payment` function.
+   */
+  createOrder(
+    orderItems: CreateOrderRequest,
+  ): Promise<CreateOrderResponse | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * It is no longer necessary to use this method as payment creation is now automatically
+   * handled when making a payment through the `payment` function.
+   */
+  createPayment(
+    paymentItems: CreatePaymentRequest,
+  ): Promise<CreatePaymentResponse | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * Use the {@link payment} method
+   */
+  startCheckoutRouter(
+    routerData: StartCheckoutRequest | StartCheckoutIdRequest,
+  ): Promise<StartCheckoutResponse | ErrorResponse | undefined>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * Use the {@link payment} method
+   */
+  startCheckoutRouterFull(
+    routerFullData: StartCheckoutFullRequest,
+  ): Promise<StartCheckoutResponse | ErrorResponse | undefined>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * Use the {@link saveCustomerCard} method
+   */
+  registerCustomerCard(
+    customerToken: string,
+    data: RegisterCustomerCardRequest,
+  ): Promise<RegisterCustomerCardResponse | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * Use the {@link removeCustomerCard} method
+   */
+  deleteCustomerCard(
+    customerToken: string,
+    skyflowId: string,
+  ): Promise<Boolean | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * Use the {@link getCustomerPaymentMethods} method
+   */
+  getActiveAPMs(): Promise<APM[]>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * It is no longer necessary to use this method as customer registration is now automatically handled
+   * during the payment process or when using card management methods.
+   */
+  getSkyflowTokens({
+    vault_id,
+    vault_url,
+    data,
+  }: TokensRequest): Promise<any | ErrorResponse>;
+
+  // TODO: DEPRECATED
+  /**
+   * @deprecated This method is deprecated and will be removed in a future release.
+   * It is no longer necessary to use this method is now automatically handled
+   * during the payment process.
+   */
+  getOpenpayDeviceSessionID(
+    merchant_id: string,
+    public_key: string,
+    is_sandbox: boolean,
+  ): Promise<string | ErrorResponse>;
 }
 
-
-export interface IInlineLiteCheckoutOptions extends IInlineCheckoutBaseOptions {}
+export interface IInlineLiteCheckoutOptions
+  extends IInlineCheckoutBaseOptions {}

package/src/types/requests.ts

@@ -71,7 +71,7 @@ export type RegisterCustomerCardRequest = {
     skyflow_id: string;
 }
 
-export type TokensRequest = {
+export type TokensSkyflowRequest = {
     baseUrl: string;
     apiKey: string;
     vault_id: string,
@@ -80,6 +80,13 @@ export type TokensRequest = {
         [key: string]: any;
     }
 }
+export type TokensRequest = {
+    vault_id: string,
+    vault_url: string,
+    data: {
+        [key: string]: any;
+    }
+}
 
 export type StartCheckoutFullRequest = {
     order: {

package/src/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;
+}

package/tests/utils/mockClasses.ts

@@ -4,9 +4,8 @@ import {
     CreatePaymentRequest,
     RegisterCustomerCardRequest,
     StartCheckoutRequest,
-    TokensRequest,
     StartCheckoutFullRequest,
-    StartCheckoutRequestWithCard
+    StartCheckoutRequestWithCard, TokensSkyflowRequest
 } from "../../src/types/requests";
 import {
     CreateOrderResponse,
@@ -556,14 +555,14 @@ export class StartCheckoutFullRequestClass implements StartCheckoutFullRequest {
     }
 }
 
-export class TokensRequestClass implements TokensRequest {
+export class TokensRequestClass implements TokensSkyflowRequest {
     baseUrl!: string;
     apiKey!: string;
     vault_id!: string;
     vault_url!: string;
     data: { [key: string]: any } = {};
 
-    get mockObject(): TokensRequest {
+    get mockObject(): TokensSkyflowRequest {
         return {
             baseUrl: "",
             apiKey: "",