@ue-shed/protocol 0.7.1 → 0.9.0

package/contracts/cameras/render/v1/README.md

@@ -20,6 +20,12 @@ Review's separately versioned `ue-shed-review-render-stages/1.0` uses
 `ResolveReviewViewpoint(RequestJson)` and
 `InspectRenderedReview(SessionId, RequestJson)` on `UEShedCameraReviewLibrary`.
 
+Both renderer policies accept an optional `editorPreviews` boolean (absent means `false`). It
+shows child actors that ChildActorComponents spawn for editor-only owners. Plugins that support it
+advertise the `editorPreviews` capability, and frame evidence then carries
+`editorPreviews.revealedChildActors`. Earlier plugins reject the field as `invalid_policy`. Review
+capture responses and map-tile evidence embed the same renderer policy and frame evidence.
+
 Request JSON rejects unknown fields. Native semantic validation additionally rejects duplicate Data
 Layer identities, unsupported renderer/exposure combinations, effective layer hierarchy conflicts,
 world/project mismatch, contention, region overrides with preserved loading, exceeded resource

package/contracts/cameras/render/v1/begin-result.schema.json

@@ -20,6 +20,173 @@
 				"resolvedPolicy": {
 					"type": "object",
 					"properties": {
+						"visibility": {
+							"type": "object",
+							"properties": {
+								"hide": {
+									"type": "array",
+									"items": {
+										"type": "object",
+										"properties": {
+											"locator": {
+												"anyOf": [
+													{
+														"type": "object",
+														"properties": {
+															"kind": {
+																"type": "string",
+																"enum": ["actor_path"]
+															},
+															"actorPath": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"pattern": "^\\/Game\\/"
+																	},
+																	{
+																		"maxLength": 4096
+																	}
+																]
+															}
+														},
+														"required": ["kind", "actorPath"],
+														"additionalProperties": false
+													},
+													{
+														"type": "object",
+														"properties": {
+															"kind": {
+																"type": "string",
+																"enum": ["actor_guid"]
+															},
+															"actorGuid": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+																	}
+																]
+															},
+															"lastKnownActorPath": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"maxLength": 4096
+																	}
+																]
+															}
+														},
+														"required": [
+															"kind",
+															"actorGuid",
+															"lastKnownActorPath"
+														],
+														"additionalProperties": false
+													}
+												]
+											},
+											"label": {
+												"type": "string",
+												"allOf": [
+													{
+														"maxLength": 256
+													}
+												]
+											}
+										},
+										"required": ["locator", "label"],
+										"additionalProperties": false
+									},
+									"allOf": [
+										{
+											"maxItems": 256
+										}
+									]
+								},
+								"protect": {
+									"type": "array",
+									"items": {
+										"type": "object",
+										"properties": {
+											"locator": {
+												"anyOf": [
+													{
+														"type": "object",
+														"properties": {
+															"kind": {
+																"type": "string",
+																"enum": ["actor_path"]
+															},
+															"actorPath": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"pattern": "^\\/Game\\/"
+																	},
+																	{
+																		"maxLength": 4096
+																	}
+																]
+															}
+														},
+														"required": ["kind", "actorPath"],
+														"additionalProperties": false
+													},
+													{
+														"type": "object",
+														"properties": {
+															"kind": {
+																"type": "string",
+																"enum": ["actor_guid"]
+															},
+															"actorGuid": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+																	}
+																]
+															},
+															"lastKnownActorPath": {
+																"type": "string",
+																"allOf": [
+																	{
+																		"maxLength": 4096
+																	}
+																]
+															}
+														},
+														"required": [
+															"kind",
+															"actorGuid",
+															"lastKnownActorPath"
+														],
+														"additionalProperties": false
+													}
+												]
+											},
+											"label": {
+												"type": "string",
+												"allOf": [
+													{
+														"maxLength": 256
+													}
+												]
+											}
+										},
+										"required": ["locator", "label"],
+										"additionalProperties": false
+									},
+									"allOf": [
+										{
+											"maxItems": 256
+										}
+									]
+								}
+							},
+							"required": ["hide", "protect"],
+							"additionalProperties": false
+						},
 						"renderer": {
 							"anyOf": [
 								{
@@ -46,6 +213,9 @@
 										},
 										"volumetricFog": {
 											"type": "boolean"
+										},
+										"editorPreviews": {
+											"type": "boolean"
 										}
 									},
 									"required": [
@@ -88,6 +258,9 @@
 										},
 										"volumetricFog": {
 											"type": "boolean"
+										},
+										"editorPreviews": {
+											"type": "boolean"
 										}
 									},
 									"required": [

package/contracts/cameras/render/v1/capabilities.schema.json

@@ -3,6 +3,52 @@
 	"$id": "https://ue-shed.dev/contracts/cameras/render/v1/capabilities.schema.json",
 	"type": "object",
 	"properties": {
+		"authoredVisibility": {
+			"type": "object",
+			"properties": {
+				"version": {
+					"type": "number",
+					"enum": [1]
+				},
+				"maximumActorsPerList": {
+					"type": "number",
+					"enum": [256]
+				},
+				"geometry": {
+					"type": "string",
+					"enum": ["loaded_non_nanite_opaque_static_mesh_actors"]
+				},
+				"viewport": {
+					"type": "boolean"
+				},
+				"sceneCapture": {
+					"type": "boolean"
+				}
+			},
+			"required": ["version", "maximumActorsPerList", "geometry", "viewport", "sceneCapture"],
+			"additionalProperties": false
+		},
+		"editorPreviews": {
+			"type": "object",
+			"properties": {
+				"version": {
+					"type": "number",
+					"enum": [1]
+				},
+				"subjects": {
+					"type": "string",
+					"enum": ["child_actors_of_editor_only_owners"]
+				},
+				"viewport": {
+					"type": "boolean"
+				},
+				"sceneCapture": {
+					"type": "boolean"
+				}
+			},
+			"required": ["version", "subjects", "viewport", "sceneCapture"],
+			"additionalProperties": false
+		},
 		"contract": {
 			"type": "object",
 			"properties": {

package/contracts/cameras/render/v1/fixtures/invalid-session-editor-previews-type.json

@@ -0,0 +1,41 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"expectedProjectName": "UEShedFixture",
+	"policy": {
+		"renderer": {
+			"kind": "editor_viewport",
+			"strategy": "high_resolution_screenshot",
+			"profile": "lit",
+			"vignette": "project",
+			"fog": true,
+			"volumetricFog": true,
+			"editorPreviews": "child_actors"
+		},
+		"exposure": {
+			"mode": "fixed_ev100",
+			"ev100": 1,
+			"compensation": "project"
+		},
+		"settling": {
+			"minimumFrames": 4,
+			"timeoutMs": 120000
+		},
+		"time": "live_editor",
+		"preparation": {
+			"geometry": {
+				"mode": "preserve_loading"
+			},
+			"dataLayers": []
+		}
+	},
+	"leaseMs": 120000,
+	"maximumFrames": 8
+}

package/contracts/cameras/render/v1/fixtures/session-editor-previews.json

@@ -0,0 +1,41 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"expectedProjectName": "UEShedFixture",
+	"policy": {
+		"renderer": {
+			"kind": "editor_viewport",
+			"strategy": "high_resolution_screenshot",
+			"profile": "lit",
+			"vignette": "project",
+			"fog": true,
+			"volumetricFog": true,
+			"editorPreviews": true
+		},
+		"exposure": {
+			"mode": "fixed_ev100",
+			"ev100": 1,
+			"compensation": "project"
+		},
+		"settling": {
+			"minimumFrames": 4,
+			"timeoutMs": 120000
+		},
+		"time": "live_editor",
+		"preparation": {
+			"geometry": {
+				"mode": "preserve_loading"
+			},
+			"dataLayers": []
+		}
+	},
+	"leaseMs": 120000,
+	"maximumFrames": 8
+}

package/contracts/cameras/render/v1/fixtures/session-scene-capture-editor-previews.json

@@ -0,0 +1,40 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"expectedMapPath": "/Game/Fixture/Cameras/L_CameraLoad",
+	"expectedProjectName": "UEShedFixture",
+	"policy": {
+		"renderer": {
+			"kind": "scene_capture",
+			"profile": "full_fidelity",
+			"lodDistanceScale": 1,
+			"fog": true,
+			"volumetricFog": true,
+			"editorPreviews": true
+		},
+		"exposure": {
+			"mode": "fixed_ev100",
+			"ev100": 1,
+			"compensation": "project"
+		},
+		"settling": {
+			"minimumFrames": 4,
+			"timeoutMs": 120000
+		},
+		"time": "live_editor",
+		"preparation": {
+			"geometry": {
+				"mode": "preserve_loading"
+			},
+			"dataLayers": []
+		}
+	},
+	"leaseMs": 120000,
+	"maximumFrames": 8
+}

package/contracts/cameras/render/v1/frame-evidence.schema.json

@@ -3,6 +3,95 @@
 	"$id": "https://ue-shed.dev/contracts/cameras/render/v1/frame-evidence.schema.json",
 	"type": "object",
 	"properties": {
+		"visibilityDiagnostics": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"locator": {
+						"anyOf": [
+							{
+								"type": "object",
+								"properties": {
+									"kind": {
+										"type": "string",
+										"enum": ["actor_path"]
+									},
+									"actorPath": {
+										"type": "string",
+										"allOf": [
+											{
+												"pattern": "^\\/Game\\/"
+											},
+											{
+												"maxLength": 4096
+											}
+										]
+									}
+								},
+								"required": ["kind", "actorPath"],
+								"additionalProperties": false
+							},
+							{
+								"type": "object",
+								"properties": {
+									"kind": {
+										"type": "string",
+										"enum": ["actor_guid"]
+									},
+									"actorGuid": {
+										"type": "string",
+										"allOf": [
+											{
+												"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+											}
+										]
+									},
+									"lastKnownActorPath": {
+										"type": "string",
+										"allOf": [
+											{
+												"maxLength": 4096
+											}
+										]
+									}
+								},
+								"required": ["kind", "actorGuid", "lastKnownActorPath"],
+								"additionalProperties": false
+							}
+						]
+					},
+					"status": {
+						"type": "string",
+						"enum": ["resolved", "missing_or_unloaded", "ambiguous", "unsupported"]
+					},
+					"actorPath": {
+						"type": "string"
+					},
+					"message": {
+						"type": "string"
+					}
+				},
+				"required": ["locator", "status", "actorPath", "message"],
+				"additionalProperties": false
+			}
+		},
+		"editorPreviews": {
+			"type": "object",
+			"properties": {
+				"revealedChildActors": {
+					"type": "integer",
+					"allOf": [
+						{
+							"minimum": 0,
+							"maximum": 1000000
+						}
+					]
+				}
+			},
+			"required": ["revealedChildActors"],
+			"additionalProperties": false
+		},
 		"editorState": {
 			"type": "object",
 			"properties": {
@@ -129,6 +218,173 @@
 		"policy": {
 			"type": "object",
 			"properties": {
+				"visibility": {
+					"type": "object",
+					"properties": {
+						"hide": {
+							"type": "array",
+							"items": {
+								"type": "object",
+								"properties": {
+									"locator": {
+										"anyOf": [
+											{
+												"type": "object",
+												"properties": {
+													"kind": {
+														"type": "string",
+														"enum": ["actor_path"]
+													},
+													"actorPath": {
+														"type": "string",
+														"allOf": [
+															{
+																"pattern": "^\\/Game\\/"
+															},
+															{
+																"maxLength": 4096
+															}
+														]
+													}
+												},
+												"required": ["kind", "actorPath"],
+												"additionalProperties": false
+											},
+											{
+												"type": "object",
+												"properties": {
+													"kind": {
+														"type": "string",
+														"enum": ["actor_guid"]
+													},
+													"actorGuid": {
+														"type": "string",
+														"allOf": [
+															{
+																"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+															}
+														]
+													},
+													"lastKnownActorPath": {
+														"type": "string",
+														"allOf": [
+															{
+																"maxLength": 4096
+															}
+														]
+													}
+												},
+												"required": [
+													"kind",
+													"actorGuid",
+													"lastKnownActorPath"
+												],
+												"additionalProperties": false
+											}
+										]
+									},
+									"label": {
+										"type": "string",
+										"allOf": [
+											{
+												"maxLength": 256
+											}
+										]
+									}
+								},
+								"required": ["locator", "label"],
+								"additionalProperties": false
+							},
+							"allOf": [
+								{
+									"maxItems": 256
+								}
+							]
+						},
+						"protect": {
+							"type": "array",
+							"items": {
+								"type": "object",
+								"properties": {
+									"locator": {
+										"anyOf": [
+											{
+												"type": "object",
+												"properties": {
+													"kind": {
+														"type": "string",
+														"enum": ["actor_path"]
+													},
+													"actorPath": {
+														"type": "string",
+														"allOf": [
+															{
+																"pattern": "^\\/Game\\/"
+															},
+															{
+																"maxLength": 4096
+															}
+														]
+													}
+												},
+												"required": ["kind", "actorPath"],
+												"additionalProperties": false
+											},
+											{
+												"type": "object",
+												"properties": {
+													"kind": {
+														"type": "string",
+														"enum": ["actor_guid"]
+													},
+													"actorGuid": {
+														"type": "string",
+														"allOf": [
+															{
+																"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+															}
+														]
+													},
+													"lastKnownActorPath": {
+														"type": "string",
+														"allOf": [
+															{
+																"maxLength": 4096
+															}
+														]
+													}
+												},
+												"required": [
+													"kind",
+													"actorGuid",
+													"lastKnownActorPath"
+												],
+												"additionalProperties": false
+											}
+										]
+									},
+									"label": {
+										"type": "string",
+										"allOf": [
+											{
+												"maxLength": 256
+											}
+										]
+									}
+								},
+								"required": ["locator", "label"],
+								"additionalProperties": false
+							},
+							"allOf": [
+								{
+									"maxItems": 256
+								}
+							]
+						}
+					},
+					"required": ["hide", "protect"],
+					"additionalProperties": false
+				},
 				"renderer": {
 					"anyOf": [
 						{
@@ -155,6 +411,9 @@
 								},
 								"volumetricFog": {
 									"type": "boolean"
+								},
+								"editorPreviews": {
+									"type": "boolean"
 								}
 							},
 							"required": [
@@ -197,6 +456,9 @@
 								},
 								"volumetricFog": {
 									"type": "boolean"
+								},
+								"editorPreviews": {
+									"type": "boolean"
 								}
 							},
 							"required": [