@digitraffic/common 2023.4.4-1 → 2023.4.28-1

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

@@ -10,8 +10,9 @@ import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
  * non-textual content.
  *
  * If fileName is set, then Content-Disposition-header will be set to use it
+ * If timestamp is set, then ETag & Last-Modified headers will be set
  */
-export declare const RESPONSE_DEFAULT_LAMBDA = "#set($inputRoot = $input.path('$'))\n$util.base64Decode($inputRoot.body)\n#if ($inputRoot.status != 200)\n#set ($context.responseOverride.status = $inputRoot.status)\n#set ($context.responseOverride.header.Content-Type = 'text/plain')\n#end\n#set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')\n#if (\"$!inputRoot.fileName\" != \"\")\n#set ($disposition = 'attachment; filename=\"FN\"')\n#set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))\n#end\n";
+export declare const RESPONSE_DEFAULT_LAMBDA = "#set($inputRoot = $input.path('$'))\n#if ($inputRoot.status != 200)\n#set ($context.responseOverride.status = $inputRoot.status)\n#set ($context.responseOverride.header.Content-Type = 'text/plain')\n#end\n#set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')\n#if (\"$!inputRoot.timestamp\" != \"\")\n#set ($context.responseOverride.header.ETag = $inputRoot.timestamp)\n#set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)\n#end\n#if (\"$!inputRoot.fileName\" != \"\")\n#set ($disposition = 'attachment; filename=\"FN\"')\n#set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))\n#end\n$util.base64Decode($inputRoot.body)";
 /**
  * Use this for deprecated integrations.
  * Will add HTTP headers Deprecation and Sunset to response.

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

@@ -13,19 +13,23 @@ const date_utils_1 = require("../../../utils/date-utils");
  * non-textual content.
  *
  * If fileName is set, then Content-Disposition-header will be set to use it
+ * If timestamp is set, then ETag & Last-Modified headers will be set
  */
 exports.RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
-$util.base64Decode($inputRoot.body)
 #if ($inputRoot.status != 200)
 #set ($context.responseOverride.status = $inputRoot.status)
 #set ($context.responseOverride.header.Content-Type = 'text/plain')
 #end
 #set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')
+#if ("$!inputRoot.timestamp" != "")
+#set ($context.responseOverride.header.ETag = $inputRoot.timestamp)
+#set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)
+#end
 #if ("$!inputRoot.fileName" != "")
 #set ($disposition = 'attachment; filename="FN"')
 #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))
 #end
-`;
+$util.base64Decode($inputRoot.body)`;
 /**
  * Use this for deprecated integrations.
  * Will add HTTP headers Deprecation and Sunset to response.

package/dist/aws/types/lambda-response.d.ts

@@ -2,7 +2,9 @@ export declare class LambdaResponse {
     readonly status: number;
     readonly body: string;
     readonly fileName?: string;
-    constructor(status: number, body: string, fileName?: string);
+    readonly timestamp?: string;
+    constructor(status: number, body: string, fileName?: string, timestamp?: Date);
+    withTimestamp(timestamp: Date): LambdaResponse;
     /**
      * Create LambdaResponse for HTTP 200 from json.
      */
@@ -31,4 +33,6 @@ export declare class LambdaResponse {
      * Create LambdaResponse for HTTP 501
      */
     static notImplemented(): LambdaResponse;
+    private static createForString;
+    private static createForBase64;
 }

package/dist/aws/types/lambda-response.js

@@ -2,10 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LambdaResponse = void 0;
 class LambdaResponse {
-    constructor(status, body, fileName) {
+    constructor(status, body, fileName, timestamp) {
         this.status = status;
         this.body = body;
         this.fileName = fileName;
+        this.timestamp = timestamp?.toUTCString();
+    }
+    withTimestamp(timestamp) {
+        return new LambdaResponse(this.status, this.body, this.fileName, timestamp);
     }
     /**
      * Create LambdaResponse for HTTP 200 from json.
@@ -23,41 +27,41 @@ class LambdaResponse {
      * Create LambdaResponse for HTTP 200 from base64-encoded data.
      */
     static okBinary(base64, fileName) {
-        return createForBase64(200, base64, fileName);
+        return this.createForBase64(200, base64, fileName);
     }
     /**
      * Create LambdaResponse for HTTP 400
      */
     static badRequest(body) {
-        return createForString(400, body);
+        return this.createForString(400, body);
     }
     /**
      * Create LambdaResponse for HTTP 404
      */
     static notFound() {
-        return createForString(404, "Not found");
+        return this.createForString(404, "Not found");
     }
     /**
      * Create LambdaResponse for HTTP 500
      */
     static internalError() {
-        return createForString(500, "Internal error");
+        return this.createForString(500, "Internal error");
     }
     /**
      * Create LambdaResponse for HTTP 501
      */
     static notImplemented() {
-        return createForString(501, "Not implemented");
+        return this.createForString(501, "Not implemented");
+    }
+    static createForString(status, body, fileName) {
+        return this.createForBase64(status, toBase64(body), fileName);
+    }
+    static createForBase64(status, base64Body, fileName) {
+        return new LambdaResponse(status, base64Body, fileName);
     }
 }
 exports.LambdaResponse = LambdaResponse;
 function toBase64(body) {
     return Buffer.from(body).toString("base64");
 }
-function createForString(status, body, fileName) {
-    return createForBase64(status, toBase64(body), fileName);
-}
-function createForBase64(status, base64Body, fileName) {
-    return new LambdaResponse(status, base64Body, fileName);
-}
 //# sourceMappingURL=lambda-response.js.map

package/dist/types/nullable.d.ts

@@ -1,19 +1,20 @@
+import { ValueOf } from "./util-types";
 /**
  * Adds `null` as an accepted type to all properties in given type.
  */
 export type Nullable<Obj> = {
     [Key in keyof Obj]: Obj[Key] | null;
 };
-type RequiredKeys<Obj> = {
+type RequiredKeys<Obj> = ValueOf<{
     [Key in keyof Obj]-?: object extends {
         [K in Key]: Obj[Key];
     } ? never : Key;
-}[keyof Obj];
-type OptionalKeys<Obj> = {
+}>;
+type OptionalKeys<Obj> = ValueOf<{
     [Key in keyof Obj]-?: object extends {
         [K in Key]: Obj[Key];
     } ? Key : never;
-}[keyof Obj];
+}>;
 type RequiredProperties<Obj> = Pick<Obj, RequiredKeys<Obj>>;
 type OptionalProperties<Obj> = Pick<Obj, OptionalKeys<Obj>>;
 /**

package/dist/types/util-types.d.ts

@@ -0,0 +1 @@
+export type ValueOf<Obj> = Obj[keyof Obj];

package/dist/types/util-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=util-types.js.map

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.4.4-1",
+  "version": "2023.4.28-1",
   "description": "",
   "repository": {
     "type": "git",
     "url": "https://github.com/tmfg/digitraffic-common.git"
   },
   "engines": {
-    "node": ">=14 <17"
+    "node": ">=14 <17 || >=18 <19"
   },
   "license": "EUPL-1.2",
   "private": false,
@@ -17,53 +17,54 @@
     "src/**/*.ts"
   ],
   "peerDependencies": {
-    "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
+    "@aws-cdk/aws-synthetics-alpha": "^2.62.2-alpha.0",
     "@types/geojson": "^7946.0.10",
-    "aws-cdk-lib": "2.70.0",
-    "aws-sdk": "^2.1343.0",
-    "axios": "^1.3.4",
+    "aws-cdk-lib": "^2.76.0",
+    "aws-sdk": "^2.1362.0",
+    "axios": "^1.2.6",
     "change-case": "^4.1.2",
     "constructs": "^10.1.292",
     "geojson-validation": "^1.0.2",
     "moment": "^2.29.4",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
-    "pg-promise": "^10.12.0"
+    "pg-promise": "^11.0.0"
   },
   "devDependencies": {
     "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
-    "@types/aws-lambda": "^8.10.114",
+    "@types/aws-lambda": "~8.10.114",
     "@types/geojson": "^7946.0.10",
-    "@types/jest": "^29.5.0",
-    "@types/lodash": "^4.14.192",
-    "@types/node": "^18.15.10",
-    "@types/ramda": "^0.28.23",
-    "@types/sinon": "^10.0.13",
-    "@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",
+    "@types/jest": "^29.5.1",
+    "@types/lodash": "^4.14.194",
+    "@types/node": "18.15.13",
+    "@types/ramda": "~0.29.0",
+    "@types/sinon": "10.0.14",
+    "@typescript-eslint/eslint-plugin": "~5.59.0",
+    "@typescript-eslint/parser": "^5.59.0",
+    "aws-cdk-lib": "~2.76.0",
+    "aws-sdk": "~2.1362.0",
+    "axios": "^1.3.6",
     "change-case": "^4.1.2",
-    "constructs": "^10.1.292",
-    "eslint": "~8.36.0",
+    "constructs": "10.2.2",
+    "eslint": "~8.38.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-deprecation": "~1.3.3",
+    "eslint-plugin-deprecation": "~1.4.1",
     "geojson-validation": "^1.0.2",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
-    "jest-junit": "^15.0.0",
-    "lint-staged": "^13.2.0",
+    "jest-junit": "^16.0.0",
+    "lint-staged": "^13.2.1",
     "moment": "^2.29.4",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
-    "pg-promise": "^10.12.0",
+    "pg-promise": "^11.4.3",
     "prettier": "^2.8.7",
-    "ramda": "^0.28.0",
-    "rimraf": "^4.1.0",
-    "sinon": "^15.0.3",
-    "ts-jest": "^29.0.5",
-    "typescript": "~4.9.5"
+    "ramda": "~0.29.0",
+    "rimraf": "^5.0.0",
+    "sinon": "15.0.4",
+    "ts-jest": "^29.1.0",
+    "typescript": "~4.9.5",
+    "velocityjs": "2.0.6"
   },
   "externals": [
     "aws-sdk",

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

@@ -18,19 +18,23 @@ import { dateFromIsoString } from "../../../utils/date-utils";
  * non-textual content.
  *
  * If fileName is set, then Content-Disposition-header will be set to use it
+ * If timestamp is set, then ETag & Last-Modified headers will be set
  */
 export const RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
-$util.base64Decode($inputRoot.body)
 #if ($inputRoot.status != 200)
 #set ($context.responseOverride.status = $inputRoot.status)
 #set ($context.responseOverride.header.Content-Type = 'text/plain')
 #end
 #set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')
+#if ("$!inputRoot.timestamp" != "")
+#set ($context.responseOverride.header.ETag = $inputRoot.timestamp)
+#set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)
+#end
 #if ("$!inputRoot.fileName" != "")
 #set ($disposition = 'attachment; filename="FN"')
 #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))
 #end
-`;
+$util.base64Decode($inputRoot.body)`;
 
 /**
  * Use this for deprecated integrations.

package/src/aws/types/lambda-response.ts

@@ -2,11 +2,27 @@ export class LambdaResponse {
     readonly status: number;
     readonly body: string;
     readonly fileName?: string;
+    readonly timestamp?: string;
 
-    constructor(status: number, body: string, fileName?: string) {
+    constructor(
+        status: number,
+        body: string,
+        fileName?: string,
+        timestamp?: Date
+    ) {
         this.status = status;
         this.body = body;
         this.fileName = fileName;
+        this.timestamp = timestamp?.toUTCString();
+    }
+
+    withTimestamp(timestamp: Date) {
+        return new LambdaResponse(
+            this.status,
+            this.body,
+            this.fileName,
+            timestamp
+        );
     }
 
     /**
@@ -27,54 +43,54 @@ export class LambdaResponse {
      * Create LambdaResponse for HTTP 200 from base64-encoded data.
      */
     static okBinary(base64: string, fileName?: string) {
-        return createForBase64(200, base64, fileName);
+        return this.createForBase64(200, base64, fileName);
     }
 
     /**
      * Create LambdaResponse for HTTP 400
      */
     static badRequest(body: string) {
-        return createForString(400, body);
+        return this.createForString(400, body);
     }
 
     /**
      * Create LambdaResponse for HTTP 404
      */
     static notFound() {
-        return createForString(404, "Not found");
+        return this.createForString(404, "Not found");
     }
 
     /**
      * Create LambdaResponse for HTTP 500
      */
     static internalError() {
-        return createForString(500, "Internal error");
+        return this.createForString(500, "Internal error");
     }
 
     /**
      * Create LambdaResponse for HTTP 501
      */
     static notImplemented() {
-        return createForString(501, "Not implemented");
+        return this.createForString(501, "Not implemented");
     }
-}
 
-function toBase64(body: string) {
-    return Buffer.from(body).toString("base64");
-}
+    private static createForString(
+        status: number,
+        body: string,
+        fileName?: string
+    ): LambdaResponse {
+        return this.createForBase64(status, toBase64(body), fileName);
+    }
 
-function createForString(
-    status: number,
-    body: string,
-    fileName?: string
-): LambdaResponse {
-    return createForBase64(status, toBase64(body), fileName);
+    private static createForBase64(
+        status: number,
+        base64Body: string,
+        fileName?: string
+    ): LambdaResponse {
+        return new LambdaResponse(status, base64Body, fileName);
+    }
 }
 
-function createForBase64(
-    status: number,
-    base64Body: string,
-    fileName?: string
-): LambdaResponse {
-    return new LambdaResponse(status, base64Body, fileName);
+function toBase64(body: string) {
+    return Buffer.from(body).toString("base64");
 }

package/src/types/nullable.ts

@@ -1,14 +1,16 @@
+import { ValueOf } from "./util-types";
+
 /**
  * Adds `null` as an accepted type to all properties in given type.
  */
 export type Nullable<Obj> = { [Key in keyof Obj]: Obj[Key] | null };
 
-type RequiredKeys<Obj> = {
+type RequiredKeys<Obj> = ValueOf<{
     [Key in keyof Obj]-?: object extends { [K in Key]: Obj[Key] } ? never : Key;
-}[keyof Obj];
-type OptionalKeys<Obj> = {
+}>;
+type OptionalKeys<Obj> = ValueOf<{
     [Key in keyof Obj]-?: object extends { [K in Key]: Obj[Key] } ? Key : never;
-}[keyof Obj];
+}>;
 type RequiredProperties<Obj> = Pick<Obj, RequiredKeys<Obj>>;
 type OptionalProperties<Obj> = Pick<Obj, OptionalKeys<Obj>>;
 

package/src/types/util-types.ts

@@ -0,0 +1 @@
+export type ValueOf<Obj> = Obj[keyof Obj];