types.ts

export interface PaginatedResponse<T> {
    results: T[]
    next?: string
    previous?: string
}

export interface TripType {
    id: string
    start: string
    end: string
    city: CityType
    user: UserType
    notes?: string // `notes` is not present when viewing others' trips
}

export interface CountryType {
    code: string
    code3: string
    name: string
    currency: string
    tld: string
    capital: string
}

export interface RegionType {
    // First-level administrative organization; e.g. states (US) or provinces (CA).
    code: string
    name: string
}

export interface CityType {
    id: number // Only `id` that is numberic
    name: string
    country: CountryType
    region?: RegionType
    location: number[]
    kind: string
    timezone: string
}

export interface WorkHoursType {
    start?: string
    end?: string
}

export interface UserType {
    id: string
    first_name: string
    email: string
    avatar_url: string
    home_city?: CityType
    trips?: Omit<TripType, 'user' | 'notes'>[]
    work_hours: WorkHoursType
}

// Where the user is located at a given point in time
export interface UserAtDateType extends UserType {
    current_location: CityType
    travelling: boolean
}

export interface UserTravelingType {
    user: Omit<UserType, 'trips'>
    trip: Omit<TripType, 'user'>
}

export interface MatchType {
    id: string
    source_user: Omit<UserType, 'trips'>
    target_user: Omit<UserType, 'trips'>
    distance: number
    overlap_start: string
    overlap_end: string
    source_trip?: Omit<TripType, 'user' | 'notes'>
    target_trip?: Omit<TripType, 'user' | 'notes'>
}