@hello.nrfcloud.com/proto-map 7.1.1 → 8.0.0

package/README.md

@@ -68,9 +68,9 @@ The conformity to the rules is checked using the script
 ### Model definition rules
 
 - **device models** are identified using a model name, for example
-  `PCA20035+solar`
-- a [`README.md`](./models/PCA20035+solar/README.md) must be provided that
-  describes the model
+  `kartverket-vasstandsdata`
+- a [`README.md`](./models/kartverket-vasstandsdata/README.md) must be provided
+  that describes the model
 
 The conformity to the rules is checked using the script
 [`./models/check-model-rules.ts`](./models/check-model-rules.ts).

package/api/Context.ts

@@ -3,13 +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`),
 	},
-	objectUpdate: new URL(`${baseURL}/object/update`),
 	named: (name: string): URL => new URL(`${baseURL}/${name}`),
 }

package/api/index.ts

@@ -3,6 +3,4 @@ export * from './DeviceId.js'
 export * from './Devices.js'
 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

@@ -2,14 +2,10 @@ 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"))
     },
-    objectUpdate: new URL("".concat(baseURL, "/object/update")),
     named: function(name) {
         return new URL("".concat(baseURL, "/").concat(name));
     }

package/dist/api/index.js

@@ -3,6 +3,4 @@ export * from './DeviceId.js';
 export * from './Devices.js';
 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": "7.1.1",
+  "version": "8.0.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -54,7 +54,7 @@
     "remark": "15.0.1",
     "remark-frontmatter": "5.0.0",
     "tsmatchers": "5.0.2",
-    "tsx": "4.7.2",
+    "tsx": "4.7.3",
     "xml2js": "0.6.2",
     "yaml": "2.4.1"
   },
@@ -104,7 +104,7 @@
     "lwm2m"
   ],
   "peerDependencies": {
-    "@sinclair/typebox": "^0.32.24",
+    "@sinclair/typebox": "^0.32.25",
     "ajv": "^8.12.0"
   }
 }

package/api/History.spec.ts

@@ -1,36 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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 ResourceHistory = Type.Object(
-	{
-		'@context': Type.Literal(Context.history.resource.toString()),
-		partialInstances: Type.Array(
-			Type.Intersect(
-				[
-					Resources,
-					Type.Object({
-						ts: Timestamp,
-					}),
-				],
-				{
-					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/ObjectUpdate.spec.ts

@@ -1,28 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-import { validate } from '../validate.js'
-import { ObjectUpdate } from './ObjectUpdate.js'
-import type { Static } from '@sinclair/typebox'
-
-void describe('ObjectUpdate', () => {
-	void it('should validate', () => {
-		const input: Static<typeof ObjectUpdate> = {
-			'@context': 'https://github.com/hello-nrfcloud/proto-map/object/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(ObjectUpdate)(input)
-		assert.equal('errors' in maybeValid, false)
-		assert.deepEqual('value' in maybeValid && maybeValid.value, input)
-	})
-})

package/api/ObjectUpdate.ts

@@ -1,26 +0,0 @@
-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 ObjectUpdate = Type.Object(
-	{
-		'@context': Type.Literal(Context.objectUpdate.toString()),
-		ObjectID,
-		ObjectInstanceID: Type.Optional(ObjectInstanceID),
-		ObjectVersion: Type.Optional(ObjectVersion),
-		Resources,
-		ts: Timestamp,
-		deviceId: PublicDeviceId,
-	},
-	{
-		title: 'Object update',
-		description: 'Describes an update to a LwM2M object for a device.',
-	},
-)

package/api/Timestamp.spec.ts

@@ -1,14 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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/dist/api/History.js

@@ -1,34 +0,0 @@
-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: Timestamp
-        })
-    ], {
-        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

@@ -1,33 +0,0 @@
-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/ObjectUpdate.js

@@ -1,17 +0,0 @@
-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 ObjectUpdate = Type.Object({
-    '@context': Type.Literal(Context.objectUpdate.toString()),
-    ObjectID: ObjectID,
-    ObjectInstanceID: Type.Optional(ObjectInstanceID),
-    ObjectVersion: Type.Optional(ObjectVersion),
-    Resources: Resources,
-    ts: Timestamp,
-    deviceId: PublicDeviceId
-}, {
-    title: 'Object update',
-    description: 'Describes an update to a LwM2M object for a device.'
-});

package/dist/api/ObjectUpdate.spec.js

@@ -1,26 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert/strict';
-import { validate } from '../validate.js';
-import { ObjectUpdate } from './ObjectUpdate.js';
-void describe('ObjectUpdate', function() {
-    void it('should validate', function() {
-        var input = {
-            '@context': 'https://github.com/hello-nrfcloud/proto-map/object/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(ObjectUpdate)(input);
-        assert.equal('errors' in maybeValid, false);
-        assert.deepEqual('value' in maybeValid && maybeValid.value, input);
-    });
-});

package/dist/api/Timestamp.js

@@ -1,7 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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);
-    });
-});