@digitraffic/common 2024.3.13-1 → 2024.3.22-1

package/dist/__test__/imports.test.mjs

@@ -75,10 +75,6 @@ test('httpserver import ok?', () => {
     const httpserver = import("../test/httpserver.mjs");
     return expect(httpserver).resolves.toBeDefined();
 });
-test('secretsManager import ok?', () => {
-    const secretsManager = import("../test/secrets-manager.mjs");
-    return expect(secretsManager).resolves.toBeDefined();
-});
 test('asserter import ok?', () => {
     const asserter = import("../test/asserter.mjs");
     return expect(asserter).resolves.toBeDefined();
@@ -311,10 +307,12 @@ test('messaging import ok?', () => {
     const messaging = import("../aws/runtime/messaging.mjs");
     return expect(messaging).resolves.toBeDefined();
 });
+/*
+temporary disable, enable after sdk v2 is kicked out
 test('apikey import ok?', () => {
-    const apikey = import("../aws/runtime/apikey.mjs");
-    return expect(apikey).resolves.toBeDefined();
-});
+  const apikey = import("../aws/runtime/apikey.mjs");
+  return expect(apikey).resolves.toBeDefined();
+});*/
 test('environment import ok?', () => {
     const environment = import("../aws/runtime/environment.mjs");
     return expect(environment).resolves.toBeDefined();

package/dist/__test__/secrets/secret-holder.test.mjs

@@ -1,19 +1,29 @@
-import { mockSecret, stubSecretsManager } from "../../test/secrets-manager.mjs";
+import { SecretsManager } from "@aws-sdk/client-secrets-manager";
+import { jest } from "@jest/globals";
 const SECRET_WITH_PREFIX = {
     "prefix.value": "value",
     "prefix.name": "name",
     "wrong.value": "value",
     username: "DB_USER",
 };
-const SECRET_EMPTY = {};
-const stubSM = stubSecretsManager();
-const secretHolder = await import("../../aws/runtime/secrets/secret-holder.mjs");
-const database = await import("../../database/database.mjs");
-const { SecretHolder } = secretHolder;
-const { DatabaseEnvironmentKeys } = database;
+const emptySecret = { $metadata: {} };
+const getSecretValueMock = jest.fn();
+// eslint-disable-next-line @typescript-eslint/no-misused-promises
+jest.spyOn(SecretsManager.prototype, "getSecretValue").mockImplementation(getSecretValueMock);
+const { SecretHolder } = await import("../../aws/runtime/secrets/secret-holder.mjs");
+const { DatabaseEnvironmentKeys } = await import("../../database/database.mjs");
+function mockSecret(secret) {
+    if (!secret) {
+        getSecretValueMock.mockImplementation(() => Promise.resolve(emptySecret));
+    }
+    else {
+        getSecretValueMock.mockImplementation(() => Promise.resolve({ ...emptySecret, ...{ SecretString: JSON.stringify(secret) } }));
+    }
+}
 describe("SecretHolder - tests", () => {
     beforeEach(() => {
         process.env["SECRET_ID"] = "test-id";
+        process.env["AWS_REGION"] = "eu-west-1";
     });
     afterEach(() => {
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
@@ -26,10 +36,10 @@ describe("SecretHolder - tests", () => {
         return expect(secret).rejects.toThrow("No secret found!");
     }, 10000);
     test("get - empty secret", () => {
-        mockSecret(SECRET_EMPTY);
+        mockSecret({});
         const holder = SecretHolder.create();
         const secret = holder.get();
-        return expect(secret).resolves.toEqual(SECRET_EMPTY);
+        return expect(secret).resolves.toEqual({});
     });
     test("get - no prefix", () => {
         mockSecret(SECRET_WITH_PREFIX);
@@ -60,27 +70,27 @@ describe("SecretHolder - tests", () => {
     test("get - ttl - do not fetch", async () => {
         mockSecret(SECRET_WITH_PREFIX);
         const holder = SecretHolder.create();
-        const callCount = stubSM.getSecretValue.callCount;
+        const callCount = getSecretValueMock.mock.calls.length;
         await holder.get();
-        expect(stubSM.getSecretValue.callCount).toEqual(callCount + 1);
+        expect(getSecretValueMock).toHaveBeenCalledTimes(callCount + 1);
         // gets cached secret
         await holder.get();
-        expect(stubSM.getSecretValue.callCount).toEqual(callCount + 1);
+        expect(getSecretValueMock).toHaveBeenCalledTimes(callCount + 1);
     });
     test("get - ttl - fetch", async () => {
         mockSecret(SECRET_WITH_PREFIX);
         const holder = new SecretHolder("", "", [], {
             ttl: 1,
         });
-        const callCount = stubSM.getSecretValue.callCount;
+        const callCount = getSecretValueMock.mock.calls.length;
         await holder.get();
-        expect(stubSM.getSecretValue.callCount).toEqual(callCount + 1);
+        expect(getSecretValueMock).toHaveBeenCalledTimes(callCount + 1);
         // cache expires, fetches secret again
         const start = Date.now();
         while (Date.now() < start + 2000)
             ;
         await holder.get();
-        expect(stubSM.getSecretValue.callCount).toEqual(callCount + 2);
+        expect(getSecretValueMock).toHaveBeenCalledTimes(callCount + 2);
     });
 });
 //# sourceMappingURL=secret-holder.test.mjs.map

package/dist/__test__/secrets/secret.test.mjs

@@ -1,12 +1,24 @@
-import { mockSecret, stubSecretsManager } from "../../test/secrets-manager.mjs";
+import { SecretsManager } from "@aws-sdk/client-secrets-manager";
+import { jest } from "@jest/globals";
 const SECRET_ID = "test_secret";
 const SECRET_WITH_PREFIX = {
     "prefix.value": "value",
     "prefix.name": "name",
     "wrong.value": "value",
 };
-const SECRET_EMPTY = {};
-stubSecretsManager();
+const emptySecret = { $metadata: {} };
+const getSecretValueMock = jest.fn();
+// eslint-disable-next-line @typescript-eslint/no-misused-promises
+jest.spyOn(SecretsManager.prototype, "getSecretValue").mockImplementation(getSecretValueMock);
+function mockSecret(secret) {
+    if (!secret) {
+        getSecretValueMock.mockImplementation(() => Promise.resolve(emptySecret));
+    }
+    else {
+        getSecretValueMock.mockImplementation(() => Promise.resolve({ ...emptySecret, ...{ SecretString: JSON.stringify(secret) } }));
+    }
+}
+process.env["AWS_REGION"] = "eu-west-1";
 const secret = await import("../../aws/runtime/secrets/secret.mjs");
 const { getSecret } = secret;
 describe("secret - test", () => {
@@ -17,9 +29,9 @@ describe("secret - test", () => {
         }).rejects.toThrow("No secret found!");
     });
     test("getSecret - empty secret", async () => {
-        mockSecret(SECRET_EMPTY);
+        mockSecret({});
         const secret = await getSecret(SECRET_ID, "");
-        expect(secret).toEqual(SECRET_EMPTY);
+        expect(secret).toEqual({});
     });
     test("getSecret - no prefix", async () => {
         mockSecret(SECRET_WITH_PREFIX);

package/dist/aws/infra/canaries/url-checker.mjs

@@ -38,10 +38,9 @@ export class UrlChecker {
             .withIncludeResponseHeaders(false)
             .withFailedCanaryMetric(true);
     }
-    static create(hostname, apiKeyId) {
-        return getApiKeyFromAPIGateway(apiKeyId).then((apiKey) => {
-            return new UrlChecker(hostname, apiKey.value);
-        });
+    static async create(hostname, apiKeyId) {
+        const apiKey = await getApiKeyFromAPIGateway(apiKeyId);
+        return new UrlChecker(hostname, apiKey.value);
     }
     static createV2() {
         return this.create(getEnvVariable(ENV_HOSTNAME), getEnvVariable(ENV_API_KEY));

package/dist/aws/infra/stack/rest_apis.d.mts

@@ -1,4 +1,4 @@
-import { type IResource, type JsonSchema, Resource, RestApi, type RestApiProps } from "aws-cdk-lib/aws-apigateway";
+import { type IResource, type JsonSchema, Resource, type ResourceOptions, RestApi, type RestApiProps } from "aws-cdk-lib/aws-apigateway";
 import { PolicyDocument } from "aws-cdk-lib/aws-iam";
 import { Construct } from "constructs";
 import type { ModelWithReference } from "../../types/model-with-reference.mjs";
@@ -16,6 +16,7 @@ export declare class DigitrafficRestApi extends RestApi {
     private getModelWithReference;
     private addDocumentationPart;
     documentResource(resource: Resource, ...documentationPart: DocumentationPart[]): void;
+    addResourceWithCorsOptionsSubTree(resource: Resource, pathPart: string, config?: ResourceOptions): Resource;
     /**
      * Add support for HTTP OPTIONS to an API GW resource,
      * this is required for preflight CORS requests made by browsers.
@@ -45,3 +46,4 @@ export declare function setReturnCodeForMissingAuthenticationToken(returnCode: n
 export declare function createRestApi(stack: Construct, apiId: string, apiName: string, allowFromIpAddresses?: string[] | undefined): RestApi;
 export declare function createDefaultPolicyDocument(): PolicyDocument;
 export declare function createIpRestrictionPolicyDocument(allowFromIpAddresses: string[]): PolicyDocument;
+export declare const PUBLIC_REST_API_CORS_CONFIG: Partial<ResourceOptions>;

package/dist/aws/infra/stack/rest_apis.mjs

@@ -1,4 +1,4 @@
-import { CfnDocumentationPart, EndpointType, GatewayResponse, MethodLoggingLevel, MockIntegration, Model, Resource, ResponseType, RestApi, } from "aws-cdk-lib/aws-apigateway";
+import { CfnDocumentationPart, Cors, EndpointType, GatewayResponse, MethodLoggingLevel, Model, Resource, ResponseType, RestApi, } from "aws-cdk-lib/aws-apigateway";
 import { AnyPrincipal, Effect, PolicyDocument, PolicyStatement, } from "aws-cdk-lib/aws-iam";
 import { Construct } from "constructs";
 import { getModelReference } from "../../../utils/api-model.mjs";
@@ -82,38 +82,20 @@ export class DigitrafficRestApi extends RestApi {
             console.info("Skipping documentation for %s", resource.path);
         }
     }
+    addResourceWithCorsOptionsSubTree(resource, pathPart, config) {
+        const mergedConfig = {
+            ...PUBLIC_REST_API_CORS_CONFIG,
+            ...config
+        };
+        return resource.addResource(pathPart, mergedConfig);
+    }
     /**
      * Add support for HTTP OPTIONS to an API GW resource,
      * this is required for preflight CORS requests made by browsers.
      * @param apiResource
      */
     addCorsOptions(apiResource) {
-        apiResource.addMethod("OPTIONS", new MockIntegration({
-            integrationResponses: [
-                {
-                    statusCode: "200",
-                    responseParameters: {
-                        "method.response.header.Access-Control-Allow-Headers": "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,Digitraffic-User'",
-                        "method.response.header.Access-Control-Allow-Origin": "'*'",
-                        "method.response.header.Access-Control-Allow-Methods": "'OPTIONS,GET,HEAD'",
-                    },
-                },
-            ],
-            requestTemplates: {
-                "application/json": '{"statusCode": 200}',
-            },
-        }), {
-            methodResponses: [
-                {
-                    statusCode: "200",
-                    responseParameters: {
-                        "method.response.header.Access-Control-Allow-Headers": true,
-                        "method.response.header.Access-Control-Allow-Methods": true,
-                        "method.response.header.Access-Control-Allow-Origin": true,
-                    },
-                },
-            ],
-        });
+        apiResource.addCorsPreflight(PUBLIC_REST_API_CORS_CONFIG.defaultCorsPreflightOptions);
     }
 }
 /**
@@ -206,4 +188,11 @@ export function createIpRestrictionPolicyDocument(allowFromIpAddresses) {
         ],
     });
 }
+export const PUBLIC_REST_API_CORS_CONFIG = {
+    defaultCorsPreflightOptions: {
+        allowOrigins: Cors.ALL_ORIGINS,
+        allowHeaders: ["Content-Type", "X-Amz-Date", "Authorization", "X-Api-Key", "X-Amz-Security-Token", "Digitraffic-User"],
+        allowMethods: ["OPTIONS", "GET", "HEAD"]
+    }
+};
 //# sourceMappingURL=rest_apis.mjs.map

package/dist/aws/runtime/apikey.d.mts

@@ -1,2 +1,2 @@
-import type { UpdateApiKeyCommandOutput } from "@aws-sdk/client-api-gateway";
-export declare function getApiKeyFromAPIGateway(keyId: string): Promise<UpdateApiKeyCommandOutput>;
+import type { ApiKey } from "aws-sdk/clients/apigateway.js";
+export declare function getApiKeyFromAPIGateway(keyId: string): Promise<ApiKey>;

package/dist/aws/runtime/apikey.mjs

@@ -1,9 +1,19 @@
-import { APIGateway } from "@aws-sdk/client-api-gateway";
-export function getApiKeyFromAPIGateway(keyId) {
-    const agw = new APIGateway();
-    return agw.getApiKey({
+//import { APIGatewayClient, GetApiKeyCommand } from "@aws-sdk/client-api-gateway";
+//import type { GetApiKeyCommandOutput } from "@aws-sdk/client-api-gateway";
+import { APIGateway } from "aws-sdk";
+export async function getApiKeyFromAPIGateway(keyId) {
+    const ag = new APIGateway();
+    return ag.getApiKey({
+        apiKey: keyId,
+        includeValue: true
+    }).promise();
+    /*
+    const client = new APIGatewayClient();
+    const command = new GetApiKeyCommand({
         apiKey: keyId,
         includeValue: true,
     });
+
+    return client.send(command);*/
 }
 //# sourceMappingURL=apikey.mjs.map

package/dist/aws/runtime/secrets/secret.mjs

@@ -1,6 +1,6 @@
+import { SecretsManager } from "@aws-sdk/client-secrets-manager";
 import { getEnvVariable, getEnvVariableOrElse } from "../../../utils/utils.mjs";
 import { EnvKeys } from "../environment.mjs";
-const { SecretsManager } = await import("@aws-sdk/client-secrets-manager");
 // SECRET_OVERRIDE_AWS_REGION might not have been set before import of
 // secret, so we need to lazy initialize SecretsManager
 let smClient;

package/dist/utils/utils.d.mts

@@ -75,6 +75,12 @@ export declare function getEnvVariableOr<T>(key: string, fn: () => T): string |
  * @param orElse Alternative value
  */
 export declare function getEnvVariableOrElse<T>(key: string, orElse: T): string | T;
+/**
+ * Gets variable from environment or from an AWS Secrets Manager secret if not found in the environment.
+ * @param Environment key
+ * @param Secret id in Secrets Manager
+ */
+export declare function getFromEnvOrSecret(key: string, secretId: string): Promise<string>;
 export declare function setSecretOverideAwsRegionEnv(region: string): void;
 /**
  * ESLint won't allow to call Object.prototype builtin methods.

package/dist/utils/utils.mjs

@@ -1,4 +1,5 @@
 import { EnvKeys } from "../aws/runtime/environment.mjs";
+import { getSecret, } from "../aws/runtime/secrets/secret.mjs";
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.
@@ -130,6 +131,23 @@ export function getEnvVariableOr(key, fn) {
 export function getEnvVariableOrElse(key, orElse) {
     return getEnvVariableOr(key, () => orElse);
 }
+/**
+ * Gets variable from environment or from an AWS Secrets Manager secret if not found in the environment.
+ * @param Environment key
+ * @param Secret id in Secrets Manager
+ */
+export async function getFromEnvOrSecret(key, secretId) {
+    const envValue = getEnvVariableSafe(key);
+    if (envValue.result === "ok") {
+        return envValue.value;
+    }
+    const secret = await getSecret(secretId);
+    const secretValue = secret[key];
+    if (secretValue !== undefined) {
+        return secretValue;
+    }
+    throw new Error(`Cannot get value with key ${key} from env or secret`);
+}
 export function setSecretOverideAwsRegionEnv(region) {
     setEnvVariable(EnvKeys.SECRET_OVERRIDE_AWS_REGION, region);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2024.3.13-1",
+  "version": "2024.3.22-1",
   "description": "",
   "type": "module",
   "repository": {
@@ -36,7 +36,6 @@
     "./dist/test/testutils": "./dist/test/testutils.mjs",
     "./dist/test/db-testutils": "./dist/test/db-testutils.mjs",
     "./dist/test/httpserver": "./dist/test/httpserver.mjs",
-    "./dist/test/secrets-manager": "./dist/test/secrets-manager.mjs",
     "./dist/test/asserter": "./dist/test/asserter.mjs",
     "./dist/test/mock-ky": "./dist/test/mock-ky.mjs",
     "./dist/marine/rtz": "./dist/marine/rtz.mjs",
@@ -104,64 +103,65 @@
     "./dist/aws/runtime/digitraffic-integration-response": "./dist/aws/runtime/digitraffic-integration-response.mjs"
   },
   "peerDependencies": {
-    "@aws-sdk/client-s3": "^3.496.0",
-    "@aws-sdk/lib-storage": "^3.496.0",
-    "@aws-sdk/client-secrets-manager": "^3.496.0",
-    "@aws-sdk/client-api-gateway": "^3.496.0",
-    "@aws-sdk/client-sns": "^3.496.0",
-    "@types/geojson": "^7946.0.12",
-    "aws-cdk-lib": "^2.132.1",
+    "@aws-sdk/client-s3": "^3.533.0",
+    "@aws-sdk/lib-storage": "^3.533.0",
+    "@aws-sdk/client-secrets-manager": "^3.533.0",
+    "@aws-sdk/client-api-gateway": "^3.533.0",
+    "@aws-sdk/client-sns": "^3.533.0",
+    "@types/geojson": "^7946.0.14",
+    "aws-cdk-lib": "^2.133.0",
     "change-case": "5.0.0",
     "constructs": "^10.3.0",
     "date-fns": "~2.30.0",
     "date-fns-tz": "~2.0.0",
     "etag": "^1.8.1",
     "geojson-validation": "^1.0.2",
-    "ky": "^1.2.0",
+    "ky": "^1.2.2",
     "lodash": "~4.17.21",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
     "pg-promise": "^11.5.4"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "3.496.0",
-    "@aws-sdk/lib-storage": "3.496.0",
-    "@aws-sdk/client-secrets-manager": "3.496.0",
-    "@aws-sdk/client-api-gateway": "3.496.0",
-    "@aws-sdk/client-sns": "3.496.0",
+    "aws-sdk": "2.1577.0",
+    "@aws-sdk/client-s3": "3.533.0",
+    "@aws-sdk/lib-storage": "3.533.0",
+    "@aws-sdk/client-secrets-manager": "3.533.0",
+    "@aws-sdk/client-api-gateway": "3.533.0",
+    "@aws-sdk/client-sns": "3.533.0",
     "@jest/globals": "^29.7.0",
-    "@rushstack/eslint-config": "^3.6.2",
-    "@rushstack/heft": "^0.64.3",
-    "@rushstack/heft-jest-plugin": "^0.11.3",
-    "@rushstack/heft-lint-plugin": "^0.3.3",
-    "@rushstack/heft-typescript-plugin": "^0.3.3",
-    "@types/aws-lambda": "8.10.131",
+    "@rushstack/eslint-config": "^3.6.4",
+    "@rushstack/heft": "^0.66.0",
+    "@rushstack/heft-jest-plugin": "^0.11.21",
+    "@rushstack/heft-lint-plugin": "^0.3.20",
+    "@rushstack/heft-typescript-plugin": "^0.3.20",
+    "@types/aws-lambda": "8.10.136",
     "@types/etag": "1.8.3",
-    "@types/geojson": "7946.0.13",
-    "@types/geojson-validation": "^1.0.2",
-    "@types/jest": "29.5.11",
+    "@types/geojson": "^7946.0.14",
+    "@types/geojson-validation": "^1.0.3",
+    "@types/jest": "29.5.12",
     "@types/lodash": "4.14.202",
-    "@types/node": "20.10.7",
-    "@types/sinon": "17.0.2",
+    "@types/node": "20.11.27",
+    "@types/sinon": "17.0.3",
     "@typescript-eslint/eslint-plugin": "~6.18.1",
     "@typescript-eslint/parser": "^6.20.0",
-    "aws-cdk-lib": "~2.132.1",
+    "aws-cdk-lib": "^2.133.0",
     "change-case": "5.3.0",
     "constructs": "10.3.0",
     "date-fns": "~2.30.0",
-    "date-fns-tz": "~2.0.0",
-    "eslint": "~8.56.0",
+    "date-fns-tz": "~2.0.1",
+    "eslint": "~8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-deprecation": "~2.0.0",
     "etag": "^1.8.1",
     "geojson-validation": "^1.0.2",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "ky": "^1.2.0",
+    "ky": "^1.2.2",
     "lodash": "~4.17.21",
     "node-ttl": "^0.2.0",
     "pg-promise": "^11.5.4",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
     "sinon": "17.0.1",
     "ts-jest": "^29.1.2",

package/dist/test/secrets-manager.d.mts

@@ -1,10 +0,0 @@
-import { SecretsManager } from "@aws-sdk/client-secrets-manager";
-import sinon from "sinon";
-/**
- * Stub Secrets Manager for tests.  You must call this
- * before you instantiate Secrets Manager(this might happen when you import the function that uses Secrets Manager).
- *
- * To mock the actual secret, call mockSecret()
- */
-export declare function stubSecretsManager(): sinon.SinonStubbedInstance<SecretsManager>;
-export declare function mockSecret<Secret>(secret: Secret): void;

package/dist/test/secrets-manager.mjs

@@ -1,32 +0,0 @@
-import { SecretsManager } from "@aws-sdk/client-secrets-manager";
-import sinon from "sinon";
-import { EnvKeys } from "../aws/runtime/environment.mjs";
-import { setEnvVariable } from "../utils/utils.mjs";
-import { jest } from '@jest/globals';
-setEnvVariable(EnvKeys.AWS_REGION, "eu-west-1");
-const emptySecret = { $metadata: {} };
-const SecretsManagerStubInstance = sinon.createStubInstance(SecretsManager);
-SecretsManagerStubInstance.getSecretValue.resolves(emptySecret);
-/**
- * Stub Secrets Manager for tests.  You must call this
- * before you instantiate Secrets Manager(this might happen when you import the function that uses Secrets Manager).
- *
- * To mock the actual secret, call mockSecret()
- */
-export function stubSecretsManager() {
-    jest.unstable_mockModule("@aws-sdk/client-secrets-manager", function () {
-        return {
-            SecretsManager: sinon.stub().returns(SecretsManagerStubInstance)
-        };
-    });
-    return SecretsManagerStubInstance;
-}
-export function mockSecret(secret) {
-    if (!secret) {
-        SecretsManagerStubInstance.getSecretValue.resolves({ ...emptySecret });
-    }
-    else {
-        SecretsManagerStubInstance.getSecretValue.resolves({ SecretString: JSON.stringify(secret) });
-    }
-}
-//# sourceMappingURL=secrets-manager.mjs.map