@dsmrt/axiom-aws-sdk 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ssm-parameters";
+export * from "./ssm-parameter-collection";

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ssm-parameters"), exports);
+__exportStar(require("./ssm-parameter-collection"), exports);

package/lib/ssm-parameter-collection.d.ts

@@ -0,0 +1,15 @@
+import { Parameter, SSMClient } from "@aws-sdk/client-ssm";
+export type Params = {
+    [key: string]: Parameter;
+};
+export declare class ParameterCollection<TParams extends Params> {
+    readonly path: string;
+    private readonly client?;
+    readonly map: Map<keyof TParams, Parameter>;
+    constructor(path: string, client?: SSMClient | undefined);
+    hasParam(param: keyof TParams): Promise<boolean>;
+    findParam(param: keyof TParams): Promise<Parameter | undefined>;
+    getParam(param: keyof TParams): Promise<Parameter>;
+    get(): Promise<Map<keyof TParams, Parameter>>;
+    private loadParameters;
+}

package/lib/ssm-parameter-collection.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterCollection = void 0;
+const ssm_parameters_1 = require("./ssm-parameters");
+class ParameterCollection {
+    path;
+    client;
+    map = new Map();
+    constructor(path, client) {
+        this.path = path;
+        this.client = client;
+    }
+    async hasParam(param) {
+        if (this.map.size < 1) {
+            await this.loadParameters();
+        }
+        return this.map.has(param);
+    }
+    async findParam(param) {
+        if (this.map.size < 1) {
+            await this.loadParameters();
+        }
+        return this.map.get(param);
+    }
+    async getParam(param) {
+        if (!(await this.hasParam(param))) {
+            throw new Error(`Parameter '${param.toString()}' does not exist'`);
+        }
+        return this.map.get(param);
+    }
+    async get() {
+        if (this.map.size < 1) {
+            await this.loadParameters();
+        }
+        return this.map;
+    }
+    async loadParameters() {
+        if (!this.path) {
+            throw new Error(`Parameter path is not set or is undefined`);
+        }
+        const params = await (0, ssm_parameters_1.getParametersByPath)(this.path, undefined, undefined, this.client);
+        params.forEach((param) => {
+            const fullName = param.Name;
+            const name = fullName.replace(`${this.path}/`, "");
+            this.map.set(name, param);
+        });
+    }
+}
+exports.ParameterCollection = ParameterCollection;

package/lib/ssm-parameters.d.ts

@@ -0,0 +1,11 @@
+import { SSMClient, Parameter } from "@aws-sdk/client-ssm";
+export declare const ssmClient: SSMClient;
+export declare const getParametersByPath: (path: string, parameters?: Parameter[], nextToken?: string, client?: SSMClient) => Promise<Parameter[]>;
+export declare const getParameters: (names: string[], client?: SSMClient) => Promise<Parameter[]>;
+/**
+ * Extract a single parameter from an array of params (typically from params by path)
+ *
+ * @param name
+ * @param params
+ */
+export declare const extractParamValue: (path: string, name: string, params: Parameter[]) => string;

package/lib/ssm-parameters.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractParamValue = exports.getParameters = exports.getParametersByPath = exports.ssmClient = void 0;
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+exports.ssmClient = new client_ssm_1.SSMClient({});
+// to use this, you need to give the lambda function permission to the
+// ** CloudFormation Example **
+// Resources:
+//   LambdaPolicies:
+//     Type: AWS::IAM::Policy
+//     Properties:
+//       PolicyName: LambdaRole
+//       PolicyDocument:
+//         Statement:
+//         - Effect: Allow
+//           Action:
+//           - "ssm:GetParameters"
+//           - "ssm:GetParametersByPath"
+//           Resource: !Sub 'arn:aws:ssm:*:*:parameter/${PARAMETER_PATH}/*'
+const getParametersByPath = async (path, parameters, nextToken, client) => {
+    client ??= exports.ssmClient;
+    let returnParams = parameters || [];
+    const command = new client_ssm_1.GetParametersByPathCommand({
+        Path: path,
+        Recursive: true,
+        WithDecryption: true,
+        NextToken: nextToken,
+    });
+    const output = await client.send(command);
+    // merge parameters
+    if (output.Parameters !== undefined) {
+        returnParams = [...returnParams, ...output.Parameters];
+    }
+    if (output.NextToken !== undefined) {
+        return (0, exports.getParametersByPath)(path, returnParams, output.NextToken, client);
+    }
+    // return all
+    return returnParams;
+};
+exports.getParametersByPath = getParametersByPath;
+// ** CloudFormation Example **
+// Resources:
+//   LambdaPolicies:
+//     Type: AWS::IAM::Policy
+//     Properties:
+//       PolicyName: LambdaRole
+//       PolicyDocument:
+//         Statement:
+//         - Effect: Allow
+//           Action:
+//           - "ssm:GetParameters"
+//           - "ssm:GetParametersByPath"
+//           Resource:
+//           - ${name1}
+//           - ${name2}
+//           - ${name3
+const getParameters = async (names, client) => {
+    client ??= exports.ssmClient;
+    const command = new client_ssm_1.GetParametersCommand({
+        Names: names,
+        WithDecryption: true,
+    });
+    const result = await client.send(command);
+    if (result.Parameters === undefined) {
+        return [];
+    }
+    return result.Parameters;
+};
+exports.getParameters = getParameters;
+/**
+ * Extract a single parameter from an array of params (typically from params by path)
+ *
+ * @param name
+ * @param params
+ */
+const extractParamValue = (path, name, params) => {
+    const fullName = `${path.replace(/\/$/, "")}/${name}`;
+    const item = params.find((item) => item.Name === fullName);
+    if (!item || !item.Value) {
+        throw new Error(`Parameter '${fullName}' is not set.`);
+    }
+    return item.Value;
+};
+exports.extractParamValue = extractParamValue;

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@dsmrt/axiom-aws-sdk",
+    "version": "0.0.1",
+    "description": "AWS sdk library for working with axiom cli",
+    "main": "lib/index.js",
+    "repository": {
+        "type": "git",
+        "url": "git@github.com:dsmrt/axiom.git",
+        "directory": "aws-sdk"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "scripts": {
+        "lint": "eslint ./src/ --ext .ts",
+        "lint:fix": "eslint ./src/ --ext .ts --fix",
+        "test": "vitest run --coverage -c ./vitest.config.ts",
+        "watch": "vitest watch --coverage -c ./vitest.config.ts",
+        "build": "tsc -d -p ./tsconfig.json"
+    },
+    "keywords": [
+        "axiom",
+        "config",
+        "aws"
+    ],
+    "author": {
+        "name": "Damien Smrt",
+        "url": "https://dsmrt.com"
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^20.9.0",
+        "@typescript-eslint/eslint-plugin": "^6.12.0",
+        "@typescript-eslint/parser": "^6.12.0",
+        "@vitest/coverage-v8": "^0.34.6",
+        "eslint": "^8.54.0",
+        "prettier": "^3.1.0",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.2.2",
+        "vitest": "^0.34.6"
+    },
+    "dependencies": {
+        "@aws-sdk/client-ssm": "^3.451.0",
+        "@aws-sdk/client-sts": "^3.454.0",
+        "@aws-sdk/credential-providers": "^3.454.0",
+        "@aws-sdk/types": "^3.451.0"
+    }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node16",
+    "outDir": "lib"
+  },
+  "include": ["src/index.ts"]
+}