@hello.nrfcloud.com/nrfcloud-api-helpers 5.0.10 → 5.1.0

package/dist/api/getFOTABundle.spec.d.ts

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

package/dist/api/getFOTABundle.spec.js

@@ -0,0 +1,92 @@
+import { describe, it, mock } from 'node:test';
+import assert from 'node:assert/strict';
+import { getFOTABundles } from './getFOTABundles.js';
+void describe('getFOTABundles()', () => {
+    void it('should fetch all FOTA bundles', async () => {
+        const mockFetch = mock.fn();
+        mockFetch.mock.mockImplementationOnce(() => ({
+            ok: true,
+            json: async () => Promise.resolve({
+                items: [
+                    {
+                        bundleId: 'APP*0038b655*v1.1.1-debug',
+                        lastModified: '2023-06-28T09:50:02.000Z',
+                        size: 418565,
+                        version: 'v1.1.1-debug',
+                        type: 'APP',
+                        filenames: ['hello-nrfcloud-thingy91-debug-v1.1.1-fwupd.bin'],
+                        name: 'hello.nrfcloud.com v1.1.1-debug',
+                        description: 'Firmware Update Image BIN file (thingy91, debug)',
+                    },
+                ],
+                total: 1,
+                pageNextToken: '102/B5fGZNAs7vcw8E2i611ID4apx/Du/2/H6nr2UDWk5eoihEeAgh6qoaGcDzAI4M8JCoO4iAAK96TWfuB19ru9c1PrnwiTUdw/sZzwrYSrS433vPjDJNvJUIEmqm9+V3ElM5M1bLmt6GrGa57SymHHK4nN0W+zHhmE97cCCfzJMBXhVTl3TzvBx5rE1KJYf',
+            }),
+        }), 0);
+        mockFetch.mock.mockImplementationOnce(() => ({
+            ok: true,
+            json: async () => Promise.resolve({
+                items: [
+                    {
+                        bundleId: 'APP*0103b0f9*v1.1.2-sol-dbg',
+                        lastModified: '2023-06-29T14:18:19.000Z',
+                        size: 426280,
+                        version: 'v1.1.2-sol-dbg',
+                        type: 'APP',
+                        filenames: ['hello-nrfcloud-thingy91-sol-dbg-v1.1.2-fwupd.bin'],
+                        name: 'hello.nrfcloud.com v1.1.2-sol-dbg',
+                        description: 'Firmware Update Image BIN file (thingy91, solar, debug)',
+                    },
+                ],
+                total: 1,
+            }),
+        }), 1);
+        const fetcher = getFOTABundles({
+            endpoint: new URL('https://example.com/'),
+            apiKey: 'some-key',
+        }, mockFetch);
+        const res = await fetcher();
+        assert.deepEqual(mockFetch.mock.calls[0]?.arguments, [
+            `https://example.com/v1/firmwares?pageLimit=100`,
+            {
+                headers: {
+                    Accept: 'application/json; charset=utf-8',
+                    Authorization: 'Bearer some-key',
+                },
+            },
+        ]);
+        assert.deepEqual(mockFetch.mock.calls[1]?.arguments, [
+            `https://example.com/v1/firmwares?pageLimit=100&pageNextToken=${encodeURIComponent(`102/B5fGZNAs7vcw8E2i611ID4apx/Du/2/H6nr2UDWk5eoihEeAgh6qoaGcDzAI4M8JCoO4iAAK96TWfuB19ru9c1PrnwiTUdw/sZzwrYSrS433vPjDJNvJUIEmqm9+V3ElM5M1bLmt6GrGa57SymHHK4nN0W+zHhmE97cCCfzJMBXhVTl3TzvBx5rE1KJYf`)}`,
+            {
+                headers: {
+                    Accept: 'application/json; charset=utf-8',
+                    Authorization: 'Bearer some-key',
+                },
+            },
+        ]);
+        assert.deepEqual(res, {
+            bundles: [
+                {
+                    bundleId: 'APP*0038b655*v1.1.1-debug',
+                    lastModified: '2023-06-28T09:50:02.000Z',
+                    size: 418565,
+                    version: 'v1.1.1-debug',
+                    type: 'APP',
+                    filenames: ['hello-nrfcloud-thingy91-debug-v1.1.1-fwupd.bin'],
+                    name: 'hello.nrfcloud.com v1.1.1-debug',
+                    description: 'Firmware Update Image BIN file (thingy91, debug)',
+                },
+                {
+                    bundleId: 'APP*0103b0f9*v1.1.2-sol-dbg',
+                    lastModified: '2023-06-29T14:18:19.000Z',
+                    size: 426280,
+                    version: 'v1.1.2-sol-dbg',
+                    type: 'APP',
+                    filenames: ['hello-nrfcloud-thingy91-sol-dbg-v1.1.2-fwupd.bin'],
+                    name: 'hello.nrfcloud.com v1.1.2-sol-dbg',
+                    description: 'Firmware Update Image BIN file (thingy91, solar, debug)',
+                },
+            ],
+        });
+    });
+});

package/dist/api/getFOTABundles.d.ts

@@ -0,0 +1,21 @@
+import { type Static } from '@sinclair/typebox';
+import type { ValidationError } from 'ajv';
+import { FwType } from './devices.js';
+export declare const FOTABundle: import("@sinclair/typebox").TObject<{
+    bundleId: import("@sinclair/typebox").TString;
+    lastModified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    size: import("@sinclair/typebox").TNumber;
+    version: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TEnum<typeof FwType>;
+    filenames: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const getFOTABundles: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => () => Promise<{
+    error: Error | ValidationError;
+} | {
+    bundles: Array<Static<typeof FOTABundle>>;
+}>;

package/dist/api/getFOTABundles.js

@@ -0,0 +1,73 @@
+import { Type } from '@sinclair/typebox';
+import { validatedFetch } from './validatedFetch.js';
+import { FwType } from './devices.js';
+export const FOTABundle = Type.Object({
+    bundleId: Type.String({
+        minLength: 1,
+        description: 'The ID of the bundle',
+        examples: ['APP*20a4b75a*v1.1.1-debug'],
+    }),
+    lastModified: Type.Optional(Type.String({
+        title: 'Timestamp',
+        description: 'ISO-8601 date-time string',
+        examples: ['2019-08-24T14:15:22Z'],
+    })),
+    size: Type.Number({
+        minimum: 0,
+        description: 'Size of the bundle in bytes',
+        examples: [418565],
+    }),
+    version: Type.String({ minLength: 1, examples: ['v1.1.1-debug'] }),
+    type: Type.Enum(FwType, { title: 'Firmware Type' }),
+    filenames: Type.Array(Type.String({
+        minLength: 1,
+        examples: ['hello-nrfcloud-thingy91-debug-v1.1.1-fwupd.bin'],
+    }), { description: 'The files in the bundle.' }),
+    name: Type.Optional(Type.String({
+        minLength: 1,
+        title: 'Name',
+        description: 'The name of the bundle',
+        examples: ['hello.nrfcloud.com v1.1.1-debug'],
+    })),
+    description: Type.Optional(Type.String({
+        minLength: 1,
+        title: 'Description',
+        description: 'The description of the bundle',
+        examples: ['Firmware Update Image BIN file (thingy91, debug)'],
+    })),
+});
+const FirmwaresType = Type.Object({
+    items: Type.Array(FOTABundle),
+    total: Type.Integer({
+        minimum: 0,
+        description: 'Reflects the total results returned by the query, which may be less than the total number of items available. If the response contains a pageNextToken value, you can supply the pageNextToken in the next request to get more results. The maximum value of total is the page limit of the request, or ten pages if no page limit is provided.',
+    }),
+    pageNextToken: Type.Optional(Type.String({
+        minLength: 1,
+        description: 'Token used to retrieve the next page of items in the list. Present in a response only if the total available results exceeds the specified limit on a page. This token does not change between requests. When supplying as a request parameter, use URL-encoding.',
+    })),
+}, {
+    title: 'Firmware bundles',
+    description: 'Returns the list of firmware bundles. See https://api.nrfcloud.com/v1#tag/Firmware-Bundles/operation/ListFirmware',
+});
+export const getFOTABundles = ({ apiKey, endpoint, }, fetchImplementation) => async () => {
+    const vf = validatedFetch({
+        endpoint,
+        apiKey,
+    }, fetchImplementation);
+    return paginateFirmwares(vf);
+};
+const paginateFirmwares = async (vf, bundles = [], pageNextToken = undefined) => {
+    const query = new URLSearchParams({ pageLimit: '100' });
+    if (pageNextToken !== undefined)
+        query.set('pageNextToken', pageNextToken);
+    const maybeBundles = await vf({
+        resource: `firmwares`,
+        query,
+    }, FirmwaresType);
+    if ('error' in maybeBundles)
+        return maybeBundles;
+    if (maybeBundles.result.pageNextToken !== undefined)
+        return paginateFirmwares(vf, [...bundles, ...maybeBundles.result.items], maybeBundles.result.pageNextToken);
+    return { bundles: [...bundles, ...maybeBundles.result.items] };
+};

package/dist/api/index.d.ts

@@ -13,3 +13,4 @@ export * from './groundFix.js';
 export * from './bulkOps.js';
 export * from './createFOTAJob.js';
 export * from './getFOTAJob.js';
+export * from './getFOTABundles.js';

package/dist/api/index.js

@@ -13,3 +13,4 @@ export * from './groundFix.js';
 export * from './bulkOps.js';
 export * from './createFOTAJob.js';
 export * from './getFOTAJob.js';
+export * from './getFOTABundles.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "5.0.10",
+  "version": "5.1.0",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -32,14 +32,14 @@
   "author": "Nordic Semiconductor ASA | nordicsemi.no",
   "license": "BSD-3-Clause",
   "devDependencies": {
-    "@bifravst/eslint-config-typescript": "6.1.2",
+    "@bifravst/eslint-config-typescript": "6.1.3",
     "@bifravst/prettier-config": "1.0.2",
     "@commitlint/config-conventional": "19.2.2",
     "@types/aws-lambda": "8.10.138",
     "@types/node": "20.14.2",
     "husky": "9.0.11",
     "tsmatchers": "5.0.2",
-    "tsx": "4.15.1"
+    "tsx": "4.15.2"
   },
   "lint-staged": {
     "*.ts": [