Merge pull request #122 from SpringRoll/release/2.3.2

Release 2.3.2

Author: 902seanryan

CHANGELOG.md

@@ -5,8 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [2.3.2] 2022-04-14
+
+## Fixed
+
+- re-re-named UserDataPlugin onUserDataRead and onUserDataRemove parameters from 'name' to 'data' to match Bellhop
+
 ## [2.3.1] 2022-03-10
+
 ### Fixed
+
 - replaced `return` with `continue` in set up plugin function
 
 ## [2.3.0] - 2022-03-03
@@ -20,9 +29,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bumped karma dependency from 5.2.3 to 6.3.14
 
 ## [2.2.5] - 2022-02-03
+
 - Upgraded follow-redirects dependency for security alert
 
 ## Fixed
+
 - Fixed error when reporting a plugin preload failure
 
 ## [2.2.4] - 2021-06-04

dist/SpringRoll-Container-umd.js

@@ -1,6 +1,6 @@
 {
   "name": "springroll-container",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "The iframe controller for interacting with SpringRoll applications",
   "main": "./dist/index.js",
   "license": "MIT",

dist/SpringRoll-Container-umd.js.map

@@ -5,7 +5,7 @@ import { BasePlugin } from '../base-plugins';
  * @export
  * @class UserDataPlugin
  * @extends {BasePlugin}
- * @property {SavedDataHandler} SavedDataHandler The handler to work with the savedData class 
+ * @property {SavedDataHandler} SavedDataHandler The handler to work with the savedData class
  */
 export class UserDataPlugin extends BasePlugin {
   /**
@@ -34,7 +34,7 @@ export class UserDataPlugin extends BasePlugin {
   }
 
   /**
-   * 
+   *
    * @memberof UserDataPlugin
    */
   init() {
@@ -54,27 +54,27 @@ export class UserDataPlugin extends BasePlugin {
   }
 
   /**
-   * Handler for the userDataRemove event 
+   * Handler for the userDataRemove event
    * @method onUserDataRemove
    * @private
-   * @param {string} name The name of the record to be removed
+   * @param {string} data The name of the record to be removed
    * @param {string} type The type of listener for bellhop to send to
    */
-  onUserDataRemove({ name, type }) { 
-    SavedDataHandler.remove(name, () => {
+  onUserDataRemove({ data, type }) {
+    SavedDataHandler.remove(data, () => {
       this.client.send(type);
     });
   }
 
   /**
    * Handler for the userDataRead event
    * @method onUserDataRead
-   * @private   
-   * @param {string} name The name of the record to be removed
+   * @private
+   * @param {string} data The name of the record to be removed
    * @param {string} type The type of listener for bellhop to send to
    */
-  onUserDataRead({ name, type }) {
-    SavedDataHandler.read(name, value => this.client.send(type, value));
+  onUserDataRead({ data, type }) {
+    SavedDataHandler.read(data, value => this.client.send(type, value));
   }
 
   /**
@@ -91,7 +91,7 @@ export class UserDataPlugin extends BasePlugin {
   }
 
   // ----------------------------------------------------------------
-  //                      IndexedDB Manipulation        
+  //                      IndexedDB Manipulation
   // ----------------------------------------------------------------
 
   /**
@@ -100,12 +100,12 @@ export class UserDataPlugin extends BasePlugin {
    * @param {string} dbName The name of your IndexedDB database
    * @param {string} [dbVersion] The version number of the database
    * @param {JSON} [additions] Any additions to the structure of the database
-   * @param {array} [additions.stores] Any stores to be added into the database syntax: 
+   * @param {array} [additions.stores] Any stores to be added into the database syntax:
    * @param {string} [additions.stores.storeName] The name of the store
-   * @param {object} [additions.stores.options] Optionally, the option parameter for the createStore method 
-   * @param {array} [additions.indexes] Any Indexes to be added to the database syntax: 
+   * @param {object} [additions.stores.options] Optionally, the option parameter for the createStore method
+   * @param {array} [additions.indexes] Any Indexes to be added to the database syntax:
    * @param {string} [additions.indexes.storeName] The name of the store
-   * @param {object} [additions.indexes.options] Optionally, the option parameter for the createIndex method 
+   * @param {object} [additions.indexes.options] Optionally, the option parameter for the createIndex method
    * @param {string} type The type of listener for bellhop to send to
    */
   onIDBOpen({type, data: {dbName, dbVersion = null, additions = {}, deletions = {} }}) {
@@ -119,12 +119,12 @@ export class UserDataPlugin extends BasePlugin {
    * @param {string} type The type of listener for bellhop to send to
    * @param {string} storeName The name of the store from which the record will be updated
    * @param {*} value The value for the record with the given key to be updated
-   * @param {string} key the key of the record to be updated 
+   * @param {string} key the key of the record to be updated
    */
   onIDBAdd({type, data: { storeName, value, key}}) {
     this.savedDataHandler.IDBAdd(storeName, value, key, value => this.client.send(type, value));
   }
-  
+
   /**
    * Update a record from a given store
    * @param {string} type The type of listener for bellhop to send to
@@ -140,7 +140,7 @@ export class UserDataPlugin extends BasePlugin {
    * Remove a record from a store
    * @param {string} type The type of listener for bellhop to send to
    * @param {string} storeName The name of the store from which the record will be removed
-   * @param {*} key the key of the record to be removed 
+   * @param {*} key the key of the record to be removed
    */
   onIDBRemove({type, data: {storeName, key}}) {
     this.savedDataHandler.IDBRemove(storeName, key, value => this.client.send(type, value));
@@ -149,13 +149,13 @@ export class UserDataPlugin extends BasePlugin {
   /**
    * Return a record from a given store with a given key
    * @param {string} storeName The name of the store to read from
-   * @param {string} key The key for the record in the given store 
+   * @param {string} key The key for the record in the given store
    * @param {string} type The type of listener for bellhop to send to
    */
   onIDBRead({type, data: {storeName, key}}) {
     this.savedDataHandler.IDBRead(storeName, key, value => this.client.send(type, value));
   }
-  
+
   /**
    * Get all records from a store
    * @param {string} storeName The store to get all records from
@@ -165,7 +165,7 @@ export class UserDataPlugin extends BasePlugin {
   onIDBReadAll({ type, data: {storeName, count} }) {
     this.savedDataHandler.IDBReadAll(storeName, count, value => this.client.send(type, value));
   }
-  
+
   /**
    * Get the version of a given database
    * @param {string} dbName The name of the database to return the version of
@@ -176,7 +176,7 @@ export class UserDataPlugin extends BasePlugin {
     const sdh = new SavedDataHandler();
     sdh.IDBGetVersion(dbName, value => this.client.send(type, value));
   }
-  
+
   /**
    * Close the connection with the database
    * @param {string} type The type of listener for bellhop to send to