@hello.nrfcloud.com/nrfcloud-api-helpers 5.2.37 → 5.3.0

package/dist/api/devices.d.ts

@@ -1,7 +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';
+import { type ValidationError } from './validatedFetch.js';
 declare const Devices: import("@sinclair/typebox").TObject<{
     total: import("@sinclair/typebox").TInteger;
     items: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
@@ -69,5 +69,10 @@ export declare const devices: ({ endpoint, apiKey, }: {
     } | {
         bulkOpsRequestId: string;
     }>;
+    remove: (deviceId: string) => Promise<{
+        error: FetchError | ValidationError;
+    } | {
+        success: boolean;
+    }>;
 };
 export {};

package/dist/api/devices.js

@@ -1,8 +1,8 @@
 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';
+import { slashless } from './slashless.js';
+import { validatedFetch } from './validatedFetch.js';
 const Page = (Item) => Type.Object({
     total: Type.Integer(),
     items: Type.Array(Item),
@@ -80,5 +80,14 @@ export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
                 return maybeResult;
             return { bulkOpsRequestId: maybeResult.result.bulkOpsRequestId };
         },
+        remove: async (deviceId) => {
+            const maybeResult = await vf({
+                method: 'DELETE',
+                resource: `devices/${deviceId}`,
+            }, Type.Any());
+            if ('error' in maybeResult)
+                return maybeResult;
+            return { success: true };
+        },
     };
 };

package/dist/api/validatedFetch.d.ts

@@ -1,4 +1,4 @@
-import { type Static, type TObject } from '@sinclair/typebox';
+import { type Static, type TSchema } from '@sinclair/typebox';
 import type { ValueError } from '@sinclair/typebox/compiler';
 import type { FetchError } from './FetchError.js';
 export declare class ValidationError extends Error {
@@ -9,7 +9,7 @@ export declare class ValidationError extends Error {
 export declare const validatedFetch: ({ endpoint, apiKey }: {
     apiKey: string;
     endpoint: URL;
-}, fetchImplementation?: typeof fetch) => <Schema extends TObject>(params: ({
+}, fetchImplementation?: typeof fetch) => <Schema extends TSchema>(params: ({
     resource: string;
 } | {
     resource: string;

package/dist/api/validatedFetch.js

@@ -1,7 +1,7 @@
-import {} from '@sinclair/typebox';
-import { slashless } from './slashless.js';
 import { validateWithTypeBox } from '@hello.nrfcloud.com/proto';
+import {} from '@sinclair/typebox';
 import { toFetchError } from './FetchError.js';
+import { slashless } from './slashless.js';
 export class ValidationError extends Error {
     errors;
     isValidationError = true;
@@ -23,6 +23,8 @@ const fetchData = (fetchImplementation) => async (...args) => {
     const response = await (fetchImplementation ?? fetch)(...args);
     if (!response.ok)
         throw await toFetchError(response);
+    if (response.headers?.get('content-length') === '0')
+        return undefined;
     return response.json();
 };
 export const validatedFetch = ({ endpoint, apiKey }, fetchImplementation) => async (params, schema) => {

package/dist/api/validatedFetch.spec.js

@@ -109,6 +109,20 @@ void describe('validatedFetch()', () => {
         assert.equal('result' in res, false);
         assert.deepEqual('error' in res && res.error, new FetchError(400, 'Bad Request'));
     });
+    void it('should return undefined if response is empty', async () => {
+        const mockFetch = mock.fn(() => ({
+            ok: true,
+            status: 204,
+            text: async () => '',
+            headers: new Map([[`content-length`, '0']]),
+        }));
+        const vf = validatedFetch({
+            endpoint: new URL('https://example.com/'),
+            apiKey: 'some-key',
+        }, mockFetch);
+        const res = await vf({ resource: 'foo' }, Type.Undefined());
+        assert.deepEqual('result' in res && res.result, undefined, 'Result should be undefined');
+    });
 });
 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.2.37",
+  "version": "5.3.0",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -85,7 +85,7 @@
     "@aws-sdk/client-dynamodb": "^3.614.0",
     "@aws-sdk/client-ssm": "^3.614.0",
     "@aws-sdk/util-dynamodb": "^3.614.0",
-    "@bifravst/aws-ssm-settings-helpers": "^1.1.42",
+    "@bifravst/aws-ssm-settings-helpers": "^1.1.43",
     "@hello.nrfcloud.com/proto": "^14.1.7",
     "@sinclair/typebox": "^0.32.34"
   }