Implemented getVolunteersTable API function #80

src/lib/api/getVolunteersTable.ts

@@ -0,0 +1,85 @@
+/**
+ * Fetches all volunteers with their associated cohorts and roles.
+ *
+ * @returns A Promise resolving to an array of VolunteerTableEntry objects,
+ *   where each entry contains:
+ *   - volunteer: The volunteer's core information
+ *   - cohorts: Array of cohorts the volunteer belongs to
+ *   - roles: Array of roles assigned to the volunteer
+ *
+ * @throws Error if the Supabase query fails
+ *
+ * @example
+ * const volunteersData = await getVolunteersTable();
+ * // Returns:
+ * // [
+ * //   { volunteer: Volunteer1, cohorts: [Cohort1, Cohort2], roles: [Role1, Role2] },
+ * //   { volunteer: Volunteer2, cohorts: [Cohort1], roles: [Role1] },
+ * //   ...
+ * // ]
+ */
+import { createClient } from "@/lib/client/supabase";
+import type { Database } from "@/lib/client/supabase/types";
+import type { PostgrestError } from "@supabase/supabase-js";
+
+type VolunteerRow = Database["public"]["Tables"]["Volunteers"]["Row"];
+type CohortRow = Database["public"]["Tables"]["Cohorts"]["Row"];
+type RoleRow = Database["public"]["Tables"]["Roles"]["Row"];
+
+export interface VolunteerTableEntry {
+  volunteer: VolunteerRow;
+  cohorts: CohortRow[];
+  roles: RoleRow[];
+}
+
+// Explicit type for Supabase nested select response to override incorrect inferred type
+type VolunteerWithRelations = VolunteerRow & {
+  VolunteerCohorts: Array<{ Cohorts: CohortRow | null }>;
+  VolunteerRoles: Array<{ Roles: RoleRow | null }>;
+};
+
+export async function getVolunteersTable(): Promise<VolunteerTableEntry[]> {
+  const client = await createClient();
+
+  // Single query with nested selects - type assertion for proper array inference
+  const { data, error } = (await client.from("Volunteers").select(`
+      *,
+      VolunteerCohorts ( Cohorts (*) ),
+      VolunteerRoles ( Roles (*) )
+    `)) as {
+    data: VolunteerWithRelations[] | null;
+    error: PostgrestError | null;
+  };
+
+  if (error) {
+    throw new Error(error.message || JSON.stringify(error));
+  }
+
+  if (!data || data.length === 0) {
+    return [];
+  }
+
+  // Transform nested structure to flat format
+  const result: VolunteerTableEntry[] = data.map((volunteerData) => {
+    // Extract volunteer fields and nested relation arrays
+    const { VolunteerCohorts, VolunteerRoles, ...volunteer } = volunteerData;
+
+    // Extract cohorts from nested VolunteerCohorts relation
+    const cohorts: CohortRow[] = (VolunteerCohorts ?? [])
+      .map((vc) => vc.Cohorts)
+      .filter((cohort): cohort is CohortRow => cohort !== null);
+
+    // Extract roles from nested VolunteerRoles relation
+    const roles: RoleRow[] = (VolunteerRoles ?? [])
+      .map((vr) => vr.Roles)
+      .filter((role): role is RoleRow => role !== null);
+
+    return {
+      volunteer: volunteer as VolunteerRow,
+      cohorts,
+      roles,
+    };
+  });
+
+  return result;
+}

src/lib/api/index.ts

@@ -7,3 +7,4 @@ export { getVolunteersByCohorts } from "./getVolunteersByCohorts";
 export { getVolunteersByMultipleColumns } from "./getVolunteersByMultipleColumns";
 export { getVolunteersByRoles } from "./getVolunteersByRoles";
 export { createVolunteer } from "./createVolunteer";
+export { getVolunteersTable } from "./getVolunteersTable";