@zthun/romulator-client 1.2.0 → 1.3.0

package/dist/index.js

@@ -1,203 +1,67 @@
 import { ZMetadataBuilder } from '@zthun/helpful-query';
 import { firstDefined } from '@zthun/helpful-fn';
-import { castArray, uniq } from 'lodash-es';
+import { castArray, keyBy, kebabCase, omitBy, isUndefined, uniq } from 'lodash-es';
+import { sep, extname, basename } from 'node:path';
 
-function _class_call_check$4(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
+class ZRomulatorConfigGamesMetadata {
+    static all() {
+        return [
+            ZRomulatorConfigGamesMetadata.gamesFolder()
+        ];
     }
-}
-function _defineProperties$4(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
+    static gamesFolder() {
+        return new ZMetadataBuilder().id("games-folder").path("gamesFolder").name("Games Folder").fallback("${HOME}/Games").editable().file().build();
     }
 }
-function _create_class$4(Constructor, protoProps, staticProps) {
-    if (staticProps) _defineProperties$4(Constructor, staticProps);
-    return Constructor;
-}
-var ZRomulatorConfigGamesMetadata = /*#__PURE__*/ function() {
-    function ZRomulatorConfigGamesMetadata() {
-        _class_call_check$4(this, ZRomulatorConfigGamesMetadata);
-    }
-    _create_class$4(ZRomulatorConfigGamesMetadata, null, [
-        {
-            key: "all",
-            value: function all() {
-                return [
-                    ZRomulatorConfigGamesMetadata.gamesFolder()
-                ];
-            }
-        },
-        {
-            key: "gamesFolder",
-            value: function gamesFolder() {
-                return new ZMetadataBuilder().id("games-folder").path("gamesFolder").name("Games Folder").fallback("${HOME}/Games").editable().file().build();
-            }
-        }
-    ]);
-    return ZRomulatorConfigGamesMetadata;
-}();
 
-function _class_call_check$3(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
+class ZRomulatorConfigGamesBuilder {
+    _config = {};
+    gamesFolder(games) {
+        this._config.gamesFolder = games;
+        return this;
     }
-}
-function _defineProperties$3(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
+    copy(other) {
+        this._config = structuredClone(other);
+        return this;
     }
-}
-function _create_class$3(Constructor, protoProps, staticProps) {
-    if (protoProps) _defineProperties$3(Constructor.prototype, protoProps);
-    return Constructor;
-}
-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;
-}
-function _object_spread(target) {
-    for(var i = 1; i < arguments.length; i++){
-        var source = arguments[i] != null ? arguments[i] : {};
-        var ownKeys = Object.keys(source);
-        if (typeof Object.getOwnPropertySymbols === "function") {
-            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
-                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
-            }));
-        }
-        ownKeys.forEach(function(key) {
-            _define_property$2(target, key, source[key]);
-        });
+    assign(other) {
+        this._config = {
+            ...this._config,
+            ...other
+        };
+        return this;
+    }
+    build() {
+        return structuredClone(this._config);
     }
-    return target;
 }
-var ZRomulatorConfigGamesBuilder = /*#__PURE__*/ function() {
-    function ZRomulatorConfigGamesBuilder() {
-        _class_call_check$3(this, ZRomulatorConfigGamesBuilder);
-        _define_property$2(this, "_config", {});
-    }
-    _create_class$3(ZRomulatorConfigGamesBuilder, [
-        {
-            key: "gamesFolder",
-            value: function gamesFolder(games) {
-                this._config.gamesFolder = games;
-                return this;
-            }
-        },
-        {
-            key: "copy",
-            value: function copy(other) {
-                this._config = structuredClone(other);
-                return this;
-            }
-        },
-        {
-            key: "assign",
-            value: function assign(other) {
-                this._config = _object_spread({}, this._config, other);
-                return this;
-            }
-        },
-        {
-            key: "build",
-            value: function build() {
-                return structuredClone(this._config);
-            }
-        }
-    ]);
-    return ZRomulatorConfigGamesBuilder;
-}();
 
-function _class_call_check$2(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
+class ZRomulatorConfigMediaMetadata {
+    static all() {
+        return [
+            ZRomulatorConfigMediaMetadata.mediaFolder()
+        ];
     }
-}
-function _defineProperties$2(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
+    static mediaFolder() {
+        return new ZMetadataBuilder().id("media-folder").path("mediaFolder").name("Media Folder").fallback("${HOME}/Games/.media").editable().file().build();
     }
 }
-function _create_class$2(Constructor, protoProps, staticProps) {
-    if (staticProps) _defineProperties$2(Constructor, staticProps);
-    return Constructor;
-}
-var ZRomulatorConfigMediaMetadata = /*#__PURE__*/ function() {
-    function ZRomulatorConfigMediaMetadata() {
-        _class_call_check$2(this, ZRomulatorConfigMediaMetadata);
-    }
-    _create_class$2(ZRomulatorConfigMediaMetadata, null, [
-        {
-            key: "all",
-            value: function all() {
-                return [
-                    ZRomulatorConfigMediaMetadata.mediaFolder()
-                ];
-            }
-        },
-        {
-            key: "mediaFolder",
-            value: function mediaFolder() {
-                return new ZMetadataBuilder().id("media-folder").path("mediaFolder").name("Media Folder").fallback("${HOME}/Games/.media").editable().file().build();
-            }
-        }
-    ]);
-    return ZRomulatorConfigMediaMetadata;
-}();
 
-function _class_call_check$1(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
+class ZRomulatorConfigMediaBuilder {
+    _media = {};
+    mediaFolder(folder) {
+        this._media.mediaFolder = folder;
+        return this;
     }
-}
-function _defineProperties$1(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
+    copy(other) {
+        this._media = structuredClone(other);
+        return this;
+    }
+    build() {
+        return structuredClone(this._media);
     }
 }
-function _create_class$1(Constructor, protoProps, staticProps) {
-    if (protoProps) _defineProperties$1(Constructor.prototype, protoProps);
-    return Constructor;
-}
-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;
-}
+
 /**
  * Represents a list of known config ids
  */ var ZRomulatorConfigId = /*#__PURE__*/ function(ZRomulatorConfigId) {
@@ -209,82 +73,209 @@ function _define_property$1(obj, key, value) {
    */ ZRomulatorConfigId["Media"] = "media";
     return ZRomulatorConfigId;
 }({});
-var ZRomulatorConfigBuilder = /*#__PURE__*/ function() {
-    function ZRomulatorConfigBuilder() {
-        _class_call_check$1(this, ZRomulatorConfigBuilder);
-        _define_property$1(this, "_config", {
-            id: "games",
-            name: "",
-            file: ""
-        });
-    }
-    _create_class$1(ZRomulatorConfigBuilder, [
-        {
-            key: "id",
-            value: function id(id) {
-                this._config.id = id;
-                return this;
-            }
-        },
-        {
-            key: "avatar",
-            value: function avatar(id) {
-                this._config.avatar = id;
-                return this;
-            }
-        },
-        {
-            key: "name",
-            value: function name(name) {
-                this._config.name = name;
-                return this;
-            }
-        },
-        {
-            key: "description",
-            value: function description(description) {
-                this._config.description = description;
-                return this;
-            }
-        },
-        {
-            key: "file",
-            value: function file(path) {
-                this._config.file = path;
-                return this;
-            }
-        },
-        {
-            key: "contents",
-            value: function contents(contents) {
-                this._config.contents = contents;
-                return this;
-            }
-        },
-        {
-            key: "metadata",
-            value: function metadata(meta) {
-                var metadata = firstDefined([], this._config.metadata);
-                this._config.metadata = metadata.concat(castArray(meta));
-                return this;
-            }
-        },
-        {
-            key: "copy",
-            value: function copy(other) {
-                this._config = structuredClone(other);
-                return this;
-            }
-        },
-        {
-            key: "build",
-            value: function build() {
-                return structuredClone(this._config);
-            }
+class ZRomulatorConfigBuilder {
+    _config = {
+        id: "games",
+        name: "",
+        file: ""
+    };
+    id(id) {
+        this._config.id = id;
+        return this;
+    }
+    avatar(id) {
+        this._config.avatar = id;
+        return this;
+    }
+    name(name) {
+        this._config.name = name;
+        return this;
+    }
+    description(description) {
+        this._config.description = description;
+        return this;
+    }
+    file(path) {
+        this._config.file = path;
+        return this;
+    }
+    contents(contents) {
+        this._config.contents = contents;
+        return this;
+    }
+    metadata(meta) {
+        const metadata = firstDefined([], this._config.metadata);
+        this._config.metadata = metadata.concat(castArray(meta));
+        return this;
+    }
+    copy(other) {
+        this._config = structuredClone(other);
+        return this;
+    }
+    build() {
+        return structuredClone(this._config);
+    }
+}
+
+/**
+ * Describes what a specific piece of media represents.
+ */ var ZRomulatorMediaType = /*#__PURE__*/ function(ZRomulatorMediaType) {
+    /**
+   * A 3d representation of the box art.
+   */ ZRomulatorMediaType["Game3dBox"] = "3dboxes";
+    /**
+   * Back of the game box.
+   */ ZRomulatorMediaType["GameBackCover"] = "backcovers";
+    /**
+   * Front of the game box.
+   */ ZRomulatorMediaType["GameCover"] = "covers";
+    /**
+   * Fan art.
+   */ ZRomulatorMediaType["GameFanArt"] = "fanart";
+    /**
+   * Game manual.
+   */ ZRomulatorMediaType["GameManual"] = "manuals";
+    /**
+   * A marquee of a game.
+   */ ZRomulatorMediaType["GameMarquee"] = "marquees";
+    /**
+   * The cartridge or disc label.
+   */ ZRomulatorMediaType["GamePhysicalMedia"] = "physicalmedia";
+    /**
+   * An in game screenshot showcasing gameplay.
+   */ ZRomulatorMediaType["GameScreenshot"] = "screenshots";
+    /**
+   * An in game screenshot of the title screen.
+   */ ZRomulatorMediaType["GameTitle"] = "titlescreens";
+    /**
+   * A video showcasing the game.
+   */ ZRomulatorMediaType["GameVideo"] = "videos";
+    /**
+   * An image of a system's controller.
+   */ ZRomulatorMediaType["SystemController"] = "controller.png";
+    /**
+   * A icon for the system.
+   *
+   * These are normally 32x32.
+   */ ZRomulatorMediaType["SystemIcon"] = "icon.png";
+    /**
+   * An illustration of the system.
+   */ ZRomulatorMediaType["SystemIllustration"] = "illustration.png";
+    /**
+   * A picture of the system.
+   *
+   * These are real life looking photos of what
+   * a system looks like.
+   */ ZRomulatorMediaType["SystemPicture"] = "picture.png";
+    /**
+   * A wheel for a system.
+   *
+   * This is basically the logo.
+   */ ZRomulatorMediaType["SystemWheel"] = "wheel.png";
+    return ZRomulatorMediaType;
+}({});
+const ZRomulatorMediaTypeMap = keyBy(Object.values(ZRomulatorMediaType));
+function isMediaType(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorMediaTypeMap, candidate);
+}
+
+/**
+ * Id slugs for supported systems.
+ */ var ZRomulatorSystemId = /*#__PURE__*/ function(ZRomulatorSystemId) {
+    /**
+   * Nintendo Entertainment System
+   */ ZRomulatorSystemId["Nintendo"] = "nes";
+    /**
+   * Super Nintendo Entertainment System.
+   */ ZRomulatorSystemId["SuperNintendo"] = "snes";
+    /**
+   * Nintendo 64
+   */ ZRomulatorSystemId["Nintendo64"] = "n64";
+    /**
+   * Nintendo GameCube
+   */ ZRomulatorSystemId["GameCube"] = "gc";
+    /**
+   * Nintendo Wii
+   */ ZRomulatorSystemId["Wii"] = "wii";
+    /**
+   * Nintendo Wii U
+   */ ZRomulatorSystemId["WiiU"] = "wiiu";
+    /**
+   * Nintendo Switch
+   */ ZRomulatorSystemId["Switch"] = "switch";
+    return ZRomulatorSystemId;
+}({});
+const ZRomulatorSystemIdMap = keyBy(Object.values(ZRomulatorSystemId));
+/**
+ * Gets whether a candidate string represents a system id.
+ */ function isSystemId(candidate) {
+    return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemIdMap, candidate);
+}
+
+/**
+ * A builder for the media object.
+ */ class ZRomulatorMediaBuilder {
+    _media = {};
+    id(id) {
+        this._media.id = id;
+        return this;
+    }
+    type(type) {
+        this._media.type = type;
+        return this;
+    }
+    system(system) {
+        this._media.system = system;
+        return this;
+    }
+    game(game) {
+        this._media.game = game;
+        return this;
+    }
+    filename(name) {
+        this._media.fileName = name;
+        return this;
+    }
+    url(url) {
+        this._media.url = url;
+        return this;
+    }
+    from(path) {
+        const hierarchy = path.split(sep);
+        let builder = this.url(path);
+        // The media structure is split into 2 or 3 parts
+        // fileName = game file name or system media type name
+        // parent = media type for games or system type for systems
+        // grandparent = system type for games.
+        const fileName = hierarchy[hierarchy.length - 1];
+        const parent = hierarchy[hierarchy.length - 2];
+        const grandparent = hierarchy[hierarchy.length - 3];
+        if (!fileName) {
+            // If we don't even have a file name - then this
+            // isn't even media at all.
+            return builder;
+        }
+        builder = builder.filename(fileName);
+        const ext = extname(fileName);
+        const title = basename(fileName, ext);
+        if (isMediaType(fileName) && isSystemId(parent)) {
+            // This is media for system hardware
+            const id = `${parent}-${kebabCase(title)}`;
+            return builder.id(id).system(parent).type(fileName).game(undefined);
         }
-    ]);
-    return ZRomulatorConfigBuilder;
-}();
+        if (fileName && isMediaType(parent) && isSystemId(grandparent)) {
+            // This is media for a game that is supported.
+            const game = kebabCase(title);
+            const id = `${grandparent}-${parent}-${game}`;
+            return builder.id(id).system(grandparent).type(parent).game(game);
+        }
+        return builder;
+    }
+    build() {
+        const clone = structuredClone(this._media);
+        return omitBy(clone, isUndefined);
+    }
+}
 
 /**
  * Describes a type of system.
@@ -304,135 +295,81 @@ var ZRomulatorConfigBuilder = /*#__PURE__*/ function() {
     return ZRomulatorSystemType;
 }({});
 
-function _class_call_check(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
-    }
-}
-function _defineProperties(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
-    }
-}
-function _create_class(Constructor, protoProps, staticProps) {
-    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
-    return Constructor;
-}
-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.
- */ var ZRomulatorSystemBuilder = /*#__PURE__*/ function() {
-    function ZRomulatorSystemBuilder() {
-        _class_call_check(this, ZRomulatorSystemBuilder);
-        _define_property(this, "_system", {
-            id: "",
-            name: "",
-            aliases: [],
-            generation: 0,
-            manufacturers: [],
-            type: ZRomulatorSystemType.Console
-        });
-        /**
-   * Sets the system type to console.
+ */ class ZRomulatorSystemBuilder {
+    _system = {
+        id: ZRomulatorSystemId.Nintendo
+    };
+    /**
+   * Sets the id (slug) of the system.
    *
+   * @param id -
+   *        The unique identifier for the system.
    * @returns
    *        This instance.
-   */ _define_property(this, "console", this.type.bind(this, ZRomulatorSystemType.Console));
-        /**
-   * Sets the system type to handheld.
+   */ id(id) {
+        this._system.id = id;
+        return this;
+    }
+    /**
+   * Sets the canonical name of the system.
    *
+   * @param name -
+   *        The canonical name of the system.
    * @returns
    *        This instance.
-   */ _define_property(this, "handheld", this.type.bind(this, ZRomulatorSystemType.Handheld));
-        /**
-   * Sets the system type to arcade.
+   */ name(name) {
+        this._system.name = name;
+        return this;
+    }
+    /**
+   * Sets the system type.
    *
+   * @param type -
+   *        The type of system.
    * @returns
    *        This instance.
-   */ _define_property(this, "arcade", this.type.bind(this, ZRomulatorSystemType.Arcade));
-        /**
-   * Sets the system type to computer.
+   */ type(type) {
+        this._system.type = type;
+        return this;
+    }
+    /**
+   * Sets the system type to console.
    *
    * @returns
    *        This instance.
-   */ _define_property(this, "computer", this.type.bind(this, ZRomulatorSystemType.Computer));
-    }
-    _create_class(ZRomulatorSystemBuilder, [
-        {
-            key: "id",
-            value: /**
-   * Sets the id (slug) of the system.
+   */ console = this.type.bind(this, ZRomulatorSystemType.Console);
+    /**
+   * Sets the system type to handheld.
    *
-   * @param id -
-   *        The unique identifier for the system.
    * @returns
    *        This instance.
-   */ function id(id) {
-                this._system.id = id;
-                return this;
-            }
-        },
-        {
-            key: "name",
-            value: /**
-   * Sets the canonical name of the system.
+   */ handheld = this.type.bind(this, ZRomulatorSystemType.Handheld);
+    /**
+   * Sets the system type to arcade.
    *
-   * @param name -
-   *        The canonical name of the system.
    * @returns
    *        This instance.
-   */ function name(name) {
-                this._system.name = name;
-                return this;
-            }
-        },
-        {
-            key: "type",
-            value: /**
-   * Sets the system type.
+   */ arcade = this.type.bind(this, ZRomulatorSystemType.Arcade);
+    /**
+   * Sets the system type to computer.
    *
-   * @param type -
-   *        The type of system.
    * @returns
    *        This instance.
-   */ function type(type) {
-                this._system.type = type;
-                return this;
-            }
-        },
-        {
-            key: "aliases",
-            value: /**
+   */ computer = this.type.bind(this, ZRomulatorSystemType.Computer);
+    /**
    * Sets the aliases of the system.
    *
    * @param aliases -
    *        The aliases of the system.
    * @returns
    *        This instance.
-   */ function aliases(aliases) {
-                this._system.aliases = aliases;
-                return this;
-            }
-        },
-        {
-            key: "alias",
-            value: /**
+   */ aliases(aliases) {
+        this._system.aliases = aliases;
+        return this;
+    }
+    /**
    * Adds an alias to the system.
    *
    * If an alias already exists, then it will
@@ -442,43 +379,34 @@ function _define_property(obj, key, value) {
    *        The alias to add to the system.
    * @returns
    *        This instance.
-   */ function alias(alias) {
-                var aliases = this._system.aliases.slice();
-                aliases.push(alias);
-                return this.aliases(uniq(aliases));
-            }
-        },
-        {
-            key: "generation",
-            value: /**
+   */ alias(alias) {
+        const aliases = firstDefined([], this._system.aliases).slice();
+        aliases.push(alias);
+        return this.aliases(uniq(aliases));
+    }
+    /**
    * Sets the generational index of the system.
    *
    * @param generation -
    *        The generational index of the system.
    * @returns
    *        This instance.
-   */ function generation(generation) {
-                this._system.generation = generation;
-                return this;
-            }
-        },
-        {
-            key: "manufacturers",
-            value: /**
+   */ generation(generation) {
+        this._system.generation = generation;
+        return this;
+    }
+    /**
    * Sets the manufacturers of the system.
    *
    * @param manufacturers -
    *        The manufacturers of the system.
    * @returns
    *        This instance.
-   */ function manufacturers(manufacturers) {
-                this._system.manufacturers = manufacturers;
-                return this;
-            }
-        },
-        {
-            key: "manufacturer",
-            value: /**
+   */ manufacturers(manufacturers) {
+        this._system.manufacturers = manufacturers;
+        return this;
+    }
+    /**
    * Adds a manufacturer for the system.
    *
    * If a manufacturer already exists, then it will not be added again.
@@ -487,27 +415,21 @@ function _define_property(obj, key, value) {
    *        The manufacturer of the system.
    * @returns
    *        This instance.
-   */ function manufacturer(manufacturer) {
-                var manufacturers = this._system.manufacturers.slice();
-                manufacturers.push(manufacturer);
-                return this.manufacturers(uniq(manufacturers));
-            }
-        },
-        {
-            key: "build",
-            value: /**
+   */ manufacturer(manufacturer) {
+        const manufacturers = firstDefined([], this._system.manufacturers).slice();
+        manufacturers.push(manufacturer);
+        return this.manufacturers(uniq(manufacturers));
+    }
+    /**
    * Builds the system instance.
    *
    * @returns
    *        A structured clone of the current system
    *        that has been built.
-   */ function build() {
-                return structuredClone(this._system);
-            }
-        }
-    ]);
-    return ZRomulatorSystemBuilder;
-}();
+   */ build() {
+        return structuredClone(this._system);
+    }
+}
 
-export { ZRomulatorConfigBuilder, ZRomulatorConfigGamesBuilder, ZRomulatorConfigGamesMetadata, ZRomulatorConfigId, ZRomulatorConfigMediaMetadata, ZRomulatorSystemBuilder, ZRomulatorSystemType };
+export { ZRomulatorConfigBuilder, ZRomulatorConfigGamesBuilder, ZRomulatorConfigGamesMetadata, ZRomulatorConfigId, ZRomulatorConfigMediaBuilder, ZRomulatorConfigMediaMetadata, ZRomulatorMediaBuilder, ZRomulatorMediaType, ZRomulatorSystemBuilder, ZRomulatorSystemId, ZRomulatorSystemType, isMediaType, isSystemId };
 //# sourceMappingURL=index.js.map