Merge pull request #334 from andygup/update_appcache

v2.7.1

CHANGELOG.md

@@ -1,10 +1,17 @@
 # offline-editor-js - Changelog
 
-## Version 2.7.0.1
+## Version 2.7.1 - April 29, 2015
+
+This release has enhancements and has no breaking changes.
+
+**Enhancements**
+* Added `OfflineFeaturesManager.getFeatureLayerJSONDataStore()` for use in full offline browser restarts.
+
+## Version 2.7.0.1 - April 28, 2015
 
 Closes #323 - Add an FAQ doc.
 
-## Version 2.7
+## Version 2.7 - April 27, 2015
 
 This release focused on improving the handling of attachments. Has breaking changes.
 

dist/offline-edit-src.js

@@ -1,4 +1,4 @@
-/*! offline-editor-js - v2.7.0 - 2015-04-27
+/*! offline-editor-js - v2.7.1 - 2015-04-29
 * Copyright (c) 2015 Environmental Systems Research Institute, Inc.
 * Apache License*/
 /*jshint -W030 */
@@ -111,7 +111,9 @@ define([
  layer.objectIdField = this.DB_UID;
 
  // Initialize the database as well as set offline data.
- this._initializeDB(dataStore,callback);
+ if(!this._editStore._isDBInit) {
+ this._initializeDB(dataStore,callback);
+ }
 
  // we keep track of the FeatureLayer object
  this._featureLayers[layer.url] = layer;
@@ -1096,6 +1098,28 @@ define([
  }
  },
 
+ /**
+ * Retrieves the optional feature layer storage object
+ * For use in full offline scenarios.
+ * @param callback callback(true, object) || callback(false, error)
+ */
+ getFeatureLayerJSONDataStore: function(callback){
+ if(!this._editStore._isDBInit){
+ this._initializeDB(null,function(success) {
+ if(success){
+ this._editStore.getFeatureLayerJSON(function(success,message){
+ callback(success,message);
+ });
+ }
+ }.bind(this));
+ }
+ else {
+ this._editStore.getFeatureLayerJSON(function(success,message){
+ callback(success,message);
+ });
+ }
+ },
+
  /* internal methods */
 
  /**
@@ -1808,6 +1832,7 @@ O.esri.Edit.EditStore = function () {
  "use strict";
 
  this._db = null;
+ this._isDBInit = false;
 
  // Public properties
 
@@ -2757,6 +2782,7 @@ O.esri.Edit.EditStore = function () {
 
  request.onsuccess = function (event) {
  this._db = event.target.result;
+ this._isDBInit = true;
  console.log("database opened successfully");
  callback(true);
  }.bind(this);

dist/offline-tiles-advanced-src.js

@@ -1,4 +1,4 @@
-/*! offline-editor-js - v2.7.0 - 2015-04-27
+/*! offline-editor-js - v2.7.1 - 2015-04-29
 * Copyright (c) 2015 Environmental Systems Research Institute, Inc.
 * Apache License*/
 define([

dist/offline-tiles-basic-src.js

@@ -1,4 +1,4 @@
-/*! offline-editor-js - v2.7.0 - 2015-04-27
+/*! offline-editor-js - v2.7.1 - 2015-04-29
 * Copyright (c) 2015 Environmental Systems Research Institute, Inc.
 * Apache License*/
 define([

dist/offline-tpk-src.js

@@ -1,4 +1,4 @@
-/*! offline-editor-js - v2.7.0 - 2015-04-27
+/*! offline-editor-js - v2.7.1 - 2015-04-29
 * Copyright (c) 2015 Environmental Systems Research Institute, Inc.
 * Apache License*/
 /**

doc/howtouseeditlibrary.md

@@ -111,13 +111,19 @@ You can then retrieve this data after an offline restart by using the following
 
 ```js
 
- featureLayer.getFeatureLayerJSONDataStore(function(success, dataStore){
+ offlineFeaturesManager.getFeatureLayerJSONDataStore(function(success, dataStore){
  if(success){
  myFeatureLayer = new 
  FeatureLayer(JSON.parse(dataStore.featureLayerCollection),{
  mode: FeatureLayer.MODE_SNAPSHOT,
  outFields: ["GlobalID","BSID","ROUTES","STOPNAME"]
  });
+ 
+ offlineFeaturesManager.extend(myFeatureLayer,function(result, error) {
+ if(result) {
+ console.log("Layer has been successfully rebuilt while offline!");
+ }
+ }
  }
  });
 

doc/offlinefeaturesmanager.md

@@ -42,6 +42,7 @@ Methods | Returns | Description
 `goOffline()` | nothing | Forces library into an offline state. Any edits applied to extended FeatureLayers during this condition will be stored locally.
 `goOnline(callback)` | `callback( boolean, results )` | Forces library to return to an online state. If there are pending edits, an attempt will be made to sync them with the remote feature server. Callback function will be called when resync process is done. <br><br>Refer to the [How to use the edit library doc](howtouseeditlibrary.md) for addition information on the `results` object.
 `getOnlineStatus()` | `ONLINE`, `OFFLINE` or `RECONNECTING`| Determines the current state of the manager. Please, note that this library doesn't detect actual browser offline/online condition. You need to use the `offline.min.js` library included in `vendor\offline` directory to detect connection status and connect events to goOffline() and goOnline() methods. See `military-offline.html` sample.
+`getFeatureLayerJSONDataStore` | `callback( boolean, Object)` | **New @ v2.7.1** Returns the feature layer's dataStore Object.
 `getReadableEdit()` | String | **DEPRECATED** @ v2.5. A string value representing human readable information on pending edits. Use `featureLayer.getAllEditsArray()`.
 
 

lib/edit/editsStore.js

@@ -5,6 +5,7 @@ O.esri.Edit.EditStore = function () {
  "use strict";
 
  this._db = null;
+ this._isDBInit = false;
 
  // Public properties
 
@@ -954,6 +955,7 @@ O.esri.Edit.EditStore = function () {
 
  request.onsuccess = function (event) {
  this._db = event.target.result;
+ this._isDBInit = true;
  console.log("database opened successfully");
  callback(true);
  }.bind(this);

lib/edit/offlineFeaturesManager.js

@@ -108,7 +108,9 @@ define([
  layer.objectIdField = this.DB_UID;
 
  // Initialize the database as well as set offline data.
- this._initializeDB(dataStore,callback);
+ if(!this._editStore._isDBInit) {
+ this._initializeDB(dataStore,callback);
+ }
 
  // we keep track of the FeatureLayer object
  this._featureLayers[layer.url] = layer;
@@ -1093,6 +1095,28 @@ define([
  }
  },
 
+ /**
+ * Retrieves the optional feature layer storage object
+ * For use in full offline scenarios.
+ * @param callback callback(true, object) || callback(false, error)
+ */
+ getFeatureLayerJSONDataStore: function(callback){
+ if(!this._editStore._isDBInit){
+ this._initializeDB(null,function(success) {
+ if(success){
+ this._editStore.getFeatureLayerJSON(function(success,message){
+ callback(success,message);
+ });
+ }
+ }.bind(this));
+ }
+ else {
+ this._editStore.getFeatureLayerJSON(function(success,message){
+ callback(success,message);
+ });
+ }
+ },
+
  /* internal methods */
 
  /**

package.json

@@ -1,6 +1,6 @@
 {
  "name": "offline-editor-js",
- "version": "2.7.0",
+ "version": "2.7.1",
  "description": "Lightweight set of libraries for working offline with map tiles and ArcGIS feature services",
  "author": "Andy Gup <agup@esri.com> (http://blog.andygup.net)",
  "license": "Apache 2",