feat: add FOTA support

Author: coderbyheart

src/api/createFOTAJob.ts

@@ -0,0 +1,60 @@
+import { Type, type Static } from '@sinclair/typebox'
+import { JSONPayload, validatedFetch } from './validatedFetch.js'
+import type { ValidationError } from 'ajv'
+
+const FOTAJobType = Type.Object(
+	{
+		jobId: Type.String({
+			minLength: 1,
+			title: 'ID',
+			description: 'Universally unique identifier',
+			examples: ['bc631093-7f7c-4c1b-aa63-a68c759bcd5c'],
+		}),
+	},
+	{
+		title: 'FOTA Job',
+		description:
+			'See https://api.nrfcloud.com/#tag/FOTA-Jobs/operation/CreateFOTAJob',
+	},
+)
+export const createFOTAJob =
+	(
+		{
+			apiKey,
+			endpoint,
+		}: {
+			apiKey: string
+			endpoint: URL
+		},
+		fetchImplementation?: typeof fetch,
+	) =>
+	async ({
+		deviceId,
+		bundleId,
+	}: {
+		deviceId: string
+		bundleId: string
+	}): Promise<
+		{ error: Error | ValidationError } | { result: Static<typeof FOTAJobType> }
+	> => {
+		const maybeJob = await validatedFetch(
+			{
+				endpoint,
+				apiKey,
+			},
+			fetchImplementation,
+		)(
+			{
+				resource: 'fota-jobs',
+				payload: JSONPayload({
+					bundleId,
+					autoApply: 'true',
+					deviceIds: [deviceId],
+				}),
+			},
+			FOTAJobType,
+		)
+
+		if ('error' in maybeJob) return maybeJob
+		return maybeJob
+	}

src/api/fetchFOTAJob.ts

@@ -0,0 +1,75 @@
+import { Type, type Static } from '@sinclair/typebox'
+import type { ValidationError } from 'ajv'
+import { validatedFetch } from './validatedFetch.js'
+
+export enum FOTAJobStatus {
+	CREATED = 'CREATED',
+	IN_PROGRESS = 'IN_PROGRESS',
+	CANCELLED = 'CANCELLED',
+	DELETION_IN_PROGRESS = 'DELETION_IN_PROGRESS',
+	COMPLETED = 'COMPLETED',
+}
+
+const ts = Type.String({
+	title: 'Timestamp',
+	description: 'ISO-8601 date-time string',
+	examples: ['2019-08-24T14:15:22Z'],
+})
+
+export const FOTAJobType = Type.Object(
+	{
+		jobId: Type.String({
+			minLength: 1,
+			title: 'ID',
+			description: 'Universally unique identifier',
+			examples: ['bc631093-7f7c-4c1b-aa63-a68c759bcd5c'],
+		}),
+		status: Type.Enum(FOTAJobStatus, {
+			title: 'Status',
+			description: 'Current status of the job',
+		}),
+		statusDetail: Type.Optional(Type.String({ minLength: 1 })),
+		createdAt: ts,
+		lastUpdatedAt: Type.Optional(ts),
+		completedAt: Type.Optional(ts),
+	},
+	{
+		title: 'FOTA Job',
+		description:
+			'See https://api.nrfcloud.com/#tag/FOTA-Jobs/operation/FetchFOTAJob',
+	},
+)
+export const fetchFOTAJob =
+	(
+		{
+			apiKey,
+			endpoint,
+		}: {
+			apiKey: string
+			endpoint: URL
+		},
+		fetchImplementation?: typeof fetch,
+	) =>
+	async ({
+		jobId,
+	}: {
+		jobId: string
+	}): Promise<
+		{ error: Error | ValidationError } | { result: Static<typeof FOTAJobType> }
+	> => {
+		const maybeJob = await validatedFetch(
+			{
+				endpoint,
+				apiKey,
+			},
+			fetchImplementation,
+		)(
+			{
+				resource: `fota-jobs/${jobId}`,
+			},
+			FOTAJobType,
+		)
+
+		if ('error' in maybeJob) return maybeJob
+		return maybeJob
+	}

src/api/index.ts

@@ -11,3 +11,5 @@ export * from './DeviceShadow.js'
 export * from './serviceToken.js'
 export * from './groundFix.js'
 export * from './bulkOps.js'
+export * from './createFOTAJob.js'
+export * from './fetchFOTAJob.js'