BO16 - Create an endpoint to list all Sponsorship levels and Sponsors

firebase-data/firebase-export-metadata.json

@@ -1,12 +1,12 @@
 {
-  "version": "13.7.4",
+  "version": "13.13.0",
   "firestore": {
-    "version": "1.19.5",
+    "version": "1.19.7",
     "path": "firestore_export",
     "metadata_file": "firestore_export/firestore_export.overall_export_metadata"
   },
   "auth": {
-    "version": "13.7.4",
+    "version": "13.13.0",
     "path": "auth_export"
   }
 }

src/data/firestore/partenership/get-partnership-paginated.ts

@@ -0,0 +1,32 @@
+import type { PaginationParams } from "~/models/pagination/pagination.type";
+import type { Partnership } from "~/models/partnership/partnership.type";
+import getDocsPaginated from "../common/get-docs-paginated";
+import { partnerDataConverter, partnershipDataConverter } from "./models";
+import { getFirestore } from "firebase-admin/firestore";
+import { firestoreInstance } from "~/firebase/server";
+
+const collection = "partnerships" as const;
+
+
+const getPartnershipsPaginated = async (params: PaginationParams<Partnership>) => {
+    const result = await getDocsPaginated(collection, partnershipDataConverter, params);
+
+    if (result.status == "success") {
+        result.data.data = await Promise.all(
+            result.data.data.map(async (p) => {
+                const snapshot = await firestoreInstance.collection(`${collection}/${p.id}/partners`)
+                  .withConverter(partnerDataConverter)
+                  .orderBy("position", "asc")
+                  .get();
+
+                p.partners = snapshot.docs.map((partnerDoc) => partnerDoc.data());
+
+                return p;
+            })
+        );
+    }
+
+    return result;
+}
+
+export { getPartnershipsPaginated };

src/data/firestore/partenership/models.ts

@@ -0,0 +1,38 @@
+import type { FirestoreDataConverter, QueryDocumentSnapshot } from "firebase-admin/firestore";
+import type { FirestoreDocument } from "~/data/model-document-mapper";
+import type { Partner, Partnership } from "~/models/partnership/partnership.type";
+
+type PartnershipDoc = FirestoreDocument<Partnership>;
+type PartnerDoc = FirestoreDocument<Partner>;
+
+const partnerDataConverter: FirestoreDataConverter<Partner, PartnerDoc> = {
+    toFirestore: (model: Partner) => {
+        delete model.id;
+        return { ...model };
+    },
+
+    fromFirestore: (snapshot: QueryDocumentSnapshot) => {
+        const data = snapshot.data() as PartnerDoc;
+        data.id = snapshot.id;
+
+        return { ...data };
+    }
+}
+
+const partnershipDataConverter: FirestoreDataConverter<Partnership, PartnershipDoc> = {
+    toFirestore: (model: Partnership): PartnershipDoc => {
+        delete model.id
+        delete model.partners
+
+        return { ...model };
+    },
+    fromFirestore: (snapshot: QueryDocumentSnapshot): Partnership => {
+        const data = snapshot.data();
+        return {
+            id: snapshot.id,
+            ...data,
+        } as Partnership;
+    },
+};
+
+export { partnerDataConverter, partnershipDataConverter }

src/models/partnership/partnership.schema.ts

@@ -0,0 +1,18 @@
+import { z } from "astro/zod";
+
+const PartnerSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    logo: z.string(),
+    position: z.number(),
+    link: z.string(),
+});
+
+const PartnershipSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    position: z.number(),
+    partners: z.array(PartnerSchema),
+});
+
+export { PartnerSchema, PartnershipSchema };

src/models/partnership/partnership.type.ts

@@ -0,0 +1,17 @@
+type Partner = {
+    id?: string;
+    name: string;
+    logo: string;
+    position: number;
+    link: string;
+};
+
+type Partnership = {
+    id?: string;
+    name: string;
+    position: number;
+    partners?: Partner[];
+};
+
+
+export type { Partner, Partnership}

tests/partnership.test.ts

@@ -0,0 +1,49 @@
+import { test, expect, } from "@playwright/test";
+import { getPartnershipsPaginated } from "~/data/firestore/partenership/get-partnership-paginated";
+import { partnerDataConverter, partnershipDataConverter } from "~/data/firestore/partenership/models";
+import { firestoreInstance } from "~/firebase/server";
+import type { PaginatedResponse } from "~/models/pagination/pagination.type";
+import type { Partnership } from "~/models/partnership/partnership.type";
+
+test("get partnership after creating it", async ({ page }) => {
+    const partnership: Partnership = {
+        id: "test-partnership",
+        name: "test partnership",
+        position: 1,
+        partners: [{
+            id: "test-partner",
+            name: "test partner",
+            logo: "test logo",
+            link: "test url",
+            position: 1,
+        }],
+    };
+
+    await firestoreInstance
+        .doc("partnerships/test-partnership")
+        .withConverter(partnershipDataConverter)
+        .set(partnership);
+
+    await firestoreInstance.doc("partnerships/test-partnership/partners/test-partner")
+        .withConverter(partnerDataConverter)
+        .set(partnership.partners![0]);
+
+
+    const result = await getPartnershipsPaginated({
+        offset: 0,
+        limit: 10,
+        orderBy: "position",
+        orderDirection: "asc"
+    });
+
+    const equivalentResultData : PaginatedResponse<Partnership> = {
+        data: [partnership],
+        total: 1,
+        limit: 10,
+        offset: 0,
+        totalPages: 1,
+    };
+
+    await expect(result.status).toEqual("success");
+    await expect(result.data).toEqual(equivalentResultData); 
+});