@tonder.io/ionic-lite-sdk 0.0.34-beta.3 → 0.0.35-beta.1

package/src/types/liteInlineCheckout.d.ts

@@ -0,0 +1,191 @@
+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 {
+    CreateOrderRequest,
+    CreatePaymentRequest,
+    RegisterCustomerCardRequest,
+    StartCheckoutFullRequest,
+    StartCheckoutIdRequest,
+    StartCheckoutRequest, TokensRequest
+} from "./requests";
+import {
+    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[]>;
+
+    // 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 getSkyflowTokens({vault_id, vault_url, data}: TokensRequest): Promise<any | ErrorResponse>
+}
+
+
+export interface IInlineLiteCheckoutOptions extends IInlineCheckoutBaseOptions {}

package/src/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/src/types/requests.ts

@@ -1,5 +1,5 @@
-import { OrderItem } from "./commons";
 import { SkyflowRecord } from "./skyflow";
+import {IItem} from "./checkout";
 
 export interface CreateOrderRequest {
     business: string,
@@ -10,7 +10,7 @@ export interface CreateOrderRequest {
     status?: string,
     reference: string | number,
     is_oneclick: boolean,
-    items: OrderItem[]
+    items: IItem[]
 }
 
 export type CreatePaymentRequest = {
@@ -71,6 +71,15 @@ export type RegisterCustomerCardRequest = {
     skyflow_id: string;
 }
 
+export type TokensSkyflowRequest = {
+    baseUrl: string;
+    apiKey: string;
+    vault_id: string,
+    vault_url: string,
+    data: {
+        [key: string]: any;
+    }
+}
 export type TokensRequest = {
     vault_id: string,
     vault_url: string,
@@ -81,7 +90,7 @@ export type TokensRequest = {
 
 export type StartCheckoutFullRequest = {
     order: {
-        items: OrderItem[];
+        items: IItem[];
     };
     total: number;
     customer: {

package/src/types/validations.d.ts

@@ -0,0 +1,11 @@
+export declare function validateCardNumber(cardNumber: string): boolean;
+
+export declare function validateCardholderName(name: string): boolean;
+
+export declare function validateCVV(cvv: string): boolean;
+
+export declare function validateExpirationMonth(month: string): boolean;
+
+export declare function validateExpirationYear(year: string): boolean;
+
+export declare function validateExpirationDateParts(month: string, year: string): boolean;

package/tests/classes/liteCheckout.test.ts

@@ -38,9 +38,9 @@ describe("LiteCheckout", () => {
 
     it("Can instance LiteCheckout", () => {
         expect(liteCheckout).toBeInstanceOf(LiteCheckout);
-        expect(liteCheckout.apiKeyTonder).toEqual(constructorFields.apiKeyTonder);
-        expect(liteCheckout.baseUrlTonder).toEqual(constructorFields.baseUrlTonder);
-        expect(liteCheckout.signal).toEqual(constructorFields.signal);
+        expect(liteCheckout.apiKeyTonder).toEqual(constructorFields.apiKey);
+        expect(liteCheckout.baseUrl).toEqual(constructorFields.baseUrl);
+        expect(liteCheckout.abortController.signal).toEqual(constructorFields.signal);
     });
 
 

package/tests/methods/getBusiness.test.ts

@@ -84,7 +84,7 @@ describe("getBusiness", () => {
         let error: ErrorResponse;
 
         try {
-            const response = (await liteCheckout.getBusiness()) as IErrorResponse;
+            const response = (await liteCheckout.getBusiness());
         } catch (e: any) {
             error = e;
             expect(error.code).toStrictEqual("400");
@@ -100,7 +100,7 @@ describe("getBusiness", () => {
         let error: ErrorResponse;
 
         try {
-            const response = (await liteCheckout.getBusiness()) as ErrorResponse;
+            const response = (await liteCheckout.getBusiness());
         } catch (e: any) {
             error = e;
             expect(error.message).toStrictEqual("error");

package/tests/methods/getCustomerCards.test.ts

@@ -48,7 +48,7 @@ describe("getCustomerCards", () => {
             })
         );
 
-        const response = await liteCheckout.getCustomerCards("1234");
+        const response = await liteCheckout.getCustomerCards();
 
         expect(response).toStrictEqual({ ...new GetCustomerCardsResponseClass() });
         expect(liteCheckoutSpy).toHaveBeenCalled();
@@ -65,7 +65,7 @@ describe("getCustomerCards", () => {
             })
         );
 
-        const response = await liteCheckout.getCustomerCards("1234");
+        const response = await liteCheckout.getCustomerCards();
         expect(liteCheckoutSpy).toHaveBeenCalled();
         expect(liteCheckoutSpy).toHaveReturned();
         expect(response).toBeUndefined();
@@ -85,9 +85,7 @@ describe("getCustomerCards", () => {
         let error: ErrorResponse;
 
         try {
-            const response = (await liteCheckout.getCustomerCards(
-                "1234"
-            )) as IErrorResponse;
+            const response = (await liteCheckout.getCustomerCards());
         } catch (e: any) {
             error = e;
             expect(error.code).toStrictEqual("400");
@@ -103,9 +101,7 @@ describe("getCustomerCards", () => {
         let error: ErrorResponse;
 
         try {
-            const response = (await liteCheckout.getCustomerCards(
-                "1234"
-            )) as IErrorResponse;
+            const response = (await liteCheckout.getCustomerCards());
         } catch (e: any) {
             error = e;
             expect(error.message).toStrictEqual("error");

package/tests/utils/defaultMock.ts

@@ -16,6 +16,7 @@ const abortSignal = new AbortController().signal;
 
 export const constructorFields = {
     signal: abortSignal,
-    baseUrlTonder: "",
-    apiKeyTonder: "",
+    baseUrl: "",
+    apiKey: "",
+    returnUrl: ""
 };

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,13 +555,17 @@ 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: "",
             vault_id: "string",
             vault_url: "string",
             data: {

package/tests/methods/getOpenpayDeviceSessionID.test.ts

@@ -1,95 +0,0 @@
-import "../utils/defaultMock";
-import { LiteCheckout } from "../../src";
-import { ErrorResponse } from "../../src/classes/errorResponse";
-import { LiteCheckoutConstructor } from "../../src/classes/liteCheckout";
-import { IErrorResponse } from "../../src/types/responses";
-import { constructorFields } from "../utils/defaultMock";
-
-declare global {
-    interface Window {
-        OpenPay: any;
-        Skyflow: any;
-    }
-}
-
-describe("getOpenpayDeviceSessionID", () => {
-    let checkoutConstructor: LiteCheckoutConstructor,
-        liteCheckout: LiteCheckout,
-        fetchSpy: jest.SpyInstance,
-        liteCheckoutSpy: jest.SpyInstance;
-
-    beforeEach(async () => {
-        window.fetch = jest.fn();
-
-        checkoutConstructor = {
-            ...constructorFields,
-        };
-
-        liteCheckout = new LiteCheckout(constructorFields);
-
-        fetchSpy = jest.spyOn(global, "fetch");
-    });
-
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-
-    it("getOpenpayDeviceSessionID success", async () => {
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getOpenpayDeviceSessionID");
-
-        window.OpenPay = {
-            setId: jest.fn(),
-            setApiKey: jest.fn(),
-            setSandboxMode: jest.fn(),
-            deviceData: {
-                setup: jest.fn().mockImplementation(() => Promise.resolve("test")),
-            },
-        };
-
-        expect(
-            liteCheckout.getOpenpayDeviceSessionID("4321", "1234", true)
-        ).resolves.toBe("test");
-        expect(liteCheckoutSpy).toHaveBeenCalledWith("4321", "1234", true);
-    });
-
-    it("getOpenpayDeviceSessionID empty", async () => {
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getOpenpayDeviceSessionID");
-
-        window.OpenPay = {
-            setId: jest.fn(),
-            setApiKey: jest.fn(),
-            setSandboxMode: jest.fn(),
-            deviceData: {
-                setup: jest.fn().mockImplementation(() => Promise.resolve()),
-            },
-        };
-
-        expect(
-            liteCheckout.getOpenpayDeviceSessionID("", "", true)
-        ).resolves.toBeUndefined();
-        expect(liteCheckoutSpy).toHaveBeenCalledWith("", "", true);
-    });
-
-    it("getOpenpayDeviceSessionID error", async () => {
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getOpenpayDeviceSessionID");
-
-        window.OpenPay = {
-            setId: jest.fn(),
-            setApiKey: jest.fn(),
-            setSandboxMode: jest.fn(),
-            deviceData: {
-                setup: jest.fn().mockRejectedValue("error"),
-            },
-        };
-
-        try {
-            await liteCheckout.getOpenpayDeviceSessionID("", "", true);
-        } catch (e) {
-            const error: IErrorResponse = e as IErrorResponse;
-            expect(liteCheckoutSpy).toHaveBeenCalledWith("", "", true);
-            expect(liteCheckoutSpy).toHaveReturned();
-            expect(error.message).toStrictEqual("error");
-            expect(error).toBeInstanceOf(ErrorResponse);
-        }
-    });
-});

package/tests/methods/getSkyflowToken.test.ts

@@ -1,155 +0,0 @@
-import "../utils/defaultMock";
-import Skyflow from "skyflow-js";
-import { LiteCheckout } from "../../src";
-import { ErrorResponse } from "../../src/classes/errorResponse";
-import { LiteCheckoutConstructor } from "../../src/classes/liteCheckout";
-import { IErrorResponse } from "../../src/types/responses";
-import { constructorFields } from "../utils/defaultMock";
-import { TokensRequestClass } from "../utils/mockClasses";
-
-
-declare global {
-    interface Window {
-        OpenPay: any;
-        Skyflow: any;
-    }
-}
-
-describe("getSkyflowToken", () => {
-    let checkoutConstructor: LiteCheckoutConstructor,
-        liteCheckout: LiteCheckout,
-        fetchSpy: jest.SpyInstance,
-        liteCheckoutSpy: jest.SpyInstance;
-
-    beforeEach(async () => {
-        window.fetch = jest.fn();
-
-        checkoutConstructor = {
-            ...constructorFields,
-        };
-
-        liteCheckout = new LiteCheckout(constructorFields);
-
-        fetchSpy = jest.spyOn(global, "fetch");
-    });
-
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-
-    it("getSkyflowTokens success", async () => {
-        liteCheckout.getVaultToken = jest
-            .fn()
-            .mockImplementation(() => Promise.resolve("1234"));
-
-        liteCheckout.getFieldsPromise = jest
-            .fn()
-            .mockImplementation(() =>
-                Promise.resolve(new Array(5).fill(Promise.resolve(true)))
-            );
-
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getSkyflowTokens");
-
-        const response = await liteCheckout.getSkyflowTokens({
-            ...new TokensRequestClass(),
-        });
-        expect(response).toStrictEqual("1234");
-        expect(liteCheckoutSpy).toHaveBeenCalled();
-    });
-
-    it("getSkyflowTokens empty", async () => {
-        liteCheckout.getVaultToken = jest
-            .fn()
-            .mockImplementation(() => Promise.resolve(""));
-
-        jest.spyOn(Skyflow, "init").mockImplementation(jest.fn().mockImplementation(() => ({
-            container: () => ({
-                collect: jest.fn().mockResolvedValue(""),
-            }),
-        })));
-
-        liteCheckout.getFieldsPromise = jest
-            .fn()
-            .mockImplementation(() =>
-                Promise.resolve(new Array(5).fill(Promise.resolve(true)))
-            );
-
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getSkyflowTokens");
-
-        let error: ErrorResponse;
-
-        try {
-            const response = await liteCheckout.getSkyflowTokens({
-                ...new TokensRequestClass(),
-            }) as IErrorResponse;
-        } catch (e: any) {
-            error = e;
-            expect(error).toBeInstanceOf(ErrorResponse);
-            expect(error.message).toStrictEqual("Por favor, verifica todos los campos de tu tarjeta");
-        }
-    });
-
-    it("getSkyflowTokens error mount fields", async () => {
-        liteCheckout.getVaultToken = jest
-            .fn()
-            .mockImplementation(() => Promise.resolve(""));
-
-        jest.spyOn(Skyflow, "init").mockImplementation(jest.fn().mockImplementation(() => ({
-            container: () => ({
-                collect: jest.fn().mockResolvedValue(""),
-            }),
-        })));
-
-        liteCheckout.getFieldsPromise = jest
-            .fn()
-            .mockImplementation(() =>
-                new Array(5).fill(false)
-            );
-
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getSkyflowTokens");
-
-        let error: ErrorResponse;
-
-        try {
-            const response = (await liteCheckout.getSkyflowTokens({
-                ...new TokensRequestClass(),
-            })) as IErrorResponse;
-        } catch (e: any) {
-            error = e;
-            expect(error).toBeInstanceOf(ErrorResponse);
-            expect(error.message).toStrictEqual("Ocurrió un error al montar los campos de la tarjeta");
-        }
-    });
-
-    it("getSkyflowTokens error collect catch", async () => {
-        liteCheckout.getVaultToken = jest
-            .fn()
-            .mockImplementation(() => Promise.resolve("1234"));
-
-        jest.spyOn(Skyflow, "init").mockImplementation(jest.fn().mockImplementation(() => ({
-            container: () => ({
-                collect: jest.fn().mockRejectedValue("error"),
-            }),
-        })));
-
-        liteCheckout.getFieldsPromise = jest
-            .fn()
-            .mockImplementation(() =>
-                Promise.resolve(new Array(5).fill(Promise.resolve(true)))
-            );
-
-        liteCheckoutSpy = jest.spyOn(liteCheckout, "getSkyflowTokens");
-
-        let error: ErrorResponse;
-
-        try {
-            const response = (await liteCheckout.getSkyflowTokens({
-                ...new TokensRequestClass(),
-            })) as IErrorResponse;
-        } catch (e: any) {
-            error = e;
-            expect(error.message).toStrictEqual("error");
-            expect(error).toBeInstanceOf(ErrorResponse);
-        }
-    });
-});