@hello.nrfcloud.com/nrfcloud-api-helpers 1.1.0 → 1.1.2

package/dist/api/getDeviceShadow.d.ts

@@ -15,9 +15,9 @@ declare const DeviceShadows: import("@sinclair/typebox").TArray<import("@sinclai
 export declare const getDeviceShadow: ({ endpoint, apiKey, }: {
     endpoint: URL;
     apiKey: string;
-}, fetchImplementation?: typeof fetch) => (devices: string[]) => Promise<{
+}, fetchImplementation?: typeof fetch) => ((devices: string[]) => Promise<{
     shadows: Static<typeof DeviceShadows>;
 } | {
     error: Error | ValidationError;
-}>;
+}>);
 export {};

package/dist/api/updateDeviceShadow.d.ts

@@ -4,4 +4,9 @@ export declare const updateDeviceShadow: ({ endpoint, apiKey, }: {
 }, fetchImplementation?: typeof fetch) => (deviceId: string, state: {
     desired?: Record<string, any>;
     reported?: Record<string, any>;
-}) => Promise<void>;
+}) => Promise<MaybeOK>;
+export type MaybeOK = {
+    error: Error;
+} | {
+    ok: true;
+};

package/dist/api/updateDeviceShadow.js

@@ -1,6 +1,6 @@
 import { slashless } from './slashless.js';
 export const updateDeviceShadow = ({ endpoint, apiKey, }, fetchImplementation) => async (deviceId, state) => {
-    await (fetchImplementation ?? fetch)(new URL(`${slashless(endpoint)}/v1/devices/${encodeURIComponent(deviceId)}/state`), {
+    const res = await (fetchImplementation ?? fetch)(new URL(`${slashless(endpoint)}/v1/devices/${encodeURIComponent(deviceId)}/state`), {
         method: 'PATCH',
         headers: {
             'Content-Type': 'application/json',
@@ -8,4 +8,9 @@ export const updateDeviceShadow = ({ endpoint, apiKey, }, fetchImplementation) =
         },
         body: JSON.stringify(state),
     });
+    if (res.ok)
+        return { ok: true };
+    return {
+        error: new Error(`Update device status for ${deviceId} failed: ${res.status} (${await res.text()})`),
+    };
 };

package/dist/settings/getAllAccountSettings.d.ts

@@ -0,0 +1,9 @@
+import { SSMClient } from '@aws-sdk/client-ssm';
+import { type Settings } from './settings.js';
+/**
+ * Returns settings for all accounts
+ */
+export declare const getAllAccountSettings: ({ ssm, stackName, }: {
+    ssm: SSMClient;
+    stackName: string;
+}) => Promise<Record<string, Settings>>;

package/dist/settings/getAllAccountSettings.js

@@ -0,0 +1,29 @@
+import { SSMClient } from '@aws-sdk/client-ssm';
+import { get } from '@bifravst/aws-ssm-settings-helpers';
+import { getAccountsFromAllSettings } from './getAllAccounts.js';
+import { validateSettings } from './settings.js';
+import { NRFCLOUD_ACCOUNT_SCOPE } from './scope.js';
+/**
+ * Returns settings for all accounts
+ */
+export const getAllAccountSettings = async ({ ssm, stackName, }) => {
+    const allSettings = await get(ssm)({
+        stackName,
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+    })();
+    const accounts = getAccountsFromAllSettings(allSettings);
+    return [...accounts].reduce((allAccountSettings, account) => ({
+        ...allAccountSettings,
+        [account]: validateSettings(Object.entries(allSettings)
+            .filter(([k]) => k.startsWith(`${account}/`))
+            .map(([k, v]) => [
+            k.replace(new RegExp(`^${account}/`), ''),
+            v,
+        ])
+            .reduce((s, [k, v]) => ({ ...s, [k]: v }), {})),
+    }), {});
+};
+console.log(await getAllAccountSettings({
+    ssm: new SSMClient(),
+    stackName: 'hello-nrfcloud-backend',
+}));

package/dist/settings/getAllAccounts.d.ts

@@ -3,3 +3,4 @@ export declare const getAllAccounts: ({ ssm, stackName, }: {
     ssm: SSMClient;
     stackName: string;
 }) => Promise<string[]>;
+export declare const getAccountsFromAllSettings: (settings: Record<string, string>) => Set<string>;

package/dist/settings/getAllAccounts.js

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

package/dist/settings/initializeAccount.js

@@ -1,6 +1,6 @@
 import { SSMClient } from '@aws-sdk/client-ssm';
 import chalk from 'chalk';
-import { nrfCloudAccount } from './scope.js';
+import { NRFCLOUD_ACCOUNT_SCOPE, nrfCloudAccount } from './scope.js';
 import { get } from '@bifravst/aws-ssm-settings-helpers';
 import { createAccountDevice } from '../api/createAccountDevice.js';
 import { deleteAccountDevice } from '../api/deleteAccountDevice.js';
@@ -12,7 +12,8 @@ import { defaultApiEndpoint, getSettings as getNRFCloudSettings, putSettings as
 export const initializeAccount = ({ ssm, stackName, account, iotEndpoint, }) => async (reset = false) => {
     const settingsReader = get(ssm)({
         stackName,
-        ...nrfCloudAccount(account),
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+        context: nrfCloudAccount(account),
     });
     const { apiKey, apiEndpoint } = await settingsReader();
     if (apiKey === undefined)

package/dist/settings/scope.d.ts

@@ -1,17 +1,2 @@
-export declare enum Scopes {
-    STACK = "stack",
-    NRFCLOUD_BRIDGE_CERTIFICATE = "nRFCloudBridgeCertificate",
-    NRFCLOUD_ACCOUNT_PREFIX = "thirdParty"
-}
-export type ScopeContext = {
-    scope: string;
-    context: string;
-};
-export declare const ScopeContexts: {
-    readonly STACK_CONFIG: ScopeContext;
-    readonly STACK_MQTT_BRIDGE: ScopeContext;
-    readonly STACK_COAP_HEALTH_CHECK: ScopeContext;
-    readonly NRFCLOUD_BRIDGE_CERTIFICATE_MQTT: ScopeContext;
-    readonly NRFCLOUD_BRIDGE_CERTIFICATE_CA: ScopeContext;
-};
-export declare const nrfCloudAccount: (account: string) => ScopeContext;
+export declare const NRFCLOUD_ACCOUNT_SCOPE = "thirdParty";
+export declare const nrfCloudAccount: (account: string) => string;

package/dist/settings/scope.js

@@ -1,34 +1,7 @@
-export var Scopes;
-(function (Scopes) {
-    Scopes["STACK"] = "stack";
-    Scopes["NRFCLOUD_BRIDGE_CERTIFICATE"] = "nRFCloudBridgeCertificate";
-    Scopes["NRFCLOUD_ACCOUNT_PREFIX"] = "thirdParty";
-})(Scopes || (Scopes = {}));
-export const ScopeContexts = {
-    STACK_CONFIG: { scope: Scopes.STACK, context: 'context' },
-    STACK_MQTT_BRIDGE: {
-        scope: Scopes.STACK,
-        context: 'mqttBridge',
-    },
-    STACK_COAP_HEALTH_CHECK: {
-        scope: Scopes.STACK,
-        context: 'coap-health-check',
-    },
-    NRFCLOUD_BRIDGE_CERTIFICATE_MQTT: {
-        scope: Scopes.NRFCLOUD_BRIDGE_CERTIFICATE,
-        context: 'MQTT',
-    },
-    NRFCLOUD_BRIDGE_CERTIFICATE_CA: {
-        scope: Scopes.NRFCLOUD_BRIDGE_CERTIFICATE,
-        context: 'CA',
-    },
-};
+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 {
-        scope: Scopes.NRFCLOUD_ACCOUNT_PREFIX,
-        context: account,
-    };
+    return account;
 };

package/dist/settings/settings.d.ts

@@ -26,7 +26,7 @@ export declare const putSettings: ({ ssm, stackName, account, }: {
     ssm: SSMClient;
     stackName: string;
     account: string;
-}) => (settings: Partial<Settings>) => Promise<void>;
+}) => ((settings: Partial<Settings>) => Promise<void>);
 export declare const putSetting: ({ ssm, stackName, account, }: {
     ssm: SSMClient;
     stackName: string;
@@ -41,3 +41,4 @@ export declare const deleteSettings: ({ ssm, stackName, account, }: {
 }) => (property: string) => Promise<{
     name: string;
 }>;
+export declare const validateSettings: (p: Record<string, string>) => Settings;

package/dist/settings/settings.js

@@ -1,46 +1,20 @@
-import { nrfCloudAccount } from './scope.js';
+import { NRFCLOUD_ACCOUNT_SCOPE, nrfCloudAccount } from './scope.js';
 import { get as getSSMSettings, put as putSSMSettings, remove as deleteSSMSettings, } from '@bifravst/aws-ssm-settings-helpers';
 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,
-        ...nrfCloudAccount(account),
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+        context: nrfCloudAccount(account),
     });
-    return async () => {
-        const p = await settingsReader();
-        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),
-        };
-    };
+    return async () => validateSettings(await settingsReader());
 };
 export const getAPISettings = ({ ssm, stackName, account, }) => {
     const settingsReader = getSSMSettings(ssm)({
         stackName,
-        ...nrfCloudAccount(account),
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+        context: nrfCloudAccount(account),
     });
     return async () => {
         const p = await settingsReader();
@@ -56,7 +30,8 @@ export const getAPISettings = ({ ssm, stackName, account, }) => {
 export const putSettings = ({ ssm, stackName, account, }) => {
     const settingsWriter = putSSMSettings(ssm)({
         stackName,
-        ...nrfCloudAccount(account),
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+        context: nrfCloudAccount(account),
     });
     return async (settings) => {
         await Promise.all(Object.entries(settings).map(async ([k, v]) => settingsWriter({
@@ -68,7 +43,8 @@ export const putSettings = ({ ssm, stackName, account, }) => {
 export const putSetting = ({ ssm, stackName, account, }) => {
     const settingsWriter = putSSMSettings(ssm)({
         stackName,
-        ...nrfCloudAccount(account),
+        scope: NRFCLOUD_ACCOUNT_SCOPE,
+        context: nrfCloudAccount(account),
     });
     return async (property, value, deleteBeforeUpdate) => settingsWriter({
         property,
@@ -79,7 +55,34 @@ export const putSetting = ({ ssm, stackName, account, }) => {
 export const deleteSettings = ({ ssm, stackName, account, }) => {
     const settingsDeleter = deleteSSMSettings(ssm)({
         stackName,
-        ...nrfCloudAccount(account),
+        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),
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -32,11 +32,11 @@
   "author": "Nordic Semiconductor ASA | nordicsemi.no",
   "license": "BSD-3-Clause",
   "devDependencies": {
-    "@bifravst/eslint-config-typescript": "6.0.17",
+    "@bifravst/eslint-config-typescript": "6.0.21",
     "@bifravst/prettier-config": "1.0.0",
     "@commitlint/config-conventional": "19.1.0",
     "@types/aws-lambda": "8.10.137",
-    "@types/node": "20.12.3",
+    "@types/node": "20.12.7",
     "husky": "9.0.11",
     "tsmatchers": "5.0.2",
     "tsx": "4.7.2"