@hello.nrfcloud.com/nrfcloud-api-helpers 1.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Nordic Semiconductor ASA | nordicsemi.no
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,15 @@
+# nRF Cloud API helpers [![npm version](https://img.shields.io/npm/v/@hello.nrfcloud.com/nrfcloud-api-helpers.svg)](https://www.npmjs.com/package/@hello.nrfcloud.com/nrfcloud-api-helpers)
+
+[![GitHub Actions](https://github.com/hello-nrfcloud/nrfcloud-api-helpers/workflows/Test%20and%20Release/badge.svg)](https://github.com/hello-nrfcloud/nrfcloud-api-helpers/actions)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
+[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)
+[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)
+
+Helper functions for integrating nRF Cloud APIs in AWS lambdas written in
+TypeScript.
+
+## Installation
+
+    npm i --save --save-exact @hello.nrfcloud.com/nrfcloud-api-helpers

package/dist/api/DeviceShadow.d.ts

@@ -0,0 +1,17 @@
+import { type Static } from '@sinclair/typebox';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/All-Devices/operation/ListDevices
+ */
+export declare const DeviceShadow: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    state: import("@sinclair/typebox").TObject<{
+        reported: import("@sinclair/typebox").TObject<{}>;
+        version: import("@sinclair/typebox").TNumber;
+        metadata: import("@sinclair/typebox").TObject<{
+            reported: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+                timestamp: import("@sinclair/typebox").TInteger;
+            }>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>]>>;
+        }>;
+    }>;
+}>;
+export type DeviceShadowType = Static<typeof DeviceShadow>;

package/dist/api/DeviceShadow.js

@@ -0,0 +1,18 @@
+import { Type } from '@sinclair/typebox';
+const PropertyMetadata = Type.Union([
+    Type.Object({ timestamp: Type.Integer({ minimum: 1, maximum: 9999999999 }) }),
+    Type.Record(Type.String({ minLength: 1 }), Type.Unknown()),
+]);
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/All-Devices/operation/ListDevices
+ */
+export const DeviceShadow = Type.Object({
+    id: Type.String(),
+    state: Type.Object({
+        reported: Type.Object({}),
+        version: Type.Number(),
+        metadata: Type.Object({
+            reported: Type.Record(Type.String({ minLength: 1 }), PropertyMetadata),
+        }),
+    }),
+});

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

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

package/dist/api/DeviceShadow.spec.js

@@ -0,0 +1,53 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { validateWithTypeBox } from '@hello.nrfcloud.com/proto';
+import { DeviceShadow } from './DeviceShadow.js';
+void describe('DeviceShadow type', () => {
+    void it('should document the device shadow object', () => {
+        const res = validateWithTypeBox(DeviceShadow)({
+            id: 'some-device',
+            state: {
+                version: 42,
+                reported: {
+                    dev: {
+                        v: {
+                            imei: '358299840016535',
+                            iccid: '89450421180216254864',
+                            modV: 'mfw_nrf91x1_2.0.0-77.beta',
+                            brdV: 'thingy91x_nrf9161',
+                            appV: '0.0.0-development',
+                        },
+                        ts: 1697102116821,
+                    },
+                },
+                metadata: {
+                    reported: {
+                        dev: {
+                            v: {
+                                imei: {
+                                    timestamp: 1697102122,
+                                },
+                                iccid: {
+                                    timestamp: 1697102122,
+                                },
+                                modV: {
+                                    timestamp: 1697102122,
+                                },
+                                brdV: {
+                                    timestamp: 1697102122,
+                                },
+                                appV: {
+                                    timestamp: 1697102122,
+                                },
+                            },
+                            ts: {
+                                timestamp: 1697102122,
+                            },
+                        },
+                    },
+                },
+            },
+        });
+        assert.equal('errors' in res, false);
+    });
+});

package/dist/api/createAccountDevice.d.ts

@@ -0,0 +1,13 @@
+import { type Static } from '@sinclair/typebox';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Account-Devices/operation/CreateAccountDevice
+ */
+declare const CertificateCredentials: import("@sinclair/typebox").TObject<{
+    clientCert: import("@sinclair/typebox").TString;
+    privateKey: import("@sinclair/typebox").TString;
+}>;
+export declare const createAccountDevice: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}) => Promise<Static<typeof CertificateCredentials>>;
+export {};

package/dist/api/createAccountDevice.js

@@ -0,0 +1,20 @@
+import { Type } from '@sinclair/typebox';
+import { validatedFetch } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Account-Devices/operation/CreateAccountDevice
+ */
+const CertificateCredentials = Type.Object({
+    clientCert: Type.String(),
+    privateKey: Type.String(),
+});
+export const createAccountDevice = async ({ apiKey, endpoint, }) => {
+    const vf = validatedFetch({ endpoint, apiKey });
+    const maybeResult = await vf({ resource: 'devices/account', method: 'POST' }, CertificateCredentials);
+    if ('error' in maybeResult) {
+        throw maybeResult.error;
+    }
+    return {
+        clientCert: maybeResult.result.clientCert,
+        privateKey: maybeResult.result.privateKey,
+    };
+};

package/dist/api/deleteAccountDevice.d.ts

@@ -0,0 +1,4 @@
+export declare const deleteAccountDevice: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}) => Promise<void>;

package/dist/api/deleteAccountDevice.js

@@ -0,0 +1,9 @@
+import { slashless } from './slashless.js';
+export const deleteAccountDevice = async ({ apiKey, endpoint, }) => {
+    await fetch(`${slashless(endpoint)}/v1/devices/account`, {
+        method: 'DELETE',
+        headers: {
+            Authorization: `Bearer ${apiKey}`,
+        },
+    });
+};

package/dist/api/devices.d.ts

@@ -0,0 +1,152 @@
+import { type Static } from '@sinclair/typebox';
+import { ValidationError } from './validatedFetch.js';
+type Nullable<T> = {
+    [K in keyof T]: T[K] | null;
+};
+export declare const DeviceConfig: import("@sinclair/typebox").TObject<{
+    activeMode: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    locationTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    activeWaitTime: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    movementResolution: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    movementTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    accThreshAct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    accThreshInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    accTimeoutInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    nod: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"gnss">, import("@sinclair/typebox").TLiteral<"ncell">, import("@sinclair/typebox").TLiteral<"wifi">]>>>;
+}>;
+declare const Device: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    state: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        reported: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            config: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                activeMode: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+                locationTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                activeWaitTime: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                movementResolution: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                movementTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accThreshAct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accThreshInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accTimeoutInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                nod: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"gnss">, import("@sinclair/typebox").TLiteral<"ncell">, import("@sinclair/typebox").TLiteral<"wifi">]>>>;
+            }>>;
+            connection: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"connected">, import("@sinclair/typebox").TLiteral<"disconnected">]>>;
+            }>>;
+            device: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                deviceInfo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                    appVersion: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                    modemFirmware: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                    imei: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                    board: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                    hwVer: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                }>>;
+            }>>;
+        }>>;
+        desired: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            config: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                activeMode: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+                locationTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                activeWaitTime: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                movementResolution: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                movementTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accThreshAct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accThreshInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                accTimeoutInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                nod: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"gnss">, import("@sinclair/typebox").TLiteral<"ncell">, import("@sinclair/typebox").TLiteral<"wifi">]>>>;
+            }>>;
+        }>>;
+        version: import("@sinclair/typebox").TNumber;
+    }>>;
+    firmware: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        app: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            name: import("@sinclair/typebox").TString;
+            version: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+}>;
+declare const Devices: import("@sinclair/typebox").TObject<{
+    total: import("@sinclair/typebox").TInteger;
+    items: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        state: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            reported: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                config: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                    activeMode: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+                    locationTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    activeWaitTime: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    movementResolution: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    movementTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accThreshAct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accThreshInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accTimeoutInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    nod: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"gnss">, import("@sinclair/typebox").TLiteral<"ncell">, import("@sinclair/typebox").TLiteral<"wifi">]>>>;
+                }>>;
+                connection: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"connected">, import("@sinclair/typebox").TLiteral<"disconnected">]>>;
+                }>>;
+                device: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                    deviceInfo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                        appVersion: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                        modemFirmware: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                        imei: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                        board: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                        hwVer: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                    }>>;
+                }>>;
+            }>>;
+            desired: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                config: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                    activeMode: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+                    locationTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    activeWaitTime: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    movementResolution: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    movementTimeout: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accThreshAct: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accThreshInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    accTimeoutInact: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+                    nod: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"gnss">, import("@sinclair/typebox").TLiteral<"ncell">, import("@sinclair/typebox").TLiteral<"wifi">]>>>;
+                }>>;
+            }>>;
+            version: import("@sinclair/typebox").TNumber;
+        }>>;
+        firmware: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            app: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                name: import("@sinclair/typebox").TString;
+                version: import("@sinclair/typebox").TString;
+            }>>;
+        }>>;
+    }>>;
+}>;
+type FwType = 'APP' | 'MODEM' | 'BOOT' | 'SOFTDEVICE' | 'BOOTLOADER' | 'MDM_FULL';
+export declare const devices: ({ endpoint, apiKey, }: {
+    endpoint: URL;
+    apiKey: string;
+}, fetchImplementation?: typeof fetch) => {
+    list: () => Promise<{
+        error: Error | ValidationError;
+    } | {
+        result: Static<typeof Devices>;
+    }>;
+    get: (id: string) => Promise<{
+        error: Error | ValidationError;
+    } | {
+        result: Static<typeof Device>;
+    }>;
+    updateConfig: (id: string, config: Nullable<Omit<Static<typeof DeviceConfig>, 'nod'>> & Pick<Static<typeof DeviceConfig>, 'nod'>) => Promise<{
+        error: Error;
+    } | {
+        success: boolean;
+    }>;
+    register: (devices: {
+        deviceId: string;
+        subType?: string;
+        tags?: string[];
+        fwTypes?: FwType[];
+        certPem: string;
+    }[]) => Promise<{
+        error: Error;
+    } | {
+        bulkOpsRequestId: string;
+    }>;
+};
+export {};

package/dist/api/devices.js

@@ -0,0 +1,121 @@
+import { Type } from '@sinclair/typebox';
+import { slashless } from './slashless.js';
+import { ValidationError, validatedFetch } from './validatedFetch.js';
+export const DeviceConfig = Type.Partial(Type.Object({
+    activeMode: Type.Boolean(), // e.g. false
+    locationTimeout: Type.Number(), // e.g. 300
+    activeWaitTime: Type.Number(), // e.g. 120
+    movementResolution: Type.Number(), // e.g. 120
+    movementTimeout: Type.Number(), // e.g. 3600
+    accThreshAct: Type.Number(), // e.g. 4
+    accThreshInact: Type.Number(), // e.g. 4
+    accTimeoutInact: Type.Number(), // e.g. 60
+    nod: Type.Array(Type.Union([
+        Type.Literal('gnss'),
+        Type.Literal('ncell'),
+        Type.Literal('wifi'),
+    ])), // e.g. ['nod']
+}));
+const Device = Type.Object({
+    id: Type.String(),
+    state: Type.Optional(Type.Object({
+        reported: Type.Optional(Type.Object({
+            config: Type.Optional(DeviceConfig),
+            connection: Type.Optional(Type.Object({
+                status: Type.Optional(Type.Union([
+                    Type.Literal('connected'),
+                    Type.Literal('disconnected'),
+                ])),
+            })),
+            device: Type.Optional(Type.Object({
+                deviceInfo: Type.Optional(Type.Partial(Type.Object({
+                    appVersion: Type.String(), // e.g. '1.1.0'
+                    modemFirmware: Type.String(), // e.g. 'mfw_nrf9160_1.3.4'
+                    imei: Type.String(), // e.g. '352656108602296'
+                    board: Type.String(), // e.g. 'thingy91_nrf9160'
+                    hwVer: Type.String(), // e.g. 'nRF9160 SICA B1A'
+                }))),
+            })),
+        })),
+        desired: Type.Optional(Type.Object({
+            config: Type.Optional(DeviceConfig),
+        })),
+        version: Type.Number(),
+    })),
+    firmware: Type.Optional(Type.Object({
+        app: Type.Optional(Type.Object({
+            name: Type.String({ minLength: 1 }),
+            version: Type.String({ minLength: 1 }),
+        })),
+    })),
+});
+const Page = (Item) => Type.Object({
+    total: Type.Integer(),
+    items: Type.Array(Item),
+});
+const Devices = Page(Device);
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/IP-Devices/operation/ProvisionDevices
+ */
+const ProvisionDevice = Type.Object({
+    bulkOpsRequestId: Type.String(),
+});
+export const devices = ({ endpoint, apiKey, }, fetchImplementation) => {
+    const headers = {
+        Authorization: `Bearer ${apiKey}`,
+        Accept: 'application/json; charset=utf-8',
+    };
+    const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation);
+    return {
+        list: async () => vf({
+            resource: `devices?${new URLSearchParams({
+                pageLimit: '100',
+                deviceNameFuzzy: 'oob-',
+            }).toString()}`,
+        }, Devices),
+        get: async (id) => vf({ resource: `devices/${encodeURIComponent(id)}` }, Device),
+        updateConfig: async (id, config) => fetch(`${slashless(endpoint)}/v1/devices/${encodeURIComponent(id)}/state`, {
+            headers: {
+                ...headers,
+                'Content-Type': 'application/json',
+            },
+            method: 'PATCH',
+            body: JSON.stringify({
+                desired: {
+                    config,
+                },
+            }),
+        }).then((res) => {
+            if (res.status >= 400)
+                return { error: new Error(`Update failed: ${res.status}`) };
+            return { success: true };
+        }),
+        register: async (devices) => {
+            const bulkRegistrationPayload = devices
+                .map(({ deviceId, subType, tags, fwTypes, certPem }) => [
+                [
+                    deviceId,
+                    subType ?? '',
+                    (tags ?? []).join('|'),
+                    (fwTypes ?? []).join('|'),
+                    `"${certPem}"`,
+                ],
+            ])
+                .map((cols) => cols.join(','))
+                .join('\n');
+            const maybeResult = await vf({
+                resource: 'devices',
+                payload: {
+                    body: bulkRegistrationPayload,
+                    type: 'application/octet-stream',
+                },
+            }, ProvisionDevice);
+            if ('error' in maybeResult) {
+                return {
+                    error: maybeResult.error,
+                };
+            }
+            return { bulkOpsRequestId: maybeResult.result.bulkOpsRequestId };
+        },
+    };
+};

package/dist/api/getAccountInfo.d.ts

@@ -0,0 +1,18 @@
+import { type Static } from '@sinclair/typebox';
+import type { ValidationError } from 'ajv';
+declare const AccountInfoType: import("@sinclair/typebox").TObject<{
+    mqttEndpoint: import("@sinclair/typebox").TString;
+    mqttTopicPrefix: import("@sinclair/typebox").TString;
+    team: import("@sinclair/typebox").TObject<{
+        tenantId: import("@sinclair/typebox").TString;
+        name: import("@sinclair/typebox").TString;
+    }>;
+}>;
+export type AccountInfo = Static<typeof AccountInfoType>;
+export declare const getAccountInfo: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => Promise<{
+    error: Error | ValidationError;
+} | AccountInfo>;
+export {};

package/dist/api/getAccountInfo.js

@@ -0,0 +1,21 @@
+import { Type } from '@sinclair/typebox';
+import { validatedFetch } from './validatedFetch.js';
+const AccountInfoType = Type.Object({
+    mqttEndpoint: Type.String(), // e.g. 'mqtt.nrfcloud.com'
+    mqttTopicPrefix: Type.String(), // e.g. 'prod/a0673464-e4e1-4b87-bffd-6941a012067b/',
+    team: Type.Object({
+        tenantId: Type.String(), // e.g. 'bbfe6b73-a46a-43ad-94bd-8e4b4a7847ce',
+        name: Type.String(), // e.g. 'hello.nrfcloud.com'
+    }),
+});
+export const getAccountInfo = async ({ apiKey, endpoint, }, fetchImplementation) => {
+    const maybeAccount = await validatedFetch({
+        endpoint,
+        apiKey,
+    }, fetchImplementation)({
+        resource: 'account',
+    }, AccountInfoType);
+    if ('error' in maybeAccount)
+        return maybeAccount;
+    return maybeAccount.result;
+};

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

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

package/dist/api/getAccountInfo.spec.js

@@ -0,0 +1,25 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { getAccountInfo } from './getAccountInfo.js';
+import APIresponse from './test-data/account.json';
+import { check, objectMatching } from 'tsmatchers';
+void describe('getAccountInfo()', () => {
+    void it('return the account info', async () => {
+        const res = await getAccountInfo({
+            endpoint: new URL('https://example.com/'),
+            apiKey: 'some-key',
+        }, () => Promise.resolve({
+            ok: true,
+            json: async () => Promise.resolve(APIresponse),
+        }));
+        assert.equal('error' in res, false);
+        check(res).is(objectMatching({
+            mqttEndpoint: 'mqtt.nrfcloud.com',
+            mqttTopicPrefix: 'prod/b8b26bc5-2814-4063-b4fa-83ecddb2fec7/',
+            team: {
+                tenantId: 'b8b26bc5-2814-4063-b4fa-83ecddb2fec7',
+                name: 'XXX',
+            },
+        }));
+    });
+});

package/dist/api/getCurrentMonthlyCosts.d.ts

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

package/dist/api/getCurrentMonthlyCosts.js

@@ -0,0 +1,15 @@
+import { validatedFetch } from './validatedFetch.js';
+import { Type } from '@sinclair/typebox';
+export const getCurrentMonthlyCosts = ({ apiKey, endpoint, }, fetchImplementation) => async () => {
+    const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation);
+    const maybeResult = await vf({ resource: 'account' }, Type.Object({
+        plan: Type.Object({
+            currentMonthTotalCost: Type.Number(), // e.g. 2.73
+        }),
+    }));
+    if ('error' in maybeResult) {
+        return maybeResult;
+    }
+    const currentMonthTotalCost = maybeResult.result.plan.currentMonthTotalCost;
+    return { currentMonthTotalCost };
+};

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

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

package/dist/api/getCurrentMonthlyCosts.spec.js

@@ -0,0 +1,17 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { getCurrentMonthlyCosts } from './getCurrentMonthlyCosts.js';
+import APIresponse from './test-data/account.json';
+void describe('getCurrentMonthlyCosts()', () => {
+    void it("return the current month's total cost for an account", async () => {
+        const res = await getCurrentMonthlyCosts({
+            endpoint: new URL('https://example.com/'),
+            apiKey: 'some-key',
+        }, () => Promise.resolve({
+            ok: true,
+            json: async () => Promise.resolve(APIresponse),
+        }))();
+        assert.equal('error' in res, false);
+        assert.equal('currentMonthTotalCost' in res && res.currentMonthTotalCost, 24.03);
+    });
+});

package/dist/api/getDeviceShadow.d.ts

@@ -0,0 +1,23 @@
+import { type Static } from '@sinclair/typebox';
+import type { ValidationError } from 'ajv';
+declare const DeviceShadows: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    state: import("@sinclair/typebox").TObject<{
+        reported: import("@sinclair/typebox").TObject<{}>;
+        version: import("@sinclair/typebox").TNumber;
+        metadata: import("@sinclair/typebox").TObject<{
+            reported: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+                timestamp: import("@sinclair/typebox").TInteger;
+            }>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>]>>;
+        }>;
+    }>;
+}>>;
+export declare const getDeviceShadow: ({ endpoint, apiKey, }: {
+    endpoint: URL;
+    apiKey: string;
+}, fetchImplementation?: typeof fetch) => (devices: string[]) => Promise<{
+    shadows: Static<typeof DeviceShadows>;
+} | {
+    error: Error | ValidationError;
+}>;
+export {};