@bifravst/aws-ssm-settings-helpers 1.0.0 → 1.0.1

package/dist/settings.d.ts

@@ -1,18 +1,21 @@
 import { SSMClient } from '@aws-sdk/client-ssm';
-export declare const settingsPath: ({ stackName, scope, property, }: {
+export declare const settingsPath: ({ stackName, scope, context, property, }: {
     stackName: string;
     scope: string;
+    context: string;
     property?: string | undefined;
 }) => string;
-export declare const getSettings: <Settings extends Record<string, string>>({ ssm, stackName, scope, }: {
+export declare const getSettings: <Settings extends Record<string, string>>({ ssm, stackName, scope, context, }: {
     ssm: SSMClient;
     stackName: string;
     scope: string;
+    context: string;
 }) => () => Promise<Settings>;
-export declare const putSettings: ({ ssm, stackName, scope, }: {
+export declare const putSettings: ({ ssm, stackName, scope, context, }: {
     ssm: SSMClient;
     stackName: string;
     scope: string;
+    context: string;
 }) => ({ property, value, deleteBeforeUpdate, }: {
     property: string;
     value: string;
@@ -23,10 +26,11 @@ export declare const putSettings: ({ ssm, stackName, scope, }: {
 }) => Promise<{
     name: string;
 }>;
-export declare const deleteSettings: ({ ssm, stackName, scope, }: {
+export declare const deleteSettings: ({ ssm, stackName, scope, context, }: {
     ssm: SSMClient;
     stackName: string;
     scope: string;
+    context: string;
 }) => ({ property }: {
     property: string;
 }) => Promise<{

package/dist/settings.js

@@ -1,16 +1,23 @@
 import { DeleteParameterCommand, GetParametersByPathCommand, PutParameterCommand, SSMClient, } from '@aws-sdk/client-ssm';
 import { paginate } from './paginate.js';
-const scopeRx = new RegExp(`^[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+$`);
-const validScope = (scope) => scopeRx.test(scope);
-export const settingsPath = ({ stackName, scope, property, }) => {
-    if (!validScope(scope))
-        throw new Error(`Invalid scope name`);
-    const base = `/${stackName}/${scope}`;
-    return property === undefined ? base : `${base}/${property}`;
+const nameRx = /^[a-zA-Z0-9_.-]+$/;
+export const settingsPath = ({ stackName, scope, context, property, }) => {
+    if (!nameRx.test(stackName))
+        throw new Error(`Invalid stackName value: ${stackName}!`);
+    if (!nameRx.test(scope))
+        throw new Error(`Invalid scope value: ${scope}!`);
+    if (!nameRx.test(context))
+        throw new Error(`Invalid context value: ${context}!`);
+    const parts = [stackName, scope, context];
+    if (property !== undefined) {
+        if (!nameRx.test(property))
+            throw new Error(`Invalid property value: ${property}!`);
+        parts.push(property);
+    }
+    return `/${parts.join('/')}`;
 };
-const settingsName = ({ stackName, scope, property, }) => settingsPath({ stackName, scope, property });
-export const getSettings = ({ ssm, stackName, scope, }) => async () => {
-    const Path = settingsPath({ stackName, scope });
+export const getSettings = ({ ssm, stackName, scope, context, }) => async () => {
+    const Path = settingsPath({ stackName, scope, context });
     const Parameters = [];
     await paginate({
         paginator: async (NextToken) => ssm
@@ -26,7 +33,7 @@ export const getSettings = ({ ssm, stackName, scope, }) => async () => {
         }),
     });
     if (Parameters.length === 0)
-        throw new Error(`System not configured: ${Path}!`);
+        throw new Error(`context not configured: ${Path}!`);
     return Parameters.map(({ Name, ...rest }) => ({
         ...rest,
         Name: Name?.replace(`${Path}/`, ''),
@@ -35,8 +42,8 @@ export const getSettings = ({ ssm, stackName, scope, }) => async () => {
         [Name ?? '']: Value ?? '',
     }), {});
 };
-export const putSettings = ({ ssm, stackName, scope, }) => async ({ property, value, deleteBeforeUpdate, }) => {
-    const Name = settingsName({ stackName, scope, property });
+export const putSettings = ({ ssm, stackName, scope, context, }) => async ({ property, value, deleteBeforeUpdate, }) => {
+    const Name = settingsPath({ stackName, scope, context, property });
     if (deleteBeforeUpdate ?? false) {
         try {
             await ssm.send(new DeleteParameterCommand({
@@ -55,8 +62,8 @@ export const putSettings = ({ ssm, stackName, scope, }) => async ({ property, va
     }));
     return { name: Name };
 };
-export const deleteSettings = ({ ssm, stackName, scope, }) => async ({ property }) => {
-    const Name = settingsName({ stackName, scope, property });
+export const deleteSettings = ({ ssm, stackName, scope, context, }) => async ({ property }) => {
+    const Name = settingsPath({ stackName, scope, context, property });
     try {
         await ssm.send(new DeleteParameterCommand({
             Name,

package/dist/settings.spec.js

@@ -8,7 +8,8 @@ void describe('getSettingsOptional()', () => {
                 send: async () => Promise.resolve({ Parameters: undefined }),
             },
             stackName: 'STACK_NAME',
-            scope: 'stack/context',
+            scope: 'stack',
+            context: 'context',
         });
         const result = await stackConfig({});
         assert.deepEqual(result, {});
@@ -16,18 +17,21 @@ void describe('getSettingsOptional()', () => {
 });
 void describe('settingsPath()', () => {
     void it('should produce a fully qualified parameter name', () => assert.equal(settingsPath({
-        scope: 'stack/context',
+        scope: 'stack',
+        context: 'context',
         stackName: 'hello-nrfcloud',
         property: 'someProperty',
     }), '/hello-nrfcloud/stack/context/someProperty'));
     void it('should produce a fully qualified parameter name for valid string scope', () => assert.equal(settingsPath({
-        scope: 'thirdParty/elite',
+        scope: 'thirdParty',
+        context: 'elite',
         stackName: 'hello-nrfcloud',
         property: 'someProperty',
     }), '/hello-nrfcloud/thirdParty/elite/someProperty'));
     void it('should error for invalid string scope', () => {
         assert.throws(() => settingsPath({
-            scope: 'invalidScope',
+            scope: 'thirdParty',
+            context: 'el ite',
             stackName: 'hello-nrfcloud',
             property: 'someProperty',
         }));
@@ -54,7 +58,8 @@ void describe('getSettings()', () => {
                 send: async () => Promise.resolve({ Parameters: returnedValues }),
             },
             stackName: 'hello-nrfcloud',
-            scope: 'stack/context',
+            scope: 'stack',
+            context: 'context',
         });
         const result = await stackConfig();
         assert.deepEqual(result, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifravst/aws-ssm-settings-helpers",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Helper functions written in TypeScript for storing and retrieving application settings in AWS SSM Parameter Store.",
   "exports": {
     ".": {