@pipedream/microsoft_outlook_calendar 0.1.0 → 0.3.0

package/README.md

@@ -1,5 +1,11 @@
 # Overview
 
-With the Microsoft Outlook API, you can build a wide range of applications and
-services that work with Outlook. The Microsoft Outlook Calendar app helps you
-manage your calendar and schedule appointments.
+The Microsoft Outlook Calendar API provides programmatic access to a user's calendar events, allowing for the creation, retrieval, update, and deletion of events within Outlook calendars. With Pipedream, you can integrate these calendar operations into workflows that automate tasks involving scheduling, event management, and coordination with other services. Whether it's triggering actions when new events are created, syncing calendar events with other scheduling tools, or managing attendees, Pipedream's serverless platform enables you to build custom automations with minimal overhead.
+
+# Example Use Cases
+
+- **Automated Event Reminder Emails**: Trigger a Pipedream workflow whenever a new event is added to an Outlook Calendar. The workflow could send a reminder email via a service like SendGrid or Gmail to all the attendees a day before the event occurs, ensuring everyone is prepped and on time.
+
+- **Cross-Platform Calendar Sync**: Sync events between Microsoft Outlook Calendar and Google Calendar. When an event is created or updated in Outlook, a Pipedream workflow can create or update a corresponding event in Google Calendar. This ensures that users who operate across different platforms have unified schedules.
+
+- **Meeting Room Availability Checker**: Monitor your Outlook Calendar for new meetings and automatically check the availability of meeting rooms using a service like Google's G Suite Admin SDK. If a room is available, the workflow reserves it and updates the event with the room's details. If not, it could notify the organizer to select a different room or time.

package/actions/create-calendar-event/create-calendar-event.mjs

@@ -0,0 +1,111 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  type: "action",
+  key: "microsoft_outlook_calendar-create-calendar-event",
+  version: "0.0.6",
+  name: "Create Calendar Event",
+  description: "Create an event in the user's default calendar. [See the documentation](https://docs.microsoft.com/en-us/graph/api/user-post-events)",
+  props: {
+    microsoftOutlook,
+    subject: {
+      label: "Subject",
+      description: "Subject of the event",
+      type: "string",
+    },
+    contentType: {
+      propDefinition: [
+        microsoftOutlook,
+        "contentType",
+      ],
+    },
+    content: {
+      propDefinition: [
+        microsoftOutlook,
+        "content",
+      ],
+      description: "Content",
+    },
+    timeZone: {
+      propDefinition: [
+        microsoftOutlook,
+        "timeZone",
+      ],
+    },
+    start: {
+      propDefinition: [
+        microsoftOutlook,
+        "start",
+      ],
+    },
+    end: {
+      propDefinition: [
+        microsoftOutlook,
+        "end",
+      ],
+    },
+    attendees: {
+      propDefinition: [
+        microsoftOutlook,
+        "attendees",
+      ],
+    },
+    location: {
+      propDefinition: [
+        microsoftOutlook,
+        "location",
+      ],
+    },
+    isOnlineMeeting: {
+      propDefinition: [
+        microsoftOutlook,
+        "isOnlineMeeting",
+      ],
+    },
+    expand: {
+      propDefinition: [
+        microsoftOutlook,
+        "expand",
+      ],
+      description: "Additional event details, [See object definition](https://docs.microsoft.com/en-us/graph/api/resources/event)",
+    },
+  },
+  async run({ $ }) {
+    //RegExp to check time strings(yyyy-MM-ddThh:mm:ss)
+    const re = /^(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)$/;
+    if (!re.test(this.start) || !re.test(this.start)) {
+      throw new Error("Please provide both start and end props in 'yyyy-MM-ddThh:mm:ss'");
+    }
+    const data = {
+      subject: this.subject,
+      body: {
+        contentType: this.contentType ?? "HTML",
+        content: this.content,
+      },
+      start: {
+        dateTime: this.start,
+        timeZone: this.timeZone,
+      },
+      end: {
+        dateTime: this.end,
+        timeZone: this.timeZone,
+      },
+      location: {
+        displayName: this.location,
+      },
+      attendees: this.attendees.map((at) => ({
+        emailAddress: {
+          address: at,
+        },
+      })),
+      isOnlineMeeting: this.isOnlineMeeting,
+      ...this.expand,
+    };
+    const response = await this.microsoftOutlook.createCalendarEvent({
+      $,
+      data,
+    });
+    $.export("$summary", "Calendar event has been created.");
+    return response;
+  },
+};

package/actions/delete-calendar-event/delete-calendar-event.mjs

@@ -0,0 +1,28 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  type: "action",
+  key: "microsoft_outlook_calendar-delete-calendar-event",
+  version: "0.0.1",
+  name: "Delete Calendar Event",
+  description: "Delete an event in the user's default calendar. [See the documentation](https://learn.microsoft.com/en-us/graph/api/event-delete?view=graph-rest-1.0&tabs=http)",
+  props: {
+    microsoftOutlook,
+    eventId: {
+      propDefinition: [
+        microsoftOutlook,
+        "eventId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.microsoftOutlook.deleteCalendarEvent({
+      $,
+      eventId: this.eventId,
+    });
+
+    $.export("$summary", `Successfully deleted calendar event with ID ${this.eventId}`);
+
+    return response;
+  },
+};

package/actions/get-schedule/get-schedule.mjs

@@ -0,0 +1,71 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  key: "microsoft_outlook_calendar-get-schedule",
+  name: "Get Free/Busy Schedule",
+  description: "Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. [See the documentation](https://learn.microsoft.com/en-us/graph/api/calendar-getschedule)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    microsoftOutlook,
+    schedules: {
+      type: "string[]",
+      label: "Schedules",
+      description: "A collection of SMTP addresses of users, distribution lists, or resources to get availability information for",
+    },
+    start: {
+      propDefinition: [
+        microsoftOutlook,
+        "start",
+      ],
+    },
+    end: {
+      propDefinition: [
+        microsoftOutlook,
+        "end",
+      ],
+    },
+    timeZone: {
+      propDefinition: [
+        microsoftOutlook,
+        "timeZone",
+      ],
+    },
+    availabilityViewInterval: {
+      type: "integer",
+      label: "Availability View Interval",
+      description: "Represents the duration of a time slot in minutes in an availabilityView in the response. The default is 30 minutes, minimum is 5, maximum is 1440.",
+      optional: true,
+    },
+  },
+  methods: {
+    getSchedule(opts = {}) {
+      return this.microsoftOutlook._makeRequest({
+        method: "POST",
+        path: "/me/calendar/getSchedule",
+        ...opts,
+      });
+    },
+  },
+  async run({ $ }) {
+    const { value } = await this.getSchedule({
+      $,
+      data: {
+        schedules: this.schedules,
+        startTime: {
+          dateTime: this.start,
+          timeZone: this.timeZone,
+        },
+        endTime: {
+          dateTime: this.end,
+          timeZone: this.timeZone,
+        },
+        availabilityViewInterval: this.availabilityViewInterval,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved schedules for \`${this.schedules.join("`, `")}\``);
+
+    return value;
+  },
+};

package/actions/list-events/list-events.mjs

@@ -0,0 +1,64 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  key: "microsoft_outlook_calendar-list-events",
+  name: "List Events",
+  description: "Get a list of event objects in the user's mailbox. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-events)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    microsoftOutlook,
+    filter: {
+      type: "string",
+      label: "Filter",
+      description: "Use the `$filter` query parameter to filter events. E.g. `contains(subject, 'my event')` [See the documentation](https://learn.microsoft.com/en-us/graph/filter-query-parameter) for more information about the `$filter` parameter.",
+      optional: true,
+    },
+    orderBy: {
+      type: "string",
+      label: "Order By",
+      description: "The field to sort the results by. Default is `createdDateTime`. [See the documentation](https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#orderby-parameter) for more info about the `$orderby` parameter.",
+      default: "createdDateTime",
+      optional: true,
+    },
+    sortOrder: {
+      type: "string",
+      label: "Sort Order",
+      description: "Whether to sort the results in ascending or descending order. Default is `descending`.",
+      options: [
+        {
+          label: "ascending",
+          value: "asc",
+        },
+        {
+          label: "descending",
+          value: "desc",
+        },
+      ],
+      default: "desc",
+      optional: true,
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "The maximum number of results to return",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { value = [] } = await this.microsoftOutlook.listCalendarEvents({
+      $,
+      params: {
+        "$orderby": `${this.orderBy} ${this.sortOrder}`,
+        "$filter": this.filter,
+        "$top": this.maxResults,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved ${value.length} event${value.length === 1
+      ? ""
+      : "s"}`);
+
+    return value;
+  },
+};

package/actions/update-calendar-event/update-calendar-event.mjs

@@ -0,0 +1,142 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  type: "action",
+  key: "microsoft_outlook_calendar-update-calendar-event",
+  version: "0.0.1",
+  name: "Update Calendar Event",
+  description: "Update an event in the user's default calendar. [See the documentation](https://learn.microsoft.com/en-us/graph/api/event-update?view=graph-rest-1.0&tabs=http)",
+  props: {
+    microsoftOutlook,
+    eventId: {
+      propDefinition: [
+        microsoftOutlook,
+        "eventId",
+      ],
+    },
+    subject: {
+      label: "Subject",
+      description: "Subject of the event",
+      type: "string",
+      optional: true,
+
+    },
+    contentType: {
+      propDefinition: [
+        microsoftOutlook,
+        "contentType",
+      ],
+      optional: true,
+    },
+    content: {
+      propDefinition: [
+        microsoftOutlook,
+        "content",
+      ],
+      description: "Content",
+      optional: true,
+    },
+    timeZone: {
+      propDefinition: [
+        microsoftOutlook,
+        "timeZone",
+      ],
+      optional: true,
+    },
+    start: {
+      propDefinition: [
+        microsoftOutlook,
+        "start",
+      ],
+      optional: true,
+    },
+    end: {
+      propDefinition: [
+        microsoftOutlook,
+        "end",
+      ],
+      optional: true,
+    },
+    attendees: {
+      propDefinition: [
+        microsoftOutlook,
+        "attendees",
+      ],
+      optional: true,
+    },
+    location: {
+      propDefinition: [
+        microsoftOutlook,
+        "location",
+      ],
+      optional: true,
+    },
+    isOnlineMeeting: {
+      propDefinition: [
+        microsoftOutlook,
+        "isOnlineMeeting",
+      ],
+      optional: true,
+    },
+    expand: {
+      propDefinition: [
+        microsoftOutlook,
+        "expand",
+      ],
+      description: "Additional event details, [See object definition](https://docs.microsoft.com/en-us/graph/api/resources/event)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      subject: this.subject,
+      isOnlineMeeting: this.isOnlineMeeting,
+      ...this.expand,
+    };
+
+    if (this.location) {
+      data.location = {
+        displayName: this.location,
+      };
+    }
+
+    if (this.contentType && this.content) {
+      data.body = {
+        contentType: this.contentType ?? "HTML",
+        content: this.content,
+      };
+    }
+
+    if (this.start && this.timeZone) {
+      data.start = {
+        dateTime: this.start,
+        timeZone: this.timeZone,
+
+      };
+    }
+    if (this.end && this.timeZone) {
+      data.end = {
+        dateTime: this.end,
+        timeZone: this.timeZone,
+      };
+    }
+
+    if (this.attendees) {
+      data.attendees = this.attendees.map((at) => ({
+        emailAddress: {
+          address: at,
+        },
+      }));
+    }
+
+    const response = await this.microsoftOutlook.updateCalendarEvent({
+      $,
+      eventId: this.eventId,
+      data,
+    });
+
+    $.export("$summary", `Successfully updated calendar event with ID ${response.id}`);
+
+    return response;
+  },
+};

package/microsoft_outlook_calendar.app.mjs

@@ -4,6 +4,19 @@ export default {
   type: "app",
   app: "microsoft_outlook_calendar",
   propDefinitions: {
+    eventId: {
+      label: "Event ID",
+      description: "The event ID",
+      type: "string",
+      async options() {
+        const { value: events } = await this.listCalendarEvents();
+
+        return events.map((event) => ({
+          label: event.subject,
+          value: event.id,
+        }));
+      },
+    },
     contentType: {
       label: "Content Type",
       description: "Content type (default `text`)",
@@ -132,6 +145,24 @@ export default {
         ...args,
       });
     },
+    async updateCalendarEvent({
+      eventId, ...args
+    }) {
+      return this._makeRequest({
+        method: "PATCH",
+        path: `/me/events/${eventId}`,
+        ...args,
+      });
+    },
+    async deleteCalendarEvent({
+      eventId, ...args
+    }) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/me/events/${eventId}`,
+        ...args,
+      });
+    },
     async listCalendarEvents(args = {}) {
       return this._makeRequest({
         method: "GET",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/microsoft_outlook_calendar",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Pipedream Microsoft Outlook Calendar Components",
   "main": "microsoft_outlook_calendar.app.mjs",
   "keywords": [
@@ -11,10 +11,10 @@
   ],
   "homepage": "https://pipedream.com/apps/microsoft_outlook_calendar",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "dependencies": {
-    "@pipedream/platform": "^1.5.1"
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/sources/common.mjs

@@ -0,0 +1,10 @@
+import microsoftOutlook from "../microsoft_outlook_calendar.app.mjs";
+import common from "../../microsoft_outlook/sources/common.mjs";
+
+export default {
+  ...common,
+  props: {
+    ...common.props,
+    microsoftOutlook,
+  },
+};

package/sources/new-calendar-event/new-calendar-event.mjs

@@ -0,0 +1,56 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "microsoft_outlook_calendar-new-calendar-event",
+  name: "New Calendar Event (Instant)",
+  description: "Emit new event when a new Calendar event is created",
+  version: "0.0.7",
+  type: "source",
+  hooks: {
+    ...common.hooks,
+    async activate() {
+      await this.activate({
+        changeType: "created",
+        resource: "/me/events",
+      });
+    },
+    async deactivate() {
+      await this.deactivate();
+    },
+  },
+  methods: {
+    ...common.methods,
+    async getSampleEvents({ pageSize }) {
+      return this.microsoftOutlook.listCalendarEvents({
+        params: {
+          $top: pageSize,
+          $orderby: "createdDateTime desc",
+        },
+      });
+    },
+    emitEvent(item) {
+      this.$emit({
+        message: item,
+      }, this.generateMeta(item));
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `New calendar event (ID:${item.id})`,
+        ts: Date.parse(item.createdDateTime),
+      };
+    },
+  },
+  async run(event) {
+    await this.run({
+      event,
+      emitFn: async ({ resourceId } = {}) => {
+        const item = await this.microsoftOutlook.getCalendarEvent({
+          eventId: resourceId,
+        });
+        this.emitEvent(item);
+      },
+    });
+  },
+};

package/sources/new-upcoming-event/new-upcoming-event.mjs

@@ -0,0 +1,92 @@
+import common from "../common.mjs";
+import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
+
+export default {
+  ...common,
+  key: "microsoft_outlook_calendar-new-upcoming-event",
+  name: "New Upcoming Calendar Event",
+  description: "Emit new event when a Calendar event is upcoming, this source is using `reminderMinutesBeforeStart` property of the event to determine the time it should emit.",
+  version: "0.0.3",
+  type: "source",
+  props: {
+    ...common.props,
+    pipedream: taskScheduler.props.pipedream,
+  },
+  hooks: {
+    ...common.hooks,
+    async activate() {
+      await this.activate({
+        changeType: "updated",
+        resource: "/me/events",
+      });
+    },
+    async deactivate() {
+      await this.deactivate();
+    },
+  },
+  methods: {
+    ...taskScheduler.methods,
+    ...common.methods,
+    _hasDeployed() {
+      const result = this.db.get("hasDeployed");
+      this.db.set("hasDeployed", true);
+      return result;
+    },
+    subtractMinutes(date, minutes) {
+      return date.getTime() - minutes * 60000;
+    },
+    async getSampleEvents({ pageSize }) {
+      return this.microsoftOutlook.listCalendarEvents({
+        params: {
+          $top: pageSize,
+          $orderby: "lastModifiedDateTime desc",
+        },
+      });
+    },
+    emitEvent(item) {
+      this.$emit({
+        message: item,
+      }, this.generateMeta(item));
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `Upcoming event - ${item.subject}`,
+        ts: +Date.parse(item.createdDateTime),
+      };
+    },
+  },
+  async run(event) {
+    if (event.$channel === this.selfChannel()) {
+      const item = await this.microsoftOutlook.getCalendarEvent({
+        eventId: event.eventId,
+      });
+      // checking if the event was modified after this scheduling
+      if (item.lastModifiedDateTime === event.lastModifiedControl) {
+        this.emitEvent(item);
+      }
+      return;
+    }
+    await this.run({
+      event,
+      emitFn: async ({ resourceId } = {}) => {
+        if (!this._hasDeployed()) {
+          await this.selfSubscribe();
+        }
+        const item = await this.microsoftOutlook.getCalendarEvent({
+          eventId: resourceId,
+        });
+        if (event.$channel !== this.selfChannel()) {
+          const startTime = new Date(item.start.dateTime || item.start.date);
+          const reminderMinutesBeforeStart = item.reminderMinutesBeforeStart || 15;
+          const later = new Date(this.subtractMinutes(startTime, reminderMinutesBeforeStart));
+          const newEvent = {
+            lastModifiedControl: item.lastModifiedDateTime,
+            eventId: resourceId,
+          };
+          this.emitScheduleEvent(newEvent, later);
+        }
+      },
+    });
+  },
+};

package/sources/updated-calendar-event/updated-calendar-event.mjs

@@ -0,0 +1,56 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "microsoft_outlook_calendar-updated-calendar-event",
+  name: "New Calendar Event Update (Instant)",
+  description: "Emit new event when a Calendar event is updated",
+  version: "0.0.7",
+  type: "source",
+  hooks: {
+    ...common.hooks,
+    async activate() {
+      await this.activate({
+        changeType: "updated",
+        resource: "/me/events",
+      });
+    },
+    async deactivate() {
+      await this.deactivate();
+    },
+  },
+  methods: {
+    ...common.methods,
+    async getSampleEvents({ pageSize }) {
+      return this.microsoftOutlook.listCalendarEvents({
+        params: {
+          $top: pageSize,
+          $orderby: "lastModifiedDateTime desc",
+        },
+      });
+    },
+    emitEvent(item) {
+      this.$emit({
+        message: item,
+      }, this.generateMeta(item));
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `Calendar event updated (ID:${item.id})`,
+        ts: Date.parse(item.createdDateTime),
+      };
+    },
+  },
+  async run(event) {
+    await this.run({
+      event,
+      emitFn: async ({ resourceId } = {}) => {
+        const item = await this.microsoftOutlook.getCalendarEvent({
+          eventId: resourceId,
+        });
+        this.emitEvent(item);
+      },
+    });
+  },
+};