ical-generator 4.0.0 → 4.1.0-develop.2

package/package.json

@@ -9,19 +9,19 @@
   "description": "ical-generator is a small piece of code which generates ical calendar files",
   "devDependencies": {
     "@qiwi/semantic-release-gh-pages-plugin": "^5.2.5",
-    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/npm": "^9.0.2",
+    "@semantic-release/npm": "^10.0.3",
     "@touch4it/ical-timezones": "^1.9.0",
-    "@types/luxon": "^3.2.0",
+    "@types/luxon": "^3.3.0",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.15.3",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
+    "@types/node": "^18.15.11",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
     "c8": "^7.11.3",
     "dayjs": "^1.11.7",
-    "eslint": "^8.36.0",
+    "eslint": "^8.37.0",
     "eslint-plugin-jsonc": "^2.7.0",
     "esm": "^3.2.25",
     "license-checker": "^25.0.1",
@@ -29,17 +29,17 @@
     "mocha": "^10.2.0",
     "mochawesome": "^7.1.3",
     "moment": "^2.29.4",
-    "moment-timezone": "^0.5.41",
+    "moment-timezone": "^0.5.43",
     "nyc": "^15.1.0",
     "portfinder": "^1.0.32",
     "rrule": "^2.7.2",
-    "semantic-release": "^20.1.3",
+    "semantic-release": "^21.0.1",
     "semantic-release-license": "^1.0.2",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
     "tsup": "^6.7.0",
     "typedoc": "^0.23.28",
-    "typescript": "^5.0.2"
+    "typescript": "^5.0.4"
   },
   "engines": {
     "node": "^14.8.0 || >=16.0.0"
@@ -128,5 +128,5 @@
     "test": "mocha"
   },
   "type": "module",
-  "version": "4.0.0"
+  "version": "4.1.0-develop.2"
 }

package/src/alarm.ts

@@ -18,6 +18,13 @@ export enum ICalAlarmType {
     audio = 'audio'
 }
 
+export const ICalAlarmRelatesTo = {
+    end: 'END',
+    start: 'START'
+} as const;
+
+export type ICalAlarmRelatesTo = typeof ICalAlarmRelatesTo[keyof typeof ICalAlarmRelatesTo];
+
 export type ICalAlarmTypeValue = keyof ICalAlarmType;
 
 export interface ICalAttachment {
@@ -28,6 +35,7 @@ export interface ICalAttachment {
 export interface ICalAlarmData {
     type?: ICalAlarmType | null;
     trigger?: number | ICalDateTimeValue | null;
+    relatesTo?: ICalAlarmRelatesTo | null;
     triggerBefore?: number | ICalDateTimeValue | null;
     triggerAfter?: number | ICalDateTimeValue | null;
     repeat?: number | null;
@@ -40,6 +48,7 @@ export interface ICalAlarmData {
 interface ICalInternalAlarmData {
     type: ICalAlarmType | null;
     trigger: ICalDateTimeValue | number | null;
+    relatesTo: ICalAlarmRelatesTo | null;
     repeat: number | null;
     interval: number | null;
     attach: ICalAttachment | null;
@@ -50,6 +59,7 @@ interface ICalInternalAlarmData {
 export interface ICalAlarmJSONData {
     type: ICalAlarmType | null;
     trigger: string | number | null;
+    relatesTo: ICalAlarmRelatesTo | null;
     repeat: number | null;
     interval: number | null;
     attach: ICalAttachment | null;
@@ -91,6 +101,7 @@ export default class ICalAlarm {
         this.data = {
             type: null,
             trigger: null,
+            relatesTo: null,
             repeat: null,
             interval: null,
             attach: null,
@@ -205,6 +216,55 @@ export default class ICalAlarm {
         return this;
     }
 
+    /**
+     * Get to which time alarm trigger relates to.
+     * Can be either `START` or `END`. If the value is
+     * `START` the alarm is triggerd relative to the event start time.
+     * If the value is `END` the alarm is triggerd relative to the event end time
+     * 
+     * @since 4.0.1
+     */
+    relatesTo(): ICalAlarmRelatesTo | null;
+
+    /**
+     * Use this method to set to which time alarm trigger relates to.
+     * Works only if trigger is a `number`
+     * 
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     * const alarm = cal.createAlarm();
+     *
+     * alarm.trigger(600); // -> 10 minutes before event starts
+     * 
+     * alarm.relatesTo('START'); // -> 10 minutes before event starts
+     * alarm.relatesTo('END'); // -> 10 minutes before event ends
+     * 
+     * alarm.trigger(-600); // -> 10 minutes after event starts
+     * 
+     * alarm.relatesTo('START'); // -> 10 minutes after event starts
+     * alarm.relatesTo('END'); // -> 10 minutes after event ends
+     * ```
+     * @since 4.0.1
+     */
+    relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
+    relatesTo(relatesTo?: ICalAlarmRelatesTo | null): this | ICalAlarmRelatesTo | null {
+        if (relatesTo === undefined) {
+            return this.data.relatesTo;
+        }
+        if (!relatesTo) {
+            this.data.relatesTo = null;
+            return this;
+        }
+
+        if (!Object.values(ICalAlarmRelatesTo).includes(relatesTo)) {
+            throw new Error('`relatesTo` is not correct, must be either `START` or `END`!');
+        }
+
+        this.data.relatesTo = relatesTo;
+        return this;
+    }
+
 
     /**
      * Get the trigger time for the alarm. Can either
@@ -569,11 +629,16 @@ export default class ICalAlarm {
         // ACTION
         g += 'ACTION:' + this.data.type.toUpperCase() + '\r\n';
 
-        if (typeof this.data.trigger === 'number' && this.data.trigger > 0) {
-            g += 'TRIGGER;RELATED=END:' + toDurationString(this.data.trigger) + '\r\n';
-        }
+        if (typeof this.data.trigger === 'number' && this.data.relatesTo === null) {
+            if (this.data.trigger > 0) {
+                g += 'TRIGGER;RELATED=END:' + toDurationString(this.data.trigger) + '\r\n';
+            }
+            else {
+                g += 'TRIGGER:' + toDurationString(this.data.trigger) + '\r\n';
+            }
+        } 
         else if (typeof this.data.trigger === 'number') {
-            g += 'TRIGGER:' + toDurationString(this.data.trigger) + '\r\n';
+            g += 'TRIGGER;RELATED=' + this.data.relatesTo.toUpperCase() + ':' + toDurationString(this.data.trigger) + '\r\n';
         }
         else {
             g += 'TRIGGER;VALUE=DATE-TIME:' + formatDate(this.event.timezone(), this.data.trigger) + '\r\n';

package/src/event.ts

@@ -1086,7 +1086,7 @@ export default class ICalEvent {
      *
      * ```javascript
      * import ical, {ICalEventBusyStatus} from 'ical-generator';
-     * event.busystatus(ICalEventStatus.BUSY);
+     * event.busystatus(ICalEventBusyStatus.BUSY);
      * ```
      *
      * @since 1.0.2