@zthun/romulator-client 1.18.3 → 1.18.5

package/dist/job/job.d.mts

@@ -0,0 +1,114 @@
+import { ZJobType } from './job-type.mjs';
+/**
+ * Represents a job in the romulator system.
+ */
+export interface IZJob {
+    /**
+     * The id of the job.
+     */
+    id?: string;
+    /**
+     * The job type.
+     */
+    type: ZJobType;
+    /**
+     * The parameters for the job.
+     */
+    context?: any;
+    /**
+     * The creation date of the job.
+     */
+    createdAt?: string;
+}
+/**
+ * A builder that constructs IZJob instances.
+ */
+export declare class ZJobBuilder {
+    private _job;
+    /**
+     * 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?: string): this;
+    /**
+     * Sets the id to a new generated guid if the id is not set.
+     *
+     * @returns
+     *        This object.
+     */
+    guid(): this;
+    /**
+     * Sets the job type.
+     *
+     * @param val -
+     *        The job type.
+     * @returns
+     *        This builder.
+     */
+    type(val: ZJobType): this;
+    /**
+     * Sets the job type to ping.
+     *
+     * @returns
+     *        This object.
+     */
+    ping: () => this;
+    /**
+     * Sets the job type to scrape.
+     *
+     * @returns
+     *        This object.
+     */
+    scrape: () => this;
+    /**
+     * Sets the job context or parameters.
+     *
+     * @param val -
+     *        Context to attach to the job.
+     * @returns
+     *        This builder.
+     */
+    context(val: any): 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?: string): 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.
+     *
+     * @returns
+     *        This object.
+     */
+    redact(): this;
+    /**
+     * Copies the values from another job into this builder.
+     *
+     * @param other -
+     *        The job to duplicate.
+     * @returns
+     *        This builder.
+     */
+    copy(other: IZJob): this;
+    /**
+     * Builds a clean IZJob instance with undefined values removed.
+     *
+     * @returns
+     *        The constructed job.
+     */
+    build(): IZJob;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/romulator-client",
-  "version": "1.18.3",
+  "version": "1.18.5",
   "description": "A client for declaring models and invoking the romulator api",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -25,22 +25,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@zthun/helpful-fn": "^9.11.2",
-    "@zthun/helpful-query": "^9.11.3",
-    "lodash-es": "^4.17.22"
+    "@zthun/helpful-fn": "^9.11.5",
+    "@zthun/helpful-query": "^9.11.5",
+    "lodash-es": "^4.17.23"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@zthun/janitor-build-config": "^19.5.4",
+    "@zthun/janitor-build-config": "^19.5.6",
     "@zthun/janitor-ts-config": "^19.5.3",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vite": "^7.3.0",
-    "vitest": "^4.0.16"
+    "vite": "^7.3.1",
+    "vitest": "^4.0.18"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "71edc74d72d566881b161224dfe5e7f1271cca0b"
+  "gitHead": "4dc5c512318120bb4a9e03f76d2634d91126bcd2"
 }