@digitraffic/common 2026.3.17-1 → 2026.3.26-1-beta

package/dist/utils/utils.d.ts

@@ -0,0 +1,95 @@
+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.
+ * Function works only for primitive types and for other it just checks the reference to object.
+ *
+ * Some examples
+ * bothArraysHasSameValues( [a, b], [b, a] )    => true
+ * bothArraysHasSameValues( [a, a], [a, a, a] ) => true
+ * bothArraysHasSameValues( [a, b], [a] )       => false
+ *
+ * Object references:
+ * const o1 = { a: 1, b: 2};
+ * const o2 = { a: 1, b: 2};
+ * // Arrays has references to same objects
+ * bothArraysHasSameValues([o1], [o1]))         => true
+ * Arrays have references to different objects
+ * bothArraysHasSameValues([o1], [o2]))         => false
+ *
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+export declare function bothArraysHasSameValues(a: null | undefined | unknown[], b: null | undefined | unknown[]): boolean;
+/**
+ * Returns the last item on the array.  If the array is empty, throws an error!
+ */
+export declare function getLast<T>(array: T[], sortFunction?: (a: T) => number): T;
+/**
+ * Returns the first item on the array.  If the array is empty, throws an error!
+ */
+export declare function getFirst<T>(array: T[], sortFunction?: (a: T) => number): T;
+/**
+ * Gets environment variable. Throws error if variable is not found.
+ *
+ * @param key Environment key
+ * @return string
+ */
+export declare function getEnvVariable(key: string): string;
+/**
+ * Gets environment variable. Safe version returns object with either ok or error status.
+ * Easier to use for recovery than catching an error.
+ *
+ * @param key Environment key
+ * @return Either<string>
+ */
+export declare function getEnvVariableSafe(key: string): Either<string>;
+/**
+ * Sets environment variable.
+ *
+ * @param key Environment key
+ * @param value Environment variable value
+ */
+export declare function setEnvVariable(key: string, value: string): void;
+export declare function setEnvVariableAwsRegion(value: string): void;
+/**
+ * Gets environment variable. If environment variable is undefined, returns value of given function.
+ *
+ * @param key Environment key
+ * @param fn Alternative function
+ */
+export declare function getEnvVariableOr<T>(key: string, fn: () => T): string | T;
+/**
+ * Gets environment variable. If environment variable is undefined, returns given value.
+ * Use to return an explicit alternative value e.g. in cases where environment variable may be undefined.
+ *
+ * @param key Environment key
+ * @param orElse Alternative value
+ */
+export declare function getEnvVariableOrElse<T>(key: string, orElse: T): string | T;
+export declare function setSecretOverideAwsRegionEnv(region: string): void;
+/**
+ * ESLint won't allow to call Object.prototype builtin methods.
+ * To call hasOwnProperty we must use Object.prototype.hasOwnProperty.call()
+ * @param object to test for property
+ * @param propertyName property name to check
+ * @see https://eslint.org/docs/latest/rules/no-prototype-builtins
+ */
+export declare function hasOwnPropertySafe(object: object, propertyName: string): boolean;
+/**
+ * Return an error message from the given object hat might be an Error object.
+ * @param maybeError
+ */
+export declare function getErrorMessage(maybeError: unknown): string;
+/**
+ * @param value
+ */
+export declare function isDefined<T>(value: T | undefined | null): value is T;
+/**
+ * Omits a key from an object deeply (also in nested objects). Creates and returns new object.
+ *
+ * @param obj Object to omit from
+ * @param keysToOmit Keys to omit
+ * @returns New same type of object as that was given as input but with the keys omitted.
+ */
+export declare function omitDeep<T>(obj: T, ...keysToOmit: readonly string[]): T;

package/dist/utils/utils.js

@@ -0,0 +1,178 @@
+import { forIn, isObject } from "es-toolkit/compat";
+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.
+ * Function works only for primitive types and for other it just checks the reference to object.
+ *
+ * Some examples
+ * bothArraysHasSameValues( [a, b], [b, a] )    => true
+ * bothArraysHasSameValues( [a, a], [a, a, a] ) => true
+ * bothArraysHasSameValues( [a, b], [a] )       => false
+ *
+ * Object references:
+ * const o1 = { a: 1, b: 2};
+ * const o2 = { a: 1, b: 2};
+ * // Arrays has references to same objects
+ * bothArraysHasSameValues([o1], [o1]))         => true
+ * Arrays have references to different objects
+ * bothArraysHasSameValues([o1], [o2]))         => false
+ *
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+export function bothArraysHasSameValues(a, b) {
+    if ((a && !b) || (!a && b)) {
+        return false;
+    }
+    else if (!a && !b) {
+        return true;
+    }
+    const aSet = new Set(a);
+    const bSet = new Set(b);
+    if (aSet.size !== bSet.size) {
+        return false;
+    }
+    return Array.from(aSet).every((value) => bSet.has(value));
+}
+/**
+ * Returns the last item on the array.  If the array is empty, throws an error!
+ */
+export function getLast(array, sortFunction) {
+    return getFirstOrLast(false, array, sortFunction);
+}
+/**
+ * Returns the first item on the array.  If the array is empty, throws an error!
+ */
+export function getFirst(array, sortFunction) {
+    return getFirstOrLast(true, array, sortFunction);
+}
+function getFirstOrLast(getFirst, array, sortFunction) {
+    if (array.length === 0) {
+        throw new Error(`can't get ${getFirst ? "first" : "last"} from empty array!`);
+    }
+    const index = getFirst ? 0 : array.length - 1;
+    if (sortFunction) {
+        return array.sort(sortFunction)[index];
+    }
+    return array[index];
+}
+/**
+ * Gets environment variable. Throws error if variable is not found.
+ *
+ * @param key Environment key
+ * @return string
+ */
+export function getEnvVariable(key) {
+    const either = getEnvVariableSafe(key);
+    if (either.result === "error") {
+        throw new Error(either.message);
+    }
+    return either.value;
+}
+/**
+ * Gets environment variable. Safe version returns object with either ok or error status.
+ * Easier to use for recovery than catching an error.
+ *
+ * @param key Environment key
+ * @return Either<string>
+ */
+export function getEnvVariableSafe(key) {
+    const value = process.env[key];
+    if (value === undefined) {
+        return {
+            result: "error",
+            message: `Error: environment variable "${key}" is undefined.`,
+        };
+    }
+    return { result: "ok", value };
+}
+/**
+ * Sets environment variable.
+ *
+ * @param key Environment key
+ * @param value Environment variable value
+ */
+export function setEnvVariable(key, value) {
+    process.env[key] = value;
+}
+export function setEnvVariableAwsRegion(value) {
+    setEnvVariable(EnvKeys.AWS_REGION, value);
+}
+/**
+ * Gets environment variable. If environment variable is undefined, returns value of given function.
+ *
+ * @param key Environment key
+ * @param fn Alternative function
+ */
+export function getEnvVariableOr(key, fn) {
+    const either = getEnvVariableSafe(key);
+    if (either.result === "ok") {
+        return either.value;
+    }
+    return fn();
+}
+/**
+ * Gets environment variable. If environment variable is undefined, returns given value.
+ * Use to return an explicit alternative value e.g. in cases where environment variable may be undefined.
+ *
+ * @param key Environment key
+ * @param orElse Alternative value
+ */
+export function getEnvVariableOrElse(key, orElse) {
+    return getEnvVariableOr(key, () => orElse);
+}
+export function setSecretOverideAwsRegionEnv(region) {
+    setEnvVariable(EnvKeys.SECRET_OVERRIDE_AWS_REGION, region);
+}
+/**
+ * ESLint won't allow to call Object.prototype builtin methods.
+ * To call hasOwnProperty we must use Object.prototype.hasOwnProperty.call()
+ * @param object to test for property
+ * @param propertyName property name to check
+ * @see https://eslint.org/docs/latest/rules/no-prototype-builtins
+ */
+export function hasOwnPropertySafe(object, propertyName) {
+    return Object.hasOwn(object, propertyName);
+}
+/**
+ * Return an error message from the given object hat might be an Error object.
+ * @param maybeError
+ */
+export function getErrorMessage(maybeError) {
+    if (maybeError instanceof Error) {
+        return `${maybeError.name}: ${maybeError.message}`;
+    }
+    return String(maybeError);
+}
+/**
+ * @param value
+ */
+export function isDefined(value) {
+    return value !== undefined && value !== null;
+}
+/**
+ * Omits a key from an object deeply (also in nested objects). Creates and returns new object.
+ *
+ * @param obj Object to omit from
+ * @param keysToOmit Keys to omit
+ * @returns New same type of object as that was given as input but with the keys omitted.
+ */
+export function omitDeep(obj, ...keysToOmit) {
+    if (!isObject(obj)) {
+        // primitive values are returned as-is
+        return obj;
+    }
+    if (Array.isArray(obj)) {
+        // recursively process arrays
+        return obj.map((item) => omitDeep(item, ...keysToOmit));
+    }
+    const result = {};
+    forIn(obj, (value, key) => {
+        if (!keysToOmit.includes(key)) {
+            result[key] = omitDeep(value, ...keysToOmit);
+        }
+    });
+    return result;
+}
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1,27 @@
+import { z } from "zod";
+/**
+ * Functions for validating and parsing e.g. path and query parameters with zod.
+ * The value of the message parameter will appear in the zod error object resulting from failed validation.
+ * Empty strings are treated as undefined.
+ *
+ * Usage:
+ * const mySchema = z
+ *  .object({
+ *    requiredParam: zStringToDate("Invalid value of myParameter"),
+ *    optionalParam: zStringToDate().optional(),
+ *  });
+ *
+ */
+/**
+ * Parses a string to a number. Empty strings are treated as undefined.
+ */
+export declare function zStringToNumber(message?: string): z.ZodPipe<z.ZodString, z.ZodTransform<number | undefined, string>>;
+/**
+ * Parses a string to a Date. Empty strings are treated as undefined.
+ */
+export declare function zStringToDate(message?: string): z.ZodPipe<z.ZodString, z.ZodTransform<Date | undefined, string>>;
+/**
+ * A non-empty string. Empty strings produce a validation error.
+ * Chain with .optional() to also accept undefined.
+ */
+export declare function zNonEmptyString(message?: string): z.ZodString;

package/dist/utils/zod-utils.js

@@ -0,0 +1,57 @@
+import { z } from "zod";
+/**
+ * Functions for validating and parsing e.g. path and query parameters with zod.
+ * The value of the message parameter will appear in the zod error object resulting from failed validation.
+ * Empty strings are treated as undefined.
+ *
+ * Usage:
+ * const mySchema = z
+ *  .object({
+ *    requiredParam: zStringToDate("Invalid value of myParameter"),
+ *    optionalParam: zStringToDate().optional(),
+ *  });
+ *
+ */
+/**
+ * Parses a string to a number. Empty strings are treated as undefined.
+ */
+export function zStringToNumber(message) {
+    return z.string().transform((val, ctx) => {
+        if (!val)
+            return undefined;
+        const num = Number(val);
+        if (Number.isNaN(num)) {
+            ctx.addIssue({ code: "custom", message: message ?? "Not a number" });
+            return z.NEVER;
+        }
+        return num;
+    });
+}
+/**
+ * Parses a string to a Date. Empty strings are treated as undefined.
+ */
+export function zStringToDate(message) {
+    return z.string().transform((val, ctx) => {
+        if (!val)
+            return undefined;
+        const date = new Date(val);
+        if (Number.isNaN(date.getTime())) {
+            ctx.addIssue({
+                code: "custom",
+                message: message ?? "Invalid date format",
+            });
+            return z.NEVER;
+        }
+        return date;
+    });
+}
+/**
+ * A non-empty string. Empty strings produce a validation error.
+ * Chain with .optional() to also accept undefined.
+ */
+export function zNonEmptyString(message) {
+    return z.string().refine((val) => val !== "", {
+        message: message ?? "String must not be empty",
+    });
+}
+//# sourceMappingURL=zod-utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2026.3.17-1",
+  "version": "2026.3.26-1-beta",
   "private": false,
   "description": "",
   "repository": {
@@ -108,39 +108,40 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "@aws-sdk/client-api-gateway": "3.998.0",
-    "@aws-sdk/client-s3": "3.998.0",
-    "@aws-sdk/client-secrets-manager": "3.998.0",
-    "@aws-sdk/client-sns": "3.998.0",
-    "@aws-sdk/lib-storage": "3.998.0",
-    "@biomejs/biome": "2.4.4",
+    "@aws-sdk/client-api-gateway": "3.1004.0",
+    "@aws-sdk/client-s3": "3.1003.0",
+    "@aws-sdk/client-secrets-manager": "3.1003.0",
+    "@aws-sdk/client-sns": "3.1003.0",
+    "@aws-sdk/lib-storage": "3.1003.0",
+    "@biomejs/biome": "2.4.6",
     "@date-fns/tz": "1.4.1",
     "@rushstack/heft": "1.2.6",
     "@rushstack/heft-typescript-plugin": "1.3.1",
-    "@smithy/fetch-http-handler": "5.3.11",
+    "@smithy/fetch-http-handler": "5.3.13",
+    "@smithy/node-http-handler": "4.4.14",
     "@smithy/types": "4.13.0",
-    "@types/aws-lambda": "8.10.160",
+    "@types/aws-lambda": "8.10.161",
     "@types/etag": "1.8.4",
     "@types/geojson": "7946.0.16",
     "@types/geojson-validation": "1.0.3",
     "@types/lodash-es": "4.17.12",
     "@types/madge": "5.0.3",
-    "@types/node": "25.3.1",
+    "@types/node": "25.3.5",
     "@vitest/coverage-v8": "4.0.18",
-    "aws-cdk-lib": "2.240.0",
+    "aws-cdk-lib": "2.241.0",
     "change-case": "5.4.4",
     "constructs": "10.5.1",
     "date-fns": "4.1.0",
-    "es-toolkit": "1.44.0",
+    "es-toolkit": "1.45.1",
     "etag": "1.8.1",
     "geojson-validation": "1.0.2",
     "ky": "1.14.3",
-    "lefthook": "2.1.1",
+    "lefthook": "2.1.2",
     "lodash-es": "4.17.23",
     "madge": "8.0.0",
-    "pg-native": "3.6.0",
-    "pg-promise": "12.6.1",
-    "pg-query-stream": "4.13.0",
+    "pg-native": "3.7.0",
+    "pg-promise": "12.6.2",
+    "pg-query-stream": "4.14.0",
     "rimraf": "6.1.3",
     "sort-package-json": "3.6.1",
     "typescript": "5.9.3",
@@ -149,24 +150,24 @@
     "zod": "4.3.6"
   },
   "peerDependencies": {
-    "@aws-sdk/client-api-gateway": "3.975.0",
-    "@aws-sdk/client-s3": "3.975.0",
-    "@aws-sdk/client-secrets-manager": "3.975.0",
-    "@aws-sdk/client-sns": "3.975.0",
-    "@aws-sdk/lib-storage": "3.975.0",
+    "@aws-sdk/client-api-gateway": "3.1004.0",
+    "@aws-sdk/client-s3": "3.1003.0",
+    "@aws-sdk/client-secrets-manager": "3.1003.0",
+    "@aws-sdk/client-sns": "3.1003.0",
+    "@aws-sdk/lib-storage": "3.1003.0",
     "@date-fns/tz": "1.4.1",
-    "@smithy/fetch-http-handler": "5.3.9",
-    "@smithy/node-http-handler": "4.4.8",
-    "aws-cdk-lib": "2.236.0",
+    "@smithy/fetch-http-handler": "5.3.13",
+    "@smithy/node-http-handler": "4.4.14",
+    "aws-cdk-lib": "2.241.0",
     "change-case": "5.4.4",
-    "constructs": "10.4.5",
+    "constructs": "10.5.1",
     "date-fns": "4.1.0",
-    "es-toolkit": "1.44.0",
+    "es-toolkit": "1.45.1",
     "geojson-validation": "1.0.2",
     "ky": "1.14.3",
     "lodash-es": "4.17.23",
-    "pg-native": "3.5.2",
-    "pg-promise": "12.3.0",
+    "pg-native": "3.7.0",
+    "pg-promise": "12.6.2",
     "zod": "4.3.6"
   },
   "engines": {
@@ -176,6 +177,7 @@
     "build": "heft build --clean",
     "build:watch": "heft build-watch",
     "ci:test": "vitest run --coverage --reporter=junit --outputFile=junit.xml",
+    "deps:update-all": "node --experimental-strip-types scripts/update-deps-and-peers.ts",
     "format:check": "biome check ",
     "format:check-staged": "biome check --staged",
     "format:fix": "biome check --write",