@hello.nrfcloud.com/proto-map 12.1.4 → 13.0.0

package/README.md

@@ -35,7 +35,8 @@ in a meaningful way to users without the need for custom implementation.
   (non-inclusively).
 - The URN must have the prefix `urn:oma:lwm2m:x:`.
 - The `ObjectVersion` must be appended if it is not `1.0`, which is the default.
-- All objects must define one `Time` property.
+- All objects must define one `Time` property. Time is a signed integer
+  representing the number of seconds since Jan 1 st, 1970 in the UTC time zone.
 - Objects must be `Multiple` instance.
 - Objects must be `Optional`.
 - Resources should only be marked as mandatory in case they must be published

package/dist/lwm2m/instanceTs.js

@@ -1,8 +1,19 @@
 import { definitions } from './definitions.js';
 import { timestampResources } from './timestampResources.js';
-export var instanceTs = function(instance) {
+/**
+ * Returns the timestamp of the instance
+ *
+ * The timestamp is s signed integer representing
+ * the number of seconds since Jan 1, 1970 in the
+ * UTC time zone.
+ */ export var instanceTs = function(instance) {
     var definition = definitions[instance.ObjectID];
     var tsResourceId = timestampResources.get(definition.ObjectID)// All registered objects must have a timestamp resource
     ;
     return instance.Resources[tsResourceId];
 };
+/**
+ * Returns the timestamp of the instance as a Date object
+ */ export var instanceTsAsDate = function(instance) {
+    return new Date(instanceTs(instance) * 1000);
+};

package/dist/lwm2m/instanceTs.spec.js

@@ -1,6 +1,6 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert/strict';
-import { instanceTs } from './instanceTs.js';
+import { instanceTs, instanceTsAsDate } from './instanceTs.js';
 void describe('instanceTs()', function() {
     void it('should return the timestamp of the instance', function() {
         return assert.equal(instanceTs({
@@ -9,8 +9,21 @@ void describe('instanceTs()', function() {
             Resources: {
                 '0': 3.5399999618530273,
                 '1': 4.168000221252441,
-                '99': 1708683500474
+                '99': 1708683500
             }
-        }), 1708683500474);
+        }), 1708683500);
+    });
+});
+void describe('instanceTsAsDate()', function() {
+    void it('should return the timestamp of the instance', function() {
+        return assert.equal(instanceTsAsDate({
+            ObjectID: 14210,
+            ObjectVersion: '1.0',
+            Resources: {
+                '0': 3.5399999618530273,
+                '1': 4.168000221252441,
+                '99': 1708683500
+            }
+        }).getTime(), 1708683500 * 1000);
     });
 });

package/dist/lwm2m/validate.spec.js

@@ -13,7 +13,7 @@ void describe('validate()', function() {
                 '1': 6.151946,
                 '6': 'Fixed',
                 '3': 1,
-                '99': 1710147413003
+                '99': 1710147413
             }
         };
         var maybeValid = v(object);
@@ -35,7 +35,7 @@ void describe('validate()', function() {
                 '5': 24201,
                 '6': '10.234.105.140',
                 11: undefined,
-                '99': 1716988087000
+                '99': 1716988087
             }
         };
         var maybeValid = v(object);
@@ -51,7 +51,7 @@ void describe('validate()', function() {
                     'MODEM',
                     'APP'
                 ],
-                '99': 1717409966000
+                '99': 1717409966
             }
         };
         var maybeValid = v(object);

package/dist/lwm2m/validation.js

@@ -159,7 +159,7 @@ export var NumberResource = function(r) {
     return typeof r === 'number';
 };
 export var TimeResource = function(r) {
-    return NumberResource(r) && r > 1700000000000 && r < 9999999999999;
+    return NumberResource(r) && r > 1700000000 && r < 9999999999;
 };
 export var StringResource = function(r) {
     return typeof r === 'string';

package/dist/senml/SenMLSchema.spec.js

@@ -9,7 +9,7 @@ void describe('SenMLType', function() {
                 bn: '14201/0/',
                 n: '0',
                 v: 33.98755678796222,
-                bt: 1698155694999
+                bt: 1698155694
             },
             {
                 n: '1',

package/dist/senml/fromCBOR.spec.js

@@ -21,9 +21,10 @@ void describe('fromCBOR()', function() {
                 '0': '10',
                 '2': 57
             },
+            // Converts from BigInt as well
             {
                 '0': '99',
-                '2': 1716475294528n
+                '2': 1716475294n
             }
         ]), [
             {
@@ -43,10 +44,9 @@ void describe('fromCBOR()', function() {
                 n: '10',
                 v: 57
             },
-            // Convert bigints
             {
                 n: '99',
-                v: 1716475294528
+                v: 1716475294
             }
         ]);
     });

package/dist/senml/hasValue.spec.js

@@ -60,7 +60,7 @@ void describe('hasValue() should determine whether an object has a value', funct
                 bn: 14202,
                 n: 0,
                 v: 99,
-                bt: 1699049685992
+                bt: 1699049685
             },
             true
         ],

package/dist/senml/lwm2mToSenML.spec.js

@@ -12,7 +12,7 @@ void describe('lwm2mToSenML()', function() {
                 '1': 6.151946,
                 '6': 'Fixed',
                 '3': 1,
-                '99': 1710147413003
+                '99': 1710147413
             }
         };
         var level1 = {
@@ -21,7 +21,7 @@ void describe('lwm2mToSenML()', function() {
             Resources: {
                 '0': 84.3,
                 '1': 'AES',
-                '99': 1710140400000
+                '99': 1710140400
             }
         };
         var level2 = {
@@ -30,7 +30,7 @@ void describe('lwm2mToSenML()', function() {
             Resources: {
                 '0': 140.4,
                 '1': 'AES',
-                '99': 1710144000000
+                '99': 1710144000
             }
         };
         var level3 = {
@@ -40,7 +40,7 @@ void describe('lwm2mToSenML()', function() {
             Resources: {
                 '0': 140.7,
                 '1': 'AES',
-                '99': 1710144001000
+                '99': 1710144001
             }
         };
         var lwm2m = [
@@ -54,7 +54,7 @@ void describe('lwm2mToSenML()', function() {
                 bn: '14201/0/',
                 n: '0',
                 v: 62.469414,
-                bt: 1710147413003
+                bt: 1710147413
             },
             {
                 n: '1',
@@ -72,7 +72,7 @@ void describe('lwm2mToSenML()', function() {
                 bn: '14230/0/',
                 n: '0',
                 v: 84.3,
-                bt: 1710140400000
+                bt: 1710140400
             },
             {
                 n: '1',
@@ -82,7 +82,7 @@ void describe('lwm2mToSenML()', function() {
                 bn: '14230/0/',
                 n: '0',
                 v: 140.4,
-                bt: 1710144000000
+                bt: 1710144000
             },
             {
                 n: '1',
@@ -92,7 +92,7 @@ void describe('lwm2mToSenML()', function() {
                 bn: '14230/1/',
                 n: '0',
                 v: 140.7,
-                bt: 1710144001000
+                bt: 1710144001
             },
             {
                 n: '1',

package/dist/senml/senMLtoLwM2M.spec.js

@@ -7,7 +7,7 @@ void describe('senMLtoLwM2M()', function() {
             {
                 bn: '14201/1/',
                 blv: '1.1',
-                bt: 1698155694999,
+                bt: 1698155694,
                 n: '0',
                 v: 33.98755678796222
             },
@@ -44,7 +44,7 @@ void describe('senMLtoLwM2M()', function() {
                     3: 17.74077033996582,
                     4: 26.376304626464844,
                     5: 359.1545715332,
-                    99: 1698155694999
+                    99: 1698155694
                 }
             }
         ];
@@ -57,7 +57,7 @@ void describe('senMLtoLwM2M()', function() {
                 bn: '14203/0/',
                 n: '0',
                 vs: 'LTE-M',
-                bt: 1676369307222
+                bt: 1676369307
             },
             {
                 n: '1',
@@ -98,7 +98,7 @@ void describe('senMLtoLwM2M()', function() {
                     4: 56879116,
                     5: 24001,
                     6: '10.160.243.113',
-                    99: 1676369307222
+                    99: 1676369307
                 }
             }
         ];
@@ -111,7 +111,7 @@ void describe('senMLtoLwM2M()', function() {
                 bn: '14203/0/',
                 n: '0',
                 vs: 'LTE-M',
-                bt: 1699049665511
+                bt: 1699049665
             },
             {
                 n: '1',
@@ -121,7 +121,7 @@ void describe('senMLtoLwM2M()', function() {
                 bn: '14203/0/',
                 n: '2',
                 v: -89,
-                bt: 1699049665511
+                bt: 1699049665
             },
             {
                 n: '3',
@@ -143,7 +143,7 @@ void describe('senMLtoLwM2M()', function() {
                 bn: '14203/0/',
                 n: '11',
                 v: 7,
-                bt: 1699049665511
+                bt: 1699049665
             }
         ];
         var expected = [
@@ -158,7 +158,7 @@ void describe('senMLtoLwM2M()', function() {
                     5: 24202,
                     6: '100.81.95.75',
                     11: 7,
-                    99: 1699049665511
+                    99: 1699049665
                 }
             }
         ];
@@ -171,25 +171,25 @@ void describe('senMLtoLwM2M()', function() {
                 bn: '14205/0/',
                 n: '0',
                 v: 21,
-                bt: 1699049600000
+                bt: 1699049600
             },
             {
                 bn: '14205/1/',
                 n: '0',
                 v: 31,
-                bt: 1699049600000
+                bt: 1699049600
             },
             {
                 bn: '14205/0/',
                 n: '0',
                 v: 22,
-                bt: 1699049700000
+                bt: 1699049700
             },
             {
                 bn: '14205/1/',
                 n: '0',
                 v: 32,
-                bt: 1699049700000
+                bt: 1699049700
             }
         ];
         var expected = [
@@ -197,7 +197,7 @@ void describe('senMLtoLwM2M()', function() {
                 ObjectID: 14205,
                 Resources: {
                     0: 21,
-                    99: 1699049600000
+                    99: 1699049600
                 }
             },
             {
@@ -205,14 +205,14 @@ void describe('senMLtoLwM2M()', function() {
                 ObjectInstanceID: 1,
                 Resources: {
                     0: 31,
-                    99: 1699049600000
+                    99: 1699049600
                 }
             },
             {
                 ObjectID: 14205,
                 Resources: {
                     0: 22,
-                    99: 1699049700000
+                    99: 1699049700
                 }
             },
             {
@@ -220,7 +220,7 @@ void describe('senMLtoLwM2M()', function() {
                 ObjectInstanceID: 1,
                 Resources: {
                     0: 32,
-                    99: 1699049700000
+                    99: 1699049700
                 }
             }
         ];

package/dist/senml/validateSenML.spec.js

@@ -9,7 +9,7 @@ void describe('validateSenML()', function() {
                 blv: '1.1',
                 n: '0',
                 v: 99,
-                bt: 1699049685992
+                bt: 1699049685
             },
             {
                 n: '1',

package/lwm2m/instanceTs.spec.ts

@@ -1,6 +1,6 @@
 import { describe, it } from 'node:test'
 import assert from 'node:assert/strict'
-import { instanceTs } from './instanceTs.js'
+import { instanceTs, instanceTsAsDate } from './instanceTs.js'
 
 void describe('instanceTs()', () => {
 	void it('should return the timestamp of the instance', () =>
@@ -11,9 +11,25 @@ void describe('instanceTs()', () => {
 				Resources: {
 					'0': 3.5399999618530273,
 					'1': 4.168000221252441,
-					'99': 1708683500474,
+					'99': 1708683500,
 				},
 			}),
-			1708683500474,
+			1708683500,
+		))
+})
+
+void describe('instanceTsAsDate()', () => {
+	void it('should return the timestamp of the instance', () =>
+		assert.equal(
+			instanceTsAsDate({
+				ObjectID: 14210,
+				ObjectVersion: '1.0',
+				Resources: {
+					'0': 3.5399999618530273,
+					'1': 4.168000221252441,
+					'99': 1708683500,
+				},
+			}).getTime(),
+			1708683500 * 1000,
 		))
 })

package/lwm2m/instanceTs.ts

@@ -2,8 +2,21 @@ import type { LwM2MObjectInstance } from './LwM2MObjectInstance.js'
 import { definitions } from './definitions.js'
 import { timestampResources } from './timestampResources.js'
 
+/**
+ * Returns the timestamp of the instance
+ *
+ * The timestamp is s signed integer representing
+ * the number of seconds since Jan 1, 1970 in the
+ * UTC time zone.
+ */
 export const instanceTs = (instance: LwM2MObjectInstance): number => {
 	const definition = definitions[instance.ObjectID]
 	const tsResourceId = timestampResources.get(definition.ObjectID) as number // All registered objects must have a timestamp resource
 	return instance.Resources[tsResourceId] as number
 }
+
+/**
+ * Returns the timestamp of the instance as a Date object
+ */
+export const instanceTsAsDate = (instance: LwM2MObjectInstance): Date =>
+	new Date(instanceTs(instance) * 1000)

package/lwm2m/validate.spec.ts

@@ -14,7 +14,7 @@ void describe('validate()', () => {
 				'1': 6.151946,
 				'6': 'Fixed',
 				'3': 1,
-				'99': 1710147413003,
+				'99': 1710147413,
 			},
 		}
 		const maybeValid = v(object)
@@ -38,7 +38,7 @@ void describe('validate()', () => {
 				'5': 24201,
 				'6': '10.234.105.140',
 				11: undefined,
-				'99': 1716988087000,
+				'99': 1716988087,
 			},
 		}
 		const maybeValid = v(object)
@@ -51,7 +51,7 @@ void describe('validate()', () => {
 			ObjectVersion: '1.0',
 			Resources: {
 				'0': ['BOOT', 'MODEM', 'APP'],
-				'99': 1717409966000,
+				'99': 1717409966,
 			},
 		}
 		const maybeValid = v(object)

package/lwm2m/validation.ts

@@ -101,7 +101,7 @@ export const validateInstance =
 
 export const NumberResource = (r: unknown): r is number => typeof r === 'number'
 export const TimeResource = (r: unknown): r is number =>
-	NumberResource(r) && r > 1700000000000 && r < 9999999999999
+	NumberResource(r) && r > 1700000000 && r < 9999999999
 export const StringResource = (r: unknown): r is string => typeof r === 'string'
 export const BooleanResource = (r: unknown): r is boolean =>
 	typeof r === 'boolean'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "12.1.4",
+  "version": "13.0.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {

package/senml/SenMLSchema.spec.ts

@@ -10,7 +10,7 @@ void describe('SenMLType', () => {
 				bn: '14201/0/',
 				n: '0',
 				v: 33.98755678796222,
-				bt: 1698155694999,
+				bt: 1698155694,
 			},
 			{ n: '1', v: -84.506132079174634 },
 		]

package/senml/fromCBOR.spec.ts

@@ -10,15 +10,15 @@ void describe('fromCBOR()', () => {
 				{ '0': '1', '2': 17.66905 },
 				{ '0': '2', '2': 100562.21875 },
 				{ '0': '10', '2': 57 },
-				{ '0': '99', '2': 1716475294528n },
+				// Converts from BigInt as well
+				{ '0': '99', '2': 1716475294n },
 			]),
 			[
 				{ 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 },
+				{ n: '99', v: 1716475294 },
 			],
 		))
 })

package/senml/hasValue.spec.ts

@@ -4,7 +4,7 @@ import { hasValue } from './hasValue.js'
 
 void describe('hasValue() should determine whether an object has a value', () => {
 	for (const [record, expected] of [
-		[{ bn: 14202, n: 0, v: 99, bt: 1699049685992 }, true],
+		[{ bn: 14202, n: 0, v: 99, bt: 1699049685 }, true],
 		[{ n: 1, v: 4.179 }, true],
 		[{ n: 2, v: 0 }, true],
 		[{ n: 3, v: 25.7 }, true],

package/senml/lwm2mToSenML.spec.ts

@@ -19,7 +19,7 @@ void describe('lwm2mToSenML()', () => {
 				'1': 6.151946,
 				'6': 'Fixed',
 				'3': 1,
-				'99': 1710147413003,
+				'99': 1710147413,
 			},
 		}
 		const level1: LwM2MObjectInstance<SeaWaterLevel_14230> = {
@@ -28,7 +28,7 @@ void describe('lwm2mToSenML()', () => {
 			Resources: {
 				'0': 84.3,
 				'1': 'AES',
-				'99': 1710140400000,
+				'99': 1710140400,
 			},
 		}
 		const level2: LwM2MObjectInstance<SeaWaterLevel_14230> = {
@@ -37,7 +37,7 @@ void describe('lwm2mToSenML()', () => {
 			Resources: {
 				'0': 140.4,
 				'1': 'AES',
-				'99': 1710144000000,
+				'99': 1710144000,
 			},
 		}
 		const level3: LwM2MObjectInstance<SeaWaterLevel_14230> = {
@@ -47,7 +47,7 @@ void describe('lwm2mToSenML()', () => {
 			Resources: {
 				'0': 140.7,
 				'1': 'AES',
-				'99': 1710144001000,
+				'99': 1710144001,
 			},
 		}
 		const lwm2m: Array<LwM2MObjectInstance<any>> = [
@@ -57,15 +57,15 @@ void describe('lwm2mToSenML()', () => {
 			level3,
 		]
 		const expected: SenMLType = [
-			{ bn: '14201/0/', n: '0', v: 62.469414, bt: 1710147413003 },
+			{ bn: '14201/0/', n: '0', v: 62.469414, bt: 1710147413 },
 			{ n: '1', v: 6.151946 },
 			{ n: '3', v: 1 },
 			{ n: '6', vs: 'Fixed' },
-			{ bn: '14230/0/', n: '0', v: 84.3, bt: 1710140400000 },
+			{ bn: '14230/0/', n: '0', v: 84.3, bt: 1710140400 },
 			{ n: '1', vs: 'AES' },
-			{ bn: '14230/0/', n: '0', v: 140.4, bt: 1710144000000 },
+			{ bn: '14230/0/', n: '0', v: 140.4, bt: 1710144000 },
 			{ n: '1', vs: 'AES' },
-			{ bn: '14230/1/', n: '0', v: 140.7, bt: 1710144001000 },
+			{ bn: '14230/1/', n: '0', v: 140.7, bt: 1710144001 },
 			{ n: '1', vs: 'AES' },
 		]
 

package/senml/senMLtoLwM2M.spec.ts

@@ -10,7 +10,7 @@ void describe('senMLtoLwM2M()', () => {
 			{
 				bn: '14201/1/',
 				blv: '1.1',
-				bt: 1698155694999,
+				bt: 1698155694,
 				n: '0',
 				v: 33.98755678796222,
 			},
@@ -47,7 +47,7 @@ void describe('senMLtoLwM2M()', () => {
 					3: 17.74077033996582,
 					4: 26.376304626464844,
 					5: 359.1545715332,
-					99: 1698155694999,
+					99: 1698155694,
 				},
 			},
 		]
@@ -61,7 +61,7 @@ void describe('senMLtoLwM2M()', () => {
 				bn: '14203/0/',
 				n: '0',
 				vs: 'LTE-M',
-				bt: 1676369307222,
+				bt: 1676369307,
 			},
 			{
 				n: '1',
@@ -102,7 +102,7 @@ void describe('senMLtoLwM2M()', () => {
 					4: 56879116,
 					5: 24001,
 					6: '10.160.243.113',
-					99: 1676369307222,
+					99: 1676369307,
 				},
 			},
 		]
@@ -112,14 +112,14 @@ void describe('senMLtoLwM2M()', () => {
 
 	void it('should ignore repeated base properties', () => {
 		const input: SenMLType = [
-			{ bn: '14203/0/', n: '0', vs: 'LTE-M', bt: 1699049665511 },
+			{ bn: '14203/0/', n: '0', vs: 'LTE-M', bt: 1699049665 },
 			{ n: '1', v: 20 },
-			{ bn: '14203/0/', n: '2', v: -89, bt: 1699049665511 },
+			{ bn: '14203/0/', n: '2', v: -89, bt: 1699049665 },
 			{ n: '3', v: 2305 },
 			{ n: '4', v: 34784790 },
 			{ n: '5', v: 24202 },
 			{ n: '6', vs: '100.81.95.75' },
-			{ bn: '14203/0/', n: '11', v: 7, bt: 1699049665511 },
+			{ bn: '14203/0/', n: '11', v: 7, bt: 1699049665 },
 		]
 		const expected: LwM2MObjectInstance[] = [
 			{
@@ -133,7 +133,7 @@ void describe('senMLtoLwM2M()', () => {
 					5: 24202,
 					6: '100.81.95.75',
 					11: 7,
-					99: 1699049665511,
+					99: 1699049665,
 				},
 			},
 		]
@@ -143,17 +143,17 @@ void describe('senMLtoLwM2M()', () => {
 
 	void it('should handle multiple measurements for the same resource', () => {
 		const input: SenMLType = [
-			{ bn: '14205/0/', n: '0', v: 21, bt: 1699049600000 },
-			{ bn: '14205/1/', n: '0', v: 31, bt: 1699049600000 },
-			{ bn: '14205/0/', n: '0', v: 22, bt: 1699049700000 },
-			{ bn: '14205/1/', n: '0', v: 32, bt: 1699049700000 },
+			{ bn: '14205/0/', n: '0', v: 21, bt: 1699049600 },
+			{ bn: '14205/1/', n: '0', v: 31, bt: 1699049600 },
+			{ bn: '14205/0/', n: '0', v: 22, bt: 1699049700 },
+			{ bn: '14205/1/', n: '0', v: 32, bt: 1699049700 },
 		]
 		const expected: LwM2MObjectInstance[] = [
 			{
 				ObjectID: 14205,
 				Resources: {
 					0: 21,
-					99: 1699049600000,
+					99: 1699049600,
 				},
 			},
 			{
@@ -161,14 +161,14 @@ void describe('senMLtoLwM2M()', () => {
 				ObjectInstanceID: 1,
 				Resources: {
 					0: 31,
-					99: 1699049600000,
+					99: 1699049600,
 				},
 			},
 			{
 				ObjectID: 14205,
 				Resources: {
 					0: 22,
-					99: 1699049700000,
+					99: 1699049700,
 				},
 			},
 			{
@@ -176,7 +176,7 @@ void describe('senMLtoLwM2M()', () => {
 				ObjectInstanceID: 1,
 				Resources: {
 					0: 32,
-					99: 1699049700000,
+					99: 1699049700,
 				},
 			},
 		]

package/senml/validateSenML.spec.ts

@@ -6,7 +6,7 @@ import type { SenMLType } from './SenMLSchema.js'
 void describe('validateSenML()', () => {
 	void it('should validate', () => {
 		const senMl: SenMLType = [
-			{ bn: '14202/1/', blv: '1.1', n: '0', v: 99, bt: 1699049685992 },
+			{ bn: '14202/1/', blv: '1.1', n: '0', v: 99, bt: 1699049685 },
 			{ n: '1', v: 4.179 },
 			{ n: '2', v: 0 },
 			{ n: '3', v: 25.7 },