@ue-shed/protocol 0.5.1 → 0.7.0

package/contracts/uasset-io/v1/README.md

@@ -16,8 +16,33 @@ frames. Version 1.0 operations and the cumulative meaning of `maximumOutputBytes
 Paired TypeScript and native workers negotiate additive operations; a worker that cannot decode an
 operation rejects it before `accepted`.
 
+Minor version 1.2 adds the single-package `blueprint` operation and its versioned saved-graph
+projection. It carries editor graph nodes, arbitrary tagged node properties, native pin data, and
+deduplicated links without requiring Unreal Engine to load the asset. Graph membership drives
+discovery of engine, plugin, and project graph/node subclasses; unsupported saved revisions and
+Control Rig's separate RigVM model fail explicitly.
+
+Minor version 1.3 adds optional `pageEncoding: "dictionary"` to `project_index_query` and the
+`project_index_dictionary_page` result. The page carries a local `strings` array; header `classes`
+and `serializedNames` are zero-based references into it. Map items, paths, item ordering, generation,
+and cursors retain their existing meaning. Each page is independent, with at most 1,024 items,
+64 references per header field, and 131,072 dictionary strings. Decoders must reject references
+outside that page's dictionary before expanding them. This relational check supplements JSON Schema.
+Public library query results expand to the original string arrays. Omitting `pageEncoding` retains
+the original result format; an older worker rejects the new field before accepting the request.
+
+Minor version 1.4 adds `project_index_count`, available in both `protocol` and `protocol-session`.
+Its `request` carries `projectId`, `expectedGeneration`, and between 1 and 16 `filters`. Filters use
+the existing query kinds and value bounds, without pagination fields. The result carries the same
+identity and generation plus `count`: the number of distinct package paths matching any filter.
+Overlapping filters, including map and header matches for the same package, count once. Counts read
+the immutable inventory and checked postings without hydrating package evidence. Stale generations
+and corrupt postings fail with the same typed errors as queries. Old workers reject the operation
+before accepting it.
+
 Result frames use an explicit result kind. Generic inspection, authoring, scan, compact text,
-compact texture, and saved-world values each have a named schema; there is no untyped result field.
+compact texture, Blueprint graph, and saved-world values each have a named schema; there is no
+untyped result field.
 The shared inspection schemas are exported from `@ue-shed/protocol` so the Effect reader and the
 Rust worker can converge on one wire shape.
 

package/contracts/uasset-io/v1/event.schema.json

@@ -44,6 +44,22 @@
 			"title": "int",
 			"exclusiveMinimum": 0
 		},
+		"UAssetIoProjectIndexCountResult": {
+			"type": "object",
+			"properties": {
+				"projectId": {
+					"$ref": "#/$defs/UAssetIoNonEmptyString"
+				},
+				"generation": {
+					"$ref": "#/$defs/UAssetIoPositiveInt"
+				},
+				"count": {
+					"$ref": "#/$defs/UAssetIoNonNegativeInt"
+				}
+			},
+			"required": ["projectId", "generation", "count"],
+			"additionalProperties": false
+		},
 		"UAssetInspectionNonNegativeInt": {
 			"type": "integer",
 			"allOf": [
@@ -3691,6 +3707,372 @@
 			"required": ["schema_version", "status", "path", "package", "assets"],
 			"additionalProperties": false
 		},
+		"BlueprintText": {
+			"type": "object",
+			"properties": {
+				"source": {
+					"type": "string"
+				},
+				"namespace": {
+					"type": "string"
+				},
+				"key": {
+					"type": "string"
+				}
+			},
+			"required": ["source"],
+			"additionalProperties": false
+		},
+		"BlueprintTerminalType": {
+			"type": "object",
+			"properties": {
+				"category": {
+					"type": "string"
+				},
+				"subcategory": {
+					"type": "string"
+				},
+				"subcategory_object": {
+					"type": "string"
+				},
+				"is_const": {
+					"type": "boolean"
+				},
+				"is_weak_pointer": {
+					"type": "boolean"
+				},
+				"is_uobject_wrapper": {
+					"type": "boolean"
+				}
+			},
+			"required": [
+				"category",
+				"subcategory",
+				"is_const",
+				"is_weak_pointer",
+				"is_uobject_wrapper"
+			],
+			"additionalProperties": false
+		},
+		"BlueprintMemberReference": {
+			"type": "object",
+			"properties": {
+				"parent": {
+					"type": "string"
+				},
+				"name": {
+					"type": "string"
+				},
+				"guid": {
+					"type": "string"
+				}
+			},
+			"required": ["name"],
+			"additionalProperties": false
+		},
+		"BlueprintPinType": {
+			"type": "object",
+			"properties": {
+				"category": {
+					"type": "string"
+				},
+				"subcategory": {
+					"type": "string"
+				},
+				"subcategory_object": {
+					"type": "string"
+				},
+				"container_type": {
+					"type": "string",
+					"enum": ["none", "array", "set", "map"]
+				},
+				"value_type": {
+					"$ref": "#/$defs/BlueprintTerminalType"
+				},
+				"is_reference": {
+					"type": "boolean"
+				},
+				"is_weak_pointer": {
+					"type": "boolean"
+				},
+				"member_reference": {
+					"$ref": "#/$defs/BlueprintMemberReference"
+				},
+				"is_const": {
+					"type": "boolean"
+				},
+				"is_uobject_wrapper": {
+					"type": "boolean"
+				},
+				"serialize_as_single_precision_float": {
+					"type": "boolean"
+				}
+			},
+			"required": [
+				"category",
+				"subcategory",
+				"container_type",
+				"is_reference",
+				"is_weak_pointer",
+				"member_reference",
+				"is_const",
+				"is_uobject_wrapper",
+				"serialize_as_single_precision_float"
+			],
+			"additionalProperties": false
+		},
+		"BlueprintPinReference": {
+			"type": "object",
+			"properties": {
+				"node_object_path": {
+					"type": "string"
+				},
+				"pin_id": {
+					"type": "string"
+				}
+			},
+			"required": ["pin_id"],
+			"additionalProperties": false
+		},
+		"BlueprintPin": {
+			"type": "object",
+			"properties": {
+				"id": {
+					"type": "string"
+				},
+				"name": {
+					"type": "string"
+				},
+				"friendly_name": {
+					"$ref": "#/$defs/BlueprintText"
+				},
+				"source_index": {
+					"type": "integer"
+				},
+				"tooltip": {
+					"type": "string"
+				},
+				"direction": {
+					"type": "string",
+					"enum": ["input", "output"]
+				},
+				"pin_type": {
+					"$ref": "#/$defs/BlueprintPinType"
+				},
+				"default_value": {
+					"type": "string"
+				},
+				"autogenerated_default_value": {
+					"type": "string"
+				},
+				"default_object": {
+					"type": "string"
+				},
+				"default_text_value": {
+					"$ref": "#/$defs/BlueprintText"
+				},
+				"linked_to": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintPinReference"
+					}
+				},
+				"sub_pins": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintPinReference"
+					}
+				},
+				"parent_pin": {
+					"$ref": "#/$defs/BlueprintPinReference"
+				},
+				"reference_pass_through_connection": {
+					"$ref": "#/$defs/BlueprintPinReference"
+				},
+				"persistent_guid": {
+					"type": "string"
+				},
+				"flags": {
+					"type": "integer",
+					"allOf": [
+						{
+							"minimum": 0
+						}
+					]
+				}
+			},
+			"required": [
+				"id",
+				"name",
+				"source_index",
+				"tooltip",
+				"direction",
+				"pin_type",
+				"default_value",
+				"autogenerated_default_value",
+				"linked_to",
+				"sub_pins",
+				"flags"
+			],
+			"additionalProperties": false
+		},
+		"BlueprintNode": {
+			"type": "object",
+			"properties": {
+				"object_path": {
+					"type": "string"
+				},
+				"class_path": {
+					"type": "string"
+				},
+				"kind": {
+					"type": "string",
+					"enum": ["event", "function_call", "variable_get", "variable_set", "other"]
+				},
+				"title": {
+					"type": "string"
+				},
+				"position": {
+					"type": "object",
+					"properties": {
+						"x": {
+							"type": "integer"
+						},
+						"y": {
+							"type": "integer"
+						}
+					},
+					"required": ["x", "y"],
+					"additionalProperties": false
+				},
+				"guid": {
+					"type": "string"
+				},
+				"properties": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/SavedProperty1"
+					}
+				},
+				"pins": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintPin"
+					}
+				},
+				"subclass_tail_bytes": {
+					"type": "integer",
+					"allOf": [
+						{
+							"minimum": 0
+						}
+					]
+				}
+			},
+			"required": [
+				"object_path",
+				"class_path",
+				"kind",
+				"title",
+				"position",
+				"properties",
+				"pins",
+				"subclass_tail_bytes"
+			],
+			"additionalProperties": false
+		},
+		"BlueprintLink": {
+			"type": "object",
+			"properties": {
+				"from": {
+					"$ref": "#/$defs/BlueprintPinReference"
+				},
+				"to": {
+					"$ref": "#/$defs/BlueprintPinReference"
+				}
+			},
+			"required": ["from", "to"],
+			"additionalProperties": false
+		},
+		"BlueprintGraph": {
+			"type": "object",
+			"properties": {
+				"object_path": {
+					"type": "string"
+				},
+				"name": {
+					"type": "string"
+				},
+				"guid": {
+					"type": "string"
+				},
+				"nodes": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintNode"
+					}
+				},
+				"links": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintLink"
+					}
+				}
+			},
+			"required": ["object_path", "name", "nodes", "links"],
+			"additionalProperties": false
+		},
+		"BlueprintGraphCoverageGap": {
+			"type": "object",
+			"properties": {
+				"object_path": {
+					"type": "string"
+				},
+				"reason": {
+					"type": "string",
+					"enum": [
+						"missing_node_reference",
+						"null_node_reference",
+						"null_pin",
+						"unresolved_pin_owner",
+						"unresolved_linked_pin",
+						"undecoded_node_property",
+						"native_node_subclass_tail"
+					]
+				},
+				"detail": {
+					"type": "string"
+				}
+			},
+			"required": ["object_path", "reason", "detail"],
+			"additionalProperties": false
+		},
+		"BlueprintGraphProjection": {
+			"type": "object",
+			"properties": {
+				"schema_version": {
+					"type": "number",
+					"enum": [1]
+				},
+				"object_path": {
+					"type": "string"
+				},
+				"graphs": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintGraph"
+					}
+				},
+				"coverage_gaps": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/BlueprintGraphCoverageGap"
+					}
+				}
+			},
+			"required": ["schema_version", "object_path", "graphs", "coverage_gaps"],
+			"additionalProperties": false
+		},
 		"NonNegativeInt": {
 			"type": "integer",
 			"allOf": [
@@ -6426,8 +6808,106 @@
 			"required": ["generation", "items", "projectId"],
 			"additionalProperties": false
 		},
+		"UAssetIoProjectIndexDictionaryHeader": {
+			"type": "object",
+			"properties": {
+				"classes": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/UAssetIoNonNegativeInt"
+					},
+					"allOf": [
+						{
+							"maxItems": 64
+						}
+					]
+				},
+				"kind": {
+					"type": "string",
+					"enum": ["header"]
+				},
+				"packageName": {
+					"$ref": "#/$defs/UAssetIoNonEmptyString"
+				},
+				"packagePath": {
+					"$ref": "#/$defs/UAssetIoNonEmptyString"
+				},
+				"serializedNames": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/UAssetIoNonNegativeInt"
+					},
+					"allOf": [
+						{
+							"maxItems": 64
+						}
+					]
+				}
+			},
+			"required": ["classes", "kind", "packageName", "packagePath", "serializedNames"],
+			"additionalProperties": false
+		},
+		"UAssetIoProjectIndexDictionaryPage": {
+			"type": "object",
+			"properties": {
+				"generation": {
+					"$ref": "#/$defs/UAssetIoPositiveInt"
+				},
+				"items": {
+					"type": "array",
+					"items": {
+						"anyOf": [
+							{
+								"$ref": "#/$defs/UAssetIoProjectIndexMap"
+							},
+							{
+								"$ref": "#/$defs/UAssetIoProjectIndexDictionaryHeader"
+							}
+						]
+					},
+					"allOf": [
+						{
+							"maxItems": 1024
+						}
+					]
+				},
+				"nextCursor": {
+					"$ref": "#/$defs/UAssetIoNonEmptyString"
+				},
+				"projectId": {
+					"$ref": "#/$defs/UAssetIoNonEmptyString"
+				},
+				"strings": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/UAssetIoNonEmptyString"
+					},
+					"allOf": [
+						{
+							"maxItems": 131072
+						}
+					]
+				}
+			},
+			"required": ["generation", "items", "projectId", "strings"],
+			"additionalProperties": false
+		},
 		"UAssetIoResult": {
 			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"kind": {
+							"type": "string",
+							"enum": ["project_index_count"]
+						},
+						"result": {
+							"$ref": "#/$defs/UAssetIoProjectIndexCountResult"
+						}
+					},
+					"required": ["kind", "result"],
+					"additionalProperties": false
+				},
 				{
 					"type": "object",
 					"properties": {
@@ -6442,6 +6922,20 @@
 					"required": ["inspection", "kind"],
 					"additionalProperties": false
 				},
+				{
+					"type": "object",
+					"properties": {
+						"blueprint": {
+							"$ref": "#/$defs/BlueprintGraphProjection"
+						},
+						"kind": {
+							"type": "string",
+							"enum": ["blueprint"]
+						}
+					},
+					"required": ["blueprint", "kind"],
+					"additionalProperties": false
+				},
 				{
 					"type": "object",
 					"properties": {
@@ -6581,6 +7075,20 @@
 					},
 					"required": ["kind", "page"],
 					"additionalProperties": false
+				},
+				{
+					"type": "object",
+					"properties": {
+						"kind": {
+							"type": "string",
+							"enum": ["project_index_dictionary_page"]
+						},
+						"page": {
+							"$ref": "#/$defs/UAssetIoProjectIndexDictionaryPage"
+						}
+					},
+					"required": ["kind", "page"],
+					"additionalProperties": false
 				}
 			]
 		},
@@ -6606,6 +7114,7 @@
 							"type": "string",
 							"enum": [
 								"inspect",
+								"blueprint",
 								"authoring",
 								"scan",
 								"extract_text",
@@ -6614,7 +7123,8 @@
 								"project_index_status",
 								"project_index_refresh",
 								"project_index_rebuild",
-								"project_index_query"
+								"project_index_query",
+								"project_index_count"
 							]
 						}
 					},

package/contracts/uasset-io/v1/fixtures/invalid/project-index-count-empty-filters.json

@@ -0,0 +1,23 @@
+{
+	"contract": {
+		"name": "uasset-io",
+		"version": {
+			"major": 1,
+			"minor": 4
+		}
+	},
+	"limits": {
+		"maximumOutputBytes": 1048576,
+		"timeoutMs": 30000
+	},
+	"operation": {
+		"kind": "project_index_count",
+		"cacheRoot": "C:/Caches/project-index",
+		"request": {
+			"projectId": "fixture-project",
+			"expectedGeneration": 4,
+			"filters": []
+		}
+	},
+	"requestId": "project-index-query-001"
+}

package/contracts/uasset-io/v1/fixtures/invalid/project-index-dictionary-page-negative-index.json

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

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

@@ -0,0 +1,6 @@
+{
+	"contract": { "name": "uasset-io", "version": { "major": 1, "minor": 2 } },
+	"limits": { "maximumOutputBytes": 1048576, "timeoutMs": 30000 },
+	"operation": { "assetPath": "C:/project/Content/BP_Example.uasset", "kind": "blueprint" },
+	"requestId": "blueprint-001"
+}