alchemymvc 1.3.22 → 1.4.0-alpha.2

package/lib/class/session.js

@@ -3,9 +3,9 @@ var data_listeners = alchemy.shared('data_binding_listeners');
 /**
  * The Session class
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.1
+ * @version  1.4.0
  *
  * @param    {Conduit}   conduit   The initializing conduit
  */
@@ -14,6 +14,9 @@ var Session = Function.inherits('Alchemy.Base', function ClientSession(conduit)
 	// Register the creation date
 	this.created = new Date();
 
+	// The values in the session
+	this.values = new Map();
+
 	// Register when the last scene connected
 	this.last_scene_connection = null;
 
@@ -53,7 +56,7 @@ var Session = Function.inherits('Alchemy.Base', function ClientSession(conduit)
 	// Increment the alchemy session count
 	alchemy.session_count++;
 
-	if (alchemy.settings.session_menu) {
+	if (alchemy.settings.sessions.janeway_menu) {
 		this.createMenuItem(conduit);
 	}
 });
@@ -61,11 +64,11 @@ var Session = Function.inherits('Alchemy.Base', function ClientSession(conduit)
 /**
  * Amount of requests that have been made
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.17
  *
- * @type     {Number}
+ * @type     {number}
  */
 Session.enforceProperty(function request_count(amount) {
 
@@ -85,11 +88,11 @@ Session.enforceProperty(function request_count(amount) {
 /**
  * Amount of server-side controller actions that have been executed
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {Number}
+ * @type     {number}
  */
 Session.enforceProperty(function action_count(amount) {
 
@@ -103,11 +106,11 @@ Session.enforceProperty(function action_count(amount) {
 /**
  * Idle time
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {Number}
+ * @type     {number}
  */
 Session.setProperty(function idle_time() {
 
@@ -124,7 +127,7 @@ Session.setProperty(function idle_time() {
  * @since    1.3.1
  * @version  1.3.1
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 Session.setProperty(function is_active() {
 
@@ -135,6 +138,37 @@ Session.setProperty(function is_active() {
 	return false;
 });
 
+/**
+ * Set a value in the session
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {*}   key
+ * @param    {*}   value
+ */
+Session.setMethod(function set(key, value) {
+	if (value === undefined) {
+		this.values.delete(key);
+	} else {
+		this.values.set(key, value);
+	}
+});
+
+/**
+ * Get a value from the session
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {*}   key
+ */
+Session.setMethod(function get(key) {
+	return this.values.get(key);
+});
+
 /**
  * Add the amount of time this client has been in the queue
  *
@@ -142,7 +176,7 @@ Session.setProperty(function is_active() {
  * @since    1.3.1
  * @version  1.3.1
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Session.setMethod(function addFinishedQueueDuration(ms) {
 	this.queued_time += ms;
@@ -155,7 +189,7 @@ Session.setMethod(function addFinishedQueueDuration(ms) {
  * @since    1.3.1
  * @version  1.3.1
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Session.setMethod(function hasAlreadyQueued() {
 
@@ -169,13 +203,13 @@ Session.setMethod(function hasAlreadyQueued() {
 /**
  * Register a conduit
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.17
  *
  * @param    {Conduit}   conduit   The conduit to postpone
  *
- * @return   {String}    The postponed id
+ * @return   {string}    The postponed id
  */
 Session.setMethod(function createMenuItem(conduit) {
 
@@ -233,7 +267,7 @@ Session.setMethod(function postpone(conduit, options) {
  * @since    1.3.1
  * @version  1.3.1
  *
- * @return   {Number}    The amount of renders
+ * @return   {number}    The amount of renders
  */
 Session.setMethod(function incrementRenderCount() {
 	return ++this.render_counter;
@@ -246,7 +280,7 @@ Session.setMethod(function incrementRenderCount() {
  * @since    1.3.1
  * @version  1.3.1
  *
- * @param    {String}   id   The postponement id
+ * @param    {string}   id   The postponement id
  *
  * @return   {Alchemy.Conduit.Postponement}    The postponement
  */
@@ -287,11 +321,11 @@ Session.setMethod(function getExistingPostponement(conduit) {
 /**
  * Executed when the session is removed from the session store
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.1
  *
- * @param    {Boolean}   expired   True if removed because time ran out
+ * @param    {boolean}   expired   True if removed because time ran out
  */
 Session.setMethod(function removed(expired) {
 
@@ -323,7 +357,7 @@ Session.setMethod(function removed(expired) {
 /**
  * Destroy this session
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -334,7 +368,7 @@ Session.setMethod(function destroy() {
 /**
  * Execute function when sockets are connected
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -350,7 +384,7 @@ Session.setMethod(function whenConnected(callback) {
 /**
  * Get a scene by its id
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  */
@@ -361,7 +395,7 @@ Session.setMethod(function getScene(scene_id) {
 /**
  * Expect the given scene_id to make a connection later on
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.10
  */
@@ -372,7 +406,7 @@ Session.setMethod(function expectScene(scene_id, conduit) {
 /**
  * Register a websocket connection
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.10
  */
@@ -439,7 +473,7 @@ Session.setMethod(function registerConnection(conduit) {
 /**
  * Register data bindings
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -502,13 +536,13 @@ Session.setMethod(function registerBindings(live_bindings, scene_id) {
 /**
  * Give the user an update for this data
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @param    {String|ObjectId}   id
+ * @param    {string|ObjectId}   id
  * @param    {Object}            data
- * @param    {String}            scene_id   Optional scene_id
+ * @param    {string}            scene_id   Optional scene_id
  */
 Session.setMethod(function sendDataUpdate(id, data, scene_id) {
 
@@ -560,11 +594,11 @@ Session.setMethod(function sendDataUpdate(id, data, scene_id) {
 /**
  * Send updates to all connected clients listening to this id
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.4.0
  *
- * @param    {String|ObjectId}   id
+ * @param    {string|ObjectId}   id
  * @param    {Object}            data
  */
 Alchemy.setMethod(function updateData(id, _data) {

package/lib/class/session_scene.js

@@ -2,7 +2,7 @@
  * The Session Scene class:
  * represents a specific scene/tab
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  *
@@ -29,7 +29,7 @@ const SessionScene = Function.inherits('Alchemy.Base', function SessionScene(con
 /**
  * The edit action
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  *
@@ -55,7 +55,7 @@ SessionScene.setMethod(function registerConnection(conduit) {
 /**
  * Remove a connection
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  *
@@ -79,7 +79,7 @@ SessionScene.setMethod(function removeConnection(conduit) {
 /**
  * Destroy this scene
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  */

package/lib/class/sitemap.js

@@ -5,7 +5,7 @@ let cached_sitemap;
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -17,7 +17,7 @@ const Sitemap = Function.inherits('Alchemy.Base', function Sitemap() {
 /**
  * Get the sitemap
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -50,7 +50,7 @@ Sitemap.setStatic(function get() {
 /**
  * Get all the categories
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -91,7 +91,7 @@ Sitemap.setMethod(function getCategories(prefix) {
 /**
  * Start loading the contents
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -114,7 +114,7 @@ Sitemap.setMethod(function load() {
 /**
  * Add a URL to the sitemap
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  */
@@ -137,7 +137,7 @@ Sitemap.setMethod(function addUrl(category, url, config = {}, prefix = '') {
 /**
  * Process a route section
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -170,7 +170,7 @@ Sitemap.setMethod(function processSection(section) {
 /**
  * Process a route & its sitemap config
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -188,7 +188,7 @@ Sitemap.setTypedMethod([Types.Alchemy.Route], function processRoute(route) {
 /**
  * Process a route & its sitemap config
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -206,7 +206,7 @@ Sitemap.setTypedMethod([Types.Alchemy.Route, Types.Boolean], function processRou
 /**
  * Process a route & its sitemap config
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -261,7 +261,7 @@ Sitemap.setTypedMethod([Types.Alchemy.Route, Types.Object], function processRout
 /**
  * Process a route & its sitemap config
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -279,14 +279,14 @@ Sitemap.setTypedMethod([Types.Alchemy.Route, Types.Object, Types.Alchemy.Criteri
 /**
  * Add a route with the given parameters
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.3
  *
  * @param    {Route}   route           The route of which to add something to the map
  * @param    {Object}  config          Sitemap configuration for this route
  * @param    {Object}  parameters      The parameter object to use for generating the url
- * @param    {String}  forced_prefix   The optional prefix to use
+ * @param    {string}  forced_prefix   The optional prefix to use
  *
  * @return   {Promise}
  */
@@ -351,11 +351,11 @@ Sitemap.setMethod(function addRouteWithParameters(route, config, parameters, for
 /**
  * Create an XML builder
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.4
  * @version  1.3.6
  *
- * @param    {String}   prefix
+ * @param    {string}   prefix
  *
  * @return   {Hawkejs.Builder}
  */
@@ -402,11 +402,11 @@ Sitemap.setMethod(function getXmlBuilder(prefix) {
 /**
  * Get the XML representation
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.4
  * @version  1.3.4
  *
- * @return   {String}
+ * @return   {string}
  */
 Sitemap.setMethod(function getXml() {
 	return this.getXmlBuilder().end();