@hello.nrfcloud.com/proto-map 16.0.4 → 16.1.0

package/api/Context.ts

@@ -4,6 +4,7 @@ export const Context = {
 	device: new URL(`${baseURL}/device`),
 	deviceCredentials: new URL(`${baseURL}/device/credentials`),
 	devices: new URL(`${baseURL}/devices`),
+	userDevices: new URL(`${baseURL}/user-devices`),
 	deviceJWT: new URL(`${baseURL}/device-jwt`),
 	userJWT: new URL(`${baseURL}/user-jwt`),
 	apiHealth: new URL(`${baseURL}/api/health`),

package/api/IsoDateType.spec.ts

@@ -0,0 +1,19 @@
+import { IsoDateType } from './IsoDateType.js'
+import { describe, test as it } from 'node:test'
+import assert from 'node:assert/strict'
+import { validate } from '../validate.js'
+
+void describe('isoDateRegExp', () => {
+	void it('should match a date string', () => {
+		const isoTs = new Date().toISOString()
+		const maybeValid = validate(IsoDateType())(isoTs)
+		assert.equal('errors' in maybeValid, false)
+		assert.equal('value' in maybeValid && maybeValid?.value, isoTs)
+	})
+	void it('should validate a date string with local timezone', () => {
+		const isoTs = '2024-07-01T16:33:15+02:00'
+		const maybeValid = validate(IsoDateType())(isoTs)
+		assert.equal('errors' in maybeValid, false)
+		assert.equal('value' in maybeValid && maybeValid?.value, isoTs)
+	})
+})

package/api/IsoDateType.ts

@@ -0,0 +1,9 @@
+import { Type, type TString } from '@sinclair/typebox'
+
+export const IsoDateType = (description?: string): TString =>
+	Type.String({
+		pattern:
+			'^([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}(?:.[0-9]*)?)(([+-]([0-9]{2}):([0-9]{2})|Z)?)$',
+		description: description ?? 'A date formatted as an ISO 8601 string',
+		examples: [new Date().toISOString()],
+	})

package/api/UserDevices.ts

@@ -0,0 +1,19 @@
+import { Type } from '@sinclair/typebox'
+import { Context } from './Context.js'
+import { DeviceId, PublicDeviceId } from './DeviceId.js'
+import { IsoDateType } from './IsoDateType.js'
+import { Model } from './Devices.js'
+
+export const UserDevices = Type.Object({
+	'@context': Type.Literal(Context.userDevices.toString()),
+	devices: Type.Array(
+		Type.Object({
+			id: PublicDeviceId,
+			deviceId: DeviceId,
+			model: Model,
+			expires: IsoDateType(
+				'The date when the device will be removed from the list of devices',
+			),
+		}),
+	),
+})

package/api/index.ts

@@ -7,3 +7,5 @@ export * from './UserJWT.js'
 export * from './APIHealth.js'
 export * from './DeviceCredentials.js'
 export * from './Email.js'
+export * from './IsoDateType.js'
+export * from './UserDevices.js'

package/dist/api/Context.js

@@ -3,6 +3,7 @@ export var Context = {
     device: new URL("".concat(baseURL, "/device")),
     deviceCredentials: new URL("".concat(baseURL, "/device/credentials")),
     devices: new URL("".concat(baseURL, "/devices")),
+    userDevices: new URL("".concat(baseURL, "/user-devices")),
     deviceJWT: new URL("".concat(baseURL, "/device-jwt")),
     userJWT: new URL("".concat(baseURL, "/user-jwt")),
     apiHealth: new URL("".concat(baseURL, "/api/health"))

package/dist/api/IsoDateType.js

@@ -0,0 +1,10 @@
+import { Type } from '@sinclair/typebox';
+export var IsoDateType = function(description) {
+    return Type.String({
+        pattern: '^([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}(?:.[0-9]*)?)(([+-]([0-9]{2}):([0-9]{2})|Z)?)$',
+        description: description !== null && description !== void 0 ? description : 'A date formatted as an ISO 8601 string',
+        examples: [
+            new Date().toISOString()
+        ]
+    });
+};

package/dist/api/IsoDateType.spec.js

@@ -0,0 +1,18 @@
+import { IsoDateType } from './IsoDateType.js';
+import { describe, test as it } from 'node:test';
+import assert from 'node:assert/strict';
+import { validate } from '../validate.js';
+void describe('isoDateRegExp', function() {
+    void it('should match a date string', function() {
+        var isoTs = new Date().toISOString();
+        var maybeValid = validate(IsoDateType())(isoTs);
+        assert.equal('errors' in maybeValid, false);
+        assert.equal('value' in maybeValid && (maybeValid === null || maybeValid === void 0 ? void 0 : maybeValid.value), isoTs);
+    });
+    void it('should validate a date string with local timezone', function() {
+        var isoTs = '2024-07-01T16:33:15+02:00';
+        var maybeValid = validate(IsoDateType())(isoTs);
+        assert.equal('errors' in maybeValid, false);
+        assert.equal('value' in maybeValid && (maybeValid === null || maybeValid === void 0 ? void 0 : maybeValid.value), isoTs);
+    });
+});

package/dist/api/UserDevices.js

@@ -0,0 +1,14 @@
+import { Type } from '@sinclair/typebox';
+import { Context } from './Context.js';
+import { DeviceId, PublicDeviceId } from './DeviceId.js';
+import { IsoDateType } from './IsoDateType.js';
+import { Model } from './Devices.js';
+export var UserDevices = Type.Object({
+    '@context': Type.Literal(Context.userDevices.toString()),
+    devices: Type.Array(Type.Object({
+        id: PublicDeviceId,
+        deviceId: DeviceId,
+        model: Model,
+        expires: IsoDateType('The date when the device will be removed from the list of devices')
+    }))
+});

package/dist/api/index.js

@@ -7,3 +7,5 @@ export * from './UserJWT.js';
 export * from './APIHealth.js';
 export * from './DeviceCredentials.js';
 export * from './Email.js';
+export * from './IsoDateType.js';
+export * from './UserDevices.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/proto-map",
-  "version": "16.0.4",
+  "version": "16.1.0",
   "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
   "type": "module",
   "exports": {
@@ -39,8 +39,8 @@
     "@bifravst/prettier-config": "1.1.0",
     "@commitlint/config-conventional": "19.2.2",
     "@swc/cli": "0.4.0",
-    "@swc/core": "1.7.6",
-    "@types/node": "22.1.0",
+    "@swc/core": "1.7.10",
+    "@types/node": "22.2.0",
     "@types/xml2js": "0.4.14",
     "chalk": "5.3.0",
     "globstar": "1.0.0",
@@ -98,6 +98,6 @@
     "lwm2m"
   ],
   "peerDependencies": {
-    "@sinclair/typebox": "^0.33.3"
+    "@sinclair/typebox": "^0.33.4"
   }
 }