// NOTE: the ! are here for correct js syntax

// --------------------------------------------------------------------------------------------------
//                                        Errors (response only)
// --------------------------------------------------------------------------------------------------
/*
  Used when general or critical errors happen:
  unknown request type, random crappy request, empty request,
  server error, unauthorized request to a private resource
*/

// Response
!{
  errors: [
    { code: 'unknow_request' },
    { code: 'empty_request' },
    { code: 'access_denied' },
    { code: 'internal_server_error' },
    { code: 'exception', reason: 'whatever floats your boat' },
  ]
}

// --------------------------------------------------------------------------------------------------
//                                           Authenticate user
// --------------------------------------------------------------------------------------------------

// Request
!{
  user_authenticate: {
    username: String,
    password: String
  }
}

// Response
!{
  user_authenticate: true | false,
  user_info: { /* ... */}
}

// --------------------------------------------------------------------------------------------------
//                                             Register user
// --------------------------------------------------------------------------------------------------

// Request
!{
  user_register: {
    username: String,
    password: String,
    fullname: String,
    email:    String,
    phone:    String | null
  }
}

// Response
!{
  user_register: true | false,
  user_info: { /* ... */ }
}

// --------------------------------------------------------------------------------------------------
//                                           Get user info
// --------------------------------------------------------------------------------------------------

// Request
!{
  get_user_info: {
    username: String | undefined
    // if undefined - get info for self
  }
}

// Response
!{
  get_user_info: true | false,
  user_info: {
    username: String,
    fullname: String,
    email:    String,
    phone:    String | null,
    // any other info ...
  }
}