feat(api): include deviceId

Author: coderbyheart

devices/publicDevicesRepo.spec.ts

@@ -229,6 +229,7 @@ void describe('getById()', () => {
 
 		assert.deepEqual('device' in res && toPublic(res.device), {
 			id,
+			deviceId: 'some-device',
 			model: 'thingy91x',
 		})
 	})
@@ -249,11 +250,8 @@ void describe('toPublic()', () => {
 		})
 		assert.deepEqual(record, {
 			id,
+			deviceId: 'some-device',
 			model: ModelID.Thingy91x,
 		})
-		assert.equal(
-			Object.values(record as Record<string, any>).includes('some-device'),
-			false,
-		)
 	})
 })

devices/publicDevicesRepo.ts

@@ -269,7 +269,8 @@ export const publicDevicesRepo = ({
 
 export const toPublic = (
 	device: PublicDeviceRecord,
-): Pick<PublicDeviceRecord, 'id' | 'model'> => ({
+): Pick<PublicDeviceRecord, 'id' | 'deviceId' | 'model'> => ({
 	id: device.id,
+	deviceId: device.deviceId,
 	model: device.model,
 })

features/JWT.feature.md

@@ -21,9 +21,9 @@ public device id in `publicDeviceId`
 
 ## Retrieve the JWT
 
-When I `GET` to `${API}/device/${publicDeviceId}/jwt`
+When I `GET` to `${API}/device/${publicDeviceId}  `
 
-Then I should receive a `https://github.com/hello-nrfcloud/proto-map/jwt`
+Then I should receive a `https://github.com/hello-nrfcloud/proto-map/device-jwt`
 response
 
 And I store `jwt` of the last response into `jwt`

features/OOBMapShare.feature.md

@@ -75,13 +75,16 @@ And the last response should match
 ```json
 {
   "id": "${publicDeviceId}",
+  "deviceId": "${deviceId}",
   "model": "thingy91x"
 }
 ```
 
 ## The sharing status of a device can be checked using the fingerprint
 
-> Users should be able to determine whether a certain device is sharing data
+> Users should be able to determine whether a certain device is sharing data.
+>
+> This uses the fingerprint so it's not possible to just enumerate device IDs.
 
 When I `GET` to `${API}/share/status?fingerprint=${fingerprint}`
 
@@ -93,6 +96,7 @@ And the last response should match
 ```json
 {
   "id": "${publicDeviceId}",
+  "deviceId": "${deviceId}",
   "model": "thingy91x"
 }
 ```

lambda/apiHealthCheck.ts

@@ -1,21 +1,20 @@
+import { fromEnv } from '@bifravst/from-env'
 import { aResponse } from '@hello.nrfcloud.com/lambda-helpers/aResponse'
 import { addVersionHeader } from '@hello.nrfcloud.com/lambda-helpers/addVersionHeader'
 import { corsOPTIONS } from '@hello.nrfcloud.com/lambda-helpers/corsOPTIONS'
 import { Context } from '@hello.nrfcloud.com/proto-map/api'
 import middy from '@middy/core'
-import { fromEnv } from '@bifravst/from-env'
 import { type APIGatewayProxyResultV2 } from 'aws-lambda'
 
 const { version } = fromEnv({
 	version: 'VERSION',
 })(process.env)
 
-const h = async (): Promise<APIGatewayProxyResultV2> => {
-	return aResponse(200, {
-		'@context': Context.named('api/health'),
+const h = async (): Promise<APIGatewayProxyResultV2> =>
+	aResponse(200, {
+		'@context': Context.apiHealth,
 		version,
 	})
-}
 
 export const handler = middy()
 	.use(addVersionHeader(version))

lambda/deviceJwt.ts

@@ -69,7 +69,7 @@ const h = async (
 	return aResponse(
 		200,
 		{
-			'@context': Context.named('jwt'),
+			'@context': Context.deviceJWT,
 			id: maybeSharedDevice.device.id,
 			deviceId: maybeSharedDevice.device.deviceId,
 			model: maybeSharedDevice.device.model,

lambda/devicesData.ts

@@ -123,6 +123,7 @@ const h = async (
 
 	const devices: Array<{
 		id: string
+		deviceId: string
 		model: string
 		state?: Array<LwM2MObjectInstance>
 	}> = (
@@ -137,6 +138,7 @@ const h = async (
 					)
 					return {
 						id,
+						deviceId,
 						model,
 						state:
 							shadow.payload === undefined
@@ -151,7 +153,7 @@ const h = async (
 					} else {
 						console.error(err)
 					}
-					return { id, model }
+					return { id, deviceId, model }
 				}
 			}),
 		)