@ue-shed/protocol 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/contracts/cameras/map-tile/v1/README.md +7 -0
  2. package/contracts/cameras/map-tile/v1/capture-response.schema.json +97 -25
  3. package/contracts/cameras/map-tile/v1/manifest.schema.json +136 -37
  4. package/contracts/cameras/map-tile/v1/plan.schema.json +132 -36
  5. package/contracts/cameras/map-tile/v1/release-result.schema.json +12 -0
  6. package/contracts/cameras/render/v1/README.md +33 -0
  7. package/contracts/cameras/render/v1/begin-result.schema.json +712 -0
  8. package/contracts/cameras/render/v1/capabilities.schema.json +201 -0
  9. package/contracts/cameras/render/v1/end-result.schema.json +185 -0
  10. package/contracts/cameras/render/v1/fixtures/frame-orthographic.json +31 -0
  11. package/contracts/cameras/render/v1/fixtures/frame-perspective.json +31 -0
  12. package/contracts/cameras/render/v1/fixtures/invalid-frame-mixed-projection.json +32 -0
  13. package/contracts/cameras/render/v1/fixtures/invalid-frame-size.json +31 -0
  14. package/contracts/cameras/render/v1/fixtures/invalid-session-backend-fields.json +40 -0
  15. package/contracts/cameras/render/v1/fixtures/invalid-session-budget.json +39 -0
  16. package/contracts/cameras/render/v1/fixtures/invalid-session-future.json +39 -0
  17. package/contracts/cameras/render/v1/fixtures/session-camera-regions.json +51 -0
  18. package/contracts/cameras/render/v1/fixtures/session-editor-viewport.json +40 -0
  19. package/contracts/cameras/render/v1/fixtures/session-scene-capture.json +39 -0
  20. package/contracts/cameras/render/v1/frame-evidence.schema.json +771 -0
  21. package/contracts/cameras/render/v1/frame-request.schema.json +219 -0
  22. package/contracts/cameras/render/v1/frame-status.schema.json +1076 -0
  23. package/contracts/cameras/render/v1/policy.schema.json +510 -0
  24. package/contracts/cameras/render/v1/preflight.schema.json +68 -0
  25. package/contracts/cameras/render/v1/review-inspection-request.schema.json +342 -0
  26. package/contracts/cameras/render/v1/review-inspection-result.schema.json +2030 -0
  27. package/contracts/cameras/render/v1/review-realization-request.schema.json +417 -0
  28. package/contracts/cameras/render/v1/review-realization-result.schema.json +454 -0
  29. package/contracts/cameras/render/v1/session-request.schema.json +617 -0
  30. package/contracts/cameras/review/v1/README.md +7 -0
  31. package/contracts/cameras/review/v1/capture-request.schema.json +247 -61
  32. package/contracts/cameras/review/v1/capture-response.schema.json +820 -192
  33. package/package.json +1 -1
package/contracts/cameras/map-tile/v1/README.md CHANGED
@@ -56,3 +56,10 @@ Control payload rather than giving it hidden editor authority.
56
56
 
57
57
  Change this contract in authority order: JSON Schema and fixtures, conformant Effect codecs,
58
58
  UEShedCameras C++ producer with trusted UE 5.7 evidence, then consumers.
59
+
60
+ Minor 1 adds source `renderEvidence` to capture responses and immutable manifests. The source
61
+ frame resolution can differ from a published tile after gutter cropping, supersampling or slicing.
62
+ `release-result.schema.json` describes the EndMapTileCapture result for this lifecycle; callers
63
+ must require `restoration: restored` before publication. A false `released` means the specified run
64
+ did not own the map adapter; it never releases another owner. Renderer ownership is shared with
65
+ the camera render 1.0 and Review adapters.
package/contracts/cameras/map-tile/v1/capture-response.schema.json CHANGED
@@ -15,26 +15,49 @@
15
15
  "tileCounts"
16
16
  ],
17
17
  "properties": {
18
- "actualMapPath": { "type": "string", "pattern": "^/[A-Za-z0-9_./-]+$" },
18
+ "actualMapPath": {
19
+ "type": "string",
20
+ "pattern": "^/[A-Za-z0-9_./-]+$"
21
+ },
19
22
  "contract": {
20
23
  "type": "object",
21
24
  "additionalProperties": false,
22
25
  "required": ["name", "version"],
23
26
  "properties": {
24
- "name": { "const": "ue-shed-map-tile-capture" },
25
- "version": { "$ref": "plan.schema.json#/$defs/version" }
27
+ "name": {
28
+ "const": "ue-shed-map-tile-capture"
29
+ },
30
+ "version": {
31
+ "$ref": "plan.schema.json#/$defs/version"
32
+ }
26
33
  }
27
34
  },
28
- "correlationId": { "$ref": "plan.schema.json#/$defs/id" },
35
+ "correlationId": {
36
+ "$ref": "plan.schema.json#/$defs/id"
37
+ },
29
38
  "dirtyState": {
30
39
  "type": "object",
31
40
  "additionalProperties": false,
32
41
  "required": ["before", "after"],
33
- "properties": { "before": { "type": "boolean" }, "after": { "type": "boolean" } }
42
+ "properties": {
43
+ "before": {
44
+ "type": "boolean"
45
+ },
46
+ "after": {
47
+ "type": "boolean"
48
+ }
49
+ }
50
+ },
51
+ "durationMs": {
52
+ "type": "number",
53
+ "minimum": 0
54
+ },
55
+ "failure": {
56
+ "$ref": "#/$defs/failure"
57
+ },
58
+ "operationId": {
59
+ "$ref": "plan.schema.json#/$defs/id"
34
60
  },
35
- "durationMs": { "type": "number", "minimum": 0 },
36
- "failure": { "$ref": "#/$defs/failure" },
37
- "operationId": { "$ref": "plan.schema.json#/$defs/id" },
38
61
  "results": {
39
62
  "type": "array",
40
63
  "maxItems": 64,
@@ -53,13 +76,35 @@
53
76
  "width"
54
77
  ],
55
78
  "properties": {
56
- "bytes": { "type": "integer", "minimum": 1 },
57
- "captureDurationMs": { "type": "number", "minimum": 0 },
58
- "height": { "type": "integer", "minimum": 1 },
59
- "key": { "$ref": "capture-request.schema.json#/$defs/tileKey" },
60
- "stagedPath": { "type": "string", "minLength": 1 },
61
- "status": { "const": "captured" },
62
- "width": { "type": "integer", "minimum": 1 }
79
+ "bytes": {
80
+ "type": "integer",
81
+ "minimum": 1
82
+ },
83
+ "captureDurationMs": {
84
+ "type": "number",
85
+ "minimum": 0
86
+ },
87
+ "height": {
88
+ "type": "integer",
89
+ "minimum": 1
90
+ },
91
+ "key": {
92
+ "$ref": "capture-request.schema.json#/$defs/tileKey"
93
+ },
94
+ "stagedPath": {
95
+ "type": "string",
96
+ "minLength": 1
97
+ },
98
+ "status": {
99
+ "const": "captured"
100
+ },
101
+ "width": {
102
+ "type": "integer",
103
+ "minimum": 1
104
+ },
105
+ "renderEvidence": {
106
+ "$ref": "../../render/v1/frame-evidence.schema.json"
107
+ }
63
108
  }
64
109
  },
65
110
  {
@@ -67,23 +112,40 @@
67
112
  "additionalProperties": false,
68
113
  "required": ["failure", "key", "status"],
69
114
  "properties": {
70
- "failure": { "$ref": "#/$defs/failure" },
71
- "key": { "$ref": "capture-request.schema.json#/$defs/tileKey" },
72
- "status": { "const": "failed" }
115
+ "failure": {
116
+ "$ref": "#/$defs/failure"
117
+ },
118
+ "key": {
119
+ "$ref": "capture-request.schema.json#/$defs/tileKey"
120
+ },
121
+ "status": {
122
+ "const": "failed"
123
+ }
73
124
  }
74
125
  }
75
126
  ]
76
127
  }
77
128
  },
78
- "status": { "enum": ["completed", "partial", "cancelled", "failed"] },
129
+ "status": {
130
+ "enum": ["completed", "partial", "cancelled", "failed"]
131
+ },
79
132
  "tileCounts": {
80
133
  "type": "object",
81
134
  "additionalProperties": false,
82
135
  "required": ["failed", "requested", "succeeded"],
83
136
  "properties": {
84
- "failed": { "type": "integer", "minimum": 0 },
85
- "requested": { "type": "integer", "minimum": 0 },
86
- "succeeded": { "type": "integer", "minimum": 0 }
137
+ "failed": {
138
+ "type": "integer",
139
+ "minimum": 0
140
+ },
141
+ "requested": {
142
+ "type": "integer",
143
+ "minimum": 0
144
+ },
145
+ "succeeded": {
146
+ "type": "integer",
147
+ "minimum": 0
148
+ }
87
149
  }
88
150
  }
89
151
  },
@@ -106,9 +168,19 @@
106
168
  "write_failed"
107
169
  ]
108
170
  },
109
- "message": { "type": "string", "minLength": 1, "maxLength": 1024 },
110
- "recovery": { "type": "string", "minLength": 1, "maxLength": 1024 },
111
- "retrySafe": { "type": "boolean" }
171
+ "message": {
172
+ "type": "string",
173
+ "minLength": 1,
174
+ "maxLength": 1024
175
+ },
176
+ "recovery": {
177
+ "type": "string",
178
+ "minLength": 1,
179
+ "maxLength": 1024
180
+ },
181
+ "retrySafe": {
182
+ "type": "boolean"
183
+ }
112
184
  }
113
185
  }
114
186
  }
package/contracts/cameras/map-tile/v1/manifest.schema.json CHANGED
@@ -29,20 +29,34 @@
29
29
  "additionalProperties": false,
30
30
  "required": ["children", "parent", "path"],
31
31
  "properties": {
32
- "children": { "const": "z+1: (2r,2c),(2r,2c+1),(2r+1,2c),(2r+1,2c+1)" },
33
- "parent": { "const": "z-1: (floor(r/2),floor(c/2))" },
34
- "path": { "const": "Z{zoom:02}/R{row:03}_C{column:03}.png" }
32
+ "children": {
33
+ "const": "z+1: (2r,2c),(2r,2c+1),(2r+1,2c),(2r+1,2c+1)"
34
+ },
35
+ "parent": {
36
+ "const": "z-1: (floor(r/2),floor(c/2))"
37
+ },
38
+ "path": {
39
+ "const": "Z{zoom:02}/R{row:03}_C{column:03}.png"
40
+ }
35
41
  }
36
42
  },
37
- "capturePolicy": { "$ref": "plan.schema.json#/$defs/capturePolicy" },
38
- "completedAt": { "$ref": "#/$defs/timestamp" },
43
+ "capturePolicy": {
44
+ "$ref": "plan.schema.json#/$defs/capturePolicy"
45
+ },
46
+ "completedAt": {
47
+ "$ref": "#/$defs/timestamp"
48
+ },
39
49
  "contract": {
40
50
  "type": "object",
41
51
  "additionalProperties": false,
42
52
  "required": ["name", "version"],
43
53
  "properties": {
44
- "name": { "const": "ue-shed-map-tile-pyramid" },
45
- "version": { "$ref": "plan.schema.json#/$defs/version" }
54
+ "name": {
55
+ "const": "ue-shed-map-tile-pyramid"
56
+ },
57
+ "version": {
58
+ "$ref": "plan.schema.json#/$defs/version"
59
+ }
46
60
  }
47
61
  },
48
62
  "failures": {
@@ -52,8 +66,12 @@
52
66
  "additionalProperties": false,
53
67
  "required": ["failure", "key"],
54
68
  "properties": {
55
- "failure": { "$ref": "capture-response.schema.json#/$defs/failure" },
56
- "key": { "$ref": "capture-request.schema.json#/$defs/tileKey" }
69
+ "failure": {
70
+ "$ref": "capture-response.schema.json#/$defs/failure"
71
+ },
72
+ "key": {
73
+ "$ref": "capture-request.schema.json#/$defs/tileKey"
74
+ }
57
75
  }
58
76
  }
59
77
  },
@@ -67,18 +85,33 @@
67
85
  "additionalProperties": false,
68
86
  "required": ["name", "version"],
69
87
  "properties": {
70
- "name": { "const": "rows_max_x_to_min_x_columns_min_y_to_max_y" },
71
- "version": { "const": 1 }
88
+ "name": {
89
+ "const": "rows_max_x_to_min_x_columns_min_y_to_max_y"
90
+ },
91
+ "version": {
92
+ "const": 1
93
+ }
72
94
  }
73
95
  },
74
96
  "origin": {
75
97
  "type": "object",
76
98
  "additionalProperties": false,
77
99
  "required": ["x", "y"],
78
- "properties": { "x": { "type": "number" }, "y": { "type": "number" } }
100
+ "properties": {
101
+ "x": {
102
+ "type": "number"
103
+ },
104
+ "y": {
105
+ "type": "number"
106
+ }
107
+ }
108
+ },
109
+ "requestedBounds": {
110
+ "$ref": "plan.schema.json#/$defs/bounds"
79
111
  },
80
- "requestedBounds": { "$ref": "plan.schema.json#/$defs/bounds" },
81
- "snappedBounds": { "$ref": "plan.schema.json#/$defs/bounds" }
112
+ "snappedBounds": {
113
+ "$ref": "plan.schema.json#/$defs/bounds"
114
+ }
82
115
  }
83
116
  },
84
117
  "gutter": {
@@ -86,9 +119,17 @@
86
119
  "additionalProperties": false,
87
120
  "required": ["pixels", "rule", "textureAddress"],
88
121
  "properties": {
89
- "pixels": { "type": "integer", "minimum": 0, "maximum": 32 },
90
- "rule": { "const": "render_overdraw_then_crop" },
91
- "textureAddress": { "const": "clamp_to_edge" }
122
+ "pixels": {
123
+ "type": "integer",
124
+ "minimum": 0,
125
+ "maximum": 32
126
+ },
127
+ "rule": {
128
+ "const": "render_overdraw_then_crop"
129
+ },
130
+ "textureAddress": {
131
+ "const": "clamp_to_edge"
132
+ }
92
133
  }
93
134
  },
94
135
  "levels": {
@@ -100,30 +141,69 @@
100
141
  "additionalProperties": false,
101
142
  "required": ["columns", "rows", "tileWorldSize", "unitsPerPixel", "zoom"],
102
143
  "properties": {
103
- "columns": { "type": "integer", "minimum": 1 },
104
- "rows": { "type": "integer", "minimum": 1 },
105
- "tileWorldSize": { "type": "number", "exclusiveMinimum": 0 },
106
- "unitsPerPixel": { "type": "number", "exclusiveMinimum": 0 },
107
- "zoom": { "type": "integer", "minimum": 0 }
144
+ "columns": {
145
+ "type": "integer",
146
+ "minimum": 1
147
+ },
148
+ "rows": {
149
+ "type": "integer",
150
+ "minimum": 1
151
+ },
152
+ "tileWorldSize": {
153
+ "type": "number",
154
+ "exclusiveMinimum": 0
155
+ },
156
+ "unitsPerPixel": {
157
+ "type": "number",
158
+ "exclusiveMinimum": 0
159
+ },
160
+ "zoom": {
161
+ "type": "integer",
162
+ "minimum": 0
163
+ }
108
164
  }
109
165
  }
110
166
  },
111
- "planId": { "$ref": "plan.schema.json#/$defs/id" },
112
- "project": { "$ref": "plan.schema.json#/$defs/project" },
167
+ "planId": {
168
+ "$ref": "plan.schema.json#/$defs/id"
169
+ },
170
+ "project": {
171
+ "$ref": "plan.schema.json#/$defs/project"
172
+ },
113
173
  "provenance": {
114
174
  "type": "object",
115
175
  "additionalProperties": false,
116
176
  "required": ["producer", "tool", "toolVersion"],
117
177
  "properties": {
118
- "producer": { "type": "string", "minLength": 1, "maxLength": 1024 },
119
- "tool": { "const": "ue-shed" },
120
- "toolVersion": { "type": "string", "minLength": 1, "maxLength": 1024 }
178
+ "producer": {
179
+ "type": "string",
180
+ "minLength": 1,
181
+ "maxLength": 1024
182
+ },
183
+ "tool": {
184
+ "const": "ue-shed"
185
+ },
186
+ "toolVersion": {
187
+ "type": "string",
188
+ "minLength": 1,
189
+ "maxLength": 1024
190
+ }
121
191
  }
122
192
  },
123
- "runId": { "$ref": "plan.schema.json#/$defs/id" },
124
- "startedAt": { "$ref": "#/$defs/timestamp" },
125
- "state": { "enum": ["complete", "partial", "cancelled"] },
126
- "tilePixelSize": { "type": "integer", "minimum": 64, "maximum": 4096 },
193
+ "runId": {
194
+ "$ref": "plan.schema.json#/$defs/id"
195
+ },
196
+ "startedAt": {
197
+ "$ref": "#/$defs/timestamp"
198
+ },
199
+ "state": {
200
+ "enum": ["complete", "partial", "cancelled"]
201
+ },
202
+ "tilePixelSize": {
203
+ "type": "integer",
204
+ "minimum": 64,
205
+ "maximum": 4096
206
+ },
127
207
  "tiles": {
128
208
  "type": "array",
129
209
  "items": {
@@ -139,16 +219,35 @@
139
219
  "worldBounds"
140
220
  ],
141
221
  "properties": {
142
- "bytes": { "type": "integer", "minimum": 1 },
143
- "hash": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
144
- "height": { "type": "integer", "minimum": 1 },
145
- "key": { "$ref": "capture-request.schema.json#/$defs/tileKey" },
222
+ "bytes": {
223
+ "type": "integer",
224
+ "minimum": 1
225
+ },
226
+ "hash": {
227
+ "type": "string",
228
+ "pattern": "^sha256:[a-f0-9]{64}$"
229
+ },
230
+ "height": {
231
+ "type": "integer",
232
+ "minimum": 1
233
+ },
234
+ "key": {
235
+ "$ref": "capture-request.schema.json#/$defs/tileKey"
236
+ },
146
237
  "relativePath": {
147
238
  "type": "string",
148
239
  "pattern": "^Z[0-9]{2,}/R[0-9]{3,}_C[0-9]{3,}\\.png$"
149
240
  },
150
- "width": { "type": "integer", "minimum": 1 },
151
- "worldBounds": { "$ref": "plan.schema.json#/$defs/bounds" }
241
+ "width": {
242
+ "type": "integer",
243
+ "minimum": 1
244
+ },
245
+ "worldBounds": {
246
+ "$ref": "plan.schema.json#/$defs/bounds"
247
+ },
248
+ "renderEvidence": {
249
+ "$ref": "../../render/v1/frame-evidence.schema.json"
250
+ }
152
251
  }
153
252
  }
154
253
  }