@ue-shed/protocol 0.7.1 → 0.8.0

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

@@ -1,218 +1,267 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "https://ue-shed.dev/contracts/cameras/map-tile/v1/plan.schema.json",
-	"title": "UE Shed Map Capture Plan v1.0",
 	"type": "object",
-	"additionalProperties": false,
-	"required": [
-		"capture",
-		"contract",
-		"gutterPixels",
-		"id",
-		"levels",
-		"output",
-		"project",
-		"requestedBounds",
-		"tilePixelSize"
-	],
 	"properties": {
 		"capture": {
-			"$ref": "#/$defs/capturePolicy"
-		},
-		"contract": {
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["name", "version"],
-			"properties": {
-				"name": {
-					"const": "ue-shed-map-capture-plan"
-				},
-				"version": {
-					"$ref": "#/$defs/version"
-				}
-			}
-		},
-		"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
-				}
-			}
-		},
-		"output": {
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["imageFormat", "publication"],
-			"properties": {
-				"imageFormat": {
-					"const": "png"
-				},
-				"publication": {
-					"const": "local_immutable"
-				}
-			}
-		},
-		"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}$"
-		},
-		"version": {
 			"type": "object",
-			"additionalProperties": false,
-			"required": ["major", "minor"],
 			"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"
-				}
-			}
-		},
-		"project": {
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["id", "mapPath"],
-			"properties": {
-				"id": {
-					"$ref": "#/$defs/id"
-				},
-				"mapPath": {
-					"type": "string",
-					"pattern": "^/[A-Za-z0-9_./-]+$"
-				}
-			}
-		},
-		"dataLayers": {
-			"oneOf": [
-				{
+				"visibility": {
 					"type": "object",
-					"additionalProperties": false,
-					"required": ["mode"],
 					"properties": {
-						"mode": {
-							"const": "unchanged"
-						}
-					}
-				},
-				{
-					"type": "object",
-					"additionalProperties": false,
-					"required": ["mode", "states"],
-					"properties": {
-						"mode": {
-							"const": "explicit"
-						},
-						"states": {
+						"hide": {
 							"type": "array",
-							"maxItems": 64,
 							"items": {
 								"type": "object",
-								"additionalProperties": false,
-								"required": ["name", "state"],
 								"properties": {
-									"name": {
+									"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",
-										"minLength": 1,
-										"maxLength": 1024
+										"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
+											}
+										]
 									},
-									"state": {
-										"enum": ["unloaded", "loaded", "activated"]
+									"label": {
+										"type": "string",
+										"allOf": [
+											{
+												"maxLength": 256
+											}
+										]
 									}
+								},
+								"required": ["locator", "label"],
+								"additionalProperties": false
+							},
+							"allOf": [
+								{
+									"maxItems": 256
 								}
-							}
+							]
 						}
-					}
-				}
-			]
-		},
-		"capturePolicy": {
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["dataLayers", "orientation", "render", "z"],
-			"properties": {
+					},
+					"required": ["hide", "protect"],
+					"additionalProperties": false
+				},
 				"dataLayers": {
-					"$ref": "#/$defs/dataLayers"
+					"anyOf": [
+						{
+							"type": "object",
+							"properties": {
+								"mode": {
+									"type": "string",
+									"enum": ["unchanged"]
+								}
+							},
+							"required": ["mode"],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"mode": {
+									"type": "string",
+									"enum": ["explicit"]
+								},
+								"states": {
+									"type": "array",
+									"items": {
+										"type": "object",
+										"properties": {
+											"name": {
+												"type": "string",
+												"allOf": [
+													{
+														"minLength": 1
+													},
+													{
+														"maxLength": 1024
+													}
+												]
+											},
+											"state": {
+												"type": "string",
+												"enum": ["unloaded", "loaded", "activated"]
+											}
+										},
+										"required": ["name", "state"],
+										"additionalProperties": false
+									},
+									"allOf": [
+										{
+											"maxItems": 64
+										}
+									]
+								}
+							},
+							"required": ["mode", "states"],
+							"additionalProperties": false
+						}
+					]
 				},
 				"orientation": {
 					"type": "object",
-					"additionalProperties": false,
-					"required": ["pitch", "roll", "yaw"],
 					"properties": {
 						"pitch": {
-							"const": -90
+							"type": "number",
+							"enum": [-90]
 						},
 						"roll": {
-							"const": 0
+							"type": "number",
+							"enum": [0]
 						},
 						"yaw": {
-							"const": 0
+							"type": "number",
+							"enum": [0]
 						}
-					}
+					},
+					"required": ["pitch", "roll", "yaw"],
+					"additionalProperties": false
 				},
 				"render": {
 					"type": "object",
-					"additionalProperties": false,
-					"required": ["effects", "lodPolicy", "profile"],
 					"properties": {
 						"exposureEV100": {
 							"type": "number",
-							"minimum": -20,
-							"maximum": 30
+							"allOf": [
+								{
+									"minimum": -20,
+									"maximum": 30
+								}
+							]
 						},
 						"effects": {
 							"type": "object",
-							"additionalProperties": false,
-							"required": ["fog", "volumetricFog"],
 							"properties": {
 								"fog": {
 									"type": "boolean"
@@ -220,22 +269,36 @@
 								"volumetricFog": {
 									"type": "boolean"
 								}
-							}
+							},
+							"required": ["fog", "volumetricFog"],
+							"additionalProperties": false
 						},
 						"lodDistanceScaleByZoom": {
 							"type": "array",
-							"minItems": 1,
-							"maxItems": 24,
 							"items": {
 								"type": "number",
-								"minimum": 0.1,
-								"maximum": 100
-							}
+								"allOf": [
+									{
+										"minimum": 0.1,
+										"maximum": 100
+									}
+								]
+							},
+							"allOf": [
+								{
+									"minItems": 1
+								},
+								{
+									"maxItems": 24
+								}
+							]
 						},
 						"lodPolicy": {
+							"type": "string",
 							"enum": ["natural", "fixed_lod_zero", "per_level_distance_scale"]
 						},
 						"profile": {
+							"type": "string",
 							"enum": [
 								"full_fidelity",
 								"seam_stable",
@@ -244,30 +307,161 @@
 							]
 						}
 					},
+					"required": ["effects", "lodPolicy", "profile"],
+					"additionalProperties": false
+				},
+				"z": {
+					"type": "number"
+				}
+			},
+			"required": ["dataLayers", "orientation", "render", "z"],
+			"additionalProperties": false
+		},
+		"contract": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string",
+					"enum": ["ue-shed-map-capture-plan"]
+				},
+				"version": {
+					"type": "object",
+					"properties": {
+						"major": {
+							"type": "number",
+							"enum": [1]
+						},
+						"minor": {
+							"type": "number",
+							"enum": [0, 1, 2]
+						}
+					},
+					"required": ["major", "minor"],
+					"additionalProperties": false
+				}
+			},
+			"required": ["name", "version"],
+			"additionalProperties": false
+		},
+		"gutterPixels": {
+			"type": "integer",
+			"allOf": [
+				{
+					"minimum": 0,
+					"maximum": 32
+				}
+			]
+		},
+		"id": {
+			"type": "string",
+			"allOf": [
+				{
+					"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
+				}
+			]
+		},
+		"levels": {
+			"type": "object",
+			"properties": {
+				"coarsestUnitsPerPixel": {
+					"type": "number",
 					"allOf": [
 						{
-							"if": {
-								"properties": {
-									"lodPolicy": {
-										"const": "per_level_distance_scale"
-									}
-								}
-							},
-							"then": {
-								"required": ["lodDistanceScaleByZoom"]
-							},
-							"else": {
-								"not": {
-									"required": ["lodDistanceScaleByZoom"]
-								}
-							}
+							"exclusiveMinimum": 0
 						}
 					]
 				},
-				"z": {
+				"count": {
+					"type": "integer",
+					"allOf": [
+						{
+							"minimum": 1,
+							"maximum": 24
+						}
+					]
+				}
+			},
+			"required": ["coarsestUnitsPerPixel", "count"],
+			"additionalProperties": false
+		},
+		"output": {
+			"type": "object",
+			"properties": {
+				"imageFormat": {
+					"type": "string",
+					"enum": ["png"]
+				},
+				"publication": {
+					"type": "string",
+					"enum": ["local_immutable"]
+				}
+			},
+			"required": ["imageFormat", "publication"],
+			"additionalProperties": false
+		},
+		"project": {
+			"type": "object",
+			"properties": {
+				"id": {
+					"type": "string",
+					"allOf": [
+						{
+							"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
+						}
+					]
+				},
+				"mapPath": {
+					"type": "string",
+					"allOf": [
+						{
+							"pattern": "^\\/[A-Za-z0-9_./-]+$"
+						}
+					]
+				}
+			},
+			"required": ["id", "mapPath"],
+			"additionalProperties": false
+		},
+		"requestedBounds": {
+			"type": "object",
+			"properties": {
+				"minX": {
+					"type": "number"
+				},
+				"minY": {
+					"type": "number"
+				},
+				"maxX": {
+					"type": "number"
+				},
+				"maxY": {
 					"type": "number"
 				}
-			}
+			},
+			"required": ["minX", "minY", "maxX", "maxY"],
+			"additionalProperties": false
+		},
+		"tilePixelSize": {
+			"type": "integer",
+			"allOf": [
+				{
+					"minimum": 64,
+					"maximum": 4096
+				}
+			]
 		}
-	}
+	},
+	"required": [
+		"capture",
+		"contract",
+		"gutterPixels",
+		"id",
+		"levels",
+		"output",
+		"project",
+		"requestedBounds",
+		"tilePixelSize"
+	],
+	"additionalProperties": false,
+	"$defs": {}
 }

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

@@ -3,8 +3,13 @@
 	"$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"] }
+		"released": {
+			"type": "boolean"
+		},
+		"restoration": {
+			"type": "string",
+			"enum": ["restored", "failed"]
+		}
 	},
 	"required": ["released", "restoration"],
 	"additionalProperties": false,