@super-calendar/core 2.5.0 → 2.6.0

package/dist/index.d.mts

@@ -2,9 +2,9 @@ import { Locale } from "date-fns";
 import { Dispatch, SetStateAction } from "react";
 //#region src/types.d.ts
 /** The view the calendar renders: a day-column grid (`day`, `3days`, `week`, `custom`), the `month` grid, or the `schedule` list. */
-type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule";
+type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule" | "year";
 /** The time-grid modes (day-column views, excluding month and schedule). */
-type TimeGridMode = Exclude<CalendarMode, "month" | "schedule">;
+type TimeGridMode = Exclude<CalendarMode, "month" | "schedule" | "year">;
 /**
  * The minimal shape every calendar event must have. Layout (positioning,
  * overlap resolution, paging) only ever reads `start`/`end`; `title` is used by
@@ -311,6 +311,8 @@ declare const getIsToday: (date: Date) => boolean;
 declare const isSameCalendarDay: (a: Date, b: Date) => boolean;
 /** Minutes elapsed since midnight (0–1439). */
 declare const minutesIntoDay: (date: Date) => number;
+/** The twelve month anchors (first-of-month) of `date`'s year, January first. */
+declare const getYearMonths: (date: Date) => Date[];
 //#endregion
 //#region src/utils/drag.d.ts
 /**
@@ -709,4 +711,4 @@ declare function zonedTimeToUtc(wallClock: Date, timeZone: string): Date;
  */
 declare function eventsInTimeZone<T>(events: CalendarEvent<T>[], timeZone: string): CalendarEvent<T>[];
 //#endregion
-export { BusinessHours, CalendarColors, CalendarEvent, CalendarMode, CalendarSelection, CalendarSelectionProvider, DateRange, DateSelectionConstraints, DayBadgeKind, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventChipLayout, EventKeyExtractor, ICalEvent, ICalendarEvent, MIN_BOX_HEIGHT_FOR_TIME, MonthEventCapacity, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, PositionedEvent, RangeBandKind, RecurrenceFrequency, RecurrenceRule, TimeGridMode, ToICalendarOptions, UseDateRangeOptions, UseDateRangeResult, UseMonthGridOptions, WeekStartsOn, WeekdayFormat, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };
+export { BusinessHours, CalendarColors, CalendarEvent, CalendarMode, CalendarSelection, CalendarSelectionProvider, DateRange, DateSelectionConstraints, DayBadgeKind, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventChipLayout, EventKeyExtractor, ICalEvent, ICalendarEvent, MIN_BOX_HEIGHT_FOR_TIME, MonthEventCapacity, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, PositionedEvent, RangeBandKind, RecurrenceFrequency, RecurrenceRule, TimeGridMode, ToICalendarOptions, UseDateRangeOptions, UseDateRangeResult, UseMonthGridOptions, WeekStartsOn, WeekdayFormat, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, getYearMonths, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };

package/dist/index.d.ts

@@ -2,9 +2,9 @@ import { Dispatch, SetStateAction } from "react";
 import { Locale } from "date-fns";
 //#region src/types.d.ts
 /** The view the calendar renders: a day-column grid (`day`, `3days`, `week`, `custom`), the `month` grid, or the `schedule` list. */
-type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule";
+type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule" | "year";
 /** The time-grid modes (day-column views, excluding month and schedule). */
-type TimeGridMode = Exclude<CalendarMode, "month" | "schedule">;
+type TimeGridMode = Exclude<CalendarMode, "month" | "schedule" | "year">;
 /**
  * The minimal shape every calendar event must have. Layout (positioning,
  * overlap resolution, paging) only ever reads `start`/`end`; `title` is used by
@@ -311,6 +311,8 @@ declare const getIsToday: (date: Date) => boolean;
 declare const isSameCalendarDay: (a: Date, b: Date) => boolean;
 /** Minutes elapsed since midnight (0–1439). */
 declare const minutesIntoDay: (date: Date) => number;
+/** The twelve month anchors (first-of-month) of `date`'s year, January first. */
+declare const getYearMonths: (date: Date) => Date[];
 //#endregion
 //#region src/utils/drag.d.ts
 /**
@@ -709,4 +711,4 @@ declare function zonedTimeToUtc(wallClock: Date, timeZone: string): Date;
  */
 declare function eventsInTimeZone<T>(events: CalendarEvent<T>[], timeZone: string): CalendarEvent<T>[];
 //#endregion
-export { BusinessHours, CalendarColors, CalendarEvent, CalendarMode, CalendarSelection, CalendarSelectionProvider, DateRange, DateSelectionConstraints, DayBadgeKind, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventChipLayout, EventKeyExtractor, ICalEvent, ICalendarEvent, MIN_BOX_HEIGHT_FOR_TIME, MonthEventCapacity, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, PositionedEvent, RangeBandKind, RecurrenceFrequency, RecurrenceRule, TimeGridMode, ToICalendarOptions, UseDateRangeOptions, UseDateRangeResult, UseMonthGridOptions, WeekStartsOn, WeekdayFormat, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };
+export { BusinessHours, CalendarColors, CalendarEvent, CalendarMode, CalendarSelection, CalendarSelectionProvider, DateRange, DateSelectionConstraints, DayBadgeKind, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventChipLayout, EventKeyExtractor, ICalEvent, ICalendarEvent, MIN_BOX_HEIGHT_FOR_TIME, MonthEventCapacity, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, PositionedEvent, RangeBandKind, RecurrenceFrequency, RecurrenceRule, TimeGridMode, ToICalendarOptions, UseDateRangeOptions, UseDateRangeResult, UseMonthGridOptions, WeekStartsOn, WeekdayFormat, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, getYearMonths, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };

package/dist/index.js

@@ -145,6 +145,8 @@ const getIsToday = (date) => (0, date_fns.isToday)(date);
 const isSameCalendarDay = (a, b) => (0, date_fns.isSameDay)(a, b);
 /** Minutes elapsed since midnight (0–1439). */
 const minutesIntoDay = (date) => (0, date_fns.getHours)(date) * 60 + (0, date_fns.getMinutes)(date);
+/** The twelve month anchors (first-of-month) of `date`'s year, January first. */
+const getYearMonths = (date) => Array.from({ length: 12 }, (_, i) => new Date(date.getFullYear(), i, 1));
 //#endregion
 //#region src/utils/dateRange.ts
 /** Whether `date` passes the min/max/disabled constraints (compared by calendar day). */
@@ -1215,6 +1217,7 @@ exports.formatHour = formatHour;
 exports.getIsToday = getIsToday;
 exports.getViewDays = getViewDays;
 exports.getWeekDays = getWeekDays;
+exports.getYearMonths = getYearMonths;
 exports.groupEventsByDay = groupEventsByDay;
 exports.isAllDayEvent = isAllDayEvent;
 exports.isDateSelectable = isDateSelectable;

package/dist/index.mjs

@@ -144,6 +144,8 @@ const getIsToday = (date) => isToday(date);
 const isSameCalendarDay = (a, b) => isSameDay(a, b);
 /** Minutes elapsed since midnight (0–1439). */
 const minutesIntoDay = (date) => getHours(date) * 60 + getMinutes(date);
+/** The twelve month anchors (first-of-month) of `date`'s year, January first. */
+const getYearMonths = (date) => Array.from({ length: 12 }, (_, i) => new Date(date.getFullYear(), i, 1));
 //#endregion
 //#region src/utils/dateRange.ts
 /** Whether `date` passes the min/max/disabled constraints (compared by calendar day). */
@@ -1193,4 +1195,4 @@ function expandRecurringEvents(events, rangeStart, rangeEnd) {
 	return out;
 }
 //#endregion
-export { CalendarSelectionProvider, MIN_BOX_HEIGHT_FOR_TIME, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };
+export { CalendarSelectionProvider, MIN_BOX_HEIGHT_FOR_TIME, bandRounding, buildMonthGrid, buildMonthWeeks, cellRangeFromDrag, closedHourBands, compareDayEvents, darkColors, dayBadgeKind, daySelectionState, eventAccessibilityLabel, eventChipLayout, eventDayKeys, eventTimeLabel, eventsInTimeZone, expandRecurringEvents, formatHour, getIsToday, getViewDays, getWeekDays, getYearMonths, groupEventsByDay, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isTimeVisibleAtHeight, isWeekend, isWithinDateRange, layoutDayEvents, lightColors, minutesIntoDay, monthEventCapacity, monthVisibleCount, nextDateRange, parseICalendar, rangeBandKind, resolveDraggedBounds, shiftMinutes, snapDeltaMinutes, titleEllipsizeMode, titleNumberOfLines, toICalendar, toZonedTime, useCalendarSelection, useDateRange, useMonthGrid, viewDayCount, weekDaysCount, weekdayFormatToken, zonedTimeToUtc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@super-calendar/core",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Render-agnostic core for super-calendar: date math, selection model, event layout, the month-grid builder, headless hooks, and neutral theme tokens. No renderer.",
   "keywords": [
     "calendar",

package/src/types.ts

@@ -1,8 +1,8 @@
 /** The view the calendar renders: a day-column grid (`day`, `3days`, `week`, `custom`), the `month` grid, or the `schedule` list. */
-export type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule";
+export type CalendarMode = "day" | "3days" | "week" | "custom" | "month" | "schedule" | "year";
 
 /** The time-grid modes (day-column views, excluding month and schedule). */
-export type TimeGridMode = Exclude<CalendarMode, "month" | "schedule">;
+export type TimeGridMode = Exclude<CalendarMode, "month" | "schedule" | "year">;
 
 /**
  * The minimal shape every calendar event must have. Layout (positioning,

package/src/utils/dates.ts

@@ -119,3 +119,7 @@ export const isSameCalendarDay = (a: Date, b: Date): boolean => isSameDay(a, b);
 
 /** Minutes elapsed since midnight (0–1439). */
 export const minutesIntoDay = (date: Date): number => getHours(date) * 60 + getMinutes(date);
+
+/** The twelve month anchors (first-of-month) of `date`'s year, January first. */
+export const getYearMonths = (date: Date): Date[] =>
+  Array.from({ length: 12 }, (_, i) => new Date(date.getFullYear(), i, 1));