feat: stubs for data providers

Author: debater-coder

apps/client/src/interfaces/DataProvider.ts

@@ -26,14 +26,14 @@ export type Notice<TAudience> = {
 };
 
 // Fetch output must be serialisable to JSON
-export interface DataProvider<TAudience> {
+export interface DataProvider<TAudience = never> {
   activate(): void;
   deactivate(): void;
   isActivated(): boolean;
 
   config: {
     name: LongOrShortString;
-    description: LongOrShortString;
+    description: string;
   };
 
   barcode?: {
@@ -58,6 +58,7 @@ export interface DataProvider<TAudience> {
   };
 
   newsletter?: {
-    newsletterDownloadUrl: string;
+    downloadUrl: string;
+    name: string;
   };
 }

apps/client/src/services/dataProviders/SbhsDataProvider/SbhsDataProvider.ts

@@ -0,0 +1,44 @@
+import { NoticeYear } from "../../../consumers/sbhsApi/schemas";
+import { DataProvider, Notice, Period } from "../../../interfaces/DataProvider";
+import { DateTime } from "luxon";
+
+export class SbhsDataProvider implements DataProvider<NoticeYear> {
+  activate(): void {
+    throw new Error("Method not implemented.");
+  }
+  deactivate(): void {
+    throw new Error("Method not implemented.");
+  }
+  isActivated(): boolean {
+    throw new Error("Method not implemented.");
+  }
+
+  config = {
+    name: { short: "SBHS", long: "SBHS Student Portal" },
+    description: "Accesses timetable and notices from the SBHS Student Portal.",
+  };
+
+  barcode?:
+    | { fetch: () => Promise<unknown>; parse: (data: unknown) => string }
+    | undefined;
+
+  dtt?:
+    | {
+        fetch: (date: DateTime) => Promise<unknown>;
+        parse: (data: unknown) => Period[];
+      }
+    | undefined;
+
+  cycle?:
+    | { fetch: () => Promise<unknown>; parse: (data: unknown) => Period[] }
+    | undefined;
+
+  notices?:
+    | {
+        fetch: () => Promise<unknown>;
+        parse: (data: unknown) => Notice<NoticeYear>[];
+      }
+    | undefined;
+
+  newsletter = { downloadUrl: "https://sbhs.co/hnpdf", name: "High Notes" };
+}

apps/client/src/services/dataProviders/SbhsDataProvider/index.ts

@@ -0,0 +1 @@
+export { SbhsDataProvider } from "./SbhsDataProvider";

apps/client/src/services/dataProviders/TestDataProvider/TestDataProvider.ts

@@ -0,0 +1,37 @@
+import { DataProvider } from "../../../interfaces/DataProvider";
+import { z } from "zod";
+
+export class TestDataProvider implements DataProvider {
+  private activated = false;
+
+  activate = () => {
+    this.activated = true;
+  };
+
+  deactivate = () => {
+    this.activated = false;
+  };
+
+  isActivated = () => this.activated;
+
+  config = {
+    name: { short: "Test" },
+    description: "Test",
+  };
+
+  // Example implentation of fetch and parse
+  barcode = {
+    fetch: async () => ({
+      barcode: "Test Barcode", // In reality, this would be fetched from the API
+    }),
+
+    parse: (data: unknown) => {
+      const barcodeSchema = z.object({
+        barcode: z.string(),
+      });
+      const { barcode } = barcodeSchema.parse(data);
+
+      return barcode;
+    },
+  };
+}