@retropak/types 1.0.0-draft → 1.0.0-draft11

package/dist/generated.d.ts

@@ -6,7 +6,7 @@
 /**
  * A classification for the type/nature of the software.
  */
-export type Category = "addon" | "application" | "beta" | "bios" | "compilation" | "coverdisk" | "demo" | "educational" | "firmware" | "freeware" | "game" | "homebrew" | "multimedia" | "promotional" | "prototype" | "scene_demo" | "shareware" | "unlicensed" | "utility";
+export type Category = "addon" | "application" | "beta" | "bios" | "compilation" | "coverdisk" | "demo" | "educational" | "enhanced" | "firmware" | "freeware" | "game" | "homebrew" | "multimedia" | "port" | "promotional" | "prototype" | "remake" | "remaster" | "rerelease" | "scene_demo" | "shareware" | "unlicensed" | "utility";
 /**
  * Genre classification.
  */
@@ -129,14 +129,32 @@ export interface RetropakManifest {
              * GameFAQs ID.
              */
             gamefaqs?: number;
-            [k: string]: unknown;
         };
         rating?: AgeRating;
+        /**
+         * The software license (e.g., 'freeware', 'shareware', 'commercial', 'gpl', 'mit').
+         */
+        license?: "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";
+        /**
+         * European Article Number (EAN-13) barcode from product packaging. Also covers JAN (Japanese Article Number).
+         */
+        ean?: string;
+        /**
+         * Universal Product Code (UPC-A) barcode from product packaging.
+         */
+        upc?: string;
+        /**
+         * International Standard Book Number (ISBN-10 or ISBN-13) if applicable.
+         */
+        isbn?: string;
+        /**
+         * International Standard Serial Number (ISSN) for magazine coverdisks.
+         */
+        issn?: string;
         /**
          * Additional notes, warnings, or information (e.g. access codes, compatibility notes, copy protection details).
          */
         notes?: string;
-        [k: string]: unknown;
     };
     /**
      * The media files (ROMs, disc images, tapes, etc.) included in this package.
@@ -148,36 +166,34 @@ export interface RetropakManifest {
      * Artwork, documentation, and other supplementary files.
      */
     assets?: {
-        boxFront?: Image;
-        boxBack?: Image1;
-        boxSpine?: Image2;
+        boxFront?: Image1;
+        boxBack?: Image2;
+        boxSpine?: Image3;
         /**
          * Images of the physical media (cartridge, disc, tape, floppy, etc.).
          */
-        physicalMedia?: PhysicalMediaImage[];
-        logo?: Image3;
-        backdrop?: Image4;
-        titleScreen?: Image5;
+        physicalMedia?: Image4[];
+        logo?: Image5;
+        backdrop?: Image6;
+        titleScreen?: Image7;
         /**
          * Gameplay screenshots.
          */
-        gameplay?: Image6[];
+        gameplay?: Image4[];
         /**
          * Path to the manual (PDF, image, html or text).
          */
         manual?: string;
-        map?: Image7;
+        map?: Image8;
         /**
          * Soundtrack or audio files from the game.
          */
         music?: MusicTrack[];
-        [k: string]: unknown;
     };
     /**
      * External configuration files for emulators or platforms.
      */
     config?: ConfigFile[];
-    [k: string]: unknown;
 }
 /**
  * Multiplayer capabilities.
@@ -195,7 +211,6 @@ export interface Players {
      * Whether cooperative play is supported.
      */
     coop?: boolean;
-    [k: string]: unknown;
 }
 /**
  * Input devices, peripherals, and capabilities.
@@ -209,7 +224,6 @@ export interface Features {
      * Optional features the title supports.
      */
     supported?: Feature[];
-    [k: string]: unknown;
 }
 /**
  * A person credited for work on the title.
@@ -223,7 +237,10 @@ export interface CreditEntry {
      * Job titles or roles (e.g. 'Director', 'Lead Programmer', 'Composer').
      */
     roles?: string[];
-    [k: string]: unknown;
+    /**
+     * Character names portrayed by this person (for voice actors, motion capture actors, etc.).
+     */
+    characters?: string[];
 }
 /**
  * Age/content ratings from various rating boards.
@@ -265,16 +282,11 @@ export interface AgeRating {
      * BBFC rating (United Kingdom).
      */
     bbfc?: "u" | "pg" | "12" | "12a" | "15" | "18" | "r18";
-    [k: string]: unknown;
 }
 /**
  * A media file (ROM, disc image, tape, etc.).
  */
 export interface MediaItem {
-    /**
-     * Unique identifier for this media item, used for referencing in other fields.
-     */
-    id?: string;
     /**
      * Relative path to the media file within the archive.
      */
@@ -301,6 +313,10 @@ export interface MediaItem {
      * SHA-1 checksum of the media file for verification.
      */
     sha1?: string;
+    /**
+     * SHA-256 checksum of the media file for verification.
+     */
+    sha256?: string;
     /**
      * CRC32 checksum of the media file for verification.
      */
@@ -319,17 +335,17 @@ export interface MediaItem {
      */
     source?: string;
     /**
-     * Official product serial/catalog number from the original media.
+     * Official product code or catalog number from the original media (e.g. 'SLUS-00594', 'MK-1491', 'DOL-GALE-USA').
      */
-    serial?: string;
+    productCode?: string;
     /**
      * Additional notes about this specific media file (e.g. distribution method, requirements, known issues).
      */
     notes?: string;
-    [k: string]: unknown;
+    labelImage?: Image;
 }
 /**
- * Front box/case cover image.
+ * Image of the media label (e.g. disc label, cartridge label, cassette label).
  */
 export interface Image {
     /**
@@ -340,10 +356,9 @@ export interface Image {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
- * Back box/case cover image.
+ * Front box/case cover image.
  */
 export interface Image1 {
     /**
@@ -354,10 +369,9 @@ export interface Image1 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
- * Box/case spine image.
+ * Back box/case cover image.
  */
 export interface Image2 {
     /**
@@ -368,31 +382,24 @@ export interface Image2 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
- * An image of physical media (cartridge, disc, tape, etc.).
+ * Box/case spine image.
  */
-export interface PhysicalMediaImage {
+export interface Image3 {
     /**
-     * Path to the physical media image file.
+     * Path to the image file.
      */
     file: string;
     /**
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    /**
-     * References the 'id' field of a media item, if specific to one disc/cart.
-     */
-    mediaId?: string;
-    type?: MediaType;
-    [k: string]: unknown;
 }
 /**
- * Logo/wordmark with transparent background.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image3 {
+export interface Image4 {
     /**
      * Path to the image file.
      */
@@ -401,12 +408,11 @@ export interface Image3 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
- * Widescreen background artwork for TV/big screen interfaces. Should be free of text or logos.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image4 {
+export interface Image5 {
     /**
      * Path to the image file.
      */
@@ -415,12 +421,11 @@ export interface Image4 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
- * Title screen screenshot.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image5 {
+export interface Image6 {
     /**
      * Path to the image file.
      */
@@ -429,12 +434,11 @@ export interface Image5 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
  * An image file with optional alt text for accessibility.
  */
-export interface Image6 {
+export interface Image7 {
     /**
      * Path to the image file.
      */
@@ -443,12 +447,11 @@ export interface Image6 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
  * An image file with optional alt text for accessibility.
  */
-export interface Image7 {
+export interface Image8 {
     /**
      * Path to the image file.
      */
@@ -457,7 +460,6 @@ export interface Image7 {
      * Alternative text describing the image for accessibility.
      */
     alt?: string;
-    [k: string]: unknown;
 }
 /**
  * A soundtrack or audio file from the title.
@@ -475,7 +477,6 @@ export interface MusicTrack {
      * Whether this track is suitable for background/menu music when browsing titles.
      */
     background?: boolean;
-    [k: string]: unknown;
 }
 /**
  * An external configuration file for emulator or platform-specific settings.
@@ -493,5 +494,4 @@ export interface ConfigFile {
      * What this config file does or overrides.
      */
     description?: string;
-    [k: string]: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@retropak/types",
-    "version": "1.0.0-draft",
+    "version": "1.0.0-draft11",
     "description": "TypeScript type definitions for Retropak manifests",
     "type": "module",
     "main": "./dist/index.js",

package/src/generated.ts

@@ -17,13 +17,18 @@ export type Category =
   | "coverdisk"
   | "demo"
   | "educational"
+  | "enhanced"
   | "firmware"
   | "freeware"
   | "game"
   | "homebrew"
   | "multimedia"
+  | "port"
   | "promotional"
   | "prototype"
+  | "remake"
+  | "remaster"
+  | "rerelease"
   | "scene_demo"
   | "shareware"
   | "unlicensed"
@@ -460,14 +465,52 @@ export interface RetropakManifest {
        * GameFAQs ID.
        */
       gamefaqs?: number;
-      [k: string]: unknown;
     };
     rating?: AgeRating;
+    /**
+     * The software license (e.g., 'freeware', 'shareware', 'commercial', 'gpl', 'mit').
+     */
+    license?:
+      | "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";
+    /**
+     * European Article Number (EAN-13) barcode from product packaging. Also covers JAN (Japanese Article Number).
+     */
+    ean?: string;
+    /**
+     * Universal Product Code (UPC-A) barcode from product packaging.
+     */
+    upc?: string;
+    /**
+     * International Standard Book Number (ISBN-10 or ISBN-13) if applicable.
+     */
+    isbn?: string;
+    /**
+     * International Standard Serial Number (ISSN) for magazine coverdisks.
+     */
+    issn?: string;
     /**
      * Additional notes, warnings, or information (e.g. access codes, compatibility notes, copy protection details).
      */
     notes?: string;
-    [k: string]: unknown;
   };
   /**
    * The media files (ROMs, disc images, tapes, etc.) included in this package.
@@ -479,36 +522,34 @@ export interface RetropakManifest {
    * Artwork, documentation, and other supplementary files.
    */
   assets?: {
-    boxFront?: Image;
-    boxBack?: Image1;
-    boxSpine?: Image2;
+    boxFront?: Image1;
+    boxBack?: Image2;
+    boxSpine?: Image3;
     /**
      * Images of the physical media (cartridge, disc, tape, floppy, etc.).
      */
-    physicalMedia?: PhysicalMediaImage[];
-    logo?: Image3;
-    backdrop?: Image4;
-    titleScreen?: Image5;
+    physicalMedia?: Image4[];
+    logo?: Image5;
+    backdrop?: Image6;
+    titleScreen?: Image7;
     /**
      * Gameplay screenshots.
      */
-    gameplay?: Image6[];
+    gameplay?: Image4[];
     /**
      * Path to the manual (PDF, image, html or text).
      */
     manual?: string;
-    map?: Image7;
+    map?: Image8;
     /**
      * Soundtrack or audio files from the game.
      */
     music?: MusicTrack[];
-    [k: string]: unknown;
   };
   /**
    * External configuration files for emulators or platforms.
    */
   config?: ConfigFile[];
-  [k: string]: unknown;
 }
 /**
  * Multiplayer capabilities.
@@ -526,7 +567,6 @@ export interface Players {
    * Whether cooperative play is supported.
    */
   coop?: boolean;
-  [k: string]: unknown;
 }
 /**
  * Input devices, peripherals, and capabilities.
@@ -540,7 +580,6 @@ export interface Features {
    * Optional features the title supports.
    */
   supported?: Feature[];
-  [k: string]: unknown;
 }
 /**
  * A person credited for work on the title.
@@ -554,7 +593,10 @@ export interface CreditEntry {
    * Job titles or roles (e.g. 'Director', 'Lead Programmer', 'Composer').
    */
   roles?: string[];
-  [k: string]: unknown;
+  /**
+   * Character names portrayed by this person (for voice actors, motion capture actors, etc.).
+   */
+  characters?: string[];
 }
 /**
  * Age/content ratings from various rating boards.
@@ -596,16 +638,11 @@ export interface AgeRating {
    * BBFC rating (United Kingdom).
    */
   bbfc?: "u" | "pg" | "12" | "12a" | "15" | "18" | "r18";
-  [k: string]: unknown;
 }
 /**
  * A media file (ROM, disc image, tape, etc.).
  */
 export interface MediaItem {
-  /**
-   * Unique identifier for this media item, used for referencing in other fields.
-   */
-  id?: string;
   /**
    * Relative path to the media file within the archive.
    */
@@ -632,6 +669,10 @@ export interface MediaItem {
    * SHA-1 checksum of the media file for verification.
    */
   sha1?: string;
+  /**
+   * SHA-256 checksum of the media file for verification.
+   */
+  sha256?: string;
   /**
    * CRC32 checksum of the media file for verification.
    */
@@ -650,17 +691,17 @@ export interface MediaItem {
    */
   source?: string;
   /**
-   * Official product serial/catalog number from the original media.
+   * Official product code or catalog number from the original media (e.g. 'SLUS-00594', 'MK-1491', 'DOL-GALE-USA').
    */
-  serial?: string;
+  productCode?: string;
   /**
    * Additional notes about this specific media file (e.g. distribution method, requirements, known issues).
    */
   notes?: string;
-  [k: string]: unknown;
+  labelImage?: Image;
 }
 /**
- * Front box/case cover image.
+ * Image of the media label (e.g. disc label, cartridge label, cassette label).
  */
 export interface Image {
   /**
@@ -671,10 +712,9 @@ export interface Image {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
- * Back box/case cover image.
+ * Front box/case cover image.
  */
 export interface Image1 {
   /**
@@ -685,10 +725,9 @@ export interface Image1 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
- * Box/case spine image.
+ * Back box/case cover image.
  */
 export interface Image2 {
   /**
@@ -699,31 +738,24 @@ export interface Image2 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
- * An image of physical media (cartridge, disc, tape, etc.).
+ * Box/case spine image.
  */
-export interface PhysicalMediaImage {
+export interface Image3 {
   /**
-   * Path to the physical media image file.
+   * Path to the image file.
    */
   file: string;
   /**
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  /**
-   * References the 'id' field of a media item, if specific to one disc/cart.
-   */
-  mediaId?: string;
-  type?: MediaType;
-  [k: string]: unknown;
 }
 /**
- * Logo/wordmark with transparent background.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image3 {
+export interface Image4 {
   /**
    * Path to the image file.
    */
@@ -732,12 +764,11 @@ export interface Image3 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
- * Widescreen background artwork for TV/big screen interfaces. Should be free of text or logos.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image4 {
+export interface Image5 {
   /**
    * Path to the image file.
    */
@@ -746,12 +777,11 @@ export interface Image4 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
- * Title screen screenshot.
+ * An image file with optional alt text for accessibility.
  */
-export interface Image5 {
+export interface Image6 {
   /**
    * Path to the image file.
    */
@@ -760,12 +790,11 @@ export interface Image5 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
  * An image file with optional alt text for accessibility.
  */
-export interface Image6 {
+export interface Image7 {
   /**
    * Path to the image file.
    */
@@ -774,12 +803,11 @@ export interface Image6 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
  * An image file with optional alt text for accessibility.
  */
-export interface Image7 {
+export interface Image8 {
   /**
    * Path to the image file.
    */
@@ -788,7 +816,6 @@ export interface Image7 {
    * Alternative text describing the image for accessibility.
    */
   alt?: string;
-  [k: string]: unknown;
 }
 /**
  * A soundtrack or audio file from the title.
@@ -806,7 +833,6 @@ export interface MusicTrack {
    * Whether this track is suitable for background/menu music when browsing titles.
    */
   background?: boolean;
-  [k: string]: unknown;
 }
 /**
  * An external configuration file for emulator or platform-specific settings.
@@ -824,5 +850,4 @@ export interface ConfigFile {
    * What this config file does or overrides.
    */
   description?: string;
-  [k: string]: unknown;
 }