@hello.nrfcloud.com/proto-map 13.2.2 → 14.0.0

package/api/APIHealth.ts

@@ -0,0 +1,14 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+
+export const APIHealth = Type.Object(
+	{
+		'@context': Type.Literal(Context.apiHealth.toString()),
+		version: Type.String({
+			title: 'Version',
+			minLength: 1,
+			description: 'The version of the API.',
+		}),
+	},
+	{ title: 'APIHealth', description: 'Information about the API.' },
+)

package/api/Context.ts

@@ -3,9 +3,10 @@ const baseURL = `https://github.com/hello-nrfcloud/proto-map`
 export const Context = {
 	device: new URL(`${baseURL}/device`),
 	devices: new URL(`${baseURL}/devices`),
+	deviceJWT: new URL(`${baseURL}/device-jwt`),
 	shareDevice: {
 		request: new URL(`${baseURL}/share-device-request`),
 		ownershipConfirmed: new URL(`${baseURL}/share-device-ownership-confirmed`),
 	},
-	named: (name: string): URL => new URL(`${baseURL}/${name}`),
+	apiHealth: new URL(`${baseURL}/api/health`),
 }

package/api/DeviceId.ts

@@ -9,6 +9,6 @@ export const DeviceId = Type.RegExp(/^[a-zA-Z0-9:_-]{1,128}$/, {
 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.',
+		'This is the format of @bifravst/random-words which is used for public IDs.',
 	examples: ['pentacid-coxalgia-backheel'],
 })

package/api/DeviceJWT.ts

@@ -0,0 +1,22 @@
+import { Type } from '@sinclair/typebox'
+import { DeviceId, PublicDeviceId } from './DeviceId.js'
+import { Model } from './Devices.js'
+import { Context } from './Context.js'
+
+export const DeviceJWT = Type.Object(
+	{
+		'@context': Type.Literal(Context.deviceJWT.toString()),
+		id: PublicDeviceId,
+		deviceId: DeviceId,
+		model: Model,
+		jwt: Type.String({
+			title: 'JWT',
+			minLength: 5,
+			description: 'The JWT for a publicly shared device.',
+			examples: [
+				'eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImEyMGM0NzZkLTVlZjUtNDE1NS1iODllLTdkZWRiMzJjODVhNCJ9.eyJpZCI6ImQ0OThkNzZhLWQ0ZjktNGQ4YS1iMTYwLTNlODA5NGMzOGNmYSIsImRldmljZUlkIjoidGFsbXVkaWMtb3ZlcnJhdGUtcGVuc2l2ZWQiLCJtb2RlbCI6InRoaW5neTkxeCIsImlhdCI6MTcyMTI4NjA1NywiZXhwIjoxNzIxMjg5NjU3LCJhdWQiOiJoZWxsby5ucmZjbG91ZC5jb20ifQ.Afn2Vj7V4boatn3Dwf4yZCTh09lTpfAEfsaX2uTZv0z2EvcWVH3CeVVsEmvCtDb8mnpvxJcj88-l9PlJqShKzZF5AShz6Ps0Igkzm0PueGjK-nq12I8DTgraT6fdSB3v5ALzLC9ozwyuPN7kJDLMHMHkO3j24sveBvFLg2BLsharSRBN',
+			],
+		}),
+	},
+	{ title: 'DeviceJWT', description: 'The JWT for a publicly shared device.' },
+)

package/api/Devices.ts

@@ -1,6 +1,6 @@
 import { Type } from '@sinclair/typebox'
 import { Context } from './Context.js'
-import { PublicDeviceId } from './DeviceId.js'
+import { DeviceId, PublicDeviceId } from './DeviceId.js'
 import {
 	ObjectID,
 	ObjectInstanceID,
@@ -29,6 +29,7 @@ export const PublicDevice = Type.Object(
 	{
 		'@context': Type.Literal(Context.device.toString()),
 		id: PublicDeviceId,
+		deviceId: DeviceId,
 		model: Model,
 		state: Type.Optional(Type.Array(LwM2MObjectInstance)),
 	},

package/api/index.ts

@@ -4,3 +4,5 @@ export * from './Devices.js'
 export * from './ShareDeviceOwnershipConfirmed.js'
 export * from './ShareDeviceRequest.js'
 export * from './LwM2M.js'
+export * from './DeviceJWT.js'
+export * from './APIHealth.js'

package/dist/api/APIHealth.js

@@ -0,0 +1,13 @@
+import { Type } from '@sinclair/typebox';
+import { Context } from './Context.js';
+export var APIHealth = Type.Object({
+    '@context': Type.Literal(Context.apiHealth.toString()),
+    version: Type.String({
+        title: 'Version',
+        minLength: 1,
+        description: 'The version of the API.'
+    })
+}, {
+    title: 'APIHealth',
+    description: 'Information about the API.'
+});

package/dist/api/Context.js

@@ -2,11 +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")),
+    deviceJWT: new URL("".concat(baseURL, "/device-jwt")),
     shareDevice: {
         request: new URL("".concat(baseURL, "/share-device-request")),
         ownershipConfirmed: new URL("".concat(baseURL, "/share-device-ownership-confirmed"))
     },
-    named: function(name) {
-        return new URL("".concat(baseURL, "/").concat(name));
-    }
+    apiHealth: new URL("".concat(baseURL, "/api/health"))
 };

package/dist/api/DeviceId.js

@@ -8,7 +8,7 @@ export var DeviceId = Type.RegExp(/^[a-zA-Z0-9:_-]{1,128}$/, {
 });
 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 @bifravst/random-words which is used for public IDs.',
     examples: [
         'pentacid-coxalgia-backheel'
     ]

package/dist/api/DeviceJWT.js

@@ -0,0 +1,21 @@
+import { Type } from '@sinclair/typebox';
+import { DeviceId, PublicDeviceId } from './DeviceId.js';
+import { Model } from './Devices.js';
+import { Context } from './Context.js';
+export var DeviceJWT = Type.Object({
+    '@context': Type.Literal(Context.deviceJWT.toString()),
+    id: PublicDeviceId,
+    deviceId: DeviceId,
+    model: Model,
+    jwt: Type.String({
+        title: 'JWT',
+        minLength: 5,
+        description: 'The JWT for a publicly shared device.',
+        examples: [
+            'eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImEyMGM0NzZkLTVlZjUtNDE1NS1iODllLTdkZWRiMzJjODVhNCJ9.eyJpZCI6ImQ0OThkNzZhLWQ0ZjktNGQ4YS1iMTYwLTNlODA5NGMzOGNmYSIsImRldmljZUlkIjoidGFsbXVkaWMtb3ZlcnJhdGUtcGVuc2l2ZWQiLCJtb2RlbCI6InRoaW5neTkxeCIsImlhdCI6MTcyMTI4NjA1NywiZXhwIjoxNzIxMjg5NjU3LCJhdWQiOiJoZWxsby5ucmZjbG91ZC5jb20ifQ.Afn2Vj7V4boatn3Dwf4yZCTh09lTpfAEfsaX2uTZv0z2EvcWVH3CeVVsEmvCtDb8mnpvxJcj88-l9PlJqShKzZF5AShz6Ps0Igkzm0PueGjK-nq12I8DTgraT6fdSB3v5ALzLC9ozwyuPN7kJDLMHMHkO3j24sveBvFLg2BLsharSRBN'
+        ]
+    })
+}, {
+    title: 'DeviceJWT',
+    description: 'The JWT for a publicly shared device.'
+});

package/dist/api/Devices.js

@@ -1,6 +1,6 @@
 import { Type } from '@sinclair/typebox';
 import { Context } from './Context.js';
-import { PublicDeviceId } from './DeviceId.js';
+import { DeviceId, PublicDeviceId } from './DeviceId.js';
 import { ObjectID, ObjectInstanceID, ObjectVersion, Resources } from './LwM2M.js';
 import { models } from '../models/models.js';
 export var LwM2MObjectInstance = Type.Object({
@@ -18,6 +18,7 @@ export var Model = Type.Union(Object.keys(models).map(function(s) {
 export var PublicDevice = Type.Object({
     '@context': Type.Literal(Context.device.toString()),
     id: PublicDeviceId,
+    deviceId: DeviceId,
     model: Model,
     state: Type.Optional(Type.Array(LwM2MObjectInstance))
 }, {

package/dist/api/index.js

@@ -4,3 +4,5 @@ export * from './Devices.js';
 export * from './ShareDeviceOwnershipConfirmed.js';
 export * from './ShareDeviceRequest.js';
 export * from './LwM2M.js';
+export * from './DeviceJWT.js';
+export * from './APIHealth.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "13.2.2",
+  "version": "14.0.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -35,16 +35,16 @@
     "prepublishOnly": "./compile.sh"
   },
   "devDependencies": {
-    "@bifravst/eslint-config-typescript": "6.1.8",
-    "@bifravst/prettier-config": "1.0.3",
+    "@bifravst/eslint-config-typescript": "6.1.10",
+    "@bifravst/prettier-config": "1.0.4",
     "@commitlint/config-conventional": "19.2.2",
     "@swc/cli": "0.4.0",
-    "@swc/core": "1.6.6",
-    "@types/node": "20.14.9",
+    "@swc/core": "1.7.0",
+    "@types/node": "20.14.11",
     "@types/xml2js": "0.4.14",
     "chalk": "5.3.0",
     "globstar": "1.0.0",
-    "husky": "9.0.11",
+    "husky": "9.1.0",
     "lint-staged": "15.2.7",
     "prettier-plugin-organize-imports": "4.0.0",
     "remark": "15.0.1",