@hello.nrfcloud.com/proto-map 12.1.0 → 12.1.2

package/api/LwM2M.ts

@@ -20,11 +20,18 @@ export const ObjectInstanceID = Type.Integer({
 	examples: [0, 1],
 })
 
+const String = Type.String({ minLength: 1, title: 'LwM2M string value' })
+const Number = Type.Number({ title: 'LwM2M number value' })
+const Boolean = Type.Boolean({ title: 'LwM2M boolean value' })
+
 export const Resources = Type.Record(
 	Type.Integer({ minimum: 0 }),
 	Type.Union([
-		Type.String({ minLength: 1, title: 'LwM2M string value' }),
-		Type.Number({ title: 'LwM2M number value' }),
-		Type.Boolean({ title: 'LwM2M boolean value' }),
+		String,
+		Type.Array(String),
+		Number,
+		Type.Array(Number),
+		Boolean,
+		Type.Array(Boolean),
 	]),
 )

package/dist/api/LwM2M.js

@@ -21,17 +21,23 @@ export var ObjectInstanceID = Type.Integer({
         1
     ]
 });
+var String = Type.String({
+    minLength: 1,
+    title: 'LwM2M string value'
+});
+var Number = Type.Number({
+    title: 'LwM2M number value'
+});
+var Boolean = Type.Boolean({
+    title: 'LwM2M boolean value'
+});
 export var Resources = Type.Record(Type.Integer({
     minimum: 0
 }), Type.Union([
-    Type.String({
-        minLength: 1,
-        title: 'LwM2M string value'
-    }),
-    Type.Number({
-        title: 'LwM2M number value'
-    }),
-    Type.Boolean({
-        title: 'LwM2M boolean value'
-    })
+    String,
+    Type.Array(String),
+    Number,
+    Type.Array(Number),
+    Boolean,
+    Type.Array(Boolean)
 ]));

package/dist/generator/generateValidator.js

@@ -104,6 +104,11 @@ export var generateValidator = function(param) {
 };
 var toResourceValidator = function(Resource) {
     var valueValidator = ts.factory.createIdentifier(typeToValidator(Resource.Type));
+    if (Resource.MultipleInstances === 'Multiple') {
+        valueValidator = ts.factory.createCallExpression(ts.factory.createIdentifier('MultipleInstanceResource'), undefined, [
+            valueValidator
+        ]);
+    }
     if (Resource.Mandatory === 'Optional') return ts.factory.createCallExpression(ts.factory.createIdentifier('OptionalResource'), undefined, [
         valueValidator
     ]);
@@ -130,10 +135,11 @@ var getResourceValidators = function(param) {
     return new Set((Array.isArray(Resources.Item) ? Resources.Item : [
         Resources.Item
     ]).map(function(param) {
-        var Type = param.Type, Mandatory = param.Mandatory;
+        var Type = param.Type, Mandatory = param.Mandatory, MultipleInstances = param.MultipleInstances;
         return [
             typeToValidator(Type),
-            Mandatory === 'Optional' ? 'OptionalResource' : undefined
+            Mandatory === 'Optional' ? 'OptionalResource' : undefined,
+            MultipleInstances === 'Multiple' ? 'MultipleInstanceResource' : undefined
         ];
     }).flat().filter(function(d) {
         return d !== undefined;

package/dist/lwm2m/object/validate14401.js

@@ -1,4 +1,4 @@
-import { TimeResource, StringResource, OptionalResource, validateInstance } from "../validation.js";
+import { TimeResource, StringResource, OptionalResource, MultipleInstanceResource, validateInstance } from "../validation.js";
 import { LwM2MObjectID } from "../LwM2MObjectID.js";
 /**
  * Validate nRF Cloud Service Info (14401)
@@ -7,6 +7,6 @@ import { LwM2MObjectID } from "../LwM2MObjectID.js";
  */ export var validate14401 = function(o) {
     return validateInstance(LwM2MObjectID.NRFCloudServiceInfo_14401, "1.0", {
         99: TimeResource,
-        0: OptionalResource(StringResource)
+        0: OptionalResource(MultipleInstanceResource(StringResource))
     })(o);
 };

package/dist/lwm2m/validate.spec.js

@@ -1,13 +1,12 @@
 import { describe, it } from 'node:test';
 import { validate } from './validate.js';
 import { validators } from './validators.js';
-import { LwM2MObjectID } from './LwM2MObjectID.js';
 import assert from 'node:assert';
 void describe('validate()', function() {
     var v = validate(validators);
     void it('should validate a LwM2M object instance', function() {
         var object = {
-            ObjectID: LwM2MObjectID.Geolocation_14201,
+            ObjectID: 14201,
             ObjectVersion: '1.0',
             Resources: {
                 '0': 62.469414,
@@ -42,4 +41,20 @@ void describe('validate()', function() {
         var maybeValid = v(object);
         assert.deepEqual('object' in maybeValid && maybeValid.object, object);
     });
+    void it('should validate an object with multiple instance resource', function() {
+        var object = {
+            ObjectID: 14401,
+            ObjectVersion: '1.0',
+            Resources: {
+                '0': [
+                    'BOOT',
+                    'MODEM',
+                    'APP'
+                ],
+                '99': 1717409966000
+            }
+        };
+        var maybeValid = v(object);
+        assert.deepEqual('object' in maybeValid && maybeValid.object, object);
+    });
 });

package/dist/lwm2m/validation.js

@@ -80,10 +80,10 @@ export var isLwM2MObject = function(object) {
         // All values must be number, string, boolean
         for(var _iterator = Object.values(object.Resources)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
             var v = _step.value;
-            if (v === undefined) continue;
-            if (typeof v === 'string') continue;
-            if (typeof v === 'boolean') continue;
-            if (typeof v === 'number') continue;
+            if (isSimpleResource(v)) continue;
+            if (Array.isArray(v) && v.every(function(v) {
+                return isSimpleResource(v);
+            })) continue;
             return error("Invalid value type ".concat(typeof v === "undefined" ? "undefined" : _type_of(v)));
         }
     } catch (err) {
@@ -104,6 +104,13 @@ export var isLwM2MObject = function(object) {
         object: object
     };
 };
+var isSimpleResource = function(v) {
+    if (v === undefined) return true;
+    if (typeof v === 'string') return true;
+    if (typeof v === 'boolean') return true;
+    if (typeof v === 'number') return true;
+    return false;
+};
 export var validateInstance = function(ObjectID, ObjectVersion, Resources) {
     return function(o) {
         var error = function(message) {
@@ -165,3 +172,8 @@ export var OptionalResource = function(validator) {
         return r === undefined ? true : validator(r);
     };
 };
+export var MultipleInstanceResource = function(validator) {
+    return function(r) {
+        return Array.isArray(r) && r.every(validator);
+    };
+};

package/dist/lwm2m/validation.spec.js

@@ -0,0 +1,39 @@
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { MultipleInstanceResource, OptionalResource, StringResource } from './validation.js';
+void describe('MultipleInstanceResource()', function() {
+    void it('should validate a multiple instance resource', function() {
+        assert.equal(true, MultipleInstanceResource(StringResource)([
+            'BOOT',
+            'MODEM',
+            'APP'
+        ]));
+    });
+});
+void describe('StringResource()', function() {
+    void it('should validate a string', function() {
+        assert.equal(true, StringResource('test'));
+    });
+});
+void describe('OptionalResource()', function() {
+    void it('should validate an undefined resource', function() {
+        assert.equal(true, OptionalResource(StringResource)(undefined));
+    });
+    void it('should validate an defined resource', function() {
+        assert.equal(true, OptionalResource(StringResource)('foo'));
+    });
+    void it('should not validate an invalid defined resource', function() {
+        assert.equal(false, OptionalResource(StringResource)(true));
+    });
+});
+void describe('combination', function() {
+    void it('should validate OptionalResource(MultipleInstanceResource(StringResource))', function() {
+        assert.equal(true, OptionalResource(MultipleInstanceResource(StringResource))([
+            'BOOT',
+            'MODEM',
+            'APP'
+        ]));
+        assert.equal(true, OptionalResource(MultipleInstanceResource(StringResource))(undefined));
+        assert.equal(false, OptionalResource(MultipleInstanceResource(StringResource))('foo'));
+    });
+});

package/lwm2m/object/validate14401.ts

@@ -1,5 +1,5 @@
 import type { LwM2MObjectInstance } from "../LwM2MObjectInstance.js";
-import { TimeResource, StringResource, OptionalResource, validateInstance } from "../validation.js";
+import { TimeResource, StringResource, OptionalResource, MultipleInstanceResource, validateInstance } from "../validation.js";
 import type { NRFCloudServiceInfo_14401 } from "../objects.js";
 import { LwM2MObjectID } from "../LwM2MObjectID.js";
 /**
@@ -11,4 +11,4 @@ export const validate14401 = (o: unknown): {
     error: Error;
 } | {
     object: LwM2MObjectInstance<NRFCloudServiceInfo_14401>;
-} => validateInstance<NRFCloudServiceInfo_14401>(LwM2MObjectID.NRFCloudServiceInfo_14401, "1.0", { 99: TimeResource, 0: OptionalResource(StringResource) })(o);
+} => validateInstance<NRFCloudServiceInfo_14401>(LwM2MObjectID.NRFCloudServiceInfo_14401, "1.0", { 99: TimeResource, 0: OptionalResource(MultipleInstanceResource(StringResource)) })(o);

package/lwm2m/validate.spec.ts

@@ -1,14 +1,13 @@
 import { describe, it } from 'node:test'
 import { validate } from './validate.js'
 import { validators } from './validators.js'
-import { LwM2MObjectID } from './LwM2MObjectID.js'
 import assert from 'node:assert'
 
 void describe('validate()', () => {
 	const v = validate(validators)
 	void it('should validate a LwM2M object instance', () => {
 		const object = {
-			ObjectID: LwM2MObjectID.Geolocation_14201,
+			ObjectID: 14201,
 			ObjectVersion: '1.0',
 			Resources: {
 				'0': 62.469414,
@@ -45,4 +44,17 @@ void describe('validate()', () => {
 		const maybeValid = v(object)
 		assert.deepEqual('object' in maybeValid && maybeValid.object, object)
 	})
+
+	void it('should validate an object with multiple instance resource', () => {
+		const object = {
+			ObjectID: 14401,
+			ObjectVersion: '1.0',
+			Resources: {
+				'0': ['BOOT', 'MODEM', 'APP'],
+				'99': 1717409966000,
+			},
+		}
+		const maybeValid = v(object)
+		assert.deepEqual('object' in maybeValid && maybeValid.object, object)
+	})
 })

package/lwm2m/validation.spec.ts

@@ -0,0 +1,55 @@
+import assert from 'node:assert'
+import { describe, it } from 'node:test'
+import {
+	MultipleInstanceResource,
+	OptionalResource,
+	StringResource,
+} from './validation.js'
+
+void describe('MultipleInstanceResource()', () => {
+	void it('should validate a multiple instance resource', () => {
+		assert.equal(
+			true,
+			MultipleInstanceResource(StringResource)(['BOOT', 'MODEM', 'APP']),
+		)
+	})
+})
+
+void describe('StringResource()', () => {
+	void it('should validate a string', () => {
+		assert.equal(true, StringResource('test'))
+	})
+})
+
+void describe('OptionalResource()', () => {
+	void it('should validate an undefined resource', () => {
+		assert.equal(true, OptionalResource(StringResource)(undefined))
+	})
+	void it('should validate an defined resource', () => {
+		assert.equal(true, OptionalResource(StringResource)('foo'))
+	})
+	void it('should not validate an invalid defined resource', () => {
+		assert.equal(false, OptionalResource(StringResource)(true))
+	})
+})
+
+void describe('combination', () => {
+	void it('should validate OptionalResource(MultipleInstanceResource(StringResource))', () => {
+		assert.equal(
+			true,
+			OptionalResource(MultipleInstanceResource(StringResource))([
+				'BOOT',
+				'MODEM',
+				'APP',
+			]),
+		)
+		assert.equal(
+			true,
+			OptionalResource(MultipleInstanceResource(StringResource))(undefined),
+		)
+		assert.equal(
+			false,
+			OptionalResource(MultipleInstanceResource(StringResource))('foo'),
+		)
+	})
+})

package/lwm2m/validation.ts

@@ -50,15 +50,23 @@ export const isLwM2MObject = (
 		return error(`All resource IDs must be a number`)
 	// All values must be number, string, boolean
 	for (const v of Object.values(object.Resources)) {
-		if (v === undefined) continue
-		if (typeof v === 'string') continue
-		if (typeof v === 'boolean') continue
-		if (typeof v === 'number') continue
+		if (isSimpleResource(v)) continue
+		if (Array.isArray(v) && v.every((v) => isSimpleResource(v))) continue
 		return error(`Invalid value type ${typeof v}`)
 	}
 	return { object: object as LwM2MObjectInstance }
 }
 
+const isSimpleResource = (
+	v?: unknown,
+): v is number | string | boolean | undefined => {
+	if (v === undefined) return true
+	if (typeof v === 'string') return true
+	if (typeof v === 'boolean') return true
+	if (typeof v === 'number') return true
+	return false
+}
+
 export const validateInstance =
 	<O extends LwM2MObjectInstance>(
 		ObjectID: LwM2MObjectID,
@@ -99,12 +107,11 @@ export const BooleanResource = (r: unknown): r is boolean =>
 	typeof r === 'boolean'
 
 export const OptionalResource =
-	(
-		validator:
-			| typeof NumberResource
-			| typeof TimeResource
-			| typeof StringResource
-			| typeof BooleanResource,
-	) =>
+	(validator: (r: unknown) => boolean) =>
 	(r: unknown): boolean =>
 		r === undefined ? true : validator(r)
+
+export const MultipleInstanceResource =
+	(validator: (r: unknown) => boolean) =>
+	(r: unknown): boolean =>
+		Array.isArray(r) && r.every(validator)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "12.1.0",
+  "version": "12.1.2",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -39,7 +39,7 @@
     "@bifravst/prettier-config": "1.0.2",
     "@commitlint/config-conventional": "19.2.2",
     "@swc/cli": "0.3.12",
-    "@swc/core": "1.5.25",
+    "@swc/core": "1.5.27",
     "@types/node": "20.14.2",
     "@types/xml2js": "0.4.14",
     "chalk": "5.3.0",
@@ -50,9 +50,9 @@
     "remark": "15.0.1",
     "remark-frontmatter": "5.0.0",
     "tsmatchers": "5.0.2",
-    "tsx": "4.13.2",
+    "tsx": "4.15.1",
     "xml2js": "0.6.2",
-    "yaml": "2.4.3"
+    "yaml": "2.4.5"
   },
   "lint-staged": {
     "*.{ts,tsx}": [