@barchart/portfolio-api-common 1.3.21 → 1.3.22

package/README.md

@@ -1,7 +1,30 @@
 # @barchart/portfolio-api-common
-## Barchart Portfolio API Common Components
 
-Shared code, used by the serverless application and the client-side SDK. See:
+A *private* library of shared JavaScript code pertaining to the paper-trading portfolio system.
 
-* https://github.com/barchart/aws-lambda-portfolio and
-* https://github.com/barchart/portfolio-client-js
+### Overview
+
+Simply put, this project contains code that runs on both the servers (i.e. Serverless applications) and clients (e.g. browser, mobile, etc).
+
+#### [lib/serialization](https://github.com/barchart/portfolio-api-common/tree/master/lib/serialization)
+
+Data is passed between client and server in JSON format. However, the code works with more complex types. For example, [Decimal](https://github.com/barchart/barchart-common-js/blob/master/lang/Decimal.js) instances are used in place of [native JavaScript floats](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number). [Day](https://github.com/barchart/barchart-common-js/blob/master/lang/Day.js) instances are used instead of [native JavaScript Dates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).
+
+So, before data is exchanged, it must be converted to pure JSON. Conversely, when data is received, as pure JSON, its translated into more complex types before use. This is facilitated by the [Schema](https://github.com/barchart/barchart-common-js/blob/master/serialization/json/Schema.js) definitions which build custom "reviver" functions for [JSON parsing](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
+
+#### [lib/processing](https://github.com/barchart/portfolio-api-common/tree/master/lib/processing)
+
+For reporting and display purposes, positions can be grouped together (by asset class, by portfolio, by user, etc). This code supports aggregation and gain/loss calculation. It is used by server-generated reports and dynamic user interfaces.
+
+### Notable Consumers
+
+* [aws-lambda-portfolio](https://github.com/barchart/aws-lambda-portfolio) - Serverless applications (i.e. the servers)
+* [portfolio-client-js](https://github.com/barchart/portfolio-client-js) - JavaScript client SDK for communicating with server API's.
+* [tgam-portfolio-ui-js](https://github.com/barchart/tgam-portfolio-ui-js) - A dynamic, single-page HTML UI.
+
+### Package Managers
+
+This library has been published as a *private* module to NPM as [@barchart/portfolio-api-common](https://www.npmjs.com/package/@barchart/portfolio-api-common).
+
+    > npm login
+    > npm install @barchart/portfolio-api-common -S

package/package.json

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