@tonder.io/ionic-lite-sdk 0.0.35-beta.4 → 0.0.35-beta.6

package/src/types/commons.ts

@@ -0,0 +1,125 @@
+import {ICustomer} from "./customer";
+
+export type Business = {
+    business: {
+        pk: number;
+        name: string;
+        categories: {
+            pk: number;
+            name: string;
+        }[];
+        web: string;
+        logo: string;
+        full_logo_url: string;
+        background_color: string;
+        primary_color: string;
+        checkout_mode: boolean;
+        textCheckoutColor: string;
+        textDetailsColor: string;
+        checkout_logo: string;
+    };
+    openpay_keys: {
+        merchant_id: string;
+        public_key: string;
+    };
+    fintoc_keys: {
+        public_key: string;
+    };
+    mercado_pago: {
+        active: boolean;
+    };
+    vault_id: string;
+    vault_url: string;
+    reference: number;
+    is_installments_available: boolean;
+};
+
+export type Customer = {
+    firstName: string;
+    lastName: string;
+    country: string;
+    street: string;
+    city: string;
+    state: string;
+    postCode: string;
+    email: string;
+    phone: string;
+};
+
+export type OrderItem = {
+    description: string;
+    quantity: number;
+    price_unit: number;
+    discount: number;
+    taxes: number;
+    product_reference: number;
+    name: string;
+    amount_total: number;
+};
+
+export type PaymentData = {
+    customer: Customer;
+    currency: string;
+    cart: {
+        total: string | number;
+        items: OrderItem[];
+    };
+};
+
+export type TonderAPM = {
+    pk: string;
+    payment_method: string;
+    priority: number;
+    category: string;
+    unavailable_countries: string[];
+    status: string;
+}
+
+export type APM = {
+    id: string;
+    payment_method: string;
+    priority: number;
+    category: string;
+    icon: string;
+    label: string;
+}
+
+
+export interface IConfigureCheckout {
+    customer: ICustomer;
+}
+
+export interface IInlineCheckoutBaseOptions {
+    mode?: "production" | "sandbox" | "stage" | "development";
+    /**
+     * @deprecated This property is deprecated and will be removed in a future release.
+     * `baseUrlTonder` is no longer required.
+     */
+    baseUrlTonder?: string;
+    /**
+     * @deprecated This property is deprecated and will be removed in a future release.
+     * Use `apiKey` instead, as `apiKeyTonder` is no longer required.
+     */
+    apiKeyTonder?: string;
+    /**
+     * @deprecated This property is deprecated and will be removed in a future release.
+     * `signal` is no longer required.
+     */
+    signal?: AbortSignal;
+    apiKey: string;
+    returnUrl: string;
+    callBack?: (response: any) => void;
+}
+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/src/types/customer.ts

@@ -0,0 +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;
+};

package/src/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from './card';
+export * from './checkout';
+export * from './commons';
+export * from './customer';
+export * from './paymentMethod';
+export * from './liteInlineCheckout';
+export * from './validations';
+export * from './responses';
+export * from './requests';
+

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 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.
+     */
+    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

@@ -0,0 +1,115 @@
+import { SkyflowRecord } from "./skyflow";
+import {IItem} from "./checkout";
+
+export interface CreateOrderRequest {
+    business: string,
+    client: string,
+    billing_address_id?: number | null,
+    shipping_address_id?: number | null,
+    amount: number,
+    status?: string,
+    reference: string | number,
+    is_oneclick: boolean,
+    items: IItem[]
+}
+
+export type CreatePaymentRequest = {
+    business_pk?: string | number,
+    amount: number,
+    date?: string,
+    order_id?: string | number
+    client_id?: string | number
+}
+
+export type StartCheckoutRequestBase = {
+    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 StartCheckoutRequestWithCard = StartCheckoutRequestBase & {
+    card: any,
+    payment_method?: never,
+}
+
+export type StartCheckoutRequestWithPaymentMethod = StartCheckoutRequestBase & {
+    card?: never,
+    payment_method: string,
+}
+
+export type StartCheckoutRequest = StartCheckoutRequestWithCard | StartCheckoutRequestWithPaymentMethod;
+
+export type StartCheckoutIdRequest = { 
+    checkout_id: any
+}
+
+export interface VaultRequest extends SkyflowRecord {
+    records: SkyflowRecord[],
+    continueOnError?: boolean,
+    byot?: "DISABLE" | "ENABLE" | "ENABLE_STRICT"
+}
+
+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,
+    data: {
+        [key: string]: any;
+    }
+}
+
+export type StartCheckoutFullRequest = {
+    order: {
+        items: IItem[];
+    };
+    total: number;
+    customer: {
+        name: string;
+        lastname: string;
+        email: string;
+        phone: string;
+    };
+    skyflowTokens: {
+        cardholder_name: string;
+        card_number: string;
+        cvv: string;
+        expiration_year: string;
+        expiration_month: string;
+        skyflow_id: string;
+    };
+    return_url: string;
+    isSandbox: boolean;
+    metadata: any;
+    currency: string;
+    payment_method?: string;
+}

package/src/types/responses.ts

@@ -0,0 +1,189 @@
+import { Business } from "./commons";
+
+export interface IErrorResponse extends Error {
+    code?: string;
+    body?: string;
+}
+
+export interface GetBusinessResponse extends Business { }
+
+export type GetVaultTokenResponse = {
+    token: string;
+};
+
+export type CustomerRegisterResponse = {
+    id: number | string;
+    email: string;
+    auth_token: string;
+};
+
+export type CreateOrderResponse = {
+    id: number | string;
+    created: string;
+    amount: string;
+    status: string;
+    payment_method?: string;
+    reference?: string;
+    is_oneclick: boolean;
+    items: {
+        description: string;
+        product_reference: string;
+        quantity: string;
+        price_unit: string;
+        discount: string;
+        taxes: string;
+        amount_total: string;
+    }[];
+    billing_address?: string;
+    shipping_address?: string;
+    client: {
+        email: string;
+        name: string;
+        first_name: string;
+        last_name: string;
+        client_profile: {
+            gender: string;
+            date_birth?: string;
+            terms: boolean;
+            phone: string;
+        };
+    };
+};
+
+export type CreatePaymentResponse = {
+    pk: number | string;
+    order?: string;
+    amount: string;
+    status: string;
+    date: string;
+    paid_date?: string;
+    shipping_address: {
+        street: string;
+        number: string;
+        suburb: string;
+        city: {
+            name: string;
+        };
+        state: {
+            name: string;
+            country: {
+                name: string;
+            };
+        };
+        zip_code: string;
+    };
+    shipping_address_id?: string;
+    billing_address: {
+        street: string;
+        number: string;
+        suburb: string;
+        city: {
+            name: string;
+        };
+        state: {
+            name: string;
+            country: {
+                name: string;
+            };
+        };
+        zip_code: string;
+    };
+    billing_address_id?: string;
+    client?: string;
+    customer_order_reference?: string;
+};
+
+export type StartCheckoutResponse = {
+    status: number;
+    message: string;
+    psp_response: {
+        id: string;
+        authorization: number;
+        operation_type: string;
+        transaction_type: string;
+        status: string;
+        conciliated: boolean;
+        creation_date: string;
+        operation_date: string;
+        description: string;
+        error_message?: string;
+        order_id?: string;
+        card: {
+            type: string;
+            brand: string;
+            address?: string;
+            card_number: string;
+            holder_name: string;
+            expiration_year: string;
+            expiration_month: string;
+            allows_charges: boolean;
+            allows_payouts: boolean;
+            bank_name: string;
+            points_type: string;
+            points_card: boolean;
+            bank_code: number;
+        };
+        customer_id: string;
+        gateway_card_present: string;
+        amount: number;
+        fee: {
+            amount: number;
+            tax: number;
+            currency: string;
+        };
+        payment_method: {
+            type: string;
+            url: string;
+        };
+        currency: string;
+        method: string;
+        object: 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: {
+        name: string;
+        url: string;
+        method: string;
+    }[];
+};
+
+export type TokensResponse = {
+    vaultID: string;
+    responses: {
+        [key: string]: string;
+    }[];
+};
+
+export type GetCustomerCardsResponse = {
+    user_id: number;
+    cards: {
+        fields: {
+            card_scheme: string;
+            card_number: string;
+            cardholder_name: string;
+            cvv: string;
+            expiration_month: string;
+            expiration_year: string;
+            skyflow_id: string;
+        };
+    }[];
+};
+
+export type RegisterCustomerCardResponse = {
+    skyflow_id: string;
+    user_id: number;
+};

package/src/types/skyflow.ts

@@ -0,0 +1,17 @@
+export type SkyflowRecord = {
+    method: string;
+    quorum?: boolean;
+    tableName: string;
+    fields?: {
+        [key: string]: string;
+    },
+    ID?: string,
+    tokenization?: boolean,
+    batchID?: string,
+    redaction?: "DEFAULT" | "REDACTED" | "MASKED" | "PLAIN_TEXT",
+    downloadURL?: boolean,
+    upsert?: string,
+    tokens?: {
+        [key: string]: string;
+    }
+}

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/methods/createOrder.test.ts

@@ -2,7 +2,7 @@ import "../utils/defaultMock";
 import { LiteCheckout } from "../../src";
 import { ErrorResponse } from "../../src/classes/errorResponse";
 import { LiteCheckoutConstructor } from "../../src/classes/liteCheckout";
-import { IErrorResponse } from "../../types/responses";
+import { IErrorResponse } from "../../src/types/responses";
 import { constructorFields } from "../utils/defaultMock";
 import { OrderResponseClass, OrderClass, OrderClassEmptyValues, OrderEmptyValuesResponse } from "../utils/mockClasses";