@zthun/romulator-client 1.16.0 → 1.17.0

package/dist/game/game.d.mts

@@ -1,3 +1,4 @@
+import { IZRomulatorPlayers } from '../players/players.mjs';
 import { ZRomulatorSystemId } from '../system/system-id.mjs';
 /**
  * Represents a rom file or image.
@@ -16,15 +17,35 @@ export interface IZRomulatorGame {
      * Battletoads and Double Dragon has the same name
      * across 3 different systems.
      */
-    name?: string;
+    name: string;
     /**
      * The fully qualified path to the game file.
      */
-    file?: string;
+    file: string;
     /**
      * The system id that this game belongs to.
      */
-    system?: ZRomulatorSystemId;
+    system: ZRomulatorSystemId;
+    /**
+     * The date the game was released.
+     */
+    release: string;
+    /**
+     * The developer studio.
+     */
+    developer: string;
+    /**
+     * The publisher studio.
+     */
+    publisher: string;
+    /**
+     * The game description.
+     */
+    description: string;
+    /**
+     * The player information.
+     */
+    players: IZRomulatorPlayers;
 }
 /**
  * A builder for the IZRomulatorGame model.
@@ -67,6 +88,57 @@ export declare class ZRomulatorGameBuilder {
      *        This instance.
      */
     system(system: ZRomulatorSystemId): this;
+    /**
+     * Sets the release date for the game.
+     *
+     * @param release -
+     *        The release information for the game.
+     * @returns
+     *        This instance.
+     */
+    release(release: string): this;
+    /**
+     * Sets the developer studio for the game.
+     *
+     * @param developer -
+     *        The developer name.
+     * @returns
+     *        This instance.
+     */
+    developer(developer: string): this;
+    /**
+     * Sets the publisher studio for the game.
+     *
+     * @param publisher -
+     *        The publisher name.
+     * @returns
+     *        This instance.
+     */
+    publisher(publisher: string): this;
+    /**
+     * Sets the description for the game.
+     *
+     * @param description -
+     *        The game description.
+     * @returns
+     *        This instance.
+     */
+    description(description: string): this;
+    /**
+     * Sets the player configuration for the game.
+     *
+     * @param players -
+     *        The player configuration.
+     * @returns
+     *        This instance.
+     */
+    players(players: IZRomulatorPlayers): this;
+    private parseDeveloper;
+    private parsePublisher;
+    private parseReleaseDate;
+    private parsePlayers;
+    private parseDescription;
+    private parseName;
     /**
      * Attempts to parse a game from a game entry in a system.json game
      * list.

package/dist/index.cjs

@@ -18,7 +18,7 @@ class ZRomulatorConfigGamesMetadata {
     }
 }
 
-function _define_property$4(obj, key, value) {
+function _define_property$5(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -51,11 +51,11 @@ class ZRomulatorConfigGamesBuilder {
         return structuredClone(this._config);
     }
     constructor(){
-        _define_property$4(this, "_config", {});
+        _define_property$5(this, "_config", {});
     }
 }
 
-function _define_property$3(obj, key, value) {
+function _define_property$4(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -117,7 +117,7 @@ class ZRomulatorConfigBuilder {
         return structuredClone(this._config);
     }
     constructor(){
-        _define_property$3(this, "_config", {
+        _define_property$4(this, "_config", {
             id: "games",
             name: "",
             file: ""
@@ -125,7 +125,7 @@ class ZRomulatorConfigBuilder {
     }
 }
 
-function _define_property$2(obj, key, value) {
+function _define_property$3(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -139,58 +139,48 @@ function _define_property$2(obj, key, value) {
     return obj;
 }
 /**
- * A builder for the IZRomulatorGame model.
- */ class ZRomulatorGameBuilder {
+ * Creates player range instances
+ */ class ZRomulatorPlayersBuilder {
     /**
-   * Sets the unique id for the game.
+   * Sets the minimum supported players.
    *
-   * @param id -
-   *        The unique identifier across all games and systems.
-   * @returns
-   *        This instance.
-   */ id(id) {
-        this._game.id = id;
-        return this;
-    }
-    /**
-   * Sets the display name for the game.
+   * @param players -
+   *        Minimum number of players.
    *
-   * @param name -
-   *        The canonical display name for the game.
    * @returns
-   *        This instance.
-   */ name(name) {
-        this._game.name = name;
+   *        This object.
+   */ min(players) {
+        this._players.min = players;
         return this;
     }
     /**
-   * Sets the file path for the rom.
+   * Sets the maximum supported players.
    *
-   * @param path -
-   *        The fully qualified path to the game file.
-   * @returns
-   *        This instance.
-   */ file(path) {
-        this._game.file = path;
-        return this;
-    }
-    /**
-   * Sets the system the game belongs to.
+   * @param players -
+   *        Maximum number of players.
    *
-   * @param system -
-   *        The owning system id.
    * @returns
-   *        This instance.
-   */ system(system) {
-        this._game.system = system;
+   *        This object.
+   */ max(players) {
+        this._players.max = players;
         return this;
     }
+    range(min, max) {
+        return this.min(min).max(max);
+    }
+    parseMax(candidate) {
+        const max = lodashEs.get(candidate, "max");
+        return typeof max === "number" ? this.max(max) : this;
+    }
+    parseMin(candidate) {
+        const min = lodashEs.get(candidate, "min");
+        return typeof min === "number" ? this.min(min) : this;
+    }
     /**
-   * Attempts to parse a game from a game entry in a system.json game
-   * list.
+   * Attempts to read player range values from an arbitrary candidate.
    *
    * @param candidate -
-   *        The candidate to parse.
+   *        Source object to inspect.
    *
    * @returns
    *        This object.
@@ -198,101 +188,58 @@ function _define_property$2(obj, key, value) {
         if (candidate == null || typeof candidate !== "object") {
             return this;
         }
-        const name = lodashEs.get(candidate, "name");
-        if (name != null && typeof name === "string") {
-            this.name(name);
-        }
-        return this;
+        return this.parseMin(candidate).parseMax(candidate);
     }
     /**
-   * Copies an existing game into this builder.
+   * Copies an existing player range into this builder.
    *
    * @param other -
-   *        The other game to copy.
+   *        Players object to duplicate.
+   *
    * @returns
-   *        This instance.
+   *        This object
    */ copy(other) {
-        this._game = structuredClone(other);
+        this._players = structuredClone(other);
         return this;
     }
     /**
-   * Builds the game instance.
+   * Creates the final player range instance.
    *
    * @returns
-   *        A structured clone of the current game with undefined properties removed.
+   *        A cloned IZRomulatorPlayers instance.
    */ build() {
-        const clone = structuredClone(this._game);
-        return lodashEs.omitBy(clone, lodashEs.isUndefined);
+        return structuredClone(this._players);
     }
     constructor(){
-        _define_property$2(this, "_game", {
-            id: ""
+        _define_property$3(this, "_players", {
+            min: 1,
+            max: 1
         });
-    }
-}
-
-var ZRomulatorGameMediaType = /*#__PURE__*/ function(ZRomulatorGameMediaType) {
-    /**
-   * A 3d representation of the box art.
-   */ ZRomulatorGameMediaType["Box3d"] = "3dboxes";
-    /**
-   * Back of the game box.
-   */ ZRomulatorGameMediaType["BackCover"] = "backcovers";
-    /**
-   * Front of the game box.
-   */ ZRomulatorGameMediaType["Cover"] = "covers";
-    /**
-   * Fan art.
-   */ ZRomulatorGameMediaType["FanArt"] = "fanart";
-    /**
-   * Game manual.
-   */ ZRomulatorGameMediaType["Manual"] = "manuals";
-    /**
-   * A marquee of a game.
-   */ ZRomulatorGameMediaType["Marquee"] = "marquees";
-    /**
-   * The cartridge or disc label.
-   */ ZRomulatorGameMediaType["PhysicalMedia"] = "physicalmedia";
-    /**
-   * An in game screenshot showcasing gameplay.
-   */ ZRomulatorGameMediaType["Screenshot"] = "screenshots";
-    /**
-   * An in game screenshot of the title screen.
-   */ ZRomulatorGameMediaType["Title"] = "titlescreens";
-    /**
-   * A video showcasing the game.
-   */ ZRomulatorGameMediaType["Video"] = "videos";
-    return ZRomulatorGameMediaType;
-}({});
-/**
- * Media type for a system.
- */ var ZRomulatorSystemMediaType = /*#__PURE__*/ function(ZRomulatorSystemMediaType) {
-    /**
-   * An image of a system's controller.
-   */ ZRomulatorSystemMediaType["Controller"] = "controller";
-    /**
-   * A picture of the system.
+        /**
+   * Sets the player count to 1 player for both min and max.
    *
-   * These are real life looking photos of what
-   * a system looks like.
-   */ ZRomulatorSystemMediaType["Picture"] = "picture";
-    /**
-   * A wheel for a system.
+   * @returns
+   *        This object.
+   */ _define_property$3(this, "singlePlayer", this.range.bind(this, 1, 1));
+        /**
+   * Sets the player count to 2 for max and 1 for min.
    *
-   * This is basically the logo.
-   */ ZRomulatorSystemMediaType["Wheel"] = "wheel";
-    return ZRomulatorSystemMediaType;
-}({});
-const ZRomulatorSystemMediaTypeMap = lodashEs.keyBy(Object.values(ZRomulatorSystemMediaType));
-const ZRomulatorGameMediaTypeMap = lodashEs.keyBy(Object.values(ZRomulatorGameMediaType));
-function isSystemMediaType(candidate) {
-    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemMediaTypeMap, candidate);
-}
-function isGameMediaType(candidate) {
-    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorGameMediaTypeMap, candidate);
-}
-function isMediaType(candidate) {
-    return isSystemMediaType(candidate) || isGameMediaType(candidate);
+   * @returns
+   *        This object.
+   */ _define_property$3(this, "twoPlayer", this.range.bind(this, 1, 2));
+        /**
+   * Sets the player count to 4 for max and 1 for min.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$3(this, "fourPlayer", this.range.bind(this, 1, 4));
+        /**
+   * Sets the player count to 8 for max and 1 for min.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$3(this, "eightPlayer", this.range.bind(this, 1, 8));
+    }
 }
 
 /**
@@ -478,6 +425,259 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
     return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemIdMap, candidate);
 }
 
+function _define_property$2(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+/**
+ * A builder for the IZRomulatorGame model.
+ */ class ZRomulatorGameBuilder {
+    /**
+   * Sets the unique id for the game.
+   *
+   * @param id -
+   *        The unique identifier across all games and systems.
+   * @returns
+   *        This instance.
+   */ id(id) {
+        this._game.id = id;
+        return this;
+    }
+    /**
+   * Sets the display name for the game.
+   *
+   * @param name -
+   *        The canonical display name for the game.
+   * @returns
+   *        This instance.
+   */ name(name) {
+        this._game.name = name;
+        return this;
+    }
+    /**
+   * Sets the file path for the rom.
+   *
+   * @param path -
+   *        The fully qualified path to the game file.
+   * @returns
+   *        This instance.
+   */ file(path) {
+        this._game.file = path;
+        return this;
+    }
+    /**
+   * Sets the system the game belongs to.
+   *
+   * @param system -
+   *        The owning system id.
+   * @returns
+   *        This instance.
+   */ system(system) {
+        this._game.system = system;
+        return this;
+    }
+    /**
+   * Sets the release date for the game.
+   *
+   * @param release -
+   *        The release information for the game.
+   * @returns
+   *        This instance.
+   */ release(release) {
+        this._game.release = release;
+        return this;
+    }
+    /**
+   * Sets the developer studio for the game.
+   *
+   * @param developer -
+   *        The developer name.
+   * @returns
+   *        This instance.
+   */ developer(developer) {
+        this._game.developer = developer;
+        return this;
+    }
+    /**
+   * Sets the publisher studio for the game.
+   *
+   * @param publisher -
+   *        The publisher name.
+   * @returns
+   *        This instance.
+   */ publisher(publisher) {
+        this._game.publisher = publisher;
+        return this;
+    }
+    /**
+   * Sets the description for the game.
+   *
+   * @param description -
+   *        The game description.
+   * @returns
+   *        This instance.
+   */ description(description) {
+        this._game.description = description;
+        return this;
+    }
+    /**
+   * Sets the player configuration for the game.
+   *
+   * @param players -
+   *        The player configuration.
+   * @returns
+   *        This instance.
+   */ players(players) {
+        this._game.players = new ZRomulatorPlayersBuilder().copy(players).build();
+        return this;
+    }
+    parseDeveloper(candidate) {
+        const developer = lodashEs.get(candidate, "developer");
+        return typeof developer === "string" ? this.developer(developer) : this;
+    }
+    parsePublisher(candidate) {
+        const publisher = lodashEs.get(candidate, "publisher");
+        return typeof publisher === "string" ? this.publisher(publisher) : this;
+    }
+    parseReleaseDate(candidate) {
+        const release = lodashEs.get(candidate, "release");
+        return typeof release == "string" ? this.release(release) : this;
+    }
+    parsePlayers(candidate) {
+        const players = lodashEs.get(candidate, "players");
+        return this.players(new ZRomulatorPlayersBuilder().copy(this._game.players).parse(players).build());
+    }
+    parseDescription(candidate) {
+        const description = lodashEs.get(candidate, "description");
+        return typeof description === "string" ? this.description(description) : this;
+    }
+    parseName(candidate) {
+        const name = lodashEs.get(candidate, "name");
+        return typeof name === "string" ? this.name(name) : this;
+    }
+    /**
+   * Attempts to parse a game from a game entry in a system.json game
+   * list.
+   *
+   * @param candidate -
+   *        The candidate to parse.
+   *
+   * @returns
+   *        This object.
+   */ parse(candidate) {
+        if (candidate == null || typeof candidate !== "object") {
+            return this;
+        }
+        return this.parseName(candidate).parseDescription(candidate).parsePlayers(candidate).parseReleaseDate(candidate).parseDeveloper(candidate).parsePublisher(candidate);
+    }
+    /**
+   * Copies an existing game into this builder.
+   *
+   * @param other -
+   *        The other game to copy.
+   * @returns
+   *        This instance.
+   */ copy(other) {
+        this._game = structuredClone(other);
+        return this;
+    }
+    /**
+   * Builds the game instance.
+   *
+   * @returns
+   *        A structured clone of the current game with undefined properties removed.
+   */ build() {
+        const clone = structuredClone(this._game);
+        return lodashEs.omitBy(clone, lodashEs.isUndefined);
+    }
+    constructor(){
+        _define_property$2(this, "_game", {
+            id: "",
+            name: "",
+            file: "",
+            system: ZRomulatorSystemId.Adam,
+            release: "",
+            description: "",
+            developer: "",
+            publisher: "",
+            players: new ZRomulatorPlayersBuilder().build()
+        });
+    }
+}
+
+var ZRomulatorGameMediaType = /*#__PURE__*/ function(ZRomulatorGameMediaType) {
+    /**
+   * A 3d representation of the box art.
+   */ ZRomulatorGameMediaType["Box3d"] = "3dboxes";
+    /**
+   * Back of the game box.
+   */ ZRomulatorGameMediaType["BackCover"] = "backcovers";
+    /**
+   * Front of the game box.
+   */ ZRomulatorGameMediaType["Cover"] = "covers";
+    /**
+   * Fan art.
+   */ ZRomulatorGameMediaType["FanArt"] = "fanart";
+    /**
+   * Game manual.
+   */ ZRomulatorGameMediaType["Manual"] = "manuals";
+    /**
+   * A marquee of a game.
+   */ ZRomulatorGameMediaType["Marquee"] = "marquees";
+    /**
+   * The cartridge or disc label.
+   */ ZRomulatorGameMediaType["PhysicalMedia"] = "physicalmedia";
+    /**
+   * An in game screenshot showcasing gameplay.
+   */ ZRomulatorGameMediaType["Screenshot"] = "screenshots";
+    /**
+   * An in game screenshot of the title screen.
+   */ ZRomulatorGameMediaType["Title"] = "titlescreens";
+    /**
+   * A video showcasing the game.
+   */ ZRomulatorGameMediaType["Video"] = "videos";
+    return ZRomulatorGameMediaType;
+}({});
+/**
+ * Media type for a system.
+ */ var ZRomulatorSystemMediaType = /*#__PURE__*/ function(ZRomulatorSystemMediaType) {
+    /**
+   * An image of a system's controller.
+   */ ZRomulatorSystemMediaType["Controller"] = "controller";
+    /**
+   * A picture of the system.
+   *
+   * These are real life looking photos of what
+   * a system looks like.
+   */ ZRomulatorSystemMediaType["Picture"] = "picture";
+    /**
+   * A wheel for a system.
+   *
+   * This is basically the logo.
+   */ ZRomulatorSystemMediaType["Wheel"] = "wheel";
+    return ZRomulatorSystemMediaType;
+}({});
+const ZRomulatorSystemMediaTypeMap = lodashEs.keyBy(Object.values(ZRomulatorSystemMediaType));
+const ZRomulatorGameMediaTypeMap = lodashEs.keyBy(Object.values(ZRomulatorGameMediaType));
+function isSystemMediaType(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemMediaTypeMap, candidate);
+}
+function isGameMediaType(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorGameMediaTypeMap, candidate);
+}
+function isMediaType(candidate) {
+    return isSystemMediaType(candidate) || isGameMediaType(candidate);
+}
+
 function _define_property$1(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -560,6 +760,21 @@ function _define_property$1(obj, key, value) {
     }
 }
 
+/**
+ * Represents a serializer for a players object.
+ *
+ * The serialized form of players is a single digit if min and max are equal, or
+ * a range string of #min-#max if they are different.
+ */ class ZRomulatorPlayersSerialize {
+    serialize(candidate) {
+        if (candidate == null) {
+            return undefined;
+        }
+        const { min, max } = candidate;
+        return min === max ? `${min}` : `${min}-${max}`;
+    }
+}
+
 /**
  * The type of media content for a system.
  */ var ZRomulatorSystemContentType = /*#__PURE__*/ function(ZRomulatorSystemContentType) {
@@ -921,6 +1136,8 @@ exports.ZRomulatorConfigId = ZRomulatorConfigId;
 exports.ZRomulatorGameBuilder = ZRomulatorGameBuilder;
 exports.ZRomulatorGameMediaType = ZRomulatorGameMediaType;
 exports.ZRomulatorMediaBuilder = ZRomulatorMediaBuilder;
+exports.ZRomulatorPlayersBuilder = ZRomulatorPlayersBuilder;
+exports.ZRomulatorPlayersSerialize = ZRomulatorPlayersSerialize;
 exports.ZRomulatorSystemBuilder = ZRomulatorSystemBuilder;
 exports.ZRomulatorSystemContentType = ZRomulatorSystemContentType;
 exports.ZRomulatorSystemHardwareType = ZRomulatorSystemHardwareType;