@digitraffic/common 2024.1.24-3 → 2024.3.11-1

package/dist/utils/geojson-types.mjs

@@ -1,12 +1,14 @@
 export class GeoJsonPoint {
+    type = "Point";
+    coordinates;
     constructor(coordinates) {
-        this.type = "Point";
         this.coordinates = coordinates;
     }
 }
 export class GeoJsonLineString {
+    type = "LineString";
+    coordinates;
     constructor(coordinates) {
-        this.type = "LineString";
         this.coordinates = coordinates;
     }
 }

package/dist/utils/geometry.d.mts

@@ -1,7 +1,7 @@
 /**
  * GeoJSON functions and tools
  */
-import { Feature, FeatureCollection, Geometry, Position } from "geojson";
+import type { Feature, FeatureCollection, Geometry, Position } from "geojson";
 export declare const SRID_WGS84 = 4326;
 /**
  * Creates WKT geometry from GeoJSON geometry

package/dist/utils/geometry.mjs

@@ -87,6 +87,9 @@ function distanceBetweenWGS84PointsInKm(fromXLon, fromYLat, toXLon, toYLat) {
  * @param pos2
  */
 export function distanceBetweenPositionsInKm(pos1, pos2) {
+    if (pos1.length !== 2 && pos2.length !== 2) {
+        throw Error(`Positions ${pos1.toString()} and ${pos2.toString()} both must be arrays of length two`);
+    }
     return distanceBetweenWGS84PointsInKm(pos1[0], pos1[1], pos2[0], pos2[1]);
 }
 export function areDistinctPositions(previous, next) {

package/dist/utils/logging.mjs

@@ -1,4 +1,3 @@
-import { AxiosError } from "axios";
 import { DtLogger } from "../aws/runtime/dt-logger.mjs";
 import { getEnvVariableOrElse } from "./utils.mjs";
 const functionName = getEnvVariableOrElse("AWS_LAMBDA_FUNCTION_NAME", "test");
@@ -49,7 +48,8 @@ export function logException(logger, error, includeStack = false) {
             ? error
             : JSON.stringify(error);
     const stack = error instanceof Error && includeStack ? error.stack : undefined;
-    const customCode = error instanceof AxiosError ? error.code : undefined;
+    // In case error is AxiosError, log the custom code property.
+    const customCode = error["code"];
     logger.error({
         type: "Error",
         method: `${functionName}.logException`,

package/dist/utils/retry.d.mts

@@ -9,7 +9,7 @@ export type RetryPredicate = (error: unknown) => boolean;
  * Utility timeout functions for "retry" function.
  */
 export declare const timeoutFunctions: {
-    noTimeout: (retryCount: number) => number;
+    noTimeout: (_: number) => number;
     exponentialTimeout: (retryCount: number) => number;
 };
 /**
@@ -17,7 +17,7 @@ export declare const timeoutFunctions: {
  */
 export declare const retryPredicates: {
     retryBasedOnStatusCode: (error: unknown) => boolean;
-    alwaysRetry: (error: unknown) => boolean;
+    alwaysRetry: (_: unknown) => boolean;
 };
 export declare let retryCount: number;
 /**

package/dist/utils/retry.mjs

@@ -13,7 +13,7 @@ export var RetryLogError;
 export const timeoutFunctions = (function () {
     return {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        noTimeout: (retryCount) => {
+        noTimeout: (_) => {
             return 0;
         },
         exponentialTimeout: (retryCount) => {
@@ -39,7 +39,7 @@ export const retryPredicates = (function () {
             return false;
         },
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        alwaysRetry: (error) => {
+        alwaysRetry: (_) => {
             return true;
         },
     };

package/dist/utils/slack.mjs

@@ -1,7 +1,8 @@
-import axios from "axios";
+import ky from "ky";
 import { logger } from "../aws/runtime/dt-logger-default.mjs";
 import { logException } from "./logging.mjs";
 export class SlackApi {
+    url;
     constructor(url) {
         this.url = url;
     }
@@ -11,8 +12,8 @@ export class SlackApi {
                 method: "SlackApi.notify",
                 message: "Sending slack notification",
             });
-            await axios.post(this.url, {
-                text,
+            await ky.post(this.url, {
+                body: text
             });
         }
         catch (error) {

package/dist/utils/utils.d.mts

@@ -1,5 +1,5 @@
-import { AwsEnv } from "../types/aws-env.mjs";
-import { Either } from "../types/either.mjs";
+import type { AwsEnv } from "../types/aws-env.mjs";
+import type { Either } from "../types/either.mjs";
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2024.1.24-3",
+  "version": "2024.3.11-1",
   "description": "",
   "type": "module",
   "repository": {
@@ -14,8 +14,7 @@
   "private": false,
   "files": [
     "dist/**/*.mjs",
-    "dist/**/*.d.mts",
-    "src/**/*.mts"
+    "dist/**/*.d.mts"
   ],
   "exports": {
     ".": "./dist/index.mjs",
@@ -39,6 +38,7 @@
     "./dist/test/httpserver": "./dist/test/httpserver.mjs",
     "./dist/test/secrets-manager": "./dist/test/secrets-manager.mjs",
     "./dist/test/asserter": "./dist/test/asserter.mjs",
+    "./dist/test/mock-ky": "./dist/test/mock-ky.mjs",
     "./dist/marine/rtz": "./dist/marine/rtz.mjs",
     "./dist/marine/id_utils": "./dist/marine/id_utils.mjs",
     "./dist/index": "./dist/index.mjs",
@@ -104,23 +104,37 @@
     "./dist/aws/runtime/digitraffic-integration-response": "./dist/aws/runtime/digitraffic-integration-response.mjs"
   },
   "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.496.0",
+    "@aws-sdk/lib-storage": "^3.496.0",
+    "@aws-sdk/client-secrets-manager": "^3.496.0",
+    "@aws-sdk/client-api-gateway": "^3.496.0",
+    "@aws-sdk/client-sns": "^3.496.0",
     "@types/geojson": "^7946.0.12",
-    "aws-cdk-lib": "^2.103.0",
-    "aws-sdk": "^2.1481.0",
-    "axios": "^1.6.2",
+    "aws-cdk-lib": "^2.132.0",
     "change-case": "5.0.0",
     "constructs": "^10.3.0",
     "date-fns": "~2.30.0",
     "date-fns-tz": "~2.0.0",
     "etag": "^1.8.1",
     "geojson-validation": "^1.0.2",
+    "ky": "^1.2.0",
     "lodash": "~4.17.21",
     "node-ttl": "^0.2.0",
     "pg-native": "^3.0.1",
     "pg-promise": "^11.5.4"
   },
   "devDependencies": {
+    "@aws-sdk/client-s3": "3.496.0",
+    "@aws-sdk/lib-storage": "3.496.0",
+    "@aws-sdk/client-secrets-manager": "3.496.0",
+    "@aws-sdk/client-api-gateway": "3.496.0",
+    "@aws-sdk/client-sns": "3.496.0",
     "@jest/globals": "^29.7.0",
+    "@rushstack/eslint-config": "^3.6.2",
+    "@rushstack/heft": "^0.64.3",
+    "@rushstack/heft-jest-plugin": "^0.11.3",
+    "@rushstack/heft-lint-plugin": "^0.3.3",
+    "@rushstack/heft-typescript-plugin": "^0.3.3",
     "@types/aws-lambda": "8.10.131",
     "@types/etag": "1.8.3",
     "@types/geojson": "7946.0.13",
@@ -130,10 +144,8 @@
     "@types/node": "20.10.7",
     "@types/sinon": "17.0.2",
     "@typescript-eslint/eslint-plugin": "~6.18.1",
-    "@typescript-eslint/parser": "^6.19.1",
-    "aws-cdk-lib": "~2.118.0",
-    "aws-sdk": "~2.1531.0",
-    "axios": "^1.6.5",
+    "@typescript-eslint/parser": "^6.20.0",
+    "aws-cdk-lib": "~2.132.0",
     "change-case": "5.3.0",
     "constructs": "10.3.0",
     "date-fns": "~2.30.0",
@@ -145,6 +157,7 @@
     "geojson-validation": "^1.0.2",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
+    "ky": "^1.2.0",
     "lodash": "~4.17.21",
     "node-ttl": "^0.2.0",
     "pg-promise": "^11.5.4",
@@ -155,10 +168,6 @@
     "typescript": "~5.3.3",
     "velocityjs": "2.0.6"
   },
-  "dependencies": {
-    "@aws-sdk/client-s3": "~3.472.0",
-    "@aws-sdk/lib-storage": "~3.472.0"
-  },
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc --watch",
@@ -166,7 +175,8 @@
     "eslint-report": "eslint . --format html",
     "ci:eslint-report": "eslint . --format html -o report.html || true",
     "clean": "rimraf dist output",
-    "test": "node --experimental-vm-modules --max-old-space-size=1536 --expose-gc ./node_modules/jest/bin/jest.js --detectOpenHandles --forceExit --coverage --coverageDirectory=output/coverage/jest --logHeapUsage --runInBand",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' heft test --clean --max-workers=1",
+    "test:jest": "node --trace-warnings --experimental-vm-modules --max-old-space-size=1536 --expose-gc ./node_modules/jest/bin/jest.js --detectOpenHandles --forceExit --coverage --coverageDirectory=output/coverage/jest --logHeapUsage --runInBand --verbose",
     "test:inspect": "node --inspect-brk --expose-gc ./node_modules/jest/bin/jest.js --detectOpenHandles --forceExit --coverage --coverageDirectory=output/coverage/jest --logHeapUsage --runInBand",
     "test:watch": "jest --detectOpenHandles --forceExit --coverage --coverageDirectory=output/coverage/jest --watch"
   }

package/src/@types/geojson-validation/index.d.mts

@@ -1,4 +0,0 @@
-declare module "geojson-validation" {
-    export function valid(json): boolean;
-    export function isFeatureCollection(json): boolean;
-}

package/src/aws/infra/api/handler-factory.mts

@@ -1,86 +0,0 @@
-import { getEnvVariableOrElse } from "../../../utils/utils.mjs";
-import { DtLogger } from "../../runtime/dt-logger.mjs";
-import { LambdaResponse } from "../../types/lambda-response.mjs";
-
-export type LoggingHandler = (
-    method: () => Promise<LambdaResponse>,
-    logger: DtLogger
-) => Promise<LambdaResponse>;
-
-export type ErrorHandler = (error: unknown, logger: DtLogger) => LambdaResponse;
-
-const functionName = getEnvVariableOrElse("AWS_LAMBDA_FUNCTION_NAME", "test");
-
-/**
- * Factory class for creating lambda-handler functions.  You can set functionality to handle logging and error-handling,
- * with the defaults:
- * * No error handling
- * * Execution time logging
- *
- * You should instantiate HandlerFactory in your project with desired error handling and use the factory instance for
- * creating handler-functions for your lambdas.
- */
-export class HandlerFactory {
-    private loggingHandler: LoggingHandler;
-    private errorHandler: ErrorHandler;
-
-    constructor() {
-        this.loggingHandler = async (method: () => Promise<LambdaResponse>) => {
-            const start = Date.now();
-
-            try {
-                return await method();
-            } finally {
-                console.info(
-                    "method=%s.handler tookMs=%d",
-                    functionName,
-                    Date.now() - start
-                );
-            }
-        };
-
-        this.errorHandler = (error: unknown) => {
-            throw error;
-        };
-    }
-
-    withLoggingHandler(loggingHandler: LoggingHandler) {
-        this.loggingHandler = loggingHandler;
-        return this;
-    }
-
-    withErrorHandler(errorHandler: ErrorHandler) {
-        this.errorHandler = errorHandler;
-        return this;
-    }
-
-    createEventHandler(
-        handler: (event: unknown) => Promise<LambdaResponse>,
-        logger: DtLogger
-    ) {
-        return async (event: unknown) => {
-            return await this.loggingHandler(async () => {
-                try {
-                    return await handler(event);
-                } catch (error) {
-                    return this.errorHandler(error, logger);
-                }
-            }, logger);
-        };
-    }
-}
-
-export function createJsonLoggingHandler(): LoggingHandler {
-    return async (method: () => Promise<LambdaResponse>, logger: DtLogger) => {
-        const start = Date.now();
-
-        try {
-            return await method();
-        } finally {
-            logger.info({
-                method: `${functionName}.handler`,
-                tookMs: Date.now() - start,
-            });
-        }
-    };
-}

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

@@ -1,147 +0,0 @@
-import {
-    IntegrationResponse,
-    LambdaIntegration,
-    PassthroughBehavior,
-} from "aws-cdk-lib/aws-apigateway";
-import { IFunction } from "aws-cdk-lib/aws-lambda";
-import { MediaType } from "../../types/mediatypes.mjs";
-import { DigitrafficIntegrationResponse } from "../../runtime/digitraffic-integration-response.mjs";
-
-type ParameterType =
-    | "path"
-    | "querystring"
-    | "multivaluequerystring"
-    | "context"
-    | "header";
-
-interface ApiParameter {
-    type: ParameterType;
-    name: string;
-}
-
-export class DigitrafficIntegration<T extends string> {
-    readonly lambda: IFunction;
-    readonly mediaType: MediaType;
-    readonly parameters: ApiParameter[] = [];
-    readonly sunset?: string;
-
-    constructor(
-        lambda: IFunction,
-        mediaType = MediaType.TEXT_PLAIN,
-        sunset?: string
-    ) {
-        this.lambda = lambda;
-        this.mediaType = mediaType;
-        this.sunset = sunset;
-    }
-
-    addPathParameter(...names: T[]): this {
-        names.forEach((name) => this.parameters.push({ type: "path", name }));
-
-        return this;
-    }
-
-    addQueryParameter(...names: T[]): this {
-        names.forEach((name) =>
-            this.parameters.push({ type: "querystring", name })
-        );
-        return this;
-    }
-
-    addMultiValueQueryParameter(...names: T[]): this {
-        names.forEach((name) =>
-            this.parameters.push({ type: "multivaluequerystring", name })
-        );
-        return this;
-    }
-
-    /**
-     * Note that context parameter values needs to be in json format as they will be parsed in template as json.
-     * See createRequestTemplates below.
-     * @param names for the parameters
-     * @returns
-     */
-    addContextParameter(...names: T[]): this {
-        names.forEach((name) =>
-            this.parameters.push({ type: "context", name })
-        );
-
-        return this;
-    }
-
-    /**
-     * Do not use Authorization header as that will be consumed by ApiGW.
-     * If Authorization header is needed, use lambda authorizers.
-     * @param names for the headers
-     */
-    addHeaderParameter(...names: T[]): this {
-        names.forEach((name) => this.parameters.push({ type: "header", name }));
-
-        return this;
-    }
-
-    build(): LambdaIntegration {
-        const integrationResponses = this.createResponses();
-
-        return new LambdaIntegration(this.lambda, {
-            proxy: false,
-            integrationResponses,
-            requestParameters:
-                this.parameters.length == 0
-                    ? undefined
-                    : this.createRequestParameters(),
-            requestTemplates:
-                this.parameters.length == 0
-                    ? undefined
-                    : this.createRequestTemplates(),
-            passthroughBehavior: PassthroughBehavior.WHEN_NO_MATCH,
-        });
-    }
-
-    createRequestParameters(): Record<string, string> {
-        const requestParameters: Record<string, string> = {};
-
-        // filter out context parameters
-        this.parameters
-            .filter((parameter) => parameter.type !== "context")
-            .forEach((parameter: ApiParameter) => {
-                requestParameters[
-                    `integration.request.${parameter.type.replace(
-                        "multivaluequerystring",
-                        "querystring"
-                    )}.${parameter.name}`
-                ] = `method.request.${parameter.type}.${parameter.name}`;
-            });
-
-        return requestParameters;
-    }
-
-    createRequestTemplates(): Record<string, string> {
-        const requestJson: Record<string, string> = {};
-
-        this.parameters.forEach((parameter: ApiParameter) => {
-            if (parameter.type === "context") {
-                requestJson[
-                    parameter.name
-                ] = `$util.parseJson($context.${parameter.name})`;
-            } else if (parameter.type === "multivaluequerystring") {
-                // make multivaluequerystring values to array
-                requestJson[
-                    parameter.name
-                ] = `[#foreach($val in $method.request.multivaluequerystring.get('${parameter.name}'))"$util.escapeJavaScript($val)"#if($foreach.hasNext),#end#end]`;
-            } else {
-                requestJson[
-                    parameter.name
-                ] = `$util.escapeJavaScript($input.params('${parameter.name}'))`;
-            }
-        });
-
-        return {
-            [MediaType.APPLICATION_JSON]: JSON.stringify(requestJson),
-        };
-    }
-
-    createResponses(): IntegrationResponse[] {
-        return [DigitrafficIntegrationResponse.ok(this.mediaType, this.sunset)];
-    }
-}

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

@@ -1,165 +0,0 @@
-import { MediaType } from "../../types/mediatypes.mjs";
-import {
-    JsonSchema,
-    JsonSchemaType,
-    JsonSchemaVersion,
-    MethodResponse,
-    Model,
-  type IModel
-} from "aws-cdk-lib/aws-apigateway";
-import { dateFromIsoString } from "../../../utils/date-utils.mjs";
-
-/**
- * This is velocity-script, that assumes the response to be LambdaResponse(status and body).
- * It will always return the body and status, but if status in something else than 200 OK the content-type
- * will be overridden to text/plain. (it's assumed, that lambda will return error text).
- *
- * Body content must be base64-encoded! use LambdaResponse for this! This way you can also return
- * 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('$'))
-#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.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))
-#end
-$util.base64Decode($inputRoot.body)`;
-
-/**
- * Use this for deprecated integrations.
- * Will add HTTP headers Deprecation and Sunset to response.
- * Example:
- *  Deprecation: true
- *  Sunset: Tue, 20 Dec 2022 00:00:00 GMT
- * @param sunset Sunset date as string in ISO 8601 date-time format (YYYY-MM-DD)
- */
-
-export const getDeprecatedDefaultLambdaResponse = (sunset: string) => {
-    const setDeprecationHeaders = `#set ($context.responseOverride.header.Deprecation = 'true')
-#set ($context.responseOverride.header.Sunset = '${dateFromIsoString(
-        sunset
-    ).toUTCString()}')`;
-    return RESPONSE_DEFAULT_LAMBDA.concat(setDeprecationHeaders);
-};
-
-const BODY_FROM_INPUT_PATH = "$input.path('$').body";
-
-/// @deprecated
-const messageSchema: JsonSchema = {
-    schema: JsonSchemaVersion.DRAFT4,
-    type: JsonSchemaType.OBJECT,
-    description: "Response with message",
-    properties: {
-        message: {
-            type: JsonSchemaType.STRING,
-            description: "Response message",
-        },
-    },
-};
-
-/// @deprecated
-export const MessageModel = {
-    contentType: MediaType.APPLICATION_JSON,
-    modelName: "MessageResponseModel",
-    schema: messageSchema,
-};
-
-const NotFoundMessage = "Not found";
-export const NotFoundResponse = JSON.stringify({ message: NotFoundMessage });
-
-const InternalServerErrorMessage = "Error";
-const InternalServerErrorResponse = JSON.stringify({
-    message: InternalServerErrorMessage,
-});
-
-const BadRequestMessage = "Bad request";
-const BadRequestResponse = JSON.stringify({ message: BadRequestMessage });
-
-/// @deprecated
-export const BadRequestResponseTemplate = {
-    [MediaType.APPLICATION_JSON]: BadRequestResponse,
-};
-/// @deprecated
-export const NotFoundResponseTemplate = {
-    [MediaType.APPLICATION_JSON]: NotFoundResponse,
-};
-/// @deprecated
-export const XmlResponseTemplate = {
-    [MediaType.APPLICATION_XML]: BODY_FROM_INPUT_PATH,
-};
-/// @deprecated
-export const InternalServerErrorResponseTemplate = {
-    [MediaType.APPLICATION_JSON]: InternalServerErrorResponse,
-};
-
-export class DigitrafficMethodResponse {
-    static response(
-        statusCode: string,
-        model: IModel,
-        mediaType: MediaType,
-        disableCors = false,
-        deprecation = false
-    ): MethodResponse {
-        return {
-            statusCode,
-            responseModels: {
-                [mediaType]: model,
-            },
-            responseParameters: {
-                ...(!disableCors && {
-                    "method.response.header.Access-Control-Allow-Origin": true,
-                }),
-                ...(deprecation && {
-                    "method.response.header.Deprecation": true,
-                    "method.response.header.Sunset": true,
-                }),
-            },
-        };
-    }
-
-    static response200(model: IModel, mediaType = MediaType.APPLICATION_JSON) {
-        return DigitrafficMethodResponse.response(
-            "200",
-            model,
-            mediaType,
-            false
-        );
-    }
-
-    static response500(
-        model = Model.EMPTY_MODEL,
-        mediaType = MediaType.APPLICATION_JSON
-    ) {
-        return DigitrafficMethodResponse.response(
-            "500",
-            model,
-            mediaType,
-            false
-        );
-    }
-
-    static response400(
-        model = Model.EMPTY_MODEL,
-        mediaType = MediaType.APPLICATION_JSON
-    ) {
-        return DigitrafficMethodResponse.response(
-            "400",
-            model,
-            mediaType,
-            false
-        );
-    }
-}