@digitraffic/common 2024.1.24-3 → 2024.1.30-1

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

@@ -1,100 +0,0 @@
-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,
-        body: string,
-        fileName?: string,
-        timestamp?: Date
-    ) {
-        this.status = status;
-        this.body = body;
-        this.fileName = fileName;
-        this.timestamp = timestamp?.toUTCString();
-        this.etag = etag(body); // create strong etag by default
-    }
-
-    withTimestamp(timestamp: Date) {
-        return new LambdaResponse(
-            this.status,
-            this.body,
-            this.fileName,
-            timestamp
-        );
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 200 from json.
-     */
-    static okJson<T>(json: T, fileName?: string) {
-        return this.ok(JSON.stringify(json), fileName);
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 200 from string.
-     */
-    static ok(body: string, fileName?: string) {
-        return this.okBinary(toBase64(body), fileName);
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 200 from base64-encoded data.
-     */
-    static okBinary(base64: string, fileName?: string) {
-        return this.createForBase64(200, base64, fileName);
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 400
-     */
-    static badRequest(body: string) {
-        return this.createForString(400, body);
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 404
-     */
-    static notFound() {
-        return this.createForString(404, "Not found");
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 500
-     */
-    static internalError() {
-        return this.createForString(500, "Internal error");
-    }
-
-    /**
-     * Create LambdaResponse for HTTP 501
-     */
-    static notImplemented() {
-        return this.createForString(501, "Not implemented");
-    }
-
-    private static createForString(
-        status: number,
-        body: string,
-        fileName?: string
-    ): LambdaResponse {
-        return this.createForBase64(status, toBase64(body), fileName);
-    }
-
-    private static 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/aws/types/mediatypes.mts

@@ -1,12 +0,0 @@
-// charset=UTF-8 is deprecated but mobile applications sometimes needs it
-export enum MediaType {
-    APPLICATION_JSON = "application/json",
-    APPLICATION_XML = "application/xml",
-    APPLICATION_GEOJSON = "application/geo+json;charset=UTF-8",
-    IMAGE_SVG = "image/svg+xml",
-    IMAGE_JPEG = "image/jpeg",
-    TEXT_PLAIN = "text/plain",
-    TEXT_HTML = "text/html",
-    TEXT_CSV = "text/csv",
-    APPLICATION_JSON_UTF8 = "application/json;charset=UTF-8",
-}

package/src/aws/types/model-with-reference.mts

@@ -1,8 +0,0 @@
-import {Model} from "aws-cdk-lib/aws-apigateway";
-
-/**
- * Model object with a reference to an API Gateway model object.
- */
-export interface ModelWithReference extends Model {
-    modelReference: string;
-}

package/src/aws/types/proxytypes.mts

@@ -1,27 +0,0 @@
-/**
- * https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
- *
- * Not fully described, extend if necessary.
- */
-export interface ProxyLambdaResponse {
-    readonly statusCode: number;
-    readonly body: string;
-    readonly headers?: Record<string, string>;
-    readonly multiValueHeaders?: Record<string, string[]>;
-}
-
-/**
- * https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
- *
- * Not fully described, extend if necessary.
- */
-export interface ProxyLambdaRequest {
-    readonly resource: string;
-    readonly path: string;
-    readonly httpMethod: string;
-    readonly headers: Record<string, string>;
-    readonly multiValueHeaders: Record<string, string[]>;
-    readonly queryStringParameters: Record<string, string>;
-    readonly multiValueQueryStringParameters: Record<string, string[]>;
-    readonly body?: string;
-}

package/src/aws/types/tags.mts

@@ -1,3 +0,0 @@
-// DEPRECATED! This must be replaced with new application specific tags
-export const BETA_TAGS = ['Beta'];
-export const DATA_V1_TAGS = ['Data v1'];

package/src/database/cached.mts

@@ -1,64 +0,0 @@
-import pg from "pg-promise";
-import { DTDatabase, DTTransaction } from "./database.mjs";
-
-const { PreparedStatement } = pg;
-
-export interface CachedValue<T> {
-    content: T;
-    last_updated: Date;
-    modified: Date;
-}
-
-const PS_UPDATE_CACHE_VALUE = new PreparedStatement({
-    name: "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: "select content, last_updated, modified from cached_json where cache_id = $1",
-});
-
-export enum JSON_CACHE_KEY {
-    NAUTICAL_WARNINGS_ACTIVE = "nautical-warnings-active",
-    NAUTICAL_WARNINGS_ARCHIVED = "nautical-warnings-archived",
-}
-
-/**
- *
- * @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,
-    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 | undefined> {
-    return db
-        .oneOrNone<CachedValue<T>>(PS_GET_CACHE_VALUE, [cacheKey])
-        .then((value) => value?.content ?? undefined);
-}
-
-export async function getFromCache<T>(
-    db: DTDatabase | DTTransaction,
-    cacheKey: JSON_CACHE_KEY
-): Promise<CachedValue<T> | undefined> {
-    return db
-        .oneOrNone<CachedValue<T>>(PS_GET_CACHE_VALUE, [cacheKey])
-        .then((result) => {
-            return result ?? undefined;
-        });
-}

package/src/database/database.mts

@@ -1,107 +0,0 @@
-import { type IDatabase, type ITask } from "pg-promise";
-import { getEnvVariable, getEnvVariableOrElse } from "../utils/utils.mjs";
-import { logger } from "../aws/runtime/dt-logger-default.mjs";
-import { logException } from "../utils/logging.mjs";
-
-export enum DatabaseEnvironmentKeys {
-    DB_USER = "DB_USER",
-    DB_PASS = "DB_PASS",
-    DB_URI = "DB_URI",
-    DB_RO_URI = "DB_RO_URI",
-    DB_APPLICATION = "DB_APPLICATION",
-}
-import pgpImport from "pg-promise";
-const pgp = pgpImport();
-
-// convert numeric types to number instead of string
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-pgp.pg.types.setTypeParser(pgp.pg.types.builtins.INT8, (value: string) => {
-    return parseInt(value);
-});
-
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-pgp.pg.types.setTypeParser(pgp.pg.types.builtins.FLOAT8, (value: string) => {
-    return parseFloat(value);
-});
-
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-pgp.pg.types.setTypeParser(pgp.pg.types.builtins.NUMERIC, (value: string) => {
-    return parseFloat(value);
-});
-
-export type DTDatabase = IDatabase<unknown>;
-
-export type DTTransaction = ITask<unknown>;
-
-/**
- * Creates a non-pooling database connection primarily used by Lambdas.
- *
- * Note! Using this method opens a new RDS connection on every invocation. It is advised to
- * use RDS proxy to pool connections transparently.
- * https://docs.amazonaws.cn/en_us/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html
- * @param username Username
- * @param password Password
- * @param applicationName name of application
- * @param url Connection URL
- * @param options pg-promise options
- */
-export function initDbConnection(
-    username: string,
-    password: string,
-    applicationName: string,
-    url: string,
-    options?: object
-): DTDatabase {
-    const finalUrl = `postgresql://${username}:${password}@${url}?application_name=${applicationName}`;
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
-    return pgp(finalUrl, options);
-}
-
-export function inTransaction<T>(
-    fn: (db: DTTransaction) => Promise<T>
-): Promise<T> {
-    return inDatabase((db) => db.tx((t: DTTransaction) => fn(t)));
-}
-
-export function inDatabase<T>(fn: (db: DTDatabase) => Promise<T>): Promise<T> {
-    return doInDatabase(false, fn);
-}
-
-export function inDatabaseReadonly<T>(
-    fn: (db: DTDatabase) => Promise<T>
-): Promise<T> {
-    return doInDatabase(true, fn);
-}
-
-async function doInDatabase<T>(
-    readonly: boolean,
-    fn: (db: DTDatabase) => Promise<T>
-): Promise<T> {
-    const db_application = getEnvVariableOrElse(
-        DatabaseEnvironmentKeys.DB_APPLICATION,
-        "unknown-cdk-application"
-    );
-    const db_uri = readonly
-        ? getEnvVariable(DatabaseEnvironmentKeys.DB_RO_URI)
-        : getEnvVariable(DatabaseEnvironmentKeys.DB_URI);
-
-    const db = initDbConnection(
-        getEnvVariable(DatabaseEnvironmentKeys.DB_USER),
-        getEnvVariable(DatabaseEnvironmentKeys.DB_PASS),
-        db_application,
-        db_uri
-    );
-    try {
-        // deallocate all prepared statements to allow for connection pooling
-        // DISCARD instead of DEALLOCATE as it didn't always clean all prepared statements
-        await db.none("DISCARD ALL");
-        return await fn(db);
-    } catch (e) {
-        logException(logger, e);
-
-        throw e;
-    } finally {
-        await db.$pool.end();
-    }
-}

package/src/database/last-updated.mts

@@ -1,103 +0,0 @@
-import { DTDatabase, DTTransaction } from "./database.mjs";
-
-export enum DataType {
-    VS_DATEX2 = "VS_DATEX2",
-    COUNTING_SITES_DATA = "COUNTING_SITES_DATA",
-    COUNTING_SITES_METADATA = "COUNTING_SITES_METADATA",
-    COUNTING_SITES_METADATA_CHECK = "COUNTING_SITES_METADATA_CHECK",
-    MAINTENANCE_TRACKING_DATA_CHECKED = "MAINTENANCE_TRACKING_DATA_CHECKED",
-    PERMIT_DATA = "PERMIT_DATA",
-    PERMIT_DATA_CHECK = "PERMIT_DATA_CHECK",
-}
-
-const UNSET_SUBTYPE = "-";
-
-type UpdatedTimestamp = {
-    updated: Date;
-} | null;
-
-export function getLastUpdated(
-    db: DTDatabase,
-    datatype: DataType
-): Promise<Date | null> {
-    return db.oneOrNone(
-        "select updated from data_updated where data_type=$(datatype) and subtype=$(subtype)",
-        {
-            datatype: datatype,
-            subtype: UNSET_SUBTYPE,
-        },
-        (x: UpdatedTimestamp) => x?.updated ?? null
-    );
-}
-
-export function getLastUpdatedWithSubtype(
-    db: DTDatabase,
-    datatype: DataType,
-    subtype: string
-): Promise<Date | null> {
-    return db.oneOrNone(
-        "SELECT updated FROM data_updated WHERE data_type=$(datatype) AND subtype=$(subtype)",
-        {
-            datatype: datatype,
-            subtype: subtype,
-        },
-        (x: UpdatedTimestamp) => x?.updated ?? null
-    );
-}
-
-export function updateLastUpdated(
-    db: DTDatabase | DTTransaction,
-    datatype: DataType,
-    updated: Date
-): Promise<null> {
-    return db.none(
-        `insert into data_updated(id, data_type, updated)
- values(nextval('seq_data_updated'), $(datatype), $(updated))
- on conflict (data_type, subtype)
- do update set updated = $(updated)`,
-        { updated, datatype }
-    );
-}
-
-export function updateLastUpdatedWithSubtype(
-    db: DTDatabase | DTTransaction,
-    datatype: DataType,
-    subtype: string,
-    updated: Date
-): Promise<null> {
-    return db.none(
-        `insert into data_updated(id, data_type, subtype, updated)
- values(nextval('seq_data_updated'), $(datatype), $(subtype), $(updated))
- on conflict (data_type, subtype)
- do update set updated = $(updated)`,
-        { updated, subtype, datatype }
-    );
-}
-
-export function getUpdatedTimestamp(
-    db: DTDatabase,
-    datatype: string
-): Promise<Date | null> {
-    return db.oneOrNone(
-        "select updated_time as updated from updated_timestamp where updated_name=$(datatype)",
-        {
-            datatype: datatype,
-        },
-        (x: UpdatedTimestamp) => x?.updated ?? null
-    );
-}
-
-export function updateUpdatedTimestamp(
-    db: DTDatabase | DTTransaction,
-    datatype: string,
-    date: Date,
-    by = ""
-): Promise<null> {
-    return db.none(
-        `insert into updated_timestamp(updated_name, updated_time, updated_by)
-values($(datatype), $(date), $(by))
-on conflict (updated_name)
-do update set updated_time = $(date), updated_by = $(by)`,
-        { date, datatype, by }
-    );
-}

package/src/database/models.mts

@@ -1,7 +0,0 @@
-export interface Countable {
-    count: number;
-}
-
-export interface Identifiable<T> {
-    id: T;
-}

package/src/index.mts

@@ -1,2 +0,0 @@
-export { DigitrafficStack } from "./aws/infra/stack/stack.mjs";
-

package/src/marine/id_utils.mts

@@ -1,30 +0,0 @@
-export function isValidIMO(imo: number): boolean {
-    return imo >= 1000000 && imo <= 9999999 && imoChecksumIsValid(imo);
-}
-
-function imoChecksumIsValid(imo: number): boolean {
-    const imoStr = imo.toString();
-    const imoDigit1 = Number(imoStr[0]);
-    const imoDigit2 = Number(imoStr[1]);
-    const imoDigit3 = Number(imoStr[2]);
-    const imoDigit4 = Number(imoStr[3]);
-    const imoDigit5 = Number(imoStr[4]);
-    const imoDigit6 = Number(imoStr[5]);
-    const checkDigit = Number(imoStr[6]);
-    const checkCalculation = Number(((imoDigit1 * 7) + (imoDigit2 * 6) + (imoDigit3 * 5) + (imoDigit4 * 4) + (imoDigit5 * 3) + (imoDigit6 * 2)));
-    const checkResult = checkCalculation % 10 === checkDigit;
-    if (!checkResult) {
-        console.warn('method=imoChecksumIsValid IMO checksum failed %d', imo);
-    }
-    return checkResult;
-}
-
-export function isValidMMSI(mmsi: number): boolean {
-    return mmsi >= 100000000 && mmsi <= 999999999;
-}
-
-const LocodePattern = /^FI[A-Z]{3}$/i;
-
-export function isValidLOCODE(locode: string): boolean {
-    return LocodePattern.test(locode);
-}

package/src/marine/rtz.mts

@@ -1,57 +0,0 @@
-export interface RtzPositionCoordinate {
-    readonly $: {
-        readonly lat: number;
-        readonly lon: number;
-    };
-}
-
-export interface RtzWaypointPosition {
-    readonly position: RtzPositionCoordinate[];
-}
-
-export interface RtzWaypoint {
-    readonly waypoint: RtzWaypointPosition[];
-}
-
-export interface RtzScheduleElement {
-    readonly $: {
-        /**
-         * Date
-         */
-        readonly etd?: string;
-        /**
-         * Date
-         */
-        readonly eta?: string;
-    };
-}
-
-export interface RtzSchedule {
-    readonly scheduleElement: RtzScheduleElement[];
-}
-
-export interface RtzScheduleWrapper {
-    readonly manual?: RtzSchedule[];
-    readonly calculated?: RtzSchedule[];
-}
-
-export interface RtzSchedules {
-    readonly schedule: RtzScheduleWrapper[];
-}
-
-export interface RtzRouteInfo {
-    readonly $: {
-        readonly vesselMMSI: string;
-        readonly vesselIMO: string;
-    };
-}
-
-export interface RtzRoute {
-    readonly routeInfo: RtzRouteInfo[];
-    readonly waypoints: RtzWaypoint[];
-    readonly schedules: RtzSchedules[];
-}
-
-export interface RtzVoyagePlan {
-    readonly route: RtzRoute;
-}

package/src/test/asserter.mts

@@ -1,58 +0,0 @@
-/**
- * A simple asserter-class for writing canaries without dependency to testing-libraries.
- */
-
-type AssertedValue = string | number;
-
-export abstract class Asserter {
-    static assertEquals(value: AssertedValue, expected: AssertedValue) {
-        if (value != expected) {
-            throw new Error(
-                `Given value ${value} was not expected ${expected}`
-            );
-        }
-    }
-
-    static assertTrue(value: boolean) {
-        if (!value) {
-            throw new Error(`Given value was not true`);
-        }
-    }
-
-    static assertLength<T>(data: T[] | undefined, expected: number) {
-        if (!data) {
-            throw new Error("Given array was not defined");
-        }
-
-        if (data.length != expected) {
-            throw new Error(
-                `Given array length ${data.length} was not expected ${expected}`
-            );
-        }
-    }
-
-    static assertLengthGreaterThan<T>(data: T[] | undefined, expected: number) {
-        if (!data) {
-            throw new Error("Given array was not defined");
-        }
-
-        if (data.length <= expected) {
-            throw new Error(
-                `Given array length ${data.length} was not greater than ${expected}`
-            );
-        }
-    }
-
-    static assertGreaterThan(value: number, expected: number) {
-        if (value <= expected) {
-            throw new Error(
-                `Value ${value} was expected to be greater than ${expected}`
-            );
-        }
-    }
-
-    static assertToBeCloseTo(value: number, expected: number, delta: number) {
-        expect(expected - value).toBeGreaterThanOrEqual(-1 * delta);
-        expect(expected - value).toBeLessThanOrEqual(delta);
-    }
-}

package/src/test/db-testutils.mts

@@ -1,52 +0,0 @@
-import {
-    DatabaseEnvironmentKeys,
-    DTDatabase,
-    initDbConnection,
-} from "../database/database.mjs";
-import { Countable } from "../database/models.mjs";
-
-export async function assertCount(db: DTDatabase, sql: string, count: number) {
-    await db.one(sql).then((x: Countable) => expect(x.count).toEqual(count));
-}
-
-export function dbTestBase(
-    fn: (db: DTDatabase) => void,
-    truncateFn: (db: DTDatabase) => Promise<void>,
-    dbUser: string,
-    dbPass: string,
-    dbUri: string
-): () => void {
-    const theDbUri = process.env.DB_URI ?? dbUri;
-    console.log(`Test database URI: ${theDbUri}`);
-
-    return () => {
-        const db: DTDatabase = initDbConnection(
-            dbUser,
-            dbPass,
-            "test",
-            theDbUri,
-            {
-                noWarnings: true, // ignore duplicate connection warning for tests
-            }
-        );
-
-        beforeAll(async () => {
-            process.env[DatabaseEnvironmentKeys.DB_USER] = dbUser;
-            process.env[DatabaseEnvironmentKeys.DB_PASS] = dbPass;
-            process.env[DatabaseEnvironmentKeys.DB_URI] = theDbUri;
-            process.env[DatabaseEnvironmentKeys.DB_RO_URI] = theDbUri;
-            await truncateFn(db);
-        });
-
-        afterAll(async () => {
-            await truncateFn(db);
-            await db.$pool.end();
-        });
-
-        beforeEach(async () => {
-            await truncateFn(db);
-        });
-
-        fn(db);
-    };
-}