@retropak/types 1.0.0-draft10 → 1.0.0-draft12

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.
@@ -20,9 +20,9 @@ export type Feature = "analog_stick" | "arcade_stick" | "balance_board" | "bongo
20
20
  */
21
21
  export type CompilationTitle = string;
22
22
  /**
23
- * The format/medium type of the file.
23
+ * The format/medium type of the file. Note: Files with media types 'bluray', 'cdrom', 'disk_image', 'dvd', 'flash_image', 'gd_rom', 'hdd_image', 'laserdisc', 'optical_disk', and 'umd' MUST use STORE mode (uncompressed) in the ZIP archive to enable efficient random access. Other media types MAY use DEFLATE compression.
24
24
  */
25
- export type MediaType = "archive" | "bluray" | "cartridge" | "cdrom" | "download" | "dvd" | "floppy" | "gd_rom" | "hdd_image" | "laserdisc" | "memory_card" | "tape" | "umd";
25
+ export type MediaType = "archive" | "bluray" | "cartridge" | "cdrom" | "disk_image" | "download" | "dvd" | "flash_image" | "floppy" | "gd_rom" | "hdd_image" | "laserdisc" | "memory_card" | "optical_disk" | "tape" | "umd";
26
26
  /**
27
27
  * Region encoding.
28
28
  */
@@ -172,14 +172,14 @@ export interface RetropakManifest {
172
172
  /**
173
173
  * Images of the physical media (cartridge, disc, tape, floppy, etc.).
174
174
  */
175
- physicalMedia?: PhysicalMediaImage[];
176
- logo?: Image4;
177
- backdrop?: Image5;
178
- titleScreen?: Image6;
175
+ physicalMedia?: Image4[];
176
+ logo?: Image5;
177
+ backdrop?: Image6;
178
+ titleScreen?: Image7;
179
179
  /**
180
180
  * Gameplay screenshots.
181
181
  */
182
- gameplay?: Image7[];
182
+ gameplay?: Image4[];
183
183
  /**
184
184
  * Path to the manual (PDF, image, html or text).
185
185
  */
@@ -397,21 +397,7 @@ export interface Image3 {
397
397
  alt?: string;
398
398
  }
399
399
  /**
400
- * An image of physical media (cartridge, disc, tape, etc.).
401
- */
402
- export interface PhysicalMediaImage {
403
- /**
404
- * Path to the physical media image file.
405
- */
406
- file: string;
407
- /**
408
- * Alternative text describing the image for accessibility.
409
- */
410
- alt?: string;
411
- type?: MediaType;
412
- }
413
- /**
414
- * Logo/wordmark with transparent background.
400
+ * An image file with optional alt text for accessibility.
415
401
  */
416
402
  export interface Image4 {
417
403
  /**
@@ -424,7 +410,7 @@ export interface Image4 {
424
410
  alt?: string;
425
411
  }
426
412
  /**
427
- * Widescreen background artwork for TV/big screen interfaces. Should be free of text or logos.
413
+ * An image file with optional alt text for accessibility.
428
414
  */
429
415
  export interface Image5 {
430
416
  /**
@@ -437,7 +423,7 @@ export interface Image5 {
437
423
  alt?: string;
438
424
  }
439
425
  /**
440
- * Title screen screenshot.
426
+ * An image file with optional alt text for accessibility.
441
427
  */
442
428
  export interface Image6 {
443
429
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@retropak/types",
3
- "version": "1.0.0-draft10",
3
+ "version": "1.0.0-draft12",
4
4
  "description": "TypeScript type definitions for Retropak manifests",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/generated.ts CHANGED
@@ -177,20 +177,23 @@ export type Feature =
177
177
  */
178
178
  export type CompilationTitle = string;
179
179
  /**
180
- * The format/medium type of the file.
180
+ * The format/medium type of the file. Note: Files with media types 'bluray', 'cdrom', 'disk_image', 'dvd', 'flash_image', 'gd_rom', 'hdd_image', 'laserdisc', 'optical_disk', and 'umd' MUST use STORE mode (uncompressed) in the ZIP archive to enable efficient random access. Other media types MAY use DEFLATE compression.
181
181
  */
182
182
  export type MediaType =
183
183
  | "archive"
184
184
  | "bluray"
185
185
  | "cartridge"
186
186
  | "cdrom"
187
+ | "disk_image"
187
188
  | "download"
188
189
  | "dvd"
190
+ | "flash_image"
189
191
  | "floppy"
190
192
  | "gd_rom"
191
193
  | "hdd_image"
192
194
  | "laserdisc"
193
195
  | "memory_card"
196
+ | "optical_disk"
194
197
  | "tape"
195
198
  | "umd";
196
199
  /**
@@ -528,14 +531,14 @@ export interface RetropakManifest {
528
531
  /**
529
532
  * Images of the physical media (cartridge, disc, tape, floppy, etc.).
530
533
  */
531
- physicalMedia?: PhysicalMediaImage[];
532
- logo?: Image4;
533
- backdrop?: Image5;
534
- titleScreen?: Image6;
534
+ physicalMedia?: Image4[];
535
+ logo?: Image5;
536
+ backdrop?: Image6;
537
+ titleScreen?: Image7;
535
538
  /**
536
539
  * Gameplay screenshots.
537
540
  */
538
- gameplay?: Image7[];
541
+ gameplay?: Image4[];
539
542
  /**
540
543
  * Path to the manual (PDF, image, html or text).
541
544
  */
@@ -753,21 +756,7 @@ export interface Image3 {
753
756
  alt?: string;
754
757
  }
755
758
  /**
756
- * An image of physical media (cartridge, disc, tape, etc.).
757
- */
758
- export interface PhysicalMediaImage {
759
- /**
760
- * Path to the physical media image file.
761
- */
762
- file: string;
763
- /**
764
- * Alternative text describing the image for accessibility.
765
- */
766
- alt?: string;
767
- type?: MediaType;
768
- }
769
- /**
770
- * Logo/wordmark with transparent background.
759
+ * An image file with optional alt text for accessibility.
771
760
  */
772
761
  export interface Image4 {
773
762
  /**
@@ -780,7 +769,7 @@ export interface Image4 {
780
769
  alt?: string;
781
770
  }
782
771
  /**
783
- * Widescreen background artwork for TV/big screen interfaces. Should be free of text or logos.
772
+ * An image file with optional alt text for accessibility.
784
773
  */
785
774
  export interface Image5 {
786
775
  /**
@@ -793,7 +782,7 @@ export interface Image5 {
793
782
  alt?: string;
794
783
  }
795
784
  /**
796
- * Title screen screenshot.
785
+ * An image file with optional alt text for accessibility.
797
786
  */
798
787
  export interface Image6 {
799
788
  /**