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

Comparing version 1.3.17 to 1.4.1

gulpfile.js

 const gulp = require('gulp');
 
 const bump = require('gulp-bump'),
-	exec = require('child_process').exec,
 	git = require('gulp-git'),
@@ -32,11 +31,2 @@ gitStatus = require('git-get-status'),
 
-gulp.task('document', (cb) => {
-	exec('jsdoc . -c jsdoc.json -r -d docs', (error, stdout, stderr) => {
-		console.log(stdout);
-		console.log(stderr);
-
-		cb();
-	});
-});
-
 gulp.task('commit-changes', () => {
@@ -73,3 +63,2 @@ return gulp.src([ './', './package.json' ])
 	'ensure-clean-working-directory',
-	'document',
 	'bump-version',
@@ -82,5 +71,6 @@ 'commit-changes',
 gulp.task('lint', () => {
-	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./test/dist/**', '!./docs/**' ])
+	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./test/dist/**' ])
 		.pipe(jshint({'esversion': 6}))
-		.pipe(jshint.reporter('default'));
+		.pipe(jshint.reporter('default'))
+		.pipe(jshint.reporter('fail'));
 });
@@ -87,0 +77,0 @@

package.json

 {
   "name": "@barchart/events-api-common",
-  "version": "1.3.17",
-  "description": "Common classes used by the Event system",
+  "version": "1.4.1",
+  "description": "Common classes used by the Barchart Event Tracking System",
   "author": {
@@ -16,4 +16,4 @@ "name": "Bryan Ingle",
   "dependencies": {
-    "@barchart/common-js": "~3.3.0",
-    "uuid": "3.1.0"
+    "@barchart/common-js": "^3.5.1",
+    "uuid": "^3.4.0"
   },
@@ -27,3 +27,2 @@ "devDependencies": {
     "gulp-jshint": "~2.1.0",
-    "jsdoc": "^3.5.5",
     "jshint": "2.9.5"
@@ -30,0 +29,0 @@ },

README.md

 # @barchart/events-api-common
-## Barchart Event API Common Components
 
-A supporting library for the Barchart Event Tracking System. It is unlikely that you'll want to reference this library directly.
+[![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoicXh1c2JCQUxUczU5YTZrUnN0QVNTaTl0VDlQSElobFh4QS9ua2FJZnkvZW1kL0RXVzlub1FqM0d5M3ovNjNydUROTUpzK3FtT0pWSTBRZzFYTk83THBBPSIsIml2UGFyYW1ldGVyU3BlYyI6IkYzL1pjVmlYakp6SEN6VTMiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)](https://github.com/barchart/events-api-common)
 
-If you are looking for the JavaScript SDK for the system, here is the link:
+A *private* library of shared JavaScript code used by the [Barchart Event Tracking System](https://github.com/barchart/aws-lambda-events) and client SDK.
 
-> https://www.npmjs.com/package/@barchart/events-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/data/serialization](https://github.com/barchart/events-api-common/tree/master/lib/data/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) and [```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).
+
+### Notable Consumers
+
+* [@barchart/aws-lambda-events](https://github.com/barchart/aws-lambda-events) - Serverless applications (i.e. the backend)
+* [@barchart/events-client-js](https://github.com/barchart/events-client-js) - JavaScript SDK for communicating with the backend.
+
+### Package Managers
+
+This library has been published as a *private* module to NPM as [@barchart/events-api-common](https://www.npmjs.com/package/@barchart/events-api-common).
+
+```shell
+npm login
+npm install @barchart/events-api-common -S
+```
+

Fixed alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28792

increased by12.6%

Dev dependency count

7

decreased by-12.5%

Number of package files

13

increased by8.33%

Number of lines in readme file

31

increased by287.5%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

687

decreased by-2.14%

Dependency changes

• + Added@barchart/common-js@3.29.0(transitive)

• + Addedaxios@0.21.4(transitive)

• + Addedbig.js@5.2.2(transitive)

• + Addedfollow-redirects@1.15.6(transitive)

• + Addeduuid@3.4.0(transitive)

• - Removed@barchart/common-js@3.3.114(transitive)

• - Removedaxios@0.19.0(transitive)

• - Removedbig.js@5.0.3(transitive)

• - Removedfollow-redirects@1.5.10(transitive)

• - Removedis-buffer@2.0.5(transitive)

• - Removeduuid@3.1.0(transitive)

• Updated@barchart/common-js@^3.5.1

• Updateduuid@^3.4.0