feat(Event): Made ICalEvent.location.title optional to allow settin…

…g `GEO` without title close #578 BREAKING CHANGE: [ICalEvent.location()](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalEvent.html#location)'s `title` field can now be undefined
sebbo2002 · Feb 20, 2024 · 42be230 · 42be230
1 parent a66adf1
commit 42be230
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 11 deletions.
diff --git a/src/event.ts b/src/event.ts
@@ -880,7 +880,7 @@ export default class ICalEvent {
 
     /**
      * Set the event's location by passing a string (minimum) or
-     * an {@link ICalLocation} object which will also fill the iCal
+     * an {@link ICalLocationWithTitle} object which will also fill the iCal
      * `GEO` attribute and Apple's `X-APPLE-STRUCTURED-LOCATION`.
      *
      * ```javascript
@@ -904,6 +904,22 @@ export default class ICalEvent {
      * GEO:52.50363;13.32865
      * ```
      *
+     * Since v6.1.0 you can also pass a {@link ICalLocationWithoutTitle} object to pass
+     * the geolocation only. This will only fill the iCal `GEO` attribute.
+     *
+     * ```javascript
+     * event.location({
+     *    geo: {
+     *        lat: 52.503630,
+     *        lon: 13.328650
+     *    }
+     * });
+     * ```
+     *
+     * ```text
+     * GEO:52.50363;13.32865
+     * ```
+     *
      * @since 0.2.0
      */
     location(location: ICalLocation | string | null): this;
@@ -917,10 +933,11 @@ export default class ICalEvent {
             };
             return this;
         }
-        if (
-            (!location?.title && !location?.geo) ||
-            (location?.geo && (!isFinite(location.geo.lat) || !isFinite(location.geo.lon)))
-        ) {
+        if (location && (
+            ('title' in location && !location.title) ||
+            (location?.geo && (!isFinite(location.geo.lat) || !isFinite(location.geo.lon))) ||
+            (!('title' in location) && !location?.geo)
+        )) {
             throw new Error(
                 '`location` isn\'t formatted correctly. See https://sebbo2002.github.io/ical-generator/'+
                 'develop/reference/classes/ICalEvent.html#location'
@@ -1751,7 +1768,7 @@ export default class ICalEvent {
         }
 
         // LOCATION
-        if (this.data.location?.title) {
+        if (this.data.location && 'title' in this.data.location && this.data.location.title) {
             g += 'LOCATION:' + escape(
                 this.data.location.title +
                 (this.data.location.address ? '\n' + this.data.location.address : ''),
@@ -1769,7 +1786,7 @@ export default class ICalEvent {
         }
 
         // GEO
-        if (this.data.location.geo) {
+        if (this.data.location && 'geo' in this.data.location && this.data.location.geo) {
             g += 'GEO:' + escape(this.data.location.geo?.lat, false) + ';' +
                 escape(this.data.location.geo?.lon, false) + '\r\n';
         }

diff --git a/src/index.ts b/src/index.ts
@@ -99,6 +99,8 @@ export {
     ICalDateTimeValue,
     ICalRepeatingOptions,
     ICalLocation,
+    ICalLocationWithTitle,
+    ICalLocationWithoutTitle,
     ICalGeo,
     ICalOrganizer,
     ICalDescription,

diff --git a/src/types.ts b/src/types.ts
@@ -19,13 +19,19 @@ export interface ICalRepeatingOptions {
     startOfWeek?: ICalWeekday;
 }
 
-export interface ICalLocation {
+export type ICalLocation = ICalLocationWithTitle | ICalLocationWithoutTitle;
+
+export interface ICalLocationWithTitle {
     title: string;
     address?: string;
     radius?: number;
     geo?: ICalGeo;
 }
 
+export interface ICalLocationWithoutTitle {
+    geo: ICalGeo;
+}
+
 export interface ICalGeo {
     lat: number;
     lon: number;

diff --git a/test/event.ts b/test/event.ts
@@ -1225,8 +1225,12 @@ describe('ical-generator Event', function () {
                 title: 'Foo',
                 geo: {lat: 44.5, lon: -3.4}
             });
-            assert.deepStrictEqual(e.location()?.title, 'Foo');
-            assert.deepStrictEqual(e.location()?.geo, {lat: 44.5, lon: -3.4});
+
+            const location = e.location();
+            assert.ok(location);
+            assert.ok('title' in location);
+            assert.deepStrictEqual(location?.title, 'Foo');
+            assert.deepStrictEqual(location?.geo, {lat: 44.5, lon: -3.4});
 
             e.location(null);
             assert.strictEqual(e.location(), null);
@@ -1245,7 +1249,11 @@ describe('ical-generator Event', function () {
             }, new ICalCalendar());
 
             event.location('Europa-Park');
-            assert.strictEqual(event.location()?.title, 'Europa-Park');
+
+            const location = event.location();
+            assert.ok(location);
+            assert.ok('title' in location);
+            assert.strictEqual(location?.title, 'Europa-Park');
         });
 
         it('should throw error when location is not valid', function () {

diff --git a/test/issues.ts b/test/issues.ts
@@ -270,4 +270,36 @@ describe('Issues', function () {
             ].join('\r\n'));
         });
     });
+
+    describe('Issue #569 / 570', function () {
+        it('event.location should work with `geo` only', function () {
+            const event = ical().createEvent({
+                id: '12345',
+                summary: 'Hello',
+                start: new Date('2020-06-15T00:00:00Z'),
+                end: new Date('2020-06-15T01:00:00Z'),
+                stamp: new Date('2020-06-15T00:00:00Z')
+            });
+
+            event.location({
+                geo: {
+                    lat: 52.51147570081018,
+                    lon: 13.342200696373846
+                }
+            });
+
+            assert.strictEqual(event.toString(), [
+                'BEGIN:VEVENT',
+                'UID:12345',
+                'SEQUENCE:0',
+                'DTSTAMP:20200615T000000Z',
+                'DTSTART:20200615T000000Z',
+                'DTEND:20200615T010000Z',
+                'SUMMARY:Hello',
+                'GEO:52.51147570081018;13.342200696373846',
+                'END:VEVENT',
+                ''
+            ].join('\r\n'));
+        });
+    });
 });