feat: dynamic title update Component support

Author: devnatan

inventory-framework-api/src/main/java/me/devnatan/inventoryframework/ViewContainer.java

@@ -81,7 +81,7 @@ public interface ViewContainer {
 
     void close(@NotNull Viewer viewer);
 
-    void changeTitle(@Nullable String title, @NotNull Viewer target);
+    void changeTitle(@Nullable Object title, @NotNull Viewer target);
 
     boolean isEntityContainer();
 

inventory-framework-api/src/main/java/me/devnatan/inventoryframework/context/IFConfinedContext.java

@@ -56,9 +56,33 @@ public interface IFConfinedContext extends IFContext {
      * library developers to add support to your version.
      *
      * @param title The new container title.
+     * @see <a href="https://github.com/DevNatan/inventory-framework/wiki/navigating-between-views">Navigating between Views on Wiki</a>
      */
     void updateTitleForPlayer(@NotNull String title);
 
+    /**
+     * Updates the container title only for the player current scope of execution.
+     *
+     * <p>This should not be used before the container is opened, if you need to set the __initial
+     * title__ use {@link IFOpenContext#modifyConfig()} on open handler instead.
+     *
+     * <p>This method is version dependant, so it may be that your server version is not yet
+     * supported, if you try to use this method and fail (can fail silently), report it to the
+     * library developers to add support to your version.
+     * <p>
+     *
+     * <a href="https://github.com/KyoriPowered/adventure">Kyori's Adventure Text Component</a> is supported if your platform is PaperSpigot
+     * in a non-legacy version. Non-{@link String} titles will be converted to a plain text.
+     * <p>
+     * <b><i> This API is experimental and is not subject to the general compatibility guarantees
+     * such API may be changed or may be removed completely in any further release. </i></b>
+     *
+     * @param title The new container title.
+     * @see <a href="https://github.com/DevNatan/inventory-framework/wiki/dynamic-title-update">Dynamic Title Update on Wiki</a>
+     */
+    @ApiStatus.Experimental
+    void updateTitleForPlayer(@NotNull Object title);
+
     /**
      * Resets the container title only for the player current scope of execution to the initially
      * defined title. Must be used after {@link #updateTitleForPlayer(String)} to take effect.

inventory-framework-api/src/main/java/me/devnatan/inventoryframework/context/IFContext.java

@@ -212,6 +212,27 @@ void performClickInComponent(
      */
     void updateTitleForEveryone(@NotNull String title);
 
+    /**
+     * Updates the container title for everyone that's viewing it.
+     *
+     * <p>This should not be used before the container is opened, if you need to set the __initial
+     * title__ use {@link IFOpenContext#modifyConfig()} on open handler instead.
+     *
+     * <p>This method is version dependant, so it may be that your server version is not yet
+     * supported, if you try to use this method and fail (can fail silently), report it to the
+     * library developers to add support to your version.
+     * <p>
+     * <a href="https://github.com/KyoriPowered/adventure">Kyori's Adventure Text Component</a> is supported if your platform is PaperSpigot
+     * in a non-legacy version. Non-{@link String} titles will be converted to a plain text.
+     * <p>
+     * <b><i> This API is experimental and is not subject to the general compatibility guarantees
+     * such API may be changed or may be removed completely in any further release. </i></b>
+     *
+     * @param title The new container title.
+     */
+    @ApiStatus.Experimental
+    void updateTitleForEveryone(@NotNull Object title);
+
     /**
      * Updates the container title to all viewers in this context, to the initially defined title.
      * Must be used after {@link #updateTitleForEveryone(String)} to take effect.

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/BukkitViewContainer.java

@@ -2,7 +2,7 @@
 
 import java.util.ArrayList;
 import java.util.Objects;
-import me.devnatan.inventoryframework.runtime.thirdparty.InventoryUpdate;
+import me.devnatan.inventoryframework.internal.InventoryFactory;
 import org.bukkit.entity.HumanEntity;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.Inventory;
@@ -147,12 +147,12 @@ public int getLastSlot() {
     }
 
     @Override
-    public void changeTitle(@Nullable String title, @NotNull Viewer target) {
+    public void changeTitle(@Nullable Object title, @NotNull Viewer target) {
         changeTitle(title, ((BukkitViewer) target).getPlayer());
     }
 
-    public void changeTitle(@Nullable String title, @NotNull Player target) {
-        InventoryUpdate.updateInventory(target, title);
+    public void changeTitle(@Nullable Object title, @NotNull Player target) {
+        InventoryFactory.current().setInventoryTitle(target, title);
     }
 
     @Override

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/context/SlotClickContext.java

@@ -162,6 +162,11 @@ public final void updateTitleForPlayer(@NotNull String title) {
         getParent().updateTitleForPlayer(title);
     }
 
+    @Override
+    public final void updateTitleForPlayer(@NotNull Object title) {
+        getParent().updateTitleForPlayer(title);
+    }
+
     @Override
     public final void resetTitleForPlayer() {
         getParent().resetTitleForPlayer();

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/context/SlotRenderContext.java

@@ -119,6 +119,11 @@ public final void updateTitleForPlayer(@NotNull String title) {
         getParent().updateTitleForPlayer(title);
     }
 
+    @Override
+    public final void updateTitleForPlayer(@NotNull Object title) {
+        getParent().updateTitleForPlayer(title);
+    }
+
     @Override
     public final void resetTitleForPlayer() {
         getParent().resetTitleForPlayer();

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/internal/BukkitInventoryFactory.java

@@ -4,7 +4,9 @@
 import static me.devnatan.inventoryframework.runtime.util.InventoryUtils.toInventoryType;
 
 import me.devnatan.inventoryframework.ViewType;
+import me.devnatan.inventoryframework.runtime.thirdparty.InventoryUpdate;
 import org.bukkit.Bukkit;
+import org.bukkit.entity.Player;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
 
@@ -30,4 +32,13 @@ public Inventory createInventory(InventoryHolder holder, ViewType type, int size
         }
         return inventory;
     }
+
+    @Override
+    public void setInventoryTitle(Player player, Object newTitle) {
+        if (!(newTitle instanceof String))
+            throw new UnsupportedOperationException(
+                    "Import inventory-framework-platform-paper to use Component as inventory title.");
+
+        InventoryUpdate.updateInventory(player, newTitle);
+    }
 }

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/internal/InventoryFactory.java

@@ -2,10 +2,17 @@
 
 import me.devnatan.inventoryframework.IFDebug;
 import me.devnatan.inventoryframework.ViewType;
+import org.bukkit.entity.Player;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
+import org.jetbrains.annotations.ApiStatus;
 
-abstract class InventoryFactory {
+/**
+ * <b><i> This is an internal inventory-framework API that should not be used from outside of
+ * this library. No compatibility guarantees are provided. </i></b>
+ */
+@ApiStatus.Internal
+public abstract class InventoryFactory {
 
     protected static InventoryFactory instance;
 
@@ -35,4 +42,6 @@ private static InventoryFactory forCurrentPlatform() {
     }
 
     public abstract Inventory createInventory(InventoryHolder holder, ViewType type, int size, Object title);
+
+    public abstract void setInventoryTitle(Player player, Object newTitle);
 }

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/runtime/thirdparty/InventoryUpdate.java

@@ -66,7 +66,7 @@ public final class InventoryUpdate {
 
     private static final Set<String> UNOPENABLES = Sets.newHashSet("CRAFTING", "CREATIVE", "PLAYER");
     private static final boolean SUPPORTS_19 = McVersion.supports(19);
-    private static final Object[] DUMMY_COLOR_MODIFIERS = new Object[0];
+    public static final Object[] DUMMY_COLOR_MODIFIERS = new Object[0];
 
     static {
         // Initialize classes.
@@ -86,6 +86,10 @@ public final class InventoryUpdate {
                         I_CHAT_BASE_COMPONENT, "b", MethodType.methodType(I_CHAT_MUTABLE_COMPONENT, String.class), true)
                 : null;
 
+        System.out.println("SUPPORTS_19 = " + SUPPORTS_19);
+        System.out.println("CHAT_MESSAGE = " + CHAT_MESSAGE);
+        System.out.println("literal = " + literal);
+
         // Initialize constructors.
         chatMessage = SUPPORTS_19 ? null : getConstructor(CHAT_MESSAGE, String.class, Object[].class);
         packetPlayOutOpenWindow = (useContainers())
@@ -107,30 +111,27 @@ public final class InventoryUpdate {
      * @param newTitle the new title for the inventory.
      */
     @SuppressWarnings("UnstableApiUsage")
-    public static void updateInventory(Player player, String newTitle) {
+    public static void updateInventory(Player player, Object newTitle) {
         Preconditions.checkArgument(player != null, "Cannot update inventory to null player.");
 
         if (newTitle == null) newTitle = "";
 
         try {
-            if (newTitle.length() > 32) {
-                newTitle = newTitle.substring(0, 32);
+            if (newTitle instanceof String && ((String) newTitle).length() > 32) {
+                newTitle = ((String) newTitle).substring(0, 32);
             }
 
-            if (McVersion.supports(20)) {
+            if (newTitle instanceof String && McVersion.supports(20)) {
                 InventoryView open = player.getOpenInventory();
                 if (UNOPENABLES.contains(open.getType().name())) return;
-                open.setTitle(newTitle);
+                open.setTitle((String) newTitle);
                 return;
             }
 
             // Get EntityPlayer from CraftPlayer.
             Object craftPlayer = CRAFT_PLAYER.cast(player);
             Object entityPlayer = GET_HANDLE.invoke(craftPlayer);
 
-            // Create new title.
-            Object title = createTitleComponent(newTitle);
-
             // Get activeContainer from EntityPlayer.
             Object activeContainer = getActiveContainer(entityPlayer);
 
@@ -162,12 +163,31 @@ public static void updateInventory(Player player, String newTitle) {
                 return;
             }
 
-            Object object = getContainerOrName(container, type);
-
-            // Create packet.
-            Object packet = useContainers()
-                    ? packetPlayOutOpenWindow.invoke(windowId, object, title)
-                    : packetPlayOutOpenWindow.invoke(windowId, object, title, size);
+            Object packet;
+            if (!(newTitle instanceof String)) {
+                final Class<?> menuTypeClass = Class.forName("net.minecraft.world.inventory.MenuType");
+                final Class<?> paperAdventure = Class.forName("io.papermc.paper.adventure.PaperAdventure");
+                final Class<?> componentClass = Class.forName("net.kyori.adventure.text.Component");
+                final Object minecraftComponent =
+                        paperAdventure.getMethod("asVanilla", componentClass).invoke(null, newTitle);
+
+                // Bukkit uses uppercase "X", Minecraft uses lowercase "x"
+                // Bukkit: GENERIC_9X3 / Minecraft: GENERIC_9x3
+                final String minecraftEnumName = container.name().replace("X", "x");
+
+                final Object menuType =
+                        menuTypeClass.getField(minecraftEnumName).get(null);
+
+                packet = packetPlayOutOpenWindow.invoke(windowId, menuType, minecraftComponent);
+            } else {
+                // Create new title.
+                Object title = createTitleComponent(newTitle);
+                Object object = getContainerOrName(container, type);
+
+                packet = useContainers()
+                        ? packetPlayOutOpenWindow.invoke(windowId, object, title)
+                        : packetPlayOutOpenWindow.invoke(windowId, object, title, size);
+            }
 
             // Send packet sync.
             ReflectionUtils.sendPacketSync(player, packet);
@@ -391,9 +411,11 @@ public Object getObject() {
                 int version = ReflectionUtils.MINOR_NUMBER;
                 String name = (version == 14 && this == CARTOGRAPHY_TABLE) ? "CARTOGRAPHY" : name();
                 // Since 1.17, containers go from "a" to "x".
-                if (version > 16 && version <= 20) name = String.valueOf(alphabet[ordinal()]);
+                if (version > 16 && version <= 20) name = java.lang.String.valueOf(alphabet[ordinal()]);
+
                 Field field = CONTAINERS.getField(name);
                 return field.get(null);
+
             } catch (ReflectiveOperationException exception) {
                 exception.printStackTrace();
             }

inventory-framework-platform-minestom/src/main/kotlin/me/devnatan/inventoryframework/MinestomViewContainer.kt

@@ -105,13 +105,15 @@ class MinestomViewContainer(
     }
 
     override fun changeTitle(
-        title: String?,
+        title: Any?,
         target: Viewer,
     ) {
-        changeTitle(
-            title?.let { Component.text(it) } ?: Component.empty(),
-            (target as MinestomViewer).player,
-        )
+        val newTitle =
+            title as? Component
+                ?: title?.let { raw -> Component.text(raw as String) }
+                ?: Component.empty()
+
+        changeTitle(newTitle, (target as MinestomViewer).player)
     }
 
     fun changeTitle(