@hello.nrfcloud.com/nrfcloud-api-helpers 6.0.466 → 6.0.468

package/npm/{src/settings → settings}/settings.d.ts

@@ -16,35 +16,29 @@ export declare const getSettings: ({ ssm, stackName, account, }: {
     ssm: SSMClient;
     stackName: string;
     account: string;
-}) => (() => Promise<Settings>);
+}) => () => Promise<Settings>;
 export declare const getAPISettings: ({ ssm, stackName, account, }: {
     ssm: SSMClient;
     stackName: string;
     account: string;
-}) => (() => Promise<Pick<Settings, "apiKey" | "apiEndpoint">>);
+}) => () => Promise<Pick<Settings, "apiEndpoint" | "apiKey">>;
 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;
     account: string;
-}) => ((property: keyof Settings, value: string, deleteBeforeUpdate: boolean) => ReturnType<({ property, value, deleteBeforeUpdate, }: {
-    property: string;
-    value: string;
-    deleteBeforeUpdate?: boolean;
-}) => Promise<{
+}) => (property: keyof Settings, value: string, deleteBeforeUpdate: boolean) => Promise<{
     name: string;
-}>>);
+}>;
 export declare const deleteSettings: ({ ssm, stackName, account, }: {
     ssm: SSMClient;
     stackName: string;
     account: string;
-}) => ((property: string) => ReturnType<({ property }: {
-    property: string;
-}) => Promise<{
+}) => (property: string) => Promise<{
     name: string;
-}>>);
+}>;
 export declare const validateSettings: (p: Record<string, string>) => Settings;

package/npm/settings/settings.js

@@ -0,0 +1,83 @@
+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)
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "6.0.466",
+  "version": "6.0.468",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -14,7 +14,7 @@
   "scripts": {
     "test": "node --no-warnings --experimental-transform-types --test \"!(node_modules|e2e-tests|integration-tests)/**/*.spec.ts\"",
     "prepare": "husky",
-    "prepublishOnly": "node --experimental-strip-types ./.npm/compile.ts && npx tsc -P ./.npm/tsconfig.npm.json --outDir ./npm"
+    "prepublishOnly": "node --experimental-strip-types ./.npm/compile.ts && npx tsgo -P ./.npm/tsconfig.npm.json --outDir ./npm && mv npm/src/* npm"
   },
   "repository": {
     "type": "git",

package/npm/src/api/createAccountDevice.d.ts

@@ -1,13 +0,0 @@
-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/npm/src/api/devices.d.ts

@@ -1,78 +0,0 @@
-import { type Static } from '@sinclair/typebox';
-import { DeviceShadow } from './DeviceShadow.ts';
-import type { FetchError } from './FetchError.ts';
-import { type ValidationError } from './validatedFetch.ts';
-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;
-        $meta: import("@sinclair/typebox").TObject<{
-            createdAt: import("@sinclair/typebox").TString;
-            updatedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
-        }>;
-        state: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
-            reported: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>>;
-            desired: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>>;
-            version: import("@sinclair/typebox").TNumber;
-            metadata: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>;
-        }>>;
-    }>>;
-}>;
-/**
- * firmware types supported by a device for FOTA
- */
-export declare enum FwType {
-    APP = "APP",
-    MODEM = "MODEM",
-    BOOT = "BOOT",
-    SOFTDEVICE = "SOFTDEVICE",
-    BOOTLOADER = "BOOTLOADER",
-    MDM_FULL = "MDM_FULL"
-}
-export declare const devices: ({ endpoint, apiKey, }: {
-    endpoint: URL;
-    apiKey: string;
-}, fetchImplementation?: typeof fetch) => {
-    list: () => Promise<{
-        error: FetchError | ValidationError;
-    } | {
-        result: Static<typeof Devices>;
-    }>;
-    get: (id: string) => Promise<{
-        error: FetchError | ValidationError;
-    } | {
-        result: Static<typeof DeviceShadow>;
-    }>;
-    updateState: (id: string, state: {
-        desired?: Record<string, any>;
-        reported?: Record<string, any>;
-    }) => Promise<{
-        error: FetchError | ValidationError;
-    } | {
-        success: boolean;
-    }>;
-    register: (devices: {
-        deviceId: string;
-        certPem: string;
-        subType?: string;
-        tags?: string[];
-        /**
-         * A list of pipe-delimited firmware types that each device supports for FOTA (e.g., APP|MODEM)
-         *
-         * Defaults to all supported (APP|MODEM|BOOT|SOFTDEVICE|BOOTLOADER|MDM_FULL)
-         *
-         * @default 'APP|MODEM|BOOT|SOFTDEVICE|BOOTLOADER|MDM_FULL'
-         */
-        fwTypes?: FwType[];
-    }[]) => Promise<{
-        error: FetchError | ValidationError;
-    } | {
-        bulkOpsRequestId: string;
-    }>;
-    remove: (deviceId: string) => Promise<{
-        error: FetchError | ValidationError;
-    } | {
-        success: boolean;
-    }>;
-};
-export {};

package/npm/src/api/getDeviceShadow.d.ts

@@ -1,25 +0,0 @@
-import { type Static } from '@sinclair/typebox';
-import type { FetchError } from './FetchError.ts';
-import type { ValidationError } from './validatedFetch.ts';
-declare const DeviceShadows: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
-    id: import("@sinclair/typebox").TString;
-    $meta: import("@sinclair/typebox").TObject<{
-        createdAt: import("@sinclair/typebox").TString;
-        updatedAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
-    }>;
-    state: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
-        reported: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>>;
-        desired: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>>;
-        version: import("@sinclair/typebox").TNumber;
-        metadata: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>;
-    }>>;
-}>>;
-export declare const getDeviceShadow: ({ endpoint, apiKey, }: {
-    endpoint: URL;
-    apiKey: string;
-}, fetchImplementation?: typeof fetch) => ((devices: string[]) => Promise<{
-    shadows: Static<typeof DeviceShadows>;
-} | {
-    error: FetchError | ValidationError;
-}>);
-export {};