@digitraffic/common 2023.5.10-1 → 2023.5.22-1

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.22-1",
   "description": "",
   "repository": {
     "type": "git",

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());
+}