@digitraffic/common 2023.3.21-2 → 2023.3.27-1

package/dist/aws/infra/api/integration.d.ts

@@ -1,7 +1,7 @@
 import { IntegrationResponse, LambdaIntegration } from "aws-cdk-lib/aws-apigateway";
 import { IFunction } from "aws-cdk-lib/aws-lambda";
 import { MediaType } from "../../types/mediatypes";
-declare type ParameterType = "path" | "querystring";
+declare type ParameterType = "path" | "querystring" | "context";
 interface ApiParameter {
     type: ParameterType;
     name: string;
@@ -14,6 +14,7 @@ export declare class DigitrafficIntegration {
     constructor(lambda: IFunction, mediaType?: MediaType, sunset?: string);
     addPathParameter(...names: string[]): this;
     addQueryParameter(...names: string[]): this;
+    addContextParameter(...names: string[]): this;
     build(): LambdaIntegration;
     createRequestParameters(): Record<string, string>;
     createRequestTemplates(): Record<string, string>;

package/dist/aws/infra/api/integration.js

@@ -19,6 +19,10 @@ class DigitrafficIntegration {
         names.forEach((name) => this.parameters.push({ type: "querystring", name }));
         return this;
     }
+    addContextParameter(...names) {
+        names.forEach((name) => this.parameters.push({ type: "context", name }));
+        return this;
+    }
     build() {
         const integrationResponses = this.createResponses();
         return new aws_apigateway_1.LambdaIntegration(this.lambda, {
@@ -35,7 +39,10 @@ class DigitrafficIntegration {
     }
     createRequestParameters() {
         const requestParameters = {};
-        this.parameters.forEach((parameter) => {
+        // filter out context parameters
+        this.parameters
+            .filter((parameter) => parameter.type !== "context")
+            .forEach((parameter) => {
             requestParameters[`integration.request.${parameter.type}.${parameter.name}`] = `method.request.${parameter.type}.${parameter.name}`;
         });
         return requestParameters;
@@ -43,7 +50,12 @@ class DigitrafficIntegration {
     createRequestTemplates() {
         const requestJson = {};
         this.parameters.forEach((parameter) => {
-            requestJson[parameter.name] = `$util.escapeJavaScript($input.params('${parameter.name}'))`;
+            if (parameter.type === "context") {
+                requestJson[parameter.name] = `$util.parseJson($context.${parameter.name})`;
+            }
+            else {
+                requestJson[parameter.name] = `$util.escapeJavaScript($input.params('${parameter.name}'))`;
+            }
         });
         return {
             [mediatypes_1.MediaType.APPLICATION_JSON]: JSON.stringify(requestJson),

package/dist/aws/infra/api/response.d.ts

@@ -27,11 +27,18 @@ export declare const MessageModel: {
     schema: JsonSchema;
 };
 export declare const NotFoundResponse: string;
-export declare const BadRequestResponseTemplate: Record<string, string>;
-export declare const NotFoundResponseTemplate: Record<string, string>;
-export declare const XmlResponseTemplate: Record<string, string>;
-export declare const InternalServerErrorResponseTemplate: Record<string, string>;
-export declare function createResponses<T>(key: MediaType, value: T): Record<string, T>;
+export declare const BadRequestResponseTemplate: {
+    "application/json": string;
+};
+export declare const NotFoundResponseTemplate: {
+    "application/json": string;
+};
+export declare const XmlResponseTemplate: {
+    "application/xml": string;
+};
+export declare const InternalServerErrorResponseTemplate: {
+    "application/json": string;
+};
 export declare class DigitrafficMethodResponse {
     static response(statusCode: string, model: IModel, mediaType: MediaType, disableCors?: boolean, deprecation?: boolean): MethodResponse;
     static response200(model: IModel, mediaType?: MediaType): MethodResponse;

package/dist/aws/infra/api/response.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DigitrafficMethodResponse = exports.createResponses = exports.InternalServerErrorResponseTemplate = exports.XmlResponseTemplate = exports.NotFoundResponseTemplate = exports.BadRequestResponseTemplate = exports.NotFoundResponse = exports.MessageModel = exports.getDeprecatedDefaultLambdaResponse = exports.RESPONSE_DEFAULT_LAMBDA = void 0;
+exports.DigitrafficMethodResponse = exports.InternalServerErrorResponseTemplate = exports.XmlResponseTemplate = exports.NotFoundResponseTemplate = exports.BadRequestResponseTemplate = exports.NotFoundResponse = exports.MessageModel = exports.getDeprecatedDefaultLambdaResponse = exports.RESPONSE_DEFAULT_LAMBDA = void 0;
 const mediatypes_1 = require("../../types/mediatypes");
 const aws_apigateway_1 = require("aws-cdk-lib/aws-apigateway");
 const date_utils_1 = require("../../../utils/date-utils");
@@ -68,20 +68,21 @@ const InternalServerErrorResponse = JSON.stringify({
 const BadRequestMessage = "Bad request";
 const BadRequestResponse = JSON.stringify({ message: BadRequestMessage });
 /// @deprecated
-exports.BadRequestResponseTemplate = createResponses(mediatypes_1.MediaType.APPLICATION_JSON, BadRequestResponse);
-/// @deprecated
-exports.NotFoundResponseTemplate = createResponses(mediatypes_1.MediaType.APPLICATION_JSON, exports.NotFoundResponse);
+exports.BadRequestResponseTemplate = {
+    [mediatypes_1.MediaType.APPLICATION_JSON]: BadRequestResponse,
+};
 /// @deprecated
-exports.XmlResponseTemplate = createResponses(mediatypes_1.MediaType.APPLICATION_XML, BODY_FROM_INPUT_PATH);
+exports.NotFoundResponseTemplate = {
+    [mediatypes_1.MediaType.APPLICATION_JSON]: exports.NotFoundResponse,
+};
 /// @deprecated
-exports.InternalServerErrorResponseTemplate = createResponses(mediatypes_1.MediaType.APPLICATION_JSON, InternalServerErrorResponse);
+exports.XmlResponseTemplate = {
+    [mediatypes_1.MediaType.APPLICATION_XML]: BODY_FROM_INPUT_PATH,
+};
 /// @deprecated
-function createResponses(key, value) {
-    return {
-        [key]: value,
-    };
-}
-exports.createResponses = createResponses;
+exports.InternalServerErrorResponseTemplate = {
+    [mediatypes_1.MediaType.APPLICATION_JSON]: InternalServerErrorResponse,
+};
 class DigitrafficMethodResponse {
     static response(statusCode, model, mediaType, disableCors = false, deprecation = false) {
         return {

package/dist/aws/infra/api/responses.d.ts

@@ -13,7 +13,9 @@ export declare const RESPONSE_CORS_INTEGRATION: {
 export declare const RESPONSE_404_NOT_FOUND: {
     statusCode: string;
     selectionPattern: string;
-    responseTemplates: Record<string, string>;
+    responseTemplates: {
+        "application/json": string;
+    };
 };
 /**
  * @deprecated Use DigitrafficMethodResponse

package/dist/aws/infra/api/responses.js

@@ -4,27 +4,33 @@ exports.getResponse = exports.defaultIntegration = exports.methodResponse = expo
 const response_1 = require("./response");
 const aws_apigateway_1 = require("aws-cdk-lib/aws-apigateway");
 const errors_1 = require("../../types/errors");
+/// @deprecated
 exports.RESPONSE_200_OK = {
     statusCode: "200",
 };
+/// @deprecated
 exports.RESPONSE_400_BAD_REQUEST = {
     statusCode: "400",
     selectionPattern: errors_1.BAD_REQUEST_MESSAGE,
     responseTemplates: response_1.BadRequestResponseTemplate,
 };
+/// @deprecated
 exports.RESPONSE_500_SERVER_ERROR = {
     statusCode: "500",
     selectionPattern: errors_1.ERROR_MESSAGE,
     responseTemplates: response_1.InternalServerErrorResponseTemplate,
 };
+/// @deprecated
 const RESPONSE_XML = {
     responseTemplates: response_1.XmlResponseTemplate,
 };
+/// @deprecated
 exports.RESPONSE_CORS_INTEGRATION = {
     responseParameters: {
         "method.response.header.Access-Control-Allow-Origin": "'*'",
     },
 };
+/// @deprecated
 exports.RESPONSE_404_NOT_FOUND = {
     statusCode: "404",
     selectionPattern: errors_1.NOT_FOUND_MESSAGE,
@@ -36,7 +42,9 @@ exports.RESPONSE_404_NOT_FOUND = {
 function methodResponse(status, contentType, model, parameters) {
     return {
         statusCode: status,
-        responseModels: (0, response_1.createResponses)(contentType, model),
+        responseModels: {
+            [contentType]: model,
+        },
         responseParameters: parameters ?? {},
     };
 }

package/dist/database/database.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.inDatabaseReadonly = exports.inDatabase = exports.inTransaction = exports.initDbConnection = exports.DatabaseEnvironmentKeys = void 0;
 const utils_1 = require("../utils/utils");
-const environment_1 = require("../aws/runtime/environment");
 var DatabaseEnvironmentKeys;
 (function (DatabaseEnvironmentKeys) {
     DatabaseEnvironmentKeys["DB_USER"] = "DB_USER";
@@ -57,10 +56,10 @@ function inDatabaseReadonly(fn) {
 }
 exports.inDatabaseReadonly = inDatabaseReadonly;
 async function doInDatabase(readonly, fn) {
-    const db_application = (0, environment_1.envValue)(DatabaseEnvironmentKeys.DB_APPLICATION, "unknown-cdk-application");
+    const db_application = (0, utils_1.getEnvVariableOrElse)(DatabaseEnvironmentKeys.DB_APPLICATION, "unknown-cdk-application");
     const db_uri = readonly
-        ? (0, environment_1.envValue)(DatabaseEnvironmentKeys.DB_RO_URI)
-        : (0, environment_1.envValue)(DatabaseEnvironmentKeys.DB_URI);
+        ? (0, utils_1.getEnvVariable)(DatabaseEnvironmentKeys.DB_RO_URI)
+        : (0, utils_1.getEnvVariable)(DatabaseEnvironmentKeys.DB_URI);
     const db = initDbConnection((0, utils_1.getEnvVariable)(DatabaseEnvironmentKeys.DB_USER), (0, utils_1.getEnvVariable)(DatabaseEnvironmentKeys.DB_PASS), db_application, db_uri);
     try {
         // deallocate all prepared statements to allow for connection pooling

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.3.21-2",
+  "version": "2023.3.27-1",
   "description": "",
   "repository": {
     "type": "git",
@@ -17,13 +17,13 @@
     "src/**/*.ts"
   ],
   "peerDependencies": {
-    "@aws-cdk/aws-synthetics-alpha": "2.62.2-alpha.0",
+    "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
     "@types/geojson": "^7946.0.10",
-    "aws-cdk-lib": "2.62.2",
-    "aws-sdk": "^2.1304.0",
-    "axios": "^1.2.6",
+    "aws-cdk-lib": "2.70.0",
+    "aws-sdk": "^2.1343.0",
+    "axios": "^1.3.4",
     "change-case": "^4.1.2",
-    "constructs": "^10.1.235",
+    "constructs": "^10.1.292",
     "geojson-validation": "^1.0.2",
     "moment": "^2.29.4",
     "node-ttl": "^0.2.0",
@@ -31,36 +31,36 @@
     "pg-promise": "^10.12.0"
   },
   "devDependencies": {
-    "@aws-cdk/aws-synthetics-alpha": "2.62.2-alpha.0",
-    "@types/aws-lambda": "^8.10.110",
+    "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
+    "@types/aws-lambda": "^8.10.114",
     "@types/geojson": "^7946.0.10",
-    "@types/jest": "^29.2.5",
-    "@types/node": "^18.13.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.10",
     "@types/ramda": "^0.28.23",
     "@types/sinon": "^10.0.13",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
-    "aws-cdk-lib": "2.62.2",
-    "aws-sdk": "^2.1304.0",
-    "axios": "^1.2.6",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "aws-cdk-lib": "2.70.0",
+    "aws-sdk": "^2.1343.0",
+    "axios": "^1.3.4",
     "change-case": "^4.1.2",
-    "constructs": "^10.1.222",
-    "eslint": "~8.34.0",
-    "eslint-config-prettier": "^8.6.0",
+    "constructs": "^10.1.292",
+    "eslint": "~8.36.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-deprecation": "1.3.3",
     "geojson-validation": "^1.0.2",
     "husky": "^8.0.3",
-    "jest": "^29.4.2",
+    "jest": "^29.5.0",
     "jest-junit": "^15.0.0",
-    "lint-staged": "^13.1.1",
+    "lint-staged": "^13.2.0",
     "moment": "^2.29.4",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
     "pg-promise": "^10.12.0",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.7",
     "ramda": "^0.28.0",
     "rimraf": "^4.1.0",
-    "sinon": "^15.0.1",
+    "sinon": "^15.0.3",
     "ts-jest": "^29.0.5",
     "typescript": "~4.8.4"
   },

package/src/aws/infra/api/integration.ts

@@ -7,7 +7,7 @@ import { IFunction } from "aws-cdk-lib/aws-lambda";
 import { MediaType } from "../../types/mediatypes";
 import { DigitrafficIntegrationResponse } from "../../runtime/digitraffic-integration-response";
 
-type ParameterType = "path" | "querystring";
+type ParameterType = "path" | "querystring" | "context";
 
 interface ApiParameter {
     type: ParameterType;
@@ -44,6 +44,14 @@ export class DigitrafficIntegration {
         return this;
     }
 
+    addContextParameter(...names: string[]): this {
+        names.forEach((name) =>
+            this.parameters.push({ type: "context", name })
+        );
+
+        return this;
+    }
+
     build(): LambdaIntegration {
         const integrationResponses = this.createResponses();
 
@@ -65,11 +73,14 @@ export class DigitrafficIntegration {
     createRequestParameters(): Record<string, string> {
         const requestParameters: Record<string, string> = {};
 
-        this.parameters.forEach((parameter: ApiParameter) => {
-            requestParameters[
-                `integration.request.${parameter.type}.${parameter.name}`
-            ] = `method.request.${parameter.type}.${parameter.name}`;
-        });
+        // filter out context parameters
+        this.parameters
+            .filter((parameter) => parameter.type !== "context")
+            .forEach((parameter: ApiParameter) => {
+                requestParameters[
+                    `integration.request.${parameter.type}.${parameter.name}`
+                ] = `method.request.${parameter.type}.${parameter.name}`;
+            });
 
         return requestParameters;
     }
@@ -78,9 +89,15 @@ export class DigitrafficIntegration {
         const requestJson: Record<string, string> = {};
 
         this.parameters.forEach((parameter: ApiParameter) => {
-            requestJson[
-                parameter.name
-            ] = `$util.escapeJavaScript($input.params('${parameter.name}'))`;
+            if (parameter.type === "context") {
+                requestJson[
+                    parameter.name
+                ] = `$util.parseJson($context.${parameter.name})`;
+            } else {
+                requestJson[
+                    parameter.name
+                ] = `$util.escapeJavaScript($input.params('${parameter.name}'))`;
+            }
         });
 
         return {

package/src/aws/infra/api/response.ts

@@ -1,7 +1,13 @@
-import {MediaType} from "../../types/mediatypes";
-import {JsonSchema, JsonSchemaType, JsonSchemaVersion, MethodResponse, Model,} from "aws-cdk-lib/aws-apigateway";
-import {IModel} from "aws-cdk-lib/aws-apigateway/lib/model";
-import {dateFromIsoString} from "../../../utils/date-utils";
+import { MediaType } from "../../types/mediatypes";
+import {
+    JsonSchema,
+    JsonSchemaType,
+    JsonSchemaVersion,
+    MethodResponse,
+    Model,
+} from "aws-cdk-lib/aws-apigateway";
+import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
+import { dateFromIsoString } from "../../../utils/date-utils";
 
 /**
  * This is velocity-script, that assumes the response to be LambdaResponse(status and body).
@@ -37,7 +43,9 @@ $util.base64Decode($inputRoot.body)
 
 export const getDeprecatedDefaultLambdaResponse = (sunset: string) => {
     const setDeprecationHeaders = `#set ($context.responseOverride.header.Deprecation = 'true')
-#set ($context.responseOverride.header.Sunset = '${dateFromIsoString(sunset).toUTCString()}')`;
+#set ($context.responseOverride.header.Sunset = '${dateFromIsoString(
+        sunset
+    ).toUTCString()}')`;
     return RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
 };
 
@@ -75,35 +83,21 @@ const BadRequestMessage = "Bad request";
 const BadRequestResponse = JSON.stringify({ message: BadRequestMessage });
 
 /// @deprecated
-export const BadRequestResponseTemplate = createResponses(
-    MediaType.APPLICATION_JSON,
-    BadRequestResponse
-);
-/// @deprecated
-export const NotFoundResponseTemplate = createResponses(
-    MediaType.APPLICATION_JSON,
-    NotFoundResponse
-);
+export const BadRequestResponseTemplate = {
+    [MediaType.APPLICATION_JSON]: BadRequestResponse,
+};
 /// @deprecated
-export const XmlResponseTemplate = createResponses(
-    MediaType.APPLICATION_XML,
-    BODY_FROM_INPUT_PATH
-);
+export const NotFoundResponseTemplate = {
+    [MediaType.APPLICATION_JSON]: NotFoundResponse,
+};
 /// @deprecated
-export const InternalServerErrorResponseTemplate = createResponses(
-    MediaType.APPLICATION_JSON,
-    InternalServerErrorResponse
-);
-
+export const XmlResponseTemplate = {
+    [MediaType.APPLICATION_XML]: BODY_FROM_INPUT_PATH,
+};
 /// @deprecated
-export function createResponses<T>(
-    key: MediaType,
-    value: T
-): Record<string, T> {
-    return {
-        [key]: value,
-    };
-}
+export const InternalServerErrorResponseTemplate = {
+    [MediaType.APPLICATION_JSON]: InternalServerErrorResponse,
+};
 
 export class DigitrafficMethodResponse {
     static response(

package/src/aws/infra/api/responses.ts

@@ -1,6 +1,5 @@
 import {
     InternalServerErrorResponseTemplate,
-    createResponses,
     XmlResponseTemplate,
     NotFoundResponseTemplate,
     BadRequestResponseTemplate,
@@ -20,32 +19,38 @@ import {
 } from "../../types/errors";
 import { MediaType } from "../../types/mediatypes";
 
+/// @deprecated
 export const RESPONSE_200_OK: IntegrationResponse = {
     statusCode: "200",
 };
 
+/// @deprecated
 export const RESPONSE_400_BAD_REQUEST: IntegrationResponse = {
     statusCode: "400",
     selectionPattern: BAD_REQUEST_MESSAGE,
     responseTemplates: BadRequestResponseTemplate,
 };
 
+/// @deprecated
 export const RESPONSE_500_SERVER_ERROR: IntegrationResponse = {
     statusCode: "500",
     selectionPattern: ERROR_MESSAGE,
     responseTemplates: InternalServerErrorResponseTemplate,
 };
 
+/// @deprecated
 const RESPONSE_XML = {
     responseTemplates: XmlResponseTemplate,
 };
 
+/// @deprecated
 export const RESPONSE_CORS_INTEGRATION = {
     responseParameters: {
         "method.response.header.Access-Control-Allow-Origin": "'*'",
     },
 };
 
+/// @deprecated
 export const RESPONSE_404_NOT_FOUND = {
     statusCode: "404",
     selectionPattern: NOT_FOUND_MESSAGE,
@@ -63,7 +68,9 @@ export function methodResponse(
 ): MethodResponse {
     return {
         statusCode: status,
-        responseModels: createResponses(contentType, model),
+        responseModels: {
+            [contentType]: model,
+        },
         responseParameters: parameters ?? {},
     };
 }

package/src/database/database.ts

@@ -1,6 +1,5 @@
 import { IDatabase, ITask } from "pg-promise";
-import { getEnvVariable } from "../utils/utils";
-import { envValue } from "../aws/runtime/environment";
+import { getEnvVariable, getEnvVariableOrElse } from "../utils/utils";
 
 export enum DatabaseEnvironmentKeys {
     DB_USER = "DB_USER",
@@ -78,13 +77,13 @@ async function doInDatabase<T>(
     readonly: boolean,
     fn: (db: DTDatabase) => Promise<T>
 ): Promise<T> {
-    const db_application = envValue(
+    const db_application = getEnvVariableOrElse(
         DatabaseEnvironmentKeys.DB_APPLICATION,
         "unknown-cdk-application"
     );
     const db_uri = readonly
-        ? envValue(DatabaseEnvironmentKeys.DB_RO_URI)
-        : envValue(DatabaseEnvironmentKeys.DB_URI);
+        ? getEnvVariable(DatabaseEnvironmentKeys.DB_RO_URI)
+        : getEnvVariable(DatabaseEnvironmentKeys.DB_URI);
 
     const db = initDbConnection(
         getEnvVariable(DatabaseEnvironmentKeys.DB_USER),