@hello.nrfcloud.com/nrfcloud-api-helpers 4.0.2 → 4.1.0

package/dist/api/createFOTAJob.d.ts

@@ -0,0 +1,17 @@
+import { type Static } from '@sinclair/typebox';
+import type { ValidationError } from 'ajv';
+declare const FOTAJobType: import("@sinclair/typebox").TObject<{
+    jobId: import("@sinclair/typebox").TString;
+}>;
+export declare const createFOTAJob: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => ({ deviceId, bundleId, }: {
+    deviceId: string;
+    bundleId: string;
+}) => Promise<{
+    error: Error | ValidationError;
+} | {
+    result: Static<typeof FOTAJobType>;
+}>;
+export {};

package/dist/api/createFOTAJob.js

@@ -0,0 +1,29 @@
+import { Type } from '@sinclair/typebox';
+import { JSONPayload, validatedFetch } from './validatedFetch.js';
+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, }, fetchImplementation) => async ({ deviceId, bundleId, }) => {
+    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;
+};

package/dist/api/fetchFOTAJob.d.ts

@@ -0,0 +1,27 @@
+import { type Static } from '@sinclair/typebox';
+import type { ValidationError } from 'ajv';
+export declare enum FOTAJobStatus {
+    CREATED = "CREATED",
+    IN_PROGRESS = "IN_PROGRESS",
+    CANCELLED = "CANCELLED",
+    DELETION_IN_PROGRESS = "DELETION_IN_PROGRESS",
+    COMPLETED = "COMPLETED"
+}
+export declare const FOTAJobType: import("@sinclair/typebox").TObject<{
+    jobId: import("@sinclair/typebox").TString;
+    status: import("@sinclair/typebox").TEnum<typeof FOTAJobStatus>;
+    statusDetail: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    createdAt: import("@sinclair/typebox").TString;
+    lastUpdatedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    completedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const fetchFOTAJob: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => ({ jobId, }: {
+    jobId: string;
+}) => Promise<{
+    error: Error | ValidationError;
+} | {
+    result: Static<typeof FOTAJobType>;
+}>;

package/dist/api/fetchFOTAJob.js

@@ -0,0 +1,45 @@
+import { Type } from '@sinclair/typebox';
+import { validatedFetch } from './validatedFetch.js';
+export var FOTAJobStatus;
+(function (FOTAJobStatus) {
+    FOTAJobStatus["CREATED"] = "CREATED";
+    FOTAJobStatus["IN_PROGRESS"] = "IN_PROGRESS";
+    FOTAJobStatus["CANCELLED"] = "CANCELLED";
+    FOTAJobStatus["DELETION_IN_PROGRESS"] = "DELETION_IN_PROGRESS";
+    FOTAJobStatus["COMPLETED"] = "COMPLETED";
+})(FOTAJobStatus || (FOTAJobStatus = {}));
+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, }, fetchImplementation) => async ({ jobId, }) => {
+    const maybeJob = await validatedFetch({
+        endpoint,
+        apiKey,
+    }, fetchImplementation)({
+        resource: `fota-jobs/${jobId}`,
+    }, FOTAJobType);
+    if ('error' in maybeJob)
+        return maybeJob;
+    return maybeJob;
+};

package/dist/api/index.d.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';

package/dist/api/index.js

@@ -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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -36,7 +36,7 @@
     "@bifravst/prettier-config": "1.0.1",
     "@commitlint/config-conventional": "19.2.2",
     "@types/aws-lambda": "8.10.138",
-    "@types/node": "20.14.1",
+    "@types/node": "20.14.2",
     "husky": "9.0.11",
     "tsmatchers": "5.0.2",
     "tsx": "4.11.2"
@@ -86,7 +86,7 @@
     "@aws-sdk/client-ssm": "^3.590.0",
     "@aws-sdk/util-dynamodb": "^3.590.0",
     "@bifravst/aws-ssm-settings-helpers": "^1.1.27",
-    "@hello.nrfcloud.com/proto": "^13.0.8",
+    "@hello.nrfcloud.com/proto": "^13.0.9",
     "@sinclair/typebox": "^0.32.31"
   }
 }