feat: open context waitFor

Author: devnatan

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

@@ -4,6 +4,7 @@
 import me.devnatan.inventoryframework.ViewConfig;
 import me.devnatan.inventoryframework.ViewConfigBuilder;
 import me.devnatan.inventoryframework.ViewContainer;
+import me.devnatan.inventoryframework.state.AsyncState;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
@@ -34,6 +35,18 @@ public interface IFOpenContext extends IFConfinedContext {
      */
     void waitUntil(@NotNull CompletableFuture<Void> task);
 
+    /**
+     * Waits for a asynchronous state to be complete before ending this opening context and
+     * transitioning to the rendering context (waits to show the inventory to the player).
+     * <p>
+     * <b>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.</b>
+     *
+     * @param state The state to wait before opening the inventory.
+     */
+    @ApiStatus.Experimental
+    void waitFor(@NotNull AsyncState<?> state);
+
     /**
      * Whether opening the container to the viewer has been cancelled.
      *

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

@@ -13,6 +13,7 @@
 import me.devnatan.inventoryframework.ViewConfigBuilder;
 import me.devnatan.inventoryframework.ViewContainer;
 import me.devnatan.inventoryframework.Viewer;
+import me.devnatan.inventoryframework.state.AsyncState;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
@@ -31,6 +32,7 @@ public class OpenContext extends PlatformConfinedContext implements IFOpenContex
 
     // --- User Provided ---
     private CompletableFuture<Void> waitTask;
+    private AsyncState<?> waitState;
     private ViewConfigBuilder inheritedConfigBuilder;
 
     // --- Properties ---
@@ -139,6 +141,11 @@ public final void waitUntil(@NotNull CompletableFuture<Void> task) {
         this.waitTask = task;
     }
 
+    @Override
+    public void waitFor(@NotNull AsyncState<?> state) {
+        this.waitState = state;
+    }
+
     @Override
     public final @NotNull ViewConfig getConfig() {
         return inheritedConfigBuilder == null

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

@@ -6,6 +6,7 @@ import me.devnatan.inventoryframework.ViewConfig
 import me.devnatan.inventoryframework.ViewConfigBuilder
 import me.devnatan.inventoryframework.ViewContainer
 import me.devnatan.inventoryframework.Viewer
+import me.devnatan.inventoryframework.state.AsyncState
 import net.kyori.adventure.text.Component
 import net.minestom.server.entity.Player
 import org.jetbrains.annotations.ApiStatus
@@ -44,6 +45,7 @@ class OpenContext
         // --- User Provided ---
 
         private var waitTask: CompletableFuture<Void>? = null
+        private var waitState: AsyncState<*>? = null
         private var inheritedConfigBuilder: ViewConfigBuilder? = null
 
         // --- Properties ---
@@ -109,6 +111,10 @@ class OpenContext
             this.waitTask = task
         }
 
+        override fun waitFor(state: AsyncState<*>) {
+            this.waitState = state
+        }
+
         override fun getConfig(): ViewConfig =
             if (inheritedConfigBuilder == null) {
                 getRoot().config