@hello.nrfcloud.com/proto-map 5.6.2 → 6.0.0

package/dist/senml/lwm2mToSenML.spec.js

@@ -1,46 +1,46 @@
-import { it, describe } from "node:test";
-import { LwM2MObjectID } from "../lwm2m/LwM2MObjectID.js";
-import assert from "node:assert/strict";
-import { lwm2mToSenML } from "./lwm2mToSenML.js";
-void describe("lwm2mToSenML()", function() {
-    void it("should convert LwM2M to SenML", function() {
+import { it, describe } from 'node:test';
+import { LwM2MObjectID } from '../lwm2m/LwM2MObjectID.js';
+import assert from 'node:assert/strict';
+import { lwm2mToSenML } from './lwm2mToSenML.js';
+void describe('lwm2mToSenML()', function() {
+    void it('should convert LwM2M to SenML', function() {
         var location = {
             ObjectID: LwM2MObjectID.Geolocation_14201,
-            ObjectVersion: "1.0",
+            ObjectVersion: '1.0',
             Resources: {
-                "0": 62.469414,
-                "1": 6.151946,
-                "6": "Fixed",
-                "3": 1,
-                "99": new Date(1710147413003)
+                '0': 62.469414,
+                '1': 6.151946,
+                '6': 'Fixed',
+                '3': 1,
+                '99': new Date(1710147413003)
             }
         };
         var level1 = {
             ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
-            ObjectVersion: "1.0",
+            ObjectVersion: '1.0',
             Resources: {
-                "0": 84.3,
-                "1": "AES",
-                "99": new Date(1710140400000)
+                '0': 84.3,
+                '1': 'AES',
+                '99': new Date(1710140400000)
             }
         };
         var level2 = {
             ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
-            ObjectVersion: "1.0",
+            ObjectVersion: '1.0',
             Resources: {
-                "0": 140.4,
-                "1": "AES",
-                "99": new Date(1710144000000)
+                '0': 140.4,
+                '1': 'AES',
+                '99': new Date(1710144000000)
             }
         };
         var level3 = {
             ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
-            ObjectVersion: "1.0",
+            ObjectVersion: '1.0',
             ObjectInstanceID: 1,
             Resources: {
-                "0": 140.7,
-                "1": "AES",
-                "99": new Date(1710144001000)
+                '0': 140.7,
+                '1': 'AES',
+                '99': new Date(1710144001000)
             }
         };
         var lwm2m = [
@@ -51,52 +51,52 @@ void describe("lwm2mToSenML()", function() {
         ];
         var expected = [
             {
-                bn: "14201/0/",
-                n: "0",
+                bn: '14201/0/',
+                n: '0',
                 v: 62.469414,
                 bt: 1710147413003
             },
             {
-                n: "1",
+                n: '1',
                 v: 6.151946
             },
             {
-                n: "3",
+                n: '3',
                 v: 1
             },
             {
-                n: "6",
-                vs: "Fixed"
+                n: '6',
+                vs: 'Fixed'
             },
             {
-                bn: "14230/0/",
-                n: "0",
+                bn: '14230/0/',
+                n: '0',
                 v: 84.3,
                 bt: 1710140400000
             },
             {
-                n: "1",
-                vs: "AES"
+                n: '1',
+                vs: 'AES'
             },
             {
-                bn: "14230/0/",
-                n: "0",
+                bn: '14230/0/',
+                n: '0',
                 v: 140.4,
                 bt: 1710144000000
             },
             {
-                n: "1",
-                vs: "AES"
+                n: '1',
+                vs: 'AES'
             },
             {
-                bn: "14230/1/",
-                n: "0",
+                bn: '14230/1/',
+                n: '0',
                 v: 140.7,
                 bt: 1710144001000
             },
             {
-                n: "1",
-                vs: "AES"
+                n: '1',
+                vs: 'AES'
             }
         ];
         assert.deepEqual(lwm2mToSenML(lwm2m), expected);

package/dist/senml/parseResourceId.js

@@ -46,7 +46,7 @@ function _unsupported_iterable_to_array(o, minLen) {
 }
 export var parseResourceId = function(resourceId) {
     if (!/^\d+\/\d+\/\d+\/\d+$/.test(resourceId)) return null;
-    var _resourceId_split_map = _sliced_to_array(resourceId.split("/").map(function(s) {
+    var _resourceId_split_map = _sliced_to_array(resourceId.split('/').map(function(s) {
         return parseInt(s, 10);
     }), 4), ObjectID = _resourceId_split_map[0], ObjectInstanceID = _resourceId_split_map[1], ResourceID = _resourceId_split_map[2], ResourceInstanceId = _resourceId_split_map[3];
     return {

package/dist/senml/parseResourceId.spec.js

@@ -1,9 +1,9 @@
-import assert from "node:assert";
-import { describe, it } from "node:test";
-import { parseResourceId } from "./parseResourceId.js";
-void describe("parseResourceId()", function() {
-    void it("should parse an LwM2M resource ID", function() {
-        return assert.deepEqual(parseResourceId("14201/1/2/0"), {
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { parseResourceId } from './parseResourceId.js';
+void describe('parseResourceId()', function() {
+    void it('should parse an LwM2M resource ID', function() {
+        return assert.deepEqual(parseResourceId('14201/1/2/0'), {
             ObjectID: 14201,
             ObjectInstanceID: 1,
             ResourceID: 2,

package/dist/senml/senMLtoLwM2M.js

@@ -50,9 +50,9 @@ function _object_spread_props(target, source) {
     }
     return target;
 }
-import { timestampResources } from "../lwm2m/timestampResources.js";
-import { parseResourceId } from "./parseResourceId.js";
-import { hasValue } from "./hasValue.js";
+import { timestampResources } from '../lwm2m/timestampResources.js';
+import { parseResourceId } from './parseResourceId.js';
+import { hasValue } from './hasValue.js';
 var isInfoForDifferentInstance = function(currentObject, resourceID, currentBaseTime) {
     var _currentObject_Resources_tsRes, _currentObject_Resources;
     if (currentObject === undefined) return true;
@@ -65,16 +65,16 @@ var isInfoForDifferentInstance = function(currentObject, resourceID, currentBase
     return false;
 };
 var getValue = function(measurement) {
-    if ("bv" in measurement && !("v" in measurement)) return measurement.bv;
-    if ("bv" in measurement && "v" in measurement) return measurement.bv + measurement.v;
-    if ("v" in measurement) return measurement.v;
-    if ("vs" in measurement) return measurement.vs;
-    if ("vb" in measurement) return measurement.vb;
-    if ("vd" in measurement) return measurement.vd;
+    if ('bv' in measurement && !('v' in measurement)) return measurement.bv;
+    if ('bv' in measurement && 'v' in measurement) return measurement.bv + measurement.v;
+    if ('v' in measurement) return measurement.v;
+    if ('vs' in measurement) return measurement.vs;
+    if ('vb' in measurement) return measurement.vb;
+    if ('vd' in measurement) return measurement.vd;
     return undefined;
 };
 export var senMLtoLwM2M = function(senML) {
-    var currentBaseName = "";
+    var currentBaseName = '';
     var currentBaseTime = undefined;
     var currentObject = undefined;
     var items = [];
@@ -82,11 +82,11 @@ export var senMLtoLwM2M = function(senML) {
     try {
         for(var _iterator = senML[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
             var item = _step.value;
-            if ("bn" in item && item.bn !== undefined) currentBaseName = item.bn;
-            if ("bt" in item && item.bt !== undefined) currentBaseTime = item.bt;
+            if ('bn' in item && item.bn !== undefined) currentBaseName = item.bn;
+            if ('bt' in item && item.bt !== undefined) currentBaseTime = item.bt;
             if (!hasValue(item)) continue;
             var _item_n;
-            var itemResourceId = "".concat(currentBaseName).concat((_item_n = item.n) !== null && _item_n !== void 0 ? _item_n : "", "/0");
+            var itemResourceId = "".concat(currentBaseName).concat((_item_n = item.n) !== null && _item_n !== void 0 ? _item_n : '', "/0");
             var resourceId = parseResourceId(itemResourceId);
             if (resourceId === null) throw new Error("Invalid resource ID: ".concat(itemResourceId));
             if (currentObject === undefined || currentBaseTime !== undefined && isInfoForDifferentInstance(currentObject, resourceId, currentBaseTime)) {
@@ -99,7 +99,7 @@ export var senMLtoLwM2M = function(senML) {
                     Resources: _define_property({}, tsRes, new Date(currentBaseTime))
                 };
                 if (resourceId.ObjectInstanceID !== 0) currentObject.ObjectInstanceID = resourceId.ObjectInstanceID;
-                if ("blv" in item) currentObject.ObjectVersion = item.blv;
+                if ('blv' in item) currentObject.ObjectVersion = item.blv;
             }
             if ((currentObject === null || currentObject === void 0 ? void 0 : currentObject.Resources) === undefined) continue;
             var value = getValue(item);

package/dist/senml/senMLtoLwM2M.spec.js

@@ -1,34 +1,34 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { senMLtoLwM2M } from "./senMLtoLwM2M.js";
-void describe("senMLtoLwM2M()", function() {
-    void it("should resolve a senML message into objects", function() {
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import { senMLtoLwM2M } from './senMLtoLwM2M.js';
+void describe('senMLtoLwM2M()', function() {
+    void it('should resolve a senML message into objects', function() {
         var input = [
             {
-                bn: "14201/1/",
-                blv: "1.1",
+                bn: '14201/1/',
+                blv: '1.1',
                 bt: 1698155694999,
-                n: "0",
+                n: '0',
                 v: 33.98755678796222
             },
             {
-                n: "1",
+                n: '1',
                 v: -84.506132079174634
             },
             {
-                n: "2",
+                n: '2',
                 v: 295.468994140625
             },
             {
-                n: "3",
+                n: '3',
                 v: 17.74077033996582
             },
             {
-                n: "4",
+                n: '4',
                 v: 26.376304626464844
             },
             {
-                n: "5",
+                n: '5',
                 v: 359.1545715332
             }
         ];
@@ -36,7 +36,7 @@ void describe("senMLtoLwM2M()", function() {
             {
                 ObjectID: 14201,
                 ObjectInstanceID: 1,
-                ObjectVersion: "1.1",
+                ObjectVersion: '1.1',
                 Resources: {
                     0: 33.98755678796222,
                     1: -84.506132079174634,
@@ -50,96 +50,96 @@ void describe("senMLtoLwM2M()", function() {
         ];
         assert.deepEqual(senMLtoLwM2M(input), expected);
     });
-    void it("should drop empty resources", function() {
+    void it('should drop empty resources', function() {
         var input = [
             {
-                bn: "14203/0/",
-                n: "0",
-                vs: "LTE-M",
+                bn: '14203/0/',
+                n: '0',
+                vs: 'LTE-M',
                 bt: 1676369307222
             },
             {
-                n: "1",
+                n: '1',
                 v: 20
             },
             {
-                n: "2",
+                n: '2',
                 v: -79
             },
             {
-                n: "3",
+                n: '3',
                 v: 6
             },
             {
-                n: "4",
+                n: '4',
                 v: 56879116
             },
             {
-                n: "5",
+                n: '5',
                 v: 24001
             },
             {
-                n: "6",
-                vs: "10.160.243.113"
+                n: '6',
+                vs: '10.160.243.113'
             },
             {
-                n: "11"
+                n: '11'
             }
         ];
         var expected = [
             {
                 ObjectID: 14203,
                 Resources: {
-                    0: "LTE-M",
+                    0: 'LTE-M',
                     1: 20,
                     2: -79,
                     3: 6,
                     4: 56879116,
                     5: 24001,
-                    6: "10.160.243.113",
+                    6: '10.160.243.113',
                     99: new Date(1676369307222)
                 }
             }
         ];
         assert.deepEqual(senMLtoLwM2M(input), expected);
     });
-    void it("should ignore repeated base properties", function() {
+    void it('should ignore repeated base properties', function() {
         var input = [
             {
-                bn: "14203/0/",
-                n: "0",
-                vs: "LTE-M",
+                bn: '14203/0/',
+                n: '0',
+                vs: 'LTE-M',
                 bt: 1699049665511
             },
             {
-                n: "1",
+                n: '1',
                 v: 20
             },
             {
-                bn: "14203/0/",
-                n: "2",
+                bn: '14203/0/',
+                n: '2',
                 v: -89,
                 bt: 1699049665511
             },
             {
-                n: "3",
+                n: '3',
                 v: 2305
             },
             {
-                n: "4",
+                n: '4',
                 v: 34784790
             },
             {
-                n: "5",
+                n: '5',
                 v: 24202
             },
             {
-                n: "6",
-                vs: "100.81.95.75"
+                n: '6',
+                vs: '100.81.95.75'
             },
             {
-                bn: "14203/0/",
-                n: "11",
+                bn: '14203/0/',
+                n: '11',
                 v: 7,
                 bt: 1699049665511
             }
@@ -148,13 +148,13 @@ void describe("senMLtoLwM2M()", function() {
             {
                 ObjectID: 14203,
                 Resources: {
-                    0: "LTE-M",
+                    0: 'LTE-M',
                     1: 20,
                     2: -89,
                     3: 2305,
                     4: 34784790,
                     5: 24202,
-                    6: "100.81.95.75",
+                    6: '100.81.95.75',
                     11: 7,
                     99: new Date(1699049665511)
                 }
@@ -162,29 +162,29 @@ void describe("senMLtoLwM2M()", function() {
         ];
         assert.deepEqual(senMLtoLwM2M(input), expected);
     });
-    void it("should handle multiple measurements for the same resource", function() {
+    void it('should handle multiple measurements for the same resource', function() {
         var input = [
             {
-                bn: "14205/0/",
-                n: "0",
+                bn: '14205/0/',
+                n: '0',
                 v: 21,
                 bt: 1699049600000
             },
             {
-                bn: "14205/1/",
-                n: "0",
+                bn: '14205/1/',
+                n: '0',
                 v: 31,
                 bt: 1699049600000
             },
             {
-                bn: "14205/0/",
-                n: "0",
+                bn: '14205/0/',
+                n: '0',
                 v: 22,
                 bt: 1699049700000
             },
             {
-                bn: "14205/1/",
-                n: "0",
+                bn: '14205/1/',
+                n: '0',
                 v: 32,
                 bt: 1699049700000
             }

package/dist/senml/validateSenML.js

@@ -1,5 +1,5 @@
-import { SenML } from "../senml/SenMLSchema.js";
-import { validate } from "../validate.js";
+import { SenML } from '../senml/SenMLSchema.js';
+import { validate } from '../validate.js';
 var validator = validate(SenML);
 export var validateSenML = function(maybeSenML) {
     return validator(maybeSenML);

package/dist/senml/validateSenML.spec.js

@@ -1,26 +1,26 @@
-import { describe, it } from "node:test";
-import assert from "node:assert/strict";
-import { validateSenML } from "./validateSenML.js";
-void describe("validateSenML()", function() {
-    void it("should validate", function() {
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { validateSenML } from './validateSenML.js';
+void describe('validateSenML()', function() {
+    void it('should validate', function() {
         var senMl = [
             {
-                bn: "14202/1/",
-                blv: "1.1",
-                n: "0",
+                bn: '14202/1/',
+                blv: '1.1',
+                n: '0',
                 v: 99,
                 bt: 1699049685992
             },
             {
-                n: "1",
+                n: '1',
                 v: 4.179
             },
             {
-                n: "2",
+                n: '2',
                 v: 0
             },
             {
-                n: "3",
+                n: '3',
                 v: 25.7
             }
         ];

package/models/README.md

@@ -4,7 +4,3 @@ Models are defined in the subdirectories of this folder.
 
 A model definition consists of a `README.md` that provides a human-friendly
 description of the model.
-
-Optionally, if the device does not send senML directly,
-[transforms can be defined](../README.md#model-transform-definitions) that
-convert the payload sent by the model to senML.

package/models/check-model-rules.ts

@@ -1,15 +1,8 @@
 import chalk from 'chalk'
-import jsonata from 'jsonata'
 import assert from 'node:assert/strict'
 import { readFile, readdir, stat } from 'node:fs/promises'
 import path from 'node:path'
-import { FrontMatter, ModelIDRegExp } from './types.js'
-import { senMLtoLwM2M } from '../senml/senMLtoLwM2M.js'
-import { getCodeBlock } from '../markdown/getCodeBlock.js'
-import { getFrontMatter } from '../markdown/getFrontMatter.js'
-import { validateSenML } from '../senml/validateSenML.js'
-import { isRegisteredLwM2MObject } from '../lwm2m/isRegisteredLwM2MObject.js'
-import { hasValue } from '../senml/hasValue.js'
+import { ModelIDRegExp } from './types.js'
 import { parseREADME } from 'markdown/parseREADME.js'
 
 console.log(chalk.gray('Models rules check'))
@@ -40,86 +33,4 @@ for (const model of await readdir(modelsDir)) {
 		throw new Error(`README is not valid for ${model}!`)
 	}
 	console.log(chalk.green('✔'), chalk.gray(`README.md is valid`))
-
-	// Validate jsonata expressions
-	let hasTransforms = false
-	const transformsFolder = path.join(modelDir, 'transforms')
-	try {
-		await stat(transformsFolder)
-		hasTransforms = true
-		console.log(' ', chalk.gray('Transforms:'))
-	} catch {
-		console.log(' ', chalk.gray('No transforms found.'))
-	}
-	if (hasTransforms) {
-		for (const transform of (await readdir(transformsFolder)).filter((f) =>
-			f.endsWith('.md'),
-		)) {
-			console.log(' ', chalk.white('·'), chalk.white.bold(transform))
-			const markdown = await readFile(
-				path.join(modelDir, 'transforms', transform),
-				'utf-8',
-			)
-
-			// Validate front-matter
-			const type = getFrontMatter(markdown, FrontMatter).type
-			console.log(' ', chalk.green('✔'), chalk.gray(`Type ${type} is valid`))
-			const findBlock = getCodeBlock(markdown)
-			const matchExpression = findBlock('jsonata', 'Match Expression')
-			const transformExpression = findBlock('jsonata', 'Transform Expression')
-			const inputExample = JSON.parse(findBlock('json', 'Input Example'))
-			const resultExample = JSON.parse(findBlock('json', 'Result Example'))
-
-			const selectResult = await jsonata(matchExpression).evaluate(inputExample)
-			if (selectResult !== true) {
-				throw new Error(
-					`The select expression did not evaluate to true with the given example.`,
-				)
-			}
-			console.log(
-				' ',
-				chalk.green('✔'),
-				chalk.gray('Select expression evaluated to true for the example input'),
-			)
-
-			const transformResult = await jsonata(
-				// For testing purposes this function call result is hardcoded
-				transformExpression.replace('$millis()', '1699999999999'),
-			).evaluate(inputExample)
-
-			const maybeValidSenML = validateSenML(transformResult.filter(hasValue))
-			if ('errors' in maybeValidSenML) {
-				console.error(maybeValidSenML.errors)
-				throw new Error('The JSONata expression must produce valid SenML')
-			}
-
-			assert.deepEqual(maybeValidSenML.value, resultExample)
-			console.log(
-				' ',
-				chalk.green('✔'),
-				chalk.gray('Transformation result is valid SenML'),
-			)
-
-			assert.deepEqual(maybeValidSenML.value, resultExample)
-			console.log(
-				' ',
-				chalk.green('✔'),
-				chalk.gray('The transformation result matches the example'),
-			)
-
-			// Validate
-			for (const object of senMLtoLwM2M(maybeValidSenML.value)) {
-				if (!isRegisteredLwM2MObject(object, console.error)) {
-					throw new Error(
-						'The LwM2M object must follow LwM2M schema definition',
-					)
-				}
-				console.log(
-					' ',
-					chalk.green('✔'),
-					chalk.gray('SenML object is valid LwM2M'),
-				)
-			}
-		}
-	}
 }