Merge pull request #115 from SpringRoll/release/2.3.0

Release/2.3.0

Author: selenaqian

CHANGELOG.md

@@ -5,8 +5,18 @@ 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.0] - 2022-03-03
+
+### Added
+
+- Added context object to Container to allow data sharing between Container and plugins
+
+## Changed
+
+- Bumped karma dependency from 5.2.3 to 6.3.14
+
 ## [2.2.5] - 2022-02-03
-- Upgraded follow-redirects dependancy for security alert
+- Upgraded follow-redirects dependency for security alert
 
 ## Fixed
 - Fixed error when reporting a plugin preload failure

README.md

@@ -465,6 +465,51 @@ app.on('init', function() {
 
 Any JSON-serializable object can be set as a `playOption`.
 
+## Context
+Container has an optional parameter at instantiation time which allows the opener to attach any data they require to the Container
+instance which any plugins can interact with to share data. This data can be mutated or replaced at any time.
+
+```javascript
+
+const initialContext = {
+  hostEnvironment: 'web',
+  gameBuildInfo: {
+    commit: '#abcd123',
+    name: 'game-name'
+  }
+};
+
+const container = new Container('#game', { context: initialContext });
+
+// Once the container instance is created you can access the context from any plugin or anywhere else there is access to Container
+console.log(container.context); // { "hostEnvironment": "web", "gameBuildInfo": { "commit": "#abcd123", "name": "game-name" } }
+
+```
+
+The context can be accessed via the `container.context` getter. It can also be modified by simply adding or changing fields
+
+```javascript
+container.context.newField = 'hello';
+container.context.gamebBuildInfo = 'newInfo';
+
+// { "hostEnvironment": "web", "gameBuildInfo": "newInfo", "newField": "hello" }
+console.log(container.context);
+```
+
+You can also overwrite the context object entirely if you need to:
+
+```javascript
+container.context = {
+  newField: {
+    newKey: 'newField'
+  }
+}
+```
+
+The only caveat here is that this will check to make sure the new data is an object. If not it will log an error and leave the
+context unchanged.
+
+
 ## Saved Data API
 
 The SavedData API is made up of three classes: `SavedData`, `SavedDataHandler`, and the `UserDataPlugin`.