@ndustrial/contxt-sdk - npm Package Compare versions

Comparing version 2.11.0 to 2.11.1

CHANGELOG.md

@@ -0,1 +1,7 @@
+## [v2.11.1](http://github.com/ndustrialio/contxt-sdk-js/tree/v2.11.1) (2020-02-28)
+
+**Updated**
+
+- Updated Asset Metric Value documentation to support `isEstimated` column
+
 ## [v2.11.0](http://github.com/ndustrialio/contxt-sdk-js/tree/v2.11.0) (2020-02-24)
@@ -2,0 +8,0 @@

docs/AssetMetrics.md

@@ -226,2 +226,3 @@ <a name="AssetMetrics"></a>
 | assetMetricValue.value | <code>string</code> |  |
+| [assetMetricValue.isEstimated] | <code>boolean</code> | Whether the value is an estimation or a true reading |
 
@@ -236,3 +237,4 @@ **Example**
      notes: 'Iure delectus non sunt a voluptates pariatur fuga.',
-     value: '2000'
+     value: '2000',
+     isEstimated: true
    })
@@ -364,2 +366,3 @@ .then((newAssetMetricValue) => {
 | [update.value] | <code>string</code> |  |
+| [update.isEstimated] | <code>boolean</code> | Whether the value is an estimation or a true reading |
 
@@ -372,5 +375,6 @@ **Example**
     notes: 'Dolores et sapiente sunt doloribus aut in.',
-    value: '61456'
+    value: '61456',
+    isEstimated: true
   })
   .catch((err) => console.log(err));
 ```

docs/Typedefs.md

@@ -116,2 +116,3 @@ <a name="Asset"></a>
 | value | <code>string</code> |  |
+| isEstimated | <code>boolean</code> | Whether the value is an estimation or a true reading |
 
@@ -118,0 +119,0 @@ <a name="AssetMetricValuesFromServer"></a>

esm/assets/assetMetrics.js

@@ -42,2 +42,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; }; }();
  * @property {string} value
+ * @property {boolean} isEstimated Whether the value is an estimation or a true reading
  */
@@ -349,2 +350,3 @@
      * @param {string} assetMetricValue.value
+     * @param {boolean} [assetMetricValue.isEstimated] Whether the value is an estimation or a true reading
      *
@@ -362,3 +364,4 @@ * @returns {Promise}
      *      notes: 'Iure delectus non sunt a voluptates pariatur fuga.',
-     *      value: '2000'
+     *      value: '2000',
+     *      isEstimated: true
      *    })
@@ -549,2 +552,3 @@ *    .then((newAssetMetricValue) => {
      * @param {string} [update.value]
+     * @param {boolean} [update.isEstimated] Whether the value is an estimation or a true reading
      *
@@ -560,3 +564,4 @@ * @returns {Promise}
      *     notes: 'Dolores et sapiente sunt doloribus aut in.',
-     *     value: '61456'
+     *     value: '61456',
+     *     isEstimated: true
      *   })
@@ -563,0 +568,0 @@ *   .catch((err) => console.log(err));

lib/assets/assetMetrics.js

@@ -57,2 +57,3 @@ 'use strict';
  * @property {string} value
+ * @property {boolean} isEstimated Whether the value is an estimation or a true reading
  */
@@ -363,2 +364,3 @@
      * @param {string} assetMetricValue.value
+     * @param {boolean} [assetMetricValue.isEstimated] Whether the value is an estimation or a true reading
      *
@@ -376,3 +378,4 @@ * @returns {Promise}
      *      notes: 'Iure delectus non sunt a voluptates pariatur fuga.',
-     *      value: '2000'
+     *      value: '2000',
+     *      isEstimated: true
      *    })
@@ -563,2 +566,3 @@ *    .then((newAssetMetricValue) => {
      * @param {string} [update.value]
+     * @param {boolean} [update.isEstimated] Whether the value is an estimation or a true reading
      *
@@ -574,3 +578,4 @@ * @returns {Promise}
      *     notes: 'Dolores et sapiente sunt doloribus aut in.',
-     *     value: '61456'
+     *     value: '61456',
+     *     isEstimated: true
      *   })
@@ -577,0 +582,0 @@ *   .catch((err) => console.log(err));

package.json

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

src/assets/assetMetrics.js

@@ -38,2 +38,3 @@ import has from 'lodash.has';
  * @property {string} value
+ * @property {boolean} isEstimated Whether the value is an estimation or a true reading
  */
@@ -360,2 +361,3 @@
    * @param {string} assetMetricValue.value
+   * @param {boolean} [assetMetricValue.isEstimated] Whether the value is an estimation or a true reading
    *
@@ -373,3 +375,4 @@ * @returns {Promise}
    *      notes: 'Iure delectus non sunt a voluptates pariatur fuga.',
-   *      value: '2000'
+   *      value: '2000',
+   *      isEstimated: true
    *    })
@@ -587,2 +590,3 @@ *    .then((newAssetMetricValue) => {
    * @param {string} [update.value]
+   * @param {boolean} [update.isEstimated] Whether the value is an estimation or a true reading
    *
@@ -598,3 +602,4 @@ * @returns {Promise}
    *     notes: 'Dolores et sapiente sunt doloribus aut in.',
-   *     value: '61456'
+   *     value: '61456',
+   *     isEstimated: true
    *   })
@@ -601,0 +606,0 @@ *   .catch((err) => console.log(err));

support/fixtures/factories/assetMetricValue.js

@@ -18,3 +18,4 @@ 'use strict';
     updatedAt: () => faker.date.recent().toISOString(),
-    value: () => `${faker.random.number()}`
+    value: () => `${faker.random.number()}`,
+    isEstimated: () => faker.random.boolean()
   })
@@ -43,3 +44,6 @@ .after((assetMetricValue, options) => {
       delete assetMetricValue.updatedAt;
+
+      assetMetricValue.is_estimated = assetMetricValue.isEstimated;
+      delete assetMetricValue.isEstimated;
     }
   });

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

2892234

increased by0.09%

Lines of code

47128

increased by0.04%

No dependency changes