@barchart/events-api-common - npm Package Compare versions

Comparing version 1.3.5 to 1.3.6

lib/data/EventType.js

@@ -17,10 +17,13 @@ const assert = require('@barchart/common-js/lang/assert'),
 	 * @param {ProductType=} product
+	 * @param {Array=} contextKeys
 	 */
 	class EventType extends Enum {
-		constructor(code, description, product) {
+		constructor(code, description, product, contextKeys) {
 			super(code, description);
 
 			assert.argumentIsOptional(product, 'product', ProductType, 'ProductType');
+			assert.argumentIsOptional(contextKeys, 'contextKeys', Array);
 
 			this._product = product || null;
+			this._contextKeys = contextKeys || [ ];
 		}
@@ -38,2 +41,12 @@
 
+		/**
+		 * The context keys.
+		 *
+		 * @public
+		 * @returns {Array}
+		 */
+		get contextKeys() {
+			return this._contextKeys;
+		}
+
 		static get WATCHLIST_APPLICATION_LOADED() {
@@ -174,12 +187,12 @@ return watchlistApplicationLoaded;
 
-	const watchlistApplicationLoaded = new EventType('APPLICATION-LOADED', 'Application Loaded', ProductType.WATCHLIST);
+	const watchlistApplicationLoaded = new EventType('APPLICATION-LOADED', 'Application Loaded', ProductType.WATCHLIST, ['userId']);
 
-	const watchlistAccessed = new EventType('WATCHLIST-ACCESSED', 'Watchlist Selected', ProductType.WATCHLIST);
-	const watchlistCreated = new EventType('WATCHLIST-CREATED', 'Watchlist Created', ProductType.WATCHLIST);
-	const watchlistDownloaded = new EventType('WATCHLIST-DOWNLOADED', 'Watchlist Downloaded', ProductType.WATCHLIST);
-	const watchlistPrinted = new EventType('WATCHLIST-PRINTED', 'Watchlist Printed', ProductType.WATCHLIST);
-	const watchlistDeleted = new EventType('WATCHLIST-DELETED', 'Watchlist Deleted', ProductType.WATCHLIST);
+	const watchlistAccessed = new EventType('WATCHLIST-ACCESSED', 'Watchlist Selected', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistCreated = new EventType('WATCHLIST-CREATED', 'Watchlist Created', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistDownloaded = new EventType('WATCHLIST-DOWNLOADED', 'Watchlist Downloaded', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistPrinted = new EventType('WATCHLIST-PRINTED', 'Watchlist Printed', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistDeleted = new EventType('WATCHLIST-DELETED', 'Watchlist Deleted', ProductType.WATCHLIST, ['userId', 'watchlistId']);
 
-	const watchlistSymbolAdded = new EventType('SYMBOL-ADDED', 'Symbol Added', ProductType.WATCHLIST);
-	const watchlistSymbolRemoved = new EventType('SYMBOL-REMOVED', 'Symbol Removed', ProductType.WATCHLIST);
+	const watchlistSymbolAdded = new EventType('SYMBOL-ADDED', 'Symbol Added', ProductType.WATCHLIST, ['userId', 'watchlistId', 'tgamSymbol']);
+	const watchlistSymbolRemoved = new EventType('SYMBOL-REMOVED', 'Symbol Removed', ProductType.WATCHLIST, ['userId', 'watchlistId', 'tgamSymbol']);
 
@@ -192,10 +205,10 @@ const watchlistCustomViewCreated = new EventType('CUSTOM-VIEW-CREATED', 'Custom View Created', ProductType.WATCHLIST);
 
-	const watchlistDataModeChanged = new EventType('DATA-MODE-CHANGED', 'Data mode changed', ProductType.WATCHLIST);
+	const watchlistDataModeChanged = new EventType('DATA-MODE-CHANGED', 'Data mode changed', ProductType.WATCHLIST, ['userId', 'watchlistId']);
 
-	const watchlistEditScreenInvoked = new EventType('EDIT-SCREEN-INVOKED', 'Edit Screen Invoked', ProductType.WATCHLIST);
-	const watchlistPortfolioAddScreenInvoked = new EventType('PORTFOLIO-ADD-SCREEN-INVOKED', 'Portfolio Add Screen Invoked', ProductType.WATCHLIST);
-	const watchlistSymbolNotesScreenInvoked = new EventType('SYMBOL-NOTES-SCREEN-INVOKED', 'Symbol Notes Screen Accessed', ProductType.WATCHLIST);
+	const watchlistEditScreenInvoked = new EventType('EDIT-SCREEN-INVOKED', 'Edit Screen Invoked', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistPortfolioAddScreenInvoked = new EventType('PORTFOLIO-ADD-SCREEN-INVOKED', 'Portfolio Add Screen Invoked', ProductType.WATCHLIST, ['userId', 'watchlistId']);
+	const watchlistSymbolNotesScreenInvoked = new EventType('SYMBOL-NOTES-SCREEN-INVOKED', 'Symbol Notes Screen Accessed', ProductType.WATCHLIST, ['userId', 'watchlistId']);
 
-	const watchlistAssetClassFilterActivated = new EventType('ASSET-CLASS-FILTER-ACTIVATED', 'Asset Filter Activated', ProductType.WATCHLIST);
-	const watchlistAssetClassFilterDeactivated = new EventType('ASSET-CLASS-FILTER-DEACTIVATED', 'Asset Filter Deactivated', ProductType.WATCHLIST);
+	const watchlistAssetClassFilterActivated = new EventType('ASSET-CLASS-FILTER-ACTIVATED', 'Asset Filter Activated', ProductType.WATCHLIST, ['userId', 'classFilter']);
+	const watchlistAssetClassFilterDeactivated = new EventType('ASSET-CLASS-FILTER-DEACTIVATED', 'Asset Filter Deactivated', ProductType.WATCHLIST, ['userId', 'classFilter']);
 
@@ -202,0 +215,0 @@ // Portfolio

lib/data/serialization/EventJobSchema.js

@@ -85,3 +85,3 @@ const assert = require('@barchart/common-js/lang/assert'),
 		.withField('filter.customer', DataType.forEnum(CustomerType, 'CustomerType'))
-		.withField('filter.product', DataType.forEnum(ProductType, 'ProductType'), true)
+		.withField('filter.product', DataType.forEnum(ProductType, 'ProductType'))
 		.withField('filter.start', DataType.TIMESTAMP, true)
@@ -97,3 +97,3 @@ .withField('filter.end', DataType.TIMESTAMP, true)
 		.withField('filter.customer', DataType.forEnum(CustomerType, 'CustomerType'))
-		.withField('filter.product', DataType.forEnum(ProductType, 'ProductType'), true)
+		.withField('filter.product', DataType.forEnum(ProductType, 'ProductType'))
 		.withField('filter.start', DataType.TIMESTAMP, true)
@@ -100,0 +100,0 @@ .withField('filter.end', DataType.TIMESTAMP, true)

package.json

 {
   "name": "@barchart/events-api-common",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "Common classes used by the Event system",
@@ -5,0 +5,0 @@ "author": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20946

increased by3.27%

Lines of code

640

increased by1.91%

No dependency changes