@hello.nrfcloud.com/nrfcloud-api-helpers 6.0.463 → 6.0.464

package/dist/api/validatedFetch.spec.js

@@ -1,132 +0,0 @@
-import { Type } from '@sinclair/typebox';
-import assert from 'node:assert/strict';
-import { describe, it, mock } from 'node:test';
-import { FetchError } from './FetchError.js';
-import { JSONPayload, validatedFetch } from './validatedFetch.js';
-void describe('validatedFetch()', () => {
-    void it('should call an nRF Cloud API endpoint and validate the response', async () => {
-        const mockFetch = mock.fn(() => ({
-            ok: true,
-            json: async () => Promise.resolve({
-                foo: 'bar',
-            }),
-        }));
-        const vf = validatedFetch({
-            endpoint: new URL('https://example.com/'),
-            apiKey: 'some-key',
-        }, mockFetch);
-        const schema = Type.Object({ foo: Type.Literal('bar') });
-        const res = await vf({ resource: 'foo' }, schema);
-        assert.equal('error' in res, false);
-        assert.equal('result' in res, true);
-        assert.deepEqual('result' in res && res.result, { foo: 'bar' });
-        assert.deepEqual(mockFetch.mock.calls[0]?.arguments, [
-            `https://example.com/v1/foo`,
-            {
-                headers: {
-                    Accept: 'application/json; charset=utf-8',
-                    Authorization: 'Bearer some-key',
-                },
-            },
-        ]);
-    });
-    void it('should return the fetch exception', async () => {
-        const err = new Error(`Some error`);
-        const vf = validatedFetch({
-            endpoint: new URL('https://example.com/'),
-            apiKey: 'some-key',
-        }, () => Promise.reject(err));
-        assert.deepEqual(await vf({ resource: 'some-resource' }, Type.Object({})), {
-            error: err,
-        });
-    });
-    void it('should send POST request if body is given', async () => {
-        const mockFetch = mock.fn(() => ({
-            ok: true,
-            json: async () => Promise.resolve({}),
-        }));
-        const vf = validatedFetch({
-            endpoint: new URL('https://example.com/'),
-            apiKey: 'some-key',
-        }, mockFetch);
-        await vf({
-            resource: 'foo',
-            payload: {
-                type: 'application/octet-stream',
-                body: 'some data',
-            },
-        }, Type.Object({}));
-        assert.deepEqual(mockFetch.mock.calls[0]?.arguments, [
-            `https://example.com/v1/foo`,
-            {
-                method: 'POST',
-                body: 'some data',
-                headers: {
-                    Accept: 'application/json; charset=utf-8',
-                    Authorization: 'Bearer some-key',
-                    'Content-Type': 'application/octet-stream',
-                },
-            },
-        ]);
-    });
-    void it('should allow to specify the method', async () => {
-        const mockFetch = mock.fn(() => ({
-            ok: true,
-            json: async () => Promise.resolve({}),
-        }));
-        const vf = validatedFetch({
-            endpoint: new URL('https://example.com/'),
-            apiKey: 'some-key',
-        }, mockFetch);
-        await vf({
-            resource: 'foo',
-            method: 'POST',
-        }, Type.Object({}));
-        assert.deepEqual(mockFetch.mock.calls[0]?.arguments, [
-            `https://example.com/v1/foo`,
-            {
-                method: 'POST',
-                headers: {
-                    Accept: 'application/json; charset=utf-8',
-                    Authorization: 'Bearer some-key',
-                },
-            },
-        ]);
-    });
-    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 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' }), {
-        type: 'application/json',
-        body: JSON.stringify({ foo: 'bar' }),
-    }));
-});

package/dist/settings/getAllAccounts.js

@@ -1,9 +0,0 @@
-import { get } from '@bifravst/aws-ssm-settings-helpers';
-import { NRFCLOUD_ACCOUNT_SCOPE } from './scope.js';
-export const getAllAccounts = async ({ ssm, stackName, }) => [
-    ...getAccountsFromAllSettings(await get(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-    })()),
-];
-export const getAccountsFromAllSettings = (settings) => new Set(Object.keys(settings).map((key) => key.split('/')[0]));

package/dist/settings/getAllAccountsSettings.js

@@ -1,14 +0,0 @@
-import { get } from '@bifravst/aws-ssm-settings-helpers';
-import { groupByAccount } from './groupByAccount.js';
-import { NRFCLOUD_ACCOUNT_SCOPE } from './scope.js';
-import { validateSettings } from './settings.js';
-/**
- * Returns settings for all accounts
- */
-export const getAllAccountsSettings = async ({ ssm, stackName, }) => Object.entries(groupByAccount(await get(ssm)({
-    stackName,
-    scope: NRFCLOUD_ACCOUNT_SCOPE,
-})())).reduce((allSettings, [account, settings]) => ({
-    ...allSettings,
-    [account]: validateSettings(settings),
-}), {});

package/dist/settings/groupByAccount.js

@@ -1,14 +0,0 @@
-import { getAccountsFromAllSettings } from './getAllAccounts.js';
-export const groupByAccount = (allSettings) => {
-    const accounts = getAccountsFromAllSettings(allSettings);
-    return [...accounts].reduce((allAccountSettings, account) => ({
-        ...allAccountSettings,
-        [account]: Object.entries(allSettings)
-            .filter(([k]) => k.startsWith(`${account}/`))
-            .map(([k, v]) => [
-            k.replace(new RegExp(`^${account}/`), ''),
-            v,
-        ])
-            .reduce((s, [k, v]) => ({ ...s, [k]: v }), {}),
-    }), {});
-};

package/dist/settings/groupByAccount.spec.js

@@ -1,20 +0,0 @@
-import assert from 'node:assert/strict';
-import { describe, it } from 'node:test';
-import { groupByAccount } from './groupByAccount.js';
-void describe('groupByAccount()', () => {
-    void it('should group settings by account', () => assert.deepEqual(groupByAccount({
-        'elite/accountDeviceClientId': 'account-4db55163-7593-4d63-9679-d16fbc2d464f',
-        'elite/healthCheckModel': 'PCA20035+solar',
-        'acme/mqttEndpoint': 'mqtt.nrfcloud.com',
-        'acme/teamId': 'f4ba6ede-7867-43eb-a495-7e0de108f52e',
-    }), {
-        acme: {
-            mqttEndpoint: 'mqtt.nrfcloud.com',
-            teamId: 'f4ba6ede-7867-43eb-a495-7e0de108f52e',
-        },
-        elite: {
-            accountDeviceClientId: 'account-4db55163-7593-4d63-9679-d16fbc2d464f',
-            healthCheckModel: 'PCA20035+solar',
-        },
-    }));
-});

package/dist/settings/index.d.ts

@@ -1,5 +0,0 @@
-export * from './getAllAccounts.js';
-export * from './getAllAccountsSettings.js';
-export * from './groupByAccount.js';
-export * from './scope.js';
-export * from './settings.js';

package/dist/settings/index.js

@@ -1,5 +0,0 @@
-export * from './getAllAccounts.js';
-export * from './getAllAccountsSettings.js';
-export * from './groupByAccount.js';
-export * from './scope.js';
-export * from './settings.js';

package/dist/settings/scope.js

@@ -1,7 +0,0 @@
-export const NRFCLOUD_ACCOUNT_SCOPE = 'thirdParty';
-const nameRx = /^[a-zA-Z0-9_.-]+$/;
-export const nrfCloudAccount = (account) => {
-    if (!nameRx.test(account))
-        throw new Error(`Invalid account name: ${account}`);
-    return account;
-};

package/dist/settings/settings.js

@@ -1,88 +0,0 @@
-import { remove as deleteSSMSettings, get as getSSMSettings, put as putSSMSettings, } from '@bifravst/aws-ssm-settings-helpers';
-import { NRFCLOUD_ACCOUNT_SCOPE, nrfCloudAccount } from './scope.js';
-export const defaultApiEndpoint = new URL('https://api.nrfcloud.com');
-export const defaultCoAPEndpoint = new URL('coaps://coap.nrfcloud.com');
-export const getSettings = ({ ssm, stackName, account, }) => {
-    const settingsReader = getSSMSettings(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-        context: nrfCloudAccount(account),
-    });
-    return async () => validateSettings(await settingsReader());
-};
-export const getAPISettings = ({ ssm, stackName, account, }) => {
-    const settingsReader = getSSMSettings(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-        context: nrfCloudAccount(account),
-    });
-    return async () => {
-        const p = await settingsReader();
-        const { apiEndpoint, apiKey } = p;
-        if (apiKey === undefined)
-            throw new Error(`No nRF Cloud API key configured!`);
-        return {
-            apiEndpoint: apiEndpoint === undefined ? defaultApiEndpoint : new URL(apiEndpoint),
-            apiKey,
-        };
-    };
-};
-export const putSettings = ({ ssm, stackName, account, }) => {
-    const settingsWriter = putSSMSettings(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-        context: nrfCloudAccount(account),
-    });
-    return async (settings) => {
-        await Promise.all(Object.entries(settings).map(async ([k, v]) => settingsWriter({
-            property: k,
-            value: v.toString(),
-        })));
-    };
-};
-export const putSetting = ({ ssm, stackName, account, }) => {
-    const settingsWriter = putSSMSettings(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-        context: nrfCloudAccount(account),
-    });
-    return async (property, value, deleteBeforeUpdate) => settingsWriter({
-        property,
-        value,
-        deleteBeforeUpdate,
-    });
-};
-export const deleteSettings = ({ ssm, stackName, account, }) => {
-    const settingsDeleter = deleteSSMSettings(ssm)({
-        stackName,
-        scope: NRFCLOUD_ACCOUNT_SCOPE,
-        context: nrfCloudAccount(account),
-    });
-    return async (property) => settingsDeleter({ property });
-};
-export const validateSettings = (p) => {
-    const { apiEndpoint, apiKey, accountDeviceClientCert, accountDevicePrivateKey, mqttEndpoint, accountDeviceClientId, mqttTopicPrefix, coapEndpoint, coapPort, } = p;
-    if (apiKey === undefined)
-        throw new Error(`No nRF Cloud API key configured!`);
-    if (accountDeviceClientCert === undefined)
-        throw new Error(`No nRF Cloud account device clientCert configured!`);
-    if (accountDevicePrivateKey === undefined)
-        throw new Error(`No nRF Cloud account device privateKey configured!`);
-    if (accountDeviceClientId === undefined)
-        throw new Error(`No nRF Cloud Account Device client ID configured!`);
-    if (mqttTopicPrefix === undefined)
-        throw new Error(`No nRF Cloud MQTT topic prefix configured!`);
-    if (mqttEndpoint === undefined)
-        throw new Error(`No nRF Cloud MQTT endpoint configured!`);
-    return {
-        apiEndpoint: apiEndpoint === undefined ? defaultApiEndpoint : new URL(apiEndpoint),
-        apiKey,
-        mqttEndpoint,
-        accountDeviceClientCert,
-        accountDevicePrivateKey,
-        accountDeviceClientId,
-        mqttTopicPrefix,
-        coapEndpoint: coapEndpoint === undefined ? defaultCoAPEndpoint : new URL(coapEndpoint),
-        coapPort: parseInt(coapPort ?? `5684`, 10),
-    };
-};