websocket.md

websocket ideas

• fetch jda entities over WS
• check permissions
• check if bot in guild
• creating role hashes
• seperate server that just forwards messages between bots and dashboards (check who is who with header)

todo

• jda to json
• shared code packages
• flat repository (all packages in a single repository)

Authorising

Send an "Authorization" header with the correct token (one that is for the bot routes)

Internal data exchange

Request (from-bot):

{
  "t": "ROLES_PUT_HASH",
  "d": {
    "guild_id": "1321513153",
    "hash": "blablabla"
  }
}

Response (to-bot):

{
  "t": "ROLES_PUT_HASH",
  "data": {
    "guild_id": "1321513153",
    "hash": "blablabla",
    "success": true 
  }
}

data updates

to bot

Request:

TODO: also do guild settings in here?

{
  "t": "DATA_UPDATE",
  "d": {
    "new_one_guild": {
      "user_id": "user id",
      "guild_id": "guild id"
    },
    "patrons": {
      "add": [],
      "remove": []
    },
    "unbans": [],
    "unmutes": [],
    "reminders": []
  }
}

to dashboard

{
  "t": "DATA_UPDATE",
  "d": {
    "guilds": {
      "invalidate": [
        "list of guild ids to invalidate"
      ]
    }
  }
}

invalidating guild settings and updating

Request (to-bot):

both update and add send the full guild settings object to the bot

{
  "t": "GUILD_SETTINGS",
  "d":{
    "remove": [
      "array of guild ids to forget the settings for"
    ],
    "update": [
      {
        "guildId": "guildid"
      }
    ],
    "add": [
      {
        "guildId": "guildid"
      }
    ]
  } 
}

{
  "t": "CUSTOM_COMMANDS",
  "d": {
    "remove": [
        {
          "invoke": "a_name",
          "guild_id": "16515631"
        }
    ],
    "update": [
        {
          "invoke": "a_name",
          "guild_id": "16515631",
          "message": "This is a cool command {atuser} 123",
          "autoresponse": false
        }
    ],
    "add": [
      {
        "invoke": "a_name",
        "guild_id": "16515631",
        "message": "This is a cool command {atuser}",
        "autoresponse": false
      }
    ]
  }
}

Response (from-bot): None

getting command info

Request (to-bot):

{
  "t": "FETCH_DATA",
  "identifier": "Identifier for finding the data we requested",
  "commands": {}
}

Response (from-bot):

{
  "t": "FETCH_DATA",
  "identifier": "Identifier for finding the data we requested",
  "commands": [
    {
      "name": "etc..."
    }
  ]
}

getting guild info

All data fields are optional

Request (to-bot):

{
  "t": "FETCH_DATA",
  "d": {
    "identifier": "Identifier for finding the data we requested",
    "partial_guilds": [
      "list of guild ids"
    ],
    "guild_member_info": [
      {
        "guild_id": "13456",
        "member_id": "5464654684"
      }
    ]
  }
}

Response (from-bot):

{
  "t": "FETCH_DATA",
  "d": {
    "identifier": "Identifier for finding the data we requested",
    "partial_guilds": [
      {
        "id": "13456",
        "member_count": 999, // or -1 for not in server
        "text_channels": [
          // JDA text channel object
        ],
        "voice_channels": [
          // JDA voice channel object
        ],
        "roles": [
          // JDA role object
        ]
      }
    ],
    "guild_member_info": [
       {
        "guild_id": "13456",
        "member_id": "5464654684",
        "member": {
           // JDA member object
        }
       }
    ]
  }
}