@ndustrial/contxt-sdk - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

docs/README.md

@@ -97,2 +97,5 @@ ## Classes
 </dd>
+<dt><a href="./Health.md">Health</a></dt>
+<dd><p>Module that provides access to the Contxt Health Service</p>
+</dd>
 <dt><a href="./Iot.md">Iot</a></dt>
@@ -267,2 +270,10 @@ <dd><p>Module that provides access to real time IOT feeds and fields.</p>
 <dd></dd>
+<dt><a href="./Typedefs.md#HealthAsset">HealthAsset</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="./Typedefs.md#HealthAssetPaginatedResponse">HealthAssetPaginatedResponse</a> : <code><a href="#HealthAsset">PaginatedResponse.&lt;HealthAsset&gt;</a></code></dt>
+<dd></dd>
+<dt><a href="./Typedefs.md#HealthStatus">HealthStatus</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="./Typedefs.md#HealthStatusPaginatedResponse">HealthStatusPaginatedResponse</a> : <code><a href="#HealthStatus">PaginatedResponse.&lt;HealthStatus&gt;</a></code></dt>
+<dd></dd>
 <dt><a href="./Typedefs.md#MachineAuthSessionInfo">MachineAuthSessionInfo</a> : <code>Object</code></dt>
@@ -278,2 +289,4 @@ <dd></dd>
 <dd></dd>
+<dt><a href="./Typedefs.md#PaginatedResponse">PaginatedResponse</a> : <code>Object</code></dt>
+<dd></dd>
 <dt><a href="./Typedefs.md#PaginationMetadata">PaginationMetadata</a> : <code>Object</code></dt>
@@ -280,0 +293,0 @@ <dd></dd>

docs/Typedefs.md

@@ -909,2 +909,32 @@ <a name="Asset"></a>
 
+<a name="HealthAsset"></a>
+
+## HealthAsset : <code>Object</code>
+**Kind**: global typedef  
+**Extends**: [<code>Asset</code>](./Typedefs.md#Asset)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| health | [<code>HealthStatus</code>](./Typedefs.md#HealthStatus) | 
+
+<a name="HealthAssetPaginatedResponse"></a>
+
+## HealthAssetPaginatedResponse : [<code>PaginatedResponse.&lt;HealthAsset&gt;</code>](#HealthAsset)
+**Kind**: global typedef  
+<a name="HealthStatus"></a>
+
+## HealthStatus : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| status | <code>string</code> | A health status of value 'healthy' or 'unhealthy' |
+| timestamp | <code>string</code> | ISO 8601 Extended Format date/time string |
+
+<a name="HealthStatusPaginatedResponse"></a>
+
+## HealthStatusPaginatedResponse : [<code>PaginatedResponse.&lt;HealthStatus&gt;</code>](#HealthStatus)
+**Kind**: global typedef  
 <a name="MachineAuthSessionInfo"></a>
@@ -989,2 +1019,15 @@
 
+<a name="PaginatedResponse"></a>
+
+## PaginatedResponse : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| _metadata | <code>Object</code> | Metadata about the pagination settings |
+| _metadata.offset | <code>number</code> | Offset of records in subsequent queries |
+| _metadata.totalRecords | <code>number</code> | Total number of asset types found |
+| records | <code>Array.&lt;RecordType&gt;</code> |  |
+
 <a name="PaginationMetadata"></a>
@@ -991,0 +1034,0 @@

esm/config/audiences.js

@@ -64,2 +64,12 @@ export default {
   },
+  health: {
+    staging: {
+      clientId: '1zQ2YXbHXotrf2dDKgySqEjlJBz465qq',
+      host: 'https://health-staging.api.ndustrial.io'
+    },
+    production: {
+      clientId: '6uaQIV1KnnWhXiTm09iGDvy2aQaz2xVI',
+      host: 'https://health.api.ndustrial.io'
+    }
+  },
   iot: {
@@ -66,0 +76,0 @@ staging: {

esm/index.js

@@ -14,2 +14,3 @@ 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; }; }();
 import Files from './files';
+import Health from './health';
 import Iot from './iot';
@@ -102,2 +103,3 @@ import Request from './request';
     this.files = new Files(this, this._createRequest('files'));
+    this.health = new Health(this, this._createRequest('health'));
     this.iot = new Iot(this, this._createRequest('iot'));
@@ -104,0 +106,0 @@

lib/config/audiences.js

@@ -69,2 +69,12 @@ 'use strict';
   },
+  health: {
+    staging: {
+      clientId: '1zQ2YXbHXotrf2dDKgySqEjlJBz465qq',
+      host: 'https://health-staging.api.ndustrial.io'
+    },
+    production: {
+      clientId: '6uaQIV1KnnWhXiTm09iGDvy2aQaz2xVI',
+      host: 'https://health.api.ndustrial.io'
+    }
+  },
   iot: {
@@ -71,0 +81,0 @@ staging: {

lib/index.js

@@ -37,2 +37,6 @@ 'use strict';
 
+var _health = require('./health');
+
+var _health2 = _interopRequireDefault(_health);
+
 var _iot = require('./iot');
@@ -140,2 +144,3 @@
     this.files = new _files2.default(this, this._createRequest('files'));
+    this.health = new _health2.default(this, this._createRequest('health'));
     this.iot = new _iot2.default(this, this._createRequest('iot'));
@@ -142,0 +147,0 @@

package.json

 {
   "name": "@ndustrial/contxt-sdk",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

src/config/audiences.js

@@ -64,2 +64,12 @@ export default {
   },
+  health: {
+    staging: {
+      clientId: '1zQ2YXbHXotrf2dDKgySqEjlJBz465qq',
+      host: 'https://health-staging.api.ndustrial.io'
+    },
+    production: {
+      clientId: '6uaQIV1KnnWhXiTm09iGDvy2aQaz2xVI',
+      host: 'https://health.api.ndustrial.io'
+    }
+  },
   iot: {
@@ -66,0 +76,0 @@ staging: {

src/index.js

@@ -8,2 +8,3 @@ import Assets from './assets';
 import Files from './files';
+import Health from './health';
 import Iot from './iot';
@@ -90,2 +91,3 @@ import Request from './request';
     this.files = new Files(this, this._createRequest('files'));
+    this.health = new Health(this, this._createRequest('health'));
     this.iot = new Iot(this, this._createRequest('iot'));
@@ -92,0 +94,0 @@

src/index.spec.js

@@ -9,2 +9,3 @@ import times from 'lodash.times';
 import Files from './files';
+import Health from './health';
 import Iot from './iot';
@@ -118,2 +119,6 @@ import Request from './request';
 
+    it('sets an instance of Health', function() {
+      expect(contxtSdk.health).to.be.an.instanceof(Health);
+    });
+
     it('creates an instance of the request module for IOT', function() {
@@ -120,0 +125,0 @@ expect(createRequest).to.be.calledWith('iot');

No alert changes

Improved metrics

Total package byte prevSize

2792590

increased by2.35%

Number of package files

403

increased by2.03%

Lines of code

45607

increased by2.31%

No dependency changes