@hello.nrfcloud.com/proto-map 5.6.3 → 7.0.0

package/dist/senml/lwm2mToSenML.js

@@ -6,9 +6,6 @@ function _array_like_to_array(arr, len) {
 function _array_with_holes(arr) {
     if (Array.isArray(arr)) return arr;
 }
-function _array_without_holes(arr) {
-    if (Array.isArray(arr)) return _array_like_to_array(arr);
-}
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -28,9 +25,6 @@ function _iterable_to_array(iter) {
 function _non_iterable_rest() {
     throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-function _non_iterable_spread() {
-    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
 function _object_spread(target) {
     for(var i = 1; i < arguments.length; i++){
         var source = arguments[i] != null ? arguments[i] : {};
@@ -73,9 +67,6 @@ function _object_spread_props(target, source) {
 function _to_array(arr) {
     return _array_with_holes(arr) || _iterable_to_array(arr) || _unsupported_iterable_to_array(arr) || _non_iterable_rest();
 }
-function _to_consumable_array(arr) {
-    return _array_without_holes(arr) || _iterable_to_array(arr) || _unsupported_iterable_to_array(arr) || _non_iterable_spread();
-}
 function _unsupported_iterable_to_array(o, minLen) {
     if (!o) return;
     if (typeof o === "string") return _array_like_to_array(o, minLen);
@@ -91,11 +82,6 @@ import { ResourceType } from '../lwm2m/LWM2MObjectInfo.js';
 /**
  * Convert LwM2M Object Instances to senML
  */ export var lwm2mToSenML = function(lwm2m) {
-    return lwm2m.map(asSenML).flat().filter(function(v) {
-        return v !== null;
-    });
-};
-var asSenML = function(lwm2m) {
     var def = definitions[lwm2m.ObjectID];
     var i = instanceTs(lwm2m);
     var tsResourceId = timestampResources[lwm2m.ObjectID]// All registered objects must have a timestamp resource
@@ -104,19 +90,59 @@ var asSenML = function(lwm2m) {
     .filter(function(r) {
         return r[1] !== undefined;
     })), first = _Object_entries_filter[0], rest = _Object_entries_filter.slice(1);
-    if (first === undefined) return null;
-    var _lwm2m_ObjectInstanceID;
-    var _obj;
-    return [
-        (_obj = {
+    if (first === undefined) return {
+        errors: [
+            new Error("No valid LwM2M object found")
+        ]
+    };
+    var senML = [];
+    var errors = [];
+    var resourceId = parseInt(first[0], 10);
+    var firstKey = toKey(def, resourceId);
+    if (firstKey === null) {
+        errors.push(new Error("Unknown ResourceID ".concat(resourceId, " for LwM2M Object ").concat(def.ObjectID, "!")));
+    } else {
+        var _lwm2m_ObjectInstanceID;
+        var _obj;
+        senML.push((_obj = {
             bn: "".concat(lwm2m.ObjectID, "/").concat((_lwm2m_ObjectInstanceID = lwm2m.ObjectInstanceID) !== null && _lwm2m_ObjectInstanceID !== void 0 ? _lwm2m_ObjectInstanceID : 0, "/"),
             n: first[0]
-        }, _define_property(_obj, toKey(def, parseInt(first[0], 10)), first[1]), _define_property(_obj, "bt", i.getTime()), _obj)
-    ].concat(_to_consumable_array(rest.map(function(r) {
-        return _define_property({
-            n: r[0]
-        }, toKey(def, parseInt(r[0], 10)), r[1]);
-    })));
+        }, _define_property(_obj, firstKey, first[1]), _define_property(_obj, "bt", i.getTime()), _obj));
+    }
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = rest[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var r = _step.value;
+            var resourceId1 = parseInt(r[0], 10);
+            var key = toKey(def, resourceId1);
+            if (key === null) {
+                errors.push(new Error("Unknown ResourceID ".concat(resourceId1, " for LwM2M Object ").concat(def.ObjectID, "!")));
+            } else {
+                senML.push(_define_property({
+                    n: r[0]
+                }, key, r[1]));
+            }
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    if (errors.length > 0) return {
+        errors: errors
+    };
+    return {
+        senML: senML
+    };
 };
 var toKey = function(def, resourceId) {
     var _def_Resources_resourceId;
@@ -132,6 +158,6 @@ var toKey = function(def, resourceId) {
         case ResourceType.Opaque:
             return 'vd';
         default:
-            throw new Error("Unknown ResourceID ".concat(resourceId, " for LwM2M Object ").concat(def.ObjectID, "!"));
+            return null;
     }
 };

package/dist/senml/lwm2mToSenML.spec.js

@@ -99,6 +99,8 @@ void describe('lwm2mToSenML()', function() {
                 vs: 'AES'
             }
         ];
-        assert.deepEqual(lwm2mToSenML(lwm2m), expected);
+        assert.deepEqual(lwm2m.map(lwm2mToSenML).map(function(res) {
+            return 'senML' in res && res.senML;
+        }).flat(), expected);
     });
 });

package/dist/senml/senMLtoLwM2M.js

@@ -53,14 +53,12 @@ function _object_spread_props(target, source) {
 import { timestampResources } from '../lwm2m/timestampResources.js';
 import { parseResourceId } from './parseResourceId.js';
 import { hasValue } from './hasValue.js';
-var isInfoForDifferentInstance = function(currentObject, resourceID, currentBaseTime) {
+var isInfoForDifferentInstance = function(currentObject, resourceID, currentBaseTime, tsRes) {
     var _currentObject_Resources_tsRes, _currentObject_Resources;
     if (currentObject === undefined) return true;
     if (currentObject.ObjectID !== resourceID.ObjectID) return true;
     var _currentObject_ObjectInstanceID;
     if (((_currentObject_ObjectInstanceID = currentObject.ObjectInstanceID) !== null && _currentObject_ObjectInstanceID !== void 0 ? _currentObject_ObjectInstanceID : 0) !== resourceID.ObjectInstanceID) return true;
-    var tsRes = timestampResources[resourceID.ObjectID];
-    if (tsRes === undefined) throw new Error("Unknown LwM2M Object ID: ".concat(resourceID.ObjectID, "!"));
     if (currentBaseTime !== ((_currentObject_Resources = currentObject.Resources) === null || _currentObject_Resources === void 0 ? void 0 : (_currentObject_Resources_tsRes = _currentObject_Resources[tsRes]) === null || _currentObject_Resources_tsRes === void 0 ? void 0 : _currentObject_Resources_tsRes.getTime())) return true;
     return false;
 };
@@ -77,7 +75,7 @@ export var senMLtoLwM2M = function(senML) {
     var currentBaseName = '';
     var currentBaseTime = undefined;
     var currentObject = undefined;
-    var items = [];
+    var lwm2m = [];
     var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
     try {
         for(var _iterator = senML[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
@@ -88,12 +86,24 @@ export var senMLtoLwM2M = function(senML) {
             var _item_n;
             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)) {
-                if (currentObject !== undefined) items.push(currentObject);
-                var tsRes = timestampResources[resourceId.ObjectID];
-                if (tsRes === undefined) throw new Error("Unknown LwM2M Object ID: ".concat(resourceId.ObjectID, "!"));
-                if (currentBaseTime === undefined) throw new Error("No base time defined for object!");
+            if (resourceId === null) {
+                return {
+                    error: new Error("Invalid resource ID: ".concat(itemResourceId))
+                };
+            }
+            var tsRes = timestampResources[resourceId.ObjectID];
+            if (tsRes === undefined) {
+                return {
+                    error: new Error("No timestamp resource defined for object: ".concat(resourceId.ObjectID))
+                };
+            }
+            if (currentObject === undefined || currentBaseTime !== undefined && isInfoForDifferentInstance(currentObject, resourceId, currentBaseTime, tsRes)) {
+                if (currentObject !== undefined) lwm2m.push(currentObject);
+                if (currentBaseTime === undefined) {
+                    return {
+                        error: new Error("No base time defined for object: ".concat(resourceId.ObjectID, "!"))
+                    };
+                }
                 currentObject = {
                     ObjectID: resourceId.ObjectID,
                     Resources: _define_property({}, tsRes, new Date(currentBaseTime))
@@ -121,6 +131,8 @@ export var senMLtoLwM2M = function(senML) {
             }
         }
     }
-    if (currentObject !== undefined) items.push(currentObject);
-    return items;
+    if (currentObject !== undefined) lwm2m.push(currentObject);
+    return {
+        lwm2m: lwm2m
+    };
 };

package/dist/senml/senMLtoLwM2M.spec.js

@@ -48,7 +48,8 @@ void describe('senMLtoLwM2M()', function() {
                 }
             }
         ];
-        assert.deepEqual(senMLtoLwM2M(input), expected);
+        var res = senMLtoLwM2M(input);
+        assert.deepEqual('lwm2m' in res && res.lwm2m, expected);
     });
     void it('should drop empty resources', function() {
         var input = [
@@ -101,7 +102,8 @@ void describe('senMLtoLwM2M()', function() {
                 }
             }
         ];
-        assert.deepEqual(senMLtoLwM2M(input), expected);
+        var res = senMLtoLwM2M(input);
+        assert.deepEqual('lwm2m' in res && res.lwm2m, expected);
     });
     void it('should ignore repeated base properties', function() {
         var input = [
@@ -160,7 +162,8 @@ void describe('senMLtoLwM2M()', function() {
                 }
             }
         ];
-        assert.deepEqual(senMLtoLwM2M(input), expected);
+        var res = senMLtoLwM2M(input);
+        assert.deepEqual('lwm2m' in res && res.lwm2m, expected);
     });
     void it('should handle multiple measurements for the same resource', function() {
         var input = [
@@ -221,6 +224,7 @@ void describe('senMLtoLwM2M()', function() {
                 }
             }
         ];
-        assert.deepEqual(senMLtoLwM2M(input), expected);
+        var res = senMLtoLwM2M(input);
+        assert.deepEqual('lwm2m' in res && res.lwm2m, expected);
     });
 });

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'),
-				)
-			}
-		}
-	}
 }

package/models/models.ts

@@ -1,10 +1,7 @@
-import { type Transform, TransformType } from "./types.js";
 /**
  * The Model IDs defined in this repo.
  */
 export enum ModelID {
-    PCA20035_solar = "PCA20035+solar",
-    Asset_tracker_v2_AWS = "asset_tracker_v2+AWS",
     Kartverket_vasstandsdata = "kartverket-vasstandsdata"
 }
 export type Model = {
@@ -12,10 +9,6 @@ export type Model = {
      * The Model ID
      */
     "id": ModelID;
-    /**
-     * The transforms defined for this model.
-     */
-    "transforms": Array<Transform>;
     /**
      * Description of the Model from the README.md
      */
@@ -33,4 +26,4 @@ export type Model = {
 /**
  * The models defined for hello.nrfcloud.com
  */
-export const models: Readonly<Record<ModelID, Model>> = { [ModelID.PCA20035_solar]: { "id": ModelID.PCA20035_solar, "transforms": [{ "type": TransformType.Messages, "match": "appId = 'AIR_QUAL'", "transform": "[\n    {\"bn\": \"14205/0/\", \"n\": \"10\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'BATTERY'", "transform": "[\n    {\"bn\": \"14202/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'BUTTON'", "transform": "[\n    {\"bn\": \"14220/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'DEVICE' and $exists(data.deviceInfo)", "transform": "[\n    {\"bn\": \"14204/0/\", \"n\": \"0\", \"vs\": data.deviceInfo.imei, \"bt\": ts },\n    {\"n\": \"1\", \"vs\": data.deviceInfo.iccid },\n    {\"n\": \"2\", \"vs\": data.deviceInfo.modemFirmware },\n    {\"n\": \"3\", \"vs\": data.deviceInfo.appVersion },\n    {\"n\": \"4\", \"vs\": data.deviceInfo.board },\n    {\"n\": \"5\", \"vs\": data.deviceInfo.bat }\n]" }, { "type": TransformType.Messages, "match": "appId = 'SOLAR'", "transform": "[\n    {\"bn\": \"14210/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'GROUND_FIX' and $exists(data.lat) and $exists(data.lon) and $exists(data.uncertainty) and $exists(data.fulfilledWith)", "transform": "[\n    {\"bn\": \"14201/1/\", \"n\": \"0\", \"v\": data.lat, \"bt\": $millis() },\n    {\"n\": \"1\", \"v\": data.lon },\n    {\"n\": \"3\", \"v\": data.uncertainty },\n    {\"n\": \"6\", \"vs\": data.fulfilledWith }\n]" }, { "type": TransformType.Messages, "match": "appId = 'GNSS'", "transform": "[\n    {\"bn\": \"14201/0/\", \"n\": \"0\", \"v\": data.lat, \"bt\": ts },\n    {\"n\": \"1\", \"v\": data.lng },\n    {\"n\": \"2\", \"v\": data.alt },\n    {\"n\": \"3\", \"v\": data.acc },\n    {\"n\": \"4\", \"v\": data.spd },\n    {\"n\": \"5\", \"v\": data.hdg },\n    {\"n\": \"6\", \"vs\": \"GNSS\" }\n]" }, { "type": TransformType.Messages, "match": "appId = 'HUMID'", "transform": "[\n    {\"bn\": \"14205/0/\", \"n\": \"1\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'DEVICE' and $exists(data.networkInfo)", "transform": "[\n    {\"bn\": \"14203/0/\", \"n\": \"0\", \"vs\": data.networkInfo.networkMode, \"bt\": ts },\n    {\"n\": \"1\", \"v\": data.networkInfo.currentBand },\n    {\"n\": \"2\", \"v\": data.networkInfo.rsrp },\n    {\"n\": \"3\", \"v\": data.networkInfo.areaCode },\n    {\"n\": \"4\", \"v\": data.networkInfo.cellID },\n    {\"n\": \"5\", \"v\": data.networkInfo.mccmnc },\n    {\"n\": \"6\", \"vs\": data.networkInfo.ipAddress },\n    {\"n\": \"11\", \"v\": data.networkInfo.eest }\n]" }, { "type": TransformType.Messages, "match": "appId = 'AIR_PRESS'", "transform": "[\n    {\"bn\": \"14205/0/\", \"n\": \"2\", \"v\": $number(data)*10, \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'TEMP'", "transform": "[\n    {\"bn\": \"14205/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }], "about": { "title": "Thingy:91 with Solar Shield", "description": "The Nordic Thingy:91 Solar Shield is a plug-and-play prototyping platform. Powerfoyle solar cell is mounted onto the Thingy to quickly get started exploring the endless possibilities with solar powered IoT applications and to develop products with eternal life or even battery-free products.\u200B\nThe Thingy:91 runs the asset_tracker_v2 application and sends messages to nRF Cloud using MQTT." } }, [ModelID.Asset_tracker_v2_AWS]: { "id": ModelID.Asset_tracker_v2_AWS, "transforms": [{ "type": TransformType.Shadow, "match": "$exists(state.reported.gnss)", "transform": "[\n    {\"bn\": \"14201/0/\", \"n\": \"0\", \"v\": state.reported.gnss.v.lat, \"bt\": state.reported.gnss.ts },\n    {\"n\": \"1\", \"v\": state.reported.gnss.v.lng },\n    {\"n\": \"2\", \"v\": state.reported.gnss.v.alt },\n    {\"n\": \"3\", \"v\": state.reported.gnss.v.acc },\n    {\"n\": \"4\", \"v\": state.reported.gnss.v.spd },\n    {\"n\": \"5\", \"v\": state.reported.gnss.v.hdg },\n    {\"n\": \"6\", \"vs\": \"GNSS\" }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.bat)", "transform": "[\n    {\"bn\": \"14202/0/\", \"n\": \"1\", \"v\": state.reported.bat.v/1000, \"bt\": state.reported.bat.ts }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.dev)", "transform": "[\n    {\"bn\": \"14204/0/\", \"n\": \"0\", \"vs\": state.reported.dev.v.imei, \"bt\": state.reported.dev.ts },\n    {\"n\": \"1\", \"vs\": state.reported.dev.v.iccid },\n    {\"n\": \"2\", \"vs\": state.reported.dev.v.modV },\n    {\"n\": \"3\", \"vs\": state.reported.dev.v.appV },\n    {\"n\": \"4\", \"vs\": state.reported.dev.v.brdV }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.env)", "transform": "[\n    {\"bn\": \"14205/0/\", \"n\": \"0\", \"v\": state.reported.env.v.temp, \"bt\": state.reported.env.ts },\n    {\"n\": \"1\", \"v\": state.reported.env.v.hum },\n    {\"n\": \"2\", \"v\": state.reported.env.v.atmp },\n    {\"n\": \"10\", \"v\": state.reported.env.v.bsec_iaq }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.fg)", "transform": "[\n    {\"bn\": \"14202/0/\", \"n\": \"0\", \"v\": state.reported.fg.v.SoC, \"bt\": state.reported.fg.ts },\n    {\"n\": \"1\", \"v\": state.reported.fg.v.V/1000 },\n    {\"n\": \"2\", \"v\": state.reported.fg.v.I },\n    {\"n\": \"3\", \"v\": state.reported.fg.v.T = null ? null : state.reported.fg.v.T/10 },\n    {\"n\": \"4\", \"v\": state.reported.fg.v.TTF },\n    {\"n\": \"5\", \"v\": state.reported.fg.v.TTE }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.roam)", "transform": "[\n    {\"bn\": \"14203/0/\", \"n\": \"0\", \"vs\": state.reported.roam.v.nw, \"bt\": state.reported.roam.ts },\n    {\"n\": \"1\", \"v\": state.reported.roam.v.band },\n    {\"bn\": \"14203/0/\", \"n\": \"2\", \"v\": state.reported.roam.v.rsrp, \"bt\": state.reported.roam.ts },\n    {\"n\": \"3\", \"v\": state.reported.roam.v.area },\n    {\"n\": \"4\", \"v\": state.reported.roam.v.cell },\n    {\"n\": \"5\", \"v\": state.reported.roam.v.mccmnc },\n    {\"n\": \"6\", \"vs\": state.reported.roam.v.ip },\n    {\"bn\": \"14203/0/\", \"n\": \"11\", \"v\": state.reported.roam.v.eest, \"bt\": state.reported.roam.ts }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.sol)", "transform": "[\n    {\"bn\": \"14210/0/\", \"n\": \"0\", \"v\": state.reported.sol.v.gain, \"bt\": state.reported.sol.ts },\n    {\"n\": \"1\", \"v\": state.reported.sol.v.bat }\n]" }], "about": { "title": "asset_tracker_v2 on AWS", "description": "This implements the conversion for the asset_tracker_v2 message protocol when connected to AWS IoT." } }, [ModelID.Kartverket_vasstandsdata]: { "id": ModelID.Kartverket_vasstandsdata, "transforms": [], "about": { "title": "Kartverket Vasstandsdata", "description": "A simulated device reporting the current sea level as provided by the Kartverket's (Norwegian Mapping Authority) API for vasstandsdata (API for water level data).\nReports sea water level using the Object 14230.\nThe data is licensed by the Norwegian Mapping Authority\u2019s under the Creative Commons Attribution 4.0 International (CC BY 4.0) license." } } } as const;
+export const models: Readonly<Record<ModelID, Model>> = { [ModelID.Kartverket_vasstandsdata]: { "id": ModelID.Kartverket_vasstandsdata, "about": { "title": "Kartverket Vasstandsdata", "description": "A simulated device reporting the current sea level as provided by the Kartverket's (Norwegian Mapping Authority) API for vasstandsdata (API for water level data).\nReports sea water level using the Object 14230.\nThe data is licensed by the Norwegian Mapping Authority\u2019s under the Creative Commons Attribution 4.0 International (CC BY 4.0) license." } } } as const;

package/models/types.ts

@@ -1,17 +1 @@
-import { Type } from '@sinclair/typebox'
-
 export const ModelIDRegExp = /^[A-Za-z0-9+_-]+$/
-
-export enum TransformType {
-	Shadow = 'shadow',
-	Messages = 'messages',
-}
-export type Transform = {
-	type: TransformType
-	match: string
-	transform: string
-}
-
-export const FrontMatter = Type.Object({
-	type: Type.Union([Type.Literal('shadow'), Type.Literal('messages')]),
-})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "5.6.3",
+  "version": "7.0.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -105,7 +105,6 @@
   ],
   "peerDependencies": {
     "@sinclair/typebox": "^0.32.22",
-    "ajv": "^8.12.0",
-    "jsonata": "^2.0.4"
+    "ajv": "^8.12.0"
   }
 }

package/senml/lwm2mToSenML.spec.ts

@@ -69,6 +69,12 @@ void describe('lwm2mToSenML()', () => {
 			{ n: '1', vs: 'AES' },
 		]
 
-		assert.deepEqual(lwm2mToSenML(lwm2m), expected)
+		assert.deepEqual(
+			lwm2m
+				.map(lwm2mToSenML)
+				.map((res) => 'senML' in res && res.senML)
+				.flat(),
+			expected,
+		)
 	})
 })

package/senml/lwm2mToSenML.ts

@@ -9,14 +9,8 @@ import { ResourceType, type LWM2MObjectInfo } from '../lwm2m/LWM2MObjectInfo.js'
  * Convert LwM2M Object Instances to senML
  */
 export const lwm2mToSenML = (
-	lwm2m: Array<LwM2MObjectInstance<any>>,
-): SenMLType =>
-	lwm2m
-		.map(asSenML)
-		.flat()
-		.filter((v) => v !== null) as SenMLType
-
-const asSenML = (lwm2m: LwM2MObjectInstance<any>): SenMLType | null => {
+	lwm2m: LwM2MObjectInstance<any>,
+): { senML: SenMLType } | { errors: Array<Error> } => {
 	const def = definitions[lwm2m.ObjectID]
 	const i = instanceTs(lwm2m)
 	const tsResourceId = timestampResources[lwm2m.ObjectID] as number // All registered objects must have a timestamp resource
@@ -27,22 +21,50 @@ const asSenML = (lwm2m: LwM2MObjectInstance<any>): SenMLType | null => {
 		// Filter out undefined values (and timestamp resource)
 		.filter((r): r is [string, LwM2MResourceValue] => r[1] !== undefined)
 
-	if (first === undefined) return null
-	return [
-		{
+	if (first === undefined)
+		return { errors: [new Error(`No valid LwM2M object found`)] }
+
+	const senML: SenMLType = []
+	const errors: Array<Error> = []
+	const resourceId = parseInt(first[0], 10)
+	const firstKey = toKey(def, resourceId)
+	if (firstKey === null) {
+		errors.push(
+			new Error(
+				`Unknown ResourceID ${resourceId} for LwM2M Object ${def.ObjectID}!`,
+			),
+		)
+	} else {
+		senML.push({
 			bn: `${lwm2m.ObjectID}/${lwm2m.ObjectInstanceID ?? 0}/`,
 			n: first[0],
-			[toKey(def, parseInt(first[0], 10))]: first[1],
+			[firstKey]: first[1],
 			bt: i.getTime(),
-		},
-		...rest.map((r) => ({
-			n: r[0],
-			[toKey(def, parseInt(r[0], 10))]: r[1],
-		})),
-	]
+		})
+	}
+
+	for (const r of rest) {
+		const resourceId = parseInt(r[0], 10)
+		const key = toKey(def, resourceId)
+		if (key === null) {
+			errors.push(
+				new Error(
+					`Unknown ResourceID ${resourceId} for LwM2M Object ${def.ObjectID}!`,
+				),
+			)
+		} else {
+			senML.push({
+				n: r[0],
+				[key]: r[1],
+			})
+		}
+	}
+
+	if (errors.length > 0) return { errors }
+	return { senML }
 }
 
-const toKey = (def: LWM2MObjectInfo, resourceId: number) => {
+const toKey = (def: LWM2MObjectInfo, resourceId: number): string | null => {
 	switch (def.Resources[resourceId]?.Type) {
 		case ResourceType.String:
 			return 'vs'
@@ -55,8 +77,6 @@ const toKey = (def: LWM2MObjectInfo, resourceId: number) => {
 		case ResourceType.Opaque:
 			return 'vd'
 		default:
-			throw new Error(
-				`Unknown ResourceID ${resourceId} for LwM2M Object ${def.ObjectID}!`,
-			)
+			return null
 	}
 }

package/senml/senMLtoLwM2M.spec.ts

@@ -50,7 +50,8 @@ void describe('senMLtoLwM2M()', () => {
 				},
 			},
 		]
-		assert.deepEqual(senMLtoLwM2M(input), expected)
+		const res = senMLtoLwM2M(input)
+		assert.deepEqual('lwm2m' in res && res.lwm2m, expected)
 	})
 
 	void it('should drop empty resources', () => {
@@ -104,7 +105,8 @@ void describe('senMLtoLwM2M()', () => {
 				},
 			},
 		]
-		assert.deepEqual(senMLtoLwM2M(input), expected)
+		const res = senMLtoLwM2M(input)
+		assert.deepEqual('lwm2m' in res && res.lwm2m, expected)
 	})
 
 	void it('should ignore repeated base properties', () => {
@@ -134,7 +136,8 @@ void describe('senMLtoLwM2M()', () => {
 				},
 			},
 		]
-		assert.deepEqual(senMLtoLwM2M(input), expected)
+		const res = senMLtoLwM2M(input)
+		assert.deepEqual('lwm2m' in res && res.lwm2m, expected)
 	})
 
 	void it('should handle multiple measurements for the same resource', () => {
@@ -176,6 +179,7 @@ void describe('senMLtoLwM2M()', () => {
 				},
 			},
 		]
-		assert.deepEqual(senMLtoLwM2M(input), expected)
+		const res = senMLtoLwM2M(input)
+		assert.deepEqual('lwm2m' in res && res.lwm2m, expected)
 	})
 })

package/senml/senMLtoLwM2M.ts

@@ -42,14 +42,12 @@ const isInfoForDifferentInstance = (
 	currentObject: LwM2MObjectInstance,
 	resourceID: ResourceID,
 	currentBaseTime: number,
+	tsRes: number,
 ): boolean => {
 	if (currentObject === undefined) return true
 	if (currentObject.ObjectID !== resourceID.ObjectID) return true
 	if ((currentObject.ObjectInstanceID ?? 0) !== resourceID.ObjectInstanceID)
 		return true
-	const tsRes = timestampResources[resourceID.ObjectID]
-	if (tsRes === undefined)
-		throw new Error(`Unknown LwM2M Object ID: ${resourceID.ObjectID}!`)
 	if (
 		currentBaseTime !==
 		(currentObject.Resources?.[tsRes] as Date | undefined)?.getTime()
@@ -70,11 +68,13 @@ const getValue = (
 	if ('vd' in measurement) return measurement.vd
 	return undefined
 }
-export const senMLtoLwM2M = (senML: SenMLType): Array<LwM2MObjectInstance> => {
+export const senMLtoLwM2M = (
+	senML: SenMLType,
+): { lwm2m: Array<LwM2MObjectInstance> } | { error: Error } => {
 	let currentBaseName: string = ''
 	let currentBaseTime: number | undefined = undefined
 	let currentObject: LwM2MObjectInstance | undefined = undefined
-	const items: LwM2MObjectInstance[] = []
+	const lwm2m: Array<LwM2MObjectInstance> = []
 
 	for (const item of senML) {
 		if ('bn' in item && item.bn !== undefined) currentBaseName = item.bn
@@ -82,20 +82,37 @@ export const senMLtoLwM2M = (senML: SenMLType): Array<LwM2MObjectInstance> => {
 		if (!hasValue(item)) continue
 		const itemResourceId = `${currentBaseName}${item.n ?? ''}/0`
 		const resourceId = parseResourceId(itemResourceId)
-		if (resourceId === null)
-			throw new Error(`Invalid resource ID: ${itemResourceId}`)
+		if (resourceId === null) {
+			return { error: new Error(`Invalid resource ID: ${itemResourceId}`) }
+		}
+
+		const tsRes = timestampResources[resourceId.ObjectID]
+		if (tsRes === undefined) {
+			return {
+				error: new Error(
+					`No timestamp resource defined for object: ${resourceId.ObjectID}`,
+				),
+			}
+		}
 
 		if (
 			currentObject === undefined ||
 			(currentBaseTime !== undefined &&
-				isInfoForDifferentInstance(currentObject, resourceId, currentBaseTime))
+				isInfoForDifferentInstance(
+					currentObject,
+					resourceId,
+					currentBaseTime,
+					tsRes,
+				))
 		) {
-			if (currentObject !== undefined) items.push(currentObject)
-			const tsRes = timestampResources[resourceId.ObjectID]
-			if (tsRes === undefined)
-				throw new Error(`Unknown LwM2M Object ID: ${resourceId.ObjectID}!`)
-			if (currentBaseTime === undefined)
-				throw new Error(`No base time defined for object!`)
+			if (currentObject !== undefined) lwm2m.push(currentObject)
+			if (currentBaseTime === undefined) {
+				return {
+					error: new Error(
+						`No base time defined for object: ${resourceId.ObjectID}!`,
+					),
+				}
+			}
 			currentObject = {
 				ObjectID: resourceId.ObjectID,
 				Resources: {
@@ -115,7 +132,7 @@ export const senMLtoLwM2M = (senML: SenMLType): Array<LwM2MObjectInstance> => {
 			}
 		}
 	}
-	if (currentObject !== undefined) items.push(currentObject)
+	if (currentObject !== undefined) lwm2m.push(currentObject)
 
-	return items
+	return { lwm2m }
 }