asset workspace progress

This commit is contained in:
2026-03-24 13:42:44 +00:00
parent 4c8190cc31
commit 59e1ad5ecf
286 changed files with 7156 additions and 8898 deletions
@@ -0,0 +1,7 @@
package p.packer;
public enum PackerOperationStatus {
SUCCESS,
PARTIAL,
FAILED
}
@@ -0,0 +1,17 @@
package p.packer;
import java.nio.file.Path;
import java.util.Objects;
public record PackerProjectContext(
String projectId,
Path rootPath) {
public PackerProjectContext {
projectId = Objects.requireNonNull(projectId, "projectId").trim();
rootPath = Objects.requireNonNull(rootPath, "rootPath").toAbsolutePath().normalize();
if (projectId.isBlank()) {
throw new IllegalArgumentException("projectId must not be blank");
}
}
}
@@ -0,0 +1,13 @@
package p.packer;
import p.packer.messages.*;
public interface PackerWorkspaceService {
InitWorkspaceResult initWorkspace(InitWorkspaceRequest request);
ListAssetsResult listAssets(ListAssetsRequest request);
GetAssetDetailsResult getAssetDetails(GetAssetDetailsRequest request);
CreateAssetResult createAsset(CreateAssetRequest request);
}
@@ -0,0 +1,47 @@
package p.packer.assets;
import java.util.Locale;
public enum AssetFamilyCatalog {
IMAGE_BANK("image_bank", "Image Bank"),
PALETTE_BANK("palette_bank", "Palette Bank"),
SOUND_BANK("sound_bank", "Sound Bank"),
UNKNOWN("unknown", "Unknown");
private final String manifestType;
private final String displayName;
AssetFamilyCatalog(String manifestType, String displayName) {
this.manifestType = manifestType;
this.displayName = displayName;
}
public String manifestType() {
return manifestType;
}
public String displayName() {
return displayName;
}
public boolean matchesQuery(String normalizedQuery) {
return manifestType.contains(normalizedQuery)
|| displayName.toLowerCase(Locale.ROOT).contains(normalizedQuery);
}
public static AssetFamilyCatalog fromManifestType(String manifestType) {
if (manifestType == null) {
return UNKNOWN;
}
final String normalized = manifestType.trim().toLowerCase(Locale.ROOT);
for (AssetFamilyCatalog candidate : values()) {
if (candidate == UNKNOWN) {
continue;
}
if (candidate.manifestType.equals(normalized)) {
return candidate;
}
}
return UNKNOWN;
}
}
@@ -0,0 +1,52 @@
package p.packer.assets;
import java.util.Objects;
public record AssetReference(String value) {
private static final String ASSET_ID_PREFIX = "asset:id:";
private static final String ASSET_ROOT_PREFIX = "asset:root:";
public AssetReference {
value = Objects.requireNonNull(value, "value").trim();
if (value.isBlank()) {
throw new IllegalArgumentException("value must not be blank");
}
}
public static AssetReference of(String value) {
return new AssetReference(value);
}
public static AssetReference forAssetId(int assetId) {
if (assetId <= 0) {
throw new IllegalArgumentException("assetId must be positive");
}
return new AssetReference(ASSET_ID_PREFIX + assetId);
}
public static AssetReference forRelativeAssetRoot(String relativeAssetRoot) {
final String normalized = Objects.requireNonNull(relativeAssetRoot, "relativeAssetRoot").trim();
if (normalized.isBlank()) {
throw new IllegalArgumentException("relativeAssetRoot must not be blank");
}
return new AssetReference(ASSET_ROOT_PREFIX + normalized);
}
public boolean isAssetIdReference() {
return value.startsWith(ASSET_ID_PREFIX);
}
public boolean isAssetRootReference() {
return value.startsWith(ASSET_ROOT_PREFIX);
}
public String rawValue() {
if (isAssetIdReference()) {
return value.substring(ASSET_ID_PREFIX.length());
}
if (isAssetRootReference()) {
return value.substring(ASSET_ROOT_PREFIX.length());
}
return value;
}
}
@@ -0,0 +1,37 @@
package p.packer.assets;
import java.util.Locale;
public enum OutputCodecCatalog {
NONE("NONE", "None"),
UNKNOWN("UNKNOWN", "Unknown");
private final String manifestValue;
private final String displayName;
OutputCodecCatalog(String manifestValue, String displayName) {
this.manifestValue = manifestValue;
this.displayName = displayName;
}
public String manifestValue() {
return manifestValue;
}
public String displayName() {
return displayName;
}
public static OutputCodecCatalog fromManifestValue(String manifestValue) {
if (manifestValue == null) {
return UNKNOWN;
}
final String normalized = manifestValue.trim().toUpperCase(Locale.ROOT);
for (OutputCodecCatalog candidate : values()) {
if (candidate.manifestValue.equals(normalized)) {
return candidate;
}
}
return UNKNOWN;
}
}
@@ -0,0 +1,68 @@
package p.packer.assets;
import java.util.List;
import java.util.Locale;
public enum OutputFormatCatalog {
TILES_INDEXED_V1(AssetFamilyCatalog.IMAGE_BANK, "TILES/indexed_v1", "TILES/indexed_v1"),
PALETTE_INDEXED_V1(AssetFamilyCatalog.PALETTE_BANK, "PALETTE/indexed_v1", "PALETTE/indexed_v1"),
SOUND_BANK_V1(AssetFamilyCatalog.SOUND_BANK, "SOUND/bank_v1", "SOUND/bank_v1"),
AUDIO_PCM_V1(AssetFamilyCatalog.SOUND_BANK, "AUDIO/pcm_v1", "AUDIO/pcm_v1"),
UNKNOWN(AssetFamilyCatalog.UNKNOWN, "unknown", "Unknown");
private final AssetFamilyCatalog assetFamily;
private final String manifestValue;
private final String displayName;
OutputFormatCatalog(AssetFamilyCatalog assetFamily, String manifestValue, String displayName) {
this.assetFamily = assetFamily;
this.manifestValue = manifestValue;
this.displayName = displayName;
}
public AssetFamilyCatalog assetFamily() {
return assetFamily;
}
public String manifestValue() {
return manifestValue;
}
public String displayName() {
return displayName;
}
public List<OutputCodecCatalog> availableCodecs() {
return this == UNKNOWN ? List.of() : List.of(OutputCodecCatalog.NONE);
}
public boolean supports(OutputCodecCatalog codec) {
return availableCodecs().contains(codec);
}
public static List<OutputFormatCatalog> supportedFor(AssetFamilyCatalog assetFamily) {
if (assetFamily == null || assetFamily == AssetFamilyCatalog.UNKNOWN) {
return List.of();
}
return java.util.Arrays.stream(values())
.filter(candidate -> candidate != UNKNOWN)
.filter(candidate -> candidate.assetFamily == assetFamily)
.toList();
}
public static OutputFormatCatalog fromManifestValue(String manifestValue) {
if (manifestValue == null) {
return UNKNOWN;
}
final String normalized = manifestValue.trim().toLowerCase(Locale.ROOT);
for (OutputFormatCatalog candidate : values()) {
if (candidate == UNKNOWN) {
continue;
}
if (candidate.manifestValue.toLowerCase(Locale.ROOT).equals(normalized)) {
return candidate;
}
}
return UNKNOWN;
}
}
@@ -0,0 +1,28 @@
package p.packer.assets;
import p.packer.diagnostics.PackerDiagnostic;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.Objects;
public record PackerAssetDetails(
PackerAssetSummary summary,
String outputFormat,
OutputCodecCatalog outputCodec,
List<OutputCodecCatalog> availableOutputCodecs,
Map<OutputCodecCatalog, List<PackerCodecConfigurationField>> codecConfigurationFieldsByCodec,
Map<String, List<Path>> inputsByRole,
List<PackerDiagnostic> diagnostics) {
public PackerAssetDetails {
Objects.requireNonNull(summary, "summary");
outputFormat = Objects.requireNonNullElse(outputFormat, "unknown").trim();
outputCodec = Objects.requireNonNullElse(outputCodec, OutputCodecCatalog.UNKNOWN);
availableOutputCodecs = List.copyOf(Objects.requireNonNull(availableOutputCodecs, "availableOutputCodecs"));
codecConfigurationFieldsByCodec = Map.copyOf(Objects.requireNonNull(codecConfigurationFieldsByCodec, "codecConfigurationFieldsByCodec"));
inputsByRole = Map.copyOf(Objects.requireNonNull(inputsByRole, "inputsByRole"));
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
}
}
@@ -0,0 +1,20 @@
package p.packer.assets;
import java.nio.file.Path;
import java.util.Objects;
public record PackerAssetIdentity(
Integer assetId,
String assetUuid,
String assetName,
Path assetRoot) {
public PackerAssetIdentity {
assetUuid = assetUuid == null ? null : assetUuid.trim();
assetName = Objects.requireNonNull(assetName, "assetName").trim();
assetRoot = Objects.requireNonNull(assetRoot, "assetRoot").toAbsolutePath().normalize();
if (assetName.isBlank()) {
throw new IllegalArgumentException("assetName must not be blank");
}
}
}
@@ -0,0 +1,6 @@
package p.packer.assets;
public enum PackerAssetState {
REGISTERED,
UNREGISTERED
}
@@ -0,0 +1,27 @@
package p.packer.assets;
import java.util.Objects;
public record PackerAssetSummary(
AssetReference assetReference,
PackerAssetIdentity identity,
PackerAssetState state,
PackerBuildParticipation buildParticipation,
AssetFamilyCatalog assetFamily,
boolean preloadEnabled,
boolean hasDiagnostics) {
public PackerAssetSummary {
Objects.requireNonNull(assetReference, "assetReference");
Objects.requireNonNull(identity, "identity");
Objects.requireNonNull(state, "state");
Objects.requireNonNull(buildParticipation, "buildParticipation");
assetFamily = Objects.requireNonNullElse(assetFamily, AssetFamilyCatalog.UNKNOWN);
if (state == PackerAssetState.REGISTERED && identity.assetId() == null) {
throw new IllegalArgumentException("registered asset must expose assetId");
}
if (state == PackerAssetState.UNREGISTERED && buildParticipation != PackerBuildParticipation.EXCLUDED) {
throw new IllegalArgumentException("unregistered asset must stay excluded from build participation");
}
}
}
@@ -0,0 +1,6 @@
package p.packer.assets;
public enum PackerBuildParticipation {
INCLUDED,
EXCLUDED
}
@@ -0,0 +1,24 @@
package p.packer.assets;
import java.util.List;
import java.util.Objects;
public record PackerCodecConfigurationField(
String key,
String label,
PackerCodecConfigurationFieldType fieldType,
String value,
boolean required,
List<String> options) {
public PackerCodecConfigurationField {
key = Objects.requireNonNull(key, "key").trim();
label = Objects.requireNonNull(label, "label").trim();
Objects.requireNonNull(fieldType, "fieldType");
value = Objects.requireNonNullElse(value, "").trim();
options = List.copyOf(Objects.requireNonNull(options, "options"));
if (key.isBlank() || label.isBlank()) {
throw new IllegalArgumentException("codec configuration field key and label must not be blank");
}
}
}
@@ -0,0 +1,8 @@
package p.packer.assets;
public enum PackerCodecConfigurationFieldType {
TEXT,
BOOLEAN,
INTEGER,
ENUM
}
@@ -0,0 +1,22 @@
package p.packer.diagnostics;
import java.nio.file.Path;
import java.util.Objects;
public record PackerDiagnostic(
PackerDiagnosticSeverity severity,
PackerDiagnosticCategory category,
String message,
Path evidencePath,
boolean blocking) {
public PackerDiagnostic {
Objects.requireNonNull(severity, "severity");
Objects.requireNonNull(category, "category");
message = Objects.requireNonNull(message, "message").trim();
evidencePath = evidencePath == null ? null : evidencePath.toAbsolutePath().normalize();
if (message.isBlank()) {
throw new IllegalArgumentException("message must not be blank");
}
}
}
@@ -0,0 +1,9 @@
package p.packer.diagnostics;
public enum PackerDiagnosticCategory {
STRUCTURAL,
HYGIENE,
VERSIONING,
MIGRATION,
BUILD
}
@@ -0,0 +1,7 @@
package p.packer.diagnostics;
public enum PackerDiagnosticSeverity {
INFO,
WARNING,
ERROR
}
@@ -0,0 +1,31 @@
package p.packer.events;
import java.time.Instant;
import java.util.List;
import java.util.Objects;
public record PackerEvent(
String projectId,
String operationId,
long sequence,
PackerEventKind kind,
Instant timestamp,
String summary,
PackerProgress progress,
List<String> affectedAssets) {
public PackerEvent {
projectId = Objects.requireNonNull(projectId, "projectId").trim();
operationId = Objects.requireNonNull(operationId, "operationId").trim();
Objects.requireNonNull(kind, "kind");
timestamp = Objects.requireNonNull(timestamp, "timestamp");
summary = Objects.requireNonNull(summary, "summary").trim();
affectedAssets = List.copyOf(Objects.requireNonNull(affectedAssets, "affectedAssets"));
if (projectId.isBlank() || operationId.isBlank() || summary.isBlank()) {
throw new IllegalArgumentException("projectId, operationId, and summary must not be blank");
}
if (sequence < 0L) {
throw new IllegalArgumentException("sequence must not be negative");
}
}
}
@@ -0,0 +1,8 @@
package p.packer.events;
public enum PackerEventKind {
ASSET_DISCOVERED,
DIAGNOSTICS_UPDATED,
ACTION_APPLIED,
ACTION_FAILED
}
@@ -0,0 +1,6 @@
package p.packer.events;
@FunctionalInterface
public interface PackerEventSink {
void publish(PackerEvent event);
}
@@ -0,0 +1,12 @@
package p.packer.events;
public record PackerProgress(
double value,
boolean indeterminate) {
public PackerProgress {
if (!indeterminate && (value < 0.0 || value > 1.0)) {
throw new IllegalArgumentException("value must be between 0.0 and 1.0 when determinate");
}
}
}
@@ -0,0 +1,11 @@
package p.packer.exceptions;
public final class PackerRegistryException extends RuntimeException {
public PackerRegistryException(String message) {
super(message);
}
public PackerRegistryException(String message, Throwable cause) {
super(message, cause);
}
}
@@ -0,0 +1,33 @@
package p.packer.messages;
import p.packer.PackerProjectContext;
import p.packer.assets.AssetFamilyCatalog;
import p.packer.assets.OutputCodecCatalog;
import p.packer.assets.OutputFormatCatalog;
import java.util.Objects;
public record CreateAssetRequest(
PackerProjectContext project,
String assetRoot,
String assetName,
AssetFamilyCatalog assetFamily,
OutputFormatCatalog outputFormat,
OutputCodecCatalog outputCodec,
boolean preloadEnabled) {
public CreateAssetRequest {
Objects.requireNonNull(project, "project");
assetRoot = Objects.requireNonNull(assetRoot, "assetRoot").trim();
assetName = Objects.requireNonNull(assetName, "assetName").trim();
assetFamily = Objects.requireNonNullElse(assetFamily, AssetFamilyCatalog.UNKNOWN);
outputFormat = Objects.requireNonNullElse(outputFormat, OutputFormatCatalog.UNKNOWN);
outputCodec = Objects.requireNonNullElse(outputCodec, OutputCodecCatalog.UNKNOWN);
if (assetRoot.isBlank()) {
throw new IllegalArgumentException("assetRoot must not be blank");
}
if (assetName.isBlank()) {
throw new IllegalArgumentException("assetName must not be blank");
}
}
}
@@ -0,0 +1,14 @@
package p.packer.messages;
import p.packer.PackerOperationStatus;
import p.packer.assets.AssetReference;
import java.nio.file.Path;
public record CreateAssetResult(
PackerOperationStatus status,
String summary,
AssetReference assetReference,
Path assetRoot,
Path manifestPath) {
}
@@ -0,0 +1,16 @@
package p.packer.messages;
import p.packer.PackerProjectContext;
import p.packer.assets.AssetReference;
import java.util.Objects;
public record GetAssetDetailsRequest(
PackerProjectContext project,
AssetReference assetReference) {
public GetAssetDetailsRequest {
Objects.requireNonNull(project, "project");
Objects.requireNonNull(assetReference, "assetReference");
}
}
@@ -0,0 +1,25 @@
package p.packer.messages;
import p.packer.PackerOperationStatus;
import p.packer.assets.PackerAssetDetails;
import p.packer.diagnostics.PackerDiagnostic;
import java.util.List;
import java.util.Objects;
public record GetAssetDetailsResult(
PackerOperationStatus status,
String summary,
PackerAssetDetails details,
List<PackerDiagnostic> diagnostics) {
public GetAssetDetailsResult {
Objects.requireNonNull(status, "status");
summary = Objects.requireNonNull(summary, "summary").trim();
Objects.requireNonNull(details, "details");
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
if (summary.isBlank()) {
throw new IllegalArgumentException("summary must not be blank");
}
}
}
@@ -0,0 +1,13 @@
package p.packer.messages;
import p.packer.PackerProjectContext;
import java.util.Objects;
public record InitWorkspaceRequest(
PackerProjectContext project) {
public InitWorkspaceRequest {
Objects.requireNonNull(project, "project");
}
}
@@ -0,0 +1,25 @@
package p.packer.messages;
import p.packer.PackerOperationStatus;
import p.packer.diagnostics.PackerDiagnostic;
import java.nio.file.Path;
import java.util.List;
import java.util.Objects;
public record InitWorkspaceResult(
PackerOperationStatus status,
String summary,
Path registryPath,
List<PackerDiagnostic> diagnostics) {
public InitWorkspaceResult {
Objects.requireNonNull(status, "status");
summary = Objects.requireNonNull(summary, "summary").trim();
registryPath = Objects.requireNonNull(registryPath, "registryPath").toAbsolutePath().normalize();
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
if (summary.isBlank()) {
throw new IllegalArgumentException("summary must not be blank");
}
}
}
@@ -0,0 +1,13 @@
package p.packer.messages;
import p.packer.PackerProjectContext;
import java.util.Objects;
public record ListAssetsRequest(
PackerProjectContext project) {
public ListAssetsRequest {
Objects.requireNonNull(project, "project");
}
}
@@ -0,0 +1,25 @@
package p.packer.messages;
import p.packer.PackerOperationStatus;
import p.packer.assets.PackerAssetSummary;
import p.packer.diagnostics.PackerDiagnostic;
import java.util.List;
import java.util.Objects;
public record ListAssetsResult(
PackerOperationStatus status,
String summary,
List<PackerAssetSummary> assets,
List<PackerDiagnostic> diagnostics) {
public ListAssetsResult {
Objects.requireNonNull(status, "status");
summary = Objects.requireNonNull(summary, "summary").trim();
assets = List.copyOf(Objects.requireNonNull(assets, "assets"));
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
if (summary.isBlank()) {
throw new IllegalArgumentException("summary must not be blank");
}
}
}