Updated annotations and set the version to 1.2.7

Author: kentarokinebuchi

JSDOC.md

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

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.6 #
+# offline-persistence-toolkit 1.2.7 #
 
 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,16 +58,16 @@ If your app uses [RequireJS](http://www.requirejs.org/ "RequireJS"), update the
 ```javascript
   requirejs.config({
     paths: {
-      'persist' : 'js/libs/persist/v1.2.6/min'
+      'persist' : 'js/libs/persist/v1.2.7/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.6/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.7/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.6/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.7/min'`.
 
 Versions of the toolkit are also available on CDN under the latest JET release. e.g. 
 
@@ -91,7 +91,7 @@ And again, if you are using RequireJS, you will need to map paths for these pack
     paths: {
       'pouchdb': 'js/libs/pouchdb-7.0.0',
       'pouchfind': 'js/libs/pouchdb.find',
-      'persist' : 'js/libs/persist/v1.2.6/min'
+      'persist' : 'js/libs/persist/v1.2.7/min'
 
       // Other path mappings here
  }

USAGE.md

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

docs/defaultResponseProxy.js.html

@@ -196,10 +196,10 @@ <h1 class="page-title">Source: defaultResponseProxy.js</h1>
           logger.log("Offline Persistence Toolkit DefaultResponseProxy: Insert Response in syncManager after error for request with enpointKey: " + endpointKey);
           _insertSyncManagerRequest(requestClone, null, true).then(function() {
             cacheHandler.unregisterEndpointOptions(endpointKey);
-            reject(err); 
+            reject(err);
           }, function() {
             cacheHandler.unregisterEndpointOptions(endpointKey);
-            reject(err); 
+            reject(err);
           });
         });
       });
@@ -277,7 +277,7 @@ <h1 class="page-title">Source: defaultResponseProxy.js</h1>
 
       return fetchStrategy(request, self._options);
     };
-    
+
     /**
      * The default HEAD request handler.
      * Processes the HEAD Request using the default logic. Can be overrided to provide
@@ -294,7 +294,7 @@ <h1 class="page-title">Source: defaultResponseProxy.js</h1>
       logger.log("Offline Persistence Toolkit DefaultResponseProxy: Processing Request with default HEAD Handler");
       return _handleGetWithFetchStrategy(this, request);
     };
-    
+
     /**
      * The default OPTIONS request handler.
      * The default implementation when offline will return a Response with
@@ -366,7 +366,7 @@ <h1 class="page-title">Source: defaultResponseProxy.js</h1>
 
         if (ifMatch || ifNoneMatch) {
           logger.log("Offline Persistence Toolkit DefaultResponseProxy: Generating ETag for offline Response for default PUT Handler");
-          var randomInt = Math.floor(Math.random() * 1000000);
+          var randomInt = Math.floor(Math.random() * 1000000); // @randomNumberOk - Only used to generate ETag while offline
           requestData.headers['etag'] = (Date.now() + randomInt).toString();
           requestData.headers['x-oracle-jscpt-etag-generated'] = requestData.headers['etag'];
           delete requestData.headers['if-match'];

docs/images/arch_diagram.png

@@ -43,7 +43,7 @@ <h3> </h3>
 
 
     <section>
-        <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>
+        <article><h1>offline-persistence-toolkit 1.2.7</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/index.html

@@ -145,7 +145,7 @@ <h4 class="name" id=".buildEndpointKey"><span class="type-signature">(static) </
 
 
 <div class="description">
-    helper function to build endpoint key to register options under.The option contains shredder/unshredder needed for cache to shred/unshreddresponses. Ideally, we would like cache to be able to look up suchinformation in the framework based on scope, but there is no central placefor such information to reside, considering the facts that the frameworkshould work in service worker case. So the solution is for cache tolookup the information based on request.url, thus we require(1) responseProxy needs to register/unregister the options so during which    time period cache is able to look up shredder/unshredder(2) because of asynchronous nature, there could be multiple fetch events    going on from the same url, while we don't want the registered     shredder/unshredder to grow out of control, we create a unique key    so we can use the same key to unreigster the shredder/unshredder(3) any cache operations needs to happen within defaultResponseProxy    processRequest scope.
+    helper function to build endpoint key to register options under.The option contains shredder/unshredder needed for cache to shred/unshreddresponses. Ideally, we would like cache to be able to look up suchinformation in the framework based on scope, but there is no central placefor such information to reside, considering the facts that the frameworkshould work in service worker case. So the solution is for cache tolookup the information based on request.url, thus we require(1) responseProxy needs to register/unregister the options so during which    time period cache is able to look up shredder/unshredder(2) because of asynchronous nature, there could be multiple fetch events    going on from the same url, while we don't want the registered    shredder/unshredder to grow out of control, we create a unique key    so we can use the same key to unreigster the shredder/unshredder(3) any cache operations needs to happen within defaultResponseProxy    processRequest scope.
 </div>
 
 
@@ -976,7 +976,7 @@ <h4 class="name" id=".requestFromJSON"><span class="type-signature">(static) </s
 
 
 <div class="description">
-    Return a Request object constructed from the JSON object returned by requestToJSON
+    Return a Request object constructed from the JSON object returned byrequestToJSON
 </div>
 
 
@@ -1647,7 +1647,7 @@ <h4 class="name" id=".setResponsePayload"><span class="type-signature">(static)
 
 
 <div class="description">
-    Update the Response object with the provided payload. The existing payload will be replaced
+    Update the Response object with the provided payload. The existing payloadwill be replaced
 </div>
 
 

docs/persistenceUtils.html

@@ -33,15 +33,15 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
 define(['./impl/logger'], function (logger) {
   'use strict';
-  
+
   /**
    * @class persistenceUtils
    * @classdesc Provide various utilities for converting Request/Response objects
    * to JSON.
    * @export
    * @hideconstructor
    */
-  
+
   /**
    * Return whether the Response is a cached Response
    * @method
@@ -54,7 +54,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
   function isCachedResponse(response) {
     return response.headers.has('x-oracle-jscpt-cache-expiration-date');
   };
-  
+
   /**
    * Return whether the Response has a generated ETag
    * @method
@@ -67,7 +67,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
   function isGeneratedEtagResponse(response) {
     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.
@@ -109,7 +109,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     }
     return false;
   };
-  
+
   function _isMultipartPayload(headers) {
 
     var contentType = headers.get('Content-Type');
@@ -138,7 +138,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     requestObject['headers'] = _getHeaderValues(request.headers);
     return _copyPayload(request, requestObject);
   };
-  
+
   function _copyProperties(sourceObj, targetObj, ignoreProps) {
     for (var k in sourceObj) {
       if (typeof (sourceObj[k]) !== 'function' &amp;&amp;
@@ -150,11 +150,11 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
       }
     }
   };
-  
+
   function _isPrivateProperty(property) {
     return property.indexOf('_') === 0;
   };
-  
+
   function _getHeaderValues(headers) {
     var headersData = {};
     if (headers.entries) {
@@ -179,10 +179,10 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
       })
     }
     _addDateHeaderIfNull(headersData);
- 
+
     return headersData;
   };
-  
+
   function _addDateHeaderIfNull(headersData) {
     // Date is not exposed for CORS request/response
     var date = headersData['date'];
@@ -196,7 +196,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
   function _copyPayload(source, targetObj) {
     targetObj.body = {};
-    
+
     if ((source instanceof Request) &amp;&amp;
         _isMultipartPayload(source.headers)) {
       return _copyMultipartPayload(source, targetObj);
@@ -210,7 +210,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
       });
     }
 
-    if (!(source instanceof Request) &amp;&amp; 
+    if (!(source instanceof Request) &amp;&amp;
         typeof(source.arrayBuffer) === 'function') {
       return source.arrayBuffer().then(function (aBuffer) {
         if (aBuffer.byteLength > 0) {
@@ -222,7 +222,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     return Promise.reject(new Error({message: 'payload body type is not supported'}));
   };
-  
+
   function _copyMultipartPayload(request, targetObj) {
     logger.log("Offline Persistence Toolkit persistenceUtils: Copying multipart payload");
     if (typeof(request.formData) === 'function') {
@@ -292,7 +292,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
   };
 
   /**
-   * Return a Request object constructed from the JSON object returned by 
+   * Return a Request object constructed from the JSON object returned by
    * requestToJSON
    * @method
    * @name requestFromJSON
@@ -310,11 +310,11 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     return _createRequestFromJsonObj(data, initFromData);
   };
-  
+
   function _copyPayloadFromJsonObj(data, targetObj) {
     var skipContentType = false;
     var body = data.body;
-    
+
     if (body.text &amp;&amp; body.text.length > 0) {
       targetObj.body = body.text;
     } else if (body.arrayBuffer) {
@@ -331,7 +331,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     return skipContentType;
   };
-  
+
   function _createHeadersFromJsonObj(data, skipContentType) {
     var headers = new Headers();
     Object.keys(data.headers).forEach(function (key) {
@@ -343,7 +343,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     return headers;
   };
-  
+
   function _createRequestFromJsonObj(data, initFromData) {
     return Promise.resolve(new Request(data.url, initFromData));
   };
@@ -366,7 +366,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     return _createResponseFromJsonObj(data, initFromData);
   };
-  
+
   function _createResponseFromJsonObj(data, initFromData) {
     var response;
     var body = data.body;
@@ -387,28 +387,28 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
   };
 
   /**
-   * Update the Response object with the provided payload. The existing payload 
+   * Update the Response object with the provided payload. The existing payload
    * will be replaced
    * @method
    * @name setResponsePayload
    * @memberof persistenceUtils
    * @static
    * @param {Response} response Response object
    * @param {Object} payload JSON payload data
-   * @return {Promise} Returns a Promise which resolves to the updated Response object 
+   * @return {Promise} Returns a Promise which resolves to the updated Response object
    */
   function setResponsePayload(response, payload) {
     logger.log("Offline Persistence Toolkit persistenceUtils: setResponsePayload()");
     return responseToJSON(response).then(function (responseObject) {
       var body = responseObject.body;
-      
+
       body.arrayBuffer = null;
       body.blob = null;
       body.text = null;
-      
+
       if (payload instanceof ArrayBuffer) {
         body.arrayBuffer = payload;
-      } else if (payload instanceof Blob) { 
+      } else if (payload instanceof Blob) {
         body.blob = payload;
       } else {
         body.text = JSON.stringify(payload);
@@ -529,7 +529,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
    * (1) responseProxy needs to register/unregister the options so during which
    *     time period cache is able to look up shredder/unshredder
    * (2) because of asynchronous nature, there could be multiple fetch events
-   *     going on from the same url, while we don't want the registered 
+   *     going on from the same url, while we don't want the registered
    *     shredder/unshredder to grow out of control, we create a unique key
    *     so we can use the same key to unreigster the shredder/unshredder
    * (3) any cache operations needs to happen within defaultResponseProxy
@@ -545,19 +545,19 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     logger.log("Offline Persistence Toolkit persistenceUtils: buildEndpointKey() for Request with url: " + request.url);
     var endPointKeyObj = {
       url: request.url,
-      id : Math.random().toString(36).replace(/[^a-z]+/g, '')
+      id : Math.random().toString(36).replace(/[^a-z]+/g, '') // @randomNumberOk - Only used to internally keep track of request URLs
     };
     return JSON.stringify(endPointKeyObj);
   };
-  
+
   function _cloneRequest(request) {
     return requestToJSON(request, {_noClone: true}).then(function (requestJson) {
       return requestFromJSON(requestJson).then(function (requestClone) {
         return requestClone;
       });
     });
   };
-  
+
   function _cloneResponse(response, options) {
     options = options || {};
     return responseToJSON(response, {_noClone: true}).then(function (responseJson) {

docs/persistenceUtils.js.html

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

package.json

@@ -168,10 +168,10 @@ define(['./persistenceManager', './persistenceUtils', './fetchStrategies',
           logger.log("Offline Persistence Toolkit DefaultResponseProxy: Insert Response in syncManager after error for request with enpointKey: " + endpointKey);
           _insertSyncManagerRequest(requestClone, null, true).then(function() {
             cacheHandler.unregisterEndpointOptions(endpointKey);
-            reject(err); 
+            reject(err);
           }, function() {
             cacheHandler.unregisterEndpointOptions(endpointKey);
-            reject(err); 
+            reject(err);
           });
         });
       });
@@ -249,7 +249,7 @@ define(['./persistenceManager', './persistenceUtils', './fetchStrategies',
 
       return fetchStrategy(request, self._options);
     };
-    
+
     /**
      * The default HEAD request handler.
      * Processes the HEAD Request using the default logic. Can be overrided to provide
@@ -266,7 +266,7 @@ define(['./persistenceManager', './persistenceUtils', './fetchStrategies',
       logger.log("Offline Persistence Toolkit DefaultResponseProxy: Processing Request with default HEAD Handler");
       return _handleGetWithFetchStrategy(this, request);
     };
-    
+
     /**
      * The default OPTIONS request handler.
      * The default implementation when offline will return a Response with
@@ -338,7 +338,7 @@ define(['./persistenceManager', './persistenceUtils', './fetchStrategies',
 
         if (ifMatch || ifNoneMatch) {
           logger.log("Offline Persistence Toolkit DefaultResponseProxy: Generating ETag for offline Response for default PUT Handler");
-          var randomInt = Math.floor(Math.random() * 1000000);
+          var randomInt = Math.floor(Math.random() * 1000000); // @randomNumberOk - Only used to generate ETag while offline
           requestData.headers['etag'] = (Date.now() + randomInt).toString();
           requestData.headers['x-oracle-jscpt-etag-generated'] = requestData.headers['etag'];
           delete requestData.headers['if-match'];