@schafevormfenster/rest-commons 0.1.1

package/dist/helpers/response-headers/environment.types.d.ts

@@ -0,0 +1,2 @@
+export type Environment = "development" | "staging" | "production";
+//# sourceMappingURL=environment.types.d.ts.map

package/dist/helpers/response-headers/environment.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.types.d.ts","sourceRoot":"","sources":["../../../src/helpers/response-headers/environment.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC"}

package/dist/helpers/response-headers/environment.types.js

@@ -0,0 +1 @@
+export {};

package/dist/helpers/response-headers/resolve-environment.d.ts

@@ -0,0 +1,8 @@
+import { type Environment } from "./environment.types";
+/**
+ * Resolve environment consistently across server/middleware contexts.
+ * - VERCEL_ENV: production | preview | development
+ * - NODE_ENV: production | development
+ */
+export declare function resolveEnvironment(): Environment;
+//# sourceMappingURL=resolve-environment.d.ts.map

package/dist/helpers/response-headers/resolve-environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-environment.d.ts","sourceRoot":"","sources":["../../../src/helpers/response-headers/resolve-environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,WAAW,CAShD"}

package/dist/helpers/response-headers/resolve-environment.js

@@ -0,0 +1,18 @@
+/**
+ * Resolve environment consistently across server/middleware contexts.
+ * - VERCEL_ENV: production | preview | development
+ * - NODE_ENV: production | development
+ */
+export function resolveEnvironment() {
+    const vercel = process.env.VERCEL_ENV;
+    if (vercel === "production")
+        return "production";
+    if (vercel === "preview")
+        return "staging";
+    const node = process.env.NODE_ENV;
+    if (node === "production")
+        return "production";
+    if (node === "development")
+        return "development";
+    return "development";
+}

package/dist/helpers/slugify.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Convert a string to a URL-safe slug.
+ * Uses the slugify npm package with support for German umlauts and other special characters.
+ *
+ * @param text - Input string to slugify
+ * @returns URL-safe slug (lowercase, hyphens, no special chars)
+ *
+ * @example
+ * slugify("Hello World!") // "hello-world"
+ * slugify("Berlin, Germany") // "berlin-germany"
+ * slugify("Café in München") // "cafe-in-munchen"
+ * slugify("Äpfel und Öl") // "aepfel-und-oel"
+ */
+export declare function slugify(text: string): string;
+//# sourceMappingURL=slugify.d.ts.map

package/dist/helpers/slugify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugify.d.ts","sourceRoot":"","sources":["../../src/helpers/slugify.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAO5C"}

package/dist/helpers/slugify.js

@@ -0,0 +1,32 @@
+import slugifyPackage from "slugify";
+// Extend slugify to handle German umlauts correctly
+slugifyPackage.extend({
+    'ä': 'ae',
+    'ö': 'oe',
+    'ü': 'ue',
+    'ß': 'ss',
+    'Ä': 'Ae',
+    'Ö': 'Oe',
+    'Ü': 'Ue',
+});
+/**
+ * Convert a string to a URL-safe slug.
+ * Uses the slugify npm package with support for German umlauts and other special characters.
+ *
+ * @param text - Input string to slugify
+ * @returns URL-safe slug (lowercase, hyphens, no special chars)
+ *
+ * @example
+ * slugify("Hello World!") // "hello-world"
+ * slugify("Berlin, Germany") // "berlin-germany"
+ * slugify("Café in München") // "cafe-in-munchen"
+ * slugify("Äpfel und Öl") // "aepfel-und-oel"
+ */
+export function slugify(text) {
+    return slugifyPackage(text, {
+        lower: true, // Convert to lowercase
+        strict: true, // Strip special characters except replacement
+        remove: /[*+~.()'"!:@]/g, // Remove these characters
+        trim: true, // Trim leading/trailing replacement chars
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+export * from "./api-schemas/error.schema";
+export * from "./api-schemas/health.schema";
+export * from "./api-schemas/okay.schema";
+export * from "./api-schemas/result.schema";
+export * from "./api-schemas/results.schema";
+export * from "./primitives/location.schema";
+export * from "./primitives/slug.schema";
+export * from "./primitives/numeric-id.schema";
+export * from "./primitives/uuid.schema";
+export * from "./primitives/geoname-id.schema";
+export * from "./primitives/wikidata-id.schema";
+export * from "./primitives/international-zip.schema";
+export * from "./time/timezone.types";
+export * from "./time/iso8601.schema";
+export * from "./time/relative-time.schema";
+export * from "./time/flexible-time.schema";
+export * from "./time/bounded-time.schema";
+export * from "./time/time-helpers";
+export * from "./time/is-relative-time";
+export { parseFlexibleTime as parseFlexibleTimeAdvanced } from "./time/flexible-time-parser";
+export * from "./time/boundary-enforcement";
+/** @deprecated Use flexible-time.schema exports instead */
+export { FlexibleTimeSchema as FlexibleTimeSchemaOld, FlexibleTime as FlexibleTimeOld, TimeUnit, RelativeTimeConfig } from "./time/time-schemas";
+export * from "./helpers/correlation/get-correlation-id";
+export * from "./helpers/correlation/get-header";
+export * from "./helpers/detect-mime-type";
+export * from "./helpers/detect-suspicious-patterns";
+export * from "./helpers/hash-binary";
+export * from "./helpers/parameter-validation";
+export * from "./helpers/slugify";
+export * from "./helpers/response-headers/build-api-unauthorized-headers";
+export * from "./helpers/response-headers/environment.types";
+export * from "./helpers/response-headers/resolve-environment";
+export * from "./normalization/normalize-list";
+export * from "./normalization/normalize-location";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAG7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AAGtD,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,iBAAiB,IAAI,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,cAAc,6BAA6B,CAAC;AAG5C,2DAA2D;AAC3D,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,EAAE,YAAY,IAAI,eAAe,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGjJ,cAAc,0CAA0C,CAAC;AACzD,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,2DAA2D,CAAC;AAC1E,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAG/D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC"}

package/dist/index.js

@@ -0,0 +1,41 @@
+// Schemas
+export * from "./api-schemas/error.schema";
+export * from "./api-schemas/health.schema";
+export * from "./api-schemas/okay.schema";
+export * from "./api-schemas/result.schema";
+export * from "./api-schemas/results.schema";
+// Primitive schemas
+export * from "./primitives/location.schema";
+export * from "./primitives/slug.schema";
+export * from "./primitives/numeric-id.schema";
+export * from "./primitives/uuid.schema";
+export * from "./primitives/geoname-id.schema";
+export * from "./primitives/wikidata-id.schema";
+export * from "./primitives/international-zip.schema";
+// Time utilities
+export * from "./time/timezone.types";
+export * from "./time/iso8601.schema"; // ISO8601 schemas
+export * from "./time/relative-time.schema"; // Relative time schemas
+export * from "./time/flexible-time.schema"; // Flexible time schemas
+export * from "./time/bounded-time.schema"; // Bounded time schemas
+export * from "./time/time-helpers"; // Helper functions
+export * from "./time/is-relative-time";
+export { parseFlexibleTime as parseFlexibleTimeAdvanced } from "./time/flexible-time-parser";
+export * from "./time/boundary-enforcement";
+// Deprecated exports (for backward compatibility)
+/** @deprecated Use flexible-time.schema exports instead */
+export { FlexibleTimeSchema as FlexibleTimeSchemaOld } from "./time/time-schemas";
+// Helpers
+export * from "./helpers/correlation/get-correlation-id";
+export * from "./helpers/correlation/get-header";
+export * from "./helpers/detect-mime-type";
+export * from "./helpers/detect-suspicious-patterns";
+export * from "./helpers/hash-binary";
+export * from "./helpers/parameter-validation";
+export * from "./helpers/slugify";
+export * from "./helpers/response-headers/build-api-unauthorized-headers";
+export * from "./helpers/response-headers/environment.types";
+export * from "./helpers/response-headers/resolve-environment";
+// Utilities
+export * from "./normalization/normalize-list";
+export * from "./normalization/normalize-location";

package/dist/normalization/normalize-list.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Normalize an array of strings by:
+ * - sanitizing with whitelist rules (preserving umlauts, removing injections)
+ * - trimming whitespace
+ * - lowercasing using locale-insensitive toLowerCase
+ * - removing duplicates
+ * - sorting alphabetically with proper German locale support (umlauts near base letters)
+ * - enforcing a maximum count
+ */
+export declare function normalizeStringList(values?: string[]): string[];
+//# sourceMappingURL=normalize-list.d.ts.map

package/dist/normalization/normalize-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-list.d.ts","sourceRoot":"","sources":["../../src/normalization/normalize-list.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,MAAM,EAAO,GAAG,MAAM,EAAE,CASnE"}

package/dist/normalization/normalize-list.js

@@ -0,0 +1,19 @@
+import { MAX_TAGS_COUNT, sanitizeTag } from "@schafevormfenster/security";
+/**
+ * Normalize an array of strings by:
+ * - sanitizing with whitelist rules (preserving umlauts, removing injections)
+ * - trimming whitespace
+ * - lowercasing using locale-insensitive toLowerCase
+ * - removing duplicates
+ * - sorting alphabetically with proper German locale support (umlauts near base letters)
+ * - enforcing a maximum count
+ */
+export function normalizeStringList(values = []) {
+    const sanitized = values.map((v) => sanitizeTag(v));
+    const normalized = sanitized
+        .map((v) => v.trim().toLowerCase())
+        .filter((v) => v.length > 0);
+    const unique = [...new Set(normalized)].slice(0, MAX_TAGS_COUNT);
+    unique.sort((a, b) => a.localeCompare(b, "de-DE"));
+    return unique;
+}

package/dist/normalization/normalize-location.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Normalizes location strings to optimize cache hits.
+ *
+ * Cleanup operations:
+ * - Remove duplicate or multiple spaces and reduce to at most one space character
+ * - Ensure that a comma has no space before but one space after
+ *
+ * @param location - The location string to normalize
+ * @returns Normalized location string
+ *
+ * @example
+ * normalizeLocation("Schlatkow   ,   17390  Schmatzin")
+ * // Returns: "Schlatkow, 17390 Schmatzin"
+ */
+export declare function normalizeLocation(location: string): string;
+//# sourceMappingURL=normalize-location.d.ts.map

package/dist/normalization/normalize-location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-location.d.ts","sourceRoot":"","sources":["../../src/normalization/normalize-location.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAc1D"}

package/dist/normalization/normalize-location.js

@@ -0,0 +1,26 @@
+/**
+ * Normalizes location strings to optimize cache hits.
+ *
+ * Cleanup operations:
+ * - Remove duplicate or multiple spaces and reduce to at most one space character
+ * - Ensure that a comma has no space before but one space after
+ *
+ * @param location - The location string to normalize
+ * @returns Normalized location string
+ *
+ * @example
+ * normalizeLocation("Schlatkow   ,   17390  Schmatzin")
+ * // Returns: "Schlatkow, 17390 Schmatzin"
+ */
+export function normalizeLocation(location) {
+    return (location
+        // First pass: normalize spaces (collapse multiple spaces/tabs/newlines to single space)
+        .replaceAll(/[ \t\n\r]+/gu, " ")
+        // Trim leading and trailing spaces
+        .trim()
+        // Fix comma spacing: remove space before comma, ensure one space after comma (but not at end)
+        // eslint-disable-next-line sonarjs/slow-regex -- Necessary for comma normalization
+        .replaceAll(/ *, */gu, ", ")
+        // Remove trailing space after comma if it's at the end of string
+        .replace(/, $/u, ","));
+}

package/dist/primitives/coordinate-precision.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validates that a coordinate value has at most the specified number of decimal places.
+ * Handles both standard notation and scientific notation.
+ *
+ * @param value - The numeric coordinate value to validate
+ * @param maxDecimalPlaces - Maximum allowed decimal places (default: 8)
+ * @returns true if the value has at most maxDecimalPlaces decimal places
+ */
+export declare function hasValidDecimalPrecision(value: number, maxDecimalPlaces?: number): boolean;
+//# sourceMappingURL=coordinate-precision.d.ts.map

package/dist/primitives/coordinate-precision.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coordinate-precision.d.ts","sourceRoot":"","sources":["../../src/primitives/coordinate-precision.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,MAAM,EACb,gBAAgB,SAAI,GACnB,OAAO,CAkBT"}

package/dist/primitives/coordinate-precision.js

@@ -0,0 +1,27 @@
+/**
+ * Validates that a coordinate value has at most the specified number of decimal places.
+ * Handles both standard notation and scientific notation.
+ *
+ * @param value - The numeric coordinate value to validate
+ * @param maxDecimalPlaces - Maximum allowed decimal places (default: 8)
+ * @returns true if the value has at most maxDecimalPlaces decimal places
+ */
+export function hasValidDecimalPrecision(value, maxDecimalPlaces = 8) {
+    // Convert to string and handle scientific notation
+    const valueString = value.toString();
+    if (valueString.includes("e") || valueString.includes("E")) {
+        // For scientific notation, convert to fixed notation
+        // Use 20 decimal places to ensure we capture all significant digits
+        // without losing precision during the conversion
+        const fixed = value.toFixed(20);
+        const [, decimalPart = ""] = fixed.split(".");
+        // Remove trailing zeros without regex
+        let decimals = decimalPart;
+        while (decimals.endsWith("0")) {
+            decimals = decimals.slice(0, -1);
+        }
+        return decimals.length <= maxDecimalPlaces;
+    }
+    const decimalPlaces = valueString.split(".")[1]?.length || 0;
+    return decimalPlaces <= maxDecimalPlaces;
+}

package/dist/primitives/geo-point.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating geographic coordinates as a tuple.
+ * Geographic coordinates as [latitude, longitude].
+ */
+export declare const GeoPointSchema: z.ZodTuple<[z.ZodEffects<z.ZodNumber, number, number>, z.ZodEffects<z.ZodNumber, number, number>], null>;
+export type GeoPoint = z.infer<typeof GeoPointSchema>;
+//# sourceMappingURL=geo-point.schema.d.ts.map

package/dist/primitives/geo-point.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geo-point.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/geo-point.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;GAGG;AACH,eAAO,MAAM,cAAc,0GAEmC,CAAC;AAE/D,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/primitives/geo-point.schema.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { LatitudeSchema } from "./latitude.schema";
+import { LongitudeSchema } from "./longitude.schema";
+/**
+ * Zod schema for validating geographic coordinates as a tuple.
+ * Geographic coordinates as [latitude, longitude].
+ */
+export const GeoPointSchema = z
+    .tuple([LatitudeSchema, LongitudeSchema])
+    .describe("Geographic coordinates as [latitude, longitude]");

package/dist/primitives/geoname-id.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating Geonames.org numeric IDs.
+ * Geoname IDs are positive integers, typically 1-10 digits.
+ */
+export declare const GeonameIdSchema: z.ZodString;
+export type GeonameId = z.infer<typeof GeonameIdSchema>;
+//# sourceMappingURL=geoname-id.schema.d.ts.map

package/dist/primitives/geoname-id.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geoname-id.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/geoname-id.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,eAAe,aAGmB,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/primitives/geoname-id.schema.js

@@ -0,0 +1,9 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating Geonames.org numeric IDs.
+ * Geoname IDs are positive integers, typically 1-10 digits.
+ */
+export const GeonameIdSchema = z
+    .string()
+    .regex(/^[1-9]\d{0,9}$/, "Must be a valid Geoname ID (positive integer, max 10 digits)")
+    .describe("Geonames.org location identifier");

package/dist/primitives/international-zip.schema.d.ts

@@ -0,0 +1,76 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating international postal/ZIP codes.
+ * Focuses on Central European formats with support for other common formats.
+ * - Germany: 12345
+ * - Poland: 12-345
+ * - France: 12345
+ * - Austria: 1234
+ * - Netherlands: 1234 AB
+ * - And more
+ */
+export declare const InternationalZipSchema: z.ZodString;
+/**
+ * Country-specific ZIP code schemas for stricter validation.
+ * Focuses on Central European countries (DE, PL, FR, AT, NL) with additional support for common formats.
+ */
+export declare const ZipSchemaByCountry: {
+    /**
+     * Germany PLZ: 12345 (5 digits)
+     * Most important for Central Europe
+     */
+    readonly DE: z.ZodString;
+    /**
+     * Poland kod pocztowy: 12-345 (2 digits, hyphen, 3 digits)
+     * Most important for Central Europe
+     */
+    readonly PL: z.ZodString;
+    /**
+     * France code postal: 12345 (5 digits)
+     * Most important for Central Europe
+     */
+    readonly FR: z.ZodString;
+    /**
+     * Austria PLZ: 1234 (4 digits)
+     * Most important for Central Europe
+     */
+    readonly AT: z.ZodString;
+    /**
+     * Netherlands postcode: 1234 AB (4 digits, space, 2 letters)
+     * Most important for Central Europe
+     */
+    readonly NL: z.ZodString;
+    /**
+     * Switzerland PLZ: 1234 (4 digits)
+     */
+    readonly CH: z.ZodString;
+    /**
+     * Italy CAP: 12345 (5 digits)
+     */
+    readonly IT: z.ZodString;
+    /**
+     * Spain código postal: 12345 (5 digits)
+     */
+    readonly ES: z.ZodString;
+    /**
+     * Belgium postcode: 1234 (4 digits)
+     */
+    readonly BE: z.ZodString;
+    /**
+     * Czech Republic PSČ: 123 45 (3 digits, space, 2 digits)
+     */
+    readonly CZ: z.ZodString;
+    /**
+     * UK postcode: SW1A 1AA
+     */
+    readonly UK: z.ZodString;
+};
+export type InternationalZip = z.infer<typeof InternationalZipSchema>;
+export type CountryCode = keyof typeof ZipSchemaByCountry;
+/**
+ * Helper function to get the appropriate ZIP schema for a country
+ * @param countryCode - Two-letter ISO country code
+ * @returns Zod schema for the country's postal code format, or InternationalZipSchema as fallback
+ */
+export declare function getZipSchemaForCountry(countryCode: string): z.ZodString;
+//# sourceMappingURL=international-zip.schema.d.ts.map

package/dist/primitives/international-zip.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"international-zip.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/international-zip.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB,aAQS,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAC7B;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAKK,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,CAAC,CAAC,SAAS,CAGvE"}

package/dist/primitives/international-zip.schema.js

@@ -0,0 +1,81 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating international postal/ZIP codes.
+ * Focuses on Central European formats with support for other common formats.
+ * - Germany: 12345
+ * - Poland: 12-345
+ * - France: 12345
+ * - Austria: 1234
+ * - Netherlands: 1234 AB
+ * - And more
+ */
+export const InternationalZipSchema = z
+    .string()
+    .min(3, "Postal code must be at least 3 characters long")
+    .max(12, "Postal code must not exceed 12 characters")
+    .regex(/^[A-Z0-9\s-]+$/i, "Postal code must contain only alphanumeric characters, spaces, and hyphens")
+    .describe("International postal/ZIP code");
+/**
+ * Country-specific ZIP code schemas for stricter validation.
+ * Focuses on Central European countries (DE, PL, FR, AT, NL) with additional support for common formats.
+ */
+export const ZipSchemaByCountry = {
+    /**
+     * Germany PLZ: 12345 (5 digits)
+     * Most important for Central Europe
+     */
+    DE: z.string().regex(/^\d{5}$/, "Must be a valid German postal code (12345)"),
+    /**
+     * Poland kod pocztowy: 12-345 (2 digits, hyphen, 3 digits)
+     * Most important for Central Europe
+     */
+    PL: z.string().regex(/^\d{2}-\d{3}$/, "Must be a valid Polish postal code (12-345)"),
+    /**
+     * France code postal: 12345 (5 digits)
+     * Most important for Central Europe
+     */
+    FR: z.string().regex(/^\d{5}$/, "Must be a valid French postal code (12345)"),
+    /**
+     * Austria PLZ: 1234 (4 digits)
+     * Most important for Central Europe
+     */
+    AT: z.string().regex(/^\d{4}$/, "Must be a valid Austrian postal code (1234)"),
+    /**
+     * Netherlands postcode: 1234 AB (4 digits, space, 2 letters)
+     * Most important for Central Europe
+     */
+    NL: z.string().regex(/^\d{4}\s?[A-Z]{2}$/i, "Must be a valid Dutch postal code (1234 AB)"),
+    /**
+     * Switzerland PLZ: 1234 (4 digits)
+     */
+    CH: z.string().regex(/^\d{4}$/, "Must be a valid Swiss postal code (1234)"),
+    /**
+     * Italy CAP: 12345 (5 digits)
+     */
+    IT: z.string().regex(/^\d{5}$/, "Must be a valid Italian CAP (12345)"),
+    /**
+     * Spain código postal: 12345 (5 digits)
+     */
+    ES: z.string().regex(/^\d{5}$/, "Must be a valid Spanish postal code (12345)"),
+    /**
+     * Belgium postcode: 1234 (4 digits)
+     */
+    BE: z.string().regex(/^\d{4}$/, "Must be a valid Belgian postal code (1234)"),
+    /**
+     * Czech Republic PSČ: 123 45 (3 digits, space, 2 digits)
+     */
+    CZ: z.string().regex(/^\d{3}\s?\d{2}$/, "Must be a valid Czech postal code (123 45)"),
+    /**
+     * UK postcode: SW1A 1AA
+     */
+    UK: z.string().regex(/^[A-Z]{1,2}\d[A-Z\d]?\s?\d[A-Z]{2}$/i, "Must be a valid UK postcode (SW1A 1AA)"),
+};
+/**
+ * Helper function to get the appropriate ZIP schema for a country
+ * @param countryCode - Two-letter ISO country code
+ * @returns Zod schema for the country's postal code format, or InternationalZipSchema as fallback
+ */
+export function getZipSchemaForCountry(countryCode) {
+    const upperCode = countryCode.toUpperCase();
+    return ZipSchemaByCountry[upperCode] || InternationalZipSchema;
+}

package/dist/primitives/latitude.schema.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating latitude coordinates.
+ * Latitude must be a number between -90 and 90 degrees inclusive.
+ * Maximum precision is 8 decimal places (~1.1mm accuracy).
+ */
+export declare const LatitudeSchema: z.ZodEffects<z.ZodNumber, number, number>;
+export type Latitude = z.infer<typeof LatitudeSchema>;
+//# sourceMappingURL=latitude.schema.d.ts.map

package/dist/primitives/latitude.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latitude.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/latitude.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CAQkB,CAAC;AAE9C,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/primitives/latitude.schema.js

@@ -0,0 +1,13 @@
+import { z } from "zod";
+import { hasValidDecimalPrecision } from "./coordinate-precision";
+/**
+ * Zod schema for validating latitude coordinates.
+ * Latitude must be a number between -90 and 90 degrees inclusive.
+ * Maximum precision is 8 decimal places (~1.1mm accuracy).
+ */
+export const LatitudeSchema = z
+    .number()
+    .min(-90, "Latitude must be greater than or equal to -90")
+    .max(90, "Latitude must be less than or equal to 90")
+    .refine((value) => hasValidDecimalPrecision(value, 8), { message: "Latitude must have at most 8 decimal places" })
+    .describe("Latitude coordinate in degrees");

package/dist/primitives/location.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating location parameter in findbyaddress endpoint.
+ * Checks for minimum length and suspicious patterns.
+ */
+export declare const LocationSchema: z.ZodEffects<z.ZodString, string, string>;
+export type Location = z.infer<typeof LocationSchema>;
+//# sourceMappingURL=location.schema.d.ts.map

package/dist/primitives/location.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/location.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;GAGG;AACH,eAAO,MAAM,cAAc,2CAWxB,CAAC;AAEJ,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/primitives/location.schema.js

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import { validateNoSuspiciousPatterns } from "../helpers/parameter-validation";
+/**
+ * Zod schema for validating location parameter in findbyaddress endpoint.
+ * Checks for minimum length and suspicious patterns.
+ */
+export const LocationSchema = z
+    .string()
+    .min(2, "Location must be at least 2 characters long")
+    .refine((value) => {
+    validateNoSuspiciousPatterns(value, "location");
+    return true;
+}, {
+    message: "Location parameter contains suspicious patterns that are not allowed",
+});

package/dist/primitives/longitude.schema.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating longitude coordinates.
+ * Longitude must be a number between -180 and 180 degrees inclusive.
+ * Maximum precision is 8 decimal places (~1.1mm accuracy).
+ */
+export declare const LongitudeSchema: z.ZodEffects<z.ZodNumber, number, number>;
+export type Longitude = z.infer<typeof LongitudeSchema>;
+//# sourceMappingURL=longitude.schema.d.ts.map

package/dist/primitives/longitude.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"longitude.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/longitude.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;GAIG;AACH,eAAO,MAAM,eAAe,2CAQkB,CAAC;AAE/C,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/primitives/longitude.schema.js

@@ -0,0 +1,13 @@
+import { z } from "zod";
+import { hasValidDecimalPrecision } from "./coordinate-precision";
+/**
+ * Zod schema for validating longitude coordinates.
+ * Longitude must be a number between -180 and 180 degrees inclusive.
+ * Maximum precision is 8 decimal places (~1.1mm accuracy).
+ */
+export const LongitudeSchema = z
+    .number()
+    .min(-180, "Longitude must be greater than or equal to -180")
+    .max(180, "Longitude must be less than or equal to 180")
+    .refine((value) => hasValidDecimalPrecision(value, 8), { message: "Longitude must have at most 8 decimal places" })
+    .describe("Longitude coordinate in degrees");

package/dist/primitives/numeric-id.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating ID parameter in community ID endpoint.
+ * Checks that ID contains only numbers and is between 3-20 characters long.
+ */
+export declare const NumericIdSchema: z.ZodString;
+export type NumericId = z.infer<typeof NumericIdSchema>;
+//# sourceMappingURL=numeric-id.schema.d.ts.map

package/dist/primitives/numeric-id.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-id.schema.d.ts","sourceRoot":"","sources":["../../src/primitives/numeric-id.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,eAAe,aAIgC,CAAC;AAE7D,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/primitives/numeric-id.schema.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating ID parameter in community ID endpoint.
+ * Checks that ID contains only numbers and is between 3-20 characters long.
+ */
+export const NumericIdSchema = z
+    .string()
+    .min(3, "ID must be at least 3 characters long")
+    .max(20, "ID must not exceed 20 characters")
+    .regex(/^\d+$/, "ID must contain only numeric characters");