@ilamy/calendar 1.0.1 → 1.1.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import React3 from "react";
+import React4 from "react";
+import dayjs from "dayjs";
 import { Options } from "rrule";
 /**
 * Re-rrule.js Options with practical TypeScript interface.
@@ -80,6 +81,10 @@ interface CalendarEvent {
 	* Unique identifier across calendar systems
 	*/
 	uid?: string;
+	/** Single resource assignment */
+	resourceId?: string | number;
+	/** Multiple resource assignment (cross-resource events) */
+	resourceIds?: (string | number)[];
 	/**
 	* Custom data associated with the event
 	* Use this to store additional metadata specific to your application
@@ -92,7 +97,36 @@ interface CalendarEvent {
 * Used for setting the first day of the week and other week-related settings.
 */
 type WeekDays = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";
-import React2 from "react";
+/**
+* Configuration for business hours.
+* Defines the working hours to be highlighted on the calendar.
+*/
+interface BusinessHours {
+	/**
+	* Days of the week to apply business hours to.
+	* @default ['monday', 'tuesday', 'wednesday', 'thursday', 'friday']
+	*/
+	daysOfWeek?: WeekDays[];
+	/**
+	* Start time for business hours in 24-hour format (0-24).
+	* @default 9
+	*/
+	startTime?: number;
+	/**
+	* End time for business hours in 24-hour format (0-24).
+	* @default 17
+	*/
+	endTime?: number;
+}
+interface EventFormProps {
+	open?: boolean;
+	selectedEvent?: CalendarEvent | null;
+	onAdd?: (event: CalendarEvent) => void;
+	onUpdate?: (event: CalendarEvent) => void;
+	onDelete?: (event: CalendarEvent) => void;
+	onClose: () => void;
+}
+import React3 from "react";
 interface Translations {
 	today: string;
 	create: string;
@@ -193,6 +227,14 @@ interface Translations {
 type TranslationKey = keyof Translations;
 type TranslatorFunction = (key: TranslationKey | string) => string;
 /**
+* Available calendar view types.
+*/
+type CalendarView = "month" | "week" | "day" | "year";
+/**
+* Time format options for displaying times in the calendar.
+*/
+type TimeFormat = "12-hour" | "24-hour";
+/**
 * This interface extends the base CalendarEvent but allows more flexible date types
 * for the start and end properties. The component will automatically convert these
 * to dayjs objects internally for consistent date handling.
@@ -204,6 +246,18 @@ interface IlamyCalendarPropEvent extends Omit<CalendarEvent, "start" | "end"> {
 	start: dayjs.Dayjs | Date | string;
 	end: dayjs.Dayjs | Date | string;
 }
+/**
+* Information passed to the onCellClick callback.
+* Uses named properties for extensibility.
+*/
+interface CellClickInfo {
+	/** Start date/time of the clicked cell */
+	start: dayjs.Dayjs;
+	/** End date/time of the clicked cell */
+	end: dayjs.Dayjs;
+	/** Resource ID if clicking on a resource calendar cell (optional) */
+	resourceId?: string | number;
+}
 interface IlamyCalendarProps {
 	/**
 	* Array of events to display in the calendar.
@@ -218,12 +272,17 @@ interface IlamyCalendarProps {
 	* The initial view to display when the calendar loads.
 	* Defaults to 'month'.
 	*/
-	initialView?: "month" | "week" | "day" | "year";
+	initialView?: CalendarView;
+	/**
+	* The initial date to display when the calendar loads.
+	* If not provided, the calendar will default to today's date.
+	*/
+	initialDate?: dayjs.Dayjs | Date | string;
 	/**
 	* Custom render function for calendar events.
 	* If provided, it will override the default event rendering.
 	*/
-	renderEvent?: (event: CalendarEvent) => React2.ReactNode;
+	renderEvent?: (event: CalendarEvent) => React3.ReactNode;
 	/**
 	* Callback when an event is clicked.
 	* Provides the clicked event object.
@@ -231,14 +290,14 @@ interface IlamyCalendarProps {
 	onEventClick?: (event: CalendarEvent) => void;
 	/**
 	* Callback when a calendar cell is clicked.
-	* Provides the start and end date of the clicked cell.
+	* Provides cell information including start/end dates and optional resourceId.
 	*/
-	onCellClick?: (start: dayjs.Dayjs, end: dayjs.Dayjs) => void;
+	onCellClick?: (info: CellClickInfo) => void;
 	/**
 	* Callback when the calendar view changes (month, week, day, year).
 	* Useful for syncing with external state or analytics.
 	*/
-	onViewChange?: (view: "month" | "week" | "day" | "year") => void;
+	onViewChange?: (view: CalendarView) => void;
 	/**
 	* Callback when a new event is added to the calendar.
 	* Provides the newly created event object.
@@ -314,18 +373,49 @@ interface IlamyCalendarProps {
 	* Custom header component to replace the default calendar header.
 	* Useful for adding custom branding or additional controls.
 	*/
-	headerComponent?: React2.ReactNode;
+	headerComponent?: React3.ReactNode;
 	/**
 	* Custom class name for the calendar header.
 	* Useful for applying custom styles to the header.
 	*/
 	headerClassName?: string;
+	/**
+	* Configuration for business hours.
+	* Defines the working hours to be highlighted on the calendar.
+	*/
+	businessHours?: BusinessHours;
+	/**
+	* Custom render function for the event form.
+	* If provided, it will override the default event form component.
+	* The function receives EventFormProps and should return a React node.
+	*/
+	renderEventForm?: (props: EventFormProps) => React3.ReactNode;
+	/**
+	* Time format for displaying times in the calendar.
+	* - "12-hour": Times displayed as "1:00 PM" (default)
+	* - "24-hour": Times displayed as "13:00"
+	*/
+	timeFormat?: TimeFormat;
 }
-declare const IlamyCalendar: React3.FC<IlamyCalendarProps>;
-import React4 from "react";
-interface IlamyResourceCalendarProps extends IlamyCalendarProps {
+declare const IlamyCalendar: React4.FC<IlamyCalendarProps>;
+import React5 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.
+*
+* @interface IlamyResourceCalendarPropEvent
+* @extends {IlamyCalendarPropEvent}
+*/
+interface IlamyResourceCalendarPropEvent extends IlamyCalendarPropEvent {
+	/** Single resource assignment */
+	resourceId?: string | number;
+	/** Multiple resource assignment (cross-resource events) */
+	resourceIds?: (string | number)[];
+}
+interface IlamyResourceCalendarProps extends Omit<IlamyCalendarProps, "events"> {
 	/** Array of events to display */
-	events?: ResourceCalendarEvent[];
+	events?: IlamyResourceCalendarPropEvent[];
 	/** Array of resources */
 	resources?: Resource[];
 	/** Custom render function for resources */
@@ -352,23 +442,14 @@ interface Resource {
 	/** Optional position for resource display */
 	position?: number;
 }
-/**
-* Resource calendar event interface extending CalendarEvent with resource assignment
-*/
-interface ResourceCalendarEvent extends CalendarEvent {
-	/** Single resource assignment */
-	resourceId?: string | number;
-	/** Multiple resource assignment (cross-resource events) */
-	resourceIds?: (string | number)[];
-}
-declare const IlamyResourceCalendar: React4.FC<IlamyResourceCalendarProps>;
+declare const IlamyResourceCalendar: React5.FC<IlamyResourceCalendarProps>;
 /**
 * Simplified calendar context type for external use
 * Contains only the most commonly used calendar operations
 */
 interface UseIlamyCalendarContextReturn {
 	readonly currentDate: dayjs.Dayjs;
-	readonly view: "month" | "week" | "day" | "year";
+	readonly view: CalendarView;
 	readonly events: CalendarEvent[];
 	readonly isEventFormOpen: boolean;
 	readonly selectedEvent: CalendarEvent | null;
@@ -376,24 +457,25 @@ interface UseIlamyCalendarContextReturn {
 	readonly firstDayOfWeek: number;
 	readonly setCurrentDate: (date: dayjs.Dayjs) => void;
 	readonly selectDate: (date: dayjs.Dayjs) => void;
-	readonly setView: (view: "month" | "week" | "day" | "year") => void;
+	readonly setView: (view: CalendarView) => void;
 	readonly nextPeriod: () => void;
 	readonly prevPeriod: () => void;
 	readonly today: () => void;
 	readonly addEvent: (event: CalendarEvent) => void;
 	readonly updateEvent: (eventId: string | number, event: Partial<CalendarEvent>) => void;
 	readonly deleteEvent: (eventId: string | number) => void;
-	readonly openEventForm: (date?: dayjs.Dayjs) => void;
+	readonly openEventForm: (eventData?: Partial<CalendarEvent>) => void;
 	readonly closeEventForm: () => void;
+	readonly businessHours?: BusinessHours;
 }
 declare const useIlamyCalendarContext: () => UseIlamyCalendarContextReturn;
 /**
 * Simplified resource calendar context type for external use
 */
 interface UseIlamyResourceCalendarContextReturn extends UseIlamyCalendarContextReturn {
-	readonly events: ResourceCalendarEvent[];
+	readonly events: CalendarEvent[];
 	readonly resources: Resource[];
-	readonly getEventsForResource: (resourceId: string | number) => ResourceCalendarEvent[];
+	readonly getEventsForResource: (resourceId: string | number) => CalendarEvent[];
 }
 declare const useIlamyResourceCalendarContext: () => UseIlamyResourceCalendarContextReturn;
 declare const isRecurringEvent: (event: CalendarEvent) => boolean;
@@ -407,4 +489,4 @@ declare const generateRecurringEvents: ({ event, currentEvents, startDate, endDa
 import { Frequency, Weekday } from "rrule";
 import { RRule } from "rrule";
 declare const defaultTranslations: Translations;
-export { useIlamyResourceCalendarContext, useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, defaultTranslations, Weekday, WeekDays, UseIlamyResourceCalendarContextReturn, UseIlamyCalendarContextReturn, TranslatorFunction, Translations, TranslationKey, ResourceCalendarEvent, Resource, RRuleOptions, RRule, IlamyResourceCalendarProps, IlamyResourceCalendar, IlamyCalendarProps, IlamyCalendar, Frequency, CalendarEvent };
+export { useIlamyResourceCalendarContext, useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, defaultTranslations, Weekday, WeekDays, UseIlamyResourceCalendarContextReturn, UseIlamyCalendarContextReturn, TranslatorFunction, Translations, TranslationKey, TimeFormat, Resource, RRuleOptions, RRule, IlamyResourceCalendarProps, IlamyResourceCalendar, IlamyCalendarProps, IlamyCalendar, Frequency, EventFormProps, CellClickInfo, CalendarView, CalendarEvent };