@tonder.io/ionic-lite-sdk 0.0.32-beta → 0.0.34-beta

package/.gitlab-ci.yml

@@ -1,29 +1,29 @@
-image: grupoapok/awscli:18
-
-stages:
-  - test
-  - deploy
-
-test:
-  stage: test
-  only:
-    - development
-  before_script:
-    - npm install
-  script:
-    - npm run test
-
-deploy:
-  stage: deploy
-  only:
-    - tags
-  before_script:
-    - |
-      {
-        echo "@tonder.io:registry=https://registry.npmjs.org/"
-        echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
-      } | tee -a .npmrc
-  script:
-    - npm install
-    - npm run build
+image: grupoapok/awscli:18
+
+stages:
+  - test
+  - deploy
+
+test:
+  stage: test
+  only:
+    - development
+  before_script:
+    - npm install
+  script:
+    - npm run test
+
+deploy:
+  stage: deploy
+  only:
+    - tags
+  before_script:
+    - |
+      {
+        echo "@tonder.io:registry=https://registry.npmjs.org/"
+        echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
+      } | tee -a .npmrc
+  script:
+    - npm install
+    - npm run build
     - npm publish --access=public

package/README.md

@@ -1,193 +1,202 @@
-# Tonder SDK
-
-Tonder SDK Lite to integrate REST service
-
-## Installation
-
-You can install using NPM
-```bash
-npm i @tonder.io/ionic-lite-sdk
-```
-
-Add dependencies to the root of the app (index.html)
-```html
-<script src=https://openpay.s3.amazonaws.com/openpay.v1.min.js></script>
-<script src=https://openpay.s3.amazonaws.com/openpay-data.v1.min.js></script>
-```
-
-## Usage
-## Import LiteCheckout class
-```javascript
-import { LiteCheckout } from "@tonder.io/ionic-lite-sdk"
-```
-## Create instance
-
-```javascript
-const liteCheckout = new LiteCheckout({ 
-  signal, 
-  baseUrlTonder, 
-  apiKeyTonder
-})
-```
-
-| Property        | Type          | Description                                                             |
-|:---------------:|:-------------:|:-----------------------------------------------------------------------:|
-| signal          | AborSignal    | Signal from AbortController instance if it need cancel request          |
-| baseUrlTonder   | string        | Live server: http://stage.tonder.io                                     |
-|                 |               | Mock Server: https://stoplight.io/mocks/tonder/tonder-api-v1-2/3152148  |
-| apiKeyTonder    | string        | You can take this from you Tonder Dashboard                             |
-|                 |               |                                                                         |
-
-# Class methods
-
-# Checkout router
-
-```typescript
-
-const returnUrl = "http://localhost:8100/payment/success";
-
-let checkoutData = {
-  customer: {
-    name: "Jhon",
-    lastname: "Doe",
-    email: "john.c.calhoun@examplepetstore.com",
-    phone: "+58452258525"
-  },
-  order: {
-    items: [
-      {
-        description: "Test product description",
-        quantity: 1,
-        price_unit: 25,
-        discount: 1,
-        taxes: 12,
-        product_reference: 89456123,
-        name: "Test product",
-        amount_total: 25
-      }
-    ]
-  },
-  return_url: returnUrl,
-  total: 25,
-  isSandbox: true,
-  metadata: {},
-  currency: "MXN",
-  skyflowTokens: {
-    cardholder_name: "",
-    card_number: "",
-    expiration_year: "",
-    expiration_month: "",
-    cvv: "",
-    skyflow_id: ""
-  }
-}
-
-```
-
-<font size="4">It is required get the skyflow tokens to add it to the checkout router method, the values of the variable skyflowFields come from your html form</font>
-
-```typescript
-
-const merchantData: any = await liteCheckout.getBusiness();
-
-const { vault_id, vault_url } = merchantData;
-
-const skyflowFields = {
-  card_number: this.paymentForm.value.cardNumber,
-  cvv: this.paymentForm.value.cvv,
-  expiration_month: this.paymentForm.value.month,
-  expiration_year: this.paymentForm.value.expirationYear,
-  cardholder_name: this.paymentForm.value.name
-}
-
-const skyflowTokens = await liteCheckout.getSkyflowTokens({
-  vault_id: vault_id,
-  vault_url: vault_url,
-  data: skyflowFields
-})
-
-checkoutData.skyflowTokens = skyflowTokens;
-
-const jsonResponseRouter: any = await liteCheckout.startCheckoutRouterFull(
-  checkoutData
-);
-
-```
-
-<font size="4">Take actions on base to the checkout router response</font>
-
-# Customer Cards(Register)
-
-## Register customer card
-
-```typescript
-
-customer_auth_token: string;
-
-data: {
-    skyflow_id: string;
-};
-
-const jsonResponseOrder = await liteCheckout.registerCustomerCard(
-  customer_auth_token,
-  data
-);
-```
-
-## Return register customer card
-```typescript
-{
-    skyflow_id: string;
-    user_id: number;
-}
-```
-
-# Customer Cards(Get)
-
-## Get customer cards
-
-```typescript
-
-customer_auth_token: string;
-
-query: string = "?ordering=<string>&search=<string>";
-
-const jsonResponseOrder = await liteCheckout.getCustomerCards(
-  customer_auth_token,
-  query
-);
-```
-
-## Return get customer cards
-```typescript
-{
-    user_id: number,
-    cards: [
-        {
-            fields: {
-                card_number: string,
-                cardholder_name: string,
-                cvv: string,
-                expiration_month: string,
-                expiration_year: string,
-                skyflow_id: string
-            }
-        }
-    ]
-}
-```
-
-## Delete customer card
-
-```typescript
-
-const deleted: boolean = await liteCheckout.deleteCustomerCard(
-  customer_auth_token,
-  skyflow_id
-);
-
-```
-
-## License
-
-[MIT](https://choosealicense.com/licenses/mit/)
+# Tonder SDK
+
+Tonder SDK Lite to integrate REST service
+
+## Installation
+
+You can install using NPM
+```bash
+npm i @tonder.io/ionic-lite-sdk
+```
+
+Add dependencies to the root of the app (index.html)
+```html
+<script src=https://openpay.s3.amazonaws.com/openpay.v1.min.js></script>
+<script src=https://openpay.s3.amazonaws.com/openpay-data.v1.min.js></script>
+```
+
+## Usage
+## Import LiteCheckout class
+```javascript
+import { LiteCheckout } from "@tonder.io/ionic-lite-sdk"
+```
+## Create instance
+
+```javascript
+const liteCheckout = new LiteCheckout({ 
+  signal, 
+  baseUrlTonder, 
+  apiKeyTonder
+})
+
+// To verify a 3ds transaction you can use the following method
+// It should be called after the injectCheckout method
+// The response status will be one of the following
+// ['Declined', 'Cancelled', 'Failed', 'Success', 'Pending', 'Authorized']
+
+inlineCheckout.verify3dsTransaction().then(response => {
+  console.log('Verify 3ds response', response)
+})
+```
+
+| Property        | Type          | Description                                                             |
+|:---------------:|:-------------:|:-----------------------------------------------------------------------:|
+| signal          | AborSignal    | Signal from AbortController instance if it need cancel request          |
+| baseUrlTonder   | string        | Live server: http://stage.tonder.io                                     |
+|                 |               | Mock Server: https://stoplight.io/mocks/tonder/tonder-api-v1-2/3152148  |
+| apiKeyTonder    | string        | You can take this from you Tonder Dashboard                             |
+|                 |               |                                                                         |
+
+# Class methods
+
+# Checkout router
+
+```typescript
+
+const returnUrl = "http://localhost:8100/payment/success";
+
+let checkoutData = {
+  customer: {
+    name: "Jhon",
+    lastname: "Doe",
+    email: "john.c.calhoun@examplepetstore.com",
+    phone: "+58452258525"
+  },
+  order: {
+    items: [
+      {
+        description: "Test product description",
+        quantity: 1,
+        price_unit: 25,
+        discount: 1,
+        taxes: 12,
+        product_reference: 89456123,
+        name: "Test product",
+        amount_total: 25
+      }
+    ]
+  },
+  return_url: returnUrl,
+  total: 25,
+  isSandbox: true,
+  metadata: {},
+  currency: "MXN",
+  skyflowTokens: {
+    cardholder_name: "",
+    card_number: "",
+    expiration_year: "",
+    expiration_month: "",
+    cvv: "",
+    skyflow_id: ""
+  }
+}
+
+```
+
+<font size="4">It is required get the skyflow tokens to add it to the checkout router method, the values of the variable skyflowFields come from your html form</font>
+
+```typescript
+
+const merchantData: any = await liteCheckout.getBusiness();
+
+const { vault_id, vault_url } = merchantData;
+
+const skyflowFields = {
+  card_number: this.paymentForm.value.cardNumber,
+  cvv: this.paymentForm.value.cvv,
+  expiration_month: this.paymentForm.value.month,
+  expiration_year: this.paymentForm.value.expirationYear,
+  cardholder_name: this.paymentForm.value.name
+}
+
+const skyflowTokens = await liteCheckout.getSkyflowTokens({
+  vault_id: vault_id,
+  vault_url: vault_url,
+  data: skyflowFields
+})
+
+checkoutData.skyflowTokens = skyflowTokens;
+
+const jsonResponseRouter: any = await liteCheckout.startCheckoutRouterFull(
+  checkoutData
+);
+
+```
+
+<font size="4">Take actions on base to the checkout router response</font>
+
+# Customer Cards(Register)
+
+## Register customer card
+
+```typescript
+
+customer_auth_token: string;
+
+data: {
+    skyflow_id: string;
+};
+
+const jsonResponseOrder = await liteCheckout.registerCustomerCard(
+  customer_auth_token,
+  data
+);
+```
+
+## Return register customer card
+```typescript
+{
+    skyflow_id: string;
+    user_id: number;
+}
+```
+
+# Customer Cards(Get)
+
+## Get customer cards
+
+```typescript
+
+customer_auth_token: string;
+
+query: string = "?ordering=<string>&search=<string>";
+
+const jsonResponseOrder = await liteCheckout.getCustomerCards(
+  customer_auth_token,
+  query
+);
+```
+
+## Return get customer cards
+```typescript
+{
+    user_id: number,
+    cards: [
+        {
+            fields: {
+                card_number: string,
+                cardholder_name: string,
+                cvv: string,
+                expiration_month: string,
+                expiration_year: string,
+                skyflow_id: string
+            }
+        }
+    ]
+}
+```
+
+## Delete customer card
+
+```typescript
+
+const deleted: boolean = await liteCheckout.deleteCustomerCard(
+  customer_auth_token,
+  skyflow_id
+);
+
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/dist/classes/3dsHandler.d.ts

@@ -0,0 +1,33 @@
+type ThreeDSHandlerContructor = {
+    payload?: any;
+    apiKey?: string;
+    baseUrl?: string;
+    successUrl?: Location | string;
+};
+export declare class ThreeDSHandler {
+    baseUrl?: string;
+    apiKey?: string;
+    payload?: any;
+    successUrl?: Location | string;
+    localStorageKey: string;
+    constructor({ payload, apiKey, baseUrl, successUrl }: ThreeDSHandlerContructor);
+    setStorageItem(data: any): void;
+    getStorageItem(): string | null;
+    removeStorageItem(): void;
+    saveVerifyTransactionUrl(): void;
+    saveUrlWithExpiration(url: string): void;
+    getUrlWithExpiration(): any;
+    removeVerifyTransactionUrl(): void;
+    getVerifyTransactionUrl(): string | null;
+    loadIframe(): Promise<unknown> | undefined;
+    getRedirectUrl(): any;
+    redirectToChallenge(): void;
+    getURLParameters(): any;
+    handleSuccessTransaction(response: any): any;
+    handleDeclinedTransaction(response: any): any;
+    handle3dsChallenge(response_json: any): Promise<void>;
+    handleTransactionResponse(response: any): Promise<any>;
+    verifyTransactionStatus(): Promise<any>;
+    setPayload: (payload: any) => void;
+}
+export {};

package/dist/classes/liteCheckout.d.ts

@@ -1,7 +1,9 @@
 import CollectContainer from "skyflow-js/types/core/external/collect/collect-container";
-import { CreateOrderRequest, CreatePaymentRequest, RegisterCustomerCardRequest, StartCheckoutRequest, TokensRequest, StartCheckoutFullRequest } from "../types/requests";
+import { APM } from "../types/commons";
+import { CreateOrderRequest, CreatePaymentRequest, RegisterCustomerCardRequest, StartCheckoutRequest, TokensRequest, StartCheckoutFullRequest, StartCheckoutIdRequest } from "../types/requests";
 import { GetBusinessResponse, CustomerRegisterResponse, CreateOrderResponse, CreatePaymentResponse, StartCheckoutResponse, GetCustomerCardsResponse, RegisterCustomerCardResponse } from "../types/responses";
 import { ErrorResponse } from "./errorResponse";
+import { ThreeDSHandler } from "./3dsHandler";
 declare global {
     interface Window {
         OpenPay: any;
@@ -11,26 +13,34 @@ export type LiteCheckoutConstructor = {
     signal: AbortSignal;
     baseUrlTonder: string;
     apiKeyTonder: string;
+    successUrl?: string;
 };
 export declare class LiteCheckout implements LiteCheckoutConstructor {
     signal: AbortSignal;
     baseUrlTonder: string;
     apiKeyTonder: string;
-    constructor({ signal, baseUrlTonder, apiKeyTonder, }: LiteCheckoutConstructor);
+    process3ds: ThreeDSHandler;
+    successUrl?: string;
+    activeAPMs: APM[];
+    constructor({ signal, baseUrlTonder, apiKeyTonder, successUrl, }: LiteCheckoutConstructor);
     getOpenpayDeviceSessionID(merchant_id: string, public_key: string, is_sandbox: boolean): Promise<string | ErrorResponse>;
     getBusiness(): Promise<GetBusinessResponse | ErrorResponse>;
+    verify3dsTransaction(): Promise<any>;
+    resumeCheckout(response: any): Promise<any>;
+    handle3dsRedirect(response: ErrorResponse | StartCheckoutResponse | false | undefined): Promise<false | StartCheckoutResponse | ErrorResponse | undefined>;
     customerRegister(email: string): Promise<CustomerRegisterResponse | ErrorResponse>;
     createOrder(orderItems: CreateOrderRequest): Promise<CreateOrderResponse | ErrorResponse>;
     createPayment(paymentItems: CreatePaymentRequest): Promise<CreatePaymentResponse | ErrorResponse>;
-    startCheckoutRouter(routerData: StartCheckoutRequest): Promise<StartCheckoutResponse | ErrorResponse>;
-    startCheckoutRouterFull(routerFullData: StartCheckoutFullRequest): Promise<StartCheckoutResponse | ErrorResponse>;
+    handleCheckoutRouter(routerData: StartCheckoutRequest | StartCheckoutIdRequest): Promise<StartCheckoutResponse>;
+    startCheckoutRouter(routerData: StartCheckoutRequest | StartCheckoutIdRequest): Promise<StartCheckoutResponse | ErrorResponse | undefined>;
+    startCheckoutRouterFull(routerFullData: StartCheckoutFullRequest): Promise<StartCheckoutResponse | ErrorResponse | undefined>;
+    init3DSRedirect(checkoutResult: ErrorResponse | StartCheckoutResponse): Promise<false | StartCheckoutResponse | ErrorResponse | undefined>;
     getSkyflowTokens({ vault_id, vault_url, data, }: TokensRequest): Promise<any | ErrorResponse>;
     getVaultToken(): Promise<string>;
     getFieldsPromise(data: any, collectContainer: CollectContainer): Promise<Promise<boolean>[]>;
     registerCustomerCard(customerToken: string, data: RegisterCustomerCardRequest): Promise<RegisterCustomerCardResponse | ErrorResponse>;
     getCustomerCards(customerToken: string, query?: string): Promise<GetCustomerCardsResponse | ErrorResponse>;
     deleteCustomerCard(customerToken: string, skyflowId?: string): Promise<Boolean | ErrorResponse>;
-    private buildErrorResponseFromCatch;
-    private buildErrorResponse;
     private getFields;
+    getActiveAPMs(): Promise<APM[]>;
 }

package/dist/data/api.d.ts

@@ -0,0 +1 @@
+export declare function getCustomerAPMs(baseUrlTonder: string, apiKeyTonder: string, query?: string, signal?: AbortSignal | null | undefined): Promise<any>;

package/dist/helpers/constants.d.ts

@@ -0,0 +1,62 @@
+declare enum PAYMENT_METHOD {
+    SORIANA = "SORIANA",
+    OXXO = "OXXO",
+    SPEI = "SPEI",
+    CODI = "CODI",
+    MERCADOPAGO = "MERCADOPAGO",
+    PAYPAL = "PAYPAL",
+    COMERCIALMEXICANA = "COMERCIALMEXICANA",
+    BANCOMER = "BANCOMER",
+    WALMART = "WALMART",
+    BODEGA = "BODEGA",
+    SAMSCLUB = "SAMSCLUB",
+    SUPERAMA = "SUPERAMA",
+    CALIMAX = "CALIMAX",
+    EXTRA = "EXTRA",
+    CIRCULOK = "CIRCULOK",
+    SEVEN11 = "7ELEVEN",
+    TELECOMM = "TELECOMM",
+    BANORTE = "BANORTE",
+    BENAVIDES = "BENAVIDES",
+    DELAHORRO = "DELAHORRO",
+    ELASTURIANO = "ELASTURIANO",
+    WALDOS = "WALDOS",
+    ALSUPER = "ALSUPER",
+    KIOSKO = "KIOSKO",
+    STAMARIA = "STAMARIA",
+    LAMASBARATA = "LAMASBARATA",
+    FARMROMA = "FARMROMA",
+    FARMUNION = "FARMUNION",
+    FARMATODO = "FARMATODO",
+    SFDEASIS = "SFDEASIS",
+    FARM911 = "FARM911",
+    FARMECONOMICAS = "FARMECONOMICAS",
+    FARMMEDICITY = "FARMMEDICITY",
+    RIANXEIRA = "RIANXEIRA",
+    WESTERNUNION = "WESTERNUNION",
+    ZONAPAGO = "ZONAPAGO",
+    CAJALOSANDES = "CAJALOSANDES",
+    CAJAPAITA = "CAJAPAITA",
+    CAJASANTA = "CAJASANTA",
+    CAJASULLANA = "CAJASULLANA",
+    CAJATRUJILLO = "CAJATRUJILLO",
+    EDPYME = "EDPYME",
+    KASNET = "KASNET",
+    NORANDINO = "NORANDINO",
+    QAPAQ = "QAPAQ",
+    RAIZ = "RAIZ",
+    PAYSER = "PAYSER",
+    WUNION = "WUNION",
+    BANCOCONTINENTAL = "BANCOCONTINENTAL",
+    GMONEY = "GMONEY",
+    GOPAY = "GOPAY",
+    WU = "WU",
+    PUNTOSHEY = "PUNTOSHEY",
+    AMPM = "AMPM",
+    JUMBOMARKET = "JUMBOMARKET",
+    SMELPUEBLO = "SMELPUEBLO",
+    BAM = "BAM",
+    REFACIL = "REFACIL",
+    ACYVALORES = "ACYVALORES"
+}
+export { PAYMENT_METHOD };

package/dist/helpers/utils.d.ts

@@ -1,3 +1,4 @@
+import { ErrorResponse } from "../classes/errorResponse";
 export declare const getBrowserInfo: () => {
     javascript_enabled: boolean;
     time_zone: number;
@@ -7,3 +8,10 @@ export declare const getBrowserInfo: () => {
     screen_height: number | null;
     user_agent: string;
 };
+declare const buildErrorResponseFromCatch: (e: any) => ErrorResponse;
+declare const buildErrorResponse: (response: Response, stack?: string | undefined) => Promise<ErrorResponse>;
+declare const getPaymentMethodDetails: (scheme_data: string) => {
+    icon: string;
+    label: string;
+};
+export { buildErrorResponseFromCatch, buildErrorResponse, getPaymentMethodDetails };