@schafevormfenster/rest-commons 0.1.1

package/src/time/timezone.types.test.ts

@@ -0,0 +1,55 @@
+import { describe, it, expect } from "vitest";
+
+import { Timezone } from "./timezone.types";
+
+describe("Timezone schema", () => {
+  it("should accept valid IANA timezone formats", () => {
+    const validTimezones = [
+      "Europe/Berlin",
+      "America/New_York",
+      "Asia/Tokyo",
+      "Africa/Cairo",
+      "Pacific/Auckland",
+      "Australia/Sydney",
+      "Europe/London",
+      "America/Los_Angeles",
+    ];
+
+    for (const timezone of validTimezones) {
+      expect(() => Timezone.parse(timezone)).not.toThrow();
+    }
+  });
+
+  it("should accept UTC as a valid time standard", () => {
+    expect(() => Timezone.parse("UTC")).not.toThrow();
+  });
+
+  it("should reject invalid timezone formats", () => {
+    const invalidTimezones = [
+      "", // Empty string
+      "Europe", // Missing slash and second part
+      "/Berlin", // Missing first part
+      "Europe/", // Missing second part
+      "Europe//Berlin", // Double slash
+      "Europe/Berlin/Extra", // Extra part
+      "123/456", // Numbers not allowed
+      "Europe/Ber-lin", // Hyphen not allowed
+      "Eur@pe/Berlin", // Special characters not allowed
+      " Europe/Berlin", // Leading space
+      "Europe/Berlin ", // Trailing space
+    ];
+
+    for (const timezone of invalidTimezones) {
+      expect(() => Timezone.parse(timezone)).toThrow();
+    }
+  });
+
+  it("should match the correct pattern for IANA timezones", () => {
+    // Test the underlying regex pattern
+    const pattern = /^[A-Za-z_]+\/[A-Za-z_]+$/;
+
+    expect("Europe/Berlin").toMatch(pattern);
+    expect("Europe_East/Berlin_West").toMatch(pattern);
+    expect("Invalid-Timezone").not.toMatch(pattern);
+  });
+});

package/src/time/timezone.types.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+
+/**
+ * Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich"
+ */
+export const IanaTimezone = z.string().regex(/^[A-Za-z_]+\/[A-Za-z_]+$/);
+
+/**
+ * Common time standards like UTC, GMT, etc.
+ */
+export const TimeStandard = z
+  .string()
+  .regex(/^(UTC|GMT|EST|CST|MST|PST|EDT|CDT|MDT|PDT)$/);
+
+/**
+ * Timezone that can be either an IANA timezone or a time standard
+ */
+export const Timezone = z.union([IanaTimezone, TimeStandard]);
+
+export type IanaTimezone = z.infer<typeof IanaTimezone>;
+export type TimeStandard = z.infer<typeof TimeStandard>;
+export type Timezone = z.infer<typeof Timezone>;

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "lib": ["ES2022"],
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*"],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts",
+    "src/helpers/process-eventify-request.ts",
+    "src/helpers/detect-mime-type.ts"
+  ]
+}