@tonder.io/ionic-lite-sdk 0.0.3

package/.gitlab-ci.yml

@@ -0,0 +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:https://registry=//registry.npmjs.org/"
+        echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
+      } | tee -a .npmrc
+  script:
+    - npm install
+    - npm run build
+    - npm publish

package/README.md

@@ -0,0 +1,496 @@
+# Tonder SDK
+
+Tonder SDK Lite to integrate REST service
+
+## Installation
+
+You can install using NPM
+```bash
+npm i @tonder/ionic-lite-sdk
+```
+
+or using an script tag
+```html
+// TO DO
+```
+
+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/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
+
+# Business
+
+## Get business
+
+```javascript
+const merchantData = await liteCheckout.getBusiness();
+```
+
+## Return business data
+
+```typescript
+{
+    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
+    },
+    vault_id: string,
+    vault_url: string,
+    reference: number,
+    is_installments_available: boolean
+}
+```
+
+# OpenPay
+
+## Get OpenPay session id
+
+```javascript
+const { openpay_keys } = merchantData;
+
+const deviceSessionIdTonder = await liteCheckout.getOpenpayDeviceSessionID(
+  openpay_keys.merchant_id,
+  openpay_keys.public_key
+);
+```
+
+## Return OpenPay device session id
+
+string
+
+# Customer
+
+## Get customer authorization token
+
+```javascript
+const customerEmail = "john.c.calhoun@examplepetstore.com";
+
+const { auth_token } = await liteCheckout.customerRegister(customerEmail);
+```
+
+## Return customer data
+
+```typescript
+{
+    id: number,
+    email: string,
+    auth_token: string
+}
+```
+
+# Order
+
+## Create order
+
+```typescript
+const cartItems = [
+  {
+    description: "Test product description",
+    quantity: 1,
+    price_unit: 25,
+    discount: 0,
+    taxes: 12,
+    product_reference: 65421,
+    name: "Test product",
+    amount_total: 25
+  }
+]
+
+const { reference } = merchantData;
+
+const orderData = {
+  business: apiKeyTonder,
+  client: auth_token,
+  billing_address_id: null,
+  shipping_address_id: null,
+  amount: total,
+  status: "A",
+  reference: reference,
+  is_oneclick: true,
+  items: cartItems,
+};
+
+const jsonResponseOrder = await liteCheckout.createOrder(
+  orderData
+);
+```
+
+## Return order data
+```typescript
+{
+    id: number,
+    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
+        }
+    }
+}
+```
+
+# Payment
+
+## Create payment
+```javascript
+const now = new Date();
+const dateString = now.toISOString();
+
+const paymentData = {
+  business_pk: business.pk,
+  amount: total,
+  date: dateString,
+  order: jsonResponseOrder.id,
+};
+
+const jsonResponsePayment = await liteCheckout.createPayment(
+  paymentData
+);
+```
+
+## Return payment data
+```javascript
+{
+  pk: number,
+  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
+}
+```
+
+# Skyflow tokens
+
+## Get skyflow payment form tokenized values
+
+The values of the variable skyflowTokens come from your html form
+
+```javascript
+
+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 { vault_id, vault_url } = merchantData;
+
+
+const skyflowTokens = await liteCheckout.getSkyflowTokens({
+  vault_id: vault_id,
+  vault_url: vault_url,
+  data: skyflowFields
+})
+
+```
+
+## Return skyflow tokenized data
+```typescript
+{
+    vaultID: string,
+    responses: [
+        {
+            records: [
+                {
+                    skyflow_id: string
+                }
+            ]
+        },
+        {
+            fields: {
+                card_number: string,
+                cardholder_name: string,
+                cvv: string,
+                expiration_month: string,
+                expiration_year: string,
+                skyflow_id: string
+            }
+        }
+    ]
+}
+```
+
+# Checkout router
+
+## Get checkout router data
+
+```javascript
+
+const customerPhone = "+11111111";
+const returnUrl = "http://localhost:8100/payment/success";
+
+const routerData = {
+  card: skyflowTokens,
+  name: skyflowTokens.cardholder_name,
+  last_name: "",
+  email_client: customerEmail,
+  phone_number: customerPhone,
+  return_url: returnUrl,
+  id_product: "no_id",
+  quantity_product: 1,
+  id_ship: "0",
+  instance_id_ship: "0",
+  amount: total,
+  title_ship: "shipping",
+  description: "Transaction from the lite SDK",
+  device_session_id: deviceSessionIdTonder,
+  token_id: "",
+  order_id: jsonResponseOrder.id,
+  business_id: business.pk,
+  payment_id: jsonResponsePayment.pk,
+  source: 'ionic-lite-sdk',
+};
+
+const jsonResponseRouter = await liteCheckout.startCheckoutRouter(
+  routerData
+);
+
+```
+
+## Return checkout router data
+
+```typescript
+{
+    status: 200,
+    message: "Success",
+    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
+    },
+    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
+        }
+    },
+    actions: [
+        {
+            name: string,
+            url: string,
+            method: string
+        }
+    ]
+}
+```
+
+## Take actions on base to the checkout router response
+
+# Customer Cards(Register)
+
+## Register customer card
+
+```typescript
+
+aut_token: string;
+
+data: {
+    skyflow_id: string;
+};
+
+const jsonResponseOrder = await liteCheckout.registerCustomerCard(
+  aut_token,
+  data
+);
+```
+
+## Return register customer card
+```typescript
+{
+    skyflow_id: string;
+    user_id: number;
+}
+```
+
+# Customer Cards(Get)
+
+## Get customer cards
+
+```typescript
+
+aut_token: string;
+
+query: string = "?ordering=<string>&search=<string>";
+
+const jsonResponseOrder = await liteCheckout.getCustomerCards(
+  aut_token,
+  query
+);
+```
+
+## Return get customer card
+```typescript
+{
+    user_id: number,
+    cards: {
+        records: [
+            {
+                fields: {
+                    card_number: string,
+                    cardholder_name: string,
+                    cvv: string,
+                    expiration_month: string,
+                    expiration_year: string,
+                    skyflow_id: string
+                }
+            }
+        ]
+    }
+}
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/dist/classes/errorResponse.d.ts

@@ -0,0 +1,9 @@
+import { IErrorResponse } from "../types/responses";
+export declare class ErrorResponse implements IErrorResponse {
+    code?: string | undefined;
+    body?: string | undefined;
+    name: string;
+    message: string;
+    stack?: string | undefined;
+    constructor({ code, body, name, message, stack }: IErrorResponse);
+}

package/dist/classes/liteCheckout.d.ts

@@ -0,0 +1,34 @@
+import CollectContainer from "skyflow-js/types/core/external/collect/collect-container";
+import { CreateOrderRequest, CreatePaymentRequest, RegisterCustomerCardRequest, StartCheckoutRequest, TokensRequest } from "../types/requests";
+import { GetBusinessResponse, CustomerRegisterResponse, CreateOrderResponse, CreatePaymentResponse, StartCheckoutResponse, GetCustomerCardsResponse, RegisterCustomerCardResponse } from "../types/responses";
+import { ErrorResponse } from "./errorResponse";
+declare global {
+    interface Window {
+        OpenPay: any;
+    }
+}
+export type LiteCheckoutConstructor = {
+    signal: AbortSignal;
+    baseUrlTonder: string;
+    apiKeyTonder: string;
+};
+export declare class LiteCheckout implements LiteCheckoutConstructor {
+    signal: AbortSignal;
+    baseUrlTonder: string;
+    apiKeyTonder: string;
+    constructor({ signal, baseUrlTonder, apiKeyTonder, }: LiteCheckoutConstructor);
+    getOpenpayDeviceSessionID(merchant_id: string, public_key: string): Promise<string | ErrorResponse>;
+    getBusiness(): Promise<GetBusinessResponse | ErrorResponse>;
+    customerRegister(email: string): Promise<CustomerRegisterResponse | ErrorResponse>;
+    createOrder(orderItems: CreateOrderRequest): Promise<CreateOrderResponse | ErrorResponse>;
+    createPayment(paymentItems: CreatePaymentRequest): Promise<CreatePaymentResponse | ErrorResponse>;
+    startCheckoutRouter(routerData: StartCheckoutRequest): Promise<StartCheckoutResponse | ErrorResponse>;
+    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>;
+    private buildErrorResponseFromCatch;
+    private buildErrorResponse;
+    private getFields;
+}

package/dist/helpers/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const createObserver: ({ target }: {
+    target: string;
+}) => Promise<any>;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { LiteCheckout } from './classes/liteCheckout';
+export { LiteCheckout };

package/dist/index.js

@@ -0,0 +1 @@
+import e from"skyflow-js";function t(e,t,o,i){return new(o||(o=Promise))((function(r,n){function s(e){try{a(i.next(e))}catch(e){n(e)}}function d(e){try{a(i.throw(e))}catch(e){n(e)}}function a(e){var t;e.done?r(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(s,d)}a((i=i.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;class o{constructor({code:e,body:t,name:o,message:i,stack:r}){this.code=e,this.body=t,this.name=o,this.message=i,this.stack=r}}class i{constructor({signal:e,baseUrlTonder:t,apiKeyTonder:o}){this.baseUrlTonder=t,this.signal=e,this.apiKeyTonder=o}getOpenpayDeviceSessionID(e,o){return t(this,void 0,void 0,(function*(){try{let t=yield window.OpenPay;return t.setId(e),t.setApiKey(o),t.setSandboxMode(!0),yield t.deviceData.setup({signal:this.signal})}catch(e){throw this.buildErrorResponseFromCatch(e)}}))}getBusiness(){return t(this,void 0,void 0,(function*(){try{const e=yield fetch(`${this.baseUrlTonder}/api/v1/payments/business/${this.apiKeyTonder}`,{headers:{Authorization:`Token ${this.apiKeyTonder}`},signal:this.signal});return e.ok?yield e.json():yield this.buildErrorResponse(e)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}customerRegister(e){return t(this,void 0,void 0,(function*(){try{const t=`${this.baseUrlTonder}/api/v1/customer/`,o={email:e},i=yield fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Token ${this.apiKeyTonder}`},signal:this.signal,body:JSON.stringify(o)});return i.ok?yield i.json():yield this.buildErrorResponse(i)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}createOrder(e){return t(this,void 0,void 0,(function*(){try{const t=`${this.baseUrlTonder}/api/v1/orders/`,o=e,i=yield fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Token ${this.apiKeyTonder}`},body:JSON.stringify(o)});return i.ok?yield i.json():yield this.buildErrorResponse(i)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}createPayment(e){return t(this,void 0,void 0,(function*(){try{const t=`${this.baseUrlTonder}/api/v1/business/${e.business_pk}/payments/`,o=e,i=yield fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Token ${this.apiKeyTonder}`},body:JSON.stringify(o)});return i.ok?yield i.json():yield this.buildErrorResponse(i)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}startCheckoutRouter(e){return t(this,void 0,void 0,(function*(){try{const t=`${this.baseUrlTonder}/api/v1/checkout-router/`,o=e,i=yield fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Token ${this.apiKeyTonder}`},body:JSON.stringify(o)});return i.ok?yield i.json():yield this.buildErrorResponse(i)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}getSkyflowTokens({vault_id:o,vault_url:i,data:r}){return t(this,void 0,void 0,(function*(){const n=e.init({vaultID:o,vaultURL:i,getBearerToken:()=>t(this,void 0,void 0,(function*(){return yield this.getVaultToken()})),options:{logLevel:e.LogLevel.ERROR,env:e.Env.DEV}}).container(e.ContainerType.COLLECT),s=yield this.getFieldsPromise(r,n);if((yield Promise.all(s)).some((e=>!e)))return this.buildErrorResponseFromCatch(Error("Ocurrió un error al montar los campos de la tarjeta"));try{const e=yield n.collect();return e?e.records[0].fields:this.buildErrorResponseFromCatch(Error("Por favor, verifica todos los campos de tu tarjeta"))}catch(e){return this.buildErrorResponseFromCatch(e)}}))}getVaultToken(){var e;return t(this,void 0,void 0,(function*(){try{const t=yield fetch(`${this.baseUrlTonder}/api/v1/vault-token/`,{method:"GET",headers:{Authorization:`Token ${this.apiKeyTonder}`},signal:this.signal});if(t.ok)return null===(e=yield t.json())||void 0===e?void 0:e.token;throw new Error(`HTTPCODE: ${t.status}`)}catch(e){throw new Error(`Failed to retrieve bearer token; ${"string"==typeof e?e:e.message}`)}}))}getFieldsPromise(e,o){return t(this,void 0,void 0,(function*(){const t=yield this.getFields(e,o);return t?t.map((t=>new Promise((o=>{var i;const r=document.createElement("div");r.hidden=!0,r.id=`id-${t.key}`,null===(i=document.querySelector("body"))||void 0===i||i.appendChild(r),setTimeout((()=>{t.element.mount(`#id-${t.key}`),setInterval((()=>{if(t.element.isMounted()){const i=e[t.key];return t.element.update({value:i}),o(t.element.isMounted())}}),120)}),120)})))):[]}))}registerCustomerCard(e,o){return t(this,void 0,void 0,(function*(){try{const t=yield fetch(`${this.baseUrlTonder}/api/v1/cards/`,{method:"POST",headers:{Authorization:`Token ${e}`,"Content-Type":"application/json"},signal:this.signal,body:JSON.stringify(o)});return t.ok?yield t.json():yield this.buildErrorResponse(t)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}getCustomerCards(e,o=""){return t(this,void 0,void 0,(function*(){try{const t=yield fetch(`${this.baseUrlTonder}/api/v1/cards/${o}`,{method:"GET",headers:{Authorization:`Token ${e}`,"Content-Type":"application/json"},signal:this.signal});return t.ok?yield t.json():yield this.buildErrorResponse(t)}catch(e){return this.buildErrorResponseFromCatch(e)}}))}buildErrorResponseFromCatch(e){return new o({code:void 0,body:void 0,name:"string"==typeof e?"catch":e.name,message:"string"==typeof e?e:e.message,stack:"string"==typeof e?void 0:e.stack})}buildErrorResponse(e,i=void 0){var r,n,s,d,a,l;return t(this,void 0,void 0,(function*(){return new o({code:null===(n=null===(r=e.status)||void 0===r?void 0:r.toString)||void 0===n?void 0:n.call(r),body:yield null===(s=null==e?void 0:e.json)||void 0===s?void 0:s.call(e),name:null===(a=null===(d=e.status)||void 0===d?void 0:d.toString)||void 0===a?void 0:a.call(d),message:yield null===(l=null==e?void 0:e.text)||void 0===l?void 0:l.call(e),stack:i})}))}getFields(o,i){return t(this,void 0,void 0,(function*(){return yield Promise.all(Object.keys(o).map((o=>t(this,void 0,void 0,(function*(){return{element:yield i.create({table:"cards",column:o,type:e.ElementType.INPUT_FIELD}),key:o}})))))}))}}export{i as LiteCheckout};

package/dist/types/commons.d.ts

@@ -0,0 +1,58 @@
+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;
+    };
+    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;
+    cart: {
+        total: string | number;
+        items: OrderItem[];
+    };
+};

package/dist/types/requests.d.ts

@@ -0,0 +1,55 @@
+import { OrderItem } from "./commons";
+import { SkyflowRecord } from "./skyflow";
+export interface CreateOrderRequest {
+    business: string;
+    client: string;
+    billing_address_id?: string | null;
+    shipping_address_id?: string | null;
+    amount: number;
+    status: string;
+    reference: string | number;
+    is_oneclick: boolean;
+    items: OrderItem[];
+}
+export type CreatePaymentRequest = {
+    business_pk: string | number;
+    amount: number;
+    date: string;
+    order: string | number;
+};
+export type StartCheckoutRequest = {
+    card: any;
+    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;
+};
+export interface VaultRequest extends SkyflowRecord {
+    records: SkyflowRecord[];
+    continueOnError?: boolean;
+    byot?: "DISABLE" | "ENABLE" | "ENABLE_STRICT";
+}
+export type RegisterCustomerCardRequest = {
+    skyflow_id: string;
+};
+export type TokensRequest = {
+    vault_id: string;
+    vault_url: string;
+    data: {
+        [key: string]: any;
+    };
+};