vybe/DOCS.md

# NOTICE: this document is outdated
# todo: update this document

# vybe websocket protocol - sent by client

socket.io actions + expected msg format and other info

all responses have same type as original message

if a message fails, you get a response with the following format:

```json
{
  "success": false,
  "message": "Something broke"
}
```

## authenticate

you must generate a random salt, sign a message `vybe_auth [salt]`, and then send

```json
{
  "name": "username",
  "message": "that message you signed"
}
```

## create_user

Message format:

```json
{
  "name": "unique_username",
  "pubkey": "your PGP public key"
}
```

Response format:

```json
{
  "success": true,
  "id": 123
}
```

## get_history

```json
{
  "before": 100, // message ID. if ommitted just starts from end
  "thread": 1 // thread ID
}
```

Response format:

```json
{
  "success": true,
  "messages": [], // each message has same format as new_message
  "more": true // false if there are no more
}
```

## send_message

Message format:

```json
{
  "name": "unique_username",
  "message": "message",
  "encrypted": true, // if so use the AES key for this thread
  "thread": 1 // thread ID
}
```

Response format:

```json
{
  "success": true,
  "id": 111
}
```

## create_thread

Message format:

```json
{
  "name": "thread name",
  "permissions": {
    "view_limited": true,
    "post_limited": true
  },
  "members": [
    {
      "name": "username1",
      "key": "" // PGP encrypted AES key, if channel is view_limited
    }
  ]
}
```

Response format:

```json
{
  "success": true,
  "id": 111
}
```

## list_threads

no request message

Response format:

```json
{
  "success": true,
  "threads": [
    {
      "id": 1,
      "name": "meow",
      "permissions": {
        "is_member": false,
        "view": true,
        "post": true
      },
      "key": "" // if thread is view limited
    }
  ]
}
```

## get_keys

request message:

```json
{
  "names": ["user1", "user2"]
}
```

response:

```json
{
  "keys": [
    {
      "name": "user1",
      "pubkey": ""
    }
  ]
}
```

# sent by server

## new_message

```json
{
  "id": 69,
  "name": "unique_username",
  "message": "msg text",
  "encrypted": false,
  "thread": 1 // thread ID
}
```

## new_thread

```json
{
  "id": 123,
  "name": "meow thread",
  "permissions": {
    "is_member": true,
    "view": true,
    "post": false
  },
  "key": "" // pgp encrypted aes key if applicable
}
```