The real type interface was the friends we made along the way

.github/PULL_REQUEST_TEMPLATE/PR.md → .github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,13 @@
 
 ---
 
+## TL;DR
+<!-- TLDR Guide
+  List any steps devs have to take after pulling this down
+  -->
+
+---
+
 ## Gallery
 <!-- Gallery Guide
   Delete if irrelevant

README.md

@@ -395,8 +395,8 @@ The project follows a standard SvelteKit structure:
 
 ## Documentation
 
-- [FUNCTIONAL.md](./HITL_Docs/FUNCTIONAL.md) - Functional requirements
-- [ARCHITECTURE.md](./HITL_Docs/ARCHITECTURE.md) - Technical architecture
-- [TESTING.md](./HITL_Docs/TESTING.md) - Testing guide
+- [FUNCTIONAL.md](./docs/HITL_Docs/FUNCTIONAL.md) - Functional requirements
+- [ARCHITECTURE.md](./docs/HITL_Docs/ARCHITECTURE.md) - Technical architecture
+- [TESTING.md](./docs/HITL_Docs/TESTING.md) - Testing guide
 
 Explore this codebase on [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/foundersandcoders/LIFT02)

package.json

@@ -49,6 +49,7 @@
 	"dependencies": {
 		"@fontsource/metropolis": "^5.2.5",
 		"@supabase/supabase-js": "^2.49.8",
-		"dotenv": "^16.5.0"
+		"dotenv": "^16.5.0",
+		"zod": "^3.25.51"
 	}
 }

src/lib/types/main.ts

@@ -0,0 +1,63 @@
+import type { User, Employer, Pronouns } from "./sub";
+
+export type Input = Profile | Question | Response | Action | Share;
+
+export interface Profile {
+  id?: string;
+  name: string;
+  user: User;
+  pronouns?: Pronouns;
+  jobTitle?: string;
+  employer: Employer
+}
+
+export interface Question {
+  id?: string,
+  category: string,
+  question_text: string,
+  order: number
+}
+
+export interface Response {
+  id?: string,
+  user_id: string,
+  question_id: string,
+  response_text: string,
+  status?: "answered" | "skipped",
+  visibility: "public" | "private",
+  version: number,
+  is_latest: boolean,
+  created_at?: string, // TODO: Temporal()
+  updated_at?: string, // TODO: Temporal()
+  shares?: Share[] // sharing_event_responses
+}
+
+export interface Action {
+  id?: string,
+  user_id: string,
+  response_id?: string,
+  type: string,
+  description?: string,
+  version: number,
+  is_latest: boolean,
+  status: "draft" | "active" | "archived",
+  created_at?: string, // TODO: Temporal()
+  updated_at?: string // TODO: Temporal(),
+  shares?: Share[] // sharing_event_actions
+}
+
+export interface Share {
+  id?: string,
+  user_id: string,
+  recipient_email?: string,
+  /* note: Recipient Email
+    This makes sense for now, as the manager email is just a prop on the Profile
+    However, there's a line manager id prop earmarked for later use
+
+    If a table is implemented for Line Managers, this prop should be replaced by a foreign key to it
+    */
+  message?: string,
+  responses?: Response[], // sharing_event_responses
+  actions?: Action[], // sharing_event_actions
+  shared_at?: string // TODO: Temporal()
+}

src/lib/types/sub.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import * as check from "./validate";
+
+export type User = z.infer<typeof check.User>;
+
+export interface Employer {
+  name?: string,
+  id?: string,
+  manager: Manager
+}
+
+export interface Manager {
+  id?: string,
+  name?: string,
+  pronouns?: Pronouns,
+  email?: string,
+};
+
+export type Pronouns = [
+  subject: string,
+  object: string,
+  possessive: string
+];

src/lib/types/validate.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+
+export const User = z.object({
+  userId: z.string().optional(),
+  email: z.string().email(),
+});

supabase/migrations/20250528170555_schema_tweaks.sql

@@ -48,7 +48,9 @@
   -- Status
     -- Add status column with active/archived options
     alter table actions
-      add column status text not null default 'active' check (status in ('active', 'archived'));
+      add column status text not null default 'draft' check (
+        status in ('draft', 'active', 'archived')
+      );
 
   -- Version
     -- Create a sequence that increments by 1 when edited