Further cleanup of schema datagen, RecipeOptional, docs

Author: MaxNeedsSnacks

src/main/java/dev/latvian/mods/kubejs/recipe/RecipeKey.java

@@ -34,7 +34,7 @@
  * be serialized or written to the value map unless it is declared as {@link #alwaysWrite}.
  * <p>
  * By default, each key will have a "builder" method generated for scripts using the first {@link #functionNames} name.
- * You can disable this by setting {@link #noFunctions()} to true.
+ * You can disable this by setting {@link #noFunctions()}.
  * <p>
  * Finally, some types of components such as items or fluids may perform validation to ensure that they
  * aren't holding empty data.
@@ -96,13 +96,12 @@ public String toString() {
 	 * @param value The default value of this key; note that the instance supplied here
 	 *              will be used directly and across multiple recipes, so make sure
 	 *              to only pass immutable objects!
-	 * @apiNote Note that this method <i>does not</i> actually set the value during
-	 * recipe initialization unless {@link #alwaysWrite} is also set! This is mostly
-	 * meant to be used as information for mods like ProbeJS.
+	 * @apiNote This that this method <i>does not</i> write the default value during
+	 * recipe initialization unless {@link #alwaysWrite} is also set!
 	 * @see #optional(RecipeOptional)
 	 */
 	public RecipeKey<T> optional(T value) {
-		return optional(new RecipeOptional.Constant<>(value));
+		return optional(RecipeOptional.unit(value));
 	}
 
 	/**
@@ -112,9 +111,8 @@ public RecipeKey<T> optional(T value) {
 	 * @param value The default value of this key; unlike in {@link #optional(Object)},
 	 *              the value will be computed at recipe initialization time, which makes
 	 *              it safe to pass mutable objects here.
-	 * @apiNote Note that this method <i>does not</i> actually set the value during
-	 * recipe initialization unless {@link #alwaysWrite} is also set! This is mostly
-	 * meant to be used as information for mods like ProbeJS.
+	 * @apiNote This method <i>does not</i> write the default value during
+	 * recipe initialization unless {@link #alwaysWrite} is also set!
 	 * @see #optional(RecipeOptional)
 	 */
 	public RecipeKey<T> optional(RecipeOptional<T> value) {
@@ -164,7 +162,7 @@ public RecipeKey<T> alt(String... names) {
 
 	/**
 	 * Excludes this key from auto-generated constructors.
-	 * <i>Requires</i> optional() value to also be set.
+	 * <b>Requires</b> optional() value to also be set.
 	 * <p>
 	 * This method does nothing if a custom constructor has been set.
 	 */
@@ -183,7 +181,7 @@ public RecipeKey<T> noFunctions() {
 
 	/**
 	 * Sets a list of names that are used to auto-generate builder functions in JS, e.g. <code>.xp(value)</code>.
-	 * The first one will be the preferred one that ProbeJS and other third-party documentation should recommend.
+	 * The first one of these names will be the preferred one that documentation should recommend.
 	 */
 	public RecipeKey<T> functionNames(List<String> names) {
 		functionNames = names;
@@ -192,7 +190,7 @@ public RecipeKey<T> functionNames(List<String> names) {
 
 	/**
 	 * Sets a list of names that are used to auto-generate builder functions in JS, e.g. <code>.xp(value)</code>.
-	 * The first one will be the preferred one that ProbeJS and other third-party documentation should recommend.
+	 * The first one of these names will be the preferred one that documentation should recommend.
 	 */
 	public RecipeKey<T> functionNames(String... names) {
 		return functionNames(List.of(name));

src/main/java/dev/latvian/mods/kubejs/recipe/RecipeSchemaProvider.java

@@ -103,12 +103,12 @@ public RecipeSchemaData.RecipeKeyData keyData(RecipeKey<?> key) {
 			key.role,
 			key.component,
 			Optional.ofNullable(key.optional)
-				.map(o -> o.isDefault() ?
-					null :
-					key.codec.encodeStart(
-						registryAccessContainer.json(),
-						Cast.to(o.getValueForDataGeneration())
-					).getOrThrow()),
+				// this is `null` for default so we can safely ignore it
+				.map(RecipeOptional::getInformativeValue)
+				.map(value -> key.codec.encodeStart(
+					registryAccessContainer.json(),
+					Cast.to(value)
+				).getOrThrow()),
 			key.optional == RecipeOptional.DEFAULT,
 			new ArrayList<>(key.names),
 			key.excluded,

src/main/java/dev/latvian/mods/kubejs/recipe/schema/JsonRecipeSchemaLoader.java

@@ -177,15 +177,17 @@ private RecipeSchema getSchema(DynamicOps<JsonElement> jsonOps) {
 					var functionMap = new HashMap<String, RecipeSchemaFunction>();
 					gatherFunctions(functionMap);
 
-					var keyOverrides = new Reference2ObjectOpenHashMap<RecipeKey<?>, RecipeOptional<?>>(overrideKeys == null ? 0 : overrideKeys.size());
+					Map<RecipeKey<?>, RecipeOptional<?>> keyOverrides = Map.of();
 
 					if (overrideKeys != null) {
+						keyOverrides = new Reference2ObjectOpenHashMap<>(overrideKeys.size());
+
 						for (var entry : overrideKeys.entrySet()) {
 							var key = keyMap.get(entry.getKey());
 
 							if (key != null) {
 								try {
-									keyOverrides.put(key, new RecipeOptional.Constant(key.codec.decode(jsonOps, entry.getValue()).getOrThrow().getFirst()));
+									keyOverrides.put(key, RecipeOptional.unit(key.codec.decode(jsonOps, entry.getValue()).getOrThrow().getFirst()));
 								} catch (Exception ex) {
 									throw new IllegalArgumentException("Failed to create optional value for key '" + key + "' of '" + id + "' from " + entry.getValue(), ex);
 								}
@@ -341,7 +343,8 @@ public static void load(RecipeTypeRegistryContext ctx, DynamicOps<JsonElement> j
 							var optionalJson = keyData.optional().get();
 
 							try {
-								key.optional = new RecipeOptional.Constant(key.codec.decode(jsonOps, optionalJson).getOrThrow().getFirst());
+								//noinspection unchecked, rawtypes
+								key.optional = (RecipeOptional) RecipeOptional.unit(key.codec.decode(jsonOps, optionalJson).getOrThrow().getFirst());
 							} catch (Exception ex) {
 								throw new IllegalArgumentException("Failed to create optional value for key '" + key + "' of '" + builder.id + "' from " + optionalJson, ex);
 							}

src/main/java/dev/latvian/mods/kubejs/recipe/schema/RecipeConstructor.java

@@ -13,6 +13,7 @@
 import dev.latvian.mods.kubejs.util.Cast;
 import dev.latvian.mods.kubejs.util.ErrorStack;
 import dev.latvian.mods.kubejs.util.OpsContainer;
+import dev.latvian.mods.kubejs.util.RegistryAccessContainer;
 import dev.latvian.mods.rhino.Context;
 import it.unimi.dsi.fastutil.objects.Reference2ObjectLinkedOpenHashMap;
 
@@ -46,7 +47,7 @@ public <T> RecipeConstructor override(RecipeKey<T> key, RecipeOptional<T> value)
 	}
 
 	public <T> RecipeConstructor overrideValue(RecipeKey<T> key, T value) {
-		return override(key, new RecipeOptional.Constant<>(value));
+		return override(key, RecipeOptional.unit(value));
 	}
 
 	public <T> RecipeConstructor defaultValue(RecipeKey<T> key, RecipeOptional<T> value) {
@@ -60,7 +61,7 @@ public <T> RecipeConstructor defaultValue(RecipeKey<T> key, RecipeOptional<T> va
 
 	@Override
 	public String toString() {
-		return toString(OpsContainer.DEFAULT);
+		return toString(RegistryAccessContainer.current);
 	}
 
 	public String toString(OpsContainer ops) {

src/main/java/dev/latvian/mods/kubejs/recipe/schema/RecipeOptional.java

@@ -1,54 +1,74 @@
 package dev.latvian.mods.kubejs.recipe.schema;
 
+import dev.latvian.mods.kubejs.recipe.RecipeSchemaProvider;
+import dev.latvian.mods.kubejs.util.Cast;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 @FunctionalInterface
 public interface RecipeOptional<T> {
-	RecipeOptional<?> DEFAULT = new Constant<>(null);
-
-	record Constant<T>(T value) implements RecipeOptional<T> {
+	RecipeOptional<?> DEFAULT = new Unit<>() {
 		@Override
-		public T getDefaultValue(RecipeSchemaType type) {
-			return value;
+		public @Nullable Object value() {
+			return null;
 		}
 
 		@Override
-		@Nullable
-		public T getInformativeValue() {
-			return value;
-		}
-
-		@Override
-		public T getValueForDataGeneration() {
-			return value;
+		public String toString() {
+			return "null";
 		}
+	};
 
+	/**
+	 * @deprecated This type will be hidden soon, use {@link RecipeOptional#unit(T)} instead where possible
+	 */
+	@ApiStatus.Internal
+	record Constant<T>(T value) implements Unit<T> {
 		@Override
 		@NotNull
 		public String toString() {
 			return String.valueOf(value);
 		}
 	}
 
-	T getDefaultValue(RecipeSchemaType type);
+	interface Unit<T> extends RecipeOptional<T> {
+		@Nullable T value();
 
-	@Nullable
-	default T getInformativeValue() {
-		return null;
+		@Override
+		default T getDefaultValue(RecipeSchemaType type) {
+			return value();
+		}
+
+		@Override
+		@Nullable
+		default T getInformativeValue() {
+			return value();
+		}
+
+		@ApiStatus.Internal
+		record Impl<T>(T value) implements Unit<T> {
+		}
 	}
 
+	T getDefaultValue(RecipeSchemaType type);
+
 	/**
-	 * Gets a value that can be encoded into json by a recipe key's codec.
-	 * For use in {@link dev.latvian.mods.kubejs.recipe.RecipeSchemaProvider data generation}
+	 * Gets a value that is used during {@link RecipeSchemaProvider data generation} of recipe schema JSONs,
+	 * as well as during debugging of recipe constructors.
 	 * <p>
-	 * This <strong>must</strong> be implemented if you intend to use data generation with a custom optional type
+	 * This <strong>needs to be</strong> implemented if you intend to use data generation with a custom optional type
 	 */
-	default T getValueForDataGeneration() {
+	@Nullable
+	default T getInformativeValue() {
 		return null;
 	}
 
 	default boolean isDefault() {
 		return this == DEFAULT;
 	}
+
+	static <T> RecipeOptional<T> unit(@Nullable T value) {
+		return value == null ? Cast.to(DEFAULT) : new Unit.Impl<>(value);
+	}
 }