@hyprune/schema 0.5.2 → 0.7.0

package/examples/object-machine.json

@@ -0,0 +1,338 @@
+{
+  "formatVersion": "0.10",
+  "id": "conveyor",
+  "version": "1.0.0",
+  "name": "Conveyor",
+  "category": "machines",
+  "tags": [
+    "ci",
+    "pipeline"
+  ],
+  "scene": "object.glb",
+  "license": "CC-BY-4.0",
+  "attribution": [
+    {
+      "path": ".",
+      "author": "Example Author",
+      "license": "CC-BY-4.0"
+    }
+  ],
+  "bounds": {
+    "min": [
+      -2.2,
+      0,
+      -0.8
+    ],
+    "max": [
+      2.2,
+      1.9,
+      0.8
+    ]
+  },
+  "traits": {
+    "decorative": {
+      "animations": [
+        {
+          "node": "belt-rollers",
+          "type": "spin",
+          "axis": [
+            1,
+            0,
+            0
+          ],
+          "pivot": [
+            0,
+            0.6,
+            0
+          ],
+          "period": 1.2
+        }
+      ]
+    },
+    "collidable": {
+      "node": "proxy"
+    },
+    "movable": {
+      "surfaces": [
+        "floor"
+      ]
+    },
+    "machine": {
+      "primary": "status",
+      "inputs": [
+        {
+          "id": "status",
+          "type": "enum",
+          "values": [
+            "idle",
+            "running",
+            "ok",
+            "fail"
+          ],
+          "default": "idle",
+          "label": "Pipeline status",
+          "explain": "Lamp colour and belt motion: the belt runs while the pipeline runs."
+        },
+        {
+          "id": "jobStarted",
+          "type": "event",
+          "label": "Job started",
+          "explain": "Each started job drops a crate onto the belt."
+        },
+        {
+          "id": "queued",
+          "type": "int",
+          "min": 0,
+          "max": 64,
+          "default": 0,
+          "label": "Queued jobs",
+          "explain": "Crates waiting beside the entry, one per queued job."
+        },
+        {
+          "id": "lastJob",
+          "type": "text",
+          "maxLength": 24,
+          "label": "Last job",
+          "explain": "The most recent job's name."
+        }
+      ],
+      "drives": [
+        {
+          "input": "status",
+          "target": "state:lamp"
+        },
+        {
+          "input": "status",
+          "target": "animation:belt-rollers",
+          "map": {
+            "cases": [
+              {
+                "equals": "running",
+                "to": 1
+              }
+            ],
+            "else": 0
+          }
+        },
+        {
+          "input": "queued",
+          "target": "count:waiting"
+        },
+        {
+          "input": "lastJob",
+          "target": "label:sign"
+        },
+        {
+          "input": "jobStarted",
+          "target": "spawn:belt-in"
+        },
+        {
+          "input": "status",
+          "target": "effect:confetti",
+          "map": {
+            "becomes": "ok",
+            "from": "running"
+          }
+        }
+      ],
+      "recipes": [
+        {
+          "name": "Pipeline summary JSON",
+          "fields": {
+            "status": "/pipelines/0/status",
+            "jobStarted": "/pipelines/0/jobs_started",
+            "queued": {
+              "countWhere": {
+                "array": "/jobs",
+                "pointer": "/status",
+                "equals": "queued"
+              }
+            },
+            "lastJob": "/pipelines/0/last_job/name"
+          }
+        }
+      ]
+    }
+  },
+  "slots": {
+    "states": [
+      {
+        "id": "lamp",
+        "materials": [
+          "lamp-glass"
+        ],
+        "palette": [
+          {
+            "id": "idle",
+            "colour": [
+              0.35,
+              0.45,
+              0.6
+            ],
+            "emission": 0.5
+          },
+          {
+            "id": "running",
+            "colour": [
+              1.0,
+              0.7,
+              0.2
+            ],
+            "emission": 2
+          },
+          {
+            "id": "ok",
+            "colour": [
+              0.3,
+              1.0,
+              0.45
+            ],
+            "emission": 2
+          },
+          {
+            "id": "fail",
+            "colour": [
+              1.0,
+              0.2,
+              0.15
+            ],
+            "emission": 3
+          },
+          {
+            "id": "stale",
+            "colour": [
+              0.4,
+              0.4,
+              0.4
+            ],
+            "emission": 0.2
+          }
+        ]
+      }
+    ],
+    "labels": [
+      {
+        "id": "sign",
+        "pose": {
+          "position": [
+            0,
+            1.75,
+            0.81
+          ],
+          "rotation": [
+            0,
+            0,
+            0,
+            1
+          ]
+        },
+        "size": [
+          1.2,
+          0.3
+        ],
+        "maxChars": 24,
+        "font": "mono"
+      }
+    ],
+    "tracks": [
+      {
+        "id": "belt",
+        "speed": 0.6,
+        "points": [
+          {
+            "position": [
+              -2,
+              0.8,
+              0
+            ],
+            "type": "line"
+          },
+          {
+            "position": [
+              2,
+              0.8,
+              0
+            ],
+            "type": "line"
+          }
+        ],
+        "items": {
+          "assets": [
+            "job-crate"
+          ],
+          "max": 24,
+          "spacing": 0.45
+        },
+        "sink": true
+      }
+    ],
+    "spawns": [
+      {
+        "id": "belt-in",
+        "pose": {
+          "position": [
+            -2,
+            0.8,
+            0
+          ],
+          "rotation": [
+            0,
+            0.707,
+            0,
+            0.707
+          ]
+        },
+        "track": "belt",
+        "items": [
+          "job-crate"
+        ],
+        "maxRate": 2
+      }
+    ],
+    "stacks": [
+      {
+        "id": "waiting",
+        "node": "crate",
+        "cap": 64,
+        "layout": {
+          "grid": [
+            4,
+            4,
+            4
+          ],
+          "spacing": [
+            0.35,
+            0.35,
+            0.35
+          ],
+          "fill": "xzy"
+        }
+      }
+    ],
+    "effects": [
+      {
+        "id": "confetti",
+        "pose": {
+          "position": [
+            0,
+            2.0,
+            0
+          ],
+          "rotation": [
+            0,
+            0,
+            0,
+            1
+          ]
+        },
+        "kind": "burst",
+        "colour": [
+          1.0,
+          0.8,
+          0.2
+        ],
+        "durationMs": 1500
+      }
+    ]
+  }
+}

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/extensions/blueprint.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://hyprune.com/schema/extensions/blueprint.schema.json",
+  "title": "com.hyprune.blueprint 0.1 world manifest value",
+  "description": "Per-level blueprint SVGs in the frame of the package's com.hyprune.map 0.1 (RFC-0004 amendment). Levels are sorted by minY and must not overlap (maxY[i] <= minY[i+1]); each SVG is at most 65536 bytes, all levels together at most 262144 bytes, using the map SVG subset plus a class attribute from: grid floor wall stair opening screen mount area label route waypoint void outline. Consumers enforce those rules.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["version", "levels"],
+  "properties": {
+    "version": {"const": "0.1"},
+    "levels": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 6,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "name", "minY", "maxY", "path"],
+        "properties": {
+          "id": {"type": "string", "pattern": "^[a-z][a-z0-9-]{0,31}$"},
+          "name": {"type": "string", "minLength": 1, "maxLength": 64},
+          "minY": {"type": "number"},
+          "maxY": {"type": "number"},
+          "path": {"type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!/)(?!.*(^|/)\\.\\.(/|$))[A-Za-z0-9_./-]+\\.svg$"}
+        }
+      }
+    }
+  }
+}

package/lib/validate.d.mts

@@ -1,17 +1,39 @@
 // 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 {
   /** For kind `scene`: the package's parsed world.json (lightmap checks). */
   world?: unknown;
+  /**
+   * For kind `scene` from world 0.8: validate `value` as the glTF of this
+   * `world.objectAssets[].id` (extension rules, animation and collision node
+   * 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 }>;
 }
 
 /**
@@ -19,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;
@@ -33,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[];