@zthun/romulator-client 1.7.1 → 1.10.0

package/dist/system/system-id.d.mts

@@ -4,15 +4,12 @@
 export declare enum ZRomulatorSystemId {
     ThreeDo = "3do",
     Adam = "adam",
-    AGS = "ags",
     Amiga = "amiga",
     Amiga1200 = "amiga1200",
     Amiga600 = "amiga600",
     AmigaCd32 = "amigacd32",
     AmstradCpc = "amstradcpc",
     Android = "android",
-    AndroidApps = "androidapps",
-    AndroidGames = "androidgames",
     Apple2 = "apple2",
     Apple2Gs = "apple2gs",
     Arcade = "arcade",
@@ -28,37 +25,29 @@ export declare enum ZRomulatorSystemId {
     AtariJaguarCd = "atarijaguarcd",
     AtariLynx = "atarilynx",
     AtariSt = "atarist",
-    AtariXe = "atarixe",
     Atomiswave = "atomiswave",
     BbcMicro = "bbcmicro",
     C64 = "c64",
     CdiMono1 = "cdimono1",
     Cdtv = "cdtv",
-    ChaiLove = "chailove",
     ChannelF = "channelf",
     Coco = "coco",
     Colecovision = "colecovision",
-    ConsoleArcade = "consolearcade",
     Cps = "cps",
     Cps1 = "cps1",
     Cps2 = "cps2",
     Cps3 = "cps3",
     CrVision = "crvision",
     Daphne = "daphne",
-    Desktop = "desktop",
-    Doom = "doom",
     Dos = "dos",
     Dragon32 = "dragon32",
     Dreamcast = "dreamcast",
     EasyRpg = "easyrpg",
     Electron = "electron",
-    Emulators = "emulators",
-    Epic = "epic",
     Famicom = "famicom",
     FBA = "fba",
     FBNeo = "fbneo",
     FDS = "fds",
-    Flash = "flash",
     FM7 = "fm7",
     FMTowns = "fmtowns",
     FPinball = "fpinball",
@@ -74,12 +63,7 @@ export declare enum ZRomulatorSystemId {
     GMaster = "gmaster",
     GX4000 = "gx4000",
     Intellivision = "intellivision",
-    J2ME = "j2me",
-    Kodi = "kodi",
-    Laserdisc = "laserdisc",
-    LcdGames = "lcdgames",
     LowResNx = "lowresnx",
-    Lutris = "lutris",
     Lutro = "lutro",
     Macintosh = "macintosh",
     Mame = "mame",
@@ -87,20 +71,16 @@ export declare enum ZRomulatorSystemId {
     Mark3 = "mark3",
     MasterSystem = "mastersystem",
     MegaCd = "megacd",
-    MegaCdJp = "megacdjp",
     MegaDrive = "megadrive",
     MegaDriveJp = "megadrivejp",
     MegaDuck = "megaduck",
     MESS = "mess",
     Model2 = "model2",
     Model3 = "model3",
-    Moto = "moto",
     MSX = "msx",
     MSX1 = "msx1",
     MSX2 = "msx2",
     MSXTurbor = "msxturbor",
-    Mugen = "mugen",
-    Multivision = "multivision",
     N3DS = "n3ds",
     Nintendo64 = "n64",
     N64DD = "n64dd",
@@ -122,14 +102,12 @@ export declare enum ZRomulatorSystemId {
     PC = "pc",
     PC88 = "pc88",
     PC98 = "pc98",
-    PcArcade = "pcarcade",
     PcEngine = "pcengine",
     PcEngineCd = "pcenginecd",
     PCFx = "pcfx",
     Pico8 = "pico8",
     Plus4 = "plus4",
     PokeMini = "pokemini",
-    Ports = "ports",
     PS2 = "ps2",
     PS3 = "ps3",
     PS4 = "ps4",
@@ -137,7 +115,6 @@ export declare enum ZRomulatorSystemId {
     PSVita = "psvita",
     PSX = "psx",
     PV1000 = "pv1000",
-    Quake = "quake",
     SamCoupe = "samcoupe",
     Satellaview = "satellaview",
     Saturn = "saturn",
@@ -145,31 +122,23 @@ export declare enum ZRomulatorSystemId {
     ScummVM = "scummvm",
     SCV = "scv",
     Sega32X = "sega32x",
-    Sega32XJp = "sega32xjp",
-    Sega32XNa = "sega32xna",
     SegaCd = "segacd",
-    SFC = "sfc",
     Sg1000 = "sg-1000",
     SGB = "sgb",
     SuperNintendo = "snes",
-    SnesNa = "snesna",
     Solarus = "solarus",
     SpectraVideo = "spectravideo",
-    Steam = "steam",
     STV = "stv",
     Sufami = "sufami",
     SuperGrafx = "supergrafx",
     SuperVision = "supervision",
     SupraCan = "supracan",
     Switch = "switch",
-    Symbian = "symbian",
-    TanoDragon = "tanodragon",
     TgCd = "tg-cd",
     TG16 = "tg16",
     TI99 = "ti99",
     TIC80 = "tic80",
     TO8 = "to8",
-    Triforce = "triforce",
     TRS80 = "trs-80",
     TypeX = "type-x",
     Uzebox = "uzebox",
@@ -195,7 +164,6 @@ export declare enum ZRomulatorSystemId {
     XboxOne = "xboxone",
     ZMachine = "zmachine",
     Zx81 = "zx81",
-    ZxNext = "zxnext",
     ZxSpectrum = "zxspectrum"
 }
 /**

package/dist/system/system-media-format-type.d.mts

@@ -0,0 +1,23 @@
+/**
+ * The type of media a system supports.
+ */
+export declare enum ZRomulatorSystemMediaFormatType {
+    /**
+     * Cartridge based systems.
+     */
+    Cartridge = "cartridge",
+    /**
+     * Motherboard based systems.
+     *
+     * Usually for arcades.
+     */
+    Pcb = "pcb",
+    /**
+     * CD/DVD based systems.
+     */
+    Cd = "cd",
+    /**
+     * Floppy disk based systems.
+     */
+    FloppyDisk = "floppy-disk"
+}

package/dist/system/system.d.mts

@@ -1,5 +1,7 @@
+import { ZRomulatorSystemContentType } from './system-content-type.mjs';
+import { ZRomulatorSystemHardwareType } from './system-hardware-type.mjs';
 import { ZRomulatorSystemId } from './system-id.mjs';
-import { ZRomulatorSystemType } from './system-type.mjs';
+import { ZRomulatorSystemMediaFormatType } from './system-media-format-type.mjs';
 /**
  * Represents a system in romulator.
  *
@@ -12,12 +14,18 @@ export interface IZRomulatorSystem {
      * Unique identifier for the system.
      *
      * If you think about the directory structure
-     * for ES-DE, for example, the id would map to
-     * the name of the system directory.
+     * for ES-DE or retro-pie, for example, the id
+     * would map to the name of the system directory.
      *
      * This is essentially a slug.
      */
     id: ZRomulatorSystemId;
+    /**
+     * The list of file extensions that system supports.
+     *
+     * Extensions, zip and 7z, should always be in this list.
+     */
+    extensions: string[];
     /**
      * The canonical name of the system.
      *
@@ -27,13 +35,41 @@ export interface IZRomulatorSystem {
      */
     name?: string;
     /**
-     * The generational index of the system.
+     * The company that published the system.
      */
-    generation?: number;
+    company?: string;
     /**
-     * The type of system.
+     * Type classifications for the system.
      */
-    type?: ZRomulatorSystemType;
+    classification?: {
+        /**
+         * What type of system the hardware is.
+         *
+         * @example 'console'
+         */
+        hardwareType?: ZRomulatorSystemHardwareType;
+        /**
+         * The type of media format.
+         */
+        mediaFormat?: ZRomulatorSystemMediaFormatType;
+        /**
+         * The digital format of the game media.
+         */
+        contentType?: ZRomulatorSystemContentType;
+    };
+    /**
+     * The years the system was in production until.
+     */
+    productionYears?: {
+        /**
+         * The first year the system went into production.
+         */
+        start?: number;
+        /**
+         * The year when production stopped.
+         */
+        end?: number;
+    };
 }
 /**
  * A builder for creating an IZRomulatorSystem.
@@ -45,6 +81,7 @@ export declare class ZRomulatorSystemBuilder {
      *
      * @param id -
      *        The unique identifier for the system.
+     *
      * @returns
      *        This instance.
      */
@@ -54,70 +91,83 @@ export declare class ZRomulatorSystemBuilder {
      *
      * @param name -
      *        The canonical name of the system.
+     *
      * @returns
      *        This instance.
      */
     name(name: string): this;
     /**
-     * Sets the system type.
+     * Sets the company that published the system.
+     *
+     * @param name -
+     *        The name of the company.
      *
-     * @param type -
-     *        The type of system.
      * @returns
      *        This instance.
      */
-    type(type: ZRomulatorSystemType): this;
+    company(name: string): this;
     /**
-     * Sets the system type to console.
+     * Sets the system hardware type.
+     *
+     * @param type -
+     *        The system hardware type.
      *
      * @returns
      *        This instance.
      */
-    console: () => this;
+    hardware(type: ZRomulatorSystemHardwareType): this;
     /**
-     * Sets the system type to handheld.
+     * Sets the system media format.
+     *
+     * @param type -
+     *        The system media format.
      *
      * @returns
      *        This instance.
      */
-    handheld: () => this;
+    mediaFormat(type: ZRomulatorSystemMediaFormatType): this;
     /**
-     * Sets the system type to arcade.
+     * Sets the system content type.
+     *
+     * @param type -
+     *        The system content type.
      *
      * @returns
      *        This instance.
      */
-    arcade: () => this;
+    contentType(type: ZRomulatorSystemContentType): this;
     /**
-     * Sets the system type to computer.
+     * Sets the production run.
+     *
+     * @param start -
+     *        The starting year of production.
+     * @param end -
+     *        The last year of production.
      *
      * @returns
-     *        This instance.
+     *        This object.
      */
-    computer: () => this;
+    production(start: number, end?: number): this;
     /**
-     * Sets the generational index of the system.
+     * Adds to the extension list.
+     *
+     * @param extension -
+     *        The extension or list of extensions to add.
      *
-     * @param generation -
-     *        The generational index of the system.
      * @returns
-     *        This instance.
+     *        This object.
      */
-    generation(generation: number): this;
+    extension(extension: string | string[]): this;
     /**
-     * Assigns system data to this system.
+     * Parses an unknown object to try and build a system from it.
      *
-     * @param system -
-     *        The partial system data to assign.
+     * @param candidate -
+     *        The candidate to try and parse.
      *
      * @returns
      *        This object.
      */
-    assign(system: Partial<IZRomulatorSystem>): this;
-    /**
-     * Removes anything that is not a valid property on this object.
-     */
-    redact(): this;
+    parse(candidate: unknown): this;
     /**
      * Builds the system instance.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/romulator-client",
-  "version": "1.7.1",
+  "version": "1.10.0",
   "description": "A client for declaring models and invoking the romulator api",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -25,21 +25,21 @@
     "access": "public"
   },
   "dependencies": {
-    "@zthun/helpful-fn": "^9.6.0",
-    "@zthun/helpful-query": "^9.7.1",
+    "@zthun/helpful-fn": "^9.8.0",
+    "@zthun/helpful-query": "^9.8.0",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@zthun/janitor-build-config": "^19.4.0",
+    "@zthun/janitor-build-config": "^19.4.1",
     "tsx": "^4.20.6",
     "typescript": "^5.9.3",
     "vite": "^7.1.11",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.1"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "0918366e9ee8dd282893990fbfcf1bf3e976202e"
+  "gitHead": "bad1143f9c40a8bd819117cb99bf2f1b58c005e6"
 }