@zthun/romulator-client 1.18.4 → 1.19.0

package/dist/index.cjs

@@ -18,7 +18,7 @@ class ZRomulatorConfigGamesMetadata {
     }
 }
 
-function _define_property$5(obj, key, value) {
+function _define_property$6(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$5(this, "_config", {});
+        _define_property$6(this, "_config", {});
     }
 }
 
-function _define_property$4(obj, key, value) {
+function _define_property$5(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$4(this, "_config", {
+        _define_property$5(this, "_config", {
             id: "games",
             name: "",
             file: ""
@@ -125,7 +125,7 @@ class ZRomulatorConfigBuilder {
     }
 }
 
-function _define_property$3(obj, key, value) {
+function _define_property$4(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -211,7 +211,7 @@ function _define_property$3(obj, key, value) {
         return structuredClone(this._players);
     }
     constructor(){
-        _define_property$3(this, "_players", {
+        _define_property$4(this, "_players", {
             min: 1,
             max: 1
         });
@@ -220,25 +220,25 @@ function _define_property$3(obj, key, value) {
    *
    * @returns
    *        This object.
-   */ _define_property$3(this, "singlePlayer", this.range.bind(this, 1, 1));
+   */ _define_property$4(this, "singlePlayer", this.range.bind(this, 1, 1));
         /**
    * Sets the player count to 2 for max and 1 for min.
    *
    * @returns
    *        This object.
-   */ _define_property$3(this, "twoPlayer", this.range.bind(this, 1, 2));
+   */ _define_property$4(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));
+   */ _define_property$4(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));
+   */ _define_property$4(this, "eightPlayer", this.range.bind(this, 1, 8));
     }
 }
 
@@ -425,7 +425,7 @@ const ZRomulatorSystemIdMap = lodashEs.keyBy(Object.values(ZRomulatorSystemId));
     return typeof candidate === "string" && Object.prototype.hasOwnProperty.call(ZRomulatorSystemIdMap, candidate);
 }
 
-function _define_property$2(obj, key, value) {
+function _define_property$3(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -600,7 +600,7 @@ function _define_property$2(obj, key, value) {
         return lodashEs.omitBy(clone, lodashEs.isUndefined);
     }
     constructor(){
-        _define_property$2(this, "_game", {
+        _define_property$3(this, "_game", {
             id: "",
             name: "",
             file: "",
@@ -614,6 +614,261 @@ function _define_property$2(obj, key, value) {
     }
 }
 
+/**
+ * The status of a job.
+ */ var ZJobStatus = /*#__PURE__*/ function(ZJobStatus) {
+    /**
+   * Idle, job is not running yet.
+   *
+   * This is the default state.
+   */ ZJobStatus["Idle"] = "idle";
+    /**
+   * Job is running.
+   */ ZJobStatus["Running"] = "running";
+    /**
+   * Job was canceled.
+   *
+   * Jobs that were in a running state when the application
+   * shuts down will reboot with this status.
+   */ ZJobStatus["Canceled"] = "canceled";
+    /**
+   * Job failed.
+   *
+   * Try again.
+   */ ZJobStatus["Failed"] = "failed";
+    /**
+   * Job completed successfully.
+   */ ZJobStatus["Success"] = "success";
+    return ZJobStatus;
+}({});
+
+/**
+ * Represents the supported job types.
+ */ var ZJobType = /*#__PURE__*/ function(ZJobType) {
+    /**
+   * Unknown job type.
+   *
+   * You can use this as the null object for a job.
+   */ ZJobType["Unknown"] = "unknown";
+    /**
+   * A quick hello world style job.
+   *
+   * Will always succeed.  This is
+   * just to validate that the job
+   * engine is working.
+   *
+   * Ping has no context and no parameters.
+   */ ZJobType["Ping"] = "ping";
+    /**
+   * A scrape job.
+   *
+   * A scrape job downloads media from
+   * a scraper and saves it to the
+   * media folder.
+   *
+   * A scrape job with no context scrapes
+   * all systems and games.
+   */ ZJobType["Scrape"] = "scrape";
+    return ZJobType;
+}({});
+
+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 that constructs IZJob instances.
+ */ class ZJobBuilder {
+    /**
+   * Sets the unique identifier for the job.
+   *
+   * @param val -
+   *        Job id.  If this is falsy, then the id
+   *        is cleared.
+   * @returns
+   *        This builder.
+   */ id(val) {
+        this._job.id = val;
+        return this;
+    }
+    /**
+   * Sets the id to a new generated guid if the id is not set.
+   *
+   * @returns
+   *        This object.
+   */ guid() {
+        return this._job.id ? this : this.id(helpfulFn.createGuid());
+    }
+    /**
+   * Sets the job type.
+   *
+   * @param val -
+   *        The job type.
+   * @returns
+   *        This builder.
+   */ type(val) {
+        this._job.type = val;
+        return this;
+    }
+    /**
+   * Sets the state of the job.
+   *
+   * @param status -
+   *        The status of the job.
+   *
+   * @returns
+   *        This object.
+   */ status(status) {
+        this._job.status = status;
+        return this;
+    }
+    /**
+   * Sets the percent value.
+   *
+   * @param val -
+   *        The percentage of the job complete
+   *
+   * @returns
+   *        This object.
+   */ percent(val) {
+        this._job.percent = val;
+        if (this._job.percent != null) {
+            this._job.percent = Math.min(100, Math.max(0, this._job.percent));
+            this._job.percent = Math.round(this._job.percent);
+        }
+        return this;
+    }
+    /**
+   * Sets the job context or parameters.
+   *
+   * @param val -
+   *        Context to attach to the job.
+   * @returns
+   *        This builder.
+   */ context(val) {
+        this._job.context = val;
+        return this;
+    }
+    /**
+   * Sets the date and time when the job was created.
+   *
+   * @param val -
+   *        The iso string representation of the job creation date.
+   *
+   * @returns
+   *        This object.
+   */ createdAt(val) {
+        this._job.createdAt = val;
+        return this;
+    }
+    /**
+   * Removes information about the job that does not need to be written
+   * to a job file.
+   *
+   * This removes any created and updated date as the file's audit
+   * information is source of truth for these.  The id is also removed
+   * as the file name serves as an id.
+   *
+   * @returns
+   *        This object.
+   */ redact() {
+        delete this._job.id;
+        delete this._job.createdAt;
+        return this;
+    }
+    /**
+   * Attempts to parse a job from a candidate job file.
+   */ parse(candidate) {
+        const type = lodashEs.get(candidate, "type");
+        const context = lodashEs.get(candidate, "context");
+        const status = lodashEs.get(candidate, "status");
+        const percent = lodashEs.get(candidate, "percent");
+        return this.type(helpfulFn.castEnum(ZJobType, type)).status(helpfulFn.castEnum(ZJobStatus, status)).percent(helpfulFn.castNumber(percent, 0)).context(context);
+    }
+    /**
+   * Copies the values from another job into this builder.
+   *
+   * @param other -
+   *        The job to duplicate.
+   * @returns
+   *        This builder.
+   */ copy(other) {
+        this._job = structuredClone(other);
+        return this;
+    }
+    /**
+   * Builds a clean IZJob instance with undefined values removed.
+   *
+   * @returns
+   *        The constructed job.
+   */ build() {
+        const clone = structuredClone(this._job);
+        return lodashEs.omitBy(clone, lodashEs.isUndefined);
+    }
+    constructor(){
+        _define_property$2(this, "_job", {
+            type: ZJobType.Ping
+        });
+        /**
+   * Sets the job type to ping.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "ping", this.type.bind(this, ZJobType.Ping));
+        /**
+   * Sets the job type to scrape.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "scrape", this.type.bind(this, ZJobType.Scrape));
+        /**
+   * Sets the state status to idle and the percent to 0.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "idle", this.status.bind(this, ZJobStatus.Idle));
+        /**
+   * Sets the state status to running.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "running", this.status.bind(this, ZJobStatus.Running));
+        /**
+   * Sets the state status to canceled.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "canceled", this.status.bind(this, ZJobStatus.Canceled));
+        /**
+   * Sets the state status to failed.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "failed", this.status.bind(this, ZJobStatus.Failed));
+        /**
+   * Sets the state status to success and the percent to 100.
+   *
+   * @returns
+   *        This object.
+   */ _define_property$2(this, "success", this.status.bind(this, ZJobStatus.Success));
+        /**
+   * Sets the percentage to 0.
+   */ _define_property$2(this, "start", this.percent.bind(this, 0));
+        /**
+   * Sets the percentage to 100.
+   */ _define_property$2(this, "complete", this.percent.bind(this, 100));
+    }
+}
+
 var ZRomulatorGameMediaType = /*#__PURE__*/ function(ZRomulatorGameMediaType) {
     /**
    * A 3d representation of the box art.
@@ -1129,6 +1384,9 @@ function _define_property(obj, key, value) {
     }
 }
 
+exports.ZJobBuilder = ZJobBuilder;
+exports.ZJobStatus = ZJobStatus;
+exports.ZJobType = ZJobType;
 exports.ZRomulatorConfigBuilder = ZRomulatorConfigBuilder;
 exports.ZRomulatorConfigGamesBuilder = ZRomulatorConfigGamesBuilder;
 exports.ZRomulatorConfigGamesMetadata = ZRomulatorConfigGamesMetadata;