@hello.nrfcloud.com/proto-map 5.4.2 → 5.6.0

package/api/Context.ts

@@ -10,5 +10,6 @@ export const Context = {
 		request: new URL(`${baseURL}/share-device-request`),
 		ownershipConfirmed: new URL(`${baseURL}/share-device-ownership-confirmed`),
 	},
+	resourceUpdate: new URL(`${baseURL}/resource/update`),
 	named: (name: string): URL => new URL(`${baseURL}/${name}`),
 }

package/api/History.ts

@@ -7,6 +7,7 @@ import {
 	Resources,
 } from './LwM2M.js'
 import { PublicDeviceId } from './DeviceId.js'
+import { Timestamp } from './Timestamp.js'
 
 export const ResourceHistory = Type.Object(
 	{
@@ -16,13 +17,7 @@ export const ResourceHistory = Type.Object(
 				[
 					Resources,
 					Type.Object({
-						ts: Type.RegExp(
-							/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/,
-							{
-								title: 'Date formatted as ISO 8601',
-								examples: ['2024-04-19T08:45:00.000Z'],
-							},
-						),
+						ts: Timestamp,
 					}),
 				],
 				{

package/api/ResourceUpdate.spec.ts

@@ -0,0 +1,28 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { validate } from '../validate.js'
+import { ResourceUpdate } from './ResourceUpdate.js'
+import type { Static } from '@sinclair/typebox'
+
+void describe('ResourceUpdate', () => {
+	void it('should validate', () => {
+		const input: Static<typeof ResourceUpdate> = {
+			'@context': 'https://github.com/hello-nrfcloud/proto-map/resource/update',
+			ObjectID: 14201,
+			ObjectVersion: '1.0',
+			ObjectInstanceID: 0,
+			Resources: {
+				'0': 70.374978,
+				'1': 31.104015,
+				'3': 1,
+				'6': 'Fixed',
+				'99': '${tsISO}',
+			},
+			deviceId: 'bassetto-ennobler-toilless',
+			ts: '2024-04-19T08:30:00.000Z',
+		}
+		const maybeValid = validate(ResourceUpdate)(input)
+		assert.equal('errors' in maybeValid, false)
+		assert.deepEqual('value' in maybeValid && maybeValid.value, input)
+	})
+})

package/api/ResourceUpdate.ts

@@ -0,0 +1,26 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import {
+	ObjectID,
+	ObjectInstanceID,
+	ObjectVersion,
+	Resources,
+} from './LwM2M.js'
+import { PublicDeviceId } from './DeviceId.js'
+import { Timestamp } from './Timestamp.js'
+
+export const ResourceUpdate = Type.Object(
+	{
+		'@context': Type.Literal(Context.resourceUpdate.toString()),
+		ObjectID,
+		ObjectInstanceID,
+		ObjectVersion,
+		Resources,
+		ts: Timestamp,
+		deviceId: PublicDeviceId,
+	},
+	{
+		title: 'Resource history',
+		description: 'Describes an update to a LwM2M resource for a device.',
+	},
+)

package/api/Timestamp.spec.ts

@@ -0,0 +1,14 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { validate } from '../validate.js'
+import { Timestamp } from './Timestamp.js'
+import type { Static } from '@sinclair/typebox'
+
+void describe('Timestamp', () => {
+	void it('should validate', () => {
+		const input: Static<typeof Timestamp> = '2024-04-19T08:30:00.000Z'
+		const maybeValid = validate(Timestamp)(input)
+		assert.equal('errors' in maybeValid, false)
+		assert.deepEqual('value' in maybeValid && maybeValid.value, input)
+	})
+})

package/api/Timestamp.ts

@@ -0,0 +1,9 @@
+import { Type } from '@sinclair/typebox'
+
+export const Timestamp = Type.RegExp(
+	/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/,
+	{
+		title: 'Time when the update was received, formatted as ISO 8601',
+		examples: ['2024-04-19T08:45:00.000Z'],
+	},
+)

package/api/index.ts

@@ -5,3 +5,4 @@ export * from './ShareDeviceOwnershipConfirmed.js'
 export * from './ShareDeviceRequest.js'
 export * from './History.js'
 export * from './LwM2M.js'
+export * from './Timestamp.js'

package/dist/api/Context.js

@@ -9,6 +9,7 @@ export var Context = {
         request: new URL("".concat(baseURL, "/share-device-request")),
         ownershipConfirmed: new URL("".concat(baseURL, "/share-device-ownership-confirmed"))
     },
+    resourceUpdate: new URL("".concat(baseURL, "/resource/update")),
     named: function(name) {
         return new URL("".concat(baseURL, "/").concat(name));
     }

package/dist/api/History.js

@@ -2,17 +2,13 @@ import { Type } from "@sinclair/typebox";
 import { Context } from "./Context.js";
 import { ObjectID, ObjectInstanceID, ObjectVersion, Resources } from "./LwM2M.js";
 import { PublicDeviceId } from "./DeviceId.js";
+import { Timestamp } from "./Timestamp.js";
 export var ResourceHistory = Type.Object({
     "@context": Type.Literal(Context.history.resource.toString()),
     partialInstances: Type.Array(Type.Intersect([
         Resources,
         Type.Object({
-            ts: Type.RegExp(/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/, {
-                title: "Date formatted as ISO 8601",
-                examples: [
-                    "2024-04-19T08:45:00.000Z"
-                ]
-            })
+            ts: Timestamp
         })
     ], {
         title: "The resources of the object instance and the timestamp the data was received."

package/dist/api/ResourceUpdate.js

@@ -0,0 +1,17 @@
+import { Type } from "@sinclair/typebox";
+import { Context } from "./Context.js";
+import { ObjectID, ObjectInstanceID, ObjectVersion, Resources } from "./LwM2M.js";
+import { PublicDeviceId } from "./DeviceId.js";
+import { Timestamp } from "./Timestamp.js";
+export var ResourceUpdate = Type.Object({
+    "@context": Type.Literal(Context.resourceUpdate.toString()),
+    ObjectID: ObjectID,
+    ObjectInstanceID: ObjectInstanceID,
+    ObjectVersion: ObjectVersion,
+    Resources: Resources,
+    ts: Timestamp,
+    deviceId: PublicDeviceId
+}, {
+    title: "Resource history",
+    description: "Describes an update to a LwM2M resource for a device."
+});

package/dist/api/ResourceUpdate.spec.js

@@ -0,0 +1,26 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { validate } from "../validate.js";
+import { ResourceUpdate } from "./ResourceUpdate.js";
+void describe("ResourceUpdate", function() {
+    void it("should validate", function() {
+        var input = {
+            "@context": "https://github.com/hello-nrfcloud/proto-map/resource/update",
+            ObjectID: 14201,
+            ObjectVersion: "1.0",
+            ObjectInstanceID: 0,
+            Resources: {
+                "0": 70.374978,
+                "1": 31.104015,
+                "3": 1,
+                "6": "Fixed",
+                "99": "${tsISO}"
+            },
+            deviceId: "bassetto-ennobler-toilless",
+            ts: "2024-04-19T08:30:00.000Z"
+        };
+        var maybeValid = validate(ResourceUpdate)(input);
+        assert.equal("errors" in maybeValid, false);
+        assert.deepEqual("value" in maybeValid && maybeValid.value, input);
+    });
+});

package/dist/api/Timestamp.js

@@ -0,0 +1,7 @@
+import { Type } from "@sinclair/typebox";
+export var Timestamp = Type.RegExp(/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/, {
+    title: "Time when the update was received, formatted as ISO 8601",
+    examples: [
+        "2024-04-19T08:45:00.000Z"
+    ]
+});

package/dist/api/Timestamp.spec.js

@@ -0,0 +1,12 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { validate } from "../validate.js";
+import { Timestamp } from "./Timestamp.js";
+void describe("Timestamp", function() {
+    void it("should validate", function() {
+        var input = "2024-04-19T08:30:00.000Z";
+        var maybeValid = validate(Timestamp)(input);
+        assert.equal("errors" in maybeValid, false);
+        assert.deepEqual("value" in maybeValid && maybeValid.value, input);
+    });
+});

package/dist/api/index.js

@@ -5,3 +5,4 @@ export * from "./ShareDeviceOwnershipConfirmed.js";
 export * from "./ShareDeviceRequest.js";
 export * from "./History.js";
 export * from "./LwM2M.js";
+export * from "./Timestamp.js";

package/package.json

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