feat: add timetabl type definition

Author: debater-coder

apps/client/src/interfaces/DataProvider.ts

@@ -1,28 +1,63 @@
 import { DateTime } from "luxon";
 
-// A data provider provides a queryFn and a select function. The result of
-// queryFn should be serializable and deserializable with JSON.stringify. THis
-// means types like Date will not work, as they will be serialised to a string
-// but not deserialised back to a Date.
-
-type LongOrShortString = {
+export type LongOrShortString = {
   short: string;
   long?: string;
 };
 
-type Period = {
+export type Period = {
   start: DateTime;
   end: DateTime;
   teacher?: LongOrShortString;
   name?: LongOrShortString;
   location?: LongOrShortString;
 };
 
-export interface DataProvider {
+export const ContentEncodings = ["html", "markdown"] as const;
+export type ContentEncoding = typeof ContentEncodings[number];
+
+export type Notice<TAudience> = {
+  date: DateTime;
+  title: string;
+  content: string;
+  content_encoding: ContentEncoding;
+  audiences: TAudience[];
+  author: string;
+};
+
+// Fetch output must be serialisable to JSON
+export interface DataProvider<TAudience> {
   activate(): void;
   deactivate(): void;
   isActivated(): boolean;
 
-  // Returns a scan-on barcode if applicable
-  barcode?(): Promise<string>;
+  config: {
+    name: LongOrShortString;
+    description: LongOrShortString;
+  };
+
+  barcode?: {
+    fetch: () => Promise<unknown>;
+    parse: (data: unknown) => string;
+  };
+
+  // Day Timetable
+  dtt?: {
+    fetch: (date: DateTime) => Promise<unknown>;
+    parse: (data: unknown) => Period[];
+  };
+
+  cycle?: {
+    fetch: () => Promise<unknown>;
+    parse: (data: unknown) => Period[];
+  };
+
+  notices?: {
+    fetch: () => Promise<unknown>;
+    parse: (data: unknown) => Notice<TAudience>[];
+  };
+
+  newsletter?: {
+    newsletterDownloadUrl: string;
+  };
 }