ical-generator 1.12.2 → 1.15.1

package/CHANGELOG.md

@@ -4,6 +4,27 @@ _The following document documents changes to this library. Changes to the depend
 
 <br />
 
+## [1.15.1](https://github.com/sebbo2002/ical-generator/releases/tag/1.15.1) - 2020-10-03
+### Bugfix
+- Typings: OPT_PARTICIPANT should be OPT-PARTICIPANT (#192)
+
+## [1.15.0](https://github.com/sebbo2002/ical-generator/releases/tag/1.15.0) - 2020-08-24
+### Feature
+- Events: Add WKST support
+
+
+## [1.14.0](https://github.com/sebbo2002/ical-generator/releases/tag/1.14.0) - 2020-08-18
+### Bugfix
+- Make x key optional in types (#211)
+
+### Feature
+- Events: Use provided timezone when constructing `repeating.exclude`
+
+
+## [1.13.0](https://github.com/sebbo2002/ical-generator/releases/tag/1.13.0) - 2020-08-12
+### Feature
+- Made Event.domain optional
+
 ## [1.12.2](https://github.com/sebbo2002/ical-generator/releases/tag/1.12.2) - 2020-08-11
 ### Bugfix
 - Don't modify input to createEvent()

package/README.md

@@ -125,8 +125,8 @@ cal.domain('sebbo.net');
 
 #### domain([_String_ domain])
 
-Use this method to set your server's hostname. It will be used to generate the feed's UID. Default hostname is your
-server's one (`require('os').hostname()`).
+Use this method to set your server's hostname. If provided, it will be used to generate the feed's UID.
+`require('os').hostname()` can be used to get your server's hostname.
 
 
 #### prodId([_String_|_Object_ prodId])
@@ -289,7 +289,10 @@ Empty the Calender.
 
 #### uid([_String_|_Number_ uid]) or id([_String_|_Number_ id])
 
-Use this method to set the event's ID. If not set, an UID will be generated randomly.  When output, the ID will be suffixed with '@' + your calendar's domain.
+Use this method to set the event's ID. If not set, an UID will be generated randomly.
+If your calendar's domain is provided, the ID will be suffixed with '@' + your calendar's domain.
+If you do not provide a calendar domain, generating an ID using the
+[uuid](https://www.npmjs.com/package/uuid) module is recommended.
 
 
 #### sequence([_Number_ sequence])
@@ -355,7 +358,8 @@ event.repeating({
     byMonthDay: [1, 15], // repeat only on the 1st and 15th
     bySetPos: 3, // repeat every 3rd sunday (will take the first element of the byDay array)
     exclude: [new Date('Dec 25 2013 00:00:00 UTC')], // exclude these dates
-    excludeTimezone: 'Europe/Berlin' // timezone of exclude
+    excludeTimezone: 'Europe/Berlin', // timezone of exclude
+    wkst: 'SU' // Start the week on Sunday, default is Monday
 });
 ```
 

package/dist/event.js

@@ -510,7 +510,13 @@ var ICalEvent = /*#__PURE__*/function () {
         c._data.repeating.exclude = [];
         exclude.forEach(function (excludedDate, i) {
           if (typeof excludedDate === 'string') {
-            excludedDate = moment(excludedDate);
+            var timezone = _repeating.excludeTimezone || c._calendar._data.timezone;
+
+            if (timezone) {
+              excludedDate = moment.tz(excludedDate, timezone);
+            } else {
+              excludedDate = moment(excludedDate);
+            }
           } else if (excludedDate instanceof Date) {
             excludedDate = moment(excludedDate);
           } else if (!moment.isMoment(excludedDate)) {
@@ -533,6 +539,16 @@ var ICalEvent = /*#__PURE__*/function () {
         c._data.repeating.excludeTimezone = _repeating.excludeTimezone;
       }
 
+      if (_repeating.wkst) {
+        var wkst = _repeating.wkst;
+
+        if (['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA'].indexOf(wkst) === -1) {
+          throw new Error('`repeating.wkst` contains invalid value `' + wkst + '`!');
+        }
+
+        c._data.repeating.wkst = wkst;
+      }
+
       return c;
     }
     /**
@@ -1101,7 +1117,15 @@ var ICalEvent = /*#__PURE__*/function () {
 
 
       g += 'BEGIN:VEVENT\r\n';
-      g += 'UID:' + this._data.id + '@' + this._calendar.domain() + '\r\n'; // SEQUENCE
+
+      var domain = this._calendar.domain();
+
+      if (domain) {
+        g += 'UID:' + this._data.id + '@' + domain + '\r\n';
+      } else {
+        g += 'UID:' + this._data.id + '\r\n';
+      } // SEQUENCE
+
 
       g += 'SEQUENCE:' + this._data.sequence + '\r\n';
       g += 'DTSTAMP:' + ICalTools.formatDate(this._calendar.timezone(), this._data.stamp) + '\r\n';
@@ -1155,6 +1179,10 @@ var ICalEvent = /*#__PURE__*/function () {
           g += ';BYSETPOS=' + this._data.repeating.bySetPos;
         }
 
+        if (this._data.repeating.wkst) {
+          g += ';WKST=' + this._data.repeating.wkst;
+        }
+
         g += '\r\n'; // REPEATING EXCLUSION
 
         if (this._data.repeating.exclude) {

package/index.d.ts

@@ -17,10 +17,10 @@ declare module 'ical-generator' {
     type status = 'CONFIRMED' | 'TENTATIVE' | 'CANCELLED';
     type busystatus = 'FREE' | 'TENTATIVE' | 'BUSY' | 'OOF';
     type day = 'SU' | 'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA';
-    type attendeeRole = 'CHAIR' | 'REQ-PARTICIPANT' | 'OPT_PARTICIPANT' | 'NON-PARTICIPANT';
-    type attendeeStatus = 'ACCEPTED' | 'TENTATIVE'| 'DECLINED'| 'DELEGATED' | 'NEEDS-ACTION';
-    type attendeeRsvp = 'true' | 'false'| true| false;
-    type attendeeType = 'INDIVIDUAL'| 'GROUP'| 'RESOURCE'| 'ROOM'| 'UNKNOWN';
+    type attendeeRole = 'CHAIR' | 'REQ-PARTICIPANT' | 'OPT-PARTICIPANT' | 'NON-PARTICIPANT';
+    type attendeeStatus = 'ACCEPTED' | 'TENTATIVE' | 'DECLINED' | 'DELEGATED' | 'NEEDS-ACTION';
+    type attendeeRsvp = 'true' | 'false' | true | false;
+    type attendeeType = 'INDIVIDUAL' | 'GROUP' | 'RESOURCE' | 'ROOM' | 'UNKNOWN';
     type alarmType = 'display' | 'audio';
 
 
@@ -81,7 +81,7 @@ declare module 'ical-generator' {
       timezone?: string;
       recurrenceId?: moment.Moment | Date | string;
       transparency?: string;
-      x: { key:string, value:string }[];
+      x?: { key: string, value: string }[];
     }
 
     interface RepeatingData {
@@ -94,6 +94,7 @@ declare module 'ical-generator' {
       byMonthDay?: number[];
       bySetPos?: number;
       exclude?: moment.Moment[] | Date[] | string[];
+      wkst?: day;
     }
 
     /**
@@ -192,7 +193,7 @@ declare module 'ical-generator' {
       sequence(): number;
       sequence(sequence: number): ICalEvent;
       start(): moment.Moment;
-      start(start: string | moment.Moment |  Date): ICalEvent;
+      start(start: string | moment.Moment | Date): ICalEvent;
       end(): moment.Moment;
       end(end: string | moment.Moment | Date): ICalEvent;
       recurrenceId(): moment.Moment;

package/package.json

@@ -14,21 +14,21 @@
     "moment-timezone": "^0.5.31"
   },
   "devDependencies": {
-    "@babel/cli": "^7.10.5",
-    "@babel/core": "^7.11.1",
-    "@babel/preset-env": "^7.11.0",
+    "@babel/cli": "^7.11.6",
+    "@babel/core": "^7.11.6",
+    "@babel/preset-env": "^7.11.5",
     "babel-loader": "^8.1.0",
-    "babel-plugin-add-module-exports": "^1.0.2",
-    "eslint": "^7.6.0",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "eslint": "^7.10.0",
     "jquery": "^3.5.1",
     "jshint": "^2.12.0",
-    "mocha": "^8.1.1",
+    "mocha": "^8.1.3",
     "mochawesome": "^6.1.1",
-    "moment": "^2.27.0",
+    "moment": "^2.29.0",
     "npm-check": "^5.9.2",
     "nyc": "^15.1.0",
     "portfinder": "^1.0.28",
-    "webpack": "^4.44.1",
+    "webpack": "^4.44.2",
     "webpack-cli": "^3.3.12"
   },
   "peerDependencies": {
@@ -55,5 +55,5 @@
   },
   "typings": "index.d.ts",
   "runkitExampleFilename": "examples/example-runkit.js",
-  "version": "1.12.2"
+  "version": "1.15.1"
 }

package/src/event.js

@@ -504,7 +504,13 @@ class ICalEvent {
             c._data.repeating.exclude = [];
             exclude.forEach(function (excludedDate, i) {
                 if (typeof excludedDate === 'string') {
-                    excludedDate = moment(excludedDate);
+                    let timezone = repeating.excludeTimezone || c._calendar._data.timezone;
+                    if (timezone) {
+                        excludedDate = moment.tz(excludedDate, timezone);
+                    }
+                    else {
+                        excludedDate = moment(excludedDate);
+                    }
                 }
                 else if (excludedDate instanceof Date) {
                     excludedDate = moment(excludedDate);
@@ -529,6 +535,14 @@ class ICalEvent {
             c._data.repeating.excludeTimezone = repeating.excludeTimezone;
         }
 
+        if (repeating.wkst) {
+            let {wkst} = repeating;
+            if (['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA'].indexOf(wkst) === -1) {
+                throw new Error('`repeating.wkst` contains invalid value `' + wkst + '`!');
+            }
+            c._data.repeating.wkst = wkst;
+        }
+
         return c;
     }
 
@@ -1059,7 +1073,13 @@ class ICalEvent {
 
         // DATE & TIME
         g += 'BEGIN:VEVENT\r\n';
-        g += 'UID:' + this._data.id + '@' + this._calendar.domain() + '\r\n';
+        let domain = this._calendar.domain();
+        if (domain) {
+            g += 'UID:' + this._data.id + '@' + domain + '\r\n';
+        }
+        else {
+            g += 'UID:' + this._data.id + '\r\n';
+        }
 
         // SEQUENCE
         g += 'SEQUENCE:' + this._data.sequence + '\r\n';
@@ -1113,6 +1133,10 @@ class ICalEvent {
                 g += ';BYSETPOS=' + this._data.repeating.bySetPos;
             }
 
+            if (this._data.repeating.wkst) {
+                g += ';WKST=' + this._data.repeating.wkst;
+            }
+
             g += '\r\n';
 
             // REPEATING EXCLUSION

package/test/test_event.js

@@ -901,6 +901,27 @@ describe('ical-generator Event', function () {
 
             assert.ok(e._data.repeating.excludeTimezone, 'Europe/Berlin');
         });
+
+        it('should throw error when repeating.wkst is not valid', function () {
+            assert.throws(function () {
+                new ICalEvent({
+                    start: moment(),
+                    summary: 'test',
+                    repeating: {
+                        freq: 'DAILY',
+                        interval: 2,
+                        wkst: 'FOO'
+                    }
+                }, new ICalCalendar());
+            }, /`repeating\.wkst` contains invalid value `FOO`/);
+        });
+
+        it('setter should update repeating.wkst', function () {
+            const e = new ICalEvent(null, new ICalCalendar());
+
+            e.repeating({freq: 'monthly', wkst: 'SU'});
+            assert.deepStrictEqual(e._data.repeating.wkst, 'SU');
+        });
     });
 
     describe('summary()', function () {
@@ -1071,7 +1092,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             };
             assert.deepEqual(e.appleLocation(), {
@@ -1080,7 +1101,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             });
 
@@ -1097,7 +1118,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             }));
         });
@@ -1114,7 +1135,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             });
             assert.deepEqual(event._data.appleLocation, {
@@ -1123,7 +1144,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             });
         });
@@ -1141,7 +1162,7 @@ describe('ical-generator Event', function () {
                 radius: 40,
                 geo: {
                     lat: '52.063921',
-                    lon: '5.128511',
+                    lon: '5.128511'
                 }
             });
             assert.ok(event._data.location !== 'Batman Cave', null);
@@ -1731,12 +1752,34 @@ describe('ical-generator Event', function () {
                 summary: ':)'
             }, cal);
 
-            assert.ok(event._generate().indexOf('UID:42@') > -1, 'without domain');
+            assert.ok(event._generate().indexOf('UID:42\r') > -1, 'without domain');
 
             cal.domain('dojo-enterprises.wtf');
             assert.ok(event._generate().indexOf('UID:42@dojo-enterprises.wtf') > -1, 'with domain');
         });
 
+        it('should include wkst only if provided', function () {
+            const cal = new ICalCalendar();
+            let event = new ICalEvent({
+                start: moment(),
+                end: moment(),
+                repeating: {
+                    freq: 'weekly'
+                }
+            }, cal);
+            assert.ok(event._generate().indexOf('WKST') === -1, 'without WKST');
+
+            event = new ICalEvent({
+                start: moment(),
+                end: moment(),
+                repeating: {
+                    freq: 'weekly',
+                    wkst: 'SU'
+                }
+            }, cal);
+            assert.ok(event._generate().indexOf('WKST') > -1, 'without WKST');
+        });
+
         /*it('case #1', function () {
             const cal = ical({domain: 'sebbo.net', prodId: '//sebbo.net//ical-generator.tests//EN'});
             cal.createEvent({

package/test/test_issues.js

@@ -106,4 +106,47 @@ describe('Issues', function () {
             });
         });
     });
+
+    describe('Issue #210', function () {
+        it('should repeat/exclude with Europe/Berlin', function () {
+            const calendar = ical({
+                domain: 'sebbo.net',
+                prodId: '//superman-industries.com//ical-generator//EN',
+                timezone: 'Europe/Berlin',
+                events: [{
+                    start: '2020-08-13T00:00:00',
+                    summary: 'Example Event',
+                    repeating: {
+                        freq: 'MONTHLY',
+                        count: 12,
+                        exclude: '2020-12-13T00:00:00',
+                        excludeTimezone: 'Europe/Berlin'
+                    }
+                }]
+            });
+
+            const str = calendar.toString();
+            assert.ok(str.indexOf('EXDATE;TZID=Europe/Berlin:20201213T000000') > -1);
+        });
+        it('should repeat/exclude with America/New_York', function () {
+            const calendar = ical({
+                domain: 'sebbo.net',
+                prodId: '//superman-industries.com//ical-generator//EN',
+                timezone: 'America/New_York',
+                events: [{
+                    start: '2020-08-13T00:00:00',
+                    summary: 'Example Event',
+                    repeating: {
+                        freq: 'MONTHLY',
+                        count: 12,
+                        exclude: '2020-12-13T00:00:00',
+                        excludeTimezone: 'America/New_York',
+                    }
+                }]
+            });
+
+            const str = calendar.toString();
+            assert.ok(str.indexOf('EXDATE;TZID=America/New_York:20201213T000000') > -1);
+        });
+    });
 });