@webex/internal-plugin-calendar 3.0.0-beta.3 → 3.0.0-beta.300

package/src/calendar.js

@@ -3,28 +3,28 @@
  */
 
 /**
-   * Calendar Item Create Event
-   * Emitted when a calendar item has been added
-   * @event calendar:meeting:create
-   * @instance
-   * @memberof Calendar
-   */
+ * Calendar Item Create Event
+ * Emitted when a calendar item has been added
+ * @event calendar:meeting:create
+ * @instance
+ * @memberof Calendar
+ */
 
 /**
-   * Calendar Item Update Event
-   * Emitted when a calendar item has been updated
-   * @event calendar:meeting:update
-   * @instance
-   * @memberof Calendar
-   */
+ * Calendar Item Update Event
+ * Emitted when a calendar item has been updated
+ * @event calendar:meeting:update
+ * @instance
+ * @memberof Calendar
+ */
 
 /**
-   * Calendar Item Update Event
-   * Emitted when a calendar item has been deleted
-   * @event calendar:meeting:delete
-   * @instance
-   * @memberof Calendar
-   */
+ * Calendar Item Update Event
+ * Emitted when a calendar item has been deleted
+ * @event calendar:meeting:delete
+ * @instance
+ * @memberof Calendar
+ */
 
 /**
  * Calendar Registered Event
@@ -41,12 +41,21 @@
  * @instance
  * @memberof Calendar
  */
-
-import btoa from 'btoa';
+import {isArray} from 'lodash';
+import {base64} from '@webex/common';
 import {WebexPlugin} from '@webex/webex-core';
 
 import CalendarCollection from './collection';
-import {CALENDAR_REGISTERED, CALENDAR_UNREGISTERED, CALENDAR_DELETE, CALENDAR_CREATE, CALENDAR_UPDATED} from './constants';
+import {
+  CALENDAR_REGISTERED,
+  CALENDAR_UNREGISTERED,
+  CALENDAR_DELETE,
+  CALENDAR_CREATE,
+  CALENDAR_UPDATED,
+} from './constants';
+
+import EncryptHelper from './calendar.encrypt.helper';
+import DecryptHelper from './calendar.decrypt.helper';
 
 const Calendar = WebexPlugin.extend({
   namespace: 'Calendar',
@@ -59,6 +68,43 @@ const Calendar = WebexPlugin.extend({
    */
   registered: false,
 
+  /**
+   * Cache all rpc event request locally
+   * */
+  rpcEventRequests: [],
+
+  /**
+   * Cache KMS encryptionKeyUrl
+   * */
+  encryptionKeyUrl: null,
+
+  /**
+   * WebexPlugin initialize method. This triggers once Webex has completed its
+   * initialization workflow.
+   *
+   * If the plugin is meant to perform startup actions, place them in this
+   * `initialize()` method instead of the `constructor()` method.
+   * @returns {void}
+   */
+  initialize() {
+    // Used to perform actions after webex is fully qualified and ready for
+    // operation.
+    this.listenToOnce(this.webex, 'ready', () => {
+      // Pre-fetch a KMS encryption key url to improve performance
+      this.webex.internal.encryption.kms.createUnboundKeys({count: 1}).then((keys) => {
+        const key = isArray(keys) ? keys[0] : keys;
+        this.encryptionKeyUrl = key ? key.uri : null;
+        this.logger.info('calendar->bind a KMS encryption key url');
+        this.webex.internal.encryption
+          .getKey(this.encryptionKeyUrl, {onBehalfOf: null})
+          .then((retrievedKey) => {
+            this.encryptionKeyUrl = retrievedKey ? retrievedKey.uri : null;
+            this.logger.info('calendar->retrieve the KMS encryption key url and cache it');
+          });
+      });
+    });
+  },
+
   /**
    * Explicitly sets up the calendar plugin by registering
    * the device, connecting to mercury, and listening for calendar events.
@@ -79,7 +125,8 @@ const Calendar = WebexPlugin.extend({
       return Promise.resolve();
     }
 
-    return this.webex.internal.device.register()
+    return this.webex.internal.device
+      .register()
       .then(() => this.webex.internal.mercury.connect())
       .then(() => {
         this.listenForEvents();
@@ -110,7 +157,8 @@ const Calendar = WebexPlugin.extend({
 
     this.stopListeningForEvents();
 
-    return this.webex.internal.mercury.disconnect()
+    return this.webex.internal.mercury
+      .disconnect()
       .then(() => this.webex.internal.device.unregister())
       .then(() => {
         this.trigger(CALENDAR_UNREGISTERED);
@@ -140,6 +188,9 @@ const Calendar = WebexPlugin.extend({
     this.webex.internal.mercury.on('event:calendar.meeting.delete', (envelope) => {
       this._handleDelete(envelope.data);
     });
+    this.webex.internal.mercury.on('event:calendar.free_busy', (envelope) => {
+      this._handleFreeBusy(envelope.data);
+    });
   },
 
   /**
@@ -153,6 +204,7 @@ const Calendar = WebexPlugin.extend({
     this.webex.internal.mercury.off('event:calendar.meeting.update');
     this.webex.internal.mercury.off('event:calendar.meeting.update.minimal');
     this.webex.internal.mercury.off('event:calendar.meeting.delete');
+    this.webex.internal.mercury.off('event:calendar.free_busy');
   },
 
   /**
@@ -191,6 +243,32 @@ const Calendar = WebexPlugin.extend({
     this.trigger(CALENDAR_DELETE, item);
   },
 
+  /**
+   * handles free_busy events
+   * @param {Object} data
+   * @returns {undefined}
+   * @private
+   */
+  _handleFreeBusy(data) {
+    DecryptHelper.decryptFreeBusyResponse(this, data).then(() => {
+      let response = {};
+      if (data && data.calendarFreeBusyScheduleResponse) {
+        response = data.calendarFreeBusyScheduleResponse;
+      }
+      if (response && response.requestId && response.requestId in this.rpcEventRequests) {
+        this.logger.log(
+          `webex.internal.calendar - receive requests, requestId: ${response.requestId}`
+        );
+        delete response.encryptionKeyUrl;
+        const {resolve} = this.rpcEventRequests[response.requestId];
+        resolve(response);
+        delete this.rpcEventRequests[response.requestId];
+      } else {
+        this.logger.log('webex.internal.calendar - receive other requests.');
+      }
+    });
+  },
+
   /**
    * Retrieves a collection of calendars based on the request parameters
    * Defaults to 1 day before and 7 days ahead
@@ -233,20 +311,30 @@ const Calendar = WebexPlugin.extend({
    * @returns {Promise} Resolves with a decrypted calendar event
    */
   processMeetingEvent(event) {
-    return this.webex.transform('inbound', event)
-      .then(() => event);
+    return this.webex.transform('inbound', event).then(() => event);
   },
 
   /**
-   * Retrieves an array of meeting participants for the meeting id
-   * @param {String} id
+   * Retrieves an array of meeting participants for the meeting participantsUrl
+   * @param {String} participantsUrl
    * @returns {Promise} Resolves with an object of meeting participants
    */
-  getParticipants(id) {
+  getParticipants(participantsUrl) {
     return this.request({
       method: 'GET',
-      service: 'calendar',
-      resource: `calendarEvents/${btoa(id)}/participants`
+      uri: participantsUrl,
+    });
+  },
+
+  /**
+   * get meeting notes using notesUrl from meeting object.
+   * @param {String} notesUrl
+   * @returns {Promise} Resolves with an object of meeting notes
+   */
+  getNotesByUrl(notesUrl) {
+    return this.request({
+      method: 'GET',
+      uri: notesUrl,
     });
   },
 
@@ -259,7 +347,7 @@ const Calendar = WebexPlugin.extend({
     return this.request({
       method: 'GET',
       service: 'calendar',
-      resource: `calendarEvents/${btoa(id)}/notes`
+      resource: `calendarEvents/${base64.encode(id)}/notes`,
     });
   },
 
@@ -273,40 +361,141 @@ const Calendar = WebexPlugin.extend({
   list(options) {
     options = options || {};
 
-    return this.webex.request({
-      method: 'GET',
-      service: 'calendar',
-      resource: 'calendarEvents',
-      qs: options
-    })
+    return this.webex
+      .request({
+        method: 'GET',
+        service: 'calendar',
+        resource: 'calendarEvents',
+        qs: options,
+      })
       .then((res) => {
         const meetingObjects = res.body.items;
         const promises = [];
 
         meetingObjects.forEach((meeting) => {
-          if (!meeting.encryptedNotes) {
-            promises.push(
-              this.getNotes(meeting.id)
-                .then((notesResponse) => {
-                  meeting.encryptedNotes = notesResponse.body && notesResponse.body.encryptedNotes;
-                })
-            );
-          }
-
           if (!meeting.encryptedParticipants) {
             promises.push(
-              this.getParticipants(meeting.id)
-                .then((notesResponse) => {
-                  meeting.encryptedParticipants = notesResponse.body.encryptedParticipants;
-                })
+              this.getParticipants(meeting.participantsUrl).then((notesResponse) => {
+                meeting.encryptedParticipants = notesResponse.body.encryptedParticipants;
+              })
             );
           }
         });
 
-        return Promise.all(promises)
-          .then(() => meetingObjects);
+        return Promise.all(promises).then(() => meetingObjects);
+      });
+  },
+
+  /**
+   * Create calendar event
+   * @param {object} [data] meeting payload data
+   * @param {object} [query] the query parameters for specific usage
+   * @returns {Promise} Resolves with creating calendar event response
+   * */
+  createCalendarEvent(data, query) {
+    return EncryptHelper.encryptCalendarEventRequest(this, data).then(() =>
+      this.request({
+        method: 'POST',
+        service: 'calendar',
+        body: data,
+        resource: 'calendarEvents/sync',
+        qs: query || {},
+      })
+    );
+  },
+
+  /**
+   * Update calendar event
+   * @param {string} [id] calendar event id
+   * @param {object} [data] meeting payload data
+   * @param {object} [query] the query parameters for specific usage
+   * @returns {Promise} Resolves with updating calendar event response
+   * */
+  updateCalendarEvent(id, data, query) {
+    return EncryptHelper.encryptCalendarEventRequest(this, data).then(() =>
+      this.request({
+        method: 'PATCH',
+        service: 'calendar',
+        body: data,
+        resource: `calendarEvents/${base64.encode(id)}/sync`,
+        qs: query || {},
+      })
+    );
+  },
+
+  /**
+   * Delete calendar event
+   * @param {string} [id] calendar event id
+   * @param {object} [query] the query parameters for specific usage
+   * @returns {Promise} Resolves with deleting calendar event response
+   * */
+  deleteCalendarEvent(id, query) {
+    return this.request({
+      method: 'DELETE',
+      service: 'calendar',
+      resource: `calendarEvents/${base64.encode(id)}/sync`,
+      qs: query || {},
+    });
+  },
+
+  /**
+   * @typedef QuerySchedulerDataOptions
+   * @param {string} [siteName] it is site full url, must have. Example: ccctest.dmz.webex.com
+   * @param {string} [id] it is seriesOrOccurrenceId. If present, the series/occurrence meeting ID to fetch data for.
+   *                      Example: 040000008200E00074C5B7101A82E008000000004A99F11A0841D9010000000000000000100000009EE499D4A71C1A46B51494C70EC7BFE5
+   * @param {string} [clientMeetingId] If present, the client meeting UUID to fetch data for.
+   *                      Example: 7f318aa9-887c-6e94-802a-8dc8e6eb1a0a
+   * @param {string} [scheduleTemplateId] it template id.
+   * @param {string} [sessionTypeId] it session type id.
+   * @param {string} [organizerCIUserId] required in schedule-on-behalf case. It is the organizer's CI UUID.
+   * @param {boolean} [usmPreference]
+   * @param {string} [webexMeetingId] webex side meeting UUID
+   * @param {string} [eventId] event ID.
+   * @param {string} [icalUid] icalendar UUID.
+   * @param {string} [thirdPartyType] third part type, such as: Microsoft
+   */
+  /**
+   * Get scheduler data from calendar service
+   * @param {QuerySchedulerDataOptions} [query] the command parameters for fetching scheduler data.
+   * @returns {Promise} Resolves with a decrypted scheduler data
+   * */
+  getSchedulerData(query) {
+    return this.request({
+      method: 'GET',
+      service: 'calendar',
+      resource: 'schedulerData',
+      qs: query || {},
+    }).then((response) => {
+      return DecryptHelper.decryptSchedulerDataResponse(this, response.body).then(() => response);
+    });
+  },
+
+  /**
+   * Get free busy status from calendar service
+   * @param {Object} [data] the command parameters for fetching free busy status.
+   * @param {object} [query] the query parameters for specific usage
+   * @returns {Promise} Resolves with a decrypted response
+   * */
+  getFreeBusy(data, query) {
+    return EncryptHelper.encryptFreeBusyRequest(this, data)
+      .then(() => {
+        return this.request({
+          method: 'POST',
+          service: 'calendar',
+          body: data,
+          resource: 'freebusy',
+          qs: query || {},
+        });
+      })
+      .then(() => {
+        return new Promise((resolve, reject) => {
+          this.rpcEventRequests[data.requestId] = {resolve, reject};
+        });
+      })
+      .catch((error) => {
+        throw error;
       });
-  }
+  },
 });
 
 export default Calendar;

package/src/collection.js

@@ -27,7 +27,7 @@ const CalendarCollection = {
    */
   getBy(key, value) {
     if (key && value) {
-      return find(this.items, (item) => (item[key] === value));
+      return find(this.items, (item) => item[key] === value);
     }
 
     return null;
@@ -58,7 +58,6 @@ const CalendarCollection = {
     this.items = {};
   },
 
-
   /**
    * @param {Id} id is the id for the calendar item to be removed
    * @returns {Any} calendar item which got removed
@@ -95,8 +94,7 @@ const CalendarCollection = {
    */
   getAll() {
     return Object.values(this.items);
-  }
-
+  },
 };
 
 export default CalendarCollection;

package/src/config.js

@@ -5,6 +5,6 @@
 export default {
   calendar: {
     fromDate: new Date(new Date().setDate(new Date().getDate() - 1)),
-    toDate: new Date(new Date().setDate(new Date().getDate() + 7))
-  }
+    toDate: new Date(new Date().setDate(new Date().getDate() + 7)),
+  },
 };

package/src/index.js

@@ -20,21 +20,37 @@ registerInternalPlugin('calendar', Calendar, {
         name: 'transformMeetingNotes',
         direction: 'inbound',
         test(ctx, response) {
-          return Promise.resolve(has(response, 'body.encryptedNotes'));
+          return Promise.resolve(
+            has(response, 'body.encryptedNotes') &&
+              !(
+                response.options &&
+                response.options.service === 'calendar' &&
+                response.options.method === 'GET' &&
+                response.options.resource === 'schedulerData'
+              )
+          );
         },
         extract(response) {
           return Promise.resolve(response.body);
-        }
+        },
       },
       {
         name: 'transformMeetingParticipants',
         direction: 'inbound',
         test(ctx, response) {
-          return Promise.resolve(has(response, 'body.encryptedParticipants'));
+          return Promise.resolve(
+            has(response, 'body.encryptedParticipants') &&
+              !(
+                response.options &&
+                response.options.service === 'calendar' &&
+                response.options.method === 'GET' &&
+                response.options.resource === 'schedulerData'
+              )
+          );
         },
         extract(response) {
           return Promise.resolve(response.body);
-        }
+        },
       },
       {
         name: 'transformMeetingArray',
@@ -44,17 +60,25 @@ registerInternalPlugin('calendar', Calendar, {
         },
         extract(response) {
           return Promise.resolve(response.body.items);
-        }
+        },
       },
       {
         name: 'transformMeeting',
         direction: 'inbound',
         test(ctx, response) {
-          return Promise.resolve(has(response, 'body.seriesId'));
+          return Promise.resolve(
+            has(response, 'body.seriesId') &&
+              !(
+                response.options &&
+                response.options.service === 'calendar' &&
+                response.options.method === 'GET' &&
+                response.options.resource === 'schedulerData'
+              )
+          );
         },
         extract(response) {
           return Promise.resolve(response.body);
-        }
+        },
       },
       {
         name: 'transformMeeting',
@@ -64,15 +88,15 @@ registerInternalPlugin('calendar', Calendar, {
         },
         extract(response) {
           return Promise.resolve(response.calendarMeetingExternal);
-        }
-      }
+        },
+      },
     ],
     transforms: [
       {
         name: 'transformMeetingArray',
         fn(ctx, array) {
           return Promise.all(array.map((item) => ctx.transform('transformMeeting', item)));
-        }
+        },
       },
       {
         name: 'transformMeeting',
@@ -87,33 +111,78 @@ registerInternalPlugin('calendar', Calendar, {
           }
 
           // Decrypt participant properties if meeting object contains participants
-          const decryptedParticipants = object.encryptedParticipants ? object.encryptedParticipants.map((participant) => Promise.all([
-            ctx.transform('decryptTextProp', 'encryptedEmailAddress', object.encryptionKeyUrl, participant),
-            ctx.transform('decryptTextProp', 'encryptedName', object.encryptionKeyUrl, participant)
-          ])) : [];
+          const decryptedParticipants = object.encryptedParticipants
+            ? object.encryptedParticipants.map((participant) =>
+                Promise.all([
+                  ctx.transform(
+                    'decryptTextProp',
+                    'encryptedEmailAddress',
+                    object.encryptionKeyUrl,
+                    participant
+                  ),
+                  ctx.transform(
+                    'decryptTextProp',
+                    'encryptedName',
+                    object.encryptionKeyUrl,
+                    participant
+                  ),
+                ])
+              )
+            : [];
 
           // Decrypt meetingJoinInfo properties if meeting object contains meetingJoinInfo
-          const decryptedMeetingJoinInfo = object.meetingJoinInfo ? Promise.all([
-            ctx.transform('decryptTextProp', 'meetingJoinURI', object.encryptionKeyUrl, object.meetingJoinInfo),
-            ctx.transform('decryptTextProp', 'meetingJoinURL', object.encryptionKeyUrl, object.meetingJoinInfo)
-          ]) : [];
+          const decryptedMeetingJoinInfo = object.meetingJoinInfo
+            ? Promise.all([
+                ctx.transform(
+                  'decryptTextProp',
+                  'meetingJoinURI',
+                  object.encryptionKeyUrl,
+                  object.meetingJoinInfo
+                ),
+                ctx.transform(
+                  'decryptTextProp',
+                  'meetingJoinURL',
+                  object.encryptionKeyUrl,
+                  object.meetingJoinInfo
+                ),
+              ])
+            : [];
 
-          const decryptedOrganizer = object.encryptedOrganizer ? Promise.all([
-            ctx.transform('decryptTextProp', 'encryptedEmailAddress', object.encryptionKeyUrl, object.encryptedOrganizer),
-            ctx.transform('decryptTextProp', 'encryptedName', object.encryptionKeyUrl, object.encryptedOrganizer)
-          ]) : [];
+          const decryptedOrganizer = object.encryptedOrganizer
+            ? Promise.all([
+                ctx.transform(
+                  'decryptTextProp',
+                  'encryptedEmailAddress',
+                  object.encryptionKeyUrl,
+                  object.encryptedOrganizer
+                ),
+                ctx.transform(
+                  'decryptTextProp',
+                  'encryptedName',
+                  object.encryptionKeyUrl,
+                  object.encryptedOrganizer
+                ),
+              ])
+            : [];
 
-          return Promise.all([
-            ctx.transform('decryptTextProp', 'encryptedSubject', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'encryptedLocation', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'encryptedNotes', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'webexURI', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'webexURL', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'spaceMeetURL', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'spaceURI', object.encryptionKeyUrl, object),
-            ctx.transform('decryptTextProp', 'spaceURL', object.encryptionKeyUrl, object)
-          ].concat(decryptedOrganizer, decryptedParticipants, decryptedMeetingJoinInfo));
-        }
+          return Promise.all(
+            [
+              ctx.transform('decryptTextProp', 'encryptedSubject', object.encryptionKeyUrl, object),
+              ctx.transform(
+                'decryptTextProp',
+                'encryptedLocation',
+                object.encryptionKeyUrl,
+                object
+              ),
+              ctx.transform('decryptTextProp', 'encryptedNotes', object.encryptionKeyUrl, object),
+              ctx.transform('decryptTextProp', 'webexURI', object.encryptionKeyUrl, object),
+              ctx.transform('decryptTextProp', 'webexURL', object.encryptionKeyUrl, object),
+              ctx.transform('decryptTextProp', 'spaceMeetURL', object.encryptionKeyUrl, object),
+              ctx.transform('decryptTextProp', 'spaceURI', object.encryptionKeyUrl, object),
+              ctx.transform('decryptTextProp', 'spaceURL', object.encryptionKeyUrl, object),
+            ].concat(decryptedOrganizer, decryptedParticipants, decryptedMeetingJoinInfo)
+          );
+        },
       },
       {
         name: 'transformMeetingNotes',
@@ -128,9 +197,9 @@ registerInternalPlugin('calendar', Calendar, {
           }
 
           return Promise.all([
-            ctx.transform('decryptTextProp', 'encryptedNotes', object.encryptionKeyUrl, object)
+            ctx.transform('decryptTextProp', 'encryptedNotes', object.encryptionKeyUrl, object),
           ]);
-        }
+        },
       },
       {
         name: 'transformMeetingParticipants',
@@ -145,16 +214,28 @@ registerInternalPlugin('calendar', Calendar, {
           }
 
           // Decrypt participant properties
-          const decryptedParticipants = object.encryptedParticipants.map((participant) => Promise.all([
-            ctx.transform('decryptTextProp', 'encryptedEmailAddress', object.encryptionKeyUrl, participant),
-            ctx.transform('decryptTextProp', 'encryptedName', object.encryptionKeyUrl, participant)
-          ]));
+          const decryptedParticipants = object.encryptedParticipants.map((participant) =>
+            Promise.all([
+              ctx.transform(
+                'decryptTextProp',
+                'encryptedEmailAddress',
+                object.encryptionKeyUrl,
+                participant
+              ),
+              ctx.transform(
+                'decryptTextProp',
+                'encryptedName',
+                object.encryptionKeyUrl,
+                participant
+              ),
+            ])
+          );
 
           return Promise.all(decryptedParticipants);
-        }
-      }
-    ]
-  }
+        },
+      },
+    ],
+  },
 });
 
 export {default} from './calendar';

package/src/util.js

@@ -1,5 +1,4 @@
 const CalendarUtil = {
-
   // calculate the end time for the meeting based on the duration so it's stored on
   // the scheduled meeting item, that way client can display start and end without
   // calculation on their side
@@ -13,8 +12,11 @@ const CalendarUtil = {
    * @memberof CalendarUtil
    */
   calculateEndTime(item) {
-    return {...item, endTime: new Date(new Date(item.start).getTime() + item.durationMinutes * 60000)};
-  }
+    return {
+      ...item,
+      endTime: new Date(new Date(item.start).getTime() + item.durationMinutes * 60000),
+    };
+  },
 };
 
 export default CalendarUtil;