@tomassabol/aws-services 1.8.0 → 1.8.2

package/appconfig.d.ts

@@ -0,0 +1,3 @@
+import { AppConfigClient } from "@aws-sdk/client-appconfig";
+export declare const appConfigClient: AppConfigClient;
+export declare const getApplication: (applicationId: string) => Promise<import("@aws-sdk/client-appconfig").GetApplicationCommandOutput>;

package/appconfig.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApplication = exports.appConfigClient = void 0;
+const client_appconfig_1 = require("@aws-sdk/client-appconfig");
+const logger_1 = require("./logger");
+exports.appConfigClient = new client_appconfig_1.AppConfigClient({});
+const getApplication = async (applicationId) => {
+    try {
+        return await exports.appConfigClient.send(new client_appconfig_1.GetApplicationCommand({
+            ApplicationId: applicationId,
+        }));
+    }
+    catch (error) {
+        logger_1.logger.error("getApplication", { error, applicationId });
+        throw error;
+    }
+};
+exports.getApplication = getApplication;

package/dynamodb.d.ts

@@ -0,0 +1,4 @@
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+export declare const client: DynamoDBClient;
+export declare const documentClient: DynamoDBDocumentClient;

package/dynamodb.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentClient = exports.client = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+exports.client = new client_dynamodb_1.DynamoDBClient({});
+exports.documentClient = lib_dynamodb_1.DynamoDBDocumentClient.from(exports.client);

package/dynamodb.mock.d.ts

@@ -0,0 +1,8 @@
+export declare const mockDynamodbService: {
+    client: {
+        send: jest.Mock<any, any, any>;
+    };
+    documentClient: {
+        send: jest.Mock<any, any, any>;
+    };
+};

package/dynamodb.mock.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockDynamodbService = void 0;
+exports.mockDynamodbService = {
+    client: {
+        send: jest.fn(),
+    },
+    documentClient: {
+        send: jest.fn(),
+    },
+};
+jest.mock("@tomassabol/aws-services/dynamodb", () => exports.mockDynamodbService);

package/eventbridge.d.ts

@@ -0,0 +1,8 @@
+import { EventBridgeClient } from "@aws-sdk/client-eventbridge";
+export declare const client: EventBridgeClient;
+export declare function sendEvent(params: {
+    source: string;
+    eventBusName: string;
+    eventType: string;
+    event: any;
+}): Promise<void>;

package/eventbridge.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+exports.sendEvent = sendEvent;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const client_eventbridge_1 = require("@aws-sdk/client-eventbridge");
+const logger_1 = require("./logger");
+exports.client = new client_eventbridge_1.EventBridgeClient({});
+async function sendEvent(params) {
+    const { eventBusName, eventType, event, source } = params;
+    const input = {
+        Entries: [
+            {
+                EventBusName: eventBusName,
+                Source: source,
+                DetailType: eventType,
+                Detail: JSON.stringify(event),
+            },
+        ],
+    };
+    const command = new client_eventbridge_1.PutEventsCommand(input);
+    try {
+        const result = await exports.client.send(command);
+        /* Check if there are any failed events */
+        if (result.FailedEntryCount) {
+            const errorDetail = result.Entries?.length
+                ? `${result.Entries[0].ErrorCode}: ${result.Entries[0].ErrorMessage}}`
+                : "unknown";
+            throw new Error(`PutEventsCommand error ${errorDetail}`);
+        }
+        logger_1.logger.debug("sendEvent success", { input, result });
+    }
+    catch (error) {
+        logger_1.logger.error("sendEvent error", { input, error });
+        throw error;
+    }
+}

package/eventbridge.mock.d.ts

@@ -0,0 +1,3 @@
+export declare const mockEventbridgeService: {
+    sendEvent: jest.Mock<any, any, any>;
+};

package/eventbridge.mock.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockEventbridgeService = void 0;
+exports.mockEventbridgeService = {
+    sendEvent: jest.fn(),
+};
+jest.mock("@tomassabol/aws-services/eventbridge", () => exports.mockEventbridgeService);

package/logger.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from "@aws-lambda-powertools/logger";
+export declare const logger: Console | Logger;

package/logger.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger_1 = require("@aws-lambda-powertools/logger");
+const noLogger = {
+    log: () => undefined,
+    debug: () => undefined,
+    info: () => undefined,
+    error: () => undefined,
+    warn: () => undefined,
+};
+exports.logger = process.env.JEST_WORKER_ID === undefined || process.env.TEST_LOGGER
+    ? new logger_1.Logger({ logLevel: "DEBUG" })
+    : noLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomassabol/aws-services",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "license": "MIT",
   "description": "AWS Services",
   "scripts": {
@@ -27,10 +27,10 @@
   },
   "devDependencies": {
     "@aws-sdk/util-stream-node": "^3.374.0",
-    "@tsconfig/node18": "^1.0.1",
-    "@types/aws-sdk": "^2.7.0",
+    "@tsconfig/node22": "^22.0.2",
+    "@types/aws-sdk": "^2.7.4",
     "@types/jest": "^29.4.0",
-    "@types/node": "^18.14.2",
+    "@types/node": "^22.18.12",
     "@typescript-eslint/eslint-plugin": "^5.25.0",
     "@typescript-eslint/parser": "^5.25.0",
     "aws-sdk-client-mock": "^3.0.0",
@@ -48,16 +48,15 @@
     "prettier": "^2.6.2",
     "prettier-plugin-sh": "^0.12.8",
     "rimraf": "^5.0.0",
-    "typedoc": "^0.24.4",
+    "typedoc": "^0.28.14",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.9.3"
   },
   "jestSonar": {
     "reportPath": ".sonar",
     "reportFile": "test-report.xml"
-  }
-
-  ,"publishConfig": {
+  },
+  "publishConfig": {
     "access": "public"
   }
 }

package/s3.d.ts

@@ -0,0 +1,13 @@
+import { S3, PutObjectCommandOutput } from "@aws-sdk/client-s3";
+export declare const client: S3;
+export declare function putObjectToS3(params: {
+    bucket: string;
+    key: string;
+    body: string | Uint8Array | Buffer;
+    contentEncoding: string;
+    contentType: string;
+}): Promise<PutObjectCommandOutput>;
+export declare function getObjectFromS3(params: {
+    bucket: string;
+    key: string;
+}): Promise<Uint8Array>;

package/s3.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+exports.putObjectToS3 = putObjectToS3;
+exports.getObjectFromS3 = getObjectFromS3;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const logger_1 = require("./logger");
+exports.client = new client_s3_1.S3({});
+async function putObjectToS3(params) {
+    const { bucket, key, body, contentEncoding, contentType } = params;
+    try {
+        return await exports.client.putObject({
+            Bucket: bucket,
+            Key: key,
+            Body: body,
+            ContentEncoding: contentEncoding,
+            ContentType: contentType,
+        });
+    }
+    catch (error) {
+        logger_1.logger.error("putObjectToS3", {
+            error,
+            params: { bucket, key, contentEncoding, contentType },
+        });
+        throw error;
+    }
+}
+async function getObjectFromS3(params) {
+    try {
+        const { bucket, key } = params;
+        const result = await exports.client.getObject({
+            Bucket: bucket,
+            Key: key,
+        });
+        const body = result.Body;
+        if (body === undefined) {
+            logger_1.logger.error("Body not found", { params });
+            throw new Error("Body not found");
+        }
+        return await body.transformToByteArray();
+    }
+    catch (error) {
+        logger_1.logger.error("getObjectFromS3", { error, params });
+        throw error;
+    }
+}

package/secrets-manager.d.ts

@@ -0,0 +1,4 @@
+import { SecretsManagerClient } from "@aws-sdk/client-secrets-manager";
+export declare const client: SecretsManagerClient;
+export declare function getSecret(secretName: string): Promise<string>;
+export declare function getSecretAsObject<T = unknown>(secretName: string): Promise<T>;

package/secrets-manager.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+exports.getSecret = getSecret;
+exports.getSecretAsObject = getSecretAsObject;
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
+const assert_1 = __importDefault(require("assert"));
+const logger_1 = require("./logger");
+exports.client = new client_secrets_manager_1.SecretsManagerClient({});
+async function getSecret(secretName) {
+    try {
+        const response = await exports.client.send(new client_secrets_manager_1.GetSecretValueCommand({
+            SecretId: secretName,
+        }));
+        const value = response.SecretString;
+        (0, assert_1.default)(value, "SecretString value not found");
+        return value;
+    }
+    catch (error) {
+        logger_1.logger.error("getSecret", { error, secretName });
+        // For a list of exceptions thrown, see
+        // https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html
+        throw error;
+    }
+}
+async function getSecretAsObject(secretName) {
+    const value = await getSecret(secretName);
+    try {
+        return JSON.parse(value);
+    }
+    catch (error) {
+        throw Error(`Cannot parse secret ${secretName}. Expected JSON.`);
+    }
+}

package/secrets-manager.mock.d.ts

@@ -0,0 +1,4 @@
+export declare const mockSecretsManagerService: {
+    getSecret: jest.Mock<any, any, any>;
+    getSecretAsObject: jest.Mock<any, any, any>;
+};

package/secrets-manager.mock.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockSecretsManagerService = void 0;
+exports.mockSecretsManagerService = {
+    getSecret: jest.fn(),
+    getSecretAsObject: jest.fn(),
+};
+jest.mock("@tomassabol/aws-services/secrets-manager", () => exports.mockSecretsManagerService);

package/sns.d.ts

@@ -0,0 +1,7 @@
+import { SNSClient } from "@aws-sdk/client-sns";
+export declare const snsClient: SNSClient;
+export declare const publishMessageToSNS: (params: {
+    topicArn: string;
+    message: string;
+    options?: object;
+}) => Promise<import("@aws-sdk/client-sns").PublishCommandOutput>;

package/sns.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publishMessageToSNS = exports.snsClient = void 0;
+const client_sns_1 = require("@aws-sdk/client-sns");
+const logger_1 = require("./logger");
+exports.snsClient = new client_sns_1.SNSClient({});
+const publishMessageToSNS = async (params) => {
+    try {
+        const { topicArn, message, options } = params;
+        return await exports.snsClient.send(new client_sns_1.PublishCommand({
+            TopicArn: topicArn,
+            Message: message,
+            ...options,
+        }));
+    }
+    catch (error) {
+        logger_1.logger.error("publishMessageToSNS", { error, params });
+        throw error;
+    }
+};
+exports.publishMessageToSNS = publishMessageToSNS;

package/sqs.d.ts

@@ -0,0 +1,6 @@
+import { SQSClient } from "@aws-sdk/client-sqs";
+export declare const client: SQSClient;
+export declare function sendSqsMessage(params: {
+    queueUrl: string;
+    message: string | object;
+}): Promise<string | undefined>;

package/sqs.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+exports.sendSqsMessage = sendSqsMessage;
+const client_sqs_1 = require("@aws-sdk/client-sqs");
+const logger_1 = require("./logger");
+exports.client = new client_sqs_1.SQSClient({});
+async function sendSqsMessage(params) {
+    const { queueUrl, message } = params;
+    try {
+        const body = typeof message === "object" ? JSON.stringify(message) : message;
+        const input = {
+            QueueUrl: queueUrl,
+            MessageBody: body,
+        };
+        const command = new client_sqs_1.SendMessageCommand(input);
+        const response = await exports.client.send(command);
+        return response.MessageId;
+    }
+    catch (error) {
+        logger_1.logger.error("sendSqsMessage", { error, params });
+        throw error;
+    }
+}

package/sqs.mock.d.ts

@@ -0,0 +1,3 @@
+export declare const mockSqsService: {
+    sendSqsMessage: jest.Mock<any, any, any>;
+};

package/sqs.mock.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockSqsService = void 0;
+exports.mockSqsService = {
+    sendSqsMessage: jest.fn(),
+};
+jest.mock("@tomassabol/aws-services/sqs", () => exports.mockSqsService);

package/ssm.d.ts

@@ -0,0 +1,19 @@
+import { SSMClient } from "@aws-sdk/client-ssm";
+export declare const client: SSMClient;
+export type SSMParameters = {
+    [name: string]: string;
+};
+/**
+ * Get a list of parameters from SSM Parameter Store
+ *
+ * @example
+ * ```typescript
+ * const params = await getSsmParameters({
+ *   first: "/my-params/first",
+ *   second: "/my-params/second",
+ * })
+ *
+ * // params = { first: "value1", second: "value2" }
+ * ```
+ */
+export declare function getSsmParameters<T extends SSMParameters>(parameters: T): Promise<T>;

package/ssm.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+exports.getSsmParameters = getSsmParameters;
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const assert = require("assert");
+exports.client = new client_ssm_1.SSMClient({});
+/**
+ * Get a list of parameters from SSM Parameter Store
+ *
+ * @example
+ * ```typescript
+ * const params = await getSsmParameters({
+ *   first: "/my-params/first",
+ *   second: "/my-params/second",
+ * })
+ *
+ * // params = { first: "value1", second: "value2" }
+ * ```
+ */
+async function getSsmParameters(parameters) {
+    /*
+     * Fetch parameters from SSM
+     */
+    const command = new client_ssm_1.GetParametersCommand({
+        Names: Object.values(parameters),
+    });
+    const output = await exports.client.send(command);
+    /*
+     * Map returned parameters to result object
+     */
+    const result = {};
+    output.Parameters?.forEach((outputParam) => {
+        assert(typeof outputParam.Value === "string", `Received invalid value of SSM parameter ${outputParam.Name}`);
+        const entry = Object.entries(parameters).find(([_key, value]) => value === outputParam.Name);
+        assert(entry, `Received invalid SSM parameter ${outputParam.Name}`);
+        const [key] = entry;
+        result[key] = outputParam.Value;
+    });
+    /*
+     * Check that all parameters were received
+     */
+    const notFoundParams = Object.keys(parameters).filter((key) => false === Object.hasOwn(result, key));
+    if (notFoundParams.length > 0) {
+        throw new Error(`Cannot obtain SSM parameters: ${notFoundParams.join(", ")}`);
+    }
+    return result;
+}

package/ssm.mock.d.ts

@@ -0,0 +1,3 @@
+export declare const mockSsmService: {
+    getSsmParameters: jest.Mock<any, any, any>;
+};

package/ssm.mock.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockSsmService = void 0;
+exports.mockSsmService = {
+    getSsmParameters: jest.fn(),
+};
+jest.mock("@tomassabol/aws-services/ssm", () => exports.mockSsmService);

package/tsconfig.build.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/appconfig.ts","../src/dynamodb.mock.ts","../src/dynamodb.ts","../src/eventbridge.mock.ts","../src/eventbridge.ts","../src/logger.ts","../src/s3.ts","../src/secrets-manager.mock.ts","../src/secrets-manager.ts","../src/sns.ts","../src/sqs.mock.ts","../src/sqs.ts","../src/ssm.mock.ts","../src/ssm.ts"],"version":"5.9.3"}

package/.eslintignore

@@ -1 +0,0 @@
-dist

package/.eslintrc.json

@@ -1,75 +0,0 @@
-{
-  "root": true,
-  "env": {
-    "node": true
-  },
-  "overrides": [
-    {
-      "files": ["**/*.ts", "**/*.tsx"],
-      "parser": "@typescript-eslint/parser",
-      "parserOptions": {
-        "project": "./tsconfig.json"
-      },
-      "plugins": ["@typescript-eslint"],
-      "extends": [
-        "eslint:recommended",
-        "plugin:import/recommended",
-        "plugin:import/typescript",
-        "plugin:@typescript-eslint/eslint-recommended",
-        "plugin:@typescript-eslint/recommended",
-        "prettier"
-      ],
-      "rules": {
-        "@typescript-eslint/no-empty-interface": "warn",
-        "@typescript-eslint/no-unused-vars": [
-          "warn",
-          { "argsIgnorePattern": "^_" }
-        ],
-        "@typescript-eslint/no-floating-promises": "error",
-        "require-await": "warn",
-        "no-useless-catch": "warn",
-        "no-console": "warn",
-        "no-new-object": "warn",
-        "object-shorthand": ["warn", "always"],
-        "quote-props": ["warn", "as-needed"],
-        "prefer-object-spread": "warn",
-        "prefer-destructuring": [
-          "warn",
-          {
-            "VariableDeclarator": {
-              "array": false,
-              "object": true
-            },
-            "AssignmentExpression": {
-              "array": false,
-              "object": false
-            }
-          }
-        ],
-        "default-param-last": "warn",
-        "no-param-reassign": [
-          "warn",
-          { "props": true, "ignorePropertyModificationsFor": ["acc"] }
-        ],
-        "prefer-arrow-callback": "warn",
-        "no-duplicate-imports": "warn",
-        "import/no-mutable-exports": "warn",
-        "import/first": "warn",
-        "no-iterator": "warn",
-        "dot-notation": "warn",
-        "one-var": ["warn", { "initialized": "never" }],
-        "no-multi-assign": "warn",
-        "no-plusplus": ["warn", { "allowForLoopAfterthoughts": true }],
-        "eqeqeq": "warn"
-      }
-    },
-    {
-      "files": ["**/*.md"],
-      "extends": "plugin:markdown/recommended"
-    },
-    {
-      "files": ["**/*.json"],
-      "extends": "plugin:json/recommended"
-    }
-  ]
-}

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/.lintstagedrc.json

@@ -1,9 +0,0 @@
-{
-  "*.ts": [
-    "tsc --noEmit --esModuleInterop --skipLibCheck --resolveJsonModule --target es2022 --module commonjs"
-  ],
-  "*.{js,ts,json,md}": [
-    "eslint --no-ignore --max-warnings 0",
-    "prettier --write"
-  ]
-}

package/.nvmrc

@@ -1 +0,0 @@
-v18.18.2

package/.prettierignore

@@ -1,2 +0,0 @@
-.coverage
-dist

package/.prettierrc.json

@@ -1,3 +0,0 @@
-{
-  "semi": false
-}

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "sonarlint.connectedMode.project": {
-    "connectionId": "io.tomassabol.sonarqube",
-    "projectKey": "tomassaboldev_aws-services_bb5f4f68-64f8-4726-bdd4-579ceadf172d"
-  }
-}