@forcecalendar/core 2.4.0 → 2.5.0

package/core/calendar/Calendar.js

@@ -178,9 +178,12 @@ export class Calendar {
 
   /**
    * Update an event
-   * @param {string} eventId - The event ID
+   *
+   * An occurrence id taken from view data (see {@link Event.occurrenceId})
+   * updates the recurring master, i.e. the whole series.
+   * @param {string} eventId - Event id or occurrence id
    * @param {Object} updates - Properties to update
-   * @returns {Event} The updated event
+   * @returns {Event} The updated event (the master for an occurrence id)
    */
   updateEvent(eventId, updates) {
     const oldEvent = this.eventStore.getEvent(eventId);
@@ -193,7 +196,10 @@ export class Calendar {
 
   /**
    * Remove an event
-   * @param {string} eventId - The event ID
+   *
+   * An occurrence id taken from view data (see {@link Event.occurrenceId})
+   * removes the recurring master, i.e. the whole series.
+   * @param {string} eventId - Event id or occurrence id
    * @returns {boolean} True if removed
    */
   removeEvent(eventId) {
@@ -218,15 +224,19 @@ export class Calendar {
 
   /**
    * Get an event by ID
-   * @param {string} eventId - The event ID
-   * @returns {Event|null}
+   *
+   * Occurrence ids taken from view data (`<masterId>_<startMs>`, see
+   * {@link Event.occurrenceId}) resolve to the stored recurring master, so
+   * every id a renderer hands back can be looked up here.
+   * @param {string} eventId - Event id or occurrence id
+   * @returns {Event|null} The stored event (the master for an occurrence id) or null
    */
   getEvent(eventId) {
     return this.eventStore.getEvent(eventId);
   }
 
   /**
-   * Get all events
+   * Get all stored events (recurring masters, never their occurrences)
    * @returns {Event[]}
    */
   getEvents() {
@@ -344,7 +354,7 @@ export class Calendar {
   }
 
   /**
-   * Get events for a specific date
+   * Get events for a specific date, with recurring series expanded into occurrences
    * @param {Date} date - The date
    * @param {string} [timezone] - Timezone for the query (defaults to calendar timezone)
    * @returns {Event[]}
@@ -353,6 +363,20 @@ export class Calendar {
     return this.eventStore.getEventsForDate(date, timezone || this.config.timeZone);
   }
 
+  /**
+   * Get the events for every day in a range, keyed by local date (YYYY-MM-DD)
+   *
+   * Recurring series are expanded once for the whole range; this is what the
+   * month and week views use. See `EventStore.getEventsByDate`.
+   * @param {Date} start - First day of the range
+   * @param {Date} end - Last day of the range
+   * @param {string} [timezone] - Timezone for the query (defaults to calendar timezone)
+   * @returns {Map<string, Event[]>} Local date string -> events on that day
+   */
+  getEventsByDate(start, end, timezone = null) {
+    return this.eventStore.getEventsByDate(start, end, timezone || this.config.timeZone);
+  }
+
   /**
    * Get events in a date range
    * @param {Date} start - Start date
@@ -364,6 +388,64 @@ export class Calendar {
     return this.eventStore.getEventsInRange(start, end, true, timezone || this.config.timeZone);
   }
 
+  /**
+   * Lazily iterate the occurrences of an event in chronological order.
+   *
+   * Occurrences are produced one at a time, so taking the next few of an
+   * open-ended series does not expand the series. `after` and `before`
+   * are exclusive unless `inclusive` is set; see
+   * RecurrenceEngineV2.iterateOccurrences for the full semantics.
+   *
+   * @example
+   * for (const occurrence of calendar.iterateOccurrences('standup', { after: new Date() })) {
+   *   if (occurrence.start > deadline) break;
+   *   remind(occurrence);
+   * }
+   *
+   * @param {string} eventId - The event ID
+   * @param {import('../types.js').ExpandedOccurrenceIteratorOptions} [options={}] - Window and expansion options
+   * @returns {Generator<import('../types.js').ExpandedOccurrence, void, undefined>} Occurrences in chronological order
+   * @throws {Error} If no event with the ID exists
+   */
+  iterateOccurrences(eventId, options = {}) {
+    return this.eventStore.iterateOccurrences(eventId, options);
+  }
+
+  /**
+   * First occurrence of an event after an instant, or null when the
+   * series has no occurrence after it. `after` is exclusive unless
+   * `options.inclusive` is set.
+   *
+   * @example
+   * const upcoming = calendar.getNextOccurrence('standup', new Date());
+   *
+   * @param {string} eventId - The event ID
+   * @param {Date|number} [after=null] - Instant to search from (defaults to the series start)
+   * @param {import('../types.js').ExpandedOccurrenceIteratorOptions} [options={}] - Further options
+   * @returns {import('../types.js').ExpandedOccurrence|null} The next occurrence, or null
+   * @throws {Error} If no event with the ID exists
+   */
+  getNextOccurrence(eventId, after = null, options = {}) {
+    return this.eventStore.getNextOccurrence(eventId, after, options);
+  }
+
+  /**
+   * The first `count` occurrences of an event inside a window, generated
+   * lazily. `count` is capped at the engine's MAX_OCCURRENCES_HARD_LIMIT.
+   *
+   * @example
+   * const nextFive = calendar.takeOccurrences('standup', 5, { after: new Date() });
+   *
+   * @param {string} eventId - The event ID
+   * @param {number} count - Maximum number of occurrences to return
+   * @param {import('../types.js').ExpandedOccurrenceIteratorOptions} [options={}] - Window and expansion options
+   * @returns {import('../types.js').ExpandedOccurrence[]} Up to `count` occurrences in chronological order
+   * @throws {Error} If no event with the ID exists
+   */
+  takeOccurrences(eventId, count, options = {}) {
+    return this.eventStore.takeOccurrences(eventId, count, options);
+  }
+
   /**
    * Set the calendar's timezone
    * @param {string} timezone - IANA timezone identifier
@@ -529,6 +611,12 @@ export class Calendar {
       ? 6
       : Math.ceil((lastDay.getDate() + DateUtils.getDayOfWeek(firstDay, weekStartsOn)) / 7);
 
+    // Expand recurring series once for the whole grid, not once per cell
+    const eventsByDate = this.getEventsByDate(
+      startDate,
+      DateUtils.addDays(startDate, maxWeeks * 7 - 1)
+    );
+
     for (let weekIndex = 0; weekIndex < maxWeeks; weekIndex++) {
       const week = {
         weekNumber: DateUtils.getWeekNumber(currentDate),
@@ -547,7 +635,7 @@ export class Calendar {
           isCurrentMonth,
           isToday,
           isWeekend,
-          events: this.getEventsForDate(dayDate)
+          events: eventsByDate.get(DateUtils.getLocalDateString(dayDate)) || []
         });
 
         // Use DateUtils.addDays to handle month boundaries correctly
@@ -580,8 +668,12 @@ export class Calendar {
     const days = [];
     const currentDate = new Date(startDate);
 
+    // Expand recurring series once for the whole week, not once per day
+    const eventsByDate = this.getEventsByDate(startDate, endDate);
+
     for (let i = 0; i < 7; i++) {
       const dayDate = new Date(currentDate);
+      const events = eventsByDate.get(DateUtils.getLocalDateString(dayDate)) || [];
       days.push({
         date: dayDate,
         dayOfMonth: dayDate.getDate(),
@@ -589,9 +681,9 @@ export class Calendar {
         dayName: DateUtils.getDayName(dayDate, this.state.get('locale')),
         isToday: DateUtils.isToday(dayDate),
         isWeekend: dayDate.getDay() === 0 || dayDate.getDay() === 6,
-        events: this.getEventsForDate(dayDate),
+        events,
         // Add overlap groups for positioning overlapping events
-        overlapGroups: this.eventStore.getOverlapGroups(dayDate, true),
+        overlapGroups: this.eventStore.groupOverlappingEvents(events, true),
         getEventPositions: events => this.eventStore.calculateEventPositions(events)
       });
       // Move to next day

package/core/events/Event.js

@@ -325,6 +325,16 @@ export class Event {
     this.recurring = normalized.recurring;
     this.recurrenceRule = normalized.recurrenceRule;
 
+    // Occurrence identity. Set by EventStore.expandRecurringEvent on the
+    // instances it derives from a recurring series; stored events keep the
+    // defaults. The id of an occurrence is Event.occurrenceId(master, start).
+    /** @type {boolean} True when this instance is one occurrence of a recurring series */
+    this.isOccurrence = false;
+    /** @type {string|null} Id of the recurring master this occurrence belongs to */
+    this.recurringEventId = null;
+    /** @type {Date|null} Start of this occurrence as generated by the recurrence rule */
+    this.occurrenceStart = null;
+
     // Store original timezone from system if not provided
     this._originalTimeZone = normalized.timeZone || null;
 
@@ -721,6 +731,57 @@ export class Event {
     return true;
   }
 
+  /**
+   * Build the id of one occurrence of a recurring series.
+   *
+   * The id is `<recurringEventId>_<startMs>` where `startMs` is the
+   * occurrence start as returned by `Date.prototype.getTime()`. It is
+   * deterministic, so the same occurrence gets the same id no matter which
+   * range it was expanded for, and it matches the ids generated by
+   * `RecurrenceEngineV2`. Use {@link Event.parseOccurrenceId} to get the
+   * master id back.
+   *
+   * @example
+   * Event.occurrenceId('standup', new Date(2025, 5, 16, 9)); // 'standup_1750028400000'
+   *
+   * @param {string} recurringEventId - Id of the recurring master event
+   * @param {Date|number|string} occurrenceStart - Start of the occurrence
+   * @returns {string} Occurrence id
+   */
+  static occurrenceId(recurringEventId, occurrenceStart) {
+    const start = occurrenceStart instanceof Date ? occurrenceStart : new Date(occurrenceStart);
+    return `${recurringEventId}_${start.getTime()}`;
+  }
+
+  /**
+   * Split an occurrence id built by {@link Event.occurrenceId} into the master
+   * id and the occurrence start.
+   *
+   * Returns `null` for ids that do not have the `<id>_<startMs>` shape. A
+   * positive result only means the id is well-formed; whether the master
+   * exists is for the caller (see `EventStore.getEvent`) to check.
+   *
+   * @param {string} id - Candidate occurrence id
+   * @returns {{recurringEventId: string, occurrenceStart: Date}|null} Parsed parts or null
+   */
+  static parseOccurrenceId(id) {
+    if (typeof id !== 'string') {
+      return null;
+    }
+    const separator = id.lastIndexOf('_');
+    if (separator <= 0 || separator === id.length - 1) {
+      return null;
+    }
+    const time = id.slice(separator + 1);
+    if (!/^-?\d+$/.test(time)) {
+      return null;
+    }
+    return {
+      recurringEventId: id.slice(0, separator),
+      occurrenceStart: new Date(Number(time))
+    };
+  }
+
   // ============ Attendee Management Methods ============
 
   /**