@hello.nrfcloud.com/nrfcloud-api-helpers 5.0.0 → 5.0.2

package/dist/api/devices.d.ts

@@ -20,7 +20,7 @@ declare const Devices: import("@sinclair/typebox").TObject<{
 /**
  * firmware types supported by a device for FOTA
  */
-declare enum FwType {
+export declare enum FwType {
     APP = "APP",
     MODEM = "MODEM",
     BOOT = "BOOT",
@@ -52,10 +52,17 @@ export declare const devices: ({ endpoint, apiKey, }: {
     }>;
     register: (devices: {
         deviceId: string;
+        certPem: string;
         subType?: string;
         tags?: string[];
+        /**
+         * A list of pipe-delimited firmware types that each device supports for FOTA (e.g., APP|MODEM)
+         *
+         * Defaults to all supported (APP|MODEM|BOOT|SOFTDEVICE|BOOTLOADER|MDM_FULL)
+         *
+         * @default 'APP|MODEM|BOOT|SOFTDEVICE|BOOTLOADER|MDM_FULL'
+         */
         fwTypes?: FwType[];
-        certPem: string;
     }[]) => Promise<{
         error: Error;
     } | {

package/dist/api/devices.js

@@ -16,7 +16,7 @@ const ProvisionDevice = Type.Object({
 /**
  * firmware types supported by a device for FOTA
  */
-var FwType;
+export var FwType;
 (function (FwType) {
     FwType["APP"] = "APP";
     FwType["MODEM"] = "MODEM";
@@ -32,6 +32,7 @@ export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
     };
     const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation);
     return {
+        // FIXME: implement pagination
         list: async () => vf({
             resource: `devices?${new URLSearchParams({
                 pageLimit: '100',
@@ -53,15 +54,18 @@ export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
         }),
         register: async (devices) => {
             const bulkRegistrationPayload = devices
-                .map(({ deviceId, subType, tags, fwTypes, certPem }) => [
-                [
-                    deviceId,
-                    subType ?? '',
-                    (tags ?? []).join('|'),
-                    (fwTypes ?? []).join('|'),
-                    `"${certPem}"`,
-                ],
-            ])
+                .map(({ deviceId, subType, tags, fwTypes, certPem }) => {
+                const deviceFwTypes = fwTypes ?? Object.values(FwType);
+                return [
+                    [
+                        deviceId,
+                        subType ?? '',
+                        (tags ?? []).join('|'),
+                        deviceFwTypes.join('|'),
+                        `"${certPem}"`,
+                    ],
+                ];
+            })
                 .map((cols) => cols.join(','))
                 .join('\n');
             const maybeResult = await vf({

package/dist/api/getFOTAJob.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
 import type { ValidationError } from 'ajv';
+import { FwType } from './devices.js';
 export declare enum FOTAJobStatus {
     CREATED = "CREATED",
     IN_PROGRESS = "IN_PROGRESS",
@@ -14,6 +15,18 @@ export declare const FOTAJobType: import("@sinclair/typebox").TObject<{
     createdAt: import("@sinclair/typebox").TString;
     lastUpdatedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     completedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    firmware: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        bundleId: import("@sinclair/typebox").TString;
+        fileSize: import("@sinclair/typebox").TNumber;
+        firmwareType: import("@sinclair/typebox").TEnum<typeof FwType>;
+        host: import("@sinclair/typebox").TString;
+        uris: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+        version: import("@sinclair/typebox").TString;
+    }>>;
+    target: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        deviceIds: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+        tags: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    }>>;
 }>;
 export declare const getFOTAJob: ({ apiKey, endpoint, }: {
     apiKey: string;

package/dist/api/getFOTAJob.js

@@ -1,5 +1,6 @@
 import { Type } from '@sinclair/typebox';
 import { validatedFetch } from './validatedFetch.js';
+import { FwType } from './devices.js';
 export var FOTAJobStatus;
 (function (FOTAJobStatus) {
     FOTAJobStatus["CREATED"] = "CREATED";
@@ -28,6 +29,33 @@ export const FOTAJobType = Type.Object({
     createdAt: ts,
     lastUpdatedAt: Type.Optional(ts),
     completedAt: Type.Optional(ts),
+    firmware: Type.Optional(Type.Object({
+        bundleId: Type.String({
+            minLength: 1,
+            examples: ['APP*439ddbc7*v2.0.0'],
+        }),
+        fileSize: Type.Number({ minimum: 1, examples: [385068] }),
+        firmwareType: Type.Enum(FwType, { title: 'Firmware Type' }),
+        host: Type.String({
+            minLength: 1,
+            examples: ['firmware.nrfcloud.com'],
+        }),
+        uris: Type.Array(Type.String({
+            minLength: 1,
+            examples: [
+                'bbfe6b73-a46a-43ad-94bd-8e4b4a7847ce/APP*439ddbc7*v2.0.0/hello-nrfcloud-thingy91-v2.0.0-fwupd.bin',
+            ],
+        })),
+        version: Type.String({ minLength: 1, examples: ['v2.0.0'] }),
+    })),
+    target: Type.Optional(Type.Object({
+        deviceIds: Type.Array(Type.String({
+            minLength: 1,
+            title: 'Device ID',
+            examples: ['oob-358299840021360'],
+        })),
+        tags: Type.Array(Type.String({ minLength: 1, title: 'Tag', examples: ['nrf9160'] })),
+    })),
 }, {
     title: 'FOTA Job',
     description: 'See https://api.nrfcloud.com/#tag/FOTA-Jobs/operation/FetchFOTAJob',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {

package/dist/cellGeoLocation/cache.d.ts

@@ -1,18 +0,0 @@
-import { type DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { cellId } from './cellId.js';
-export declare const get: ({ db, TableName }: {
-    db: DynamoDBClient;
-    TableName: string;
-}) => (cell: Parameters<typeof cellId>[0]) => Promise<{
-    lat: number;
-    lng: number;
-    accuracy: number;
-} | null>;
-export declare const store: ({ db, TableName }: {
-    db: DynamoDBClient;
-    TableName: string;
-}) => (cell: Parameters<typeof cellId>[0], location: {
-    lat: number;
-    lng: number;
-    accuracy: number;
-}) => Promise<void>;

package/dist/cellGeoLocation/cache.js

@@ -1,30 +0,0 @@
-import { GetItemCommand, PutItemCommand, } from '@aws-sdk/client-dynamodb';
-import { cellId } from './cellId.js';
-import { marshall, unmarshall } from '@aws-sdk/util-dynamodb';
-export const get = ({ db, TableName }) => async (cell) => {
-    try {
-        const { Item } = await db.send(new GetItemCommand({
-            TableName,
-            Key: {
-                cellId: {
-                    S: cellId(cell),
-                },
-            },
-        }));
-        const { lat, lng, accuracy } = unmarshall(Item);
-        return { lat, lng, accuracy };
-    }
-    catch {
-        return null;
-    }
-};
-export const store = ({ db, TableName }) => async (cell, location) => {
-    await db.send(new PutItemCommand({
-        TableName,
-        Item: marshall({
-            cellId: cellId(cell),
-            ...location,
-            ttl: Math.floor(Date.now() / 1000) + 30 * 24 * 60 * 60,
-        }),
-    }));
-};

package/dist/cellGeoLocation/cache.spec.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { mock } from 'node:test';
-export declare const assertCall: (mockFn: ReturnType<(typeof mock)['fn']>, args: Record<string, unknown>, callNumber?: number) => void;

package/dist/cellGeoLocation/cache.spec.js

@@ -1,99 +0,0 @@
-import { describe, it, mock } from 'node:test';
-import assert from 'node:assert/strict';
-import { ResourceNotFoundException } from '@aws-sdk/client-dynamodb';
-import { get, store } from './cache.js';
-import { arrayContaining, check, objectMatching } from 'tsmatchers';
-export const assertCall = (mockFn, args, callNumber = 0) => {
-    check(mockFn.mock.calls[callNumber]?.arguments).is(arrayContaining(objectMatching(args)));
-};
-void describe('cellGeoLocation/cache', () => {
-    void describe('get()', () => {
-        void it('should return null if cell is not cached', async () => {
-            const send = mock.fn(async () => Promise.reject(new ResourceNotFoundException({
-                message: ` Requested resource not found`,
-                $metadata: {},
-            })));
-            assert.equal(await get({
-                db: { send },
-                TableName: 'cacheTable',
-            })({
-                area: 42,
-                mccmnc: 53005,
-                cell: 666,
-            }), null);
-            assertCall(send, {
-                input: {
-                    Key: {
-                        cellId: {
-                            S: '53005-42-666',
-                        },
-                    },
-                    TableName: 'cacheTable',
-                },
-            });
-        });
-        void it('should return the location if the cell is cached', async () => {
-            const send = mock.fn(async () => Promise.resolve({
-                $metadata: {
-                    httpStatusCode: 200,
-                    requestId: 'SHTTK1LO0ELJ5LI2U0LUJOUBOJVV4KQNSO5AEMVJF66Q9ASUAAJG',
-                    extendedRequestId: undefined,
-                    cfId: undefined,
-                    attempts: 1,
-                    totalRetryDelay: 0,
-                },
-                Item: {
-                    cellId: { S: '53005-42-666' },
-                    lat: { N: '-36.87313199' },
-                    lng: { N: '174.7577405' },
-                    accuracy: { N: '510' },
-                },
-            }));
-            assert.deepEqual(await get({
-                db: { send },
-                TableName: 'cacheTable',
-            })({
-                area: 42,
-                mccmnc: 53005,
-                cell: 666,
-            }), { accuracy: 510, lat: -36.87313199, lng: 174.7577405 });
-            assertCall(send, {
-                input: {
-                    Key: {
-                        cellId: {
-                            S: '53005-42-666',
-                        },
-                    },
-                    TableName: 'cacheTable',
-                },
-            });
-        });
-    });
-    void describe('store()', () => {
-        void it('should store the cell', async () => {
-            const send = mock.fn(async () => Promise.resolve({}));
-            await store({
-                db: { send },
-                TableName: 'cacheTable',
-            })({
-                area: 42,
-                mccmnc: 53005,
-                cell: 666,
-            }, { accuracy: 510, lat: -36.87313199, lng: 174.7577405 });
-            assertCall(send, {
-                input: {
-                    Item: {
-                        accuracy: { N: '510' },
-                        cellId: { S: '53005-42-666' },
-                        lat: { N: '-36.87313199' },
-                        lng: { N: '174.7577405' },
-                        ttl: {
-                            N: `${Math.floor(Date.now() / 1000) + 30 * 24 * 60 * 60}`,
-                        },
-                    },
-                    TableName: 'cacheTable',
-                },
-            });
-        });
-    });
-});

package/dist/cellGeoLocation/cellId.d.ts

@@ -1,5 +0,0 @@
-export declare const cellId: ({ area, mccmnc, cell, }: {
-    area: number;
-    mccmnc: number;
-    cell: number;
-}) => string;

package/dist/cellGeoLocation/cellId.js

@@ -1 +0,0 @@
-export const cellId = ({ area, mccmnc, cell, }) => `${mccmnc}-${area}-${cell}`;

package/dist/cellGeoLocation/cellId.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cellGeoLocation/cellId.spec.js

@@ -1,10 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert/strict';
-import { cellId } from './cellId.js';
-void describe('cellId', () => {
-    void it('should generate a cellId', () => assert.equal(cellId({
-        area: 42,
-        mccmnc: 53005,
-        cell: 666,
-    }), '53005-42-666'));
-});

package/dist/cellGeoLocation/index.d.ts

@@ -1,2 +0,0 @@
-export * from './cache.js';
-export * from './cellId.js';

package/dist/cellGeoLocation/index.js

@@ -1,2 +0,0 @@
-export * from './cache.js';
-export * from './cellId.js';