@hello.nrfcloud.com/proto-map 8.0.6 → 8.1.1

package/dist/senml/fromCBOR.js

@@ -0,0 +1,179 @@
+function _array_like_to_array(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _array_with_holes(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _iterable_to_array_limit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+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 _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+function _sliced_to_array(arr, i) {
+    return _array_with_holes(arr) || _iterable_to_array_limit(arr, i) || _unsupported_iterable_to_array(arr, i) || _non_iterable_rest();
+}
+function _type_of(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+}
+function _unsupported_iterable_to_array(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _array_like_to_array(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array(o, minLen);
+}
+var labelMap = new Map([
+    [
+        -1,
+        'bver'
+    ],
+    [
+        -2,
+        'bn'
+    ],
+    [
+        -3,
+        'bt'
+    ],
+    [
+        -4,
+        'bu'
+    ],
+    [
+        -5,
+        'bv'
+    ],
+    [
+        -6,
+        'bs'
+    ],
+    [
+        0,
+        'n'
+    ],
+    [
+        1,
+        'u'
+    ],
+    [
+        2,
+        'v'
+    ],
+    [
+        3,
+        'vs'
+    ],
+    [
+        4,
+        'vb'
+    ],
+    [
+        5,
+        's'
+    ],
+    [
+        6,
+        't'
+    ],
+    [
+        7,
+        'ut'
+    ],
+    [
+        8,
+        'vd'
+    ]
+]);
+/**
+ * Convert SenML from CBOR notation to JSON notation.
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc8428.html#section-6
+ */ export var fromCBOR = function(records) {
+    return records.map(function(record) {
+        return Object.entries(record).reduce(function(json, param) {
+            var _param = _sliced_to_array(param, 2), k = _param[0], v = _param[1];
+            var label = labelMap.get(parseInt(k, 10));
+            if (label === undefined) return json;
+            if ((typeof v === "undefined" ? "undefined" : _type_of(v)) === 'bigint') v = Number(v);
+            return _object_spread_props(_object_spread({}, json), _define_property({}, label, v));
+        }, {});
+    });
+};

package/dist/senml/fromCBOR.spec.js

@@ -0,0 +1,53 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import { fromCBOR } from './fromCBOR.js';
+void describe('fromCBOR()', function() {
+    void it('should convert CBOR encoding to JSON encoding', function() {
+        return assert.deepEqual(fromCBOR([
+            {
+                '0': '0',
+                '2': 28.904369,
+                '-2': '14205/0/'
+            },
+            {
+                '0': '1',
+                '2': 17.66905
+            },
+            {
+                '0': '2',
+                '2': 100562.21875
+            },
+            {
+                '0': '10',
+                '2': 57
+            },
+            {
+                '0': '99',
+                '2': 1716475294528n
+            }
+        ]), [
+            {
+                n: '0',
+                v: 28.904369,
+                bn: '14205/0/'
+            },
+            {
+                n: '1',
+                v: 17.66905
+            },
+            {
+                n: '2',
+                v: 100562.21875
+            },
+            {
+                n: '10',
+                v: 57
+            },
+            // Convert bigints
+            {
+                n: '99',
+                v: 1716475294528
+            }
+        ]);
+    });
+});

package/export.js

@@ -1,6 +1,7 @@
 export * from './dist/senml/SenMLSchema.js'
 export * from './dist/senml/senMLtoLwM2M.js'
 export * from './dist/senml/lwm2mToSenML.js'
+export * from './dist/senml/fromCBOR.js'
 export * from './dist/models/models.js'
 export * from './dist/models/types.js'
 export * from './dist/lwm2m/timestampResources.js'

package/index.d.ts

@@ -1,6 +1,7 @@
 export * from './senml/SenMLSchema.js'
 export * from './senml/senMLtoLwM2M.js'
 export * from './senml/lwm2mToSenML.js'
+export * from './senml/fromCBOR.js'
 export * from './models/models.js'
 export * from './models/types.js'
 export * from './lwm2m/timestampResources.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "8.0.6",
+  "version": "8.1.1",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -39,22 +39,22 @@
     "prepublishOnly": "./compile.sh"
   },
   "devDependencies": {
-    "@bifravst/eslint-config-typescript": "6.0.25",
+    "@bifravst/eslint-config-typescript": "6.0.26",
     "@bifravst/prettier-config": "1.0.0",
     "@commitlint/config-conventional": "19.2.2",
     "@swc/cli": "0.3.12",
-    "@swc/core": "1.5.5",
-    "@types/node": "20.12.11",
+    "@swc/core": "1.5.7",
+    "@types/node": "20.12.12",
     "@types/xml2js": "0.4.14",
     "chalk": "5.3.0",
     "globstar": "1.0.0",
     "husky": "9.0.11",
-    "lint-staged": "15.2.2",
+    "lint-staged": "15.2.4",
     "prettier-plugin-organize-imports": "3.2.4",
     "remark": "15.0.1",
     "remark-frontmatter": "5.0.0",
     "tsmatchers": "5.0.2",
-    "tsx": "4.9.4",
+    "tsx": "4.11.0",
     "xml2js": "0.6.2",
     "yaml": "2.4.2"
   },
@@ -104,7 +104,7 @@
     "lwm2m"
   ],
   "peerDependencies": {
-    "@sinclair/typebox": "^0.32.30",
+    "@sinclair/typebox": "^0.32.31",
     "ajv": "^8.13.0"
   }
 }

package/senml/fromCBOR.spec.ts

@@ -0,0 +1,24 @@
+import assert from 'node:assert/strict'
+import { describe, it } from 'node:test'
+import { fromCBOR } from './fromCBOR.js'
+
+void describe('fromCBOR()', () => {
+	void it('should convert CBOR encoding to JSON encoding', () =>
+		assert.deepEqual(
+			fromCBOR([
+				{ '0': '0', '2': 28.904369, '-2': '14205/0/' },
+				{ '0': '1', '2': 17.66905 },
+				{ '0': '2', '2': 100562.21875 },
+				{ '0': '10', '2': 57 },
+				{ '0': '99', '2': 1716475294528n },
+			]),
+			[
+				{ n: '0', v: 28.904369, bn: '14205/0/' },
+				{ n: '1', v: 17.66905 },
+				{ n: '2', v: 100562.21875 },
+				{ n: '10', v: 57 },
+				// Convert bigints
+				{ n: '99', v: 1716475294528 },
+			],
+		))
+})

package/senml/fromCBOR.ts

@@ -0,0 +1,36 @@
+const labelMap = new Map<number, string>([
+	[-1, 'bver'], // Base Version
+	[-2, 'bn'], // Base Name
+	[-3, 'bt'], // Base Time
+	[-4, 'bu'], // Base Unit
+	[-5, 'bv'], // Base Value
+	[-6, 'bs'], // Base Sum
+	[0, 'n'], // Name
+	[1, 'u'], // Unit
+	[2, 'v'], // Value
+	[3, 'vs'], // String Value
+	[4, 'vb'], // Boolean Value
+	[5, 's'], // Sum
+	[6, 't'], // Time
+	[7, 'ut'], // Update Time
+	[8, 'vd'], // Data Value
+])
+/**
+ * Convert SenML from CBOR notation to JSON notation.
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc8428.html#section-6
+ */
+export const fromCBOR = (
+	records: Array<Record<number, any>>,
+): Array<Record<string, unknown>> =>
+	records.map((record) =>
+		Object.entries(record).reduce((json, [k, v]) => {
+			const label = labelMap.get(parseInt(k, 10))
+			if (label === undefined) return json
+			if (typeof v === 'bigint') v = Number(v)
+			return {
+				...json,
+				[label]: v,
+			}
+		}, {}),
+	)