Merge pull request HelpChat#143 from BlitzOffline/feature/api-redesign

Author: BlitzOffline

.gitignore

@@ -1,3 +1,4 @@
 .idea
 .gradle
 build
+test-module

api/build.gradle.kts

@@ -1,13 +1,27 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     id("chatchat.base-conventions")
     id("maven-publish")
+    id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
 dependencies {
-    compileOnly(libs.adventure.bukkit)
+    api(libs.adventure.bukkit)
+    api(libs.adventure.minimessage)
+    api(libs.adventure.configurate)
+
     compileOnly(libs.spigot)
 }
 
 publishing {
 
 }
+
+tasks {
+    withType<ShadowJar> {
+        listOf("net.kyori",
+            "io.leangen",
+        ).forEach { relocate(it, "at.helpch.chatchat.libs.$it") }
+    }
+}

api/src/main/java/at/helpch/chatchat/api/Channel.java

@@ -0,0 +1,54 @@
+package at.helpch.chatchat.api;
+
+import at.helpch.chatchat.api.channel.ChannelTypeRegistry;
+import at.helpch.chatchat.api.hook.HookManager;
+import at.helpch.chatchat.api.mention.MentionManager;
+import at.helpch.chatchat.api.placeholder.MiniPlaceholderManager;
+import at.helpch.chatchat.api.rule.RuleManager;
+import at.helpch.chatchat.api.user.UsersHolder;
+import org.jetbrains.annotations.NotNull;
+
+public interface ChatChatAPI {
+
+    /**
+     * Get the {@link UsersHolder}
+     *
+     * @return The {@link UsersHolder}
+     */
+    @NotNull UsersHolder usersHolder();
+
+    /**
+     * Get the {@link HookManager}
+     *
+     * @return The {@link HookManager}
+     */
+    @NotNull HookManager hookManager();
+
+    /**
+     * Get the {@link ChannelTypeRegistry}
+     *
+     * @return The {@link ChannelTypeRegistry}
+     */
+    @NotNull ChannelTypeRegistry channelTypeRegistry();
+
+    /**
+     * Get the {@link RuleManager}
+     *
+     * @return The {@link RuleManager}
+     */
+    @NotNull RuleManager ruleManager();
+
+    /**
+     * Get the {@link MentionManager}
+     *
+     * @return The {@link MentionManager}
+     */
+    @NotNull MentionManager mentionsManager();
+
+    /**
+     * Get the {@link MiniPlaceholderManager}
+     *
+     * @return The {@link MiniPlaceholderManager}
+     */
+    @NotNull MiniPlaceholderManager miniPlaceholdersManager();
+}

api/src/main/java/at/helpch/chatchat/api/ChatChatAPI.java

@@ -0,0 +1,75 @@
+package at.helpch.chatchat.api.channel;
+
+import at.helpch.chatchat.api.holder.FormatsHolder;
+import at.helpch.chatchat.api.user.ChatUser;
+import at.helpch.chatchat.api.user.User;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Represents a channel.
+ */
+public interface Channel {
+
+    /**
+     * Get the name of the channel.
+     *
+     * @return The name of the channel.
+     */
+    @NotNull String name();
+
+    /**
+     * Get the message prefix of the channel. This prefix can be used at the start of a message to automatically send
+     * the message in this channel instead of having the {@link User} switch the channel first.
+     *
+     * @return The message prefix of the channel.
+     */
+    @NotNull String messagePrefix();
+
+    /**
+     * Get the channel prefix of this channel. This is for display purposes.
+     *
+     * @return The channel prefix of this channel.
+     */
+    @NotNull String channelPrefix();
+
+    /**
+     * Get a list of commands that can be used to switch to this channel.
+     *
+     * @return The commands that can be used to switch to this channel.
+     */
+    @NotNull List<String> commandNames();
+
+    /**
+     * Get a {@link FormatsHolder} that contains a list of formats that are associated with this channel. The list can
+     * be empty, but any format in the list will take precedence over global formats.
+     *
+     * @return The formats associated with this channel.
+     */
+    @NotNull FormatsHolder formats();
+
+    /**
+     * Get the radius of this channel. Radius can be set to -1 to be disabled.
+     *
+     * @return The radius of this channel.
+     */
+    int radius();
+
+    /**
+     * Get a set of {@link ChatUser}s that can see this channel.
+     *
+     * @param source The {@link User} that is requesting the list.
+     * @return The {@link ChatUser}s that can see this channel.
+     */
+    Set<User> targets(@NotNull final User source);
+
+    /**
+     * Get a set of {@link ChatUser}s that can send messages in this channel.
+     *
+     * @param user The {@link User} that is requesting the list.
+     * @return The {@link ChatUser}s that can send messages in this channel.
+     */
+    boolean isUsableBy(@NotNull final ChatUser user);
+}