@barchart/portfolio-client-js 1.1.27 → 1.1.30

package/example/example.html

@@ -158,7 +158,7 @@
 			var readPositionSummaries = function() {
 				var action = 'portfolioGateway.readPositionSummaries()';
 
-				that.gateway.readPositionSummaries(that.portfolio() || null, that.position() || null, 'YEARLY', 2)
+				that.gateway.readPositionSummaries(that.portfolio() || null, that.position() || null, [ 'YEARLY', 'YTD' ], 1)
 					.then((data) => {
 						writeConsoleText(action, true);
 						writeConsoleObject(data);

package/example/example.js

@@ -81,6 +81,20 @@ module.exports = function () {
 				return 'g4zerhpif5.execute-api.us-east-1.amazonaws.com/dev';
 			}
 
+			/**
+    * The host of the staging system.
+    *
+    * @public
+    * @static
+    * @returns {String}
+    */
+
+		}, {
+			key: 'stagingHost',
+			get: function get() {
+				return 'g4zerhpif5.execute-api.us-east-1.amazonaws.com/dev';
+			}
+
 			/**
     * The host of the production system.
     *
@@ -114,6 +128,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
 var assert = require('@barchart/common-js/lang/assert'),
+    Day = require('@barchart/common-js/lang/Day'),
     Disposable = require('@barchart/common-js/lang/Disposable'),
     Enum = require('@barchart/common-js/lang/Enum'),
     is = require('@barchart/common-js/lang/is');
@@ -148,6 +163,7 @@ module.exports = function () {
   * @param {String} protocol - The protocol to use (either HTTP or HTTPS).
   * @param {String} host - The host name of the Portfolio web service.
   * @param {Number} port - The TCP port number of the Portfolio web service.
+  * @param {String} environment - A description of the environment we're connecting to.
   * @param {RequestInterceptor=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
   * @extends {Disposable}
   */
@@ -155,7 +171,7 @@ module.exports = function () {
 	var PortfolioGateway = function (_Disposable) {
 		_inherits(PortfolioGateway, _Disposable);
 
-		function PortfolioGateway(protocol, host, port, requestInterceptor) {
+		function PortfolioGateway(protocol, host, port, environment, requestInterceptor) {
 			_classCallCheck(this, PortfolioGateway);
 
 			var _this = _possibleConstructorReturn(this, (PortfolioGateway.__proto__ || Object.getPrototypeOf(PortfolioGateway)).call(this));
@@ -163,6 +179,8 @@ module.exports = function () {
 			_this._started = false;
 			_this._startPromise = null;
 
+			_this._environment = environment;
+
 			var protocolType = Enum.fromCode(ProtocolType, protocol.toUpperCase());
 
 			var requestInterceptorToUse = void 0;
@@ -198,7 +216,13 @@ module.exports = function () {
 			_this._readPositionSummariesEndpoint = EndpointBuilder.for('read-position-summaries', 'read position summaries').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
 				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('summaries', 'summaries').withVariableParameter('position', 'position', 'position', false);
 			}).withQueryBuilder(function (qb) {
-				qb.withVariableParameter('frame', 'frame', 'frame', true).withVariableParameter('periods', 'periods', 'periods', true);
+				qb.withVariableParameter('frames', 'frames', 'frames', true, function (frames) {
+					return frames.map(function (f) {
+						return f.code;
+					}).join();
+				}).withVariableParameter('periods', 'periods', 'periods', true).withVariableParameter('start', 'start', 'start', true, function (s) {
+					return s.format();
+				});
 			}).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForPositionSummaryDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readTransactionsEndpoint = EndpointBuilder.for('read-transactions', 'read transactions').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
@@ -226,16 +250,24 @@ module.exports = function () {
 		}
 
 		/**
-   * Initializes the connection to the remote server and returns a promise
-   * containing the current instance.
+   * Returns a description of the environment (e.g. development or production).
    *
    * @public
-   * @returns {Promise.<PortfolioGateway>}
+   * @return {*}
    */
 
 
 		_createClass(PortfolioGateway, [{
 			key: 'start',
+
+
+			/**
+    * Initializes the connection to the remote server and returns a promise
+    * containing the current instance.
+    *
+    * @public
+    * @returns {Promise.<PortfolioGateway>}
+    */
 			value: function start() {
 				var _this2 = this;
 
@@ -376,14 +408,15 @@ module.exports = function () {
     * @public
     * @param {String=} portfolio
     * @param {String=} position
-    * @param {PositionSummaryFrame=|String=} frame
+    * @param {Array.<PositionSummaryFrame>=|Array.<String>=} frames
     * @param {Number=} periods
+    * @param {Day=|String=} start
     * @returns {Promise.<Position[]>}
     */
 
 		}, {
 			key: 'readPositionSummaries',
-			value: function readPositionSummaries(portfolio, position, frame, periods) {
+			value: function readPositionSummaries(portfolio, position, frames, periods, start) {
 				var _this8 = this;
 
 				return Promise.resolve().then(function () {
@@ -392,29 +425,54 @@ module.exports = function () {
 					assert.argumentIsOptional(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
 
-					if (!is.string(frame)) {
-						assert.argumentIsOptional(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
+					if (is.array(frames)) {
+						if (frames.length > 0 && is.string(frames[0])) {
+							assert.argumentIsArray(frames, 'frames', String);
+						} else {
+							assert.argumentIsArray(frames, 'frames', PositionSummaryFrame, 'PositionSummaryFrame');
+						}
+					} else {
+						if (is.string(frames)) {
+							assert.argumentIsOptional(frames, 'frames', String);
+						} else {
+							assert.argumentIsOptional(frames, 'frames', PositionSummaryFrame, 'PositionSummaryFrame');
+						}
 					}
 
 					assert.argumentIsOptional(periods, 'periods', Number);
+					assert.argumentIsOptional(start, 'start', Day);
 
 					var query = {
 						portfolio: portfolio || '*',
 						position: position || '*'
 					};
 
-					if (frame) {
-						if (is.string(frame)) {
-							query.frame = frame;
-						} else {
-							query.frame = frame.code;
-						}
+					if (frames) {
+						query.frames = frames.map(function (frame) {
+							if (is.string(frame)) {
+								return Enum.fromCode(PositionSummaryFrame, frame);
+							} else {
+								return frame;
+							}
+						});
 					}
 
 					if (periods) {
 						query.periods = periods;
 					}
 
+					if (start) {
+						var s = void 0;
+
+						if (is.string(start)) {
+							s = Day.parse(start);
+						} else {
+							s = start;
+						}
+
+						query.start = s;
+					}
+
 					return Gateway.invoke(_this8._readPositionSummariesEndpoint, query);
 				});
 			}
@@ -568,6 +626,11 @@ module.exports = function () {
 			value: function toString() {
 				return '[PortfolioGateway]';
 			}
+		}, {
+			key: 'environment',
+			get: function get() {
+				return this._environment;
+			}
 		}], [{
 			key: 'forLocal',
 			value: function forLocal(requestInterceptor) {
@@ -593,7 +656,26 @@ module.exports = function () {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
+				});
+			}
+
+			/**
+    * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
+    *
+    * @public
+    * @static
+    * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+    * @returns {Promise.<PortfolioGateway>}
+    */
+
+		}, {
+			key: 'forStaging',
+			value: function forStaging(requestInterceptor) {
+				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
+					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'production', 'RequestInterceptor');
+
+					return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
 				});
 			}
 
@@ -612,7 +694,7 @@ module.exports = function () {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.productionHost, 443, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
 				});
 			}
 		}]);
@@ -691,7 +773,7 @@ module.exports = function () {
 	return PortfolioGateway;
 }();
 
-},{"./../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/ErrorInterceptor":20,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/portfolio-api-common/lib/data/PositionSummaryFrame":52,"@barchart/portfolio-api-common/lib/data/TransactionType":53,"@barchart/portfolio-api-common/lib/serialization/PortfolioSchema":55,"@barchart/portfolio-api-common/lib/serialization/PositionSchema":56,"@barchart/portfolio-api-common/lib/serialization/PositionSummarySchema":57,"@barchart/portfolio-api-common/lib/serialization/TransactionSchema":58}],4:[function(require,module,exports){
+},{"./../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/ErrorInterceptor":20,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Day":29,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/portfolio-api-common/lib/data/PositionSummaryFrame":52,"@barchart/portfolio-api-common/lib/data/TransactionType":53,"@barchart/portfolio-api-common/lib/serialization/PortfolioSchema":55,"@barchart/portfolio-api-common/lib/serialization/PositionSchema":56,"@barchart/portfolio-api-common/lib/serialization/PositionSummarySchema":57,"@barchart/portfolio-api-common/lib/serialization/TransactionSchema":58}],4:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -1004,7 +1086,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.1.27'
+		version: '1.1.30'
 	};
 }();
 
@@ -5471,9 +5553,9 @@ module.exports = function () {
 				assert.argumentIsRequired(a, 'a', Decimal, 'Decimal');
 				assert.argumentIsRequired(b, 'b', Decimal, 'Decimal');
 
-				if (a._big.gt(b)) {
+				if (a._big.gt(b._big)) {
 					return 1;
-				} else if (a._big.lt(b)) {
+				} else if (a._big.lt(b._big)) {
 					return -1;
 				} else {
 					return 0;
@@ -9059,15 +9141,27 @@ module.exports = (() => {
 	 * @param {String} alternateDescription
 	 * @param {String} code
 	 * @param {Boolean} canReinvest
+	 * @param {Boolean} usesSymbols
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest) {
+		constructor(code, description, alternateDescription, canReinvest, usesSymbols) {
 			super(code, description);
 
+			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
+			assert.argumentIsRequired(canReinvest, 'canReinvest', Boolean);
+			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
+
 			this._alternateDescription = alternateDescription;
 			this._canReinvest = canReinvest;
+			this._usesSymbols = usesSymbols;
 		}
 
+		/**
+		 * A human-readable description.
+		 *
+		 * @public
+		 * @return {String}
+		 */
 		get alternateDescription() {
 			return this._alternateDescription;
 		}
@@ -9075,16 +9169,28 @@ module.exports = (() => {
 		/**
 		 * Indicates if the instrument type allows automatic reinvestment.
 		 *
+		 * @public
 		 * @returns {Boolean}
 		 */
 		get canReinvest() {
 			return this._canReinvest;
 		}
 
+		/**
+		 * Indicates if an instrument of this type can be represented by a symbol.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get usesSymbols() {
+			return this._usesSymbols;
+		}
+
 		/**
 		 * Cash.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get CASH() {
@@ -9095,6 +9201,7 @@ module.exports = (() => {
 		 * An equity issue.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get EQUITY() {
@@ -9105,6 +9212,7 @@ module.exports = (() => {
 		 * A mutual fund.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get FUND() {
@@ -9115,6 +9223,7 @@ module.exports = (() => {
 		 * An undefined asset (e.g. a house, or a collectible, or a salvaged alien spaceship).
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get OTHER() {
@@ -9126,10 +9235,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, true);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false);
 
 	return InstrumentType;
 })();
@@ -9138,6 +9247,7 @@ module.exports = (() => {
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -9153,23 +9263,68 @@ module.exports = (() => {
 	 * @param {String} description
 	 * @param {Function} rangeCalculator
 	 * @param {Function} startDateCalculator
+	 * @param {Function} descriptionCalculator
 	 */
 	class PositionSummaryFrame extends Enum {
-		constructor(code, description, rangeCalculator, startDateCalculator) {
+		constructor(code, description, rangeCalculator, startDateCalculator, descriptionCalculator) {
 			super(code, description);
 
 			assert.argumentIsRequired(rangeCalculator, 'rangeCalculator', Function);
+			assert.argumentIsRequired(startDateCalculator, 'startDateCalculator', Function);
+			assert.argumentIsRequired(descriptionCalculator, 'descriptionCalculator', Function);
 
 			this._rangeCalculator = rangeCalculator;
 			this._startDateCalculator = startDateCalculator;
+			this._descriptionCalculator = descriptionCalculator;
 		}
 
+		/**
+		 * Returns a human-readable description of the frame, given
+		 * start and end dates.
+		 *
+		 * @public
+		 * @param {Day} startDate
+		 * @param {Day} endDate
+		 * @return {String}
+		 */
+		describeRange(startDate, endDate) {
+			return this._descriptionCalculator(startDate, endDate);
+		}
+
+		/**
+		 * Returns the most recent ranges for the frame.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
+		getRecentRanges(periods) {
+			const startDate = this.getStartDate(periods);
+			const transaction = { date: startDate, snapshot: { open: Decimal.ONE } };
+
+			return this.getRanges([ transaction ]);
+		}
+
+		/**
+		 * Returns the ranges for the set of {@link Transaction} objects.
+		 *
+		 * @public
+		 * @param {Array.<Transaction>} transactions
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
 		getRanges(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the start date for a frame, a given number of periods ago.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Day}
+		 */
 		getStartDate(periods) {
 			assert.argumentIsRequired(periods, 'periods', Number);
 
@@ -9221,10 +9376,19 @@ module.exports = (() => {
 		}
 	}
 
-	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate);
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate);
-	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate);
-	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate);
+	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate, getYearlyRangeDescription);
+	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate, getQuarterlyRangeDescription);
+	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate, getMonthlyRangeDescription);
+	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate, getYearToDateRangeDescription);
+
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame}
+	 *
+	 * @typedef PositionSummaryRange
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 */
 
 	function getRange(start, end) {
 		return {
@@ -9308,6 +9472,22 @@ module.exports = (() => {
 		return null;
 	}
 
+	function getYearlyRangeDescription(startDate, endDate) {
+		return endDate.year.toString();
+	}
+
+	function getQuarterlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getMonthlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getYearToDateRangeDescription(startDate, endDate) {
+		return `${endDate.year.toString()} YTD`;
+	}
+
 	function getFilteredTransactions(transactions) {
 		return transactions.reduce((filtered, transaction) => {
 			if (!transaction.snapshot.open.getIsZero() || transaction.type.closing) {
@@ -9321,7 +9501,7 @@ module.exports = (() => {
 	return PositionSummaryFrame;
 })();
 
-},{"@barchart/common-js/lang/Day":29,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/array":36,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40}],53:[function(require,module,exports){
+},{"@barchart/common-js/lang/Day":29,"@barchart/common-js/lang/Decimal":30,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/array":36,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40}],53:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum');
 
@@ -9335,6 +9515,7 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
+	 * @param {String} display
 	 * @param {Boolean} purchase
 	 * @param {Boolean} sale
 	 * @param {Boolean} income
@@ -9342,15 +9523,17 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing) {
 			super(code, description);
 
+			assert.argumentIsRequired(display, 'display', String);
 			assert.argumentIsRequired(purchase, 'purchase', Boolean);
 			assert.argumentIsRequired(sale, 'sale', Boolean);
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
 
+			this._display = display;
 			this._purchase = purchase;
 			this._sale = sale;
 			this._income = income;
@@ -9358,6 +9541,16 @@ module.exports = (() => {
 			this._closing = closing;
 		}
 
+		/**
+		 * A human-readable description of the transaction type.
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get display() {
+			return this._display;
+		}
+
 		/**
 		 * Indicates if the transaction was a trade.
 		 *
@@ -9623,27 +9816,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short',  false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee', false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
 
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
 
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, true, false);
 
-	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', false, false, true, false, false);
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
 
 	return TransactionType;
 })();
@@ -9868,6 +10061,7 @@ module.exports = (() => {
 	);
 
 	const update = new PortfolioSchema(SchemaBuilder.withName('update')
+		.withField('portfolio', DataType.STRING)
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'), true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'), true)
@@ -10143,7 +10337,8 @@ const assert = require('@barchart/common-js/lang/assert'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
 
-const TransactionType = require('./../data/TransactionType');
+const InstrumentType = require('./../data/InstrumentType'),
+	TransactionType = require('./../data/TransactionType');
 
 module.exports = (() => {
 	'use strict';
@@ -10295,7 +10490,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[TransactionSchema]';
+			return `[TransactionSchema (code=${this.code})]`;
 		}
 	}
 
@@ -10381,12 +10576,11 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('instrument.name', DataType.STRING, true)
-		.withField('instrument.type', DataType.STRING, true)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.name', DataType.STRING)
+		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('instrument.symbol.barchart', DataType.STRING, true)
 		.withField('instrument.symbol.display', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -10409,9 +10603,9 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('instrument.name', DataType.STRING, true)
-		.withField('instrument.type', DataType.STRING, true)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.name', DataType.STRING)
+		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('instrument.symbol.barchart', DataType.STRING, true)
 		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
@@ -10525,11 +10719,8 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('instrument.name', DataType.STRING, true)
-		.withField('instrument.type', DataType.STRING, true)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
+		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
@@ -10610,7 +10801,7 @@ module.exports = (() => {
 	return TransactionSchema;
 })();
 
-},{"./../data/TransactionType":53,"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/common-js/serialization/json/DataType":45,"@barchart/common-js/serialization/json/Schema":47,"@barchart/common-js/serialization/json/builders/SchemaBuilder":49}],59:[function(require,module,exports){
+},{"./../data/InstrumentType":51,"./../data/TransactionType":53,"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/common-js/serialization/json/DataType":45,"@barchart/common-js/serialization/json/Schema":47,"@barchart/common-js/serialization/json/builders/SchemaBuilder":49}],59:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

package/lib/common/Configuration.js

@@ -33,6 +33,18 @@ module.exports = (() => {
 			return 'g4zerhpif5.execute-api.us-east-1.amazonaws.com/dev';
 		}
 
+
+		/**
+		 * The host of the staging system.
+		 *
+		 * @public
+		 * @static
+		 * @returns {String}
+		 */
+		static get stagingHost() {
+			return 'g4zerhpif5.execute-api.us-east-1.amazonaws.com/dev';
+		}
+
 		/**
 		 * The host of the production system.
 		 *

package/lib/gateway/PortfolioGateway.js

@@ -1,4 +1,5 @@
 const assert = require('@barchart/common-js/lang/assert'),
+	Day = require('@barchart/common-js/lang/Day'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	is = require('@barchart/common-js/lang/is');
@@ -33,16 +34,19 @@ module.exports = (() => {
 	 * @param {String} protocol - The protocol to use (either HTTP or HTTPS).
 	 * @param {String} host - The host name of the Portfolio web service.
 	 * @param {Number} port - The TCP port number of the Portfolio web service.
+	 * @param {String} environment - A description of the environment we're connecting to.
 	 * @param {RequestInterceptor=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
 	 * @extends {Disposable}
 	 */
 	class PortfolioGateway extends Disposable {
-		constructor(protocol, host, port, requestInterceptor) {
+		constructor(protocol, host, port, environment, requestInterceptor) {
 			super();
 
 			this._started = false;
 			this._startPromise = null;
 
+			this._environment = environment;
+
 			const protocolType = Enum.fromCode(ProtocolType, protocol.toUpperCase());
 
 			let requestInterceptorToUse;
@@ -146,8 +150,9 @@ module.exports = (() => {
 						.withVariableParameter('position', 'position', 'position',  false);
 				})
 				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('frame', 'frame', 'frame', true)
-						.withVariableParameter('periods', 'periods', 'periods', true);
+					qb.withVariableParameter('frames', 'frames', 'frames', true, frames => frames.map(f => f.code).join())
+						.withVariableParameter('periods', 'periods', 'periods', true)
+						.withVariableParameter('start', 'start', 'start', true, s => s.format());
 				})
 				.withRequestInterceptor(requestInterceptorToUse)
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -189,7 +194,7 @@ module.exports = (() => {
 						.withLiteralParameter('transactions', 'transactions');
 				})
 				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('type', 'type', 'type', false, (i) => i.code);
+					qb.withVariableParameter('type', 'type', 'type', false, i => i.code);
 				})
 				.withBody('portfolio data')
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -234,6 +239,16 @@ module.exports = (() => {
 				.endpoint;
 		}
 
+		/**
+		 * Returns a description of the environment (e.g. development or production).
+		 *
+		 * @public
+		 * @return {*}
+		 */
+		get environment() {
+			return this._environment;
+		}
+
 		/**
 		 * Initializes the connection to the remote server and returns a promise
 		 * containing the current instance.
@@ -361,11 +376,12 @@ module.exports = (() => {
 		 * @public
 		 * @param {String=} portfolio
 		 * @param {String=} position
-		 * @param {PositionSummaryFrame=|String=} frame
+		 * @param {Array.<PositionSummaryFrame>=|Array.<String>=} frames
 		 * @param {Number=} periods
+		 * @param {Day=|String=} start
 		 * @returns {Promise.<Position[]>}
 		 */
-		readPositionSummaries(portfolio, position, frame, periods) {
+		readPositionSummaries(portfolio, position, frames, periods, start) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
@@ -373,29 +389,54 @@ module.exports = (() => {
 					assert.argumentIsOptional(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
 
-					if (!is.string(frame)) {
-						assert.argumentIsOptional(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
+					if (is.array(frames)) {
+						if (frames.length > 0 && is.string(frames[ 0 ])) {
+							assert.argumentIsArray(frames, 'frames', String);
+						} else {
+							assert.argumentIsArray(frames, 'frames', PositionSummaryFrame, 'PositionSummaryFrame');
+						}
+					} else {
+						if (is.string(frames)) {
+							assert.argumentIsOptional(frames, 'frames', String);
+						} else {
+							assert.argumentIsOptional(frames, 'frames', PositionSummaryFrame, 'PositionSummaryFrame');
+						}
 					}
 
 					assert.argumentIsOptional(periods, 'periods', Number);
+					assert.argumentIsOptional(start, 'start', Day);
 
 					const query = {
 						portfolio: portfolio || '*',
 						position: position || '*'
 					};
 
-					if (frame) {
-						if (is.string(frame)) {
-							query.frame = frame;
-						} else {
-							query.frame = frame.code;
-						}
+					if (frames) {
+						query.frames = frames.map((frame) => {
+							if (is.string(frame)) {
+								return Enum.fromCode(PositionSummaryFrame, frame);
+							} else {
+								return frame;
+							}
+						});
 					}
 
 					if (periods) {
 						query.periods = periods;
 					}
 
+					if (start) {
+						let s;
+
+						if (is.string(start)) {
+							s = Day.parse(start);
+						} else {
+							s = start;
+						}
+
+						query.start = s;
+					}
+
 					return Gateway.invoke(this._readPositionSummariesEndpoint, query);
 				});
 		}
@@ -542,10 +583,27 @@ module.exports = (() => {
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
 				});
 		}
 
+		/**
+		 * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
+		 *
+		 * @public
+		 * @static
+		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+		 * @returns {Promise.<PortfolioGateway>}
+		 */
+		static forStaging(requestInterceptor) {
+			return Promise.resolve(requestInterceptor)
+			.then((requestInterceptor) => {
+				assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'production', 'RequestInterceptor');
+
+				return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
+			});
+		}
+
 		/**
 		 * Creates and starts a new {@link PortfolioGateway} for use in the production environment.
 		 *
@@ -559,7 +617,7 @@ module.exports = (() => {
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.productionHost, 443, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
 				});
 		}
 

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.1.27'
+		version: '1.1.30'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "1.1.27",
+  "version": "1.1.30",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",