ical-generator 11.1.4-develop.2 → 11.1.4-develop.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,4 +1,6 @@
1
- //#region src/attendee.d.ts
1
+ /**
2
+ * ical-generator entrypoint
3
+ */
2
4
  export declare enum ICalAttendeeRole {
3
5
  CHAIR = "CHAIR",
4
6
  NON = "NON-PARTICIPANT",
@@ -324,8 +326,6 @@ declare class ICalAttendee {
324
326
  value: string;
325
327
  }[];
326
328
  }
327
- //#endregion
328
- //#region src/types.d.ts
329
329
  export declare enum ICalEventRepeatingFreq {
330
330
  DAILY = "DAILY",
331
331
  HOURLY = "HOURLY",
@@ -503,8 +503,6 @@ interface ICalTZDateStub extends Date {
503
503
  timeZone?: string;
504
504
  withTimeZone(timezone?: null | string): ICalTZDateStub;
505
505
  }
506
- //#endregion
507
- //#region src/alarm.d.ts
508
506
  export declare enum ICalAlarmType {
509
507
  audio = "audio",
510
508
  display = "display",
@@ -899,8 +897,6 @@ declare class ICalAlarm {
899
897
  value: string;
900
898
  }[];
901
899
  }
902
- //#endregion
903
- //#region src/category.d.ts
904
900
  interface ICalCategoryData {
905
901
  name: string;
906
902
  }
@@ -959,8 +955,6 @@ declare class ICalCategory {
959
955
  */
960
956
  toString(): string;
961
957
  }
962
- //#endregion
963
- //#region src/event.d.ts
964
958
  export declare enum ICalEventBusyStatus {
965
959
  BUSY = "BUSY",
966
960
  FREE = "FREE",
@@ -1533,6 +1527,11 @@ declare class ICalEvent {
1533
1527
  * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
1534
1528
  * for details about supported values and timezone handling.
1535
1529
  *
1530
+ * For all-day events, the recurrence id is emitted as an RFC 5545 DATE
1531
+ * value (`RECURRENCE-ID;VALUE=DATE:YYYYMMDD`), matching the event's
1532
+ * `DTSTART;VALUE=DATE` format. For timed events, the usual date-time
1533
+ * format is used.
1534
+ *
1536
1535
  * @since 0.2.0
1537
1536
  */
1538
1537
  recurrenceId(recurrenceId: ICalDateTimeValue | null): this;
@@ -1594,6 +1593,45 @@ declare class ICalEvent {
1594
1593
  * END:VCALENDAR
1595
1594
  * ```
1596
1595
  *
1596
+ * For all-day events, the `until` date is emitted as an RFC 5545 DATE value
1597
+ * (`UNTIL=YYYYMMDD` without time), matching the event's `DTSTART;VALUE=DATE`
1598
+ * format:
1599
+ *
1600
+ * ```typescript
1601
+ * import ical, { ICalEventRepeatingFreq } from 'ical-generator';
1602
+ *
1603
+ * const cal = ical();
1604
+ *
1605
+ * const event = cal.createEvent({
1606
+ * allDay: true,
1607
+ * start: new Date('2025-03-10'),
1608
+ * summary: 'Repeating All-Day Event'
1609
+ * });
1610
+ * event.repeating({
1611
+ * freq: ICalEventRepeatingFreq.WEEKLY,
1612
+ * until: new Date('2025-03-24')
1613
+ * });
1614
+ *
1615
+ * cal.toString();
1616
+ * ```
1617
+ *
1618
+ * ```text
1619
+ * BEGIN:VCALENDAR
1620
+ * VERSION:2.0
1621
+ * PRODID:-//sebbo.net//ical-generator//EN
1622
+ * BEGIN:VEVENT
1623
+ * UID:d21d3ff4-73c2-4e12-ae45-fb1baf488292
1624
+ * SEQUENCE:0
1625
+ * DTSTAMP:20261116T171008Z
1626
+ * DTSTART;VALUE=DATE:20250310
1627
+ * X-MICROSOFT-CDO-ALLDAYEVENT:TRUE
1628
+ * X-MICROSOFT-MSNCALENDAR-ALLDAYEVENT:TRUE
1629
+ * RRULE:FREQ=WEEKLY;UNTIL=20250324
1630
+ * SUMMARY:Repeating All-Day Event
1631
+ * END:VEVENT
1632
+ * END:VCALENDAR
1633
+ * ```
1634
+ *
1597
1635
  * @since 0.2.0
1598
1636
  */
1599
1637
  repeating(repeating: ICalRepeatingOptions | null): this;
@@ -1967,8 +2005,6 @@ declare class ICalEvent {
1967
2005
  */
1968
2006
  private swapStartAndEndIfRequired;
1969
2007
  }
1970
- //#endregion
1971
- //#region src/calendar.d.ts
1972
2008
  export declare enum ICalCalendarMethod {
1973
2009
  ADD = "ADD",
1974
2010
  CANCEL = "CANCEL",
@@ -2466,8 +2502,6 @@ declare class ICalCalendar {
2466
2502
  value: string;
2467
2503
  }[];
2468
2504
  }
2469
- //#endregion
2470
- //#region src/tools.d.ts
2471
2505
  /**
2472
2506
  * Escapes special characters in the given string. `inQuotes` selects the
2473
2507
  * parameter value encoding (RFC 6868), otherwise the TEXT escaping of
@@ -2488,8 +2522,6 @@ export declare function formatDateTZ(timezone: null | string, property: string,
2488
2522
  floating?: boolean | null;
2489
2523
  timezone?: null | string;
2490
2524
  }): string;
2491
- //#endregion
2492
- //#region src/index.d.ts
2493
2525
  /**
2494
2526
  * Create a new, empty calendar and returns it.
2495
2527
  *
@@ -2524,6 +2556,4 @@ export declare function formatDateTZ(timezone: null | string, property: string,
2524
2556
  * @param data Calendar data
2525
2557
  */
2526
2558
  declare function ical(data?: ICalCalendarData): ICalCalendar;
2527
- //#endregion
2528
- export { ICalAlarm, type ICalAlarmBaseData, type ICalAlarmData, type ICalAlarmJSONData, type ICalAlarmRepeatData, type ICalAlarmTriggerAfterData, type ICalAlarmTriggerBeforeData, type ICalAlarmTriggerData, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, type ICalAttendeeScheduleAgent, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, type ICalEventData, type ICalEventJSONData, type ICalEventJSONRepeatingData, type ICalEventTravelTime, type ICalGeo, type ICalLocation, type ICalLocationWithTitle, type ICalLocationWithoutTitle, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTZDateStub, type ICalTemporalInstantStub, type ICalTemporalPlainDateStub, type ICalTemporalPlainDateTimeStub, type ICalTemporalZonedDateTimeStub, type ICalTimezone, ical as default };
2529
- //# sourceMappingURL=index.d.cts.map
2559
+ export { ICalAlarm, type ICalAlarmBaseData, type ICalAlarmData, type ICalAlarmJSONData, type ICalAlarmRepeatData, type ICalAlarmTriggerAfterData, type ICalAlarmTriggerBeforeData, type ICalAlarmTriggerData, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, type ICalAttendeeScheduleAgent, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, type ICalEventData, type ICalEventJSONData, type ICalEventJSONRepeatingData, type ICalEventTravelTime, type ICalGeo, type ICalLocation, type ICalLocationWithTitle, type ICalLocationWithoutTitle, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTZDateStub, type ICalTemporalInstantStub, type ICalTemporalPlainDateStub, type ICalTemporalPlainDateTimeStub, type ICalTemporalZonedDateTimeStub, type ICalTimezone, ical as default };
package/dist/index.d.mts CHANGED
@@ -1,4 +1,6 @@
1
- //#region src/attendee.d.ts
1
+ /**
2
+ * ical-generator entrypoint
3
+ */
2
4
  export declare enum ICalAttendeeRole {
3
5
  CHAIR = "CHAIR",
4
6
  NON = "NON-PARTICIPANT",
@@ -324,8 +326,6 @@ declare class ICalAttendee {
324
326
  value: string;
325
327
  }[];
326
328
  }
327
- //#endregion
328
- //#region src/types.d.ts
329
329
  export declare enum ICalEventRepeatingFreq {
330
330
  DAILY = "DAILY",
331
331
  HOURLY = "HOURLY",
@@ -503,8 +503,6 @@ interface ICalTZDateStub extends Date {
503
503
  timeZone?: string;
504
504
  withTimeZone(timezone?: null | string): ICalTZDateStub;
505
505
  }
506
- //#endregion
507
- //#region src/alarm.d.ts
508
506
  export declare enum ICalAlarmType {
509
507
  audio = "audio",
510
508
  display = "display",
@@ -899,8 +897,6 @@ declare class ICalAlarm {
899
897
  value: string;
900
898
  }[];
901
899
  }
902
- //#endregion
903
- //#region src/category.d.ts
904
900
  interface ICalCategoryData {
905
901
  name: string;
906
902
  }
@@ -959,8 +955,6 @@ declare class ICalCategory {
959
955
  */
960
956
  toString(): string;
961
957
  }
962
- //#endregion
963
- //#region src/event.d.ts
964
958
  export declare enum ICalEventBusyStatus {
965
959
  BUSY = "BUSY",
966
960
  FREE = "FREE",
@@ -1533,6 +1527,11 @@ declare class ICalEvent {
1533
1527
  * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
1534
1528
  * for details about supported values and timezone handling.
1535
1529
  *
1530
+ * For all-day events, the recurrence id is emitted as an RFC 5545 DATE
1531
+ * value (`RECURRENCE-ID;VALUE=DATE:YYYYMMDD`), matching the event's
1532
+ * `DTSTART;VALUE=DATE` format. For timed events, the usual date-time
1533
+ * format is used.
1534
+ *
1536
1535
  * @since 0.2.0
1537
1536
  */
1538
1537
  recurrenceId(recurrenceId: ICalDateTimeValue | null): this;
@@ -1594,6 +1593,45 @@ declare class ICalEvent {
1594
1593
  * END:VCALENDAR
1595
1594
  * ```
1596
1595
  *
1596
+ * For all-day events, the `until` date is emitted as an RFC 5545 DATE value
1597
+ * (`UNTIL=YYYYMMDD` without time), matching the event's `DTSTART;VALUE=DATE`
1598
+ * format:
1599
+ *
1600
+ * ```typescript
1601
+ * import ical, { ICalEventRepeatingFreq } from 'ical-generator';
1602
+ *
1603
+ * const cal = ical();
1604
+ *
1605
+ * const event = cal.createEvent({
1606
+ * allDay: true,
1607
+ * start: new Date('2025-03-10'),
1608
+ * summary: 'Repeating All-Day Event'
1609
+ * });
1610
+ * event.repeating({
1611
+ * freq: ICalEventRepeatingFreq.WEEKLY,
1612
+ * until: new Date('2025-03-24')
1613
+ * });
1614
+ *
1615
+ * cal.toString();
1616
+ * ```
1617
+ *
1618
+ * ```text
1619
+ * BEGIN:VCALENDAR
1620
+ * VERSION:2.0
1621
+ * PRODID:-//sebbo.net//ical-generator//EN
1622
+ * BEGIN:VEVENT
1623
+ * UID:d21d3ff4-73c2-4e12-ae45-fb1baf488292
1624
+ * SEQUENCE:0
1625
+ * DTSTAMP:20261116T171008Z
1626
+ * DTSTART;VALUE=DATE:20250310
1627
+ * X-MICROSOFT-CDO-ALLDAYEVENT:TRUE
1628
+ * X-MICROSOFT-MSNCALENDAR-ALLDAYEVENT:TRUE
1629
+ * RRULE:FREQ=WEEKLY;UNTIL=20250324
1630
+ * SUMMARY:Repeating All-Day Event
1631
+ * END:VEVENT
1632
+ * END:VCALENDAR
1633
+ * ```
1634
+ *
1597
1635
  * @since 0.2.0
1598
1636
  */
1599
1637
  repeating(repeating: ICalRepeatingOptions | null): this;
@@ -1967,8 +2005,6 @@ declare class ICalEvent {
1967
2005
  */
1968
2006
  private swapStartAndEndIfRequired;
1969
2007
  }
1970
- //#endregion
1971
- //#region src/calendar.d.ts
1972
2008
  export declare enum ICalCalendarMethod {
1973
2009
  ADD = "ADD",
1974
2010
  CANCEL = "CANCEL",
@@ -2466,8 +2502,6 @@ declare class ICalCalendar {
2466
2502
  value: string;
2467
2503
  }[];
2468
2504
  }
2469
- //#endregion
2470
- //#region src/tools.d.ts
2471
2505
  /**
2472
2506
  * Escapes special characters in the given string. `inQuotes` selects the
2473
2507
  * parameter value encoding (RFC 6868), otherwise the TEXT escaping of
@@ -2488,8 +2522,6 @@ export declare function formatDateTZ(timezone: null | string, property: string,
2488
2522
  floating?: boolean | null;
2489
2523
  timezone?: null | string;
2490
2524
  }): string;
2491
- //#endregion
2492
- //#region src/index.d.ts
2493
2525
  /**
2494
2526
  * Create a new, empty calendar and returns it.
2495
2527
  *
@@ -2524,6 +2556,4 @@ export declare function formatDateTZ(timezone: null | string, property: string,
2524
2556
  * @param data Calendar data
2525
2557
  */
2526
2558
  declare function ical(data?: ICalCalendarData): ICalCalendar;
2527
- //#endregion
2528
- export { ICalAlarm, type ICalAlarmBaseData, type ICalAlarmData, type ICalAlarmJSONData, type ICalAlarmRepeatData, type ICalAlarmTriggerAfterData, type ICalAlarmTriggerBeforeData, type ICalAlarmTriggerData, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, type ICalAttendeeScheduleAgent, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, type ICalEventData, type ICalEventJSONData, type ICalEventJSONRepeatingData, type ICalEventTravelTime, type ICalGeo, type ICalLocation, type ICalLocationWithTitle, type ICalLocationWithoutTitle, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTZDateStub, type ICalTemporalInstantStub, type ICalTemporalPlainDateStub, type ICalTemporalPlainDateTimeStub, type ICalTemporalZonedDateTimeStub, type ICalTimezone, ical as default };
2529
- //# sourceMappingURL=index.d.mts.map
2559
+ export { ICalAlarm, type ICalAlarmBaseData, type ICalAlarmData, type ICalAlarmJSONData, type ICalAlarmRepeatData, type ICalAlarmTriggerAfterData, type ICalAlarmTriggerBeforeData, type ICalAlarmTriggerData, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, type ICalAttendeeScheduleAgent, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, type ICalEventData, type ICalEventJSONData, type ICalEventJSONRepeatingData, type ICalEventTravelTime, type ICalGeo, type ICalLocation, type ICalLocationWithTitle, type ICalLocationWithoutTitle, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTZDateStub, type ICalTemporalInstantStub, type ICalTemporalPlainDateStub, type ICalTemporalPlainDateTimeStub, type ICalTemporalZonedDateTimeStub, type ICalTimezone, ical as default };
package/dist/index.mjs CHANGED
@@ -35,11 +35,12 @@ let e=/* @__PURE__ */ function(e){return e.DAILY=`DAILY`,e.HOURLY=`HOURLY`,e.MIN
35
35
  `).filter(e=>e&&!e.startsWith(`DTSTART:`)).join(`\r
36
36
  `);!t.includes(`\r
37
37
  `)&&!t.startsWith(`RRULE:`)&&(t=`RRULE:`+t),e+=t.trim()+`\r
38
- `}else this.data.repeating&&(e+=`RRULE:FREQ=`+this.data.repeating.freq,this.data.repeating.count&&(e+=`;COUNT=`+this.data.repeating.count),this.data.repeating.interval&&(e+=`;INTERVAL=`+this.data.repeating.interval),this.data.repeating.until&&(e+=`;UNTIL=`+d(this.calendar.timezone(),this.data.repeating.until,!1,this.floating())),this.data.repeating.byDay&&(e+=`;BYDAY=`+this.data.repeating.byDay.join(`,`)),this.data.repeating.byMonth&&(e+=`;BYMONTH=`+this.data.repeating.byMonth.join(`,`)),this.data.repeating.byMonthDay&&(e+=`;BYMONTHDAY=`+this.data.repeating.byMonthDay.join(`,`)),this.data.repeating.bySetPos&&(e+=`;BYSETPOS=`+this.data.repeating.bySetPos.join(`,`)),this.data.repeating.startOfWeek&&(e+=`;WKST=`+this.data.repeating.startOfWeek),e+=`\r
38
+ `}else this.data.repeating&&(e+=`RRULE:FREQ=`+this.data.repeating.freq,this.data.repeating.count&&(e+=`;COUNT=`+this.data.repeating.count),this.data.repeating.interval&&(e+=`;INTERVAL=`+this.data.repeating.interval),this.data.repeating.until&&(this.data.allDay?e+=`;UNTIL=`+d(this.timezone(),this.data.repeating.until,!0):e+=`;UNTIL=`+d(this.calendar.timezone(),this.data.repeating.until,!1,this.floating())),this.data.repeating.byDay&&(e+=`;BYDAY=`+this.data.repeating.byDay.join(`,`)),this.data.repeating.byMonth&&(e+=`;BYMONTH=`+this.data.repeating.byMonth.join(`,`)),this.data.repeating.byMonthDay&&(e+=`;BYMONTHDAY=`+this.data.repeating.byMonthDay.join(`,`)),this.data.repeating.bySetPos&&(e+=`;BYSETPOS=`+this.data.repeating.bySetPos.join(`,`)),this.data.repeating.startOfWeek&&(e+=`;WKST=`+this.data.repeating.startOfWeek),e+=`\r
39
39
  `,this.data.repeating.exclude&&(this.data.allDay?e+=`EXDATE;VALUE=DATE:`+this.data.repeating.exclude.map(e=>d(this.calendar.timezone(),e,!0)).join(`,`)+`\r
40
40
  `:(e+=`EXDATE`,this.timezone()?e+=`;TZID=`+this.timezone()+`:`+this.data.repeating.exclude.map(e=>d(this.timezone(),e,!1,!0)).join(`,`)+`\r
41
41
  `:e+=`:`+this.data.repeating.exclude.map(e=>d(this.timezone(),e,!1,this.floating())).join(`,`)+`\r
42
- `)));if(this.data.recurrenceId&&(e+=f(this.timezone(),`RECURRENCE-ID`,this.data.recurrenceId,this.data)+`\r
42
+ `)));if(this.data.recurrenceId&&(this.data.allDay?e+=`RECURRENCE-ID;VALUE=DATE:`+d(this.timezone(),this.data.recurrenceId,!0)+`\r
43
+ `:e+=f(this.timezone(),`RECURRENCE-ID`,this.data.recurrenceId,this.data)+`\r
43
44
  `),e+=`SUMMARY:`+c(this.data.summary,!1)+`\r
44
45
  `,this.data.transparency&&(e+=`TRANSP:`+c(this.data.transparency,!1)+`\r
45
46
  `),this.data.location&&`title`in this.data.location&&this.data.location.title&&(e+=`LOCATION:`+c(this.data.location.title+(this.data.location.address?`