@hello.nrfcloud.com/proto-map 5.3.2 → 5.4.0

package/api/Context.ts

@@ -3,6 +3,9 @@ const baseURL = `https://github.com/hello-nrfcloud/proto-map`
 export const Context = {
 	device: new URL(`${baseURL}/device`),
 	devices: new URL(`${baseURL}/devices`),
+	history: {
+		resource: new URL(`${baseURL}/history/resource`),
+	},
 	shareDevice: {
 		request: new URL(`${baseURL}/share-device-request`),
 		ownershipConfirmed: new URL(`${baseURL}/share-device-ownership-confirmed`),

package/api/DeviceId.ts

@@ -3,10 +3,12 @@ import { Type } from '@sinclair/typebox'
 export const DeviceId = Type.RegExp(/^[a-zA-Z0-9:_-]{1,128}$/, {
 	title: 'Device ID',
 	description: 'Must follow the AWS IoT limitations for Thing names.',
+	examples: ['oob-352656166666905'],
 })
 
 export const PublicDeviceId = Type.RegExp(/^[a-z]{8}-[a-z]{8}-[a-z]{8}$/, {
 	title: 'Public Device ID',
 	description:
 		'This is the format of @nordicsemiconductor/random-words which is used for public IDs.',
+	examples: ['pentacid-coxalgia-backheel'],
 })

package/api/Devices.ts

@@ -1,31 +1,19 @@
 import { Type } from '@sinclair/typebox'
 import { Context } from './Context.js'
 import { PublicDeviceId } from './DeviceId.js'
-import { LwM2MObjectID, models } from '@hello.nrfcloud.com/proto-map'
+import { models } from '@hello.nrfcloud.com/proto-map'
+import {
+	ObjectID,
+	ObjectInstanceID,
+	ObjectVersion,
+	Resources,
+} from './LwM2M.js'
 
 export const LwM2MObjectInstance = Type.Object({
-	ObjectID: Type.Enum(LwM2MObjectID, {
-		description:
-			'The LwM2M Object IDs defined in @hello.nrfcloud.com/proto-map',
-	}),
-	ObjectVersion: Type.Optional(
-		Type.String({
-			pattern: '^[0-9]+.[0-9]+$',
-			default: '1.0',
-			description:
-				"The Object Version of an Object is composed of 2 digits separated by a dot '.'.\nSee https://www.openmobilealliance.org/release/LightweightM2M/V1_1_1-20190617-A/OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A.pdf Section 7.2.2",
-		}),
-	),
-	ObjectInstanceID: Type.Optional(
-		Type.Integer({
-			minimum: 0,
-			default: 0,
-		}),
-	),
-	Resources: Type.Record(
-		Type.Integer({ minimum: 0 }),
-		Type.Union([Type.String(), Type.Number(), Type.Boolean()]),
-	),
+	ObjectID,
+	ObjectVersion: Type.Optional(ObjectVersion),
+	ObjectInstanceID: Type.Optional(ObjectInstanceID),
+	Resources,
 })
 
 export const Model = Type.Union(

package/api/History.spec.ts

@@ -0,0 +1,36 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { validate } from '../validate.js'
+import { ResourceHistory } from './History.js'
+import type { Static } from '@sinclair/typebox'
+
+void describe('ResourceHistory', () => {
+	void it('should validate', () => {
+		const input: Static<typeof ResourceHistory> = {
+			'@context':
+				'https://github.com/hello-nrfcloud/proto-map/history/resource',
+			query: {
+				ObjectID: 14230,
+				ObjectVersion: '1.0',
+				ObjectInstanceID: 0,
+				deviceId: 'bassetto-ennobler-toilless',
+				binIntervalMinutes: 15,
+			},
+			partialInstances: [
+				{
+					'0': 92.2,
+					'99': 1713510000000,
+					ts: '2024-04-19T08:45:00.000Z',
+				},
+				{
+					'0': 113.8,
+					'99': 1713515400000,
+					ts: '2024-04-19T08:30:00.000Z',
+				},
+			],
+		}
+		const maybeValid = validate(ResourceHistory)(input)
+		assert.equal('errors' in maybeValid, false)
+		assert.deepEqual('value' in maybeValid && maybeValid.value, input)
+	})
+})

package/api/History.ts

@@ -0,0 +1,54 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import {
+	ObjectID,
+	ObjectInstanceID,
+	ObjectVersion,
+	Resources,
+} from './LwM2M.js'
+import { PublicDeviceId } from './DeviceId.js'
+
+export const 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'],
+							},
+						),
+					}),
+				],
+				{
+					title:
+						'The resources of the object instance and the timestamp the data was received.',
+				},
+			),
+		),
+		query: Type.Object(
+			{
+				ObjectID,
+				ObjectInstanceID,
+				ObjectVersion,
+				binIntervalMinutes: Type.Number({
+					minimum: 1,
+					title: 'The number of minutes the results are binned to.',
+					examples: [15],
+				}),
+				deviceId: PublicDeviceId,
+			},
+			{ title: `The query that was used` },
+		),
+	},
+	{
+		title: 'Resource history',
+		description:
+			'Contains historical values of an LwM2M resource for a device.',
+	},
+)

package/api/LwM2M.ts

@@ -0,0 +1,30 @@
+import { Type } from '@sinclair/typebox'
+import { LwM2MObjectID } from 'lwm2m/LwM2MObjectID.js'
+
+export const ObjectVersion = Type.String({
+	pattern: '^[0-9]+.[0-9]+$',
+	default: '1.0',
+	examples: ['1.0', '1.1'],
+	description:
+		"The Object Version of an Object is composed of 2 digits separated by a dot '.'.\nSee https://www.openmobilealliance.org/release/LightweightM2M/V1_1_1-20190617-A/OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A.pdf Section 7.2.2",
+})
+
+export const ObjectID = Type.Enum(LwM2MObjectID, {
+	description: 'The LwM2M Object IDs defined in @hello.nrfcloud.com/proto-map',
+})
+
+export const ObjectInstanceID = Type.Integer({
+	minimum: 0,
+	default: 0,
+	description: 'The LwM2M Object Instance ID',
+	examples: [0, 1],
+})
+
+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' }),
+	]),
+)

package/api/index.ts

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

package/dist/api/Context.js

@@ -2,6 +2,9 @@ var baseURL = "https://github.com/hello-nrfcloud/proto-map";
 export var Context = {
     device: new URL("".concat(baseURL, "/device")),
     devices: new URL("".concat(baseURL, "/devices")),
+    history: {
+        resource: new URL("".concat(baseURL, "/history/resource"))
+    },
     shareDevice: {
         request: new URL("".concat(baseURL, "/share-device-request")),
         ownershipConfirmed: new URL("".concat(baseURL, "/share-device-ownership-confirmed"))

package/dist/api/DeviceId.js

@@ -1,9 +1,15 @@
 import { Type } from "@sinclair/typebox";
 export var DeviceId = Type.RegExp(/^[a-zA-Z0-9:_-]{1,128}$/, {
     title: "Device ID",
-    description: "Must follow the AWS IoT limitations for Thing names."
+    description: "Must follow the AWS IoT limitations for Thing names.",
+    examples: [
+        "oob-352656166666905"
+    ]
 });
 export var PublicDeviceId = Type.RegExp(/^[a-z]{8}-[a-z]{8}-[a-z]{8}$/, {
     title: "Public Device ID",
-    description: "This is the format of @nordicsemiconductor/random-words which is used for public IDs."
+    description: "This is the format of @nordicsemiconductor/random-words which is used for public IDs.",
+    examples: [
+        "pentacid-coxalgia-backheel"
+    ]
 });

package/dist/api/Devices.js

@@ -1,27 +1,13 @@
 import { Type } from "@sinclair/typebox";
 import { Context } from "./Context.js";
 import { PublicDeviceId } from "./DeviceId.js";
-import { LwM2MObjectID, models } from "@hello.nrfcloud.com/proto-map";
+import { models } from "@hello.nrfcloud.com/proto-map";
+import { ObjectID, ObjectInstanceID, ObjectVersion, Resources } from "./LwM2M.js";
 export var LwM2MObjectInstance = Type.Object({
-    ObjectID: Type.Enum(LwM2MObjectID, {
-        description: "The LwM2M Object IDs defined in @hello.nrfcloud.com/proto-map"
-    }),
-    ObjectVersion: Type.Optional(Type.String({
-        pattern: "^[0-9]+.[0-9]+$",
-        default: "1.0",
-        description: "The Object Version of an Object is composed of 2 digits separated by a dot '.'.\nSee https://www.openmobilealliance.org/release/LightweightM2M/V1_1_1-20190617-A/OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A.pdf Section 7.2.2"
-    })),
-    ObjectInstanceID: Type.Optional(Type.Integer({
-        minimum: 0,
-        default: 0
-    })),
-    Resources: Type.Record(Type.Integer({
-        minimum: 0
-    }), Type.Union([
-        Type.String(),
-        Type.Number(),
-        Type.Boolean()
-    ]))
+    ObjectID: ObjectID,
+    ObjectVersion: Type.Optional(ObjectVersion),
+    ObjectInstanceID: Type.Optional(ObjectInstanceID),
+    Resources: Resources
 });
 export var Model = Type.Union(Object.keys(models).map(function(s) {
     return Type.Literal(s);

package/dist/api/History.js

@@ -0,0 +1,38 @@
+import { Type } from "@sinclair/typebox";
+import { Context } from "./Context.js";
+import { ObjectID, ObjectInstanceID, ObjectVersion, Resources } from "./LwM2M.js";
+import { PublicDeviceId } from "./DeviceId.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"
+                ]
+            })
+        })
+    ], {
+        title: "The resources of the object instance and the timestamp the data was received."
+    })),
+    query: Type.Object({
+        ObjectID: ObjectID,
+        ObjectInstanceID: ObjectInstanceID,
+        ObjectVersion: ObjectVersion,
+        binIntervalMinutes: Type.Number({
+            minimum: 1,
+            title: "The number of minutes the results are binned to.",
+            examples: [
+                15
+            ]
+        }),
+        deviceId: PublicDeviceId
+    }, {
+        title: "The query that was used"
+    })
+}, {
+    title: "Resource history",
+    description: "Contains historical values of an LwM2M resource for a device."
+});

package/dist/api/History.spec.js

@@ -0,0 +1,33 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { validate } from "../validate.js";
+import { ResourceHistory } from "./History.js";
+void describe("ResourceHistory", function() {
+    void it("should validate", function() {
+        var input = {
+            "@context": "https://github.com/hello-nrfcloud/proto-map/history/resource",
+            query: {
+                ObjectID: 14230,
+                ObjectVersion: "1.0",
+                ObjectInstanceID: 0,
+                deviceId: "bassetto-ennobler-toilless",
+                binIntervalMinutes: 15
+            },
+            partialInstances: [
+                {
+                    "0": 92.2,
+                    "99": 1713510000000,
+                    ts: "2024-04-19T08:45:00.000Z"
+                },
+                {
+                    "0": 113.8,
+                    "99": 1713515400000,
+                    ts: "2024-04-19T08:30:00.000Z"
+                }
+            ]
+        };
+        var maybeValid = validate(ResourceHistory)(input);
+        assert.equal("errors" in maybeValid, false);
+        assert.deepEqual("value" in maybeValid && maybeValid.value, input);
+    });
+});

package/dist/api/LwM2M.js

@@ -0,0 +1,37 @@
+import { Type } from "@sinclair/typebox";
+import { LwM2MObjectID } from "lwm2m/LwM2MObjectID.js";
+export var ObjectVersion = Type.String({
+    pattern: "^[0-9]+.[0-9]+$",
+    default: "1.0",
+    examples: [
+        "1.0",
+        "1.1"
+    ],
+    description: "The Object Version of an Object is composed of 2 digits separated by a dot '.'.\nSee https://www.openmobilealliance.org/release/LightweightM2M/V1_1_1-20190617-A/OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A.pdf Section 7.2.2"
+});
+export var ObjectID = Type.Enum(LwM2MObjectID, {
+    description: "The LwM2M Object IDs defined in @hello.nrfcloud.com/proto-map"
+});
+export var ObjectInstanceID = Type.Integer({
+    minimum: 0,
+    default: 0,
+    description: "The LwM2M Object Instance ID",
+    examples: [
+        0,
+        1
+    ]
+});
+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"
+    })
+]));

package/dist/api/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "5.3.2",
+  "version": "5.4.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -43,7 +43,7 @@
     "@bifravst/prettier-config": "1.0.0",
     "@commitlint/config-conventional": "19.2.2",
     "@swc/cli": "0.3.12",
-    "@swc/core": "1.4.15",
+    "@swc/core": "1.4.16",
     "@types/node": "20.12.7",
     "@types/xml2js": "0.4.14",
     "chalk": "5.3.0",