@pipedream/microsoft_outlook_calendar 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,5 @@
+# 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.

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/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

@@ -0,0 +1,184 @@
+import { axios } from "@pipedream/platform";
+
+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`)",
+      type: "string",
+      optional: true,
+      options: [
+        "text",
+        "html",
+      ],
+      default: "text",
+    },
+    content: {
+      label: "Content",
+      description: "Content of the email in text or html format",
+      type: "string",
+      optional: true,
+    },
+    timeZone: {
+      label: "Time Zone",
+      description: "Time zone of the event in supported time zones, [See the docs](https://docs.microsoft.com/en-us/graph/api/outlookuser-supportedtimezones)",
+      type: "string",
+      async options() {
+        const timeZonesResponse = await this.getSupportedTimeZones();
+        return timeZonesResponse.value.map((tz) => ({
+          label: tz.displayName,
+          value: tz.alias,
+        }));
+      },
+    },
+    start: {
+      label: "Start",
+      description: "Start date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T11:20:00'",
+      type: "string",
+    },
+    end: {
+      label: "End",
+      description: "End date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T13:30:00'",
+      type: "string",
+    },
+    attendees: {
+      label: "Attendees",
+      description: "Array of email addresses",
+      type: "string[]",
+    },
+    location: {
+      label: "Location",
+      description: "Location of the event",
+      type: "string",
+      optional: true,
+    },
+    isOnlineMeeting: {
+      label: "Is Online Meeting",
+      description: "If it is online meeting or not",
+      type: "boolean",
+      optional: true,
+    },
+    expand: {
+      label: "Expand",
+      description: "Additional properties",
+      type: "object",
+      optional: true,
+    },
+  },
+  methods: {
+    _getUrl(path) {
+      return `https://graph.microsoft.com/v1.0${path}`;
+    },
+    _getHeaders() {
+      return {
+        "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+        "accept": "application/json",
+        "Content-Type": "application/json",
+      };
+    },
+    async _makeRequest({
+      $,
+      path,
+      headers,
+      ...otherConfig
+    } = {}) {
+      const config = {
+        url: this._getUrl(path),
+        headers: this._getHeaders(headers),
+        ...otherConfig,
+      };
+      return axios($ ?? this, config);
+    },
+    async createHook(args = {}) {
+      const response = await this._makeRequest({
+        method: "POST",
+        path: "/subscriptions",
+        ...args,
+      });
+      return response;
+    },
+    async renewHook({
+      hookId,
+      ...args
+    } = {}) {
+      return this._makeRequest({
+        method: "PATCH",
+        path: `/subscriptions/${hookId}`,
+        ...args,
+      });
+    },
+    async deleteHook({
+      hookId,
+      ...args
+    } = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/subscriptions/${hookId}`,
+        ...args,
+      });
+    },
+    async getSupportedTimeZones() {
+      return this._makeRequest({
+        method: "GET",
+        path: "/me/outlook/supportedTimeZones",
+      });
+    },
+    async createCalendarEvent(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/me/events",
+        ...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",
+        path: "/me/events",
+        ...args,
+      });
+    },
+    async getCalendarEvent({
+      eventId,
+      ...args
+    } = {}) {
+      return this._makeRequest({
+        method: "GET",
+        path: `/me/events/${eventId}`,
+        ...args,
+      });
+    },
+  },
+};

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@pipedream/microsoft_outlook_calendar",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream Microsoft Outlook Calendar Components",
-  "main": "dist/app/microsoft_outlook_calendar.app.mjs",
+  "main": "microsoft_outlook_calendar.app.mjs",
   "keywords": [
     "pipedream",
-    "microsoft_outlook_calendar"
-  ],
-  "files": [
-    "dist"
+    "microsoft_outlook_calendar",
+    "microsoft",
+    "outlook"
   ],
   "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"
   }

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);
+      },
+    });
+  },
+};