@ue-shed/protocol 0.1.0-rc.4 → 0.2.0

package/contracts/uasset-io/v1/fixtures/invalid/project-index-query-oversize-limit.json

@@ -0,0 +1,15 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"limits": {},
+	"operation": {
+		"cacheRoot": "C:/Caches/project-index",
+		"kind": "project_index_query",
+		"query": {
+			"expectedGeneration": 1,
+			"kind": "maps",
+			"limit": 1025,
+			"projectId": "fixture-project"
+		}
+	},
+	"requestId": "project-index-query-oversize"
+}

package/contracts/uasset-io/v1/fixtures/invalid/request-wrong-major.json

@@ -0,0 +1,6 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 2, "minor": 0 } },
+	"limits": {},
+	"operation": { "assetPath": "C:/project/Content/A.uasset", "kind": "inspect" },
+	"requestId": "request-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/accepted-event.json

@@ -0,0 +1,7 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "accepted",
+	"operation": "scan",
+	"requestId": "request-001",
+	"sequence": 0
+}

package/contracts/uasset-io/v1/fixtures/valid/authoring-result-event.json

@@ -0,0 +1,26 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 2,
+	"result": {
+		"kind": "authoring",
+		"snapshot": {
+			"contract": { "name": "unreal-authoring", "version": { "major": 2, "minor": 1 } },
+			"authority": { "kind": "project_files", "packageName": "/Game/Example" },
+			"completeness": "complete",
+			"diagnostics": [],
+			"fingerprint": { "status": "unavailable", "reason": "not_available" },
+			"producer": { "name": "fixture", "version": "1" },
+			"table": {
+				"kind": "data_table",
+				"objectPath": "/Game/Example.Example",
+				"rowStruct": "/Script/Example.Row",
+				"parentTables": [],
+				"rows": [],
+				"packageName": "/Game/Example",
+				"schema": { "status": "unavailable", "reason": "not_available" }
+			}
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/extract-text-occurrence-result-event.json

@@ -0,0 +1,26 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 9,
+	"result": {
+		"kind": "extract_text",
+		"event": {
+			"event": "text_occurrence",
+			"schema_version": 1,
+			"path": "Content/Example.uasset",
+			"fileBytes": 128,
+			"occurrence": {
+				"source": "Hello",
+				"identity": { "status": "resolved", "namespace": "Example", "key": "Hello" },
+				"location": {
+					"kind": "asset_property",
+					"object_path": "/Game/Example.Example",
+					"class_path": "/Script/Example.Example",
+					"property_path": "Title"
+				},
+				"edit_capability": "source_editable"
+			}
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/extract-text-result-event.json

@@ -0,0 +1,23 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 6,
+	"result": {
+		"kind": "extract_text",
+		"event": {
+			"event": "text_summary",
+			"cacheHits": 0,
+			"depth": "text",
+			"diagnostics": [],
+			"emittedAssets": 0,
+			"failedAssets": 0,
+			"partialAssets": 0,
+			"projectRoot": ".",
+			"roots": [],
+			"scannedAssets": 0,
+			"schema_version": 8,
+			"skippedAssets": 0
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/extract-text-summary-result-event.json

@@ -0,0 +1,23 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 7,
+	"result": {
+		"kind": "extract_texture",
+		"event": {
+			"event": "texture_summary",
+			"cacheHits": 0,
+			"depth": "texture",
+			"diagnostics": [],
+			"emittedAssets": 0,
+			"failedAssets": 0,
+			"partialAssets": 0,
+			"projectRoot": ".",
+			"roots": [],
+			"scannedAssets": 0,
+			"schema_version": 8,
+			"skippedAssets": 0
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/extract-texture-record-result-event.json

@@ -0,0 +1,29 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 10,
+	"result": {
+		"kind": "extract_texture",
+		"event": {
+			"event": "texture_record",
+			"schema_version": 1,
+			"path": "Content/Example.uasset",
+			"record": {
+				"object_path": "/Game/Example.Example",
+				"package_file_bytes": { "status": "available", "source": "file", "value": 128 },
+				"dimensions": {
+					"status": "available",
+					"source": "serialized",
+					"value": { "width": 64, "height": 64 }
+				},
+				"source_format": { "status": "unavailable", "reason": "not_serialized" },
+				"source_mips": { "status": "unavailable", "reason": "wrong_value_kind" },
+				"compression": { "status": "unavailable", "reason": "missing_source" },
+				"s_rgb": { "status": "available", "source": "serialized", "value": true },
+				"texture_group": { "status": "unavailable", "reason": "not_serialized" },
+				"mip_generation": { "status": "unavailable", "reason": "not_serialized" }
+			}
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/inspect-result-event.json

@@ -0,0 +1,29 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 1,
+	"result": {
+		"kind": "inspect",
+		"inspection": {
+			"assets": [],
+			"decode_errors": [],
+			"package": {
+				"name": "/Game/Example",
+				"package_flags": 0,
+				"summary_size": 64,
+				"total_header_size": 128,
+				"version": {
+					"legacy_file": 0,
+					"legacy_ue3": 0,
+					"ue4": 1,
+					"ue5": 0,
+					"licensee": 0
+				}
+			},
+			"path": "Content/Example.uasset",
+			"schema_version": 8,
+			"status": "ok"
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/partial-completed-event.json

@@ -0,0 +1,7 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "completed",
+	"outcome": "partial",
+	"requestId": "request-001",
+	"sequence": 3
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-accepted-event.json

@@ -0,0 +1,7 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"kind": "accepted",
+	"operation": "project_index_refresh",
+	"requestId": "project-index-refresh-001",
+	"sequence": 0
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-page-result-event.json

@@ -0,0 +1,28 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"kind": "result",
+	"requestId": "project-index-query-001",
+	"result": {
+		"kind": "project_index_page",
+		"page": {
+			"generation": 3,
+			"items": [
+				{
+					"kind": "map",
+					"mapPath": "Content/Maps/L_Fixture.umap",
+					"packageName": "/Game/Maps/L_Fixture"
+				},
+				{
+					"classes": ["/Script/Engine.DataTable"],
+					"kind": "header",
+					"packageName": "/Game/Data/DT_Items",
+					"packagePath": "Content/Data/DT_Items.uasset",
+					"serializedNames": ["TextProperty"]
+				}
+			],
+			"nextCursor": "2",
+			"projectId": "fixture-project"
+		}
+	},
+	"sequence": 1
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-progress-event.json

@@ -0,0 +1,9 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"completedItems": 12,
+	"kind": "progress",
+	"phase": "reading_headers",
+	"requestId": "project-index-refresh-001",
+	"sequence": 1,
+	"totalItems": 40
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-query-request.json

@@ -0,0 +1,19 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"limits": {
+		"maximumOutputBytes": 1048576,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"cacheRoot": "C:/Caches/project-index",
+		"kind": "project_index_query",
+		"query": {
+			"expectedGeneration": 3,
+			"kind": "exact_classes",
+			"limit": 50,
+			"projectId": "fixture-project",
+			"values": ["/Script/Engine.DataTable"]
+		}
+	},
+	"requestId": "project-index-query-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-rebuild-request.json

@@ -0,0 +1,13 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"limits": {
+		"maximumOutputBytes": 1048576,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"cacheRoot": "C:/Caches/project-index",
+		"kind": "project_index_rebuild",
+		"projectRoot": "C:/project"
+	},
+	"requestId": "project-index-rebuild-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-refresh-request.json

@@ -0,0 +1,13 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"limits": {
+		"maximumOutputBytes": 1048576,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"cacheRoot": "C:/Caches/project-index",
+		"kind": "project_index_refresh",
+		"projectRoot": "C:/project"
+	},
+	"requestId": "project-index-refresh-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-stale-generation-failed-event.json

@@ -0,0 +1,11 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"actualGeneration": 4,
+	"code": "stale_generation",
+	"expectedGeneration": 3,
+	"kind": "failed",
+	"message": "The Project Index generation changed since this query started.",
+	"requestId": "project-index-query-001",
+	"retrySafe": true,
+	"sequence": 1
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-status-request.json

@@ -0,0 +1,13 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"limits": {
+		"maximumOutputBytes": 1048576,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"cacheRoot": "C:/Caches/project-index",
+		"kind": "project_index_status",
+		"projectRoot": "C:/project"
+	},
+	"requestId": "project-index-status-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-status-result-event.json

@@ -0,0 +1,22 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"kind": "result",
+	"requestId": "project-index-status-001",
+	"result": {
+		"kind": "project_index_status",
+		"status": {
+			"status": "ready",
+			"summary": {
+				"changedPackages": 0,
+				"completeness": "complete",
+				"diagnostics": [],
+				"generation": 3,
+				"mapCount": 1,
+				"packageCount": 40,
+				"projectId": "fixture-project",
+				"removedPackages": 0
+			}
+		}
+	},
+	"sequence": 1
+}

package/contracts/uasset-io/v1/fixtures/valid/project-index-summary-result-event.json

@@ -0,0 +1,25 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 1 } },
+	"kind": "result",
+	"requestId": "project-index-refresh-001",
+	"result": {
+		"kind": "project_index_summary",
+		"summary": {
+			"changedPackages": 2,
+			"completeness": "complete",
+			"diagnostics": [
+				{
+					"code": "header_partial",
+					"message": "One package header decoded incompletely.",
+					"retrySafe": true
+				}
+			],
+			"generation": 4,
+			"mapCount": 1,
+			"packageCount": 40,
+			"projectId": "fixture-project",
+			"removedPackages": 1
+		}
+	},
+	"sequence": 2
+}

package/contracts/uasset-io/v1/fixtures/valid/saved-world-result-event.json

@@ -0,0 +1,27 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 8,
+	"result": {
+		"kind": "saved_world",
+		"world": {
+			"authority": { "kind": "project_files", "mapPackage": "/Game/Maps/Example" },
+			"completeness": "complete",
+			"contract": {
+				"name": "unreal-saved-world",
+				"version": { "major": 1, "minor": 0 }
+			},
+			"diagnostics": [],
+			"mapPath": "Content/Maps/Example.umap",
+			"sourceKind": "level",
+			"actors": [],
+			"summary": {
+				"failedPackages": 0,
+				"partialPackages": 0,
+				"resolvedActors": 0,
+				"scannedPackages": 0
+			}
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/scan-asset-result-event.json

@@ -0,0 +1,47 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 3,
+	"result": {
+		"kind": "scan_asset",
+		"entry": {
+			"depth": "full",
+			"fileBytes": 128,
+			"inspection": {
+				"assets": [
+					{
+						"kind": "UObject",
+						"object_path": "/Game/Example.Example",
+						"class_path": "/Script/Example.Example",
+						"properties": [
+							{
+								"name": "Title",
+								"type": "StrProperty",
+								"value_kind": "string",
+								"value": "hello"
+							}
+						]
+					}
+				],
+				"decode_errors": [],
+				"package": {
+					"name": "/Game/Example",
+					"package_flags": 0,
+					"summary_size": 64,
+					"total_header_size": 128,
+					"version": {
+						"legacy_file": 0,
+						"legacy_ue3": 0,
+						"ue4": 1,
+						"ue5": 0,
+						"licensee": 0
+					}
+				},
+				"path": "Content/Example.uasset",
+				"schema_version": 8,
+				"status": "ok"
+			}
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/scan-inventory-result-event.json

@@ -0,0 +1,15 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 4,
+	"result": {
+		"kind": "scan_inventory",
+		"entry": {
+			"kind": "package",
+			"modifiedMs": 0,
+			"path": "Content/Example.uasset",
+			"size": 128
+		}
+	}
+}

package/contracts/uasset-io/v1/fixtures/valid/scan-request.json

@@ -0,0 +1,17 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"limits": {
+		"concurrency": 4,
+		"maximumAssets": 1024,
+		"maximumOutputBytes": 67108864,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"depth": "header",
+		"inventory": true,
+		"kind": "scan",
+		"paths": [],
+		"projectRoot": "C:/project"
+	},
+	"requestId": "request-001"
+}

package/contracts/uasset-io/v1/fixtures/valid/scan-summary-result-event.json

@@ -0,0 +1,24 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 0 } },
+	"kind": "result",
+	"requestId": "request-001",
+	"sequence": 5,
+	"result": {
+		"kind": "scan_summary",
+		"summary": {
+			"cacheHits": 0,
+			"depth": "full",
+			"diagnostics": [],
+			"emittedAssets": 0,
+			"failedAssets": 0,
+			"inventoryComplete": true,
+			"inventoryFiles": 0,
+			"partialAssets": 0,
+			"projectRoot": ".",
+			"roots": [],
+			"scannedAssets": 0,
+			"schema_version": 8,
+			"skippedAssets": 0
+		}
+	}
+}