@pipedream/microsoft_outlook_calendar 0.3.4 → 0.5.0

package/actions/delete-recurring-event-instance/delete-recurring-event-instance.mjs

@@ -0,0 +1,59 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  type: "action",
+  key: "microsoft_outlook_calendar-delete-recurring-event-instance",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  name: "Delete Recurring Event Instance",
+  description: "Delete an individual instance of a recurring 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,
+    recurringEventId: {
+      propDefinition: [
+        microsoftOutlook,
+        "recurringEventId",
+      ],
+    },
+    startDateTime: {
+      type: "string",
+      label: "Start Date Time",
+      description: "The start of the time range to find instances, in ISO 8601 format (e.g., `2024-01-01T00:00:00Z`)",
+    },
+    endDateTime: {
+      type: "string",
+      label: "End Date Time",
+      description: "The end of the time range to find instances, in ISO 8601 format (e.g., `2024-12-31T23:59:59Z`)",
+    },
+    instanceId: {
+      propDefinition: [
+        microsoftOutlook,
+        "instanceId",
+        (c) => ({
+          recurringEventId: c.recurringEventId,
+          startDateTime: c.startDateTime,
+          endDateTime: c.endDateTime,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    if (new Date(this.startDateTime) >= new Date(this.endDateTime)) {
+      throw new ConfigurationError("`Start Date Time` must be before `End Date Time`");
+    }
+
+    const response = await this.microsoftOutlook.deleteCalendarEvent({
+      $,
+      eventId: this.instanceId,
+    });
+
+    $.export("$summary", `Successfully deleted recurring event instance with ID ${this.instanceId}`);
+
+    return response;
+  },
+};

package/actions/update-recurring-event-instance/update-recurring-event-instance.mjs

@@ -0,0 +1,186 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  type: "action",
+  key: "microsoft_outlook_calendar-update-recurring-event-instance",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  name: "Update Recurring Event Instance",
+  description: "Update an individual instance of a recurring 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,
+    recurringEventId: {
+      propDefinition: [
+        microsoftOutlook,
+        "recurringEventId",
+      ],
+    },
+    startDateTime: {
+      type: "string",
+      label: "Start Date Time",
+      description: "The start of the time range to find instances, in ISO 8601 format (e.g., `2024-01-01T00:00:00Z`)",
+    },
+    endDateTime: {
+      type: "string",
+      label: "End Date Time",
+      description: "The end of the time range to find instances, in ISO 8601 format (e.g., `2024-12-31T23:59:59Z`)",
+    },
+    instanceId: {
+      propDefinition: [
+        microsoftOutlook,
+        "instanceId",
+        (c) => ({
+          recurringEventId: c.recurringEventId,
+          startDateTime: c.startDateTime,
+          endDateTime: c.endDateTime,
+        }),
+      ],
+    },
+    subject: {
+      label: "Subject",
+      description: "Subject of the event instance",
+      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",
+      ],
+      description: "New start date-time for this instance (yyyy-MM-ddThh:mm:ss). Requires **Time Zone** to be set.",
+      optional: true,
+    },
+    end: {
+      propDefinition: [
+        microsoftOutlook,
+        "end",
+      ],
+      description: "New end date-time for this instance (yyyy-MM-ddThh:mm:ss). Requires **Time Zone** to be set.",
+      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({ $ }) {
+    if (new Date(this.startDateTime) >= new Date(this.endDateTime)) {
+      throw new ConfigurationError("`Start Date Time` must be before `End Date Time`");
+    }
+
+    const data = {
+      ...this.expand,
+    };
+
+    if (this.subject) {
+      data.subject = this.subject;
+    }
+
+    if (this.isOnlineMeeting !== undefined) {
+      data.isOnlineMeeting = this.isOnlineMeeting;
+    }
+
+    if (this.location) {
+      data.location = {
+        displayName: this.location,
+      };
+    }
+
+    if (this.content) {
+      data.body = {
+        contentType: this.contentType ?? "text",
+        content: this.content,
+      };
+    }
+
+    if ((this.start || this.end) && !this.timeZone) {
+      throw new ConfigurationError("Time Zone is required when updating start or end times");
+    }
+    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,
+        },
+      }));
+    }
+
+    if (!Object.keys(data).length) {
+      throw new ConfigurationError("At least one field must be provided to update the event instance");
+    }
+
+    const response = await this.microsoftOutlook.updateCalendarEvent({
+      $,
+      eventId: this.instanceId,
+      data,
+    });
+
+    $.export("$summary", `Successfully updated recurring event instance with ID ${response?.id ?? this.instanceId}`);
+
+    return response;
+  },
+};

package/microsoft_outlook_calendar.app.mjs

@@ -17,6 +17,45 @@ export default {
         }));
       },
     },
+    recurringEventId: {
+      label: "Recurring Event ID",
+      description: "The ID of the recurring event series",
+      type: "string",
+      async options() {
+        const { value: events } = await this.listCalendarEvents();
+
+        return events
+          .filter((event) => event.recurrence)
+          .map((event) => ({
+            label: event.subject,
+            value: event.id,
+          }));
+      },
+    },
+    instanceId: {
+      label: "Instance ID",
+      description: "The ID of the specific occurrence of the recurring event",
+      type: "string",
+      async options({
+        recurringEventId, startDateTime, endDateTime,
+      }) {
+        if (!recurringEventId || !startDateTime || !endDateTime) {
+          return [];
+        }
+        const { value: instances } = await this.listEventInstances({
+          eventId: recurringEventId,
+          params: {
+            startDateTime,
+            endDateTime,
+          },
+        });
+
+        return instances.map((instance) => ({
+          label: `${instance.subject} - ${instance.start?.dateTime}`,
+          value: instance.id,
+        }));
+      },
+    },
     contentType: {
       label: "Content Type",
       description: "Content type (default `text`)",
@@ -188,5 +227,14 @@ export default {
         ...args,
       });
     },
+    async listEventInstances({
+      eventId, ...args
+    }) {
+      return this._makeRequest({
+        method: "GET",
+        path: `/me/events/${eventId}/instances`,
+        ...args,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/microsoft_outlook_calendar",
-  "version": "0.3.4",
+  "version": "0.5.0",
   "description": "Pipedream Microsoft Outlook Calendar Components",
   "main": "microsoft_outlook_calendar.app.mjs",
   "keywords": [
@@ -17,7 +17,7 @@
   "dependencies": {
     "@pipedream/microsoft_outlook": "^1.7.3",
     "@pipedream/pipedream": "^0.4.2",
-    "@pipedream/platform": "^3.1.0",
+    "@pipedream/platform": "^3.1.1",
     "luxon": "^3.7.2",
     "windows-iana": "^5.1.0"
   }

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

@@ -0,0 +1,137 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  key: "microsoft_outlook_calendar-new-upcoming-event-polling",
+  name: "New Upcoming Calendar Event (Polling)",
+  description: "Emit new event based on a time interval before an upcoming calendar event. [See the documentation](https://docs.microsoft.com/en-us/graph/api/user-list-events)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    microsoftOutlook,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    pollingInfo: {
+      type: "alert",
+      alertType: "info",
+      content: "Since this source executes based on a timer, event emission may be slightly delayed. For example, if the source runs every 5 minutes, the delay may be up to 5 minutes. You can use the `new-upcoming-event` source for instant event emission.",
+    },
+    minutesBefore: {
+      type: "integer",
+      label: "Minutes Before",
+      description: "Number of minutes to trigger before the start of the calendar event.",
+      min: 0,
+      default: 30,
+    },
+  },
+  methods: {
+    _getEmittedEvents() {
+      return this.db.get("emittedEvents") || {};
+    },
+    _setEmittedEvents(emittedEvents) {
+      this.db.set("emittedEvents", emittedEvents);
+    },
+    _cleanupEmittedEvents(now) {
+      const emittedEvents = this._getEmittedEvents();
+      const cleanedEvents = {};
+      let cleanedCount = 0;
+
+      // Keep only events that haven't passed yet
+      for (const [
+        eventId,
+        startTime,
+      ] of Object.entries(emittedEvents)) {
+        if (startTime > now.getTime()) {
+          cleanedEvents[eventId] = startTime;
+        } else {
+          cleanedCount++;
+        }
+      }
+
+      if (cleanedCount > 0) {
+        console.log(`Cleaned up ${cleanedCount} past event(s) from emitted events tracker`);
+        this._setEmittedEvents(cleanedEvents);
+      }
+
+      return cleanedEvents;
+    },
+    generateMeta(event) {
+      const ts = event.start?.dateTime
+        ? Date.parse(event.start.dateTime)
+        : Date.now();
+      return {
+        id: `${event.uid}-${ts}`,
+        summary: `Upcoming: ${event.subject || "(untitled)"}`,
+        ts,
+      };
+    },
+  },
+  hooks: {
+    async deploy() {
+      // On initial deploy, don't emit historical events
+      // Just initialize the emitted events tracker
+      this._setEmittedEvents({});
+    },
+  },
+  async run() {
+    const now = new Date();
+    const alertWindowMs = this.minutesBefore * 60 * 1000;
+    const timeMax = new Date(now.getTime() + alertWindowMs).toISOString();
+
+    // Clean up old emitted events
+    const emittedEvents = this._cleanupEmittedEvents(now);
+
+    // Fetch events within the alert window
+    const { value: events } = await this.microsoftOutlook.listCalendarView({
+      params: {
+        startDateTime: now.toISOString(),
+        endDateTime: timeMax,
+        $orderby: "start/dateTime",
+      },
+    });
+
+    if (!events || events.length === 0) {
+      console.log("No upcoming events found in the alert window");
+      return;
+    }
+
+    for (const event of events) {
+      // Skip if already emitted
+      if (emittedEvents[event.uid]) {
+        continue;
+      }
+
+      const startTime = event.start
+        ? new Date(event.start.dateTime)
+        : null;
+
+      if (!startTime) {
+        continue;
+      }
+
+      const timeRemaining = startTime.getTime() - now.getTime();
+      if (timeRemaining < 0) {
+        continue;
+      }
+
+      const alertThresholdMs = this.minutesBefore * 60 * 1000;
+
+      // Emit if time remaining is less than or equal to the alert threshold
+      if (timeRemaining <= alertThresholdMs) {
+        emittedEvents[event.uid] = startTime.getTime();
+
+        const meta = this.generateMeta(event);
+        this.$emit(event, meta);
+      }
+    }
+
+    this._setEmittedEvents(emittedEvents);
+  },
+};
+