@ue-shed/protocol 0.1.0-rc.1

package/dist/index.js

@@ -0,0 +1,106 @@
+import { Effect, Schema } from "effect";
+export const IdentifierKind = Schema.Literals([
+    "actor",
+    "capability",
+    "producer",
+    "session",
+    "world"
+]);
+export class IdentifierValidationError extends Schema.TaggedErrorClass()("IdentifierValidationError", {
+    kind: IdentifierKind,
+    input: Schema.String,
+    recovery: Schema.String
+}) {
+}
+const IdentifierString = Schema.Trim.check(Schema.isNonEmpty());
+export const ActorId = IdentifierString.pipe(Schema.brand("ActorId"));
+export const CapabilityId = IdentifierString.pipe(Schema.brand("CapabilityId"));
+export const ProducerId = IdentifierString.pipe(Schema.brand("ProducerId"));
+export const SessionId = IdentifierString.pipe(Schema.brand("SessionId"));
+export const WorldId = IdentifierString.pipe(Schema.brand("WorldId"));
+function identifierError(kind, input) {
+    return new IdentifierValidationError({
+        kind,
+        input,
+        recovery: `Provide a non-empty ${kind} identifier.`
+    });
+}
+function decodeIdentifier(schema, kind, input) {
+    return Schema.decodeUnknownEffect(schema)(input).pipe(Effect.mapError(() => identifierError(kind, typeof input === "string" ? input : String(input))));
+}
+function createIdentifier(schema, kind, input) {
+    try {
+        return Schema.decodeUnknownSync(schema)(input);
+    }
+    catch {
+        throw identifierError(kind, input);
+    }
+}
+export const decodeActorId = (input) => decodeIdentifier(ActorId, "actor", input);
+export const decodeCapabilityId = (input) => decodeIdentifier(CapabilityId, "capability", input);
+export const decodeProducerId = (input) => decodeIdentifier(ProducerId, "producer", input);
+export const decodeSessionId = (input) => decodeIdentifier(SessionId, "session", input);
+export const decodeWorldId = (input) => decodeIdentifier(WorldId, "world", input);
+export function createActorId(input) {
+    return createIdentifier(ActorId, "actor", input);
+}
+export function createCapabilityId(input) {
+    return createIdentifier(CapabilityId, "capability", input);
+}
+export function createProducerId(input) {
+    return createIdentifier(ProducerId, "producer", input);
+}
+export function createSessionId(input) {
+    return createIdentifier(SessionId, "session", input);
+}
+export function createWorldId(input) {
+    return createIdentifier(WorldId, "world", input);
+}
+export const ProtocolVersion = Schema.Struct({
+    major: Schema.Int.check(Schema.isGreaterThanOrEqualTo(0)),
+    minor: Schema.Int.check(Schema.isGreaterThanOrEqualTo(0))
+});
+export const CURRENT_PROTOCOL_VERSION = ProtocolVersion.make({ major: 0, minor: 1 });
+export const TransportKind = Schema.Literals([
+    "remote-control-http",
+    "remote-control-websocket",
+    "named-pipe"
+]);
+export const CapabilityDescriptor = Schema.Struct({
+    id: CapabilityId,
+    version: ProtocolVersion,
+    transports: Schema.Array(TransportKind)
+});
+export const CapabilityManifest = Schema.Struct({
+    producerId: ProducerId,
+    displayName: Schema.String,
+    capabilities: Schema.Array(CapabilityDescriptor)
+});
+export const ConnectionState = Schema.Union([
+    Schema.Struct({ status: Schema.Literal("disconnected") }),
+    Schema.Struct({ status: Schema.Literal("connecting"), endpoint: Schema.String }),
+    Schema.Struct({
+        status: Schema.Literal("connected"),
+        sessionId: SessionId,
+        manifest: CapabilityManifest
+    }),
+    Schema.Struct({
+        status: Schema.Literal("recovering"),
+        sessionId: SessionId,
+        reason: Schema.String
+    }),
+    Schema.Struct({
+        status: Schema.Literal("ended"),
+        sessionId: SessionId,
+        reason: Schema.Literals(["requested", "producer-exited", "transport-lost"])
+    }),
+    Schema.Struct({ status: Schema.Literal("error"), message: Schema.String })
+]);
+export const decodeCapabilityManifest = Schema.decodeUnknownEffect(CapabilityManifest);
+export const decodeConnectionState = Schema.decodeUnknownEffect(ConnectionState);
+export * from "./authoring.js";
+export * from "./authoring-review.js";
+export * from "./companion.js";
+export * from "./cameras.js";
+export * from "./editor-play-session.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAExC,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC7C,OAAO;IACP,YAAY;IACZ,UAAU;IACV,SAAS;IACT,OAAO;CACP,CAAC,CAAC;AAGH,MAAM,OAAO,yBAA0B,SAAQ,MAAM,CAAC,gBAAgB,EAA6B,CAClG,2BAA2B,EAC3B;IACC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,MAAM,CAAC,MAAM;IACpB,QAAQ,EAAE,MAAM,CAAC,MAAM;CACvB,CACD;CAAG;AAEJ,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AAGtE,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;AAGhF,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;AAG5E,MAAM,CAAC,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AAGtE,SAAS,eAAe,CAAC,IAAoB,EAAE,KAAa;IAC3D,OAAO,IAAI,yBAAyB,CAAC;QACpC,IAAI;QACJ,KAAK;QACL,QAAQ,EAAE,uBAAuB,IAAI,cAAc;KACnD,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACxB,MAAS,EACT,IAAoB,EACpB,KAAc;IAEd,OAAO,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CACpD,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CACpB,eAAe,CAAC,IAAI,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CACxE,CACD,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CACxB,MAAS,EACT,IAAoB,EACpB,KAAa;IAEb,IAAI,CAAC;QACJ,OAAO,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAAC,MAAM,CAAC;QACR,MAAM,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;AACF,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAC3F,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAE,EAAE,CACpD,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;AACrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;AACpG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AACjG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAE3F,MAAM,UAAU,aAAa,CAAC,KAAa;IAC1C,OAAO,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC/C,OAAO,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC7C,OAAO,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAa;IAC5C,OAAO,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAa;IAC1C,OAAO,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5C,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACzD,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;AAErF,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC5C,qBAAqB;IACrB,0BAA0B;IAC1B,YAAY;CACZ,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,YAAY;IAChB,OAAO,EAAE,eAAe;IACxB,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,UAAU;IACtB,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC;CAChD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC;IAC3C,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;IACzD,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IAChF,MAAM,CAAC,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;QACnC,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,kBAAkB;KAC5B,CAAC;IACF,MAAM,CAAC,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QACpC,SAAS,EAAE,SAAS;QACpB,MAAM,EAAE,MAAM,CAAC,MAAM;KACrB,CAAC;IACF,MAAM,CAAC,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;QAC/B,SAAS,EAAE,SAAS;QACpB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;KAC3E,CAAC;IACF,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;CAC1E,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;AAEjF,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ue-shed/protocol",
+  "version": "0.1.0-rc.1",
+  "description": "Runtime schemas and versioned wire contracts for UE Shed integrations.",
+  "homepage": "https://github.com/ue-shed/ue-shed#readme",
+  "bugs": {
+    "url": "https://github.com/ue-shed/ue-shed/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ue-shed/ue-shed.git",
+    "directory": "packages/protocol"
+  },
+  "files": [
+    "dist",
+    "contracts",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "effect": "4.0.0-beta.98"
+  },
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "contract:check": "tsx scripts/check-authoring-contract.ts",
+    "typecheck": "tsc --noEmit"
+  }
+}