@barchart/portfolio-api-common 1.3.7 → 1.3.11

package/lib/data/CorporateActionType.js

@@ -18,58 +18,58 @@ module.exports = (() => {
 		}
 
 		/**
-		 * If true, the corporate action is fictitious -- used only for internal
-		 * system purposes.
+		 * A split.
 		 *
 		 * @public
-		 * @returns {Boolean}
+		 * @static
+		 * @returns {CorporateActionType}
 		 */
-		get internal() {
-			return this._internal;
+		static get SPLIT() {
+			return split;
 		}
 
 		/**
-		 * A symbol change.
+		 * A dividend.
 		 *
 		 * @public
 		 * @static
 		 * @returns {CorporateActionType}
 		 */
-		static get SYMBOL_CHANGE() {
-			return symbolChange;
+		static get DIVIDEND() {
+			return dividend;
 		}
 
 		/**
-		 * A name change.
+		 * A stock dividend.
 		 *
 		 * @public
 		 * @static
 		 * @returns {CorporateActionType}
 		 */
-		static get NAME_CHANGE() {
-			return nameChange;
+		static get STOCK_DIVIDEND() {
+			return stockDividend;
 		}
 
 		/**
-		 * A dividend.
+		 * A symbol change.
 		 *
 		 * @public
 		 * @static
 		 * @returns {CorporateActionType}
 		 */
-		static get DIVIDEND() {
-			return dividend;
+		static get SYMBOL_CHANGE() {
+			return symbolChange;
 		}
 
 		/**
-		 * A split.
+		 * A name change.
 		 *
 		 * @public
 		 * @static
 		 * @returns {CorporateActionType}
 		 */
-		static get SPLIT() {
-			return split;
+		static get NAME_CHANGE() {
+			return nameChange;
 		}
 
 		/**
@@ -84,10 +84,11 @@ module.exports = (() => {
 		}
 	}
 
+	const split = new CorporateActionType('SPLIT', 'Split', false);
+	const dividend = new CorporateActionType('DIVIDEND', 'Dividend', false);
+	const stockDividend = new CorporateActionType('STOCK_DIVIDEND', 'Stock Dividend', false);
 	const symbolChange = new CorporateActionType('SYMBOL_CHANGE', 'Symbol Change', false);
 	const nameChange = new CorporateActionType('NAME_CHANGE', 'Name Change', false);
-	const dividend = new CorporateActionType('DIVIDEND', 'Dividend', false);
-	const split = new CorporateActionType('SPLIT', 'Split', false);
 	const delist = new CorporateActionType('DELIST', 'Delist', false);
 
 	return CorporateActionType;

package/lib/data/InstrumentType.js

@@ -236,7 +236,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param code
+		 * @param {Number} code
 		 * @returns {InstrumentType}
 		 */
 		static fromSymbolType(code) {

package/lib/formatters/TransactionFormatter.js

@@ -126,6 +126,7 @@ module.exports = (() => {
 		f.code = t.type.code;
 		f.sequence = t.sequence;
 		f.position = t.position;
+		f.open = t.snapshot.open;
 	};
 
 	const averageCostFormatter = (t, f) => {
@@ -151,53 +152,87 @@ module.exports = (() => {
 	};
 
 	const dividendFormatter = (t, f) => {
-		f.shares = t.snapshot.open;
 		f.total = t.dividend.amount;
 		f.rate = t.dividend.rate;
+
+		f.shares = t.dividend.amount.divide(t.dividend.rate);
 	};
 
-	const dividendStockFormatter = (t, f) => {
-		f.boughtSold = t.quantity;
-		f.fee = t.fee;
+	const distributionCashFormatter = (t, f) => {
+		f.total = t.dividend.amount;
+		f.rate = t.dividend.rate;
 
-		if (t.dividend && t.dividend.rate && t.dividend.price) {
-			f.shares = t.snapshot.open.subtract(t.quantity);
-			f.price = t.dividend.price;
-			f.rate = t.dividend.rate;
-		}
+		f.shares = t.dividend.amount.divide(t.dividend.rate);
 	};
 
 	const dividendReinvestFormatter = (t, f) => {
 		f.boughtSold = t.quantity;
-		f.shares = t.snapshot.open.subtract(t.quantity);
+
+		if (f.fee && !f.fee.getIsZero()) {
+			f.fee = t.fee;
+		}
+
 		f.price = t.dividend.price;
-		f.fee = t.fee;
 		f.rate = t.dividend.rate;
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
 	};
 
-	const distributionCashFormatter = (t, f) => {
-		f.shares = t.snapshot.open;
-		f.total = t.dividend.amount;
+	const distributionReinvestFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+
+		if (f.fee && !f.fee.getIsZero()) {
+			f.fee = t.fee;
+		}
+
+		f.price = t.dividend.price;
 		f.rate = t.dividend.rate;
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
 	};
 
-	const distributionFundFormatter = (t, f) => {
-		f.boughtSold =t.quantity;
-		f.fee = t.fee;
+	const dividendStockFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
 
-		if (t.dividend && t.dividend.rate && t.dividend.price) {
-			f.shares = t.snapshot.open.subtract(t.quantity);
-			f.price = t.dividend.price;
-			f.rate = t.dividend.rate;
+		if (f.fee && !f.fee.getIsZero()) {
+			f.fee = t.fee;
 		}
+
+		if (t.dividend) {
+			if (t.dividend.numerator && t.dividend.denominator) {
+				f.rate = t.dividend.numerator.divide(t.dividend.denominator);
+			} else if (t.dividend.rate) {
+				f.rate = t.dividend.rate;
+			}
+
+			if (t.dividend.price) {
+				f.price = t.dividend.price;
+			}
+		}
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
 	};
 
-	const distributionReinvestFormatter = (t, f) => {
+	const distributionFundFormatter = (t, f) => {
 		f.boughtSold = t.quantity;
+
+		if (f.fee && !f.fee.getIsZero()) {
+			f.fee = t.fee;
+		}
+
+		if (t.dividend) {
+			if (t.dividend.numerator && t.dividend.denominator) {
+				f.rate = t.dividend.numerator.divide(t.dividend.denominator);
+			} else if (t.dividend.rate) {
+				f.rate = t.dividend.rate;
+			}
+
+			if (t.dividend.price) {
+				f.price = t.dividend.price;
+			}
+		}
+
 		f.shares = t.snapshot.open.subtract(t.quantity);
-		f.price = t.dividend.price;
-		f.fee = t.fee;
-		f.rate = t.dividend.rate;
 	};
 
 	const incomeFormatter = (t, f) => {
@@ -214,8 +249,9 @@ module.exports = (() => {
 	};
 
 	const splitFormatter = (t, f) => {
-		f.shares = t.quantity;
 		f.rate = t.split.numerator.divide(t.split.denominator);
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
 	};
 
 	const valuationFormatter = (t, f) => {

package/lib/processing/PositionContainer.js

@@ -41,8 +41,8 @@ module.exports = (() => {
 	 * @public
 	 * @param {PositionTreeDefinition[]} definitions
 	 * @param {Object[]} portfolios - The portfolios.
-	 * @param {Object[]} positions - The positions (for all of the portfolios).
-	 * @param {Object[]} summaries - The positions summaries (for all of the positions).
+	 * @param {Object[]} positions - The positions (for all of portfolios).
+	 * @param {Object[]} summaries - The positions summaries (for all of positions).
 	 * @param {PositionSummaryFrame=} reportFrame - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 * @param {Day=} reportDate - The end date for the report frame.
 	 */
@@ -933,7 +933,6 @@ module.exports = (() => {
 		});
 	}
 
-
 	function updateEmptyPortfolioGroups(portfolio) {
 		Object.keys(this._trees).forEach((key) => {
 			this._trees[key].walk((group) => {

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -74,7 +74,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * A function, when given a {@link PositionItem} returns a string that is used
+		 * A function, when given a {@link PositionItem}, returns a string that is used
 		 * to group {@link PositionItem} instances into different groups.
 		 *
 		 * @public
@@ -85,7 +85,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * A function, when given a {@link PositionItem} returns a string used to describe the
+		 * A function, when given a {@link PositionItem}, returns a string used to describe the
 		 * group.
 		 *
 		 * @public
@@ -96,7 +96,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * A function, when given a {@link PositionItem} returns the {@link Currency} used to
+		 * A function, when given a {@link PositionItem}, returns the {@link Currency} used to
 		 * display values for the group.
 		 *
 		 * @public
@@ -111,7 +111,7 @@ module.exports = (() => {
 		 * groups.
 		 *
 		 * @public
-		 * @returns {Array<String>}
+		 * @returns {String[]}
 		 */
 		get requiredGroups() {
 			return this._requiredGroups;

package/lib/processing/definitions/PositionLevelType.js

@@ -3,19 +3,49 @@ const Enum = require('@barchart/common-js/lang/Enum');
 module.exports = (() => {
 	'use strict';
 
+	/**
+	 * Describes the contents of a grouping level within a tree of positions.
+	 * This is an attribute of a {@link PositionLevelDefinition}.
+	 *
+	 * @public
+	 * @extends {Enum}
+	 */
 	class PositionLevelType extends Enum {
 		constructor(code) {
 			super(code, code);
 		}
 
+		/**
+		 * A level of grouping that represents an entire portfolio's contents.
+		 *
+		 * @public
+		 * @static
+		 * @returns {PositionLevelType}
+		 */
 		static get PORTFOLIO() {
 			return portfolio;
 		}
 
+		/**
+		 * A level of grouping that represents a single positions (i.e. guaranteed to
+		 * be a leaf node in a grouping tree).
+		 *
+		 * @public
+		 * @static
+		 * @return {PositionLevelType}
+		 */
 		static get POSITION() {
 			return position;
 		}
 
+		/**
+		 * A level of grouping that is neither a portfolio or a position. This could be an
+		 * intermediate level of grouping (e.g. an asset class within a portfolio).
+		 *
+		 * @public
+		 * @static
+		 * @return {PositionLevelType}
+		 */
 		static get OTHER() {
 			return other;
 		}

package/lib/processing/definitions/PositionTreeDefinition.js

@@ -11,7 +11,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {String} name
 	 * @param {PositionLevelDefinition[]} definitions
-	 * @oaram {String[]=} exclusionDependencies
+	 * @param {String[]=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {
@@ -44,7 +44,7 @@ module.exports = (() => {
 		 * bottom-most level of the tree (i.e. leaf nodes).
 		 *
 		 * @public
-		 * @returns {PositionLevelDefinitions>[]}
+		 * @returns {PositionLevelDefinitions[]}
 		 */
 		get definitions() {
 			return this._definitions;

package/lib/websockets/WebsocketActionType.js

@@ -0,0 +1,148 @@
+const assert = require('@barchart/common-js/lang/assert'),
+	Enum = require('@barchart/common-js/lang/Enum');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * Types of websocket response actions.
+	 *
+	 * @public
+	 * @extends {Enum}
+	 * @param {String} code
+	 * @param {String} description
+	 * @param {String} action
+	 */
+	class WebsocketActionType extends Enum {
+		constructor(code, description, action) {
+			super(code, description);
+
+			assert.argumentIsRequired(action, 'action', String);
+
+			this._action = action;
+		}
+
+		/**
+		 * An action of websocket response
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get action() {
+			return this._action;
+		}
+
+		/**
+		 * Action type for creating new portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get PORTFOLIO_CREATE() {
+			return portfolioCreate;
+		}
+
+		/**
+		 * Action type for deleting portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get PORTFOLIO_DELETE() {
+			return portfolioDelete;
+		}
+
+		/**
+		 * Action type for updating new portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get PORTFOLIO_UPDATE() {
+			return portfolioUpdate;
+		}
+
+		/**
+		 * Action type for creating new transaction.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get TRANSACTION_CREATE() {
+			return transactionCreate;
+		}
+
+		/**
+		 * Action type for deleting transaction.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get TRANSACTION_DELETE() {
+			return transactionDelete;
+		}
+
+		/**
+		 * Action type for editing transaction.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get TRANSACTION_EDIT() {
+			return transactionEdit;
+		}
+
+		/**
+		 * Action type for batching transaction.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get TRANSACTION_BATCH() {
+			return transactionBatch;
+		}
+
+		/**
+		 * Action type for deleting position.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get POSITION_DELETE() {
+			return positionDelete;
+		}
+
+		/**
+		 * Action type for updating position.
+		 *
+		 * @public
+		 * @static
+		 * @returns {WebsocketActionType}
+		 */
+		static get POSITION_UPDATE() {
+			return positionUpdate;
+		}
+	}
+
+	const portfolioCreate = new WebsocketActionType('PORTFOLIO_CREATE', 'Create portfolio action', 'portfolio/create');
+	const portfolioDelete = new WebsocketActionType('PORTFOLIO_DELETE', 'Delete portfolio action', 'portfolio/delete');
+	const portfolioUpdate = new WebsocketActionType('PORTFOLIO_UPDATE', 'Update portfolio action', 'portfolio/update');
+
+	const transactionCreate = new WebsocketActionType('TRANSACTION_CREATE', 'Create transaction action', 'transaction/create');
+	const transactionDelete = new WebsocketActionType('TRANSACTION_DELETE', 'Delete transaction action', 'transaction/delete');
+	const transactionEdit = new WebsocketActionType('TRANSACTION_EDIT', 'Edit transaction action', 'transaction/edit');
+	const transactionBatch = new WebsocketActionType('TRANSACTION_BATCH', 'Batch transaction action', 'transaction/batch');
+
+	const positionDelete = new WebsocketActionType('POSITION_DELETE', 'Delete position action', 'position/delete');
+	const positionUpdate = new WebsocketActionType('POSITION_UPDATE', 'Update position action', 'position/update');
+
+	return WebsocketActionType;
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.7",
+  "version": "1.3.11",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",