@retropak/schema 1.0.0-draft → 1.0.0-draft10

package/README.md

@@ -1,39 +1,24 @@
-# Retropak
+# @retropak/schema
 
-> A modern container format for retro software preservation
+JSON Schema definition for Retropak manifests.
 
-Retropak (`.rpk`) is an open standard for distributing retro software with everything in one place: ROMs, artwork, soundtracks, manuals, and metadata.
+## Installation
 
-## Quick Links
+```bash
+npm install @retropak/schema
+```
 
-- **[Read the Specification](docs/specification.md)**: Complete technical specification
-- **[Visit the Website](https://retropak.org)**: Documentation and guides
-- **[View the Schema](docs/schemas/v1/retropak.schema.json)**: JSON Schema for validation
-- **[Contributing](CONTRIBUTING.md)**: How to build and contribute to the docs
+## Usage
 
-## What is Retropak?
+```javascript
+import schema from '@retropak/schema/schema' assert { type: 'json' };
+import locales from '@retropak/schema/locales/en' assert { type: 'json' };
+```
 
-A `.rpk` file is a ZIP archive containing:
+## Development
 
-- **Software**: ROMs, disc images, executables
-- **Metadata**: Title, platform, genre, developer, release date
-- **Artwork**: Box art, screenshots, logos
-- **Documentation**: Manuals, maps, guides
-- **Audio**: Soundtracks and music
-- **Configuration**: Emulator settings
-
-Everything needed to preserve and present retro software in one self-contained package.
-
-## Features
-
-- **92 supported platforms**: From Atari 2600 to Xbox Series X
-- **Rich metadata**: Genre, players, features, ratings, credits
-- **Multi-disc support**: CD swapping, boot disks, compilations
-- **ROM verification**: MD5/SHA1/CRC32 checksums for database/DAT file validation
-- **Cryptographic signing**: GPG and SSH signatures for authenticity
-- **Accessibility**: Alt text support for all images
-- **Preservation-focused**: Version tracking, dump status, source attribution
+This package is part of the Retropak monorepo.
 
 ## License
 
-This specification is released under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/). Use it however you like.
+CC0-1.0

package/locales/en.json

@@ -226,13 +226,18 @@
         "coverdisk": "Coverdisk",
         "demo": "Demo",
         "educational": "Educational",
+        "enhanced": "Enhanced Edition",
         "firmware": "Firmware",
         "freeware": "Freeware",
         "game": "Game",
         "homebrew": "Homebrew",
         "multimedia": "Multimedia",
+        "port": "Port",
         "promotional": "Promotional",
         "prototype": "Prototype",
+        "remake": "Remake",
+        "remaster": "Remaster",
+        "rerelease": "Re-release",
         "scene_demo": "Scene Demo",
         "shareware": "Shareware",
         "unlicensed": "Unlicensed",
@@ -341,6 +346,28 @@
         "unknown": "Unknown",
         "unlicensed": "Unlicensed"
     },
+    "license": {
+        "commercial": "Commercial",
+        "freeware": "Freeware",
+        "shareware": "Shareware",
+        "public_domain": "Public Domain",
+        "open_source": "Open Source",
+        "gpl": "GNU GPL",
+        "gpl2": "GNU GPL v2",
+        "gpl3": "GNU GPL v3",
+        "lgpl": "GNU LGPL",
+        "mit": "MIT License",
+        "bsd": "BSD License",
+        "apache": "Apache License",
+        "creative_commons": "Creative Commons",
+        "cc_by": "Creative Commons BY",
+        "cc_by_sa": "Creative Commons BY-SA",
+        "cc_by_nc": "Creative Commons BY-NC",
+        "cc_by_nc_sa": "Creative Commons BY-NC-SA",
+        "cc0": "Creative Commons CC0",
+        "proprietary": "Proprietary",
+        "unknown": "Unknown"
+    },
     "esrb": {
         "ec": "Early Childhood",
         "e": "Everyone",

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "@retropak/schema",
-    "version": "1.0.0-draft",
+    "version": "1.0.0-draft10",
     "description": "Metadata specification for Retropak software containers",
     "type": "module",
+    "main": "./schemas/v1/retropak.schema.json",
     "exports": {
         "./schema": "./schemas/v1/retropak.schema.json",
         "./locales/en": "./locales/en.json",
@@ -14,13 +15,15 @@
     ],
     "keywords": [
         "retropak",
-        "schema"
+        "schema",
+        "json-schema"
     ],
     "author": "piers@retropak.org",
     "license": "CC0-1.0",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/piersroberts/retropak.git"
+        "url": "git+https://github.com/piersroberts/retropak.git",
+        "directory": "packages/schema"
     },
     "bugs": {
         "url": "https://github.com/piersroberts/retropak/issues"

package/schemas/v1/retropak.schema.json

@@ -243,13 +243,18 @@
                 "coverdisk",
                 "demo",
                 "educational",
+                "enhanced",
                 "firmware",
                 "freeware",
                 "game",
                 "homebrew",
                 "multimedia",
+                "port",
                 "promotional",
                 "prototype",
+                "remake",
+                "remaster",
+                "rerelease",
                 "scene_demo",
                 "shareware",
                 "unlicensed",
@@ -375,9 +380,36 @@
                 "unlicensed"
             ]
         },
+        "license": {
+            "type": "string",
+            "description": "Software license type.",
+            "enum": [
+                "commercial",
+                "freeware",
+                "shareware",
+                "public_domain",
+                "open_source",
+                "gpl",
+                "gpl2",
+                "gpl3",
+                "lgpl",
+                "mit",
+                "bsd",
+                "apache",
+                "creative_commons",
+                "cc_by",
+                "cc_by_sa",
+                "cc_by_nc",
+                "cc_by_nc_sa",
+                "cc0",
+                "proprietary",
+                "unknown"
+            ]
+        },
         "ageRating": {
             "type": "object",
             "description": "Age/content ratings from various rating boards.",
+            "additionalProperties": false,
             "properties": {
                 "nsfw": {
                     "type": "boolean",
@@ -476,12 +508,14 @@
         "configFile": {
             "type": "object",
             "description": "An external configuration file for emulator or platform-specific settings.",
+            "additionalProperties": false,
             "required": [
                 "file"
             ],
             "properties": {
                 "file": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Path to the configuration file."
                 },
                 "target": {
@@ -497,12 +531,14 @@
         "image": {
             "type": "object",
             "description": "An image file with optional alt text for accessibility.",
+            "additionalProperties": false,
             "required": [
                 "file"
             ],
             "properties": {
                 "file": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Path to the image file."
                 },
                 "alt": {
@@ -514,12 +550,14 @@
         "creditEntry": {
             "type": "object",
             "description": "A person credited for work on the title.",
+            "additionalProperties": false,
             "required": [
                 "name"
             ],
             "properties": {
                 "name": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Person's name."
                 },
                 "roles": {
@@ -528,12 +566,20 @@
                     "items": {
                         "type": "string"
                     }
+                },
+                "characters": {
+                    "type": "array",
+                    "description": "Character names portrayed by this person (for voice actors, motion capture actors, etc.).",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             }
         },
         "musicTrack": {
             "type": "object",
             "description": "A soundtrack or audio file from the title.",
+            "additionalProperties": false,
             "required": [
                 "file"
             ],
@@ -544,6 +590,7 @@
                 },
                 "file": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Path to the audio file."
                 },
                 "background": {
@@ -556,22 +603,20 @@
         "physicalMediaImage": {
             "type": "object",
             "description": "An image of physical media (cartridge, disc, tape, etc.).",
+            "additionalProperties": false,
             "required": [
                 "file"
             ],
             "properties": {
                 "file": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Path to the physical media image file."
                 },
                 "alt": {
                     "type": "string",
                     "description": "Alternative text describing the image for accessibility."
                 },
-                "mediaId": {
-                    "type": "string",
-                    "description": "References the 'id' field of a media item, if specific to one disc/cart."
-                },
                 "type": {
                     "$ref": "#/$defs/mediaType"
                 }
@@ -580,17 +625,15 @@
         "mediaItem": {
             "type": "object",
             "description": "A media file (ROM, disc image, tape, etc.).",
+            "additionalProperties": false,
             "required": [
                 "filename",
                 "type"
             ],
             "properties": {
-                "id": {
-                    "type": "string",
-                    "description": "Unique identifier for this media item, used for referencing in other fields."
-                },
                 "filename": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "Relative path to the media file within the archive."
                 },
                 "label": {
@@ -622,6 +665,11 @@
                     "pattern": "^[a-fA-F0-9]{40}$",
                     "description": "SHA-1 checksum of the media file for verification."
                 },
+                "sha256": {
+                    "type": "string",
+                    "pattern": "^[a-fA-F0-9]{64}$",
+                    "description": "SHA-256 checksum of the media file for verification."
+                },
                 "crc32": {
                     "type": "string",
                     "pattern": "^[a-fA-F0-9]{8}$",
@@ -642,13 +690,17 @@
                     "type": "string",
                     "description": "Source database or group that verified the dump (e.g. 'No-Intro', 'Redump', 'TOSEC')."
                 },
-                "serial": {
+                "productCode": {
                     "type": "string",
-                    "description": "Official product serial/catalog number from the original media."
+                    "description": "Official product code or catalog number from the original media (e.g. 'SLUS-00594', 'MK-1491', 'DOL-GALE-USA')."
                 },
                 "notes": {
                     "type": "string",
                     "description": "Additional notes about this specific media file (e.g. distribution method, requirements, known issues)."
+                },
+                "labelImage": {
+                    "$ref": "#/$defs/image",
+                    "description": "Image of the media label (e.g. disc label, cartridge label, cassette label)."
                 }
             }
         },
@@ -659,6 +711,7 @@
         "players": {
             "type": "object",
             "description": "Multiplayer capabilities.",
+            "additionalProperties": false,
             "properties": {
                 "min": {
                     "type": "integer",
@@ -678,6 +731,7 @@
         "features": {
             "type": "object",
             "description": "Input devices, peripherals, and capabilities.",
+            "additionalProperties": false,
             "properties": {
                 "required": {
                     "type": "array",
@@ -697,6 +751,7 @@
         }
     },
     "type": "object",
+    "additionalProperties": false,
     "required": [
         "schemaVersion",
         "info",
@@ -716,6 +771,7 @@
         "info": {
             "type": "object",
             "description": "Title metadata and information.",
+            "additionalProperties": false,
             "required": [
                 "title",
                 "platform"
@@ -723,6 +779,7 @@
             "properties": {
                 "title": {
                     "type": "string",
+                    "minLength": 1,
                     "description": "The primary display name of the title."
                 },
                 "alternativeTitles": {
@@ -804,6 +861,7 @@
                 "externalIds": {
                     "type": "object",
                     "description": "Identifiers from external databases for cross-referencing.",
+                    "additionalProperties": false,
                     "properties": {
                         "igdb": {
                             "type": "integer",
@@ -834,6 +892,30 @@
                 "rating": {
                     "$ref": "#/$defs/ageRating"
                 },
+                "license": {
+                    "$ref": "#/$defs/license",
+                    "description": "The software license (e.g., 'freeware', 'shareware', 'commercial', 'gpl', 'mit')."
+                },
+                "ean": {
+                    "type": "string",
+                    "pattern": "^[0-9]{13}$",
+                    "description": "European Article Number (EAN-13) barcode from product packaging. Also covers JAN (Japanese Article Number)."
+                },
+                "upc": {
+                    "type": "string",
+                    "pattern": "^[0-9]{12}$",
+                    "description": "Universal Product Code (UPC-A) barcode from product packaging."
+                },
+                "isbn": {
+                    "type": "string",
+                    "pattern": "^(97[89][0-9]{10}|[0-9]{9}[0-9X])$",
+                    "description": "International Standard Book Number (ISBN-10 or ISBN-13) if applicable."
+                },
+                "issn": {
+                    "type": "string",
+                    "pattern": "^[0-9]{4}-[0-9]{3}[0-9X]$",
+                    "description": "International Standard Serial Number (ISSN) for magazine coverdisks."
+                },
                 "notes": {
                     "type": "string",
                     "description": "Additional notes, warnings, or information (e.g. access codes, compatibility notes, copy protection details)."
@@ -851,6 +933,7 @@
         "assets": {
             "type": "object",
             "description": "Artwork, documentation, and other supplementary files.",
+            "additionalProperties": false,
             "properties": {
                 "boxFront": {
                     "$ref": "#/$defs/image",