# Weeve Session Event Structures

### Event JSON Wrapper
A CHANNEL sends a data object containing a TYPE and a PAYLOAD

channel: discussionId

{
    type: "eventName",
    payload: {}
}

There are three categories of session events, delineated chronologically:
- Connection Open/Close Events
- Session Start
- Session Run
- Pre-Stage
- Mid-Stage
- End-Stage
- Session Termination

## Connection Open/Close Events
Create new connection on user /join IF a connection does not already exist

## SESSION START EVENTS

#### Session Initialized (Client Initiated)

{
    type: "sessionInitialized",
    payload: {
        success: true
    }
}

#### SessionOpened (Client Initiated)

{
    type: "sessionOpened",
    payload: {}
}

#### SessionStarted (Client Initiated)

{
    type: "sessionStarted",
    payload: {}
}

## SESSION RUN - Pre-Stage

#### Stage started ()

{
    type: "stageStarted",
    payload: {
        stageInfo: StageInfo{
            roomID: string,
            description: string, 
            duration: number,
            transition_type: string
        }
    }
}

#### User Ping (Server Initiated)

{
    type: "ping",
    payload: {
        success: true
    }
}

####

## SESSION RUN - Mid-Stage

#### Facilitator Message (Client Initiated)

{
    type: "msg",
    payload: {
        message: string,
    }
}

#### Time Prompt (Server Initiated)

{
    type: "timePrompt",
    payload: {
        message: string,
        duration: number(secs)
    }
}

#### Sync Time (Server Initiated)

{
    type: "syncTime",
    payload: {
        timeLeft: number(secs)
    }
}

## SESSION RUN - End-Stage

#### Stage End (Server Initiated)

{
    type: "stageEnd",
    payload: {
        success: true
    }
}

####

## SESSION END EVENTS

#### Session Ended (Server/Client Initiated)

{
    type: "sessionEnd",
    payload: {
        success: true
    }
}