@ue-shed/protocol 0.5.1 → 0.7.0

package/contracts/cameras/map-tile/v1/manifest.schema.json

@@ -29,20 +29,34 @@
 			"additionalProperties": false,
 			"required": ["children", "parent", "path"],
 			"properties": {
-				"children": { "const": "z+1: (2r,2c),(2r,2c+1),(2r+1,2c),(2r+1,2c+1)" },
-				"parent": { "const": "z-1: (floor(r/2),floor(c/2))" },
-				"path": { "const": "Z{zoom:02}/R{row:03}_C{column:03}.png" }
+				"children": {
+					"const": "z+1: (2r,2c),(2r,2c+1),(2r+1,2c),(2r+1,2c+1)"
+				},
+				"parent": {
+					"const": "z-1: (floor(r/2),floor(c/2))"
+				},
+				"path": {
+					"const": "Z{zoom:02}/R{row:03}_C{column:03}.png"
+				}
 			}
 		},
-		"capturePolicy": { "$ref": "plan.schema.json#/$defs/capturePolicy" },
-		"completedAt": { "$ref": "#/$defs/timestamp" },
+		"capturePolicy": {
+			"$ref": "plan.schema.json#/$defs/capturePolicy"
+		},
+		"completedAt": {
+			"$ref": "#/$defs/timestamp"
+		},
 		"contract": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["name", "version"],
 			"properties": {
-				"name": { "const": "ue-shed-map-tile-pyramid" },
-				"version": { "$ref": "plan.schema.json#/$defs/version" }
+				"name": {
+					"const": "ue-shed-map-tile-pyramid"
+				},
+				"version": {
+					"$ref": "plan.schema.json#/$defs/version"
+				}
 			}
 		},
 		"failures": {
@@ -52,8 +66,12 @@
 				"additionalProperties": false,
 				"required": ["failure", "key"],
 				"properties": {
-					"failure": { "$ref": "capture-response.schema.json#/$defs/failure" },
-					"key": { "$ref": "capture-request.schema.json#/$defs/tileKey" }
+					"failure": {
+						"$ref": "capture-response.schema.json#/$defs/failure"
+					},
+					"key": {
+						"$ref": "capture-request.schema.json#/$defs/tileKey"
+					}
 				}
 			}
 		},
@@ -67,18 +85,33 @@
 					"additionalProperties": false,
 					"required": ["name", "version"],
 					"properties": {
-						"name": { "const": "rows_max_x_to_min_x_columns_min_y_to_max_y" },
-						"version": { "const": 1 }
+						"name": {
+							"const": "rows_max_x_to_min_x_columns_min_y_to_max_y"
+						},
+						"version": {
+							"const": 1
+						}
 					}
 				},
 				"origin": {
 					"type": "object",
 					"additionalProperties": false,
 					"required": ["x", "y"],
-					"properties": { "x": { "type": "number" }, "y": { "type": "number" } }
+					"properties": {
+						"x": {
+							"type": "number"
+						},
+						"y": {
+							"type": "number"
+						}
+					}
+				},
+				"requestedBounds": {
+					"$ref": "plan.schema.json#/$defs/bounds"
 				},
-				"requestedBounds": { "$ref": "plan.schema.json#/$defs/bounds" },
-				"snappedBounds": { "$ref": "plan.schema.json#/$defs/bounds" }
+				"snappedBounds": {
+					"$ref": "plan.schema.json#/$defs/bounds"
+				}
 			}
 		},
 		"gutter": {
@@ -86,9 +119,17 @@
 			"additionalProperties": false,
 			"required": ["pixels", "rule", "textureAddress"],
 			"properties": {
-				"pixels": { "type": "integer", "minimum": 0, "maximum": 32 },
-				"rule": { "const": "render_overdraw_then_crop" },
-				"textureAddress": { "const": "clamp_to_edge" }
+				"pixels": {
+					"type": "integer",
+					"minimum": 0,
+					"maximum": 32
+				},
+				"rule": {
+					"const": "render_overdraw_then_crop"
+				},
+				"textureAddress": {
+					"const": "clamp_to_edge"
+				}
 			}
 		},
 		"levels": {
@@ -100,30 +141,69 @@
 				"additionalProperties": false,
 				"required": ["columns", "rows", "tileWorldSize", "unitsPerPixel", "zoom"],
 				"properties": {
-					"columns": { "type": "integer", "minimum": 1 },
-					"rows": { "type": "integer", "minimum": 1 },
-					"tileWorldSize": { "type": "number", "exclusiveMinimum": 0 },
-					"unitsPerPixel": { "type": "number", "exclusiveMinimum": 0 },
-					"zoom": { "type": "integer", "minimum": 0 }
+					"columns": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"rows": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"tileWorldSize": {
+						"type": "number",
+						"exclusiveMinimum": 0
+					},
+					"unitsPerPixel": {
+						"type": "number",
+						"exclusiveMinimum": 0
+					},
+					"zoom": {
+						"type": "integer",
+						"minimum": 0
+					}
 				}
 			}
 		},
-		"planId": { "$ref": "plan.schema.json#/$defs/id" },
-		"project": { "$ref": "plan.schema.json#/$defs/project" },
+		"planId": {
+			"$ref": "plan.schema.json#/$defs/id"
+		},
+		"project": {
+			"$ref": "plan.schema.json#/$defs/project"
+		},
 		"provenance": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["producer", "tool", "toolVersion"],
 			"properties": {
-				"producer": { "type": "string", "minLength": 1, "maxLength": 1024 },
-				"tool": { "const": "ue-shed" },
-				"toolVersion": { "type": "string", "minLength": 1, "maxLength": 1024 }
+				"producer": {
+					"type": "string",
+					"minLength": 1,
+					"maxLength": 1024
+				},
+				"tool": {
+					"const": "ue-shed"
+				},
+				"toolVersion": {
+					"type": "string",
+					"minLength": 1,
+					"maxLength": 1024
+				}
 			}
 		},
-		"runId": { "$ref": "plan.schema.json#/$defs/id" },
-		"startedAt": { "$ref": "#/$defs/timestamp" },
-		"state": { "enum": ["complete", "partial", "cancelled"] },
-		"tilePixelSize": { "type": "integer", "minimum": 64, "maximum": 4096 },
+		"runId": {
+			"$ref": "plan.schema.json#/$defs/id"
+		},
+		"startedAt": {
+			"$ref": "#/$defs/timestamp"
+		},
+		"state": {
+			"enum": ["complete", "partial", "cancelled"]
+		},
+		"tilePixelSize": {
+			"type": "integer",
+			"minimum": 64,
+			"maximum": 4096
+		},
 		"tiles": {
 			"type": "array",
 			"items": {
@@ -139,16 +219,35 @@
 					"worldBounds"
 				],
 				"properties": {
-					"bytes": { "type": "integer", "minimum": 1 },
-					"hash": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
-					"height": { "type": "integer", "minimum": 1 },
-					"key": { "$ref": "capture-request.schema.json#/$defs/tileKey" },
+					"bytes": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"hash": {
+						"type": "string",
+						"pattern": "^sha256:[a-f0-9]{64}$"
+					},
+					"height": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"key": {
+						"$ref": "capture-request.schema.json#/$defs/tileKey"
+					},
 					"relativePath": {
 						"type": "string",
 						"pattern": "^Z[0-9]{2,}/R[0-9]{3,}_C[0-9]{3,}\\.png$"
 					},
-					"width": { "type": "integer", "minimum": 1 },
-					"worldBounds": { "$ref": "plan.schema.json#/$defs/bounds" }
+					"width": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"worldBounds": {
+						"$ref": "plan.schema.json#/$defs/bounds"
+					},
+					"renderEvidence": {
+						"$ref": "../../render/v1/frame-evidence.schema.json"
+					}
 				}
 			}
 		}

package/contracts/cameras/map-tile/v1/plan.schema.json

@@ -16,25 +16,44 @@
 		"tilePixelSize"
 	],
 	"properties": {
-		"capture": { "$ref": "#/$defs/capturePolicy" },
+		"capture": {
+			"$ref": "#/$defs/capturePolicy"
+		},
 		"contract": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["name", "version"],
 			"properties": {
-				"name": { "const": "ue-shed-map-capture-plan" },
-				"version": { "$ref": "#/$defs/version" }
+				"name": {
+					"const": "ue-shed-map-capture-plan"
+				},
+				"version": {
+					"$ref": "#/$defs/version"
+				}
 			}
 		},
-		"gutterPixels": { "type": "integer", "minimum": 0, "maximum": 32 },
-		"id": { "$ref": "#/$defs/id" },
+		"gutterPixels": {
+			"type": "integer",
+			"minimum": 0,
+			"maximum": 32
+		},
+		"id": {
+			"$ref": "#/$defs/id"
+		},
 		"levels": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["coarsestUnitsPerPixel", "count"],
 			"properties": {
-				"coarsestUnitsPerPixel": { "type": "number", "exclusiveMinimum": 0 },
-				"count": { "type": "integer", "minimum": 1, "maximum": 24 }
+				"coarsestUnitsPerPixel": {
+					"type": "number",
+					"exclusiveMinimum": 0
+				},
+				"count": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 24
+				}
 			}
 		},
 		"output": {
@@ -42,31 +61,61 @@
 			"additionalProperties": false,
 			"required": ["imageFormat", "publication"],
 			"properties": {
-				"imageFormat": { "const": "png" },
-				"publication": { "const": "local_immutable" }
+				"imageFormat": {
+					"const": "png"
+				},
+				"publication": {
+					"const": "local_immutable"
+				}
 			}
 		},
-		"project": { "$ref": "#/$defs/project" },
-		"requestedBounds": { "$ref": "#/$defs/bounds" },
-		"tilePixelSize": { "type": "integer", "minimum": 64, "maximum": 4096 }
+		"project": {
+			"$ref": "#/$defs/project"
+		},
+		"requestedBounds": {
+			"$ref": "#/$defs/bounds"
+		},
+		"tilePixelSize": {
+			"type": "integer",
+			"minimum": 64,
+			"maximum": 4096
+		}
 	},
 	"$defs": {
-		"id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" },
+		"id": {
+			"type": "string",
+			"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
+		},
 		"version": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["major", "minor"],
-			"properties": { "major": { "const": 1 }, "minor": { "const": 0 } }
+			"properties": {
+				"major": {
+					"const": 1
+				},
+				"minor": {
+					"enum": [0, 1]
+				}
+			}
 		},
 		"bounds": {
 			"type": "object",
 			"additionalProperties": false,
 			"required": ["minX", "minY", "maxX", "maxY"],
 			"properties": {
-				"minX": { "type": "number" },
-				"minY": { "type": "number" },
-				"maxX": { "type": "number" },
-				"maxY": { "type": "number" }
+				"minX": {
+					"type": "number"
+				},
+				"minY": {
+					"type": "number"
+				},
+				"maxX": {
+					"type": "number"
+				},
+				"maxY": {
+					"type": "number"
+				}
 			}
 		},
 		"project": {
@@ -74,8 +123,13 @@
 			"additionalProperties": false,
 			"required": ["id", "mapPath"],
 			"properties": {
-				"id": { "$ref": "#/$defs/id" },
-				"mapPath": { "type": "string", "pattern": "^/[A-Za-z0-9_./-]+$" }
+				"id": {
+					"$ref": "#/$defs/id"
+				},
+				"mapPath": {
+					"type": "string",
+					"pattern": "^/[A-Za-z0-9_./-]+$"
+				}
 			}
 		},
 		"dataLayers": {
@@ -84,14 +138,20 @@
 					"type": "object",
 					"additionalProperties": false,
 					"required": ["mode"],
-					"properties": { "mode": { "const": "unchanged" } }
+					"properties": {
+						"mode": {
+							"const": "unchanged"
+						}
+					}
 				},
 				{
 					"type": "object",
 					"additionalProperties": false,
 					"required": ["mode", "states"],
 					"properties": {
-						"mode": { "const": "explicit" },
+						"mode": {
+							"const": "explicit"
+						},
 						"states": {
 							"type": "array",
 							"maxItems": 64,
@@ -100,8 +160,14 @@
 								"additionalProperties": false,
 								"required": ["name", "state"],
 								"properties": {
-									"name": { "type": "string", "minLength": 1, "maxLength": 1024 },
-									"state": { "enum": ["unloaded", "loaded", "activated"] }
+									"name": {
+										"type": "string",
+										"minLength": 1,
+										"maxLength": 1024
+									},
+									"state": {
+										"enum": ["unloaded", "loaded", "activated"]
+									}
 								}
 							}
 						}
@@ -114,15 +180,23 @@
 			"additionalProperties": false,
 			"required": ["dataLayers", "orientation", "render", "z"],
 			"properties": {
-				"dataLayers": { "$ref": "#/$defs/dataLayers" },
+				"dataLayers": {
+					"$ref": "#/$defs/dataLayers"
+				},
 				"orientation": {
 					"type": "object",
 					"additionalProperties": false,
 					"required": ["pitch", "roll", "yaw"],
 					"properties": {
-						"pitch": { "const": -90 },
-						"roll": { "const": 0 },
-						"yaw": { "const": 0 }
+						"pitch": {
+							"const": -90
+						},
+						"roll": {
+							"const": 0
+						},
+						"yaw": {
+							"const": 0
+						}
 					}
 				},
 				"render": {
@@ -130,20 +204,33 @@
 					"additionalProperties": false,
 					"required": ["effects", "lodPolicy", "profile"],
 					"properties": {
+						"exposureEV100": {
+							"type": "number",
+							"minimum": -20,
+							"maximum": 30
+						},
 						"effects": {
 							"type": "object",
 							"additionalProperties": false,
 							"required": ["fog", "volumetricFog"],
 							"properties": {
-								"fog": { "type": "boolean" },
-								"volumetricFog": { "type": "boolean" }
+								"fog": {
+									"type": "boolean"
+								},
+								"volumetricFog": {
+									"type": "boolean"
+								}
 							}
 						},
 						"lodDistanceScaleByZoom": {
 							"type": "array",
 							"minItems": 1,
 							"maxItems": 24,
-							"items": { "type": "number", "minimum": 0.1, "maximum": 100 }
+							"items": {
+								"type": "number",
+								"minimum": 0.1,
+								"maximum": 100
+							}
 						},
 						"lodPolicy": {
 							"enum": ["natural", "fixed_lod_zero", "per_level_distance_scale"]
@@ -161,15 +248,25 @@
 						{
 							"if": {
 								"properties": {
-									"lodPolicy": { "const": "per_level_distance_scale" }
+									"lodPolicy": {
+										"const": "per_level_distance_scale"
+									}
 								}
 							},
-							"then": { "required": ["lodDistanceScaleByZoom"] },
-							"else": { "not": { "required": ["lodDistanceScaleByZoom"] } }
+							"then": {
+								"required": ["lodDistanceScaleByZoom"]
+							},
+							"else": {
+								"not": {
+									"required": ["lodDistanceScaleByZoom"]
+								}
+							}
 						}
 					]
 				},
-				"z": { "type": "number" }
+				"z": {
+					"type": "number"
+				}
 			}
 		}
 	}

package/contracts/cameras/map-tile/v1/readiness.schema.json

@@ -0,0 +1,39 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"additionalProperties": false,
+	"required": ["schemaVersion", "backend", "ready", "blockers"],
+	"properties": {
+		"schemaVersion": {
+			"const": 1
+		},
+		"backend": {
+			"const": "lit_camera_tiles"
+		},
+		"ready": {
+			"type": "boolean"
+		},
+		"actualMapPath": {
+			"type": "string",
+			"minLength": 1
+		},
+		"blockers": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["code", "message"],
+				"properties": {
+					"code": {
+						"type": "string",
+						"minLength": 1
+					},
+					"message": {
+						"type": "string",
+						"minLength": 1
+					}
+				}
+			}
+		}
+	}
+}

package/contracts/cameras/map-tile/v1/release-result.schema.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/cameras/map-tile/v1/release-result.schema.json",
+	"type": "object",
+	"properties": {
+		"released": { "type": "boolean" },
+		"restoration": { "type": "string", "enum": ["restored", "failed"] }
+	},
+	"required": ["released", "restoration"],
+	"additionalProperties": false,
+	"$defs": {}
+}

package/contracts/cameras/map-tile/v1/selection.schema.json

@@ -0,0 +1,105 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"oneOf": [
+		{
+			"type": "object",
+			"additionalProperties": false,
+			"required": [
+				"schemaVersion",
+				"status",
+				"mapPath",
+				"bounds",
+				"actors",
+				"skippedActorPaths"
+			],
+			"properties": {
+				"schemaVersion": {
+					"const": 1
+				},
+				"status": {
+					"const": "ready"
+				},
+				"mapPath": {
+					"type": "string",
+					"minLength": 1
+				},
+				"bounds": {
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["minX", "maxX", "minY", "maxY", "minZ", "maxZ"],
+					"properties": {
+						"minX": {
+							"type": "number"
+						},
+						"maxX": {
+							"type": "number"
+						},
+						"minY": {
+							"type": "number"
+						},
+						"maxY": {
+							"type": "number"
+						},
+						"minZ": {
+							"type": "number"
+						},
+						"maxZ": {
+							"type": "number"
+						}
+					}
+				},
+				"actors": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"required": ["path", "label"],
+						"properties": {
+							"path": {
+								"type": "string",
+								"minLength": 1
+							},
+							"label": {
+								"type": "string"
+							},
+							"actorGuid": {
+								"type": "string",
+								"pattern": "^[0-9A-Fa-f]{32}$"
+							}
+						}
+					},
+					"minItems": 1,
+					"maxItems": 1024
+				},
+				"skippedActorPaths": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"maxItems": 1024
+				}
+			}
+		},
+		{
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["schemaVersion", "status", "code", "message"],
+			"properties": {
+				"schemaVersion": {
+					"const": 1
+				},
+				"status": {
+					"const": "unavailable"
+				},
+				"code": {
+					"type": "string",
+					"minLength": 1
+				},
+				"message": {
+					"type": "string",
+					"minLength": 1
+				}
+			}
+		}
+	]
+}