@webamoki/web-svelte 1.2.3 → 2.0.0

package/README.md

@@ -73,7 +73,7 @@ pnpm dev
 
 ---
 
-## Versioning & Releases
+## 🔖 Versioning & Releases
 
 We use **Semantic Versioning** managed automatically by `semantic-release`.
 
@@ -121,6 +121,8 @@ ci: blah                   // No versioning - not standard
 
 ### Breaking Changes
 
+Commits with a breaking change automatically trigger a `major` version bump.
+
 For breaking changes, you must append `!` before the colon in the commit header as such:
 
 ```

package/dist/components/showcase/CodeBlock.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-  import { highlight } from '../../highlight.js';
+  import { highlight } from '../../utils/highlight.js';
   import { onMount } from 'svelte';
 
   export let language: string = 'svelte';

package/dist/{components → shared/components}/form/Button.svelte

@@ -1,7 +1,7 @@
 <script lang="ts">
-  import type { ButtonProps } from '../../shadcn/components/ui/button/index.js';
+  import type { ButtonProps } from '../../../shadcn/components/ui/button/index.js';
 
-  import { Button } from '../../shadcn/components/ui/button/index.js';
+  import { Button } from '../../../shadcn/components/ui/button/index.js';
   import Loader2Icon from '@lucide/svelte/icons/loader-2';
 
   type Props = ButtonProps & {

package/dist/{components → shared/components}/form/Button.svelte.d.ts

@@ -1,5 +1,5 @@
-import type { ButtonProps } from '../../shadcn/components/ui/button/index.js';
-import { Button } from '../../shadcn/components/ui/button/index.js';
+import type { ButtonProps } from '../../../shadcn/components/ui/button/index.js';
+import { Button } from '../../../shadcn/components/ui/button/index.js';
 type Props = ButtonProps & {
     class?: string;
     loading?: boolean;

package/dist/{components → shared/components}/form/Errors.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-  import { cn } from '../../shadcn/utils.js';
+  import { cn } from '../../../shadcn/utils.js';
   import { FieldErrors } from 'formsnap';
 
   interface Props {

package/dist/{components → shared/components}/form/FieldWrapper.svelte

@@ -18,7 +18,7 @@
   import type { HTMLInputAttributes } from 'svelte/elements';
   import type { FormPath } from 'sveltekit-superforms';
 
-  import { cn } from '../../shadcn/utils.js';
+  import { cn } from '../../../shadcn/utils.js';
   import {
     Control,
     type ControlAttrs,

package/dist/{components → shared/components}/form/fields/ChoiceMultiField.svelte

@@ -4,7 +4,9 @@
 >
   import type { FormPath } from 'sveltekit-superforms';
 
-  import ChoiceMulti, { type ChoiceMultiProps } from '../../ui/choice/ChoiceMulti.svelte';
+  import ChoiceMulti, {
+    type ChoiceMultiProps
+  } from '../../ui/choice/ChoiceMulti.svelte';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/DateField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
   import { CalendarDate } from '@internationalized/date';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';

package/dist/{components → shared/components}/form/fields/MessageField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Textarea } from '../../../../shadcn/components/ui/textarea/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Textarea } from '../../../shadcn/components/ui/textarea/index.js';
-  import { cn } from '../../../shadcn/utils.js';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/NumberField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/PasswordField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
   import { Eye, EyeOff } from '@lucide/svelte';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';

package/dist/{components → shared/components}/form/fields/SelectField.svelte

@@ -5,7 +5,6 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
-  import IconInputWrapper from '../IconInputWrapper.svelte';
   import {
     Select,
     SelectContent,
@@ -13,8 +12,9 @@
     SelectItem,
     SelectLabel,
     SelectTrigger
-  } from '../../../shadcn/components/ui/select/index.js';
-  import { cn } from '../../../shadcn/utils.js';
+  } from '../../../../shadcn/components/ui/select/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
+  import IconInputWrapper from '../IconInputWrapper.svelte';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/SelectMultiField.svelte

@@ -5,7 +5,6 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
-  import IconInputWrapper from '../IconInputWrapper.svelte';
   import {
     Select,
     SelectContent,
@@ -13,8 +12,9 @@
     SelectItem,
     SelectLabel,
     SelectTrigger
-  } from '../../../shadcn/components/ui/select/index.js';
-  import { cn } from '../../../shadcn/utils.js';
+  } from '../../../../shadcn/components/ui/select/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
+  import IconInputWrapper from '../IconInputWrapper.svelte';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/TextField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/TextFieldNullable.svelte

@@ -2,8 +2,8 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';
 

package/dist/{components → shared/components}/form/fields/TimeField.svelte

@@ -2,9 +2,9 @@
   import type { Component } from 'svelte';
   import type { FormPath } from 'sveltekit-superforms';
 
+  import { Input } from '../../../../shadcn/components/ui/input/index.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import IconInputWrapper from '../IconInputWrapper.svelte';
-  import { Input } from '../../../shadcn/components/ui/input/index.js';
-  import { cn } from '../../../shadcn/utils.js';
   import { Time } from '@internationalized/date';
 
   import FieldWrapper, { type FieldWrapperProps } from '../FieldWrapper.svelte';

package/dist/{components → shared/components}/ui/choice/ChoiceInternal.svelte

@@ -18,7 +18,7 @@
   import type { FormAttrs } from '../../form/FieldWrapper.svelte';
   import type { Snippet } from 'svelte';
 
-  import { cn } from '../../../shadcn/utils.js';
+  import { cn } from '../../../../shadcn/utils.js';
 
   interface Props extends ChoiceInternalProps<V, I, K> {
     handleItemClick: (item: I) => void;

package/dist/{components → shared/components}/ui/choice/WeekdayChoice.svelte

@@ -12,9 +12,12 @@
 </script>
 
 <script lang="ts">
-  import type { Day } from '../../../utils/types/arktype.js';
-
-  import { Days, formatDayLetter, formatDayShort } from '../../../utils/datetime/index.js';
+  import {
+    type Day,
+    Days,
+    formatDayLetter,
+    formatDayShort
+  } from '../../../utils/datetime/index.js';
   import { identity } from 'ramda';
 
   import Choice from './Choice.svelte';

package/dist/{components → shared/components}/ui/choice/WeekdayChoice.svelte.d.ts

@@ -8,7 +8,7 @@ export interface WeekdayChoiceProps {
     value?: Day;
     vertical?: boolean;
 }
-import type { Day } from '../../../utils/types/arktype.js';
+import { type Day } from '../../../utils/datetime/index.js';
 declare const WeekdayChoice: import("svelte").Component<WeekdayChoiceProps, {}, "value">;
 type WeekdayChoice = ReturnType<typeof WeekdayChoice>;
 export default WeekdayChoice;

package/dist/{components → shared/components}/ui/choice/WeekdayChoiceMulti.svelte

@@ -15,9 +15,12 @@
 </script>
 
 <script lang="ts">
-  import type { Day } from '../../../utils/types/arktype.js';
-
-  import { Days, formatDayLetter, formatDayShort } from '../../../utils/datetime/index.js';
+  import {
+    type Day,
+    Days,
+    formatDayLetter,
+    formatDayShort
+  } from '../../../utils/datetime/index.js';
 
   import ChoiceMulti from './ChoiceMulti.svelte';
 

package/dist/{components → shared/components}/ui/choice/WeekdayChoiceMulti.svelte.d.ts

@@ -9,7 +9,7 @@ export interface WeekdayChoiceMultiProps {
     value: Day[];
     vertical?: boolean;
 }
-import type { Day } from '../../../utils/types/arktype.js';
+import { type Day } from '../../../utils/datetime/index.js';
 declare const WeekdayChoiceMulti: import("svelte").Component<WeekdayChoiceMultiProps, {}, "value">;
 type WeekdayChoiceMulti = ReturnType<typeof WeekdayChoiceMulti>;
 export default WeekdayChoiceMulti;

package/dist/{components → shared/components}/ui/context-menu/ContextMenuContent.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-  import { cn } from '../../../shadcn/utils.js';
+  import { cn } from '../../../../shadcn/utils.js';
   import { getContext, onMount, type Snippet } from 'svelte';
   import { scale } from 'svelte/transition';
 

package/dist/{components → shared/components}/ui/context-menu/ContextMenuItem.svelte

@@ -1,7 +1,7 @@
 <script lang="ts">
   import type { HTMLAttributes } from 'svelte/elements';
 
-  import { cn } from '../../../shadcn/utils.js';
+  import { cn } from '../../../../shadcn/utils.js';
 
   interface Props extends HTMLAttributes<HTMLDivElement> {
     disabled?: boolean;

package/dist/{components → shared/components}/ui/search/SearchBar.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
-  import Input from '../../../shadcn/components/ui/input/input.svelte';
-  import { cn } from '../../../shadcn/utils.js';
+  import Input from '../../../../shadcn/components/ui/input/input.svelte';
+  import { cn } from '../../../../shadcn/utils.js';
   import { Search } from '@lucide/svelte';
 
   interface Props {

package/dist/{utils/types → shared/utils}/arktype.d.ts

@@ -1,18 +1,10 @@
 import type { Type } from 'arktype';
 import { CalendarDate as calendarImport, Time as timeImport } from '@internationalized/date';
-import { Days } from '../datetime/index.js';
+export declare const IntegerId: import("arktype/internal/variants/number.ts").NumberType<number, {}>;
 export declare const Phone: import("arktype/internal/variants/string.ts").StringType<string, {}>;
-/** Type string which is trimmed before narrowing the type checking */
-export declare function trimTo(typeTo: Type<string>): import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype/internal/attributes.ts").To<string>, {}>;
+export declare const HexColor: import("arktype/internal/variants/string.ts").StringType<string, {}>;
 export declare const Day: import("arktype/internal/variants/string.ts").StringType<"Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday", {}>;
-export type Day = (typeof Days)[number];
 export declare const Time: import("arktype/internal/variants/object.ts").ObjectType<timeImport, {}>;
 export declare const CalendarDate: import("arktype/internal/variants/object.ts").ObjectType<calendarImport, {}>;
-export declare const HexColor: import("arktype/internal/variants/string.ts").StringType<string, {}>;
-export declare const Email: import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype").Out<string>, {}>;
-export declare const Name: import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype").Out<string>, {}>;
-export declare const FirstName: import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype").Out<string>, {}>;
-export declare const LastName: import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype").Out<string>, {}>;
-export declare const Id: import("arktype/internal/variants/number.ts").NumberType<number, {}>;
-export declare const Password: import("arktype/internal/variants/string.ts").StringType<string, {}>;
-export declare const Duration: import("arktype/internal/variants/number.ts").NumberType<number, {}>;
+/** Type string which is trimmed before narrowing the type checking */
+export declare function trimTo(typeTo: Type<string>): import("arktype/internal/variants/object.ts").ObjectType<(In: string) => import("arktype/internal/attributes.ts").To<string>, {}>;

package/dist/shared/utils/arktype.js

@@ -0,0 +1,40 @@
+import { CalendarDate as calendarImport, Time as timeImport } from '@internationalized/date';
+import { type } from 'arktype';
+import { Days } from './datetime/index.js';
+// Useful common types
+export const IntegerId = type('number.integer >= 0');
+// Phone arktype: allows "+", digits, and spaces only
+export const Phone = type('string').narrow((value, ctx) => {
+    if (!/^[+0-9 ]+$/.test(value)) {
+        return ctx.reject({
+            problem: 'invalid phone number. Only +, digits, and spaces are allowed.'
+        });
+    }
+    return true;
+});
+export const HexColor = type('string').narrow((value, ctx) => {
+    // Regex explanation:
+    // ^           : start of string
+    // [0-9A-Fa-f]{3} : three hex digits (short form)
+    // ([0-9A-Fa-f]{3})? : optional three more digits (long form #RRGGBB)
+    // $           : end of string
+    if (!/^[0-9A-Fa-f]{3}([0-9A-Fa-f]{3})?$/.test(value)) {
+        return ctx.reject({
+            problem: 'invalid hex color value'
+        });
+    }
+    return true;
+});
+// Datetime types
+export const Day = type.enumerated(...Days);
+export const Time = type.instanceOf(timeImport).configure({
+    problem: () => 'invalid time'
+});
+export const CalendarDate = type.instanceOf(calendarImport).configure({
+    problem: () => 'invalid date'
+});
+// Arktype utilities
+/** Type string which is trimmed before narrowing the type checking */
+export function trimTo(typeTo) {
+    return type('string.trim').to(typeTo);
+}

package/dist/{utils → shared/utils}/datetime/datetime.spec.js

@@ -1,7 +1,20 @@
 import { CalendarDate, CalendarDateTime, Time, ZonedDateTime } from '@internationalized/date';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { ageFromDob, checkOverlap, dateDiffWeeks, datesWithin, formatAbsolute, formatDateFull, formatDateISO, formatDateNum, formatDateShort, formatDayLetter, formatDayShort, formatMonth, formatTimeEnd, formatTimeFull, formatTimeShort, getDayOfDate, getLastDateOfDay, getLastDatesOfDay, getLastMonths, getNextDateOfDay, isDateDay, isDateToday } from './index.js';
+import { checkOverlap, dateDiffWeeks, datesWithin, formatAbsolute, formatDateFull, formatDateISO, formatDateNum, formatDateShort, formatDayLetter, formatDayShort, formatMonth, formatTimeEnd, formatTimeFull, formatTimeShort, getDayIndex, getDayOfDate, getLastDateOfDay, getLastDatesOfDay, getLastMonths, getNextDateOfDay, isDateDay, LocalDateF } from './index.js';
 const SERVER_TIME_ZONE = 'Europe/London';
+const dt = new LocalDateF(SERVER_TIME_ZONE);
+describe('getDayIndex', () => {
+    it('returns the correct day index (0 = Monday)', () => {
+        // Test specific dates with known day indices
+        expect(getDayIndex(new CalendarDate(2023, 5, 1))).toBe(0); // May 1, 2023 was a Monday
+        expect(getDayIndex(new CalendarDate(2023, 5, 2))).toBe(1); // May 2, 2023 was a Tuesday
+        expect(getDayIndex(new CalendarDate(2023, 5, 3))).toBe(2); // May 3, 2023 was a Wednesday
+        expect(getDayIndex(new CalendarDate(2023, 5, 4))).toBe(3); // May 4, 2023 was a Thursday
+        expect(getDayIndex(new CalendarDate(2023, 5, 5))).toBe(4); // May 5, 2023 was a Friday
+        expect(getDayIndex(new CalendarDate(2023, 5, 6))).toBe(5); // May 6, 2023 was a Saturday
+        expect(getDayIndex(new CalendarDate(2023, 5, 7))).toBe(6); // May 7, 2023 was a Sunday
+    });
+});
 describe('getDayOfDate', () => {
     it('returns the correct day of the week (0 = Monday)', () => {
         // Test specific dates with known days of the week
@@ -64,30 +77,30 @@ describe('isDateToday', () => {
     });
     it('returns true when date is today', () => {
         const today = new CalendarDate(2024, 5, 15);
-        expect(isDateToday(today, SERVER_TIME_ZONE)).toBe(true);
+        expect(dt.isDateToday(today)).toBe(true);
     });
     it('returns false when date is in the past', () => {
         const yesterday = new CalendarDate(2024, 5, 14);
-        expect(isDateToday(yesterday, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(yesterday)).toBe(false);
         const lastMonth = new CalendarDate(2024, 4, 15);
-        expect(isDateToday(lastMonth, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(lastMonth)).toBe(false);
         const lastYear = new CalendarDate(2023, 5, 15);
-        expect(isDateToday(lastYear, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(lastYear)).toBe(false);
     });
     it('returns false when date is in the future', () => {
         const tomorrow = new CalendarDate(2024, 5, 16);
-        expect(isDateToday(tomorrow, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(tomorrow)).toBe(false);
         const nextMonth = new CalendarDate(2024, 6, 15);
-        expect(isDateToday(nextMonth, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(nextMonth)).toBe(false);
         const nextYear = new CalendarDate(2025, 5, 15);
-        expect(isDateToday(nextYear, SERVER_TIME_ZONE)).toBe(false);
+        expect(dt.isDateToday(nextYear)).toBe(false);
     });
     it('handles date comparison at day boundaries', () => {
         // Still the same day regardless of time of day
         vi.setSystemTime(new CalendarDateTime(2024, 5, 15, 0, 0, 1).toDate(SERVER_TIME_ZONE));
-        expect(isDateToday(new CalendarDate(2024, 5, 15), SERVER_TIME_ZONE)).toBe(true);
+        expect(dt.isDateToday(new CalendarDate(2024, 5, 15))).toBe(true);
         vi.setSystemTime(new CalendarDateTime(2024, 5, 15, 23, 59, 59).toDate(SERVER_TIME_ZONE));
-        expect(isDateToday(new CalendarDate(2024, 5, 15), SERVER_TIME_ZONE)).toBe(true);
+        expect(dt.isDateToday(new CalendarDate(2024, 5, 15))).toBe(true);
     });
 });
 describe('ageFromDob', () => {
@@ -102,35 +115,35 @@ describe('ageFromDob', () => {
     });
     it('should calculate age correctly for a normal case', () => {
         const dob = new CalendarDate(2000, 3, 30);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(25);
+        expect(dt.ageFromDob(dob)).toBe(25);
     });
     it('should calculate age correctly when birthday is today', () => {
         const dob = new CalendarDate(2000, 3, 30);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(25);
+        expect(dt.ageFromDob(dob)).toBe(25);
     });
     it('should calculate age correctly for someone born yesterday', () => {
         const dob = new CalendarDate(2000, 3, 29);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(25);
+        expect(dt.ageFromDob(dob)).toBe(25);
     });
     it('should calculate age correctly for someone born tomorrow', () => {
         const dob = new CalendarDate(2000, 3, 31);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(24);
+        expect(dt.ageFromDob(dob)).toBe(24);
     });
     it('should handle leap year birthdays', () => {
         const dob = new CalendarDate(2000, 2, 29);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(25);
+        expect(dt.ageFromDob(dob)).toBe(25);
     });
     it('should return undefined for future dates', () => {
         const futureDob = new CalendarDate(2026, 1, 1);
-        expect(() => ageFromDob(futureDob, SERVER_TIME_ZONE)).toThrow();
+        expect(() => dt.ageFromDob(futureDob)).toThrow();
     });
     it('should handle month boundary cases', () => {
         const dob = new CalendarDate(2000, 2, 28);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(25);
+        expect(dt.ageFromDob(dob)).toBe(25);
     });
     it('should handle year boundary cases', () => {
         const dob = new CalendarDate(2000, 12, 31);
-        expect(ageFromDob(dob, SERVER_TIME_ZONE)).toBe(24);
+        expect(dt.ageFromDob(dob)).toBe(24);
     });
 });
 describe('getNextDateOfDay', () => {

package/dist/{utils → shared/utils}/datetime/index.d.ts

@@ -1,15 +1,29 @@
 import type { Transport } from '@sveltejs/kit';
 import { CalendarDate, type DateDuration, Time, ZonedDateTime } from '@internationalized/date';
-import type { Day } from '../types/arktype.js';
 export declare const Days: readonly ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
+export type Day = (typeof Days)[number];
 export declare const DayIndex: Record<Day, number>;
-/**
- * Calculates the age from a date of birth.
- * @param dob - The date of birth.
- * @returns The age in years.
- * @throws Error if the date of birth is in the future.
- */
-export declare function ageFromDob(dob: CalendarDate, timezone: string): number;
+export declare class LocalDateF {
+    private readonly timezone;
+    constructor(timezone: string);
+    /**
+     * Calculates the age from a date of birth.
+     * @param dob - The date of birth.
+     * @returns The age in years.
+     * @throws Error if the date of birth is in the future.
+     */
+    ageFromDob(dob: CalendarDate): number;
+    /**
+     * Checks if a given date is today.
+     * @param date - The date to check.
+     * @returns True if the date is today, false otherwise.
+     */
+    isDateToday(date: CalendarDate): boolean;
+    /**
+     * @returns The current date.
+     */
+    today(): CalendarDate;
+}
 /**
  * Checks if two time ranges overlap, boundaries are not considered overlapping.
  * @param start1 - The start time of the first range.
@@ -73,12 +87,6 @@ export declare function getNextDateOfDay(dayOfWeek: Day, startDate: CalendarDate
  * @returns True if the date is the specified day, false otherwise.
  */
 export declare function isDateDay(date: CalendarDate, dayOfWeek: Day): boolean;
-/**
- * Checks if a given date is today.
- * @param date - The date to check.
- * @returns True if the date is today, false otherwise.
- */
-export declare function isDateToday(date: CalendarDate, timezone: string): boolean;
 /**
  * Calculates the difference in weeks between two dates.
  * @param date1 - The first date in order.