@ue-shed/protocol 0.5.0 → 0.6.0

package/contracts/cameras/review/v1/capture-response.schema.json

@@ -46,7 +46,28 @@
 				"mapPackageDirtyAfter": { "type": "boolean" },
 				"subjectProjection": { "$ref": "#/$defs/subjectProjection" },
 				"visibility": { "$ref": "#/$defs/visibilityMeasurement" }
-			}
+			},
+			"allOf": [
+				{
+					"if": {
+						"properties": {
+							"resolvedSubject": {
+								"required": ["kind"],
+								"properties": { "kind": { "const": "actor_guid" } }
+							}
+						}
+					},
+					"then": {
+						"properties": {
+							"contract": {
+								"properties": {
+									"version": { "properties": { "minor": { "const": 5 } } }
+								}
+							}
+						}
+					}
+				}
+			]
 		},
 		{
 			"type": "object",
@@ -73,7 +94,7 @@
 				"status": { "const": "captured" },
 				"operationId": { "type": "string", "minLength": 1 },
 				"viewId": { "$ref": "#/$defs/safeId" },
-				"resolvedSubject": { "$ref": "#/$defs/resolvedSubject" },
+				"resolvedSubject": { "$ref": "#/$defs/resolvedSubjectPrevious" },
 				"effectiveWorldPose": { "$ref": "#/$defs/pose" },
 				"mapPath": { "type": "string", "minLength": 1 },
 				"stagingPath": { "type": "string", "minLength": 1 },
@@ -111,7 +132,7 @@
 				"status": { "const": "captured" },
 				"operationId": { "type": "string", "minLength": 1 },
 				"viewId": { "$ref": "#/$defs/safeId" },
-				"resolvedSubject": { "$ref": "#/$defs/resolvedSubject" },
+				"resolvedSubject": { "$ref": "#/$defs/resolvedSubjectPrevious" },
 				"effectiveWorldPose": { "$ref": "#/$defs/pose" },
 				"mapPath": { "type": "string", "minLength": 1 },
 				"stagingPath": { "type": "string", "minLength": 1 },
@@ -216,7 +237,7 @@
 					"required": ["major", "minor"],
 					"properties": {
 						"major": { "const": 1 },
-						"minor": { "const": 4 }
+						"minor": { "enum": [4, 5] }
 					}
 				}
 			}
@@ -267,7 +288,7 @@
 					"required": ["major", "minor"],
 					"properties": {
 						"major": { "const": 1 },
-						"minor": { "type": "integer", "minimum": 0, "maximum": 4 }
+						"minor": { "type": "integer", "minimum": 0, "maximum": 5 }
 					}
 				}
 			}
@@ -316,6 +337,60 @@
 			}
 		},
 		"resolvedSubject": {
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "actorGuid", "actorPath", "transform"],
+					"properties": {
+						"kind": { "const": "actor_guid" },
+						"actorGuid": {
+							"type": "string",
+							"pattern": "^[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$",
+							"not": { "const": "00000000-00000000-00000000-00000000" }
+						},
+						"actorPath": { "type": "string", "minLength": 1 },
+						"transform": {
+							"type": "object",
+							"additionalProperties": false,
+							"required": ["location", "rotation"],
+							"properties": {
+								"location": { "$ref": "#/$defs/vector" },
+								"rotation": { "$ref": "#/$defs/rotation" }
+							}
+						}
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "actorPath", "transform"],
+					"properties": {
+						"kind": { "const": "actor_path" },
+						"actorPath": { "type": "string", "minLength": 1 },
+						"transform": {
+							"type": "object",
+							"additionalProperties": false,
+							"required": ["location", "rotation"],
+							"properties": {
+								"location": { "$ref": "#/$defs/vector" },
+								"rotation": { "$ref": "#/$defs/rotation" }
+							}
+						}
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "bounds"],
+					"properties": {
+						"kind": { "const": "oriented_bounds" },
+						"bounds": { "$ref": "#/$defs/bounds" }
+					}
+				}
+			]
+		},
+		"resolvedSubjectPrevious": {
 			"oneOf": [
 				{
 					"type": "object",

package/contracts/cameras/review/v1/fixtures/capture-guid.json

@@ -0,0 +1,53 @@
+{
+	"contract": {
+		"name": "ue-shed-review-capture",
+		"version": { "major": 1, "minor": 5 }
+	},
+	"status": "captured",
+	"operationId": "capture-guid",
+	"viewId": "structure-guid-context",
+	"resolvedSubject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004",
+		"actorPath": "/Game/Fixture/Cameras/L_CameraLoad.L_CameraLoad:PersistentLevel.ReviewSubject",
+		"transform": {
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": 0, "yaw": 45, "roll": 0 }
+		}
+	},
+	"effectiveWorldPose": {
+		"aspectRatio": "16:9",
+		"fieldOfViewDegrees": 70,
+		"projection": "perspective",
+		"location": { "x": 1200, "y": -900, "z": 700 },
+		"rotation": { "pitch": -20, "yaw": 145, "roll": 0 }
+	},
+	"mapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"stagedArtifacts": [
+		{
+			"variant": "pure",
+			"stagingPath": "C:/fixture/Saved/UEShed/ReviewStaging/capture-guid/pure.png"
+		}
+	],
+	"clearCompanion": { "status": "not_requested" },
+	"width": 1280,
+	"height": 720,
+	"captureDurationMs": 21.5,
+	"mapPackageDirtyBefore": false,
+	"mapPackageDirtyAfter": false,
+	"subjectProjection": {
+		"status": "projected",
+		"viewportStatus": "fully_within_viewport",
+		"normalizedBounds": { "minX": 0.2, "minY": 0.2, "maxX": 0.8, "maxY": 0.8 },
+		"margins": { "left": 0.2, "right": 0.2, "top": 0.2, "bottom": 0.2 }
+	},
+	"visibility": {
+		"status": "assessed",
+		"method": { "method": "depth_compare", "version": 1 },
+		"visibleFraction": 1,
+		"sampleCount": 6400,
+		"assessmentDurationMs": 1.5,
+		"limitations": ["Bounded depth comparison."],
+		"occluders": []
+	}
+}

package/contracts/cameras/review/v1/fixtures/capture-request-guid-valid.json

@@ -0,0 +1,28 @@
+{
+	"contract": {
+		"name": "ue-shed-review-capture",
+		"version": { "major": 1, "minor": 5 }
+	},
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "structure-guid-context",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004",
+		"lastKnownActorPath": "/Game/Fixture/Cameras/L_CameraLoad.L_CameraLoad:PersistentLevel.ReviewSubject",
+		"diagnosticLabel": "ReviewSubject"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-alternate-actor-guid.json

@@ -0,0 +1,23 @@
+{
+	"contract": { "name": "ue-shed-review-capture", "version": { "major": 1, "minor": 5 } },
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "alternate-actor-guid",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "12345678-1234-1234-1234-123456789abc"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-clear-before-minor-4.json

@@ -0,0 +1,26 @@
+{
+	"contract": {
+		"name": "ue-shed-review-capture",
+		"version": { "major": 1, "minor": 2 }
+	},
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "clear-on-old-minor",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_path",
+		"actorPath": "/Game/Fixture/Cameras/L_CameraLoad.L_CameraLoad:PersistentLevel.ReviewSubject"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-empty-diagnostic-label.json

@@ -0,0 +1,24 @@
+{
+	"contract": { "name": "ue-shed-review-capture", "version": { "major": 1, "minor": 5 } },
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "empty-diagnostic-label",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004",
+		"diagnosticLabel": ""
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-future-minor.json

@@ -0,0 +1,26 @@
+{
+	"contract": {
+		"name": "ue-shed-review-capture",
+		"version": { "major": 1, "minor": 6 }
+	},
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "future-minor",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-guid-before-minor-5.json

@@ -0,0 +1,26 @@
+{
+	"contract": {
+		"name": "ue-shed-review-capture",
+		"version": { "major": 1, "minor": 4 }
+	},
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "guid-on-old-minor",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-malformed-last-known-path.json

@@ -0,0 +1,24 @@
+{
+	"contract": { "name": "ue-shed-review-capture", "version": { "major": 1, "minor": 5 } },
+	"operationId": "55555555-5555-4555-8555-555555555555",
+	"viewId": "malformed-last-known-path",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004",
+		"lastKnownActorPath": 42
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-nil-actor-guid.json

@@ -0,0 +1,23 @@
+{
+	"contract": { "name": "ue-shed-review-capture", "version": { "major": 1, "minor": 5 } },
+	"operationId": "66666666-6666-4666-8666-666666666666",
+	"viewId": "nil-actor-guid",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000000-00000000-00000000-00000000"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/invalid-capture-request-nil-operation-id.json

@@ -0,0 +1,23 @@
+{
+	"contract": { "name": "ue-shed-review-capture", "version": { "major": 1, "minor": 5 } },
+	"operationId": "00000000-0000-0000-0000-000000000000",
+	"viewId": "nil-operation-id",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"subject": {
+		"kind": "actor_guid",
+		"actorGuid": "00000001-00000002-00000003-00000004"
+	},
+	"viewpoint": {
+		"kind": "world_fixed",
+		"approvedPose": {
+			"aspectRatio": "16:9",
+			"fieldOfViewDegrees": 70,
+			"projection": "perspective",
+			"location": { "x": 100, "y": 200, "z": 300 },
+			"rotation": { "pitch": -20, "yaw": 45, "roll": 0 }
+		}
+	},
+	"resolution": { "width": 1280, "height": 720 },
+	"assessment": { "method": "automatic" },
+	"clearCompanion": { "status": "not_requested" }
+}

package/contracts/cameras/review/v1/fixtures/selection-selected.json

@@ -1,9 +1,10 @@
 {
 	"contract": {
 		"name": "ue-shed-review-selection",
-		"version": { "major": 1, "minor": 0 }
+		"version": { "major": 1, "minor": 1 }
 	},
 	"status": "selected",
+	"actorGuid": "00000001-00000002-00000003-00000004",
 	"actorPath": "/Game/Fixture/Cameras/L_CameraLoad.L_CameraLoad:PersistentLevel.ReviewSubject",
 	"displayName": "ReviewSubject",
 	"mapPath": "/Game/Fixture/Cameras/L_CameraLoad",

package/contracts/cameras/review/v1/selection-response.schema.json

@@ -10,6 +10,11 @@
 			"properties": {
 				"contract": { "$ref": "#/$defs/contract" },
 				"status": { "const": "selected" },
+				"actorGuid": {
+					"type": "string",
+					"pattern": "^[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$",
+					"not": { "const": "00000000-00000000-00000000-00000000" }
+				},
 				"actorPath": { "type": "string", "minLength": 1 },
 				"displayName": { "type": "string", "minLength": 1 },
 				"mapPath": { "type": "string", "minLength": 1 },

package/contracts/core/v1/producer-identity.schema.json

@@ -0,0 +1,44 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"additionalProperties": false,
+	"required": ["engineVersion", "processId", "sessionId", "plugins"],
+	"properties": {
+		"engineVersion": {
+			"type": "string",
+			"minLength": 1
+		},
+		"processId": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"sessionId": {
+			"type": "string",
+			"minLength": 1
+		},
+		"plugins": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["name", "version", "loadedModules"],
+				"properties": {
+					"name": {
+						"type": "string",
+						"minLength": 1
+					},
+					"version": {
+						"type": "string"
+					},
+					"loadedModules": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"minLength": 1
+						}
+					}
+				}
+			}
+		}
+	}
+}