@digitraffic/common 2024.8.16-1 → 2024.8.30-1

package/dist/types/openapi-schema.js

@@ -0,0 +1,134 @@
+import { z } from "zod";
+export const serverObject = z.object({
+    url: z.string(),
+    description: z.string().optional(),
+    variables: z.record(z.unknown()).optional(),
+});
+export const parameterObject = z.object({
+    name: z.string(),
+    in: z.enum(["query", "header", "path", "cookie"]),
+    description: z.string().optional(),
+    required: z.boolean().optional(),
+    deprecated: z.boolean().optional(),
+    allowEmptyValue: z.boolean().optional(),
+    style: z
+        .enum(["matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject"])
+        .optional(),
+    explode: z.string().optional(),
+    allowReserved: z.boolean().optional(),
+    schema: z.unknown().optional(),
+    example: z.unknown().optional(),
+    examples: z.record(z.unknown()).optional(),
+    content: z.record(z.unknown()).optional(),
+});
+export const referenceObject = z.object({
+    $ref: z.string(),
+    summary: z.string().optional(),
+    description: z.string().optional(),
+});
+export const openapiOperation = z
+    .object({
+    tags: z.array(z.string()),
+    summary: z.string(),
+    description: z.string(),
+    externalDocs: z.unknown(),
+    operationId: z.string(),
+    parameters: z.array(parameterObject.or(referenceObject)),
+    requestBody: z.unknown(),
+    responses: z.unknown(),
+    callbacks: z.unknown(),
+    deprecated: z.boolean(),
+    security: z.array(z.record(z.array(z.string()))),
+    servers: z.array(z.unknown()),
+})
+    .partial();
+// Path items have some fixed fields but also allow for extended fields starting with "x-".
+//export const openapiPathItem = z.record(openapiOperation.or(serverObject).or(parameterObject));
+export const openapiPathItem = z
+    .object({
+    summary: z.string(),
+    description: z.string(),
+    get: openapiOperation,
+    put: openapiOperation,
+    post: openapiOperation,
+    delete: openapiOperation,
+    options: openapiOperation,
+    head: openapiOperation,
+    patch: openapiOperation,
+    trace: openapiOperation,
+    servers: serverObject,
+    parameters: z.array(parameterObject),
+})
+    .partial();
+export const openapiSchema = z
+    .object({
+    openapi: z.string().regex(new RegExp("^3\\.0\\.\\d(-.+)?$")),
+    info: z
+        .object({
+        title: z.string(),
+        description: z.string().optional(),
+        termsOfService: z.string().optional(),
+        contact: z
+            .object({
+            name: z.string().optional(),
+            url: z.string().optional(),
+            email: z.string().email().optional(),
+        })
+            .strict()
+            .optional(),
+        license: z.object({ name: z.string(), url: z.string().optional() }).strict().optional(),
+        version: z.string(),
+    })
+        .strict(),
+    externalDocs: z.object({ description: z.string().optional(), url: z.string() }).strict().optional(),
+    servers: z
+        .array(z
+        .object({
+        url: z.string(),
+        description: z.string().optional(),
+        variables: z
+            .record(z
+            .object({
+            enum: z.array(z.string()).optional(),
+            default: z.string(),
+            description: z.string().optional(),
+        })
+            .strict())
+            .optional(),
+    })
+        .strict())
+        .optional(),
+    security: z.array(z.record(z.array(z.string()))).optional(),
+    tags: z
+        .array(z
+        .object({
+        name: z.string(),
+        description: z.string().optional(),
+        externalDocs: z
+            .object({
+            description: z.string().optional(),
+            url: z.string(),
+        })
+            .strict()
+            .optional(),
+    })
+        .strict())
+        .optional(),
+    paths: z.record(openapiPathItem),
+    components: z
+        .object({
+        schemas: z.record(z.any()).optional(),
+        responses: z.record(z.any()).optional(),
+        parameters: z.record(z.any()).optional(),
+        examples: z.record(z.any()).optional(),
+        requestBodies: z.record(z.any()).optional(),
+        headers: z.record(z.any()).optional(),
+        securitySchemes: z.record(z.any()).optional(),
+        links: z.record(z.any()).optional(),
+        callbacks: z.record(z.any()).optional(),
+    })
+        .strict()
+        .optional(),
+})
+    .describe("The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3");
+//# sourceMappingURL=openapi-schema.js.map

package/dist/types/{traffictype.mjs → traffictype.js}

@@ -7,4 +7,4 @@ export var TrafficType;
     TrafficType["MCP"] = "MCP";
     TrafficType["OTHER"] = "Other";
 })(TrafficType || (TrafficType = {}));
-//# sourceMappingURL=traffictype.mjs.map
+//# sourceMappingURL=traffictype.js.map

package/dist/types/urn.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=urn.js.map

package/dist/types/util-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=util-types.js.map

package/dist/types/{validator.mjs → validator.js}

@@ -6,4 +6,4 @@ export function validateYear(year, minYear = MIN_YEAR, maxYear = MAX_YEAR) {
 export function validateMonth(month) {
     return month > 0 && month < 13;
 }
-//# sourceMappingURL=validator.mjs.map
+//# sourceMappingURL=validator.js.map

package/dist/utils/{api-model.d.mts → api-model.d.ts}

@@ -1,12 +1,13 @@
-import { RestApi, Model, type JsonSchema, RequestValidator, JsonSchemaType, JsonSchemaVersion } from 'aws-cdk-lib/aws-apigateway';
-import type { ModelWithReference } from "../aws/types/model-with-reference.mjs";
+import { type JsonSchema, JsonSchemaType, JsonSchemaVersion, type Model, type RequestValidator, type RestApi } from "aws-cdk-lib/aws-apigateway";
+import type { ModelWithReference } from "../aws/types/model-with-reference.js";
+type ModelReferenceUrl = `https://apigateway.amazonaws.com/restapis/${string}/models/${string}`;
 /**
  * Get a reference to an OpenAPI model object in a REST API.
  * Can be used to supply a reference to properties of a GeoJSON feature.
  * @param modelId Id of the referenced object
  * @param restApiId Id of the REST API
  */
-export declare function getModelReference(modelId: string, restApiId: string): string;
+export declare function getModelReference(modelId: string, restApiId: string): ModelReferenceUrl;
 /**
  * Adds a request validator to a REST API to enforce request parameters/body requirements.
  * https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
@@ -29,7 +30,7 @@ export declare function addServiceModel(modelName: string, api: RestApi, schema:
  * @param api
  * @param contentType
  */
-export declare function addSimpleServiceModel(modelName: string, api: RestApi, contentType?: string): Model;
+export declare function addSimpleServiceModel(modelName: string, api: RestApi, contentType?: `${string}/${string}`): Model;
 /**
  * Adds a JSON Schema model to an API Gateway API. Can be used later to generate OpenAPI specifications.
  * This method adds a schema for _an array._
@@ -62,7 +63,6 @@ export declare function featureSchema(modelReference: string): {
     };
 };
 /**
- *
  * Creates a JSON Schema for a GeoJSON Feature Collection. Can be used to generate OpenAPI descriptions.
  * @param modelReference Reference to a model object, in this case Features.
  */
@@ -85,3 +85,4 @@ export declare function geojsonSchema(modelReference: string): {
         };
     };
 };
+export {};

package/dist/utils/{api-model.mjs → api-model.js}

@@ -1,4 +1,4 @@
-import { RestApi, Model, RequestValidator, JsonSchemaType, JsonSchemaVersion, } from 'aws-cdk-lib/aws-apigateway';
+import { JsonSchemaType, JsonSchemaVersion, } from "aws-cdk-lib/aws-apigateway";
 /**
  * Get a reference to an OpenAPI model object in a REST API.
  * Can be used to supply a reference to properties of a GeoJSON feature.
@@ -14,7 +14,7 @@ export function getModelReference(modelId, restApiId) {
  * @param api REST API
  */
 export function addDefaultValidator(api) {
-    return api.addRequestValidator('DefaultValidator', {
+    return api.addRequestValidator("DefaultValidator", {
         validateRequestParameters: true,
         validateRequestBody: true,
     });
@@ -29,7 +29,7 @@ export function addDefaultValidator(api) {
  */
 export function addServiceModel(modelName, api, schema) {
     const mwr = api.addModel(modelName, {
-        contentType: 'application/json',
+        contentType: "application/json",
         modelName,
         schema,
     });
@@ -43,7 +43,7 @@ export function addServiceModel(modelName, api, schema) {
  * @param api
  * @param contentType
  */
-export function addSimpleServiceModel(modelName, api, contentType = 'application/xml') {
+export function addSimpleServiceModel(modelName, api, contentType = "application/xml") {
     return api.addModel(modelName, {
         contentType,
         modelName,
@@ -72,26 +72,25 @@ export function featureSchema(modelReference) {
     return {
         schema: JsonSchemaVersion.DRAFT4,
         type: JsonSchemaType.OBJECT,
-        description: 'GeoJson Feature',
-        required: ['type', 'properties', 'geometry'],
+        description: "GeoJson Feature",
+        required: ["type", "properties", "geometry"],
         properties: {
             type: {
                 type: JsonSchemaType.STRING,
-                description: 'Feature',
-                enum: ['Feature'],
+                description: "Feature",
+                enum: ["Feature"],
             },
             properties: {
                 ref: modelReference,
             },
             geometry: {
                 type: JsonSchemaType.OBJECT,
-                description: 'GeoJSON geometry',
+                description: "GeoJSON geometry",
             },
         },
     };
 }
 /**
- *
  * Creates a JSON Schema for a GeoJSON Feature Collection. Can be used to generate OpenAPI descriptions.
  * @param modelReference Reference to a model object, in this case Features.
  */
@@ -99,13 +98,13 @@ export function geojsonSchema(modelReference) {
     return {
         schema: JsonSchemaVersion.DRAFT4,
         type: JsonSchemaType.OBJECT,
-        description: 'GeoJson FeatureCollection',
-        required: ['type', 'features'],
+        description: "GeoJson FeatureCollection",
+        required: ["type", "features"],
         properties: {
             type: {
                 type: JsonSchemaType.STRING,
-                description: 'FeatureCollection',
-                enum: ['FeatureCollection'],
+                description: "FeatureCollection",
+                enum: ["FeatureCollection"],
             },
             features: {
                 type: JsonSchemaType.ARRAY,
@@ -116,4 +115,4 @@ export function geojsonSchema(modelReference) {
         },
     };
 }
-//# sourceMappingURL=api-model.mjs.map
+//# sourceMappingURL=api-model.js.map

package/dist/utils/{base64.mjs → base64.js}

@@ -3,7 +3,7 @@
  * @param str string
  */
 export function decodeBase64ToAscii(str) {
-    return decodeBase64(str, 'ascii');
+    return decodeBase64(str, "ascii");
 }
 /**
  * Decode given string from base64 to given encoding
@@ -11,6 +11,6 @@ export function decodeBase64ToAscii(str) {
  * @param encoding
  */
 export function decodeBase64(str, encoding) {
-    return Buffer.from(str, 'base64').toString(encoding);
+    return Buffer.from(str, "base64").toString(encoding);
 }
-//# sourceMappingURL=base64.mjs.map
+//# sourceMappingURL=base64.js.map

package/dist/utils/{date-utils.mjs → date-utils.js}

@@ -41,4 +41,4 @@ function isValidDate(d) {
 export function dateToUTCString(date, format) {
     return formatInTimeZone(date, UTC, format);
 }
-//# sourceMappingURL=date-utils.mjs.map
+//# sourceMappingURL=date-utils.js.map

package/dist/utils/{geojson-types.d.mts → geojson-types.d.ts}

@@ -3,12 +3,12 @@
  */
 import type { LineString, Point, Position } from "geojson";
 export declare class GeoJsonPoint implements Point {
-    readonly type = "Point";
+    readonly type: "Point";
     readonly coordinates: Position;
     constructor(coordinates: Position);
 }
 export declare class GeoJsonLineString implements LineString {
-    readonly type = "LineString";
+    readonly type: "LineString";
     readonly coordinates: Position[];
     constructor(coordinates: Position[]);
 }

package/dist/utils/{geojson-types.mjs → geojson-types.js}

@@ -12,4 +12,4 @@ export class GeoJsonLineString {
         this.coordinates = coordinates;
     }
 }
-//# sourceMappingURL=geojson-types.mjs.map
+//# sourceMappingURL=geojson-types.js.map

package/dist/utils/{geometry.d.mts → geometry.d.ts}

@@ -32,8 +32,9 @@ export declare function areDistinctPositions(previous: Position, next: Position)
  * @param pos2
  */
 export declare function distanceBetweenPositionsInM(pos1: Position, pos2: Position): number;
-export declare function createGmlLineString(geometry: Geometry, srsName?: string): {
-    srsName: string;
+export interface GmlLineString {
+    srsName: `${string}:${string}`;
     posList: string;
-};
+}
+export declare function createGmlLineString(geometry: Geometry, srsName?: `${string}:${string}`): GmlLineString;
 export declare function positionToList(position: Position, precision?: number): string;

package/dist/utils/{geometry.mjs → geometry.js}

@@ -1,5 +1,5 @@
 import * as geoJsonValidator from "geojson-validation";
-import { logger } from "../aws/runtime/dt-logger-default.mjs";
+import { logger } from "../aws/runtime/dt-logger-default.js";
 export const SRID_WGS84 = 4326;
 /**
  * Creates WKT geometry from GeoJSON geometry
@@ -47,6 +47,7 @@ function coordinatePair(coordinate) {
  * @param features List of Features
  * @param lastUpdated Last updated date
  */
+// eslint-disable-next-line @rushstack/no-new-null
 export function createFeatureCollection(features, lastUpdated) {
     return {
         type: "FeatureCollection",
@@ -94,10 +95,12 @@ function distanceBetweenWGS84PointsInKm(fromXLon, fromYLat, toXLon, toYLat) {
  * @param pos2 second position
  */
 export function distanceBetweenPositionsInKm(pos1, pos2) {
-    if (pos1.length < 2 || pos1.length > 3 || pos2.length < 2 || pos2.length > 3) {
+    const [pos10, pos11] = pos1;
+    const [pos20, pos21] = pos2;
+    if (pos1.length > 3 || pos2.length > 3 || !pos10 || !pos11 || !pos20 || !pos21) {
         throw Error(`Illegal Positions ${pos1.toString()} and ${pos2.toString()}. Both must have length between 2 or 3.`);
     }
-    return distanceBetweenWGS84PointsInKm(pos1[0], pos1[1], pos2[0], pos2[1]);
+    return distanceBetweenWGS84PointsInKm(pos10, pos11, pos20, pos21);
 }
 export function areDistinctPositions(previous, next) {
     return previous[0] !== next[0] || previous[1] !== next[1];
@@ -142,4 +145,4 @@ export function positionToList(position, precision = 8) {
 function toRadians(angdeg) {
     return angdeg * DEGREES_TO_RADIANS;
 }
-//# sourceMappingURL=geometry.mjs.map
+//# sourceMappingURL=geometry.js.map

package/dist/utils/{logging.d.mts → logging.d.ts}

@@ -1,4 +1,4 @@
-import { DtLogger } from "../aws/runtime/dt-logger.mjs";
+import { DtLogger } from "../aws/runtime/dt-logger.js";
 /**
  * Curried version of logException.
  *

package/dist/utils/{logging.mjs → logging.js}

@@ -1,5 +1,5 @@
-import { DtLogger } from "../aws/runtime/dt-logger.mjs";
-import { getEnvVariableOrElse } from "./utils.mjs";
+import { DtLogger } from "../aws/runtime/dt-logger.js";
+import { getEnvVariableOrElse } from "./utils.js";
 const functionName = getEnvVariableOrElse("AWS_LAMBDA_FUNCTION_NAME", "test");
 /**
  * Curried version of logException.
@@ -42,13 +42,10 @@ export function createExceptionLogger(logger = undefined, includeStack = false)
  * @see {@link createExceptionLogger} for a curried setup
  */
 export function logException(logger, error, includeStack = false) {
-    const message = error instanceof Error
-        ? error.message
-        : typeof error === "string"
-            ? error
-            : JSON.stringify(error);
+    const message = error instanceof Error ? error.message : typeof error === "string" ? error : JSON.stringify(error);
     const stack = error instanceof Error && includeStack ? error.stack : undefined;
     // In case error is AxiosError, log the custom code property.
+    // eslint-disable-next-line dot-notation
     const customCode = error["code"];
     logger.error({
         type: "Error",
@@ -58,4 +55,4 @@ export function logException(logger, error, includeStack = false) {
         stack,
     });
 }
-//# sourceMappingURL=logging.mjs.map
+//# sourceMappingURL=logging.js.map

package/dist/utils/{retry.mjs → retry.js}

@@ -1,6 +1,6 @@
-import { HttpError } from "../types/http-error.mjs";
-import { AsyncTimeoutError } from "../types/async-timeout-error.mjs";
-import { logger } from "../aws/runtime/dt-logger-default.mjs";
+import { HttpError } from "../types/http-error.js";
+import { AsyncTimeoutError } from "../types/async-timeout-error.js";
+import { logger } from "../aws/runtime/dt-logger-default.js";
 export var RetryLogError;
 (function (RetryLogError) {
     RetryLogError[RetryLogError["LOG_ALL_AS_ERRORS"] = 0] = "LOG_ALL_AS_ERRORS";
@@ -12,7 +12,6 @@ export var RetryLogError;
  */
 export const timeoutFunctions = (function () {
     return {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         noTimeout: (_) => {
             return 0;
         },
@@ -38,7 +37,6 @@ export const retryPredicates = (function () {
             }
             return false;
         },
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         alwaysRetry: (_) => {
             return true;
         },
@@ -62,10 +60,10 @@ async function retryRecursive(asyncFn, retries, retryCountInj, logError, timeout
     }
     try {
         // NOTE, a Promise cannot be cancelled. So if the asyncFn calls multiple async/await paris and the first one takes 31 minutes to complete,
-        // then the rest of async/await pairs will be called even though AysncTimeoutError is allready thrown.
+        // then the rest of async/await pairs will be called even though AsyncTimeoutError is already thrown.
         const result = await Promise.race([
             asyncFn(),
-            new Promise((_, reject) => setTimeout(() => reject(new AsyncTimeoutError()), asyncFnTimeout)),
+            new Promise((_resolve, reject) => setTimeout(() => reject(new AsyncTimeoutError()), asyncFnTimeout)),
         ]);
         return result;
     }
@@ -140,4 +138,4 @@ export async function retryRequest(request, ...args) {
     const asyncFn = wrapArgsToFn(request, ...args);
     return retry(asyncFn, 5, RetryLogError.LOG_LAST_RETRY_AS_ERROR_OTHERS_AS_WARNS, timeoutFunctions.exponentialTimeout, retryPredicates.retryBasedOnStatusCode);
 }
-//# sourceMappingURL=retry.mjs.map
+//# sourceMappingURL=retry.js.map

package/dist/utils/{slack.mjs → slack.js}

@@ -1,6 +1,6 @@
 import ky from "ky";
-import { logger } from "../aws/runtime/dt-logger-default.mjs";
-import { logException } from "./logging.mjs";
+import { logger } from "../aws/runtime/dt-logger-default.js";
+import { logException } from "./logging.js";
 export class SlackApi {
     url;
     constructor(url) {
@@ -21,4 +21,4 @@ export class SlackApi {
         }
     }
 }
-//# sourceMappingURL=slack.mjs.map
+//# sourceMappingURL=slack.js.map

package/dist/utils/{utils.d.mts → utils.d.ts}

@@ -1,5 +1,5 @@
-import type { AwsEnv } from "../types/aws-env.mjs";
-import type { Either } from "../types/either.mjs";
+import type { AwsEnv } from "../types/aws-env.js";
+import type { Either } from "../types/either.js";
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.
@@ -90,7 +90,6 @@ export declare function hasOwnPropertySafe(object: object, propertyName: string)
  */
 export declare function getErrorMessage(maybeError: unknown): string;
 /**
- *
  * @param value
  */
 export declare function isDefined<T>(value: T | undefined | null): value is T;

package/dist/utils/{utils.mjs → utils.js}

@@ -1,4 +1,4 @@
-import { EnvKeys } from "../aws/runtime/environment.mjs";
+import { EnvKeys } from "../aws/runtime/environment.js";
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.
@@ -20,7 +20,11 @@ import { EnvKeys } from "../aws/runtime/environment.mjs";
  * @param a first array to compare
  * @param b second array to compare
  */
-export function bothArraysHasSameValues(a, b) {
+export function bothArraysHasSameValues(
+// eslint-disable-next-line @rushstack/no-new-null
+a, 
+// eslint-disable-next-line @rushstack/no-new-null
+b) {
     if ((a && !b) || (!a && b)) {
         return false;
     }
@@ -47,7 +51,7 @@ export function getFirst(array, sortFunction) {
     return getFirstOrLast(true, array, sortFunction);
 }
 function getFirstOrLast(getFirst, array, sortFunction) {
-    if (array.length == 0) {
+    if (array.length === 0) {
         throw new Error(`can't get ${getFirst ? "first" : "last"} from empty array!`);
     }
     const index = getFirst ? 0 : array.length - 1;
@@ -154,10 +158,10 @@ export function getErrorMessage(maybeError) {
     return String(maybeError);
 }
 /**
- *
  * @param value
  */
+// eslint-disable-next-line @rushstack/no-new-null
 export function isDefined(value) {
     return value !== undefined && value !== null;
 }
-//# sourceMappingURL=utils.mjs.map
+//# sourceMappingURL=utils.js.map