@zthun/romulator-client 1.10.0 → 1.12.0

package/dist/game/game.d.mts

@@ -67,6 +67,17 @@ export declare class ZRomulatorGameBuilder {
      *        This instance.
      */
     system(system: ZRomulatorSystemId): 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: unknown): this;
     /**
      * Copies an existing game into this builder.
      *

package/dist/index.cjs

@@ -18,8 +18,20 @@ class ZRomulatorConfigGamesMetadata {
     }
 }
 
+function _define_property$4(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;
+}
 class ZRomulatorConfigGamesBuilder {
-    _config = {};
     gamesFolder(games) {
         this._config.gamesFolder = games;
         return this;
@@ -38,8 +50,24 @@ class ZRomulatorConfigGamesBuilder {
     build() {
         return structuredClone(this._config);
     }
+    constructor(){
+        _define_property$4(this, "_config", {});
+    }
 }
 
+function _define_property$3(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;
+}
 /**
  * Represents a list of known config ids
  */ var ZRomulatorConfigId = /*#__PURE__*/ function(ZRomulatorConfigId) {
@@ -52,11 +80,6 @@ class ZRomulatorConfigGamesBuilder {
     return ZRomulatorConfigId;
 }({});
 class ZRomulatorConfigBuilder {
-    _config = {
-        id: "games",
-        name: "",
-        file: ""
-    };
     id(id) {
         this._config.id = id;
         return this;
@@ -93,14 +116,31 @@ class ZRomulatorConfigBuilder {
     build() {
         return structuredClone(this._config);
     }
+    constructor(){
+        _define_property$3(this, "_config", {
+            id: "games",
+            name: "",
+            file: ""
+        });
+    }
 }
 
+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 {
-    _game = {
-        id: ""
-    };
     /**
    * Sets the unique id for the game.
    *
@@ -146,6 +186,25 @@ class ZRomulatorConfigBuilder {
         return 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;
+        }
+        const name = lodashEs.get(candidate, "name");
+        if (name != null && typeof name === "string") {
+            this.name(name);
+        }
+        return this;
+    }
+    /**
    * Copies an existing game into this builder.
    *
    * @param other -
@@ -165,6 +224,11 @@ class ZRomulatorConfigBuilder {
         const clone = structuredClone(this._game);
         return lodashEs.omitBy(clone, lodashEs.isUndefined);
     }
+    constructor(){
+        _define_property$2(this, "_game", {
+            id: ""
+        });
+    }
 }
 
 var ZRomulatorGameMediaType = /*#__PURE__*/ function(ZRomulatorGameMediaType) {
@@ -413,14 +477,34 @@ function isMediaType(candidate) {
 const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
 /**
  * Gets whether a candidate string represents a system id.
+ *
+ * This check is case sensitive.
+ *
+ * @param candidate -
+ *        The candidate to check.
+ *
+ * @returns
+ *        True if candidate is a string that represents a system id.
  */ function isSystemId(candidate) {
     return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemIdMap, candidate);
 }
 
+function _define_property$1(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 media object.
  */ class ZRomulatorMediaBuilder {
-    _media = {};
     id(id) {
         this._media.id = id;
         return this;
@@ -482,12 +566,18 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
         const clone = structuredClone(this._media);
         return lodashEs.omitBy(clone, lodashEs.isUndefined);
     }
+    constructor(){
+        _define_property$1(this, "_media", {});
+    }
 }
 
 /**
  * The type of media content for a system.
  */ var ZRomulatorSystemContentType = /*#__PURE__*/ function(ZRomulatorSystemContentType) {
     /**
+   * No idea
+   */ ZRomulatorSystemContentType["Unknown"] = "unknown";
+    /**
    * Uses memory roms.
    */ ZRomulatorSystemContentType["ReadOnlyMemory"] = "rom";
     /**
@@ -501,11 +591,28 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    */ ZRomulatorSystemContentType["Disk"] = "iso";
     return ZRomulatorSystemContentType;
 }({});
+const ZRomulatorSystemContentTypeMap = lodashEs.keyBy(Object.values(ZRomulatorSystemContentType));
+/**
+ * Gets whether a candidate string represents a system content type.
+ *
+ * This check is case sensitive.
+ *
+ * @param candidate -
+ *        The candidate to check.
+ *
+ * @returns
+ *        True if candidate is a string that represents a system content type.
+ */ function isSystemContentType(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemContentTypeMap, candidate);
+}
 
 /**
  * Describes the type of hardware a system is.
  */ var ZRomulatorSystemHardwareType = /*#__PURE__*/ function(ZRomulatorSystemHardwareType) {
     /**
+   * No idea what this is.
+   */ ZRomulatorSystemHardwareType["Unknown"] = "unknown";
+    /**
    * An accessory that attaches to another system.
    */ ZRomulatorSystemHardwareType["Accessory"] = "accessory";
     /**
@@ -534,37 +641,74 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    */ ZRomulatorSystemHardwareType["VirtualMachine"] = "virtual-machine";
     return ZRomulatorSystemHardwareType;
 }({});
+const ZRomulatorSystemHardwareTypeMap = lodashEs.keyBy(Object.values(ZRomulatorSystemHardwareType));
+/**
+ * Gets whether a candidate string represents a system hardware type.
+ *
+ * This check is case sensitive.
+ *
+ * @param candidate -
+ *        The candidate to check.
+ *
+ * @returns
+ *        True if candidate is a string that represents a system hardware type.
+ */ function isSystemHardwareType(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemHardwareTypeMap, candidate);
+}
 
 /**
  * The type of media a system supports.
- */ var ZRomulatorSystemMediaFormatType = /*#__PURE__*/ function(ZRomulatorSystemMediaFormatType) {
+ */ var ZRomulatorSystemMediaFormat = /*#__PURE__*/ function(ZRomulatorSystemMediaFormat) {
+    /**
+   * No idea
+   */ ZRomulatorSystemMediaFormat["Unknown"] = "unknown";
     /**
    * Cartridge based systems.
-   */ ZRomulatorSystemMediaFormatType["Cartridge"] = "cartridge";
+   */ ZRomulatorSystemMediaFormat["Cartridge"] = "cartridge";
     /**
    * Motherboard based systems.
    *
    * Usually for arcades.
-   */ ZRomulatorSystemMediaFormatType["Pcb"] = "pcb";
+   */ ZRomulatorSystemMediaFormat["Pcb"] = "pcb";
     /**
    * CD/DVD based systems.
-   */ ZRomulatorSystemMediaFormatType["Cd"] = "cd";
+   */ ZRomulatorSystemMediaFormat["Cd"] = "cd";
     /**
    * Floppy disk based systems.
-   */ ZRomulatorSystemMediaFormatType["FloppyDisk"] = "floppy-disk";
-    return ZRomulatorSystemMediaFormatType;
+   */ ZRomulatorSystemMediaFormat["FloppyDisk"] = "floppy-disk";
+    return ZRomulatorSystemMediaFormat;
 }({});
+const ZRomulatorSystemMediaFormatMap = lodashEs.keyBy(Object.values(ZRomulatorSystemMediaFormat));
+/**
+ * Gets whether a candidate string represents a system media format.
+ *
+ * This check is case sensitive.
+ *
+ * @param candidate -
+ *        The candidate to check.
+ *
+ * @returns
+ *        True if candidate is a string that represents a system media format.
+ */ function isSystemMediaFormat(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemMediaFormatMap, candidate);
+}
 
+function _define_property(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 creating an IZRomulatorSystem.
  */ class ZRomulatorSystemBuilder {
-    _system = {
-        id: ZRomulatorSystemId.Nintendo,
-        extensions: [
-            "zip",
-            "7z"
-        ]
-    };
     /**
    * Sets the id (slug) of the system.
    *
@@ -610,7 +754,6 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    * @returns
    *        This instance.
    */ hardware(type) {
-        this._system.classification = helpfulFn.firstDefined({}, this._system.classification);
         this._system.classification.hardwareType = type;
         return this;
     }
@@ -623,7 +766,6 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    * @returns
    *        This instance.
    */ mediaFormat(type) {
-        this._system.classification = helpfulFn.firstDefined({}, this._system.classification);
         this._system.classification.mediaFormat = type;
         return this;
     }
@@ -636,12 +778,37 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    * @returns
    *        This instance.
    */ contentType(type) {
-        this._system.classification = helpfulFn.firstDefined({}, this._system.classification);
         this._system.classification.contentType = type;
         return this;
     }
     /**
-   * Sets the production run.
+   * Sets the production start value.
+   *
+   * @param start -
+   *        The year the system was released into production.
+   *        Use '?' if you do not know this information.
+   *
+   * @returns
+   *        This object.
+   */ productionStart(start) {
+        this._system.productionYears.start = start;
+        return this;
+    }
+    /**
+   * Sets the production end of life value.
+   *
+   * @param end -
+   *        The end of life year.  Set to current
+   *        to mark no end of life.
+   *
+   * @returns
+   *        This object.
+   */ productionEnd(end) {
+        this._system.productionYears.end = end;
+        return this;
+    }
+    /**
+   * Sets the full production run.
    *
    * @param start -
    *        The starting year of production.
@@ -650,14 +817,8 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    *
    * @returns
    *        This object.
-   */ production(start, end) {
-        delete this._system.productionYears;
-        this._system.productionYears = {
-            start,
-            end
-        };
-        this._system.productionYears = lodashEs.omitBy(this._system.productionYears, lodashEs.isUndefined);
-        return this;
+   */ production(start = "?", end = "current") {
+        return this.productionStart(start).productionEnd(end);
     }
     /**
    * Adds to the extension list.
@@ -672,6 +833,50 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
         this._system.extensions = lodashEs.uniqBy(extensions.concat(extension), lodashEs.upperCase).map((e)=>e.toLowerCase());
         return this;
     }
+    parseId(candidate) {
+        const id = lodashEs.get(candidate, "id");
+        return isSystemId(id) ? this.id(id) : this;
+    }
+    parseName(candidate) {
+        const name = lodashEs.get(candidate, "name");
+        return name != null && typeof name === "string" ? this.name(name) : this;
+    }
+    parseCompany(candidate) {
+        const company = lodashEs.get(candidate, "company");
+        return company != null && typeof company === "string" ? this.company(company) : this;
+    }
+    parseExtensions(candidate) {
+        const extensions = lodashEs.castArray(lodashEs.get(candidate, "extensions")).filter((ext)=>ext != null).filter((ext)=>typeof ext === "string");
+        return this.extension(extensions);
+    }
+    parseHardwareType(classification) {
+        const hardwareType = lodashEs.get(classification, "hardwareType");
+        return isSystemHardwareType(hardwareType) ? this.hardware(hardwareType) : this;
+    }
+    parseMediaFormat(classification) {
+        const mediaFormat = lodashEs.get(classification, "mediaFormat");
+        return isSystemMediaFormat(mediaFormat) ? this.mediaFormat(mediaFormat) : this;
+    }
+    parseContentType(classification) {
+        const contentType = lodashEs.get(classification, "contentType");
+        return isSystemContentType(contentType) ? this.contentType(contentType) : this;
+    }
+    parseClassification(candidate) {
+        const classification = lodashEs.get(candidate, "classification");
+        return classification != null && typeof classification === "object" ? this.parseHardwareType(classification).parseMediaFormat(classification).parseContentType(classification) : this;
+    }
+    parseProductionStart(productionYears) {
+        const start = lodashEs.get(productionYears, "start");
+        return typeof start === "number" || start === "?" ? this.productionStart(start) : this;
+    }
+    parseProductionEnd(productionYears) {
+        const end = lodashEs.get(productionYears, "end");
+        return typeof end === "number" || end === "current" ? this.productionEnd(end) : this;
+    }
+    parseProductionYears(candidate) {
+        const production = lodashEs.get(candidate, "productionYears");
+        return production != null && typeof production === "object" ? this.parseProductionStart(production).parseProductionEnd(production) : this;
+    }
     /**
    * Parses an unknown object to try and build a system from it.
    *
@@ -684,20 +889,8 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
         if (candidate == null || typeof candidate !== "object") {
             return this;
         }
-        const id = lodashEs.get(candidate, "id");
-        const name = lodashEs.get(candidate, "name");
-        const company = lodashEs.get(candidate, "company");
-        const extensions = lodashEs.castArray(lodashEs.get(candidate, "extensions")).filter((ext)=>ext != null).filter((ext)=>typeof ext === "string");
-        if (isSystemId(id)) {
-            this.id(id);
-        }
-        if (name != null && typeof name === "string") {
-            this.name(name);
-        }
-        if (company != null && typeof company === "string") {
-            this.company(company);
-        }
-        return this.extension(extensions);
+        this.parseId(candidate).parseName(candidate).parseCompany(candidate).parseExtensions(candidate).parseClassification(candidate).parseProductionYears(candidate);
+        return this;
     }
     /**
    * Builds the system instance.
@@ -708,6 +901,26 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
    */ build() {
         return structuredClone(this._system);
     }
+    constructor(){
+        _define_property(this, "_system", {
+            id: ZRomulatorSystemId.Nintendo,
+            name: "",
+            classification: {
+                hardwareType: ZRomulatorSystemHardwareType.Unknown,
+                mediaFormat: ZRomulatorSystemMediaFormat.Unknown,
+                contentType: ZRomulatorSystemContentType.Unknown
+            },
+            company: "",
+            productionYears: {
+                start: "?",
+                end: "current"
+            },
+            extensions: [
+                "zip",
+                "7z"
+            ]
+        });
+    }
 }
 
 exports.ZRomulatorConfigBuilder = ZRomulatorConfigBuilder;
@@ -721,10 +934,13 @@ exports.ZRomulatorSystemBuilder = ZRomulatorSystemBuilder;
 exports.ZRomulatorSystemContentType = ZRomulatorSystemContentType;
 exports.ZRomulatorSystemHardwareType = ZRomulatorSystemHardwareType;
 exports.ZRomulatorSystemId = ZRomulatorSystemId;
-exports.ZRomulatorSystemMediaFormatType = ZRomulatorSystemMediaFormatType;
+exports.ZRomulatorSystemMediaFormat = ZRomulatorSystemMediaFormat;
 exports.ZRomulatorSystemMediaType = ZRomulatorSystemMediaType;
 exports.isGameMediaType = isGameMediaType;
 exports.isMediaType = isMediaType;
+exports.isSystemContentType = isSystemContentType;
+exports.isSystemHardwareType = isSystemHardwareType;
 exports.isSystemId = isSystemId;
+exports.isSystemMediaFormat = isSystemMediaFormat;
 exports.isSystemMediaType = isSystemMediaType;
 //# sourceMappingURL=index.cjs.map