@opensoha/contracts 0.1.6 → 0.1.8

package/openapi/spec_generated.go

@@ -5,9 +5,9 @@ package openapi
 import _ "embed"
 
 const (
-	Version    = "0.1.6"
-	YAMLSHA256 = "b6388f34cd559f508a70ccdfdc3a01bb33b62c1b5c4631ec8339770a9b1c338a"
-	JSONSHA256 = "bff1d46d3f3a083c7a2de06c916b2dc42e5699eeaf4fed2c3e560bf345427985"
+	Version    = "0.1.8"
+	YAMLSHA256 = "67feba4d2b47ae3982a9feb7a2286be4c856e0d29d63f445be165335acf364ef"
+	JSONSHA256 = "dd0200945f41e4d87553ef88fdeb14577b219367768a43487ac3c23f5380eabb"
 )
 
 //go:embed soha-api.yaml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensoha/contracts",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "private": false,
   "description": "Shared OpenSoha API, agent, MCP, skill, event, and auth contracts.",
   "license": "Apache-2.0",
@@ -53,6 +53,8 @@
     "./mcp/gateway-capability-baseline.schema.json": "./mcp/gateway-capability-baseline.schema.json",
     "./skills/skill-manifest.schema.json": "./skills/skill-manifest.schema.json",
     "./plugins/plugin-manifest.schema.json": "./plugins/plugin-manifest.schema.json",
+    "./plugins/companion-pack.schema.json": "./plugins/companion-pack.schema.json",
+    "./plugins/companion-provenance.schema.json": "./plugins/companion-provenance.schema.json",
     "./plugins/marketplace-catalog.schema.json": "./plugins/marketplace-catalog.schema.json",
     "./events/event-envelope.schema.json": "./events/event-envelope.schema.json",
     "./auth/token-claims.schema.json": "./auth/token-claims.schema.json",

package/plugins/companion-pack.schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://contracts.opensoha.dev/plugins/companion-pack.schema.json",
+  "title": "OpenSoha Companion Pack",
+  "type": "object",
+  "required": ["renderer", "entryAsset", "assets", "license"],
+  "properties": {
+    "renderer": {
+      "type": "string",
+      "enum": ["svg", "sprite", "live2d-cubism"]
+    },
+    "entryAsset": { "$ref": "#/$defs/safePath" },
+    "thumbnailAsset": { "$ref": "#/$defs/safePath" },
+    "modelFormatVersion": { "type": "string", "minLength": 1 },
+    "assets": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 512,
+      "items": { "$ref": "#/$defs/asset" }
+    },
+    "animations": { "$ref": "#/$defs/animations" },
+    "interactions": {
+      "type": "array",
+      "maxItems": 64,
+      "items": { "$ref": "#/$defs/interaction" }
+    },
+    "unlocks": {
+      "type": "array",
+      "maxItems": 128,
+      "items": { "$ref": "#/$defs/unlock" }
+    },
+    "license": { "$ref": "#/$defs/license" }
+  },
+  "$defs": {
+    "safePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$))(?!.*\\\\)[A-Za-z0-9._/-]+$"
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "asset": {
+      "type": "object",
+      "required": ["path", "kind", "contentType", "sizeBytes", "sha256"],
+      "properties": {
+        "path": { "$ref": "#/$defs/safePath" },
+        "kind": {
+          "type": "string",
+          "enum": ["entry", "model", "texture", "motion", "expression", "physics", "pose", "thumbnail", "audio"]
+        },
+        "contentType": {
+          "type": "string",
+          "enum": ["application/json", "application/octet-stream", "image/png", "image/jpeg", "image/webp", "image/svg+xml", "audio/mpeg", "audio/ogg"]
+        },
+        "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 67108864 },
+        "sha256": { "$ref": "#/$defs/sha256" }
+      },
+      "additionalProperties": false
+    },
+    "animations": {
+      "type": "object",
+      "properties": {
+        "idle": { "type": "string", "minLength": 1 },
+        "listening": { "type": "string", "minLength": 1 },
+        "thinking": { "type": "string", "minLength": 1 },
+        "speaking": { "type": "string", "minLength": 1 },
+        "error": { "type": "string", "minLength": 1 },
+        "dragging": { "type": "string", "minLength": 1 },
+        "hover": { "type": "string", "minLength": 1 },
+        "tap": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "interaction": {
+      "type": "object",
+      "required": ["id", "action"],
+      "properties": {
+        "id": { "type": "string", "pattern": "^[a-z][a-z0-9._-]*$" },
+        "label": { "type": "string", "minLength": 1, "maxLength": 64 },
+        "action": { "type": "string", "enum": ["tap", "pet", "feed", "play", "greet"] },
+        "animation": { "type": "string", "minLength": 1 },
+        "cooldownSeconds": { "type": "integer", "minimum": 0, "maximum": 86400 },
+        "rewardXp": { "type": "integer", "minimum": 0, "maximum": 1000 },
+        "rewardAffinity": { "type": "integer", "minimum": 0, "maximum": 100 }
+      },
+      "additionalProperties": false
+    },
+    "unlock": {
+      "type": "object",
+      "required": ["id", "kind", "level", "ref"],
+      "properties": {
+        "id": { "type": "string", "pattern": "^[a-z][a-z0-9._-]*$" },
+        "kind": { "type": "string", "enum": ["interaction", "animation", "expression", "asset"] },
+        "level": { "type": "integer", "minimum": 1, "maximum": 100 },
+        "ref": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "license": {
+      "type": "object",
+      "required": ["name", "url", "redistributionAllowed", "commercialUseAllowed"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "spdxId": { "type": "string", "minLength": 1 },
+        "url": { "type": "string", "format": "uri" },
+        "sourceUrl": { "type": "string", "format": "uri" },
+        "attribution": { "type": "string", "maxLength": 2048 },
+        "redistributionAllowed": { "const": true },
+        "commercialUseAllowed": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/plugins/companion-provenance.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://contracts.opensoha.dev/plugins/companion-provenance.schema.json",
+  "title": "OpenSoha Companion Provenance Statement",
+  "description": "The Ed25519 signature covers UTF-8 lines subjectSha256, builderId, sourceUri, sourceCommit, and builtAt in that order, joined with LF and without a trailing LF.",
+  "type": "object",
+  "required": ["subjectSha256", "builderId", "sourceUri", "sourceCommit", "builtAt", "signingKeyId", "signatureAlgorithm", "signature"],
+  "properties": {
+    "subjectSha256": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
+    "builderId": { "type": "string", "minLength": 1, "maxLength": 512 },
+    "sourceUri": { "type": "string", "format": "uri" },
+    "sourceCommit": { "type": "string", "pattern": "^[A-Fa-f0-9]{7,64}$" },
+    "builtAt": { "type": "string", "format": "date-time" },
+    "signingKeyId": { "type": "string", "pattern": "^[a-z][a-z0-9._-]*$" },
+    "signatureAlgorithm": { "const": "ed25519" },
+    "signature": { "type": "string", "minLength": 1 }
+  },
+  "additionalProperties": false
+}

package/plugins/marketplace-catalog.schema.json

@@ -87,6 +87,7 @@
         "packageUrl": { "type": "string" },
         "checksum": { "type": "string" },
         "signature": { "type": "string" },
+        "package": { "$ref": "#/$defs/package" },
         "publishedAt": { "type": "string", "format": "date-time" },
         "deprecated": { "type": "boolean" },
         "suspended": { "type": "boolean" },
@@ -98,6 +99,25 @@
       },
       "additionalProperties": false
     },
+    "package": {
+      "type": "object",
+      "required": ["url", "contentType", "sizeBytes", "sha256"],
+      "properties": {
+        "url": { "type": "string", "format": "uri" },
+        "contentType": {
+          "type": "string",
+          "enum": ["application/zip", "application/gzip", "application/x-tar"]
+        },
+        "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 268435456 },
+        "sha256": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
+        "signature": { "type": "string", "minLength": 1 },
+        "signatureAlgorithm": { "type": "string", "enum": ["ed25519"] },
+        "signingKeyId": { "type": "string", "pattern": "^[a-z][a-z0-9._-]*$" },
+        "provenanceUrl": { "type": "string", "format": "uri" },
+        "sbomUrl": { "type": "string", "format": "uri" }
+      },
+      "additionalProperties": false
+    },
     "advisory": {
       "type": "object",
       "required": ["id", "severity", "summary"],

package/plugins/plugin-manifest.schema.json

@@ -28,7 +28,8 @@
         "metric-extension",
         "notification-channel",
         "identity-template",
-        "ui-extension"
+        "ui-extension",
+        "companion-pack"
       ]
     },
     "description": { "type": "string" },
@@ -123,6 +124,9 @@
       },
       "additionalProperties": false
     },
+    "companionPack": {
+      "$ref": "https://contracts.opensoha.dev/plugins/companion-pack.schema.json"
+    },
     "configSchema": { "$ref": "#/$defs/jsonSchema" },
     "extensionPoints": { "$ref": "#/$defs/extensionPoints" },
     "metadata": {
@@ -131,6 +135,20 @@
     }
   },
   "allOf": [
+    {
+      "if": {
+        "properties": { "type": { "const": "companion-pack" } },
+        "required": ["type"]
+      },
+      "then": {
+        "required": ["companionPack"],
+        "properties": {
+          "runtime": {
+            "properties": { "mode": { "const": "manifest-only" } }
+          }
+        }
+      }
+    },
     {
       "if": {
         "anyOf": [