npm - @hyprune/schema - Versions diffs - 0.9.0 → 0.11.0 - Mend

@hyprune/schema 0.9.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/examples/registry/invalid/sources--index-with-repo.json ADDED Viewed

@@ -0,0 +1,52 @@
+{
+  "version": 1,
+  "builtin": {
+    "official": {
+      "enabled": true
+    },
+    "community": {
+      "enabled": false
+    }
+  },
+  "custom": [
+    {
+      "id": "example-index",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01",
+      "repo": "example-creator/tidepool-world"
+    },
+    {
+      "id": "tidepool",
+      "label": "Tidepool",
+      "kind": "github",
+      "repo": "example-creator/tidepool-world",
+      "enabled": true,
+      "added": "2026-11-02"
+    },
+    {
+      "id": "street",
+      "label": "Street kit",
+      "kind": "github",
+      "repo": "example-org/hyprune-objects/street",
+      "enabled": false
+    },
+    {
+      "id": "one-archive",
+      "label": "example.org",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.tar.zst",
+      "sha256": "5d2f0c6e3b9a41d8e7c2b0f4a6d9e1c3b5a7f9e2d4c6b8a0f1e3d5c7b9a2e4f6",
+      "enabled": true
+    },
+    {
+      "id": "one-record",
+      "label": "A record",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.release.json",
+      "enabled": true
+    }
+  ]
+}

package/examples/registry/invalid/sources--label-too-long.json ADDED Viewed

@@ -0,0 +1,51 @@
+{
+  "version": 1,
+  "builtin": {
+    "official": {
+      "enabled": true
+    },
+    "community": {
+      "enabled": false
+    }
+  },
+  "custom": [
+    {
+      "id": "example-index",
+      "label": "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "tidepool",
+      "label": "Tidepool",
+      "kind": "github",
+      "repo": "example-creator/tidepool-world",
+      "enabled": true,
+      "added": "2026-11-02"
+    },
+    {
+      "id": "street",
+      "label": "Street kit",
+      "kind": "github",
+      "repo": "example-org/hyprune-objects/street",
+      "enabled": false
+    },
+    {
+      "id": "one-archive",
+      "label": "example.org",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.tar.zst",
+      "sha256": "5d2f0c6e3b9a41d8e7c2b0f4a6d9e1c3b5a7f9e2d4c6b8a0f1e3d5c7b9a2e4f6",
+      "enabled": true
+    },
+    {
+      "id": "one-record",
+      "label": "A record",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.release.json",
+      "enabled": true
+    }
+  ]
+}

package/examples/registry/invalid/sources--reserved-id.json ADDED Viewed

@@ -0,0 +1,51 @@
+{
+  "version": 1,
+  "builtin": {
+    "official": {
+      "enabled": true
+    },
+    "community": {
+      "enabled": false
+    }
+  },
+  "custom": [
+    {
+      "id": "official",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "tidepool",
+      "label": "Tidepool",
+      "kind": "github",
+      "repo": "example-creator/tidepool-world",
+      "enabled": true,
+      "added": "2026-11-02"
+    },
+    {
+      "id": "street",
+      "label": "Street kit",
+      "kind": "github",
+      "repo": "example-org/hyprune-objects/street",
+      "enabled": false
+    },
+    {
+      "id": "one-archive",
+      "label": "example.org",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.tar.zst",
+      "sha256": "5d2f0c6e3b9a41d8e7c2b0f4a6d9e1c3b5a7f9e2d4c6b8a0f1e3d5c7b9a2e4f6",
+      "enabled": true
+    },
+    {
+      "id": "one-record",
+      "label": "A record",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.release.json",
+      "enabled": true
+    }
+  ]
+}

package/examples/registry/invalid/sources--too-many.json ADDED Viewed

@@ -0,0 +1,277 @@
+{
+  "version": 1,
+  "builtin": {
+    "official": {
+      "enabled": true
+    },
+    "community": {
+      "enabled": false
+    }
+  },
+  "custom": [
+    {
+      "id": "s0",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s1",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s2",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s3",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s4",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s5",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s6",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s7",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s8",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s9",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s10",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s11",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s12",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s13",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s14",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s15",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s16",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s17",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s18",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s19",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s20",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s21",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s22",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s23",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s24",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s25",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s26",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s27",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s28",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s29",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s30",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s31",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "s32",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    }
+  ]
+}

package/examples/registry/release-record.json ADDED Viewed

@@ -0,0 +1,42 @@
+{
+  "recordVersion": "0.1",
+  "type": "world",
+  "id": "io.github.example-creator.tidepool",
+  "version": "1.2.0",
+  "formatVersion": "0.9",
+  "name": "Tidepool Station",
+  "license": "CC-BY-SA-4.0",
+  "archive": {
+    "name": "io.github.example-creator.tidepool-1.2.0.tar.zst",
+    "sha256": "5d2f0c6e3b9a41d8e7c2b0f4a6d9e1c3b5a7f9e2d4c6b8a0f1e3d5c7b9a2e4f6",
+    "bytes": 48213004,
+    "expandedBytes": 96424960,
+    "files": 212
+  },
+  "requires": {
+    "libraries": [
+      "com.example.street@1.2.0"
+    ]
+  },
+  "thumbnails": [
+    {
+      "name": "io.github.example-creator.tidepool-1.2.0.thumb-1.png",
+      "sha256": "0b8e4c2a6f1d3e5b7a9c0d2e4f6a8b1c3d5e7f9a0b2c4d6e8f1a3b5c7d9e0f2a",
+      "width": 1280,
+      "height": 720
+    }
+  ],
+  "source": {
+    "repo": "https://github.com/example-creator/tidepool-world",
+    "tag": "v1.2.0",
+    "commit": "3f2a9c4e1b7d5a8c0e2f4b6d8a1c3e5f7b9d0a2c"
+  },
+  "tool": {
+    "name": "hyprune",
+    "version": "0.7.0"
+  },
+  "checks": {
+    "schema": "pass",
+    "worldCheck": "pass"
+  }
+}

package/examples/registry/sources.json ADDED Viewed

@@ -0,0 +1,51 @@
+{
+  "version": 1,
+  "builtin": {
+    "official": {
+      "enabled": true
+    },
+    "community": {
+      "enabled": false
+    }
+  },
+  "custom": [
+    {
+      "id": "example-index",
+      "label": "Example worlds",
+      "kind": "index",
+      "url": "https://example.org/hyprune/v0.1/index.json",
+      "enabled": true,
+      "added": "2026-11-01"
+    },
+    {
+      "id": "tidepool",
+      "label": "Tidepool",
+      "kind": "github",
+      "repo": "example-creator/tidepool-world",
+      "enabled": true,
+      "added": "2026-11-02"
+    },
+    {
+      "id": "street",
+      "label": "Street kit",
+      "kind": "github",
+      "repo": "example-org/hyprune-objects/street",
+      "enabled": false
+    },
+    {
+      "id": "one-archive",
+      "label": "example.org",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.tar.zst",
+      "sha256": "5d2f0c6e3b9a41d8e7c2b0f4a6d9e1c3b5a7f9e2d4c6b8a0f1e3d5c7b9a2e4f6",
+      "enabled": true
+    },
+    {
+      "id": "one-record",
+      "label": "A record",
+      "kind": "url",
+      "url": "https://example.org/files/com.example.street-1.2.0.release.json",
+      "enabled": true
+    }
+  ]
+}

package/lib/validate.d.mts CHANGED Viewed

@@ -72,3 +72,27 @@ export const objectLimits: Readonly<Record<string, number>>;
 export const worldLimits: Readonly<{ characters: number; charactersPerPath: number; pathPoints: number; arcChord: number }>;
 /** glTF extensions a scene may list in extensionsRequired for a world format. */
 export function sceneExtensions(version: string): string[];
+/** Registry document kinds (RFC-0015). `registry-entry` is one index entry (a registry entry file may add `$schema`). */
+export type RegistryKind = 'registry-index' | 'registry-entry' | 'release-record' | 'sources';
+/**
+ * Validate a registry document against `registry/v<version>/` (default: the newest) plus the
+ * semantic rules: unique ids, versions unique and newest first (SemVer), tags naming their
+ * version (`v<version>` or `<name>-v<version>`), SPDX expressions, per-type archive limits.
+ * @throws on an unknown kind or version
+ */
+export function validateRegistry(kind: RegistryKind, value: unknown, version?: string): ValidationResult;
+/** Registry format versions with published schemas (registry/v0.N), oldest first. */
+export const registryVersions: readonly string[];
+/** RFC-0015 archive limits per package type and index limits. */
+export const registryLimits: Readonly<{
+  world: Readonly<{ bytes: number; expandedBytes: number; files: number; fileBytes: number }>;
+  library: Readonly<{ bytes: number; expandedBytes: number; files: number; fileBytes: number }>;
+  index: Readonly<{ bytes: number; entries: number; versions: number; thumbnails: number; custom: number }>;
+}>;
+/** A parsed SemVer 2.0 version, or undefined when invalid. */
+export function parseSemver(text: unknown): { major: number; minor: number; patch: number; prerelease: string[]; build: string | null } | undefined;
+/** SemVer precedence (-1, 0, 1; build metadata ignored). Throws on invalid input. */
+export function compareSemver(a: string, b: string): -1 | 0 | 1;
+/** The version a tag names (`v<version>` or `<name>-v<version>`), or undefined. */
+export function tagVersion(tag: unknown): { name: string | null; version: string } | undefined;