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

package/dist/types/transaction.d.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonder.io/ionic-lite-sdk",
-  "version": "0.0.35-beta.3",
+  "version": "0.0.35-beta.31",
   "description": "Tonder ionic lite SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,6 +12,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "lodash.get": "^4.4.2",
     "skyflow-js": "^1.34.1",
     "ts-node": "^10.9.2"
   },
@@ -24,6 +25,7 @@
     "@rollup/plugin-typescript": "11.1.6",
     "@types/crypto-js": "^4.2.2",
     "@types/jest": "^29.5.11",
+    "@types/lodash.get": "^4.4.9",
     "@types/node": "^20.11.5",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",

package/src/classes/BaseInlineCheckout.ts

@@ -11,38 +11,31 @@ import {
 import { getOpenpayDeviceSessionID } from "../data/openPayApi";
 import { getBrowserInfo } from "../helpers/utils";
 import { registerOrFetchCustomer } from "../data/customerApi";
+import { get } from "lodash";
 import {
-  Business,
-  ICustomer,
-  IItem,
-  IInlineCheckoutBaseOptions,
-  IConfigureCheckout,
-  IProcessPaymentRequest,
-  IStartCheckoutResponse,
-  StartCheckoutResponse,
-  ICardFields,
-} from "../types";
+  fetchCustomerCards,
+  removeCustomerCard,
+  saveCustomerCard,
+} from "../data/cardApi";
+import { fetchCustomerPaymentMethods } from "../data/paymentMethodApi";
+import {Business, IConfigureCheckout, IInlineCheckoutBaseOptions} from "../types/commons";
+import {ICustomer} from "../types/customer";
+import {ICardFields, IItem, IProcessPaymentRequest, IStartCheckoutResponse} from "../types/checkout";
+import {ICustomerCardsResponse, ISaveCardResponse, ISaveCardSkyflowRequest} from "../types/card";
+import {IPaymentMethodResponse} from "../types/paymentMethod";
+import {ITransaction} from "../types/transaction";
 export class BaseInlineCheckout {
   baseUrl = "";
-  cartTotal = "0";
+  cartTotal: string | number = "0";
   process3ds: ThreeDSHandler;
   mode?: "production" | "sandbox" | "stage" | "development" | undefined;
   apiKeyTonder: string;
-  returnUrl: string;
-  callBack?: ((response: any) => void) | undefined;
+  returnUrl?: string;
+  callBack?: ((response: IStartCheckoutResponse | Record<string, any>) => void) | undefined;
   merchantData?: Business;
   abortController: AbortController;
 
-  firstName?: string;
-  lastName?: string;
-  country?: string;
-  address?: string;
-  city?: string;
-  state?: string;
-  postCode?: string;
-  email?: string;
-  phone?: string;
-  customer?: ICustomer;
+  customer?: ICustomer | { email: string };
 
   cartItems?: IItem[];
   metadata = {};
@@ -57,12 +50,14 @@ export class BaseInlineCheckout {
     apiKeyTonder,
     returnUrl,
     callBack = () => {},
+    baseUrlTonder
   }: IInlineCheckoutBaseOptions) {
-    this.apiKeyTonder = apiKey || apiKeyTonder || "";
+    this.apiKeyTonder = apiKeyTonder || apiKey || "";
     this.returnUrl = returnUrl;
     this.callBack = callBack;
     this.mode = mode;
-    this.baseUrl = TONDER_URL_BY_MODE[this.mode] || TONDER_URL_BY_MODE["stage"];
+    this.customer = {} as ICustomer
+    this.baseUrl = baseUrlTonder || TONDER_URL_BY_MODE[this.mode] || TONDER_URL_BY_MODE["stage"];
     this.abortController = new AbortController();
     this.process3ds = new ThreeDSHandler({
       apiKey: apiKey,
@@ -74,7 +69,7 @@ export class BaseInlineCheckout {
     if ("customer" in data) this.#handleCustomer(data["customer"]);
   }
 
-  async verify3dsTransaction() {
+  async verify3dsTransaction(): Promise<ITransaction | IStartCheckoutResponse | void> {
     const result3ds = await this.process3ds.verifyTransactionStatus();
     const resultCheckout = await this.#resumeCheckout(result3ds);
     this.process3ds.setPayload(resultCheckout);
@@ -144,11 +139,14 @@ export class BaseInlineCheckout {
     payment_method,
     customer,
     isSandbox,
+    // TODO: DEPRECATED
+    returnUrl: returnUrlData
   }: {
     card?: string;
     payment_method?: string;
     customer: Record<string, any>;
     isSandbox?: boolean;
+    returnUrl?: string;
   }) {
     const { openpay_keys, reference, business } = this.merchantData!;
     const total = Number(this.cartTotal);
@@ -205,11 +203,15 @@ export class BaseInlineCheckout {
 
       // Checkout router
       const routerItems = {
-        name: this.firstName || "",
-        last_name: this.lastName || "",
-        email_client: this.email,
-        phone_number: this.phone,
-        return_url: this.returnUrl,
+        name: get(this.customer, "firstName", get(this.customer, "name", "")),
+        last_name: get(
+          this.customer,
+          "lastName",
+          get(this.customer, "lastname", ""),
+        ),
+        email_client: get(this.customer, "email", ""),
+        phone_number: get(this.customer, "phone", ""),
+        return_url: returnUrlData || this.returnUrl,
         id_product: "no_id",
         quantity_product: 1,
         id_ship: "0",
@@ -261,18 +263,45 @@ export class BaseInlineCheckout {
     }
   }
 
-  #handleCustomer(customer: ICustomer) {
+  async _getCustomerCards(
+    authToken: string,
+    businessId: string | number,
+  ): Promise<ICustomerCardsResponse> {
+    return await fetchCustomerCards(this.baseUrl, authToken, businessId);
+  }
+
+  async _saveCustomerCard(
+    authToken: string,
+    businessId: string | number,
+    skyflowTokens: ISaveCardSkyflowRequest,
+  ): Promise<ISaveCardResponse> {
+    return await saveCustomerCard(
+      this.baseUrl,
+      authToken,
+      businessId,
+      skyflowTokens,
+    );
+  }
+
+  async _removeCustomerCard(
+    authToken: string,
+    businessId: string | number,
+    skyflowId: string,
+  ): Promise<string> {
+    return await removeCustomerCard(
+      this.baseUrl,
+      authToken,
+      skyflowId,
+      businessId,
+    );
+  }
+  async _fetchCustomerPaymentMethods(): Promise<IPaymentMethodResponse> {
+    return await fetchCustomerPaymentMethods(this.baseUrl, this.apiKeyTonder);
+  }
+
+  #handleCustomer(customer: ICustomer | { email: string }) {
     if (!customer) return;
 
-    this.firstName = customer?.firstName;
-    this.lastName = customer?.lastName;
-    this.country = customer?.country;
-    this.address = customer?.street;
-    this.city = customer?.city;
-    this.state = customer?.state;
-    this.postCode = customer?.postCode;
-    this.email = customer?.email;
-    this.phone = customer?.phone;
     this.customer = customer;
   }
 
@@ -294,7 +323,7 @@ export class BaseInlineCheckout {
 
   // TODO: Make private after remove deprecated functions of liteCheckout
   async _handle3dsRedirect(
-    response: ErrorResponse | StartCheckoutResponse | false | undefined,
+    response: ITransaction | IStartCheckoutResponse | void,
   ) {
     const iframe =
       response && "next_action" in response

package/src/classes/errorResponse.ts

@@ -1,4 +1,4 @@
-import { IErrorResponse } from "../types";
+import {IErrorResponse} from "../types/responses";
 
 export class ErrorResponse implements IErrorResponse {
     code?: string | undefined;

package/src/classes/liteCheckout.ts

@@ -12,42 +12,29 @@ import {
 } from "../helpers/utils";
 import { getCustomerAPMs } from "../data/api";
 import { BaseInlineCheckout } from "./BaseInlineCheckout";
-import {
-  fetchCustomerCards,
-  removeCustomerCard,
-  saveCustomerCard,
-} from "../data/cardApi";
 import { MESSAGES } from "../shared/constants/messages";
 import { getSkyflowTokens } from "../helpers/skyflow";
-import { fetchCustomerAPMs } from "../data/paymentMethodApi";
 import { startCheckoutRouter } from "../data/checkoutApi";
 import { getOpenpayDeviceSessionID } from "../data/openPayApi";
 import { getPaymentMethodDetails } from "../shared/catalog/paymentMethodsCatalog";
+import {APM, IInlineLiteCheckoutOptions, TonderAPM} from "../types/commons";
+import {ICustomerCardsResponse, ISaveCardRequest, ISaveCardResponse, ISaveCardSkyflowRequest} from "../types/card";
+import {IPaymentMethod} from "../types/paymentMethod";
 import {
-  APM,
-  IInlineCheckoutBaseOptions,
-  ILiteInlineCheckout,
-  TonderAPM,
-  RegisterCustomerCardResponse,
-  ISaveCardRequest,
-  ICustomerCardsResponse,
-  ISaveCardResponse,
-  IPaymentMethod,
-  GetBusinessResponse,
-  TokensRequest,
-  ICardFields,
+  CreateOrderResponse,
+  CreatePaymentResponse,
   CustomerRegisterResponse,
-  StartCheckoutFullRequest,
+  GetBusinessResponse, IErrorResponse, RegisterCustomerCardResponse, StartCheckoutResponse
+} from "../types/responses";
+import {
   CreateOrderRequest,
-  CreatePaymentRequest,
-  StartCheckoutRequest,
-  IErrorResponse,
-  StartCheckoutResponse,
+  CreatePaymentRequest, RegisterCustomerCardRequest, StartCheckoutFullRequest,
   StartCheckoutIdRequest,
-  CreatePaymentResponse,
-  CreateOrderResponse,
-  RegisterCustomerCardRequest,
-} from "../types";
+  StartCheckoutRequest,
+  TokensRequest
+} from "../types/requests";
+import {ICardFields, IStartCheckoutResponse} from "../types/checkout";
+import {ILiteCheckout} from "../types/liteInlineCheckout";
 
 declare global {
   interface Window {
@@ -55,29 +42,22 @@ declare global {
   }
 }
 
-export interface LiteCheckoutConstructor extends IInlineCheckoutBaseOptions {}
-
-export class LiteCheckout
-  extends BaseInlineCheckout
-  implements ILiteInlineCheckout
-{
+export class LiteCheckout extends BaseInlineCheckout implements ILiteCheckout{
   activeAPMs: APM[] = [];
-  #customerData?: Record<string, any>;
 
-  constructor({ apiKey, mode, returnUrl, callBack }: LiteCheckoutConstructor) {
-    super({ mode, apiKey, returnUrl, callBack });
+  constructor({ apiKey, mode, returnUrl, callBack, apiKeyTonder, baseUrlTonder }: IInlineLiteCheckoutOptions) {
+    super({ mode, apiKey, returnUrl, callBack, apiKeyTonder, baseUrlTonder });
   }
 
-  async injectCheckout() {
+  public async injectCheckout() {
     await this._initializeCheckout();
   }
 
-  async getCustomerCards(): Promise<ICustomerCardsResponse> {
+  public async getCustomerCards(): Promise<ICustomerCardsResponse> {
     try {
       await this._fetchMerchantData();
       const { auth_token } = await this._getCustomer();
-      const response = await fetchCustomerCards(
-        this.baseUrl,
+      const response = await this._getCustomerCards(
         auth_token,
         this.merchantData!.business.pk,
       );
@@ -99,13 +79,15 @@ export class LiteCheckout
     }
   }
 
-  async saveCustomerCard(card: ISaveCardRequest): Promise<ISaveCardResponse> {
+  public async saveCustomerCard(
+    card: ISaveCardRequest,
+  ): Promise<ISaveCardResponse> {
     try {
       await this._fetchMerchantData();
       const { auth_token } = await this._getCustomer();
       const { vault_id, vault_url, business } = this.merchantData!;
 
-      const skyflowTokens = await getSkyflowTokens({
+      const skyflowTokens: ISaveCardSkyflowRequest = await getSkyflowTokens({
         vault_id: vault_id,
         vault_url: vault_url,
         data: card,
@@ -113,8 +95,7 @@ export class LiteCheckout
         apiKey: this.apiKeyTonder,
       });
 
-      return await saveCustomerCard(
-        this.baseUrl,
+      return await this._saveCustomerCard(
         auth_token,
         business?.pk,
         skyflowTokens,
@@ -129,17 +110,16 @@ export class LiteCheckout
     }
   }
 
-  async removeCustomerCard(skyflowId: string): Promise<string> {
+  public async removeCustomerCard(skyflowId: string): Promise<string> {
     try {
       await this._fetchMerchantData();
       const { auth_token } = await this._getCustomer();
       const { business } = this.merchantData!;
 
-      return await removeCustomerCard(
-        this.baseUrl,
+      return await this._removeCustomerCard(
         auth_token,
-        skyflowId,
         business?.pk,
+        skyflowId,
       );
     } catch (error) {
       throw formatPublicErrorResponse(
@@ -151,9 +131,9 @@ export class LiteCheckout
     }
   }
 
-  async getCustomerPaymentMethods(): Promise<IPaymentMethod[]> {
+  public async getCustomerPaymentMethods(): Promise<IPaymentMethod[]> {
     try {
-      const response = await fetchCustomerAPMs(this.baseUrl, this.apiKeyTonder);
+      const response = await this._fetchCustomerPaymentMethods();
 
       const apms_results =
         response && "results" in response && response["results"].length > 0
@@ -183,7 +163,7 @@ export class LiteCheckout
     }
   }
 
-  async getBusiness(): Promise<GetBusinessResponse> {
+  public async getBusiness(): Promise<GetBusinessResponse> {
     try {
       return await fetchBusiness(
         this.baseUrl,
@@ -200,6 +180,23 @@ export class LiteCheckout
     }
   }
 
+  // TODO: DEPRECATED
+  async getOpenpayDeviceSessionID(
+    merchant_id: string,
+    public_key: string,
+    is_sandbox: boolean,
+  ): Promise<string | ErrorResponse> {
+    try {
+      return await getOpenpayDeviceSessionID(
+        merchant_id,
+        public_key,
+        is_sandbox,
+      );
+    } catch (e) {
+      throw buildErrorResponseFromCatch(e);
+    }
+  }
+
   // TODO: DEPRECATED
   async getSkyflowTokens({
     vault_id,
@@ -223,10 +220,13 @@ export class LiteCheckout
     card,
     payment_method,
     isSandbox,
+    // TODO: DEPRECATED
+    returnUrl: returnUrlData
   }: {
     card?: ICardFields | string;
     payment_method?: string;
     isSandbox?: boolean;
+    returnUrl?: string;
   }) {
     await this._fetchMerchantData();
     const customer = await this._getCustomer(this.abortController.signal);
@@ -253,15 +253,11 @@ export class LiteCheckout
       payment_method,
       customer,
       isSandbox,
+      returnUrl: returnUrlData
     });
   }
 
   // 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> {
@@ -287,11 +283,6 @@ export class LiteCheckout
   }
 
   // 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> {
@@ -314,11 +305,6 @@ export class LiteCheckout
   }
 
   // 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> {
@@ -341,10 +327,6 @@ export class LiteCheckout
   }
 
   // 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> {
@@ -358,16 +340,12 @@ export class LiteCheckout
   }
 
   // TODO: DEPRECATED
-  async init3DSRedirect(checkoutResult: ErrorResponse | StartCheckoutResponse) {
+  async init3DSRedirect(checkoutResult: IStartCheckoutResponse) {
     this.process3ds.setPayload(checkoutResult);
     return await this._handle3dsRedirect(checkoutResult);
   }
 
   // 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> {
@@ -500,10 +478,6 @@ export class LiteCheckout
   }
 
   // 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,
@@ -532,10 +506,6 @@ export class LiteCheckout
   }
 
   // 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 = "",
@@ -562,10 +532,6 @@ export class LiteCheckout
   }
 
   // TODO: DEPRECATED
-  /**
-   * @deprecated This method is deprecated and will be removed in a future release.
-   * Use the {@link getCustomerPaymentMethods} method
-   */
   async getActiveAPMs(): Promise<APM[]> {
     try {
       const apms_response = await getCustomerAPMs(

package/src/data/businessApi.ts

@@ -1,4 +1,4 @@
-import { GetBusinessResponse } from "../types";
+import {GetBusinessResponse} from "../types/responses";
 
 export async function fetchBusiness(
   baseUrl: string,

package/src/data/cardApi.ts

@@ -2,12 +2,8 @@ import {
   buildErrorResponse,
   buildErrorResponseFromCatch,
 } from "../helpers/utils";
-import {
-  ICustomerCardsResponse,
-  ISaveCardResponse,
-  ISaveCardSkyflowRequest,
-} from "../types";
 import { MESSAGES } from "../shared/constants/messages";
+import {ICustomerCardsResponse, ISaveCardResponse, ISaveCardSkyflowRequest} from "../types/card";
 
 export async function fetchCustomerCards(
   baseUrl: string,

package/src/data/checkoutApi.ts

@@ -1,11 +1,8 @@
+import {CreateOrderRequest, CreatePaymentRequest} from "../types/requests";
+import {IStartCheckoutIdRequest, IStartCheckoutRequest} from "../types/checkout";
+
 declare const MP_DEVICE_SESSION_ID: string | undefined;
 
-import {
-  CreateOrderRequest,
-  CreatePaymentRequest,
-  IStartCheckoutIdRequest,
-  IStartCheckoutRequest,
-} from "../types";
 
 export async function createOrder(
   baseUrl: string,

package/src/data/customerApi.ts

@@ -1,4 +1,4 @@
-import { CustomerRegisterResponse } from "../types";
+import {CustomerRegisterResponse} from "../types/responses";
 
 export async function registerOrFetchCustomer(
   baseUrl: string,

package/src/data/paymentMethodApi.ts

@@ -2,9 +2,9 @@ import {
   buildErrorResponse,
   buildErrorResponseFromCatch,
 } from "../helpers/utils";
-import { IPaymentMethodResponse } from "../types";
+import {IPaymentMethodResponse} from "../types/paymentMethod";
 
-export async function fetchCustomerAPMs(
+export async function fetchCustomerPaymentMethods(
   baseUrl: string,
   apiKey: string,
   params = {

package/src/helpers/skyflow.ts

@@ -4,7 +4,7 @@ import CollectContainer from "skyflow-js/types/core/external/collect/collect-con
 import {buildErrorResponseFromCatch} from "./utils";
 import CollectElement from "skyflow-js/types/core/external/collect/collect-element";
 import {getVaultToken} from "../data/skyflowApi";
-import {TokensSkyflowRequest} from "../types";
+import {TokensSkyflowRequest} from "../types/requests";
 
 export async function getSkyflowTokens({
   baseUrl,

package/src/helpers/utils.ts

@@ -1,5 +1,5 @@
 import { ErrorResponse } from "../classes/errorResponse";
-import { IErrorResponse } from "../types";
+import {IErrorResponse} from "../types/responses";
 
 export const getBrowserInfo = () => {
   const browserInfo = {