@ndustrial/contxt-sdk - npm Package Compare versions

Comparing version 0.0.31 to 0.0.32

CHANGELOG.md

@@ -0,1 +1,16 @@
+## [v0.0.32](http://github.com/ndustrialio/contxt-sdk-js/tree/v0.0.32) (2018-09-17)
+
+**Added**
+
+* Methods around Asset Metrics and Asset Metric Values. They are namespaced under `metrics` and include:
+  * AssetMetrics#create for creating an Asset Metric
+  * AssetMetrics#delete for removing an Asset Metric
+  * AssetMetrics#get for getting an Asset Metric by its ID
+  * AssetMetrics#getByAssetTypeId for getting all Asset Metrics by Asset Type
+  * AssetMetrics#update for updating an Asset Metric
+  * AssetMetrics#createValue for creating an Asset Metric Value
+  * AssetMetrics#deleteValue for deleting an Asset Metric Value
+  * AssetMetrics#getValuesByMetricId for getting Asset Metric Values by Asset Metric ID
+  * AssetMetrics#updateValue for updating an Asset Metric Value
+
 ## [v0.0.31](http://github.com/ndustrialio/contxt-sdk-js/tree/v0.0.31) (2018-09-10)
@@ -2,0 +17,0 @@

docs/README.md

@@ -8,2 +8,5 @@ ## Classes
 </dd>
+<dt><a href="./AssetMetrics.md">AssetMetrics</a></dt>
+<dd><p>Module that provides access to, and the manipulation of, information about different asset metrics</p>
+</dd>
 <dt><a href="./AssetTypes.md">AssetTypes</a></dt>
@@ -94,2 +97,8 @@ <dd><p>Module that provides access to, and the manipulation of, information about different asset types</p>
 <dd></dd>
+<dt><a href="./Typedefs.md#AssetMetric">AssetMetric</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="./Typedefs.md#AssetMetricValue">AssetMetricValue</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="./Typedefs.md#AssetMetricsFromServer">AssetMetricsFromServer</a> : <code>Object</code></dt>
+<dd></dd>
 <dt><a href="./Typedefs.md#AssetType">AssetType</a> : <code>Object</code></dt>
@@ -96,0 +105,0 @@ <dd></dd>

docs/Typedefs.md

@@ -81,2 +81,51 @@ <a name="Asset"></a>
 
+<a name="AssetMetric"></a>
+
+## AssetMetric : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| assetTypeId | <code>string</code> | UUID corresponding with the asset type |
+| createdAt | <code>string</code> | ISO 8601 Extended Format date/time string |
+| description | <code>string</code> |  |
+| id | <code>string</code> | UUID |
+| label | <code>string</code> |  |
+| organizationId | <code>string</code> | UUID corresponding with the organization |
+| timeInterval | <code>string</code> | Options are "hourly", "daily", "weekly", "monthly", "yearly" |
+| [units] | <code>string</code> |  |
+| updatedAt | <code>string</code> | ISO 8601 Extended Format date/time string |
+
+<a name="AssetMetricValue"></a>
+
+## AssetMetricValue : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| assetId | <code>string</code> | UUID corresponding to the asset |
+| assetMetricId | <code>string</code> | UUID corresponding to the asset metric |
+| createdAt | <code>string</code> | ISO 8601 Extended Format date/time string |
+| effectiveEndDate | <code>string</code> | ISO 8601 Extended Format date/time string |
+| effectiveStartDate | <code>string</code> | ISO 8601 Extended Format date/time string |
+| id | <code>string</code> | UUID |
+| notes | <code>string</code> |  |
+| updatedAt | <code>string</code> | ISO 8601 Extended Format date/time string |
+| value | <code>string</code> |  |
+
+<a name="AssetMetricsFromServer"></a>
+
+## AssetMetricsFromServer : <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;AssetMetric&gt;</code>](#AssetMetric) |  |
+
 <a name="AssetType"></a>
@@ -83,0 +132,0 @@

package.json

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

src/assets/index.js

 import isPlainObject from 'lodash.isplainobject';
 import AssetAttributes from './assetAttributes';
+import AssetMetrics from './assetMetrics';
 import AssetTypes from './assetTypes';
+
 import { toCamelCase, toSnakeCase } from '../utils/objects';
@@ -45,2 +47,3 @@ import { formatPaginatedDataFromServer } from '../utils/pagination';
     this.types = new AssetTypes(sdk, request, baseUrl);
+    this.metrics = new AssetMetrics(sdk, request, baseUrl);
   }
@@ -47,0 +50,0 @@

support/fixtures/factories/index.js

@@ -8,2 +8,4 @@ 'use strict';
 require('./assetAttributeValue');
+require('./assetMetric');
+require('./assetMetricValue');
 require('./assetType');
@@ -10,0 +12,0 @@ require('./audience');

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1511565

increased by7.98%

Number of package files

137

increased by3.79%

Lines of code

19496

increased by8.64%

No dependency changes