@hyprune/schema 0.0.0-stage → 0.5.0

package/examples/ipc/state.subscribe.response.json

@@ -0,0 +1,38 @@
+{
+  "jsonrpc": "2.0",
+  "id": "3",
+  "result": {
+    "subscriptionId": "sub-1",
+    "snapshot": {
+      "sessionId": "session-1",
+      "revision": 0,
+      "state": {
+        "runtime": {
+          "active": false,
+          "outputs": [
+            "output-1"
+          ]
+        },
+        "world": null,
+        "surfaces": [],
+        "movement": {
+          "modeId": "com.hyprune.fly",
+          "position": [
+            0,
+            1,
+            0
+          ],
+          "orientation": [
+            0,
+            0,
+            0,
+            1
+          ]
+        },
+        "shell": {
+          "leases": []
+        }
+      }
+    }
+  }
+}

package/examples/ipc/state.unsubscribe.request.json

@@ -0,0 +1,8 @@
+{
+  "jsonrpc": "2.0",
+  "id": "5",
+  "method": "state.unsubscribe",
+  "params": {
+    "subscriptionId": "sub-1"
+  }
+}

package/examples/ipc/state.unsubscribe.response.json

@@ -0,0 +1,7 @@
+{
+  "jsonrpc": "2.0",
+  "id": "5",
+  "result": {
+    "ok": true
+  }
+}

package/examples/ipc/surface.focus.request.json

@@ -0,0 +1,9 @@
+{
+  "jsonrpc": "2.0",
+  "id": "7",
+  "method": "surface.focus",
+  "params": {
+    "surfaceId": "surface-1",
+    "intent": "pointer"
+  }
+}

package/examples/ipc/surface.focus.response.json

@@ -0,0 +1,7 @@
+{
+  "jsonrpc": "2.0",
+  "id": "7",
+  "result": {
+    "revision": 1
+  }
+}

package/examples/ipc/world.load.request.json

@@ -0,0 +1,9 @@
+{
+  "jsonrpc": "2.0",
+  "id": "6",
+  "method": "world.load",
+  "params": {
+    "worldId": "com.hyprune.observatory",
+    "spawnId": "arrival"
+  }
+}

package/examples/ipc/world.load.response.json

@@ -0,0 +1,7 @@
+{
+  "jsonrpc": "2.0",
+  "id": "6",
+  "result": {
+    "revision": 1
+  }
+}

package/examples/placement-input.json

@@ -0,0 +1,169 @@
+{
+  "version": 2,
+  "longHoldMs": 1000,
+  "scopeVignette": true,
+  "invert_y": false,
+  "useDistance": 6,
+  "useTolerance": 0.12,
+  "captureInputLimit": 256,
+  "modes": {
+    "world": {
+      "look": [
+        "MouseMove"
+      ],
+      "forward": [
+        "k",
+        "w",
+        "Up"
+      ],
+      "back": [
+        "j",
+        "s",
+        "Down"
+      ],
+      "left": [
+        "h",
+        "a",
+        "Left"
+      ],
+      "right": [
+        "l",
+        "d",
+        "Right"
+      ],
+      "menu": [
+        "Tab[L]"
+      ],
+      "sprint": [
+        "Shift_L"
+      ],
+      "up": [
+        "space"
+      ],
+      "down": [
+        "Control_L"
+      ],
+      "use": [
+        "e"
+      ],
+      "focus": [
+        "f"
+      ],
+      "noclip": [
+        "v"
+      ],
+      "scope": [
+        "q"
+      ],
+      "debug": [
+        "F3",
+        "y"
+      ],
+      "capture": [
+        "u"
+      ],
+      "carry": [
+        "Super+LMB"
+      ],
+      "resize": [
+        "Super+RMB"
+      ],
+      "distance": [
+        "Super+Wheel"
+      ],
+      "rotate": [
+        "Super+Ctrl+Wheel"
+      ],
+      "tool1": [
+        "1"
+      ],
+      "tool2": [
+        "2"
+      ],
+      "tool3": [
+        "3"
+      ],
+      "tool4": [
+        "4"
+      ],
+      "hud.cycle": [],
+      "transport": [
+        "z"
+      ],
+      "autopilot": [
+        "x"
+      ],
+      "primary": [
+        "LMB"
+      ],
+      "secondary": [
+        "RMB"
+      ],
+      "fly": [
+        "F4"
+      ],
+      "record.toggle": [],
+      "exit": [
+        "Super+Tab",
+        "Back"
+      ],
+      "tool5": [
+        "5"
+      ],
+      "content.scale": [
+        "Super+Shift+Wheel"
+      ],
+      "window.reset": [
+        "Super+Shift+MMB"
+      ],
+      "carry.facing": [
+        "r"
+      ],
+      "alternate": [
+        "MMB"
+      ],
+      "cycle": [
+        "Wheel"
+      ]
+    },
+    "interactive": {
+      "exit": [
+        "Super+Tab",
+        "Back"
+      ],
+      "debug": [
+        "F3"
+      ],
+      "capture": [
+        "Super+u"
+      ],
+      "record.toggle": []
+    },
+    "focus": {
+      "exit": [
+        "Super+Tab",
+        "Back"
+      ],
+      "debug": [
+        "F3"
+      ],
+      "capture": [
+        "Super+u"
+      ],
+      "record.toggle": []
+    },
+    "menu": {
+      "exit": [
+        "Escape"
+      ],
+      "debug": [
+        "F3"
+      ],
+      "capture": [
+        "Super+u"
+      ],
+      "record.toggle": []
+    }
+  },
+  "show_area_markers": false
+}

package/examples/screen-type.json

@@ -0,0 +1,24 @@
+{
+  "descriptorVersion": "0.1",
+  "id": "com.hyprune.window",
+  "name": "Application window",
+  "provider": "com.hyprune.core",
+  "source": "window",
+  "geometry": "plane",
+  "defaultSize": [
+    1.6,
+    0.9
+  ],
+  "resolution": {
+    "width": 1920,
+    "height": 1080
+  },
+  "input": {
+    "pointer": true,
+    "keyboard": true,
+    "touch": false
+  },
+  "alphaMode": "blend",
+  "colorSpace": "srgb",
+  "maxFps": 60
+}

package/examples/world.json

@@ -0,0 +1,111 @@
+{
+  "formatVersion": "0.1",
+  "id": "com.hyprune.observatory",
+  "version": "0.1.0",
+  "name": "Observatory",
+  "license": "CC-BY-4.0",
+  "scene": "scene.gltf",
+  "defaultSpawn": "arrival",
+  "spawns": [
+    {
+      "id": "arrival",
+      "pose": {
+        "position": [
+          0,
+          1,
+          0
+        ],
+        "rotation": [
+          0,
+          0,
+          0,
+          1
+        ]
+      }
+    }
+  ],
+  "attribution": [
+    {
+      "path": ".",
+      "author": "Hyprune contributors",
+      "license": "CC-BY-4.0"
+    }
+  ],
+  "zones": [
+    {
+      "id": "work",
+      "name": "Work",
+      "bounds": {
+        "min": [
+          -4,
+          0,
+          -4
+        ],
+        "max": [
+          4,
+          4,
+          4
+        ]
+      }
+    }
+  ],
+  "anchors": [
+    {
+      "id": "desk",
+      "pose": {
+        "position": [
+          0,
+          1.4,
+          -3
+        ],
+        "rotation": [
+          0,
+          0,
+          0,
+          1
+        ]
+      },
+      "size": [
+        1.6,
+        0.9
+      ],
+      "screenType": "com.hyprune.window"
+    }
+  ],
+  "collision": [
+    {
+      "node": 0,
+      "shape": "mesh",
+      "layer": "static"
+    }
+  ],
+  "navigation": {
+    "kind": "mesh",
+    "node": 1,
+    "agentRadius": 0.3,
+    "agentHeight": 1.8
+  },
+  "lightmaps": [
+    {
+      "material": 0,
+      "texture": 1,
+      "texCoord": 1,
+      "encoding": "linear",
+      "intensity": 1
+    }
+  ],
+  "audio": [
+    {
+      "id": "air",
+      "path": "audio/air.ogg",
+      "position": [
+        0,
+        2,
+        0
+      ],
+      "radius": 10,
+      "gain": 0.2,
+      "loop": true
+    }
+  ]
+}

package/extensions/hud-style-manifest.schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://hyprune.com/schema/extensions/hud-style-manifest.schema.json",
+  "title": "Proposed com.hyprune.hud-style manifest value",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "theme"
+  ],
+  "properties": {
+    "theme": {
+      "type": "string",
+      "maxLength": 200,
+      "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.json$"
+    }
+  }
+}

package/extensions/hud-style.schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://hyprune.com/schema/extensions/hud-style.schema.json",
+  "title": "Proposed world HUD style 1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "colors": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "accent": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        },
+        "foreground": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        },
+        "muted": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        },
+        "tile": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        },
+        "outline": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        },
+        "scrim": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        }
+      }
+    },
+    "stroke": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "width": {
+          "type": "number",
+          "minimum": 1,
+          "maximum": 3
+        },
+        "style": {
+          "enum": [
+            "outline",
+            "shadow"
+          ]
+        }
+      }
+    },
+    "corners": {
+      "enum": [
+        "square",
+        "bevel",
+        "round"
+      ]
+    },
+    "font": {
+      "type": "string",
+      "maxLength": 200,
+      "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.(ttf|otf)$"
+    },
+    "icons": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "navigate": {
+          "type": "string",
+          "maxLength": 200,
+          "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
+        },
+        "window": {
+          "type": "string",
+          "maxLength": 200,
+          "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
+        },
+        "path": {
+          "type": "string",
+          "maxLength": 200,
+          "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
+        },
+        "position": {
+          "type": "string",
+          "maxLength": 200,
+          "pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
+        }
+      }
+    },
+    "warp": {
+      "enum": [
+        "default",
+        "ribbons",
+        "soft"
+      ]
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z0-9][a-z0-9.-]*$"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    }
+  }
+}

package/lib/validate.d.mts

@@ -0,0 +1,37 @@
+// Type declarations for lib/validate.mjs.
+
+/** Schema kinds `validate` accepts; `scene` checks a scene.gltf against its world format. */
+export type ContractKind = 'world' | 'extension' | 'screen-type' | 'ipc' | 'scene';
+
+export interface ValidationResult {
+  valid: boolean;
+  /** JSON-pointer-prefixed messages; empty when valid. */
+  errors: string[];
+}
+
+export interface ValidateOptions {
+  /** For kind `scene`: the package's parsed world.json (lightmap checks). */
+  world?: unknown;
+}
+
+/**
+ * Validate one parsed JSON document against a published contract version.
+ * @param kind     contract kind
+ * @param value    parsed document (world.json, extension.json, an IPC frame, scene.gltf)
+ * @param method   IPC only: the outstanding request's method, to validate a response's result
+ * @param version  world format or IPC version, e.g. '0.7' or '0.19' (default '0.1')
+ * @throws on an unknown kind, version or method (usage errors, not validation failures)
+ */
+export function validate(kind: ContractKind, value: unknown, method?: string, version?: string, options?: ValidateOptions): ValidationResult;
+
+/** True when dotted version `version` is at least `minimum` (numeric comparison). */
+export function atLeast(version: string, minimum: string): boolean;
+
+/** World formats with a published schema, oldest first. */
+export const worldFormats: readonly string[];
+/** IPC protocol versions with a published schema, oldest first. */
+export const ipcProtocols: readonly string[];
+/** Every contract version directory, oldest first. */
+export const contractVersions: readonly string[];
+/** glTF extensions a scene may list in extensionsRequired for a world format. */
+export function sceneExtensions(version: string): string[];