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

package/dist/api/FetchError.d.ts

@@ -0,0 +1,5 @@
+export declare class FetchError extends Error {
+    readonly statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+export declare const toFetchError: (response: Response) => Promise<FetchError>;

package/dist/api/FetchError.js

@@ -0,0 +1,11 @@
+export class FetchError extends Error {
+    statusCode;
+    constructor(statusCode, message) {
+        super(message);
+        this.statusCode = statusCode;
+        this.name = 'FetchError';
+    }
+}
+export const toFetchError = async (response) => new FetchError(response.status, parseInt(response.headers.get('content-length') ?? '0', 10) > 0
+    ? await response.text()
+    : 'No content returned from server');

package/dist/api/bulkOps.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
 import { type ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 /**
  * @link https://api.nrfcloud.com/v1/#tag/Bulk-Ops-Requests/operation/FetchBulkOpsRequest
  */
@@ -11,7 +12,7 @@ export declare const bulkOpsRequests: ({ apiKey, endpoint, }: {
     apiKey: string;
     endpoint: URL;
 }, fetchImplementation?: typeof fetch) => (bulkOpsId: string) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<typeof BulkOpsRequestType>;
 }>;

package/dist/api/createFOTAJob.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 export declare const CreatedFOTAJobType: import("@sinclair/typebox").TObject<{
     jobId: import("@sinclair/typebox").TString;
 }>;
@@ -10,7 +11,7 @@ export declare const createFOTAJob: ({ apiKey, endpoint, }: {
     deviceId: string;
     bundleId: string;
 }) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<typeof CreatedFOTAJobType>;
 }>;

package/dist/api/devices.d.ts

@@ -1,6 +1,7 @@
 import { type Static } from '@sinclair/typebox';
 import { type ValidationError } from './validatedFetch.js';
 import { DeviceShadow } from './DeviceShadow.js';
+import type { FetchError } from './FetchError.js';
 declare const Devices: import("@sinclair/typebox").TObject<{
     total: import("@sinclair/typebox").TInteger;
     items: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
@@ -33,12 +34,12 @@ export declare const devices: ({ endpoint, apiKey, }: {
     apiKey: string;
 }, fetchImplementation?: typeof fetch) => {
     list: () => Promise<{
-        error: Error | ValidationError;
+        error: FetchError | ValidationError;
     } | {
         result: Static<typeof Devices>;
     }>;
     get: (id: string) => Promise<{
-        error: Error | ValidationError;
+        error: FetchError | ValidationError;
     } | {
         result: Static<typeof DeviceShadow>;
     }>;
@@ -46,7 +47,7 @@ export declare const devices: ({ endpoint, apiKey, }: {
         desired?: Record<string, any>;
         reported?: Record<string, any>;
     }) => Promise<{
-        error: Error;
+        error: FetchError | ValidationError;
     } | {
         success: boolean;
     }>;
@@ -64,7 +65,7 @@ export declare const devices: ({ endpoint, apiKey, }: {
          */
         fwTypes?: FwType[];
     }[]) => Promise<{
-        error: Error;
+        error: FetchError | ValidationError;
     } | {
         bulkOpsRequestId: string;
     }>;

package/dist/api/devices.js

@@ -2,6 +2,7 @@ import { Type } from '@sinclair/typebox';
 import { slashless } from './slashless.js';
 import { validatedFetch } from './validatedFetch.js';
 import { DeviceShadow } from './DeviceShadow.js';
+import { toFetchError } from './FetchError.js';
 const Page = (Item) => Type.Object({
     total: Type.Integer(),
     items: Type.Array(Item),
@@ -47,9 +48,9 @@ export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
             },
             method: 'PATCH',
             body: JSON.stringify(state),
-        }).then((res) => {
+        }).then(async (res) => {
             if (res.status >= 400)
-                return { error: new Error(`Update failed: ${res.status}`) };
+                return { error: await toFetchError(res) };
             return { success: true };
         }),
         register: async (devices) => {
@@ -75,11 +76,8 @@ export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
                     type: 'application/octet-stream',
                 },
             }, ProvisionDevice);
-            if ('error' in maybeResult) {
-                return {
-                    error: maybeResult.error,
-                };
-            }
+            if ('error' in maybeResult)
+                return maybeResult;
             return { bulkOpsRequestId: maybeResult.result.bulkOpsRequestId };
         },
     };

package/dist/api/getAccountInfo.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 declare const AccountInfoType: import("@sinclair/typebox").TObject<{
     mqttEndpoint: import("@sinclair/typebox").TString;
     mqttTopicPrefix: import("@sinclair/typebox").TString;
@@ -13,7 +14,7 @@ export declare const getAccountInfo: ({ apiKey, endpoint, }: {
     apiKey: string;
     endpoint: URL;
 }, fetchImplementation?: typeof fetch) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: AccountInfo;
 }>;

package/dist/api/getCurrentMonthlyCosts.d.ts

@@ -1,9 +1,10 @@
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 export declare const getCurrentMonthlyCosts: ({ apiKey, endpoint, }: {
     apiKey: string;
     endpoint: URL;
 }, fetchImplementation?: typeof fetch) => () => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     currentMonthTotalCost: number;
 }>;

package/dist/api/getDeviceShadow.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 declare const DeviceShadows: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;
     $meta: import("@sinclair/typebox").TObject<{
@@ -19,6 +20,6 @@ export declare const getDeviceShadow: ({ endpoint, apiKey, }: {
 }, fetchImplementation?: typeof fetch) => ((devices: string[]) => Promise<{
     shadows: Static<typeof DeviceShadows>;
 } | {
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 }>);
 export {};

package/dist/api/getFOTABundles.d.ts

@@ -1,6 +1,7 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
 import { FwType } from './devices.js';
+import type { FetchError } from './FetchError.js';
 export declare const FOTABundle: import("@sinclair/typebox").TObject<{
     bundleId: import("@sinclair/typebox").TString;
     lastModified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
@@ -15,7 +16,7 @@ export declare const getFOTABundles: ({ apiKey, endpoint, }: {
     apiKey: string;
     endpoint: URL;
 }, fetchImplementation?: typeof fetch) => () => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     bundles: Array<Static<typeof FOTABundle>>;
 }>;

package/dist/api/getFOTAJob.d.ts

@@ -1,6 +1,7 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
 import { FwType } from './devices.js';
+import type { FetchError } from './FetchError.js';
 export declare enum FOTAJobStatus {
     CREATED = "CREATED",
     IN_PROGRESS = "IN_PROGRESS",
@@ -42,7 +43,7 @@ export declare const getFOTAJob: ({ apiKey, endpoint, }: {
 }, fetchImplementation?: typeof fetch) => ({ jobId, }: {
     jobId: string;
 }) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<typeof FOTAJobType>;
 }>;

package/dist/api/getLocationHistory.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
-import type { ValidationError } from 'ajv';
+import type { ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 export declare enum LocationHistoryServiceType {
     ANCHOR = "ANCHOR",
     GNSS = "GNSS",
@@ -39,7 +40,7 @@ export declare const getLocationHistory: ({ apiKey, endpoint, }: {
     start?: Date;
     end?: Date;
 }) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<typeof LocationHistoryType>;
 }>;

package/dist/api/groundFix.d.ts

@@ -1,5 +1,6 @@
 import { type Static } from '@sinclair/typebox';
 import { type ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 export declare const lat: import("@sinclair/typebox").TNumber;
 export declare const lng: import("@sinclair/typebox").TNumber;
 export declare const accuracy: import("@sinclair/typebox").TNumber;
@@ -22,7 +23,7 @@ export declare const groundFix: ({ apiKey, endpoint, }: {
     tac: number;
     rsrp?: number;
 }) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<typeof GroundFixType>;
 }>;

package/dist/api/index.d.ts

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

package/dist/api/index.js

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

package/dist/api/serviceToken.d.ts

@@ -1,4 +1,5 @@
 import { type ValidationError } from './validatedFetch.js';
+import type { FetchError } from './FetchError.js';
 /**
  * @link https://api.nrfcloud.com/v1/#tag/Account/operation/GetServiceToken
  */
@@ -9,7 +10,7 @@ export declare const serviceToken: ({ apiKey, endpoint, }: {
     apiKey: string;
     endpoint: URL;
 }, fetchImplementation?: typeof fetch) => (() => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     token: string;
 }>);

package/dist/api/validatedFetch.d.ts

@@ -1,5 +1,6 @@
 import { type Static, type TObject } from '@sinclair/typebox';
 import type { ValueError } from '@sinclair/typebox/compiler';
+import type { FetchError } from './FetchError.js';
 export declare class ValidationError extends Error {
     errors: ValueError[];
     readonly isValidationError = true;
@@ -19,7 +20,7 @@ export declare const validatedFetch: ({ endpoint, apiKey }: {
 }) & {
     query?: URLSearchParams;
 }, schema: Schema) => Promise<{
-    error: Error | ValidationError;
+    error: FetchError | ValidationError;
 } | {
     result: Static<Schema>;
 }>;

package/dist/api/validatedFetch.js

@@ -1,6 +1,7 @@
 import {} from '@sinclair/typebox';
 import { slashless } from './slashless.js';
 import { validateWithTypeBox } from '@hello.nrfcloud.com/proto';
+import { toFetchError } from './FetchError.js';
 export class ValidationError extends Error {
     errors;
     isValidationError = true;
@@ -21,7 +22,7 @@ const validate = (SchemaObject, data) => {
 const fetchData = (fetchImplementation) => async (...args) => {
     const response = await (fetchImplementation ?? fetch)(...args);
     if (!response.ok)
-        throw new Error(`Error fetching status: ${response.status}`);
+        throw await toFetchError(response);
     return response.json();
 };
 export const validatedFetch = ({ endpoint, apiKey }, fetchImplementation) => async (params, schema) => {

package/dist/api/validatedFetch.spec.js

@@ -2,6 +2,7 @@ import { describe, it, mock } from 'node:test';
 import assert from 'node:assert/strict';
 import { Type } from '@sinclair/typebox';
 import { JSONPayload, validatedFetch } from './validatedFetch.js';
+import { FetchError } from './FetchError.js';
 void describe('validatedFetch()', () => {
     void it('should call an nRF Cloud API endpoint and validate the response', async () => {
         const mockFetch = mock.fn(() => ({
@@ -92,6 +93,22 @@ void describe('validatedFetch()', () => {
             },
         ]);
     });
+    void it('should return an error if the response is not OK', async () => {
+        const mockFetch = mock.fn(() => ({
+            ok: false,
+            status: 400,
+            text: async () => Promise.resolve('Bad Request'),
+            headers: new Map([[`content-length`, 'Bad Request'.length.toString()]]),
+        }));
+        const vf = validatedFetch({
+            endpoint: new URL('https://example.com/'),
+            apiKey: 'some-key',
+        }, mockFetch);
+        const res = await vf({ resource: 'foo' }, Type.Object({}));
+        assert.equal('error' in res, true);
+        assert.equal('result' in res, false);
+        assert.deepEqual('error' in res && res.error, new FetchError(400, 'Bad Request'));
+    });
 });
 void describe('JSONPayload()', () => {
     void it('should convert a an object to a payload definition to be used in validatedFetch', () => assert.deepEqual(JSONPayload({ foo: 'bar' }), {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -33,7 +33,7 @@
   "license": "BSD-3-Clause",
   "devDependencies": {
     "@bifravst/eslint-config-typescript": "6.1.3",
-    "@bifravst/prettier-config": "1.0.2",
+    "@bifravst/prettier-config": "1.0.3",
     "@commitlint/config-conventional": "19.2.2",
     "@types/aws-lambda": "8.10.138",
     "@types/node": "20.14.2",