Add documentation

frontend/src/types.ts

@@ -1,16 +1,48 @@
+/**
+ * @fileoverview Global TypeScript type definitions
+ * @description Contains all type definitions used throughout the application
+ * @author Cursor
+ * @version 1.0.0
+ */
+
+/**
+ * HTTP headers object type
+ * @typedef {Object.<string, string>} Headers
+ */
 export type Headers = {[x: string]: string}
 
+/**
+ * API error response structure
+ * @interface ErrorResponse
+ * @property {string} message - Error message from the server
+ */
 export interface ErrorResponse {
     message: string;
 }
 
+/**
+ * 2D coordinate structure
+ * @interface Size2D
+ * @property {number} x - X coordinate
+ * @property {number} y - Y coordinate
+ */
 export interface Size2D {
     x: number;
     y: number;
 }
 
-
 // App types
+
+/**
+ * Chat message structure
+ * @interface Message
+ * @property {number} id - Unique message identifier
+ * @property {string} username - Username of the message sender
+ * @property {string} content - Message content
+ * @property {boolean} is_read - Whether the message has been read
+ * @property {string} timestamp - ISO timestamp of the message
+ * @property {string} [profile_picture] - URL to sender's profile picture
+ */
 export interface Message {
     id: number;
     username: string;
@@ -20,10 +52,24 @@ export interface Message {
     profile_picture?: string;
 }
 
+/**
+ * Collection of messages
+ * @interface Messages
+ * @property {Message[]} messages - Array of message objects
+ */
 export interface Messages {
     messages: Message[];
 }
 
+/**
+ * User information structure
+ * @interface User
+ * @property {number} id - Unique user identifier
+ * @property {string} created_at - ISO timestamp of account creation
+ * @property {string} last_seen - ISO timestamp of last activity
+ * @property {boolean} online - Whether the user is currently online
+ * @property {string} username - Username
+ */
 export interface User {
     id: number;
     created_at: string;
@@ -32,17 +78,30 @@ export interface User {
     username: string;
 }
 
-
 // ----------
 // API models
 // ----------
 
 // Requests
+
+/**
+ * Login request structure
+ * @interface LoginRequest
+ * @property {string} username - Username for authentication
+ * @property {string} password - Password for authentication
+ */
 export interface LoginRequest {
     username: string;
     password: string;
 }
 
+/**
+ * Registration request structure
+ * @interface RegisterRequest
+ * @property {string} username - Desired username
+ * @property {string} password - Desired password
+ * @property {string} confirm_password - Password confirmation
+ */
 export interface RegisterRequest {
     username: string;
     password: string;
@@ -50,6 +109,13 @@ export interface RegisterRequest {
 }
 
 // Responses
+
+/**
+ * Login response structure
+ * @interface LoginResponse
+ * @property {User} user - User information
+ * @property {string} token - JWT authentication token
+ */
 export interface LoginResponse {
     user: User;
     token: string;
@@ -59,6 +125,14 @@ export interface LoginResponse {
 // WebSocket types
 // ---------------
 
+/**
+ * WebSocket message structure
+ * @interface WebSocketMessage
+ * @property {string} type - Message type identifier
+ * @property {WebSocketCredentials} [credentials] - Authentication credentials
+ * @property {any} [data] - Message payload data
+ * @property {WebSocketError} [error] - Error information if applicable
+ */
 export interface WebSocketMessage {
     type: string;
     credentials?: WebSocketCredentials;
@@ -66,11 +140,23 @@ export interface WebSocketMessage {
     error?: WebSocketError;
 }
 
+/**
+ * WebSocket error structure
+ * @interface WebSocketError
+ * @property {number} code - Error code
+ * @property {string} detail - Error detail message
+ */
 export interface WebSocketError {
     code: number;
     detail: string;
 }
 
+/**
+ * WebSocket authentication credentials
+ * @interface WebSocketCredentials
+ * @property {string} scheme - Authentication scheme (e.g., "Bearer")
+ * @property {string} credentials - Authentication token or credentials
+ */
 export interface WebSocketCredentials {
     scheme: string;
     credentials: string;