@ue-shed/protocol 0.5.1 → 0.7.0

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

@@ -0,0 +1,201 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/cameras/render/v1/capabilities.schema.json",
+	"type": "object",
+	"properties": {
+		"contract": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string",
+					"enum": ["ue-shed-camera-render"]
+				},
+				"version": {
+					"type": "object",
+					"properties": {
+						"major": {
+							"type": "number",
+							"enum": [1]
+						},
+						"minor": {
+							"type": "number",
+							"enum": [0]
+						}
+					},
+					"required": ["major", "minor"],
+					"additionalProperties": false
+				}
+			},
+			"required": ["name", "version"],
+			"additionalProperties": false
+		},
+		"engineVersion": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				},
+				{
+					"maxLength": 1024
+				}
+			]
+		},
+		"pluginVersion": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				},
+				{
+					"maxLength": 1024
+				}
+			]
+		},
+		"projectName": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				},
+				{
+					"maxLength": 1024
+				}
+			]
+		},
+		"renderers": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"profiles": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": [
+								"lit",
+								"full_fidelity",
+								"seam_stable",
+								"scene_capture_defaults",
+								"observation"
+							]
+						}
+					},
+					"reviewAssessment": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": ["depth_compare", "ray_samples"]
+						}
+					},
+					"reviewClear": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": ["isolate_target", "hide_explicit"]
+						}
+					},
+					"kind": {
+						"type": "string",
+						"enum": ["editor_viewport", "scene_capture"]
+					},
+					"projections": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": ["perspective", "orthographic"]
+						}
+					},
+					"strategies": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": ["high_resolution_screenshot", "render_target"]
+						}
+					},
+					"exposure": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"enum": ["project_auto", "fixed_ev100", "meter_once"]
+						}
+					},
+					"maximumDimension": {
+						"type": "integer",
+						"allOf": [
+							{
+								"minimum": 16,
+								"maximum": 16384
+							}
+						]
+					}
+				},
+				"required": [
+					"profiles",
+					"reviewAssessment",
+					"reviewClear",
+					"kind",
+					"projections",
+					"strategies",
+					"exposure",
+					"maximumDimension"
+				],
+				"additionalProperties": false
+			}
+		},
+		"preparation": {
+			"type": "array",
+			"items": {
+				"type": "string",
+				"enum": ["preserve_loading", "camera_regions", "editor_data_layers"]
+			}
+		},
+		"freeze": {
+			"type": "array",
+			"items": {
+				"type": "string",
+				"enum": ["freeze_materials_and_ticks"]
+			}
+		},
+		"maximumRetainedOperations": {
+			"type": "integer",
+			"allOf": [
+				{
+					"minimum": 1,
+					"maximum": 64
+				}
+			]
+		},
+		"maximumRetainedSessions": {
+			"type": "integer",
+			"allOf": [
+				{
+					"minimum": 1,
+					"maximum": 9
+				}
+			]
+		},
+		"retentionMs": {
+			"type": "integer",
+			"allOf": [
+				{
+					"minimum": 1000,
+					"maximum": 120000
+				}
+			]
+		}
+	},
+	"required": [
+		"contract",
+		"engineVersion",
+		"pluginVersion",
+		"projectName",
+		"renderers",
+		"preparation",
+		"freeze",
+		"maximumRetainedOperations",
+		"maximumRetainedSessions",
+		"retentionMs"
+	],
+	"additionalProperties": false,
+	"$defs": {}
+}

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

@@ -0,0 +1,185 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/cameras/render/v1/end-result.schema.json",
+	"anyOf": [
+		{
+			"type": "object",
+			"properties": {
+				"status": {
+					"type": "string",
+					"enum": ["closed"]
+				},
+				"sessionId": {
+					"type": "string",
+					"allOf": [
+						{
+							"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
+						}
+					]
+				},
+				"restoration": {
+					"type": "string",
+					"enum": ["restored"]
+				}
+			},
+			"required": ["status", "sessionId", "restoration"],
+			"additionalProperties": false
+		},
+		{
+			"type": "object",
+			"properties": {
+				"status": {
+					"type": "string",
+					"enum": ["failed"]
+				},
+				"code": {
+					"type": "string",
+					"enum": [
+						"invalid_policy",
+						"invalid_frame",
+						"invalid_region",
+						"unsupported_policy",
+						"unsupported_size",
+						"editor_required",
+						"rendering_unavailable",
+						"map_mismatch",
+						"project_mismatch",
+						"editor_busy",
+						"viewport_unavailable",
+						"viewport_locked",
+						"preparation_failed",
+						"preparation_budget_exceeded",
+						"frame_budget_exceeded",
+						"world_changed",
+						"lease_expired",
+						"settling_timeout",
+						"exposure_unavailable",
+						"capture_failed",
+						"artifact_invalid",
+						"restoration_failed",
+						"cancelled",
+						"session_unknown",
+						"session_closed",
+						"session_conflict",
+						"operation_unknown",
+						"operation_expired",
+						"operation_conflict"
+					]
+				},
+				"message": {
+					"type": "string",
+					"allOf": [
+						{
+							"minLength": 1
+						},
+						{
+							"maxLength": 1024
+						}
+					]
+				},
+				"recovery": {
+					"type": "string",
+					"allOf": [
+						{
+							"minLength": 1
+						},
+						{
+							"maxLength": 1024
+						}
+					]
+				},
+				"sessionId": {
+					"type": "string",
+					"allOf": [
+						{
+							"minLength": 1
+						},
+						{
+							"maxLength": 1024
+						}
+					]
+				},
+				"operationId": {
+					"type": "string",
+					"allOf": [
+						{
+							"minLength": 1
+						},
+						{
+							"maxLength": 1024
+						}
+					]
+				},
+				"issues": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"code": {
+								"type": "string",
+								"allOf": [
+									{
+										"minLength": 1
+									},
+									{
+										"maxLength": 1024
+									}
+								]
+							},
+							"path": {
+								"type": "string",
+								"allOf": [
+									{
+										"minLength": 1
+									},
+									{
+										"maxLength": 1024
+									}
+								]
+							},
+							"message": {
+								"type": "string",
+								"allOf": [
+									{
+										"minLength": 1
+									},
+									{
+										"maxLength": 1024
+									}
+								]
+							},
+							"recovery": {
+								"type": "string",
+								"allOf": [
+									{
+										"minLength": 1
+									},
+									{
+										"maxLength": 1024
+									}
+								]
+							}
+						},
+						"required": ["code", "path", "message", "recovery"],
+						"additionalProperties": false
+					}
+				},
+				"restoration": {
+					"type": "string",
+					"enum": ["not_acquired", "restored", "failed"]
+				}
+			},
+			"required": [
+				"status",
+				"code",
+				"message",
+				"recovery",
+				"sessionId",
+				"issues",
+				"restoration"
+			],
+			"additionalProperties": false
+		}
+	],
+	"$defs": {}
+}

package/contracts/cameras/render/v1/fixtures/frame-orthographic.json

@@ -0,0 +1,31 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"operationId": "frame",
+	"camera": {
+		"location": {
+			"x": 1000,
+			"y": 1000,
+			"z": 900
+		},
+		"rotation": {
+			"pitch": -30,
+			"roll": 0,
+			"yaw": -135
+		},
+		"projection": {
+			"kind": "orthographic",
+			"width": 2400
+		}
+	},
+	"size": {
+		"width": 320,
+		"height": 180
+	}
+}

package/contracts/cameras/render/v1/fixtures/frame-perspective.json

@@ -0,0 +1,31 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"operationId": "frame",
+	"camera": {
+		"location": {
+			"x": 1000,
+			"y": 1000,
+			"z": 900
+		},
+		"rotation": {
+			"pitch": -30,
+			"roll": 0,
+			"yaw": -135
+		},
+		"projection": {
+			"kind": "perspective",
+			"horizontalFieldOfView": 60
+		}
+	},
+	"size": {
+		"width": 320,
+		"height": 180
+	}
+}

package/contracts/cameras/render/v1/fixtures/invalid-frame-mixed-projection.json

@@ -0,0 +1,32 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"operationId": "frame",
+	"camera": {
+		"location": {
+			"x": 1000,
+			"y": 1000,
+			"z": 900
+		},
+		"rotation": {
+			"pitch": -30,
+			"roll": 0,
+			"yaw": -135
+		},
+		"projection": {
+			"kind": "orthographic",
+			"width": 2400,
+			"horizontalFieldOfView": 60
+		}
+	},
+	"size": {
+		"width": 320,
+		"height": 180
+	}
+}

package/contracts/cameras/render/v1/fixtures/invalid-frame-size.json

@@ -0,0 +1,31 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 0
+		}
+	},
+	"sessionId": "fixture-session",
+	"operationId": "frame",
+	"camera": {
+		"location": {
+			"x": 1000,
+			"y": 1000,
+			"z": 900
+		},
+		"rotation": {
+			"pitch": -30,
+			"roll": 0,
+			"yaw": -135
+		},
+		"projection": {
+			"kind": "perspective",
+			"horizontalFieldOfView": 60
+		}
+	},
+	"size": {
+		"width": 0,
+		"height": 180
+	}
+}

package/contracts/cameras/render/v1/fixtures/invalid-session-backend-fields.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,
+			"strategy": "high_resolution_screenshot"
+		},
+		"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/invalid-session-budget.json

@@ -0,0 +1,39 @@
+{
+	"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
+		},
+		"exposure": {
+			"mode": "fixed_ev100",
+			"ev100": 1,
+			"compensation": "project"
+		},
+		"settling": {
+			"minimumFrames": 4,
+			"timeoutMs": 120000
+		},
+		"time": "live_editor",
+		"preparation": {
+			"geometry": {
+				"mode": "preserve_loading"
+			},
+			"dataLayers": []
+		}
+	},
+	"leaseMs": 0,
+	"maximumFrames": 8
+}

package/contracts/cameras/render/v1/fixtures/invalid-session-future.json

@@ -0,0 +1,39 @@
+{
+	"contract": {
+		"name": "ue-shed-camera-render",
+		"version": {
+			"major": 1,
+			"minor": 1
+		}
+	},
+	"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
+		},
+		"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-camera-regions.json

@@ -0,0 +1,51 @@
+{
+	"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
+		},
+		"exposure": {
+			"mode": "fixed_ev100",
+			"ev100": 1,
+			"compensation": "project"
+		},
+		"settling": {
+			"minimumFrames": 4,
+			"timeoutMs": 120000
+		},
+		"time": "live_editor",
+		"preparation": {
+			"geometry": {
+				"mode": "camera_regions",
+				"maximumRegions": 2,
+				"extent": {
+					"x": 1000,
+					"y": 1000,
+					"z": 1000
+				}
+			},
+			"dataLayers": [
+				{
+					"assetPath": "/Game/Fixture/Layers/Architecture",
+					"loaded": true,
+					"visible": true
+				}
+			]
+		}
+	},
+	"leaseMs": 120000,
+	"maximumFrames": 8
+}