@tonder.io/ionic-lite-sdk 0.0.35-beta.24 → 0.0.35-beta.26

package/README.md

@@ -8,7 +8,7 @@ Tonder SDK helps to integrate the services Tonder offers in your own mobile app
 1. [Installation](#installation)
 2. [Usage](#usage)
 3. [Configuration Options](#configuration-options)
-4. [Styling InlineCheckout](#styling-inlinecheckout)
+4. [Mobile Settings](#mobile-settings)
 5. [Payment Data Structure](#payment-data-structure)
 6. [Field Validation Functions](#field-validation-functions)
 7. [API Reference](#api-reference)
@@ -33,11 +33,11 @@ Add dependencies to the root of the app (index.html)
 
 ## Usage
 LiteCheckout allows you to build a custom checkout interface using Tonder's core functionality
-## Import LiteCheckout class
+### Import LiteCheckout class
 ```javascript
 import { LiteCheckout } from "@tonder.io/ionic-lite-sdk"
 ```
-## Create instance
+### Create instance
 
 ```javascript
 const liteCheckout = new LiteCheckout({ 
@@ -97,6 +97,23 @@ const paymentResponse = await liteCheckout.payment(paymentData);
 | returnUrl |  string  |                    URL where the checkout form is mounted (used for 3DS)                     |
 | callBack  | function |         Callback function to be invoked after the payment process ends successfully.         |
 
+## Mobile settings
+
+<font size="3">If you are deploying to Android, edit your AndroidManifest.xml file to add the Internet permission.</font>
+
+```xml
+<!-- Required to fetch data from the internet. -->
+<uses-permission android:name="android.permission.INTERNET" />
+```
+
+<font size="3">Likewise, if you are deploying to macOS, edit your macos/Runner/DebugProfile.entitlements and macos/Runner/Release.entitlements files to include the network client entitlement.</font>
+
+```xml
+<!-- Required to fetch data from the internet. -->
+<key>com.apple.security.network.client</key>
+<true>
+```
+
 ## Payment Data Structure
 
 When calling the `payment` method, use the following data structure:
@@ -235,12 +252,13 @@ For Angular, we recommend using a service to manage the Tonder instance:
 // tonder.service.ts
 import { Injectable } from "@angular/core";
 import { LiteCheckout } from "@tonder.io/ionic-lite-sdk";
+import {ILiteCheckout} from "@tonder.io/ionic-lite-sdk/dist/types/liteInlineCheckout";
 
 @Injectable({
   providedIn: "root",
 })
 export class TonderService {
-  private liteCheckout!: LiteCheckout;
+  private liteCheckout!: ILiteCheckout;
 
   constructor(@Inject(Object) private sdkParameters: IInlineLiteCheckoutOptions) {
     this.initializeInlineCheckout();
@@ -258,7 +276,7 @@ export class TonderService {
     await this.liteCheckout.injectCheckout();
   }
 
-  verify3dsTransaction(): Promise<ITransaction | void> {
+  verify3dsTransaction(): Promise<ITransaction | IStartCheckoutResponse | void> {
     return this.liteCheckout.verify3dsTransaction();
   }
 
@@ -334,13 +352,14 @@ import { TonderService } from "./tonder.service";
 export class TonderCheckoutComponent implements OnInit, OnDestroy {
   loading = false;
   checkoutData: IProcessPaymentRequest;
-    paymentForm = new FormGroup({
-        name: new FormControl('Pedro Paramo'),
-        cardNumber: new FormControl('4242424242424242'),
-        month: new FormControl('12'),
-        expirationYear: new FormControl('28'),
-        cvv: new FormControl('123')
-    });
+  paymentForm = new FormGroup({
+      name: new FormControl('Pedro Paramo'),
+      cardNumber: new FormControl('4242424242424242'),
+      month: new FormControl('12'),
+      expirationYear: new FormControl('28'),
+      cvv: new FormControl('123')
+  });
+  
   constructor(private tonderService: TonderService) {
       this.checkoutData = {
           customer: {
@@ -414,7 +433,7 @@ export class TonderCheckoutComponent implements OnInit, OnDestroy {
 
 ## Deprecated Fields
 
-The following functions and fields have been deprecated and should no longer be used. Consider using the recommended alternatives:
+The following fields have been deprecated and should no longer be used. Consider using the recommended alternatives:
 
 ### `apiKeyTonder` Property
 
@@ -433,6 +452,8 @@ The following functions and fields have been deprecated and should no longer be
 
 ## Deprecated Functions
 
+The following functions have been deprecated and should no longer be used. Consider using the recommended alternatives:
+
 ### `customerRegister`
 
 - **Deprecated Reason:** This function is no longer necessary as registration is now automatically handled during payment processing or when using card management methods.
@@ -475,8 +496,7 @@ The following functions and fields have been deprecated and should no longer be
 
 ### General
 
-- Replace `'your-api-key'`, `'http://your-website.com/checkout'`, `returnUrl`, and `paymentData` with your actual values.
-- The `paymentData` should be defined according to your specific requirements.
+- Replace `apiKey`, `mode`, `returnUrl` with your actual values.
 - Remember to use the `configureCheckout` function after creating an instance of `LiteCheckout`. This ensures that functions such as payment processing, saving cards, deleting cards, and others work correctly.
 
 ### Script Dependencies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonder.io/ionic-lite-sdk",
-  "version": "0.0.35-beta.24",
+  "version": "0.0.35-beta.26",
   "description": "Tonder ionic lite SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/.idea/aws.xml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="accountSettings">
-    <option name="activeProfile" value="profile:default" />
-    <option name="activeRegion" value="us-east-1" />
-    <option name="recentlyUsedProfiles">
-      <list>
-        <option value="profile:default" />
-      </list>
-    </option>
-    <option name="recentlyUsedRegions">
-      <list>
-        <option value="us-east-1" />
-      </list>
-    </option>
-  </component>
-</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="TsLint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/prettier.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

package/.idea/workspace.xml

@@ -1,144 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="SELECTIVE" />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="49ce0c58-6ae2-4b0a-9ac0-48692c69c15e" name="Changes" comment="">
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/package-lock.json" beforeDir="false" afterPath="$PROJECT_DIR$/package-lock.json" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/classes/BaseInlineCheckout.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/classes/BaseInlineCheckout.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/classes/errorResponse.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/classes/errorResponse.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/classes/liteCheckout.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/classes/liteCheckout.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/data/businessApi.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/data/businessApi.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/data/cardApi.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/data/cardApi.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/data/checkoutApi.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/data/checkoutApi.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/data/customerApi.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/data/customerApi.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/data/paymentMethodApi.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/data/paymentMethodApi.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/helpers/skyflow.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/helpers/skyflow.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/helpers/utils.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/helpers/utils.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/index.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/index.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/types/card.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/types/card.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/types/checkout.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/types/checkout.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/types/commons.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/types/commons.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/types/index.d.ts" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/types/liteInlineCheckout.d.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/types/liteInlineCheckout.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/classes/liteCheckout.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/classes/liteCheckout.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/createOrder.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/createOrder.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/createPayment.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/createPayment.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/customerRegister.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/customerRegister.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/getBusiness.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/getBusiness.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/getCustomerCards.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/getCustomerCards.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/registerCustomerCard.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/registerCustomerCard.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/startCheckoutRouter.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/startCheckoutRouter.test.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/methods/startCheckoutRouterFull.test.ts" beforeDir="false" afterPath="$PROJECT_DIR$/tests/methods/startCheckoutRouterFull.test.ts" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="MarkdownSettingsMigration">
-    <option name="stateVersion" value="1" />
-  </component>
-  <component name="ProjectColorInfo">{
-  &quot;customColor&quot;: &quot;&quot;,
-  &quot;associatedIndex&quot;: 1
-}</component>
-  <component name="ProjectId" id="2lFWiEUFmmZczyeFIMfy8VbaFup" />
-  <component name="ProjectViewState">
-    <option name="autoscrollFromSource" value="true" />
-    <option name="autoscrollToSource" value="true" />
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "RunOnceActivity.OpenProjectViewOnStart": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "git-widget-placeholder": "main",
-    "last_opened_file_path": "/Users/davidhernandezalmagro/Desktop/Tonder/ionic-lite/src/types",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "prettierjs.PrettierConfiguration.Package": "/Users/davidhernandezalmagro/.nvm/versions/node/v21.2.0/lib/node_modules/prettier",
-    "settings.editor.selected.configurable": "settings.javascript.prettier",
-    "ts.external.directory.path": "/Users/davidhernandezalmagro/Desktop/Tonder/ionic-lite/node_modules/typescript/lib",
-    "vue.rearranger.settings.migration": "true"
-  }
-}]]></component>
-  <component name="RecentsManager">
-    <key name="CopyFile.RECENT_KEYS">
-      <recent name="$PROJECT_DIR$/src/types" />
-    </key>
-    <key name="MoveFile.RECENT_KEYS">
-      <recent name="$PROJECT_DIR$/src" />
-      <recent name="$PROJECT_DIR$" />
-    </key>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="49ce0c58-6ae2-4b0a-9ac0-48692c69c15e" name="Changes" comment="" />
-      <created>1724776429568</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1724776429568</updated>
-      <workItem from="1724776430626" duration="1847000" />
-      <workItem from="1724790840744" duration="239000" />
-      <workItem from="1725305433705" duration="21026000" />
-      <workItem from="1725333899382" duration="2939000" />
-      <workItem from="1725337022494" duration="3671000" />
-      <workItem from="1725378545854" duration="22151000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-  <component name="Vcs.Log.Tabs.Properties">
-    <option name="TAB_STATES">
-      <map>
-        <entry key="MAIN">
-          <value>
-            <State />
-          </value>
-        </entry>
-      </map>
-    </option>
-  </component>
-  <component name="XDebuggerManager">
-    <breakpoint-manager>
-      <breakpoints>
-        <line-breakpoint enabled="true" type="javascript">
-          <url>file://$PROJECT_DIR$/src/classes/liteCheckout.ts</url>
-          <line>218</line>
-          <option name="timeStamp" value="16" />
-        </line-breakpoint>
-        <line-breakpoint enabled="true" type="javascript">
-          <url>file://$PROJECT_DIR$/src/types/commons.ts</url>
-          <line>107</line>
-          <option name="timeStamp" value="17" />
-        </line-breakpoint>
-        <line-breakpoint enabled="true" type="javascript">
-          <url>file://$PROJECT_DIR$/src/classes/liteCheckout.ts</url>
-          <line>222</line>
-          <option name="timeStamp" value="18" />
-        </line-breakpoint>
-        <line-breakpoint enabled="true" type="javascript">
-          <url>file://$PROJECT_DIR$/src/classes/liteCheckout.ts</url>
-          <line>304</line>
-          <properties lambdaOrdinal="-1" />
-          <option name="timeStamp" value="21" />
-        </line-breakpoint>
-      </breakpoints>
-    </breakpoint-manager>
-  </component>
-</project>