build ical support

Author: devksingh4

package.json

@@ -56,10 +56,13 @@
     "@fastify/auth": "^4.6.1",
     "@fastify/aws-lambda": "^4.1.0",
     "@fastify/cors": "^9.0.1",
+    "@touch4it/ical-timezones": "^1.9.0",
     "fastify": "^4.28.1",
     "fastify-plugin": "^4.5.1",
+    "ical-generator": "^7.2.0",
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.1.0",
+    "moment": "^2.30.1",
     "moment-timezone": "^0.5.45",
     "zod": "^3.23.8",
     "zod-to-json-schema": "^3.23.2",

src/index.ts

@@ -12,6 +12,7 @@ import cors from "@fastify/cors";
 import fastifyZodValidationPlugin from "./plugins/validate.js";
 import { environmentConfig } from "./config.js";
 import organizationsPlugin from "./routes/organizations.js";
+import icalPlugin from "./routes/ics.js";
 
 const now = () => Date.now();
 
@@ -66,6 +67,7 @@ async function init() {
       api.register(protectedRoute, { prefix: "/protected" });
       api.register(eventsPlugin, { prefix: "/events" });
       api.register(organizationsPlugin, { prefix: "/organizations" });
+      api.register(icalPlugin, { prefix: "/ical" });
     },
     { prefix: "/api/v1" },
   );

src/orgs.ts

@@ -23,4 +23,4 @@ export const CommitteeList = [
   "Social Committee",
   "Mentorship Committee",
 ] as const;
-export const OrganizationList = ["ACM", ...SIGList, ...CommitteeList] as const;
+export const OrganizationList = ["ACM", ...SIGList, ...CommitteeList];

src/routes/events.ts

@@ -18,6 +18,7 @@ import moment from "moment-timezone";
 // POST
 
 const repeatOptions = ["weekly", "biweekly"] as const;
+export type EventRepeatOptions = (typeof repeatOptions)[number];
 
 const baseSchema = z.object({
   title: z.string().min(1),
@@ -26,7 +27,7 @@ const baseSchema = z.object({
   end: z.optional(z.string()),
   location: z.string(),
   locationLink: z.optional(z.string().url()),
-  host: z.enum(OrganizationList),
+  host: z.enum(OrganizationList as [string, ...string[]]),
   featured: z.boolean().default(false),
   paidEventId: z.optional(z.string().min(1)),
 });
@@ -91,11 +92,14 @@ const eventsPlugin: FastifyPluginAsync = async (fastify, _options) => {
         await dynamoClient.send(
           new PutItemCommand({
             TableName: genericConfig.DynamoTableName,
-            Item: marshall({
-              ...request.body,
-              id: entryUUID,
-              createdBy: request.username,
-            }),
+            Item: marshall(
+              {
+                ...request.body,
+                id: entryUUID,
+                createdBy: request.username,
+              },
+              { removeUndefinedValues: true },
+            ),
           }),
         );
         reply.send({

src/routes/ics.ts

@@ -0,0 +1,138 @@
+import { FastifyPluginAsync } from "fastify";
+import {
+  DynamoDBClient,
+  QueryCommand,
+  QueryCommandInput,
+  ScanCommand,
+} from "@aws-sdk/client-dynamodb";
+import { genericConfig } from "../config.js";
+import { unmarshall } from "@aws-sdk/util-dynamodb";
+import { NotFoundError, ValidationError } from "../errors/index.js";
+import ical, {
+  ICalCalendarMethod,
+  ICalEventJSONRepeatingData,
+  ICalEventRepeatingFreq,
+} from "ical-generator";
+import moment from "moment";
+import { getVtimezoneComponent } from "@touch4it/ical-timezones";
+import { OrganizationList } from "../orgs.js";
+import { EventRepeatOptions } from "./events.js";
+
+const dynamoClient = new DynamoDBClient({
+  region: genericConfig.AwsRegion,
+});
+
+const repeatingIcalMap: Record<EventRepeatOptions, ICalEventJSONRepeatingData> =
+  {
+    weekly: { freq: ICalEventRepeatingFreq.WEEKLY },
+    biweekly: { freq: ICalEventRepeatingFreq.WEEKLY, interval: 2 },
+  };
+
+function generateHostName(host: string) {
+  if (host == "ACM" || !host) {
+    return "ACM@UIUC";
+  }
+  if (host.includes("ACM")) {
+    return host;
+  }
+  return `ACM@UIUC ${host}`;
+}
+
+const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
+  fastify.get("/:host?", async (request, reply) => {
+    const host = (request.params as Record<string, string>).host;
+    let queryParams: QueryCommandInput = {
+      TableName: genericConfig.DynamoTableName,
+    };
+    let response;
+    if (host) {
+      if (!OrganizationList.includes(host)) {
+        throw new ValidationError({
+          message: `Invalid host parameter "${host}" in path.`,
+        });
+      }
+      queryParams = {
+        ...queryParams,
+      };
+      response = await dynamoClient.send(
+        new QueryCommand({
+          ...queryParams,
+          ExpressionAttributeValues: {
+            ":host": {
+              S: host,
+            },
+          },
+          KeyConditionExpression: "host = :host",
+          IndexName: "HostIndex",
+        }),
+      );
+    } else {
+      response = await dynamoClient.send(new ScanCommand(queryParams));
+    }
+    const dynamoItems = response.Items
+      ? response.Items.map((x) => unmarshall(x))
+      : null;
+    if (!dynamoItems) {
+      throw new NotFoundError({
+        endpointName: host ? `/api/v1/ical/${host}` : "/api/v1/ical",
+      });
+    }
+    // generate friendly calendar name
+    let calendarName =
+      host && host.includes("ACM")
+        ? `${host} Events`
+        : `ACM@UIUC - ${host} Events`;
+    if (!host) {
+      calendarName = "ACM@UIUC - All Events";
+    }
+    const calendar = ical({ name: calendarName });
+    calendar.timezone({
+      name: "America/Chicago",
+      generator: getVtimezoneComponent,
+    });
+    calendar.method(ICalCalendarMethod.PUBLISH);
+    for (const rawEvent of dynamoItems) {
+      let event = calendar.createEvent({
+        start: moment.tz(rawEvent.start, "America/Chicago"),
+        end: rawEvent.end
+          ? moment.tz(rawEvent.end, "America/Chicago")
+          : moment.tz(rawEvent.start, "America/Chicago"),
+        summary: rawEvent.title,
+        description: rawEvent.locationLink
+          ? `Host: ${rawEvent.host}\nGoogle Maps Link: ${rawEvent.locationLink}\n\n` +
+            rawEvent.description
+          : `Host: ${rawEvent.host}\n\n` + rawEvent.description,
+        timezone: "America/Chicago",
+        organizer: generateHostName(host),
+        id: rawEvent.id,
+      });
+
+      if (rawEvent.repeats) {
+        if (rawEvent.repeatEnds) {
+          event = event.repeating({
+            ...repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+            until: moment.tz(rawEvent.repeatEnds, "America/Chicago"),
+          });
+        } else {
+          event.repeating(
+            repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+          );
+        }
+      }
+      if (rawEvent.location) {
+        event = event.location({
+          title: rawEvent.location,
+        });
+      }
+    }
+
+    reply
+      .headers({
+        "Content-Type": "text/calendar; charset=utf-8",
+        "Content-Disposition": 'attachment; filename="calendar.ics"',
+      })
+      .send(calendar.toString());
+  });
+};
+
+export default icalPlugin;

tests/unit/eventPost.test.ts

@@ -144,6 +144,7 @@ test("Happy path: Adding a non-repeating, featured, paid event", async () => {
       featured: true,
       host: "Social Committee",
       location: "Illini Union",
+      locationLink: "https://maps.app.goo.gl/rUBhjze5mWuTSUJK9",
       start: "2024-09-25T18:00:00",
       title: "Fall Semiformal",
       paidEventId: "sp24_semiformal",

yarn.lock

@@ -1521,6 +1521,11 @@
     "@smithy/types" "^3.3.0"
     tslib "^2.6.2"
 
+"@touch4it/ical-timezones@^1.9.0":
+  version "1.9.0"
+  resolved "https://registry.yarnpkg.com/@touch4it/ical-timezones/-/ical-timezones-1.9.0.tgz#bbd85014f55b5cc3e9079ed7caccd8649b5170a3"
+  integrity sha512-UAiZMrFlgMdOIaJDPsKu5S7OecyMLr3GGALJTYkRgHmsHAA/8Ixm1qD09ELP2X7U1lqgrctEgvKj9GzMbczC+g==
+
 "@tsconfig/node20@^20.1.4":
   version "20.1.4"
   resolved "https://registry.yarnpkg.com/@tsconfig/node20/-/node20-20.1.4.tgz#3457d42eddf12d3bde3976186ab0cd22b85df928"
@@ -3541,6 +3546,13 @@ husky@^9.1.4:
   resolved "https://registry.yarnpkg.com/husky/-/husky-9.1.4.tgz#926fd19c18d345add5eab0a42b2b6d9a80259b34"
   integrity sha512-bho94YyReb4JV7LYWRWxZ/xr6TtOTt8cMfmQ39MQYJ7f/YE268s3GdghGwi+y4zAeqewE5zYLvuhV0M0ijsDEA==
 
+ical-generator@^7.2.0:
+  version "7.2.0"
+  resolved "https://registry.yarnpkg.com/ical-generator/-/ical-generator-7.2.0.tgz#45589146e81693065a39c6f42007abe34e07c4b9"
+  integrity sha512-7I34QvxWqIRthaao81lmapa0OjftfDaSBZmADjV0IqxVMUWT5ywlATRsv/hZN9Rgf2VgRsnMY+xUUaA4ZvAJLA==
+  dependencies:
+    uuid-random "^1.3.2"
+
 iconv-lite@^0.4.24:
   version "0.4.24"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b"
@@ -4226,7 +4238,7 @@ moment-timezone@^0.5.45:
   dependencies:
     moment "^2.29.4"
 
-moment@^2.29.4:
+moment@^2.29.4, moment@^2.30.1:
   version "2.30.1"
   resolved "https://registry.yarnpkg.com/moment/-/moment-2.30.1.tgz#f8c91c07b7a786e30c59926df530b4eac96974ae"
   integrity sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==
@@ -5467,6 +5479,11 @@ uri-js@^4.2.2:
   dependencies:
     punycode "^2.1.0"
 
+uuid-random@^1.3.2:
+  version "1.3.2"
+  resolved "https://registry.yarnpkg.com/uuid-random/-/uuid-random-1.3.2.tgz#96715edbaef4e84b1dcf5024b00d16f30220e2d0"
+  integrity sha512-UOzej0Le/UgkbWEO8flm+0y+G+ljUon1QWTEZOq1rnMAsxo2+SckbiZdKzAHHlVh6gJqI1TjC/xwgR50MuCrBQ==
+
 uuid@^3.3.2:
   version "3.4.0"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee"