@dintero/checkout-web-sdk 0.2.0 → 0.4.0

package/.github/workflows/release.yml

@@ -25,10 +25,9 @@ jobs:
         run: |
           npm install
           npm run test
-          npm run build
 
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
-        run: npx semantic-release
+        run: npm run semantic-release

package/CHANGELOG.md

@@ -1,8 +1,32 @@
+## [0.4.0]
+
+### Changed
+
+-  Changes `lockSession` to return a promise that resolves when the following `SessionLocked` event is returned from the checkout.
+-  Changes `refreshSession` to return a promise that resolves when the following `SessionUpdated` event is returned from the checkout.
+
+## [0.3.1]
+
+### Bug Fixes
+* Add correct package version to url
+
+## [0.3.0]
+
+### Features
+
+* **lock:** Add callback function to `onSessionLocked`
+
+## [0.2.0]
+
+### Features
+
+* Handling of session validation when embedded
+
 ## [0.0.17]
 
 ### Changed
 
--  Adds `onActivePaymentProductType` callback.  
+-  Adds `onActivePaymentProductType` callback.
 -  Adds `setActivePaymentProductType` function.
 
 ## [0.0.16]

package/README.md

@@ -73,8 +73,9 @@ _The checkout sdk will add a polyfill for promises if the browser does not suppo
                 console.log("href", event.href);
                 checkout.destroy();
             },
-            onSessionLocked: function(event, checkout) {
+            onSessionLocked: function(event, checkout, callback) {
                 console.log("pay_lock_id", event.pay_lock_id);
+                callback(); // refresh session
             },
             onSessionLockFailed: function(event, checkout) {
                 console.log("session lock failed");
@@ -130,8 +131,9 @@ const checkout = await embed({
         console.log("href", event.href);
         checkout.destroy();
     },
-    onSessionLocked: (event, checkout) => {
+    onSessionLocked: (event, checkout, callback) => {
         console.log("pay_lock_id", event.pay_lock_id);
+        callback(); // refresh session
     },
     onSessionLockFailed: (event, checkout) => {
         console.log("session lock failed");
@@ -176,9 +178,16 @@ To update an existing Checkout Express-session, follow these steps:
 Call lockSession on the checkout object:
 
 ```js
-checkout.lockSession();
+checkout.lockSession().then(function(sessionLockedEvent){
+    // initiate server side session update and then refresh the session
+}).catch(function(sessionLockFailedEvent) {
+    // handle failure to lock
+});;
 ```
 
+`lockSession()` returns a promise that is resolved when the `SessionLocked` event is
+received from the checkout or rejected if the SessionLockFailed event is received.
+
 When the session is successfully locked, you'll get a callback at `onSessionLocked`.
 If locking the session fails, there will be a callback at `onSessionLockFailed`.
 
@@ -196,7 +205,20 @@ After updating the session, call refreshSession on the checkout object:
 checkout.refreshSession();
 ```
 
-Editing and paying in the checkout is enabled again.
+or use the callback in `onSessionLocked`:
+
+```js
+onSessionLocked: (event, checkout, callback) => {
+    console.log("pay_lock_id", event.pay_lock_id);
+    callback(); // refresh session
+}
+```
+
+`refreshSession()` returns a promise that is resolved when the `SessionUpdated`
+event is received from the checkout.
+
+Editing and paying in the checkout is enabled again when a session without a `pay_lock`
+is loaded by the checkout.
 
 ### Validating session before payment
 

package/coverage/{Chrome Headless 80.0.3987.0 (Linux x86_64) → Chrome Headless 99.0.4844.0 (Linux x86_64)}/html/checkout.ts.html

@@ -156,7 +156,9 @@
 <a name='L97'></a><a href='#L97'>97</a>
 <a name='L98'></a><a href='#L98'>98</a>
 <a name='L99'></a><a href='#L99'>99</a>
-<a name='L100'></a><a href='#L100'>100</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L100'></a><a href='#L100'>100</a>
+<a name='L101'></a><a href='#L101'>101</a>
+<a name='L102'></a><a href='#L102'>102</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-yes">1x</span>
@@ -255,6 +257,8 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Session } from "./session";
 &nbsp;
 export enum CheckoutEvents {
@@ -311,6 +315,7 @@ export type SessionPaymentAuthorized = {
 export type SessionLocked = {
     type: CheckoutEvents.SessionLocked;
     pay_lock_id: string;
+    callback: () =&gt; void;
 };
 &nbsp;
 export type SessionLockFailed = {
@@ -333,6 +338,7 @@ export interface SessionValidationCallback {
 }
 &nbsp;
 export type WrappedValidateSession = Pick&lt;ValidateSession, "type" | "session"&gt;;
+export type WrappedSessionLocked = Pick&lt;SessionLocked, "type" | "pay_lock_id"&gt;;
 &nbsp;
 export type SessionPayment = SessionPaymentAuthorized | SessionPaymentOnHold;
 &nbsp;
@@ -350,7 +356,7 @@ export type SessionEvent =
     | SessionPaymentOnHold
     | SessionPaymentAuthorized
     | SessionPaymentError
-    | SessionLocked
+    | WrappedSessionLocked
     | SessionLockFailed
     | ActivePaymentProductType
     | WrappedValidateSession;
@@ -361,7 +367,7 @@ export type SessionEvent =
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Feb 14 2022 14:16:49 GMT+0000 (Coordinated Universal Time)
+                at Mon Mar 21 2022 13:44:46 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="prettify.js"></script>

package/coverage/{Chrome Headless 80.0.3987.0 (Linux x86_64) → Chrome Headless 99.0.4844.0 (Linux x86_64)}/html/createIframeAsync.ts.html

@@ -126,15 +126,15 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-no">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
-<span class="cline-any cline-yes">26x</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
+<span class="cline-any cline-yes">30x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -147,28 +147,28 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">26x</span>
-<span class="cline-any cline-yes">26x</span>
-<span class="cline-any cline-yes">32x</span>
-<span class="cline-any cline-yes">26x</span>
-<span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">30x</span>
+<span class="cline-any cline-yes">30x</span>
+<span class="cline-any cline-yes">36x</span>
+<span class="cline-any cline-yes">30x</span>
+<span class="cline-any cline-yes">30x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -238,7 +238,7 @@ export const createIframeAsync = (
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Feb 14 2022 14:16:49 GMT+0000 (Coordinated Universal Time)
+                at Mon Mar 21 2022 13:44:46 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="prettify.js"></script>

package/coverage/{Chrome Headless 80.0.3987.0 (Linux x86_64) → Chrome Headless 99.0.4844.0 (Linux x86_64)}/html/index.html

@@ -23,30 +23,30 @@
         <div class='clearfix'>
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">89.54% </span>
+                <span class="strong">93.6% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>137/153</span>
+                <span class='fraction'>161/172</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">74.36% </span>
+                <span class="strong">76.83% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>58/78</span>
+                <span class='fraction'>63/82</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">72.97% </span>
+                <span class="strong">86.96% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>27/37</span>
+                <span class='fraction'>40/46</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">88.72% </span>
+                <span class="strong">93.33% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>118/133</span>
+                <span class='fraction'>140/150</span>
             </div>
         
             
@@ -104,32 +104,32 @@
 
 <tr>
 	<td class="file high" data-value="index.ts"><a href="index.ts.html">index.ts</a></td>
-	<td data-value="94.2" class="pic high">
-	<div class="chart"><div class="cover-fill" style="width: 94%"></div><div class="cover-empty" style="width: 6%"></div></div>
+	<td data-value="96.59" class="pic high">
+	<div class="chart"><div class="cover-fill" style="width: 96%"></div><div class="cover-empty" style="width: 4%"></div></div>
 	</td>
-	<td data-value="94.2" class="pct high">94.2%</td>
-	<td data-value="69" class="abs high">65/69</td>
-	<td data-value="83.33" class="pct high">83.33%</td>
-	<td data-value="36" class="abs high">30/36</td>
-	<td data-value="78.95" class="pct medium">78.95%</td>
-	<td data-value="19" class="abs medium">15/19</td>
-	<td data-value="93.33" class="pct high">93.33%</td>
-	<td data-value="60" class="abs high">56/60</td>
+	<td data-value="96.59" class="pct high">96.59%</td>
+	<td data-value="88" class="abs high">85/88</td>
+	<td data-value="82.5" class="pct high">82.5%</td>
+	<td data-value="40" class="abs high">33/40</td>
+	<td data-value="92.86" class="pct high">92.86%</td>
+	<td data-value="28" class="abs high">26/28</td>
+	<td data-value="96.1" class="pct high">96.1%</td>
+	<td data-value="77" class="abs high">74/77</td>
 	</tr>
 
 <tr>
-	<td class="file medium" data-value="subscribe.ts"><a href="subscribe.ts.html">subscribe.ts</a></td>
-	<td data-value="76.47" class="pic medium">
-	<div class="chart"><div class="cover-fill" style="width: 76%"></div><div class="cover-empty" style="width: 24%"></div></div>
+	<td class="file high" data-value="subscribe.ts"><a href="subscribe.ts.html">subscribe.ts</a></td>
+	<td data-value="88.24" class="pic high">
+	<div class="chart"><div class="cover-fill" style="width: 88%"></div><div class="cover-empty" style="width: 12%"></div></div>
 	</td>
-	<td data-value="76.47" class="pct medium">76.47%</td>
-	<td data-value="34" class="abs medium">26/34</td>
-	<td data-value="62.5" class="pct medium">62.5%</td>
-	<td data-value="24" class="abs medium">15/24</td>
-	<td data-value="50" class="pct medium">50%</td>
-	<td data-value="8" class="abs medium">4/8</td>
-	<td data-value="72.41" class="pct medium">72.41%</td>
-	<td data-value="29" class="abs medium">21/29</td>
+	<td data-value="88.24" class="pct high">88.24%</td>
+	<td data-value="34" class="abs high">30/34</td>
+	<td data-value="70.83" class="pct medium">70.83%</td>
+	<td data-value="24" class="abs medium">17/24</td>
+	<td data-value="75" class="pct medium">75%</td>
+	<td data-value="8" class="abs medium">6/8</td>
+	<td data-value="86.21" class="pct high">86.21%</td>
+	<td data-value="29" class="abs high">25/29</td>
 	</tr>
 
 <tr>
@@ -155,7 +155,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Feb 14 2022 14:16:49 GMT+0000 (Coordinated Universal Time)
+                at Mon Mar 21 2022 13:44:46 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="prettify.js"></script>