@ue-shed/protocol 0.1.0-rc.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 UE Shed contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# `@ue-shed/protocol`
+
+Runtime schemas, branded identifiers, compatibility values, and versioned wire contracts shared by
+UE Shed clients and Unreal companion plugins.
+
+```sh
+npm install @ue-shed/protocol@0.1.0-rc.1 effect@4.0.0-beta.98
+```
+
+The package supports Node.js 22.14 or newer and exposes one stable JavaScript entry point:
+
+```ts
+import {
+	CURRENT_PROTOCOL_VERSION,
+	CapabilityManifest,
+	decodeCapabilityManifest
+} from "@ue-shed/protocol";
+```
+
+The root entry point includes the core capability and connection schemas plus the authoring, camera,
+companion, and editor play-session contracts. Internal source modules are not public subpaths.
+
+The `contracts/` directory in the package contains the language-neutral JSON Schema authorities and
+conformance fixtures. These files are shipped for protocol implementors, but JavaScript consumers
+should use the runtime schemas exported from the package root.
+
+The current core protocol version is `0.1`. Individual domain contracts carry their own versions;
+consumers must validate untrusted wire input instead of casting it to an exported TypeScript type.
+
+This package does not connect to Unreal Engine, launch processes, or depend on the UE Shed Workbench.
+
+## License
+
+MIT. Unreal Engine is a trademark of Epic Games, Inc. This project is not affiliated with or
+endorsed by Epic Games.

package/contracts/asset-audits/v1/texture-preview.schema.json

@@ -0,0 +1,74 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/asset-audits/v1/texture-preview.schema.json",
+	"title": "UE Shed texture preview result",
+	"oneOf": [
+		{
+			"type": "object",
+			"required": [
+				"contract",
+				"status",
+				"authority",
+				"objectPath",
+				"mimeType",
+				"width",
+				"height",
+				"dataBase64"
+			],
+			"properties": {
+				"contract": { "$ref": "#/$defs/contract" },
+				"status": { "const": "available" },
+				"authority": { "const": "live_editor" },
+				"objectPath": { "type": "string", "minLength": 1 },
+				"mimeType": { "const": "image/png" },
+				"width": { "type": "integer", "minimum": 1, "maximum": 512 },
+				"height": { "type": "integer", "minimum": 1, "maximum": 512 },
+				"dataBase64": { "type": "string", "maxLength": 5592408 }
+			},
+			"additionalProperties": false
+		},
+		{
+			"type": "object",
+			"required": ["contract", "status", "objectPath", "reason", "message", "retrySafe"],
+			"properties": {
+				"contract": { "$ref": "#/$defs/contract" },
+				"status": { "const": "unavailable" },
+				"objectPath": { "type": "string" },
+				"reason": {
+					"enum": [
+						"invalid_request",
+						"texture_not_found",
+						"source_unavailable",
+						"source_too_large",
+						"decode_failed",
+						"encode_failed",
+						"preview_too_large",
+						"editor_data_unavailable"
+					]
+				},
+				"message": { "type": "string", "minLength": 1 },
+				"retrySafe": { "type": "boolean" }
+			},
+			"additionalProperties": false
+		}
+	],
+	"$defs": {
+		"contract": {
+			"type": "object",
+			"required": ["name", "version"],
+			"properties": {
+				"name": { "const": "texture-preview" },
+				"version": {
+					"type": "object",
+					"required": ["major", "minor"],
+					"properties": {
+						"major": { "const": 1 },
+						"minor": { "const": 0 }
+					},
+					"additionalProperties": false
+				}
+			},
+			"additionalProperties": false
+		}
+	}
+}

package/contracts/authoring/README.md

@@ -0,0 +1,25 @@
+# Authoring wire contracts
+
+The checked-in JSON Schemas in this directory are the language-neutral authority for authoring wire
+data. TypeScript Effect schemas, the Rust saved-package producer, and the Unreal C++ companion must
+remain conformant with them.
+
+`v1` remains the mutation contract used by Apply and Save. `v2/table-snapshot.schema.json` adds field
+schema, producer, package, and fingerprint evidence without changing the mutation envelope. Apply
+results allow either versioned snapshot during migration.
+
+Snapshot 2.1 and mutation 1.1 add the normalized `row_reference` value for
+`FDataTableRowHandle`. It carries the table object path and row name explicitly; generic structs
+remain structurally encoded.
+
+`v1/table-list.schema.json` is the deliberately narrow live discovery boundary. It lists canonical
+object paths; callers retrieve v2 snapshots for descriptor evidence and isolate per-table failures.
+
+Change a wire shape in this order:
+
+1. Edit the authoritative JSON Schema and add or update language-neutral conformance fixtures.
+2. Update the Effect runtime schema until `pnpm --filter @ue-shed/protocol contract:check` passes.
+3. Update Rust and C++ producers and run their fixture conformance gates.
+4. Switch consumers only after both producers pass.
+
+Do not generate these files from TypeScript. That would reverse the authority established by ADR 0002.