@hello.nrfcloud.com/proto-map 5.2.0 → 5.2.2

package/api/Context.ts

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

package/api/DeviceId.ts

@@ -0,0 +1,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.',
+})
+
+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.',
+})

package/api/Devices.ts

@@ -0,0 +1,53 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import { PublicDeviceId } from './DeviceId.js'
+import { LwM2MObjectID, models } from '@hello.nrfcloud.com/proto-map'
+
+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()]),
+	),
+})
+
+export const Model = Type.Union(
+	Object.keys(models).map((s) => Type.Literal(s)),
+	{
+		title: 'Model',
+		description:
+			'Must be one of the models defined in @hello.nrfcloud.com/proto-map',
+	},
+)
+
+export const PublicDevice = Type.Object(
+	{
+		'@context': Type.Literal(Context.device.toString()),
+		id: PublicDeviceId,
+		model: Model,
+		state: Type.Optional(Type.Array(LwM2MObjectInstance)),
+	},
+	{ title: 'Public device', description: 'A device that is publicly visible.' },
+)
+
+export const Devices = Type.Object({
+	'@context': Type.Literal(Context.devices.toString()),
+	devices: Type.Array(PublicDevice),
+})

package/api/ShareDeviceOwnershipConfirmed.ts

@@ -0,0 +1,8 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import { DeviceId } from './DeviceId.js'
+
+export const ShareDeviceOwnershipConfirmed = Type.Object({
+	'@context': Type.Literal(Context.shareDevice.ownershipConfirmed.toString()),
+	id: DeviceId,
+})

package/api/ShareDeviceRequest.ts

@@ -0,0 +1,8 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import { PublicDeviceId } from './DeviceId.js'
+
+export const ShareDeviceRequest = Type.Object({
+	'@context': Type.Literal(Context.shareDevice.request.toString()),
+	id: PublicDeviceId,
+})

package/api/index.ts

@@ -0,0 +1,5 @@
+export * from './Context.js'
+export * from './DeviceId.js'
+export * from './Devices.js'
+export * from './ShareDeviceOwnershipConfirmed.js'
+export * from './ShareDeviceRequest.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -10,7 +10,7 @@
     },
     "./*": {
       "default": "./dist/*/index.js",
-      "types": "./dist/*/index.d.ts"
+      "types": "./*/index.ts"
     }
   },
   "repository": {
@@ -103,6 +103,7 @@
     "dist",
     "export.js",
     "index.d.ts",
+    "api",
     "senml",
     "models",
     "lwm2m"