Use a shared NPM package for org constants (#153)

Integrate https://github.com/acm-uiuc/js-shared for org constants (such
as list of SIGs)

Author: devksingh4

.npmrc

@@ -0,0 +1 @@
+@acm-uiuc:registry=https://registry.npmjs.org

package.json

@@ -27,7 +27,9 @@
     "test:e2e": "playwright test",
     "test:e2e-ui": "playwright test --ui"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@acm-uiuc/js-shared": "^2.1.0"
+  },
   "devDependencies": {
     "@eslint/compat": "^1.2.8",
     "@eslint/eslintrc": "^3.3.1",
@@ -87,4 +89,4 @@
   "resolutions": {
     "pdfjs-dist": "^4.8.69"
   }
-}
+}

src/api/routes/events.ts

@@ -2,7 +2,7 @@ import "zod-openapi/extend";
 import { FastifyPluginAsync, FastifyRequest } from "fastify";
 import { AppRoles } from "../../common/roles.js";
 import { z } from "zod";
-import { OrganizationList } from "../../common/orgs.js";
+import { CoreOrganizationList } from "@acm-uiuc/js-shared";
 import {
   DeleteItemCommand,
   GetItemCommand,
@@ -111,7 +111,7 @@ const baseSchema = z.object({
     description: "Google Maps link for easy navigation to the event location.",
     example: "https://maps.app.goo.gl/dwbBBBkfjkgj8gvA8",
   }),
-  host: z.enum(OrganizationList as [string, ...string[]]),
+  host: z.enum(CoreOrganizationList as [string, ...string[]]),
   featured: z.boolean().default(false).openapi({
     description:
       "Whether or not the event should be shown on the ACM @ UIUC website home page (and added to Discord, as available).",
@@ -165,7 +165,7 @@ const eventsPlugin: FastifyPluginAsyncZodOpenApi = async (
                 "If true, only get events which are marked as featured.",
             }),
             host: z
-              .enum(OrganizationList as [string, ...string[]])
+              .enum(CoreOrganizationList as [string, ...string[]])
               .optional()
               .openapi({
                 description: "Retrieve events only for a specific host.",

src/api/routes/ics.ts

@@ -14,7 +14,7 @@ import ical, {
 } from "ical-generator";
 import moment from "moment";
 import { getVtimezoneComponent } from "@touch4it/ical-timezones";
-import { OrganizationList } from "../../common/orgs.js";
+import { CoreOrganizationList } from "@acm-uiuc/js-shared";
 import { CLIENT_HTTP_CACHE_POLICY, EventRepeatOptions } from "./events.js";
 import rateLimiter from "api/plugins/rateLimiter.js";
 import { getCacheCounter } from "api/functions/cache.js";
@@ -43,7 +43,7 @@ function generateHostName(host: string) {
 
 const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
   fastify.register(rateLimiter, {
-    limit: OrganizationList.length,
+    limit: CoreOrganizationList.length,
     duration: 30,
     rateLimitIdentifier: "ical",
   });
@@ -53,7 +53,7 @@ const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
       schema: withTags(["iCalendar Integration"], {
         params: z.object({
           host: z
-            .optional(z.enum(OrganizationList as [string, ...string[]]))
+            .optional(z.enum(CoreOrganizationList as [string, ...string[]]))
             .openapi({ description: "Host to get calendar for." }),
         }),
         summary:
@@ -87,7 +87,7 @@ const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
         reply.header("etag", etag);
       }
       if (host) {
-        if (!OrganizationList.includes(host)) {
+        if (!CoreOrganizationList.includes(host)) {
           throw new ValidationError({
             message: `Invalid host parameter "${host}" in path.`,
           });

src/api/routes/organizations.ts

@@ -1,5 +1,5 @@
 import { FastifyPluginAsync } from "fastify";
-import { OrganizationList } from "../../common/orgs.js";
+import { AllOrganizationList } from "@acm-uiuc/js-shared";
 import fastifyCaching from "@fastify/caching";
 import rateLimiter from "api/plugins/rateLimiter.js";
 import { withTags } from "api/components/index.js";
@@ -23,7 +23,7 @@ const organizationsPlugin: FastifyPluginAsync = async (fastify, _options) => {
       }),
     },
     async (_request, reply) => {
-      reply.send(OrganizationList);
+      reply.send(AllOrganizationList);
     },
   );
 };

src/common/orgs.ts

@@ -1,11 +1,11 @@
-import { z } from "zod";
+import { string, z } from "zod";
 import { createPolicy } from "./evaluator.js";
-import { OrganizationList } from "../orgs.js";
+import { CoreOrganizationList } from "@acm-uiuc/js-shared";
 import { FastifyRequest } from "fastify";
 
 export const hostRestrictionPolicy = createPolicy(
   "EventsHostRestrictionPolicy",
-  z.object({ host: z.array(z.enum(OrganizationList)) }),
+  z.object({ host: z.array(z.enum(CoreOrganizationList)) }),
   (request: FastifyRequest & { username?: string }, params) => {
     if (request.method === "GET") {
       return {

src/common/policies/events.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { OrganizationList } from "../orgs.js";
+import { AllOrganizationList } from "@acm-uiuc/js-shared";
 
 export const eventThemeOptions = [
   "Arts & Music",
@@ -146,7 +146,7 @@ export const roomRequestPostResponse = z.object({
 });
 
 export const roomRequestBaseSchema = z.object({
-  host: z.enum(OrganizationList),
+  host: z.enum(AllOrganizationList),
   title: z.string().min(2, "Title must have at least 2 characters"),
   semester: z
     .string()

src/common/types/roomRequest.ts

@@ -20,7 +20,7 @@ import { useNavigate, useParams } from "react-router-dom";
 import { z } from "zod";
 import { AuthGuard } from "@ui/components/AuthGuard";
 import { useApi } from "@ui/util/api";
-import { OrganizationList as orgList } from "@common/orgs";
+import { AllOrganizationList as orgList } from "@acm-uiuc/js-shared";
 import { AppRoles } from "@common/roles";
 import { EVENT_CACHED_DURATION } from "@common/config";
 import { IconPlus, IconTrash } from "@tabler/icons-react";

src/ui/pages/events/ManageEvent.page.tsx

@@ -18,7 +18,7 @@ import {
 } from "@mantine/core";
 import { useForm, zodResolver } from "@mantine/form";
 import { DateInput, DateTimePicker } from "@mantine/dates";
-import { OrganizationList } from "@common/orgs";
+import { AllOrganizationList } from "@acm-uiuc/js-shared";
 import {
   eventThemeOptions,
   spaceTypeOptions,
@@ -401,7 +401,10 @@ const NewRoomRequest: React.FC<NewRoomRequestProps> = ({
             placeholder="Select host organization"
             withAsterisk
             searchable
-            data={OrganizationList.map((org) => ({ value: org, label: org }))}
+            data={AllOrganizationList.map((org) => ({
+              value: org,
+              label: org,
+            }))}
             {...form.getInputProps("host")}
           />
           <TextInput