@digitraffic/common 2024.3.14-1 → 2024.3.22-2

package/dist/__test__/api/static-integration.test.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/__test__/api/static-integration.test.mjs

@@ -0,0 +1,26 @@
+import { DigitrafficStaticIntegration } from "../../aws/infra/api/static-integration.mjs";
+import { MediaType } from "../../aws/types/mediatypes.mjs";
+describe("response tests", () => {
+    it("createIntegrationResponse works", () => {
+        const integrationResponse = DigitrafficStaticIntegration.createIntegrationResponse("FakeResource", MediaType.APPLICATION_JSON, { "test-header": "test-value" });
+        expect(integrationResponse).toEqual({
+            responseParameters: {
+                "method.response.header.test-header": "'test-value'"
+            },
+            responseTemplates: {
+                "application/json": "FakeResource"
+            },
+            statusCode: "200"
+        });
+    });
+    it("createMethodResponse works", () => {
+        const methodResponse = DigitrafficStaticIntegration.createMethodResponse({ "test-header": "test-value" });
+        expect(methodResponse).toEqual({
+            responseParameters: {
+                "method.response.header.test-header": true
+            },
+            statusCode: "200"
+        });
+    });
+});
+//# sourceMappingURL=static-integration.test.mjs.map

package/dist/aws/infra/api/static-integration.d.mts

@@ -8,8 +8,17 @@ import { MediaType } from "../../types/mediatypes.mjs";
  * @param response
  */
 export declare class DigitrafficStaticIntegration extends MockIntegration {
-    constructor(resource: Resource, mediaType: MediaType, response: string, enableCors?: boolean, apiKeyRequired?: boolean);
-    static json<K>(resource: Resource, response: K, enableCors?: boolean, apiKeyRequired?: boolean): DigitrafficStaticIntegration;
-    private static createIntegrationResponse;
-    private static createMethodResponse;
+    constructor(resource: Resource, mediaType: MediaType, response: string, enableCors?: boolean, apiKeyRequired?: boolean, headers?: Record<string, string>);
+    static json<K>(resource: Resource, response: K, enableCors?: boolean, apiKeyRequired?: boolean, headers?: Record<string, string>): DigitrafficStaticIntegration;
+    static createIntegrationResponse(response: string, mediaType: MediaType, headers?: Record<string, string>): {
+        statusCode: string;
+        responseTemplates: {
+            [x: string]: string;
+        };
+        responseParameters: Record<string, string>;
+    };
+    static createMethodResponse(headers: Record<string, string>): {
+        statusCode: string;
+        responseParameters: Record<string, boolean>;
+    };
 }

package/dist/aws/infra/api/static-integration.mjs

@@ -1,12 +1,8 @@
-import { MockIntegration, PassthroughBehavior, Resource, } from "aws-cdk-lib/aws-apigateway";
+import { MockIntegration, PassthroughBehavior, Resource } from "aws-cdk-lib/aws-apigateway";
 import { MediaType } from "../../types/mediatypes.mjs";
-import { RESPONSE_CORS_INTEGRATION } from "./responses.mjs";
 const INTEGRATION_RESPONSE_200 = `{
     "statusCode": 200
 }`;
-const METHOD_RESPONSE_200 = {
-    statusCode: "200",
-};
 /**
  * Static integration, that returns the given response with given mediaType from given resource.
  *
@@ -15,8 +11,11 @@ const METHOD_RESPONSE_200 = {
  * @param response
  */
 export class DigitrafficStaticIntegration extends MockIntegration {
-    constructor(resource, mediaType, response, enableCors = true, apiKeyRequired = true) {
-        const integrationResponse = DigitrafficStaticIntegration.createIntegrationResponse(response, mediaType, enableCors);
+    constructor(resource, mediaType, response, enableCors = true, apiKeyRequired = true, headers = {}) {
+        if (enableCors) {
+            headers = { ...headers, "Access-Control-Allow-Origin": "*" };
+        }
+        const integrationResponse = DigitrafficStaticIntegration.createIntegrationResponse(response, mediaType, headers);
         super({
             passthroughBehavior: PassthroughBehavior.WHEN_NO_TEMPLATES,
             requestTemplates: {
@@ -28,39 +27,44 @@ export class DigitrafficStaticIntegration extends MockIntegration {
             resource.addMethod(httpMethod, this, {
                 apiKeyRequired,
                 methodResponses: [
-                    DigitrafficStaticIntegration.createMethodResponse(enableCors),
+                    DigitrafficStaticIntegration.createMethodResponse(headers),
                 ],
             });
         });
     }
-    static json(resource, response, enableCors = true, apiKeyRequired = true) {
-        return new DigitrafficStaticIntegration(resource, MediaType.APPLICATION_JSON, JSON.stringify(response), enableCors, apiKeyRequired);
+    static json(resource, response, enableCors = true, apiKeyRequired = true, headers = {}) {
+        return new DigitrafficStaticIntegration(resource, MediaType.APPLICATION_JSON, JSON.stringify(response), enableCors, apiKeyRequired, headers);
     }
-    static createIntegrationResponse(response, mediaType, enableCors) {
-        const integrationResponse = {
+    static createIntegrationResponse(response, mediaType, headers = {}) {
+        const params = mapRecord(headers, (entry) => ["method.response.header." + entry[0], `'${entry[1]}'`]);
+        return {
             statusCode: "200",
             responseTemplates: {
                 [mediaType]: response,
             },
+            responseParameters: params
         };
-        return enableCors
-            ? { ...integrationResponse, ...RESPONSE_CORS_INTEGRATION }
-            : integrationResponse;
     }
-    static createMethodResponse(enableCors) {
-        return enableCors
-            ? corsMethod(METHOD_RESPONSE_200)
-            : METHOD_RESPONSE_200;
+    static createMethodResponse(headers) {
+        const allowedHeaders = Object.keys(headers);
+        const entries = Object.fromEntries(allowedHeaders.map((key) => [key, true]));
+        return {
+            statusCode: "200",
+            responseParameters: prefixKeys("method.response.header.", entries)
+        };
     }
 }
-function corsMethod(response) {
-    return {
-        ...response,
-        ...{
-            responseParameters: {
-                "method.response.header.Access-Control-Allow-Origin": true,
-            },
-        },
-    };
+function mapRecord(obj, func) {
+    const mappedEntries = Object.entries(obj).map((entry) => func(entry));
+    return Object.fromEntries(mappedEntries);
+}
+/**
+ * Create a new Record with prefix added to each of the keys.
+ *
+ * @param prefix
+ * @param obj
+ */
+function prefixKeys(prefix, obj) {
+    return mapRecord(obj, (entry) => [prefix + entry[0], entry[1]]);
 }
 //# sourceMappingURL=static-integration.mjs.map

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/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.14-1",
+  "version": "2024.3.22-2",
   "description": "",
   "type": "module",
   "repository": {
@@ -109,7 +109,7 @@
     "@aws-sdk/client-api-gateway": "^3.533.0",
     "@aws-sdk/client-sns": "^3.533.0",
     "@types/geojson": "^7946.0.14",
-    "aws-cdk-lib": "^2.132.1",
+    "aws-cdk-lib": "^2.133.0",
     "change-case": "5.0.0",
     "constructs": "^10.3.0",
     "date-fns": "~2.30.0",
@@ -137,7 +137,7 @@
     "@rushstack/heft-typescript-plugin": "^0.3.20",
     "@types/aws-lambda": "8.10.136",
     "@types/etag": "1.8.3",
-    "@types/geojson": "7946.0.14",
+    "@types/geojson": "^7946.0.14",
     "@types/geojson-validation": "^1.0.3",
     "@types/jest": "29.5.12",
     "@types/lodash": "4.14.202",
@@ -145,7 +145,7 @@
     "@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",