Fixed bug in binary data handling

Author: kentarokinebuchi

JSDOC.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.5 #
+# offline-persistence-toolkit 1.2.6 #
 
 ## Introduction ##
 

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.5 #
+# offline-persistence-toolkit 1.2.6 #
 
 offline-persistence-toolkit is a client-side JavaScript library that provides caching and offline support at the HTTP request layer. This support is transparent to the user and is done through the Fetch API and an XHR adapter. HTTP requests made while the client device is offline are captured for replay when connection to the server is restored. Additional capabilities include a persistent storage layer, synchronization manager, binary data support and various configuration APIs for customizing the default behavior. This framework can be used in both ServiceWorker and non-ServiceWorker contexts within web and hybrid mobile apps.
 
@@ -58,28 +58,28 @@ If your app uses [RequireJS](http://www.requirejs.org/ "RequireJS"), update the
 ```javascript
   requirejs.config({
     paths: {
-      'persist' : 'js/libs/persist/v1.2.5/min'
+      'persist' : 'js/libs/persist/v1.2.6/min'
 
       // Other path mappings here
  }
 ```
-For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist' : 'js/libs/persist/v1.2.5/min'` entry to the list of paths.
+For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist' : 'js/libs/persist/v1.2.6/min'` entry to the list of paths.
 
 You can choose the name of the paths prefix. That is, you can use a different value to the ‘persist’ value shown in the examples.
 
-It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.2.5/min'`.
+It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.2.6/min'`.
 
 Versions of the toolkit are also available on CDN under the latest JET release. e.g. 
 
-https://static.oracle.com/cdn/jet/v5.1.0/3rdparty/opt/debug
+https://static.oracle.com/cdn/jet/v6.2.0/3rdparty/opt/debug
 
 or
 
-https://static.oracle.com/cdn/jet/v5.1.0/3rdparty/opt/min
+https://static.oracle.com/cdn/jet/v6.2.0/3rdparty/opt/min
 
 The toolkit makes heavy use of the [Promise API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise API").  If you are targeting environments that do not support the Promise API, you will need to polyfill this feature.  We recommend the [es6-promise polyfill](https://github.com/stefanpenner/es6-promise "es6-promise polyfill").
 
-The toolkit does not have a dependency on a specific client-side storage solution, but does include a PouchDB adapter.  If you plan to use PouchDB for your persistent store, you will need to install the following PouchDB packages (This version of the toolkit is certified with version 6.3.4 of pouchdb and requires apps to use this version):
+The toolkit does not have a dependency on a specific client-side storage solution, but does include a PouchDB adapter.  If you plan to use PouchDB for your persistent store, you will need to install the following PouchDB packages (This version of the toolkit is certified with version 7.0.0 of pouchdb and requires apps to use this version):
 
     npm install pouchdb pouchdb-find
 
@@ -89,9 +89,9 @@ And again, if you are using RequireJS, you will need to map paths for these pack
 
  requirejs.config({
     paths: {
-      'pouchdb': 'js/libs/pouchdb-6.3.4',
+      'pouchdb': 'js/libs/pouchdb-7.0.0',
       'pouchfind': 'js/libs/pouchdb.find',
-      'persist' : 'js/libs/persist/v1.2.5/min'
+      'persist' : 'js/libs/persist/v1.2.6/min'
 
       // Other path mappings here
  }

USAGE.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.5 #
+# offline-persistence-toolkit 1.2.6 #
 
 # Introduction #
 

docs/index.html

@@ -43,7 +43,7 @@ <h3> </h3>
 
 
     <section>
-        <article><h1>offline-persistence-toolkit 1.2.5</h1><h2>Introduction</h2><p>This document provides a reference to the offline-persistence-toolkit's JavaScript API. Links to JSDoc for each class can be found to the right.</p>
+        <article><h1>offline-persistence-toolkit 1.2.6</h1><h2>Introduction</h2><p>This document provides a reference to the offline-persistence-toolkit's JavaScript API. Links to JSDoc for each class can be found to the right.</p>
 <p>The toolkit's <a href="https://github.com/oracle/offline-persistence-toolkit/" title="README">README</a> file provides an overview of the toolkit’s capabilities. Having read that document, you can find more information about how to implement a range of common and advanced use cases with the toolkit in the
 <a href="https://github.com/oracle/offline-persistence-toolkit/blob/master/USAGE.md" title="Usage guide">Usage guide</a>.</p>
 <h2>License</h2><p>Copyright (c) 2017 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.</p></article>

docs/persistenceUtils.html

@@ -238,7 +238,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line465">line 465</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line493">line 493</a>
     </li></ul></dd>
 
 
@@ -294,6 +294,186 @@ <h5>Returns:</h5>
 
 
 
+    <h4 class="name" id=".derivePayloadType"><span class="type-signature">(static) </span>derivePayloadType<span class="signature">(xhr, response)</span><span class="type-signature"> &rarr; {string}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Derive the payload body type based on content-type from responseheader and responseType from request.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>xhr</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">XMLHttpRequest</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">request object</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>response</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Response</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">Response object</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line43">line 43</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    Returns payload body type, possible values are:  text, blob, arraybuffer, multipart
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
     <h4 class="name" id=".isCachedResponse"><span class="type-signature">(static) </span>isCachedResponse<span class="signature">(response)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
 
 
@@ -732,7 +912,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line364">line 364</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line392">line 392</a>
     </li></ul></dd>
 
 
@@ -889,7 +1069,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line238">line 238</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line266">line 266</a>
     </li></ul></dd>
 
 
@@ -1046,7 +1226,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line65">line 65</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line93">line 93</a>
     </li></ul></dd>
 
 
@@ -1203,7 +1383,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line295">line 295</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line323">line 323</a>
     </li></ul></dd>
 
 
@@ -1403,7 +1583,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line209">line 209</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line237">line 237</a>
     </li></ul></dd>
 
 
@@ -1583,7 +1763,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line333">line 333</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line361">line 361</a>
     </li></ul></dd>
 
 

docs/persistenceUtils.js.html

@@ -68,6 +68,34 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     return response.headers.has('x-oracle-jscpt-etag-generated');
   };
 
+  /**
+   * Derive the payload body type based on content-type from response
+   * header and responseType from request.
+   * @method
+   * @name derivePayloadType
+   * @memberof persistenceUtils
+   * @static
+   * @param {XMLHttpRequest} xhr request object
+   * @param {Response} response Response object
+   * @return {string} Returns payload body type, possible values are:
+   *   text, blob, arraybuffer, multipart
+   */
+  function derivePayloadType(xhr, response) {
+    var contentType = response.headers.get('Content-Type');
+    var responseType = xhr.responseType;
+    if (_isTextPayload(response.headers)) {
+      return "text";
+    } else if (isCachedResponse(response) || responseType === 'blob') {
+      return "blob";
+    } else if (contentType.indexOf('image/') !== -1 || responseType === 'arraybuffer') {
+      return "arraybuffer";
+    } else if (contentType.indexOf('multipart/form-data') !== -1) {
+      return "multipart";
+    } else {
+      return "text";
+    }
+  }
+
   function _isTextPayload(headers) {
 
     var contentType = headers.get('Content-Type');
@@ -557,6 +585,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     buildEndpointKey: buildEndpointKey,
     _cloneRequest: _cloneRequest,
     _cloneResponse: _cloneResponse,
+    derivePayloadType: derivePayloadType
   };
 });
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oracle/offline-persistence-toolkit",
   "title": "Offline Persistence Toolkit",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Offline Persistence Toolkit by Oracle Corp.",
   "author": "oraclejet",
   "license": "UPL-1.0",