@ilamy/calendar 1.3.3 → 1.5.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Frequency, Weekday } from "rrule";
 import { RRule } from "rrule";
 import { Options } from "rrule";
+import { Dayjs } from "dayjs";
 /**
 * Re-rrule.js Options with practical TypeScript interface.
 * Makes all properties optional except freq and dtstart (which are required by RFC 5545).
@@ -21,9 +22,6 @@ type RRuleOptions = {
 	*/
 	dtstart: Date;
 } & Partial<Omit<Options, "freq" | "dtstart">>;
-import React4 from "react";
-import React3 from "react";
-import dayjs2 from "dayjs";
 /**
 * Core calendar event interface representing a single calendar event.
 * This is the primary data structure for calendar events.
@@ -34,9 +32,9 @@ interface CalendarEvent {
 	/** Display title of the event */
 	title: string;
 	/** Start date and time of the event */
-	start: dayjs2.Dayjs;
+	start: Dayjs;
 	/** End date and time of the event */
-	end: dayjs2.Dayjs;
+	end: Dayjs;
 	/**
 	* Color for the event (supports CSS color values, hex, rgb, hsl, or CSS class names)
 	* @example "#3b82f6", "blue-500", "rgb(59, 130, 246)"
@@ -129,10 +127,12 @@ interface EventFormProps {
 	onDelete?: (event: CalendarEvent) => void;
 	onClose: () => void;
 }
+import React4 from "react";
+import React3 from "react";
 /**
 * Public-facing resource calendar event interface with flexible date types.
 * Similar to IlamyCalendarPropEvent but with resource assignment fields.
-* Dates can be provided as dayjs.Dayjs, Date, or string and will be normalized internally.
+* Dates can be provided as Dayjs, Date, or string and will be normalized internally.
 *
 * @interface IlamyResourceCalendarPropEvent
 * @extends {IlamyCalendarPropEvent}
@@ -182,6 +182,12 @@ interface Resource {
 	* If provided, these will be used instead of the global business hours for this resource.
 	*/
 	businessHours?: BusinessHours | BusinessHours[];
+	/**
+	* Custom data associated with the resource
+	* Use this to store additional metadata specific to your application
+	* @example { avatar: 'https://example.com/avatar.png', role: 'admin' }
+	*/
+	data?: Record<string, any>;
 }
 interface Translations {
 	today: string;
@@ -312,18 +318,22 @@ interface CalendarClassesOverride {
 * @extends {Omit<CalendarEvent, 'start' | 'end'>}
 */
 interface IlamyCalendarPropEvent extends Omit<CalendarEvent, "start" | "end"> {
-	start: dayjs2.Dayjs | Date | string;
-	end: dayjs2.Dayjs | Date | string;
+	start: Dayjs | Date | string;
+	end: Dayjs | Date | string;
 }
 /**
 * Information passed to the onCellClick callback.
 * Uses named properties for extensibility.
 */
+interface DateRange {
+	start: Dayjs;
+	end: Dayjs;
+}
 interface CellClickInfo {
 	/** Start date/time of the clicked cell */
-	start: dayjs2.Dayjs;
+	start: Dayjs;
 	/** End date/time of the clicked cell */
-	end: dayjs2.Dayjs;
+	end: Dayjs;
 	/** Resource ID if clicking on a resource calendar cell (optional) */
 	resourceId?: string | number;
 	/** Whether the clicked cell is an all-day cell (optional) */
@@ -335,11 +345,11 @@ interface CellClickInfo {
 */
 interface RenderCurrentTimeIndicatorProps {
 	/** The current time as a dayjs object */
-	currentTime: dayjs2.Dayjs;
+	currentTime: Dayjs;
 	/** The start of the visible time range */
-	rangeStart: dayjs2.Dayjs;
+	rangeStart: Dayjs;
 	/** The end of the visible time range */
-	rangeEnd: dayjs2.Dayjs;
+	rangeEnd: Dayjs;
 	/** Progress percentage (0-100) representing position in the range */
 	progress: number;
 	/**
@@ -369,7 +379,7 @@ interface IlamyCalendarProps {
 	* The initial date to display when the calendar loads.
 	* If not provided, the calendar will default to today's date.
 	*/
-	initialDate?: dayjs2.Dayjs | Date | string;
+	initialDate?: Dayjs | Date | string;
 	/**
 	* Custom render function for calendar events.
 	* If provided, it will override the default event rendering.
@@ -407,9 +417,9 @@ interface IlamyCalendarProps {
 	onEventDelete?: (event: CalendarEvent) => void;
 	/**
 	* Callback when the current date changes (navigation).
-	* Provides the new current date.
+	* Provides the new current date and the current visible range.
 	*/
-	onDateChange?: (date: dayjs2.Dayjs) => void;
+	onDateChange?: (date: Dayjs, range: DateRange) => void;
 	/**
 	* Locale to use for formatting dates and times.
 	* If not provided, the default locale will be used.
@@ -535,30 +545,41 @@ interface IlamyCalendarProps {
 	* ```
 	*/
 	renderCurrentTimeIndicator?: (props: RenderCurrentTimeIndicatorProps) => React3.ReactNode;
+	/**
+	* Days of the week to hide from the week view.
+	* Hidden days won't render as columns, giving remaining days more space.
+	* Only applies to vertical week views (regular and resource vertical).
+	* Does not affect month, day, year, or resource horizontal week views.
+	* @default []
+	* @example ['saturday', 'sunday'] // Hide weekends
+	*/
+	hiddenDays?: WeekDays[];
 }
 declare const IlamyCalendar: React4.FC<IlamyCalendarProps>;
 declare const isRecurringEvent: (event: CalendarEvent) => boolean;
 interface GenerateRecurringEventsProps {
 	event: CalendarEvent;
 	currentEvents: CalendarEvent[];
-	startDate: dayjs2.Dayjs;
-	endDate: dayjs2.Dayjs;
+	startDate: Dayjs;
+	endDate: Dayjs;
 }
 declare const generateRecurringEvents: ({ event, currentEvents, startDate, endDate }: GenerateRecurringEventsProps) => CalendarEvent[];
+import React5 from "react";
+declare const IlamyResourceCalendar: React5.FC<IlamyResourceCalendarProps>;
 /**
-* Simplified calendar context type for external use
-* Contains only the most commonly used calendar operations
+* Publicly exposed calendar context properties.
 */
 interface UseIlamyCalendarContextReturn {
-	readonly currentDate: dayjs2.Dayjs;
+	readonly currentDate: Dayjs;
 	readonly view: CalendarView;
 	readonly events: CalendarEvent[];
 	readonly isEventFormOpen: boolean;
 	readonly selectedEvent: CalendarEvent | null;
-	readonly selectedDate: dayjs2.Dayjs | null;
+	readonly selectedDate: Dayjs | null;
 	readonly firstDayOfWeek: number;
-	readonly setCurrentDate: (date: dayjs2.Dayjs) => void;
-	readonly selectDate: (date: dayjs2.Dayjs) => void;
+	readonly resources: Resource[];
+	readonly setCurrentDate: (date: Dayjs) => void;
+	readonly selectDate: (date: Dayjs) => void;
 	readonly setView: (view: CalendarView) => void;
 	readonly nextPeriod: () => void;
 	readonly prevPeriod: () => void;
@@ -568,19 +589,13 @@ interface UseIlamyCalendarContextReturn {
 	readonly deleteEvent: (eventId: string | number) => void;
 	readonly openEventForm: (eventData?: Partial<CalendarEvent>) => void;
 	readonly closeEventForm: () => void;
+	readonly getEventsForResource: (resourceId: string | number) => CalendarEvent[];
 	readonly businessHours?: BusinessHours | BusinessHours[];
 }
-declare const useIlamyCalendarContext: () => UseIlamyCalendarContextReturn;
-import React5 from "react";
-declare const IlamyResourceCalendar: React5.FC<IlamyResourceCalendarProps>;
 /**
-* Simplified resource calendar context type for external use
+* Public hook exported for library users.
+* Returns a limited set of commonly used properties and methods.
 */
-interface UseIlamyResourceCalendarContextReturn extends UseIlamyCalendarContextReturn {
-	readonly events: CalendarEvent[];
-	readonly resources: Resource[];
-	readonly getEventsForResource: (resourceId: string | number) => CalendarEvent[];
-}
-declare const useIlamyResourceCalendarContext: () => UseIlamyResourceCalendarContextReturn;
+declare function useIlamyCalendarContext(): UseIlamyCalendarContextReturn;
 declare const defaultTranslations: Translations;
-export { useIlamyResourceCalendarContext, useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, defaultTranslations, Weekday, WeekDays, UseIlamyResourceCalendarContextReturn, UseIlamyCalendarContextReturn, TranslatorFunction, Translations, TranslationKey, TimeFormat, Resource, RenderCurrentTimeIndicatorProps, RRuleOptions, RRule, IlamyResourceCalendarProps, IlamyResourceCalendar, IlamyCalendarProps, IlamyCalendar, Frequency, EventFormProps, CellClickInfo, CalendarView, CalendarEvent, BusinessHours };
+export { useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, defaultTranslations, Weekday, WeekDays, UseIlamyCalendarContextReturn, TranslatorFunction, Translations, TranslationKey, TimeFormat, Resource, RenderCurrentTimeIndicatorProps, RRuleOptions, RRule, IlamyResourceCalendarProps, IlamyResourceCalendar, IlamyCalendarProps, IlamyCalendar, Frequency, EventFormProps, CellClickInfo, CalendarView, CalendarEvent, BusinessHours };