feat: Introduce AurionPacket class

api/build.gradle

@@ -6,7 +6,44 @@ sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 
 dependencies {
+    compileOnly 'org.jetbrains:annotations:+'
     compileOnly 'com.google.code.gson:gson:2.10.1'
+
+    api('net.kyori:adventure-api:4.11.0') {
+        exclude(module: 'adventure-bom')
+        exclude(module: 'checker-qual')
+        exclude(module: 'annotations')
+    }
+
+    api('net.kyori:adventure-text-serializer-gson:4.11.0') {
+        exclude(module: 'adventure-bom')
+        exclude(module: 'adventure-api')
+        exclude(module: 'gson')
+    }
+
+    api('net.kyori:adventure-text-serializer-legacy:4.11.0') {
+        exclude(module: 'adventure-bom')
+        exclude(module: 'adventure-api')
+    }
+
+    api('net.kyori:adventure-text-serializer-plain:4.11.0') {
+        exclude(module: 'adventure-bom')
+        exclude(module: 'adventure-api')
+    }
+
+    api("net.kyori:adventure-text-minimessage:4.11.0") {
+        exclude(module: 'adventure-bom')
+        exclude(module: 'adventure-api')
+    }
+
+    api('net.kyori:event-api:3.0.0') {
+        exclude(module: 'checker-qual')
+        exclude(module: 'guava')
+    }
+
+    // lombok
+    compileOnly 'org.projectlombok:lombok:+'
+    annotationProcessor 'org.projectlombok:lombok:+'
 }
 
 publishing {

api/src/main/java/com/mineaurion/aurionchat/api/AurionPacket.java

@@ -0,0 +1,106 @@
+package com.mineaurion.aurionchat.api;
+
+import com.google.gson.Gson;
+import com.google.gson.annotations.SerializedName;
+import com.mineaurion.aurionchat.api.model.Named;
+import lombok.*;
+import lombok.Builder.Default;
+import lombok.experimental.FieldDefaults;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.io.Serializable;
+import java.util.Optional;
+
+import static net.kyori.adventure.text.serializer.gson.GsonComponentSerializer.gson;
+
+@Value
+@Builder(toBuilder = true)
+@AllArgsConstructor // make public for gson
+public class AurionPacket implements Named, Serializable {
+    public static Gson gson = new Gson();
+
+    public static AurionPacket parse(String json) {
+        return gson.fromJson(json, AurionPacket.class);
+    }
+
+    public static Builder chat(AurionPlayer player, String message, Object tellRaw) {
+        return AurionPacket.builder()
+                .type(Type.CHAT)
+                .source("ingame")
+                .player(player)
+                .detail(message)
+                .tellRawData(tellRaw.toString());
+    }
+
+    public static Builder autoMessage(String message, Object tellRaw) {
+        return AurionPacket.builder()
+                .type(Type.AUTO_MESSAGE)
+                .source("automessage")
+                .displayName("AutoMessage")
+                .detail(message)
+                .tellRawData(tellRaw.toString());
+    }
+
+    /** packet type */
+    Type type;
+
+    /** one of: servername, 'discord' or 'ingame' literal */
+    String source;
+
+    /** related player */
+    @Default @Nullable AurionPlayer player = null;
+
+    /** channel name */
+    @Default @Nullable String channel = null;
+
+    /** display name of sender (one of: player name, automessage title) */
+    @Default @Nullable String displayName = null;
+
+    /** detail data (one of: message text, join text, achievement text) */
+    @Default @Nullable String detail = null;
+
+    /** what ingame players see */
+    @NotNull String tellRawData;
+
+    /** what to display in plaintext environments */
+    @SuppressWarnings("ConstantValue") // false positive bcs of lombok
+    public String getRawDisplay() {
+        return displayName + ' ' + type.verb + (detail==null?"": ": " + detail);
+    }
+
+    public Component getComponent() {
+        return gson().deserialize(tellRawData);
+    }
+
+    @Override
+    public String toString() {
+        return gson.toJson(this);
+    }
+
+    @Override
+    @SuppressWarnings({"ConstantValue", "OptionalOfNullableMisuse"}) // false positive bcs of lombok
+    public @Nullable String getName() {
+        return Optional.ofNullable(player)
+                .map(Named::getBestName)
+                .orElse(null);
+    }
+
+    @Override
+    @SuppressWarnings("ConstantValue") // false positive bcs of lombok
+    public @Nullable String getDisplayName() {
+        return displayName;
+    }
+
+    @Getter
+    @RequiredArgsConstructor
+    @FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
+    public enum Type {
+        @SerializedName("chat") CHAT("wrote"),
+        @SerializedName("automessage") AUTO_MESSAGE("broadcasted");
+
+        String verb;
+    }
+}

api/src/main/java/com/mineaurion/aurionchat/api/AurionPlayer.java

@@ -0,0 +1,26 @@
+package com.mineaurion.aurionchat.api;
+
+import com.mineaurion.aurionchat.api.model.Player;
+import lombok.Value;
+import lombok.experimental.NonFinal;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Optional;
+import java.util.UUID;
+
+@Value @NonFinal
+public class AurionPlayer implements Player {
+    UUID id;
+    String name;
+    @Nullable String prefix;
+    @Nullable String suffix;
+    @Nullable String displayName;
+
+    public AurionPlayer(UUID id, String name, @Nullable String prefix, @Nullable String suffix) {
+        this.id = id;
+        this.name = name;
+        this.prefix = prefix;
+        this.suffix = suffix;
+        this.displayName = Optional.ofNullable(prefix).orElse("") + name + Optional.ofNullable(suffix).orElse("");
+    }
+}

api/src/main/java/com/mineaurion/aurionchat/api/model/Named.java

@@ -0,0 +1,23 @@
+package com.mineaurion.aurionchat.api.model;
+
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Optional;
+
+public interface Named {
+    @Nullable String getName();
+
+    @Nullable String getDisplayName();
+
+    default String getBestName() {
+        return getBestName(toString());
+    }
+
+    @Contract("null -> _; !null -> !null")
+    default String getBestName(String fallback) {
+        return Optional.ofNullable(getDisplayName())
+                .orElseGet(() -> Optional.ofNullable(getName())
+                        .orElse(fallback));
+    }
+}

api/src/main/java/com/mineaurion/aurionchat/api/model/Player.java

@@ -0,0 +1,13 @@
+package com.mineaurion.aurionchat.api.model;
+
+import java.util.UUID;
+
+public interface Player extends Named {
+    String getDisplayName();
+
+    UUID getId();
+
+    String getPrefix();
+
+    String getSuffix();
+}

api/src/main/java/com/mineaurion/aurionchat/api/model/ServerPlayer.java

@@ -0,0 +1,9 @@
+package com.mineaurion.aurionchat.api.model;
+
+import net.kyori.adventure.text.Component;
+
+public interface ServerPlayer extends Player {
+    void sendMessage(Component message);
+
+    boolean hasPermission(String permission);
+}

bukkit/src/main/java/com/mineaurion/aurionchat/bukkit/listeners/ChatListener.java

@@ -1,5 +1,6 @@
 package com.mineaurion.aurionchat.bukkit.listeners;
 
+import com.mineaurion.aurionchat.api.AurionPacket;
 import com.mineaurion.aurionchat.bukkit.AurionChat;
 import com.mineaurion.aurionchat.common.AurionChatPlayer;
 import com.mineaurion.aurionchat.common.Utils;
@@ -14,6 +15,8 @@
 
 import java.io.IOException;
 
+import static net.kyori.adventure.text.serializer.gson.GsonComponentSerializer.gson;
+
 public class ChatListener implements Listener {
 
     private final AurionChat plugin;
@@ -39,9 +42,13 @@ public void onAsyncPlayerChatEvent(AsyncPlayerChatEvent event){
                 aurionChatPlayer,
                 plugin.getConfigurationAdapter().getChannels().get(currentChannel).urlMode
         );
-
+        AurionPacket.Builder packet = AurionPacket.chat(
+                aurionChatPlayer,
+                event.getMessage(),
+                gson().serialize(messageFormat))
+                .channel(currentChannel);
         try{
-            plugin.getChatService().send(currentChannel, messageFormat);
+            plugin.getChatService().send(packet);
         }
         catch(IOException e){
             Bukkit.getConsoleSender().sendMessage(e.getMessage());

common/build.gradle

@@ -18,39 +18,7 @@ dependencies {
     compileOnly 'com.google.guava:guava:19.0'
     compileOnly 'org.jetbrains:annotations:21.+'
 
-    implementation project(':api')
-
-    api('net.kyori:adventure-api:4.11.0') {
-        exclude(module: 'adventure-bom')
-        exclude(module: 'checker-qual')
-        exclude(module: 'annotations')
-    }
-
-    api('net.kyori:adventure-text-serializer-gson:4.11.0') {
-        exclude(module: 'adventure-bom')
-        exclude(module: 'adventure-api')
-        exclude(module: 'gson')
-    }
-
-    api('net.kyori:adventure-text-serializer-legacy:4.11.0') {
-        exclude(module: 'adventure-bom')
-        exclude(module: 'adventure-api')
-    }
-
-    api('net.kyori:adventure-text-serializer-plain:4.11.0') {
-        exclude(module: 'adventure-bom')
-        exclude(module: 'adventure-api')
-    }
-
-    api("net.kyori:adventure-text-minimessage:4.11.0") {
-        exclude(module: 'adventure-bom')
-        exclude(module: 'adventure-api')
-    }
-
-    api('net.kyori:event-api:3.0.0') {
-        exclude(module: 'checker-qual')
-        exclude(module: 'guava')
-    }
+    api project(':api')
 
     api('org.spongepowered:configurate-core:4.1.2')
     api('org.spongepowered:configurate-yaml:4.1.2')

common/src/main/java/com/mineaurion/aurionchat/common/AurionChatPlayer.java

@@ -1,19 +1,25 @@
 package com.mineaurion.aurionchat.common;
 
-import com.mineaurion.aurionchat.common.player.Player;
+import com.mineaurion.aurionchat.api.AurionPlayer;
+import com.mineaurion.aurionchat.api.model.Player;
+import com.mineaurion.aurionchat.api.model.ServerPlayer;
 import net.kyori.adventure.text.Component;
 
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 
-public class AurionChatPlayer {
-    private final Player player;
+public class AurionChatPlayer extends AurionPlayer {
+    private final ServerPlayer player;
     private Set<String> channels = new HashSet<>();
     private String currentChannel;
     private static final String DEFAULT_CHANNEL = "global";  // Player default channel when he is speaking. We assume global is always defined in the config
 
-    public AurionChatPlayer(Player player, AbstractAurionChat plugin){
+    public AurionChatPlayer(ServerPlayer player, AbstractAurionChat plugin){
+        super(player.getId(),
+                player.getDisplayName(),
+                player.getPrefix(),
+                player.getSuffix());
         this.player = player;
         this.setCurrentChannel(DEFAULT_CHANNEL);
         this.setChannels(new HashSet<>(Collections.singletonList(DEFAULT_CHANNEL)));
@@ -84,8 +90,8 @@ public String toString()
     {
         return "currentChannel:" + this.currentChannel +
                 ",channels:" + this.channels.toString() +
-                ",uuid:" + this.player.getUUID() +
-                ",prefix:" + this.player.getPreffix() +
+                ",uuid:" + this.player.getId() +
+                ",prefix:" + this.player.getPrefix() +
                 ",suffix:" + this.player.getSuffix() +
                 ",name:" + this.player.getDisplayName()
                 ;