NBT Component Serializer

settings.gradle.kts

@@ -48,6 +48,7 @@ sequenceOf(
   "text-serializer-legacy",
   "text-serializer-plain",
   "text-serializer-ansi",
+  "text-serializer-nbt"
 ).forEach {
   include("adventure-$it")
   project(":adventure-$it").projectDir = file(it)

text-serializer-nbt/build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+  id("adventure.common-conventions")
+}
+
+dependencies {
+  api(libs.option)
+  api(projects.adventureApi)
+  api(projects.adventureNbt)
+}
+
+applyJarMetadata("net.kyori.adventure.text.serializer.nbt")

text-serializer-nbt/src/main/java/net/kyori/adventure/text/serializer/nbt/ClickEventSerializer.java

@@ -0,0 +1,59 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2024 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package net.kyori.adventure.text.serializer.nbt;
+
+import net.kyori.adventure.nbt.BinaryTag;
+import net.kyori.adventure.nbt.CompoundBinaryTag;
+import net.kyori.adventure.nbt.StringBinaryTag;
+import net.kyori.adventure.text.event.ClickEvent;
+import org.jetbrains.annotations.NotNull;
+
+final class ClickEventSerializer {
+
+  private static final String ACTION = "action";
+  private static final String VALUE = "value";
+
+  private ClickEventSerializer() {
+  }
+
+  static @NotNull ClickEvent deserialize(@NotNull CompoundBinaryTag tag) {
+    BinaryTag actionTag = tag.get(ACTION);
+
+    if (actionTag == null) {
+      throw new IllegalArgumentException("The serialized click event doesn't contain an action");
+    }
+
+    String actionString = ((StringBinaryTag) actionTag).value();
+    ClickEvent.Action action = ClickEvent.Action.NAMES.valueOrThrow(actionString);
+
+    return ClickEvent.clickEvent(action, tag.getString(VALUE));
+  }
+
+  static @NotNull CompoundBinaryTag serialize(@NotNull ClickEvent event) {
+    return CompoundBinaryTag.builder()
+      .putString(ACTION, ClickEvent.Action.NAMES.keyOrThrow(event.action()))
+      .putString(VALUE, event.value())
+      .build();
+  }
+}

text-serializer-nbt/src/main/java/net/kyori/adventure/text/serializer/nbt/HoverEventSerializer.java

@@ -0,0 +1,163 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2024 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package net.kyori.adventure.text.serializer.nbt;
+
+import net.kyori.adventure.key.Key;
+import net.kyori.adventure.nbt.BinaryTag;
+import net.kyori.adventure.nbt.CompoundBinaryTag;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.event.DataComponentValue;
+import net.kyori.adventure.text.event.HoverEvent;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+final class HoverEventSerializer {
+
+  private static final String HOVER_EVENT_ACTION = "action";
+  private static final String HOVER_EVENT_CONTENTS = "contents";
+
+  private static final String HOVER_EVENT_SHOW_TEXT = "show_text";
+  private static final String HOVER_EVENT_SHOW_ITEM = "show_item";
+  private static final String HOVER_EVENT_SHOW_ENTITY = "show_entity";
+
+  private static final String SHOW_ITEM_ID = "id";
+  private static final String SHOW_ITEM_COUNT = "count";
+  private static final String SHOW_ITEM_COMPONENTS = "components";
+
+  private static final String SHOW_ENTITY_TYPE = "type";
+  private static final String SHOW_ENTITY_ID = "id";
+  private static final String SHOW_ENTITY_NAME = "name";
+
+  private HoverEventSerializer() {
+  }
+
+  static @NotNull HoverEvent<?> deserialize(@NotNull CompoundBinaryTag compound, @NotNull NBTComponentSerializerImpl serializer) {
+    String actionString = compound.getString(HOVER_EVENT_ACTION);
+    HoverEvent.Action<?> action = HoverEvent.Action.NAMES.valueOrThrow(actionString);
+    Class<?> actionType = action.type();
+
+    BinaryTag contents = compound.get(HOVER_EVENT_CONTENTS);
+    if (contents == null) {
+      throw new IllegalArgumentException("The hover event doesn't contain any contents");
+    }
+
+    if (Component.class.isAssignableFrom(actionType)) {
+      return HoverEvent.showText(serializer.deserialize(contents));
+    } else if (HoverEvent.ShowItem.class.isAssignableFrom(actionType)) {
+      CompoundBinaryTag showItemContents = (CompoundBinaryTag) contents;
+
+      Key itemId = Key.key(showItemContents.getString(SHOW_ITEM_ID));
+      int itemCount = showItemContents.getInt(SHOW_ITEM_COUNT);
+
+      BinaryTag components = showItemContents.get(SHOW_ITEM_COMPONENTS);
+
+      if (components != null) {
+        CompoundBinaryTag componentsCompound = (CompoundBinaryTag) components;
+        Map<Key, DataComponentValue> componentValues = new HashMap<>();
+
+        for (String string : componentsCompound.keySet()) {
+          BinaryTag value = componentsCompound.get(string);
+          if (value == null) continue;
+          componentValues.put(Key.key(string), NBTDataComponentValue.nbtDataComponentValue(value));
+        }
+
+        return HoverEvent.showItem(itemId, itemCount, componentValues);
+      } else {
+        return HoverEvent.showItem(itemId, itemCount);
+      }
+    } else if (HoverEvent.ShowEntity.class.isAssignableFrom(actionType)) {
+      CompoundBinaryTag showEntityContents = (CompoundBinaryTag) contents;
+
+      Key entityType = Key.key(showEntityContents.getString(SHOW_ENTITY_TYPE));
+      UUID entityId = UUID.fromString(showEntityContents.getString(SHOW_ENTITY_ID));
+
+      BinaryTag entityName = showEntityContents.get(SHOW_ENTITY_NAME);
+
+      if (entityName != null) {
+        return HoverEvent.showEntity(entityType, entityId, serializer.deserialize(entityName));
+      } else {
+        return HoverEvent.showEntity(entityType, entityId);
+      }
+    } else {
+      throw new IllegalArgumentException("Don't know how to deserialize a hoverEvent with action of " + actionString + " from a binary tag");
+    }
+  }
+
+  static <V> @NotNull CompoundBinaryTag serialize(@NotNull HoverEvent<V> event, @NotNull NBTComponentSerializerImpl serializer) {
+    HoverEvent.Action<V> action = event.action();
+
+    BinaryTag contents;
+    String actionString;
+
+    if (action == HoverEvent.Action.SHOW_TEXT) {
+      contents = serializer.serialize((Component) event.value());
+      actionString = HOVER_EVENT_SHOW_TEXT;
+    } else if (action == HoverEvent.Action.SHOW_ITEM) {
+      HoverEvent.ShowItem item = (HoverEvent.ShowItem) event.value();
+
+      CompoundBinaryTag.Builder builder = CompoundBinaryTag.builder()
+        .putString(SHOW_ITEM_ID, item.item().asString())
+        .putInt(SHOW_ITEM_COUNT, item.count());
+
+      Map<Key, NBTDataComponentValue> components = item.dataComponentsAs(NBTDataComponentValue.class);
+
+      if (!components.isEmpty()) {
+        CompoundBinaryTag.Builder dataComponentsBuilder = CompoundBinaryTag.builder();
+
+        for (Map.Entry<Key, NBTDataComponentValue> entry : components.entrySet()) {
+          dataComponentsBuilder.put(entry.getKey().asString(), entry.getValue().binaryTag());
+        }
+
+        builder.put(SHOW_ITEM_COMPONENTS, dataComponentsBuilder.build());
+      }
+
+      contents = builder.build();
+      actionString = HOVER_EVENT_SHOW_ITEM;
+    } else if (action == HoverEvent.Action.SHOW_ENTITY) {
+      HoverEvent.ShowEntity item = (HoverEvent.ShowEntity) event.value();
+
+      CompoundBinaryTag.Builder builder = CompoundBinaryTag.builder()
+        .putString(SHOW_ENTITY_TYPE, item.type().asString())
+        .putString(SHOW_ENTITY_ID, item.id().toString());
+
+      Component customName = item.name();
+      if (customName != null) {
+        builder.put(SHOW_ENTITY_NAME, serializer.serialize(customName));
+      }
+
+      contents = builder.build();
+      actionString = HOVER_EVENT_SHOW_ENTITY;
+    } else {
+      throw new IllegalArgumentException("Don't know how to serialize " + event + " as a binary tag");
+    }
+
+    return CompoundBinaryTag.builder()
+      .putString(HOVER_EVENT_ACTION, actionString)
+      .put(HOVER_EVENT_CONTENTS, contents)
+      .build();
+  }
+}

text-serializer-nbt/src/main/java/net/kyori/adventure/text/serializer/nbt/NBTComponentSerializer.java

@@ -0,0 +1,149 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2024 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package net.kyori.adventure.text.serializer.nbt;
+
+import net.kyori.adventure.builder.AbstractBuilder;
+import net.kyori.adventure.nbt.BinaryTag;
+import net.kyori.adventure.nbt.CompoundBinaryTag;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.format.Style;
+import net.kyori.adventure.text.serializer.ComponentSerializer;
+import net.kyori.adventure.util.PlatformAPI;
+import net.kyori.option.OptionState;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.function.Consumer;
+
+/**
+ * A NBT component serializer.
+ *
+ * @since 4.18.0
+ */
+public interface NBTComponentSerializer extends ComponentSerializer<Component, Component, BinaryTag> {
+  /**
+   * Deserializes a {@linkplain Style style} from a {@linkplain BinaryTag binary tag}.
+   *
+   * @param tag the binary tag
+   * @return the style
+   * @since 4.18.0
+   */
+  @NotNull Style deserializeStyle(@NotNull CompoundBinaryTag tag);
+
+  /**
+   * Serializes a {@linkplain Style style} to a {@linkplain BinaryTag binary tag}.
+   *
+   * @param style the style
+   * @return the binary tag
+   * @since 4.18.0
+   */
+  @NotNull CompoundBinaryTag serializeStyle(@NotNull Style style);
+
+  /**
+   * Gets a component serializer for NBT serialization and deserialization.
+   *
+   * @return a NBT component serializer
+   * @since 4.18.0
+   */
+  static @NotNull NBTComponentSerializer nbt() {
+    return NBTComponentSerializerImpl.Instances.INSTANCE;
+  }
+
+  /**
+   * Creates a new {@link NBTComponentSerializer.Builder}.
+   *
+   * @return a builder
+   * @since 4.18.0
+   */
+  static @NotNull Builder builder() {
+    return new NBTComponentSerializerImpl.BuilderImpl();
+  }
+
+  /**
+   * A builder for {@link NBTComponentSerializer}.
+   *
+   * @since 4.18.0
+   */
+  interface Builder extends AbstractBuilder<NBTComponentSerializer> {
+    /**
+     * Set the option state to apply on this serializer.
+     *
+     * <p>This controls how the serializer emits and interprets components.</p>
+     *
+     * @param flags the flag set to use
+     * @return this builder
+     * @see NBTSerializerOptions
+     * @since 4.18.0
+     */
+    @NotNull Builder options(final @NotNull OptionState flags);
+
+    /**
+     * Edit the active set of serializer options.
+     *
+     * @param optionEditor the consumer operating on the existing flag set
+     * @return this builder
+     * @see NBTSerializerOptions
+     * @since 4.18.0
+     */
+    @NotNull Builder editOptions(final @NotNull Consumer<OptionState.Builder> optionEditor);
+
+    /**
+     * Builds the serializer.
+     *
+     * @return the built serializer
+     * @since 4.18.0
+     */
+    @Override
+    @NotNull NBTComponentSerializer build();
+  }
+
+  /**
+   * A {@link NBTComponentSerializer} service provider.
+   *
+   * @since 4.18.0
+   */
+  @ApiStatus.Internal
+  @PlatformAPI
+  interface Provider {
+    /**
+     * Provides a standard {@link NBTComponentSerializer}.
+     *
+     * @return a {@link NBTComponentSerializer}
+     * @since 4.18.0
+     */
+    @ApiStatus.Internal
+    @PlatformAPI
+    @NotNull NBTComponentSerializer nbt();
+
+    /**
+     * Completes the building process of {@link Builder}.
+     *
+     * @return a {@link Consumer}
+     * @since 4.18.0
+     */
+    @ApiStatus.Internal
+    @PlatformAPI
+    @NotNull Consumer<Builder> builder();
+  }
+}