Fixed bugs and updated to v1.4.1

Fixed bug in PersistenceStoreManager.prototype.getStoresMetadata()

Author: kentarokinebuchi

JSDOC.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.0 #
+# offline-persistence-toolkit 1.4.1 #
 
 ## Introduction ##
 

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.0 #
+# offline-persistence-toolkit 1.4.1 #
 
 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.4.0/min'
+      'persist' : 'js/libs/persist/v1.4.1/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.4.0/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.4.1/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.4.0/min'`.
+It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.4.1/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.4.0/min'
+      'persist' : 'js/libs/persist/v1.4.1/min'
 
       // Other path mappings here
  }

USAGE.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.0 #
+# offline-persistence-toolkit 1.4.1 #
 
 # Introduction #
 

docs/PersistenceStoreManager.html

@@ -279,7 +279,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line162">line 162</a>
+        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line164">line 164</a>
     </li></ul></dd>
 
 
@@ -388,7 +388,7 @@ <h4 class="name" id="getStoresMetadata"><span class="type-signature"></span>##ge
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line224">line 224</a>
+        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line231">line 231</a>
     </li></ul></dd>
 
 
@@ -576,7 +576,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line134">line 134</a>
+        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line136">line 136</a>
     </li></ul></dd>
 
 
@@ -767,7 +767,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line86">line 86</a>
+        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line85">line 85</a>
     </li></ul></dd>
 
 
@@ -926,7 +926,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line72">line 72</a>
+        <a href="persistenceStoreManager.js.html">persistenceStoreManager.js</a>, <a href="persistenceStoreManager.js.html#line71">line 71</a>
     </li></ul></dd>
 
 

docs/index.html

@@ -43,7 +43,7 @@ <h3> </h3>
 
 
     <section>
-        <article><h1>offline-persistence-toolkit 1.4.0</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.4.1</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/persistenceStoreManager.js.html

@@ -31,7 +31,7 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
  * All rights reserved.
  */
 
-define(['./impl/logger', './impl/PersistenceStoreMetadata'], function (logger, PersistenceStoreMetadata) {
+define(['./impl/logger', './impl/PersistenceStoreMetadata', './pouchDBPersistenceStoreFactory'], function (logger, PersistenceStoreMetadata, pouchDBPersistenceStoreFactory) {
   'use strict';
 
   /**
@@ -53,6 +53,10 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
       value: '_defaultFactory',
       writable: false
     });
+    Object.defineProperty(this, '_METADATA_STORE_NAME', {
+      value: 'systemCache-metadataStore',
+      writable: false
+    });
     // some pattern of store name (e.g. http://) will cause issues
     // for the underlying storage system. We'll rename the store
     // name to avoid such issue. This is to store the original store
@@ -61,11 +65,6 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
       value: {},
       writable: true
     });
-
-    Object.defineProperty(this, '_storeMetadataMapping', {
-      value: {},
-      writable: true
-    });
   }
 
   /**
@@ -152,10 +151,13 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
       allVersions = allVersions || {};
       allVersions[version] = store;
       self._stores[storeName] = allVersions;
-      var metadata = new PersistenceStoreMetadata(storeName, factory, Object.keys(allVersions));;
-      self._storeMetadataMapping[storeName] = metadata;
-
-      return store;
+      var metadata = new PersistenceStoreMetadata(storeName, factory, Object.keys(allVersions));
+      return self._getMetadataStore().then(function(store) {
+        var encodedStoreName = self.encodeString(storeName);
+        return store.upsert(encodedStoreName, {}, Object.keys(allVersions));
+      }).then(function() {
+        return store;
+      });
     });
   };
 
@@ -220,14 +222,15 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
           logger.log("Offline Persistence Toolkit PersistenceStoreManager: Calling delete on store");
           return store.delete().then(function () {
             delete allversions[version];
-            var metadata = self._storeMetadataMapping[storeName];
-            if (metadata) {
-              if (allversions &amp;&amp; allversions.length > 0) {
-                metadata.versions = Object.keys(allversions);
+            return self._getMetadataStore().then(function(store) {
+              if (allversions &amp;&amp;  Object.keys(allversions).length > 0) {
+                var encodedStoreName = self.encodeString(storeName);
+                return store.upsert(encodedStoreName, null,  Object.keys(allversions));
               } else {
-                delete self._storeMetadataMapping[storeName];
+                return store.removeByKey(storeName);
               }
-            }
+            });
+          }).then(function() {
             return true;
           });
         }
@@ -242,8 +245,12 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
         var self = this;
         return Promise.all(promises).then(function () {
           delete self._stores[storeName];
-          delete self._storeMetadataMapping[storeName];
-          return true;
+          return self._getMetadataStore().then(function(store) {
+            var encodedStoreName = self.encodeString(storeName);
+            return store.removeByKey(encodedStoreName);
+          }).then(function() {
+            return true;
+          });
         });
       }
     }
@@ -258,7 +265,25 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
    * @return {Promise&lt;Map&lt;String, PersistenceStoreMetadata>>} Returns a Map of store name and store metadata.
    */
   PersistenceStoreManager.prototype.getStoresMetadata = function() {
-    return Promise.resolve(this._storeMetadataMapping);
+    var self = this;
+    return this._getMetadataStore().then(function(store) {
+      return store.keys().then(function(encodedStoreNames) {
+        var allKeysPromiseArray = [];
+        encodedStoreNames.forEach(function(encodedStoreName) {
+          allKeysPromiseArray.push(store.findByKey(encodedStoreName).then(function(entry) {
+            var allVersionsKeys = entry;
+            var storeName = self.decodeString(encodedStoreName);
+            var factory = self._factories[storeName];
+            if (!factory) {
+              factory = self._factories[self._DEFAULT_STORE_FACTORY_NAME];
+            }
+            var metadata = new PersistenceStoreMetadata(storeName, factory, allVersionsKeys);
+            return metadata;
+          }));
+        });
+        return Promise.all(allKeysPromiseArray);
+      });
+    });
   }
 
   PersistenceStoreManager.prototype._mapStoreName = function (name, options) {
@@ -273,6 +298,42 @@ <h1 class="page-title">Source: persistenceStoreManager.js</h1>
     }
   };
 
+  PersistenceStoreManager.prototype._getMetadataStore = function () {
+    var self = this;
+    if (!self._metadataStore) {
+      // check if there is a default store factory
+      var factory = this._factories[this._DEFAULT_STORE_FACTORY_NAME];
+      if (!factory) {
+        // if not, register the pouchdb store
+        this._factories[self._METADATA_STORE_NAME] = pouchDBPersistenceStoreFactory;
+      }
+      return this.openStore(self._METADATA_STORE_NAME).then(function (store) {
+        self._metadataStore = store;
+        return self._metadataStore;
+      });
+    }
+    return Promise.resolve(self._metadataStore);
+  }
+
+  PersistenceStoreManager.prototype.encodeString = function(value) {
+	  var i, arr = [];
+	  for (var i = 0; i &lt; value.length; i++) {
+		  var hex = Number(value.charCodeAt(i)).toString(16);
+		  arr.push(hex);
+	  }
+	  return arr.join('');
+  }
+
+  PersistenceStoreManager.prototype.decodeString = function (value) {
+	  var hex  = value.toString();
+    var str = '';
+    var i;
+	  for (i = 0; i &lt; hex.length; i += 2) {
+		  str += String.fromCharCode(parseInt(hex.substr(i, 2), 16));
+	  }
+	  return str;
+  }
+
   return new PersistenceStoreManager();
 });</code></pre>
         </article>

package.json

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