@hyprune/schema 0.6.0 → 0.7.0

package/examples/object-seat.json

@@ -0,0 +1,59 @@
+{
+  "formatVersion": "0.9",
+  "id": "bench",
+  "version": "1.0.0",
+  "name": "Bench",
+  "category": "furniture",
+  "scene": "object.glb",
+  "license": "CC0-1.0",
+  "attribution": [
+    {
+      "path": ".",
+      "author": "Example Author",
+      "license": "CC0-1.0"
+    }
+  ],
+  "bounds": {
+    "min": [
+      -0.8,
+      0,
+      -0.25
+    ],
+    "max": [
+      0.8,
+      0.85,
+      0.25
+    ]
+  },
+  "traits": {
+    "collidable": {
+      "node": "proxy"
+    },
+    "movable": {},
+    "seat": {
+      "capacity": 2,
+      "anchors": [
+        {
+          "id": "left",
+          "position": [
+            -0.4,
+            0,
+            0.55
+          ],
+          "yaw": 0,
+          "height": 0.45
+        },
+        {
+          "id": "right",
+          "position": [
+            0.4,
+            0,
+            0.55
+          ],
+          "yaw": 0,
+          "height": 0.45
+        }
+      ]
+    }
+  }
+}

package/examples/object.json

@@ -0,0 +1,148 @@
+{
+  "formatVersion": "0.9",
+  "id": "street-lantern",
+  "version": "1.0.0",
+  "name": "Street lantern",
+  "description": "A post lantern with a softly bobbing flame and a bench seat at its foot.",
+  "category": "lighting",
+  "tags": [
+    "lamp",
+    "street"
+  ],
+  "scene": "object.glb",
+  "license": "CC-BY-4.0",
+  "attribution": [
+    {
+      "path": ".",
+      "author": "Example Author",
+      "license": "CC-BY-4.0",
+      "source": "https://example.com/street-lantern"
+    }
+  ],
+  "bounds": {
+    "min": [
+      -0.25,
+      0,
+      -0.25
+    ],
+    "max": [
+      0.25,
+      2.4,
+      0.25
+    ]
+  },
+  "thumbnail": "thumbnail.png",
+  "lighting": {
+    "mode": "probe"
+  },
+  "traits": {
+    "decorative": {
+      "animations": [
+        {
+          "node": "flame",
+          "type": "bob",
+          "axis": [
+            0,
+            1,
+            0
+          ],
+          "amplitude": 0.01,
+          "period": 3
+        }
+      ]
+    },
+    "collidable": {
+      "node": "proxy"
+    },
+    "movable": {
+      "surfaces": [
+        "floor"
+      ],
+      "upright": true,
+      "scale": [
+        0.75,
+        1.5
+      ]
+    }
+  },
+  "slots": {
+    "states": [
+      {
+        "id": "status",
+        "materials": [
+          "lamp-glass"
+        ],
+        "palette": [
+          {
+            "id": "idle",
+            "colour": [
+              0.3,
+              0.5,
+              1.0
+            ],
+            "emission": 1
+          },
+          {
+            "id": "busy",
+            "colour": [
+              1.0,
+              0.7,
+              0.2
+            ],
+            "emission": 2
+          },
+          {
+            "id": "fault",
+            "colour": [
+              1.0,
+              0.2,
+              0.2
+            ],
+            "emission": 3
+          }
+        ]
+      }
+    ],
+    "labels": [
+      {
+        "id": "title",
+        "pose": {
+          "position": [
+            0,
+            1.9,
+            0.26
+          ],
+          "rotation": [
+            0,
+            0,
+            0,
+            1
+          ]
+        },
+        "size": [
+          0.6,
+          0.15
+        ],
+        "maxChars": 24
+      }
+    ],
+    "effects": [
+      {
+        "id": "vent",
+        "pose": {
+          "position": [
+            0,
+            2.3,
+            0
+          ],
+          "rotation": [
+            0,
+            0,
+            0,
+            1
+          ]
+        }
+      }
+    ]
+  }
+}

package/lib/validate.d.mts

@@ -1,12 +1,16 @@
 // 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 type ContractKind = 'world' | 'extension' | 'screen-type' | 'ipc' | 'scene' | 'object' | 'library' | 'library-releases';
 
 export interface ValidationResult {
   valid: boolean;
   /** JSON-pointer-prefixed messages; empty when valid. */
   errors: string[];
+  /** Kinds object, library and library-releases: advisory messages (never make a document invalid). */
+  warnings?: string[];
+  /** Kind object with a glTF: triangles drawn by the scene. */
+  triangles?: number;
 }
 
 export interface ValidateOptions {
@@ -18,6 +22,18 @@ export interface ValidateOptions {
    * names, nesting) instead of the world's scene.gltf.
    */
   asset?: string;
+  /** Kind object: the parsed scene glTF (or a GLB's JSON chunk) for node, material, variant, clip, budget and bounds checks. */
+  gltf?: unknown;
+  /** Kind object: the directory name, which must equal the object id. */
+  directory?: string;
+  /** Kind object: every file of the object directory (attribution coverage and limits); kind library: every file of the library. */
+  files?: ReadonlyArray<{ path: string; size: number }>;
+  /** Kind object: the thumbnail PNG's size. */
+  thumbnail?: { width: number; height: number; bytes: number };
+  /** Kind object: values that need decoded geometry or images. */
+  measured?: { bounds?: { min: number[]; max: number[] }; maxTextureSize?: number; gpuBytes?: number };
+  /** Kind library: each listed object's parsed object.json, keyed by directory name. */
+  objects?: Record<string, { id?: string; formatVersion?: string }>;
 }
 
 /**
@@ -25,7 +41,8 @@ export interface ValidateOptions {
  * @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')
+ * @param version  world format or IPC version, e.g. '0.7' or '0.19' (default '0.1'); for objects and
+ *                 libraries the object format (default: the document's formatVersion)
  * @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;
@@ -39,5 +56,9 @@ export const worldFormats: readonly string[];
 export const ipcProtocols: readonly string[];
 /** Every contract version directory, oldest first. */
 export const contractVersions: readonly string[];
+/** Object manifest formats with a published schema (RFC-0011; world format numbering from 0.9). */
+export const objectFormats: readonly string[];
+/** RFC-0011 directory, asset and library limits the object and library checks apply. */
+export const objectLimits: Readonly<Record<string, number>>;
 /** glTF extensions a scene may list in extensionsRequired for a world format. */
 export function sceneExtensions(version: string): string[];