@digitraffic/common 2023.5.10-1 → 2023.5.25-1

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

@@ -12,7 +12,7 @@ import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
  * 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#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)";
+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.Last-Modified = $inputRoot.timestamp)\n#end\n#if (\"$!inputRoot.etag\" != \"\")\n#set ($context.responseOverride.header.ETag = $inputRoot.etag)\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

@@ -22,9 +22,11 @@ exports.RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
 #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.etag" != "")
+#set ($context.responseOverride.header.ETag = $inputRoot.etag)
+#end
 #if ("$!inputRoot.fileName" != "")
 #set ($disposition = 'attachment; filename="FN"')
 #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))

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

@@ -3,6 +3,7 @@ export declare class LambdaResponse {
     readonly body: string;
     readonly fileName?: string;
     readonly timestamp?: string;
+    readonly etag: string;
     constructor(status: number, body: string, fileName?: string, timestamp?: Date);
     withTimestamp(timestamp: Date): LambdaResponse;
     /**

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

@@ -1,12 +1,17 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LambdaResponse = void 0;
+const etag_1 = __importDefault(require("etag"));
 class LambdaResponse {
     constructor(status, body, fileName, timestamp) {
         this.status = status;
         this.body = body;
         this.fileName = fileName;
         this.timestamp = timestamp?.toUTCString();
+        this.etag = (0, etag_1.default)(body); // create strong etag by default
     }
     withTimestamp(timestamp) {
         return new LambdaResponse(this.status, this.body, this.fileName, timestamp);

package/dist/database/cached.d.ts

@@ -2,11 +2,19 @@ import { DTDatabase, DTTransaction } from "./database";
 export interface CachedValue<T> {
     content: T;
     last_updated: Date;
+    modified: Date;
 }
 export declare enum JSON_CACHE_KEY {
     NAUTICAL_WARNINGS_ACTIVE = "nautical-warnings-active",
     NAUTICAL_WARNINGS_ARCHIVED = "nautical-warnings-archived"
 }
-export declare function updateCachedJson<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY, value: T): Promise<null>;
-export declare function getJsonFromCache<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY): Promise<T | null>;
-export declare function getFromCache<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY): Promise<CachedValue<T> | null>;
+/**
+ *
+ * @param db
+ * @param cacheKey
+ * @param value
+ * @param lastUpdated time when data was created or updated
+ */
+export declare function updateCachedJson<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY, value: T, lastUpdated: Date): Promise<void>;
+export declare function getJsonFromCache<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY): Promise<T | undefined>;
+export declare function getFromCache<T>(db: DTDatabase | DTTransaction, cacheKey: JSON_CACHE_KEY): Promise<CachedValue<T> | undefined>;

package/dist/database/cached.js

@@ -2,37 +2,45 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFromCache = exports.getJsonFromCache = exports.updateCachedJson = exports.JSON_CACHE_KEY = void 0;
 const pg_promise_1 = require("pg-promise");
-const SQL_UPDATE_CACHE_VALUE = `insert into cached_json(cache_id, content, last_updated)
-    values ($1, $2, now())
-    on conflict(cache_id) do
-    update set content = $2, last_updated = now()`;
-const SQL_GET_CACHE_VALUE = `select content, last_updated from cached_json
-    where cache_id = $1`;
 const PS_UPDATE_CACHE_VALUE = new pg_promise_1.PreparedStatement({
     name: "update-cache-value",
-    text: SQL_UPDATE_CACHE_VALUE,
+    text: `insert into cached_json(cache_id, content, last_updated)
+    values ($1, $2, $3)
+    on conflict(cache_id) do
+    update set content = $2, last_updated = $3`,
 });
 const PS_GET_CACHE_VALUE = new pg_promise_1.PreparedStatement({
     name: "get-cache-value",
-    text: SQL_GET_CACHE_VALUE,
+    text: "select content, last_updated, modified from cached_json where cache_id = $1",
 });
 var JSON_CACHE_KEY;
 (function (JSON_CACHE_KEY) {
     JSON_CACHE_KEY["NAUTICAL_WARNINGS_ACTIVE"] = "nautical-warnings-active";
     JSON_CACHE_KEY["NAUTICAL_WARNINGS_ARCHIVED"] = "nautical-warnings-archived";
 })(JSON_CACHE_KEY = exports.JSON_CACHE_KEY || (exports.JSON_CACHE_KEY = {}));
-function updateCachedJson(db, cacheKey, value) {
-    return db.none(PS_UPDATE_CACHE_VALUE, [cacheKey, value]);
+/**
+ *
+ * @param db
+ * @param cacheKey
+ * @param value
+ * @param lastUpdated time when data was created or updated
+ */
+async function updateCachedJson(db, cacheKey, value, lastUpdated) {
+    await db.none(PS_UPDATE_CACHE_VALUE, [cacheKey, value, lastUpdated]);
 }
 exports.updateCachedJson = updateCachedJson;
 function getJsonFromCache(db, cacheKey) {
     return db
         .oneOrNone(PS_GET_CACHE_VALUE, [cacheKey])
-        .then((value) => value?.content ?? null);
+        .then((value) => value?.content ?? undefined);
 }
 exports.getJsonFromCache = getJsonFromCache;
-function getFromCache(db, cacheKey) {
-    return db.oneOrNone(PS_GET_CACHE_VALUE, [cacheKey]);
+async function getFromCache(db, cacheKey) {
+    return db
+        .oneOrNone(PS_GET_CACHE_VALUE, [cacheKey])
+        .then((result) => {
+        return result ?? undefined;
+    });
 }
 exports.getFromCache = getFromCache;
 //# sourceMappingURL=cached.js.map

package/dist/utils/date-utils.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Constant for the 1970-01-01T00:00:00Z epoch Date.
+ */
 export declare const EPOCH: Date;
 /**
  * Counts difference in milliseconds between dates.

package/dist/utils/date-utils.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dateFromIsoString = exports.countDiffInSeconds = exports.countDiffMs = exports.EPOCH = void 0;
+/**
+ * Constant for the 1970-01-01T00:00:00Z epoch Date.
+ */
 exports.EPOCH = new Date(Date.UTC(1970, 0, 1));
 /**
  * Counts difference in milliseconds between dates.
@@ -26,10 +29,13 @@ exports.countDiffInSeconds = countDiffInSeconds;
  */
 function dateFromIsoString(isoString) {
     const parsed = new Date(isoString);
-    if (!(parsed instanceof Date) || isNaN(parsed.getTime())) {
-        throw new Error(`Invalid ISO-DATE -string: ${isoString}`);
+    if (!isValidDate(parsed)) {
+        throw new Error(`Could not parse iso date-time string: "${isoString}" to date`);
     }
     return parsed;
 }
 exports.dateFromIsoString = dateFromIsoString;
+function isValidDate(d) {
+    return d instanceof Date && !isNaN(d.getTime());
+}
 //# sourceMappingURL=date-utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.5.10-1",
+  "version": "2023.5.25-1",
   "description": "",
   "repository": {
     "type": "git",
@@ -24,6 +24,7 @@
     "axios": "^1.2.6",
     "change-case": "^4.1.2",
     "constructs": "^10.2.17",
+    "etag": "^1.8.1",
     "geojson-validation": "^1.0.2",
     "moment": "^2.29.4",
     "node-ttl": "^0.2.0",
@@ -34,6 +35,7 @@
     "@aws-cdk/aws-synthetics-alpha": "2.78.0-alpha.0",
     "@types/aws-lambda": "~8.10.115",
     "@types/geojson": "^7946.0.10",
+    "@types/etag": "^1.8.1",
     "@types/jest": "^29.5.1",
     "@types/lodash": "^4.14.194",
     "@types/node": "18.15.13",

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

@@ -27,9 +27,11 @@ export const RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
 #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.etag" != "")
+#set ($context.responseOverride.header.ETag = $inputRoot.etag)
+#end
 #if ("$!inputRoot.fileName" != "")
 #set ($disposition = 'attachment; filename="FN"')
 #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))

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

@@ -1,8 +1,11 @@
+import etag from "etag";
+
 export class LambdaResponse {
     readonly status: number;
     readonly body: string;
     readonly fileName?: string;
     readonly timestamp?: string;
+    readonly etag: string;
 
     constructor(
         status: number,
@@ -14,6 +17,7 @@ export class LambdaResponse {
         this.body = body;
         this.fileName = fileName;
         this.timestamp = timestamp?.toUTCString();
+        this.etag = etag(body); // create strong etag by default
     }
 
     withTimestamp(timestamp: Date) {

package/src/database/cached.ts

@@ -4,24 +4,20 @@ import { DTDatabase, DTTransaction } from "./database";
 export interface CachedValue<T> {
     content: T;
     last_updated: Date;
+    modified: Date;
 }
 
-const SQL_UPDATE_CACHE_VALUE = `insert into cached_json(cache_id, content, last_updated)
-    values ($1, $2, now())
-    on conflict(cache_id) do
-    update set content = $2, last_updated = now()`;
-
-const SQL_GET_CACHE_VALUE = `select content, last_updated from cached_json
-    where cache_id = $1`;
-
 const PS_UPDATE_CACHE_VALUE = new PreparedStatement({
     name: "update-cache-value",
-    text: SQL_UPDATE_CACHE_VALUE,
+    text: `insert into cached_json(cache_id, content, last_updated)
+    values ($1, $2, $3)
+    on conflict(cache_id) do
+    update set content = $2, last_updated = $3`,
 });
 
 const PS_GET_CACHE_VALUE = new PreparedStatement({
     name: "get-cache-value",
-    text: SQL_GET_CACHE_VALUE,
+    text: "select content, last_updated, modified from cached_json where cache_id = $1",
 });
 
 export enum JSON_CACHE_KEY {
@@ -29,26 +25,38 @@ export enum JSON_CACHE_KEY {
     NAUTICAL_WARNINGS_ARCHIVED = "nautical-warnings-archived",
 }
 
-export function updateCachedJson<T>(
+/**
+ *
+ * @param db
+ * @param cacheKey
+ * @param value
+ * @param lastUpdated time when data was created or updated
+ */
+export async function updateCachedJson<T>(
     db: DTDatabase | DTTransaction,
     cacheKey: JSON_CACHE_KEY,
-    value: T
-): Promise<null> {
-    return db.none(PS_UPDATE_CACHE_VALUE, [cacheKey, value]);
+    value: T,
+    lastUpdated: Date
+): Promise<void> {
+    await db.none(PS_UPDATE_CACHE_VALUE, [cacheKey, value, lastUpdated]);
 }
 
 export function getJsonFromCache<T>(
     db: DTDatabase | DTTransaction,
     cacheKey: JSON_CACHE_KEY
-): Promise<T | null> {
+): Promise<T | undefined> {
     return db
         .oneOrNone<CachedValue<T>>(PS_GET_CACHE_VALUE, [cacheKey])
-        .then((value) => value?.content ?? null);
+        .then((value) => value?.content ?? undefined);
 }
 
-export function getFromCache<T>(
+export async function getFromCache<T>(
     db: DTDatabase | DTTransaction,
     cacheKey: JSON_CACHE_KEY
-): Promise<CachedValue<T> | null> {
-    return db.oneOrNone<CachedValue<T>>(PS_GET_CACHE_VALUE, [cacheKey]);
+): Promise<CachedValue<T> | undefined> {
+    return db
+        .oneOrNone<CachedValue<T>>(PS_GET_CACHE_VALUE, [cacheKey])
+        .then((result) => {
+            return result ?? undefined;
+        });
 }

package/src/utils/date-utils.ts

@@ -1,4 +1,8 @@
+/**
+ * Constant for the 1970-01-01T00:00:00Z epoch Date.
+ */
 export const EPOCH = new Date(Date.UTC(1970, 0, 1));
+
 /**
  * Counts difference in milliseconds between dates.
  * @param start
@@ -23,8 +27,14 @@ export function countDiffInSeconds(start: Date, end: Date): number {
  */
 export function dateFromIsoString(isoString: string): Date {
     const parsed = new Date(isoString);
-    if (!(parsed instanceof Date) || isNaN(parsed.getTime())) {
-        throw new Error(`Invalid ISO-DATE -string: ${isoString}`);
+    if (!isValidDate(parsed)) {
+        throw new Error(
+            `Could not parse iso date-time string: "${isoString}" to date`
+        );
     }
     return parsed;
 }
+
+function isValidDate(d: any) {
+    return d instanceof Date && !isNaN(d.getTime());
+}