@thenavidm/midjourney-mcp-cli 1.0.0

package/dist/api/download.js

@@ -0,0 +1,108 @@
+/**
+ * Getting the actual files onto disk.
+ *
+ * Worth spelling out why this is not a fetch. Midjourney's CDN refuses plain
+ * server-side clients, and it does not send CORS headers that would let a
+ * script inside midjourney.com read the bytes either. Both obvious routes are
+ * closed, which is why the reference CLI for this API falls back to
+ * screenshotting the rendered <img> element.
+ *
+ * A screenshot is not the file. It is re-encoded, clipped to the element box at
+ * whatever size the page happened to lay it out, and stripped of everything the
+ * original carried. Downloading a 2048px upscale and getting a 512px PNG of how
+ * it looked in a browser window is not a download.
+ *
+ * Navigating a throwaway tab straight to the asset and reading the bytes back
+ * out of the resource cache avoids both problems: a top-level navigation is not
+ * a cross-origin subresource request, so CORS does not apply, and the browser
+ * is a browser, so the CDN serves it.
+ */
+import { mkdir, writeFile } from "node:fs/promises";
+import { basename, extname, join, resolve } from "node:path";
+import { MidjourneyError, NotFoundError, ValidationError } from "./errors.js";
+import { findJob } from "./jobs.js";
+import { mimeFromUrl } from "../transport/cdp.js";
+/** A filesystem-safe name derived from the asset URL, falling back to the job id. */
+export function fileNameFor(url, jobId, index) {
+    let candidate = "";
+    try {
+        candidate = basename(new URL(url).pathname);
+    }
+    catch {
+        candidate = "";
+    }
+    const extension = extname(candidate) || extensionFor(mimeFromUrl(url));
+    const stem = candidate ? candidate.slice(0, candidate.length - extname(candidate).length) : "";
+    // Midjourney names most assets `0_<index>.png`, which collides across every
+    // job in a folder, so the job id goes in front. The stem itself is dropped
+    // when it is just the grid position again: `<job>-0-0_0.png` says nothing
+    // that `<job>-0.png` does not.
+    const redundant = /^\d+_\d+$/.test(stem);
+    const safeStem = redundant ? "" : stem.replace(/[^a-zA-Z0-9._-]/g, "-").slice(0, 60);
+    return `${jobId}-${index}${safeStem ? `-${safeStem}` : ""}${extension}`;
+}
+function extensionFor(mime) {
+    switch (mime) {
+        case "image/png":
+            return ".png";
+        case "image/jpeg":
+            return ".jpg";
+        case "image/webp":
+            return ".webp";
+        case "image/gif":
+            return ".gif";
+        case "video/mp4":
+            return ".mp4";
+        case "video/webm":
+            return ".webm";
+        default:
+            return ".bin";
+    }
+}
+/** Download one URL to a directory. */
+export async function saveUrl(client, url, outDir, fileName) {
+    if (!/^https?:\/\//i.test(url)) {
+        throw new ValidationError(`Not a downloadable URL: '${url}'.`, 0, "(local)");
+    }
+    const { base64, mimeType } = await client.transport.fetchBinary(url);
+    const buffer = Buffer.from(base64, "base64");
+    if (buffer.byteLength === 0) {
+        throw new MidjourneyError(`The browser fetched ${url} but the body was empty. The asset may have expired, or the session may not have access to it.`, 0, "(download)");
+    }
+    const directory = resolve(outDir);
+    await mkdir(directory, { recursive: true });
+    const path = join(directory, fileName);
+    await writeFile(path, buffer);
+    return { url, path, bytes: buffer.byteLength, mime_type: mimeType };
+}
+/** Download every rendered image on a job, or a chosen subset. */
+export async function downloadJob(client, jobId, options = {}) {
+    const job = await findJob(client, jobId);
+    if (!job) {
+        throw new NotFoundError(`No job ${jobId} in this account's recent history. Only jobs still in the imagine feed can be resolved; older work has to be downloaded from the web app.`, 404, "(download)");
+    }
+    if (job.images.length === 0) {
+        throw new NotFoundError(`Job ${jobId} has no rendered images. Its status is '${job.status}'${job.rawStatus ? ` (${job.rawStatus})` : ""}, so it may still be running, or it may have been moderated.`, 404, "(download)");
+    }
+    const wanted = options.indexes && options.indexes.length > 0
+        ? options.indexes
+        : job.images.map((_, index) => index);
+    const outDir = options.outDir ?? client.config.downloadDir;
+    const saved = [];
+    const skipped = [];
+    for (const index of wanted) {
+        const url = job.images[index];
+        if (!url) {
+            skipped.push(`index ${index}: this job has ${job.images.length} image(s)`);
+            continue;
+        }
+        try {
+            saved.push(await saveUrl(client, url, outDir, fileNameFor(url, job.id, index)));
+        }
+        catch (error) {
+            skipped.push(`index ${index}: ${error.message}`);
+        }
+    }
+    return { job_id: job.id, saved, skipped };
+}
+//# sourceMappingURL=download.js.map

package/dist/api/download.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.js","sourceRoot":"","sources":["../../src/api/download.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAG7D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AASlD,qFAAqF;AACrF,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,KAAa,EAAE,KAAa;IACnE,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,CAAC;QACH,SAAS,GAAG,QAAQ,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,SAAS,GAAG,EAAE,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/F,4EAA4E;IAC5E,2EAA2E;IAC3E,0EAA0E;IAC1E,+BAA+B;IAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACrF,OAAO,GAAG,KAAK,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC;AAC1E,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW;YACd,OAAO,MAAM,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,MAAM,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,OAAO,CAAC;QACjB,KAAK,WAAW;YACd,OAAO,MAAM,CAAC;QAChB,KAAK,WAAW;YACd,OAAO,MAAM,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,OAAO,CAAC;QACjB;YACE,OAAO,MAAM,CAAC;IAClB,CAAC;AACH,CAAC;AAED,uCAAuC;AACvC,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAwB,EACxB,GAAW,EACX,MAAc,EACd,QAAgB;IAEhB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,4BAA4B,GAAG,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACrE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE7C,IAAI,MAAM,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAe,CACvB,uBAAuB,GAAG,gGAAgG,EAC1H,CAAC,EACD,YAAY,CACb,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvC,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE9B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACtE,CAAC;AAQD,kEAAkE;AAClE,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAwB,EACxB,KAAa,EACb,UAA8B,EAAE;IAEhC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,aAAa,CACrB,UAAU,KAAK,2IAA2I,EAC1J,GAAG,EACH,YAAY,CACb,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,aAAa,CACrB,OAAO,KAAK,2CAA2C,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,8DAA8D,EAC7K,GAAG,EACH,YAAY,CACb,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GACV,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAC3C,CAAC,CAAC,OAAO,CAAC,OAAO;QACjB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAE1C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;IAC3D,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,kBAAkB,GAAG,CAAC,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC;YAC3E,SAAS;QACX,CAAC;QACD,IAAI,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAClF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5C,CAAC"}

package/dist/api/errors.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Typed failures, each one carrying the fix.
+ *
+ * Midjourney has no error contract to lean on: it is a web app talking to its
+ * own backend, so a failure arrives as a bare status, an HTML interstitial, or
+ * a redirect to the sign-in page. Handing a model "HTTP 403" from any of those
+ * tells it nothing and it gives up. Every failure here is classified into one
+ * of a small number of things that actually went wrong, and each says what to
+ * do about it, because the recovery is genuinely different every time: log in
+ * again, wait for a challenge to clear, buy more fast hours, fix the prompt.
+ */
+export declare class MidjourneyError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    readonly detail: string;
+    constructor(message: string, status: number, endpoint: string, detail?: string);
+    toJSON(): Record<string, unknown>;
+}
+/** Chrome could not be found, started, or driven. Nothing reached Midjourney. */
+export declare class BrowserError extends MidjourneyError {
+    constructor(message: string);
+}
+/** The browser profile is not signed in to Midjourney. */
+export declare class NotSignedInError extends MidjourneyError {
+}
+/**
+ * Cloudflare served an interstitial instead of the API.
+ *
+ * Distinct from a sign-in failure and worth its own class, because the fix is
+ * to let the browser window solve it once, not to re-authenticate.
+ */
+export declare class ChallengeError extends MidjourneyError {
+}
+/** Midjourney rejected the request as malformed, or the prompt as unacceptable. */
+export declare class ValidationError extends MidjourneyError {
+}
+/** The job, folder or asset is not there. */
+export declare class NotFoundError extends MidjourneyError {
+}
+/** Too many requests, or out of fast hours. */
+export declare class RateLimitError extends MidjourneyError {
+}
+/** Upstream 5xx. Usually transient. */
+export declare class ServerError extends MidjourneyError {
+}
+/** Our own deadline expired. */
+export declare class TimeoutError extends MidjourneyError {
+}
+/** A job was submitted but never reached a terminal state in time. */
+export declare class JobTimeoutError extends MidjourneyError {
+    readonly jobId: string;
+    constructor(message: string, jobId: string);
+    toJSON(): Record<string, unknown>;
+}
+/** Writes are off, or a spending tool was called without confirmation. */
+export declare class WriteBlockedError extends MidjourneyError {
+    constructor(message: string);
+}
+/**
+ * Is this body a Cloudflare interstitial rather than an answer?
+ *
+ * The challenge is served with a 403 and an HTML body, and so is a genuine
+ * permission failure, so the status alone cannot separate them. These markers
+ * are the ones Cloudflare has kept stable across its managed-challenge and
+ * JS-challenge pages.
+ */
+export declare function looksLikeChallenge(body: string): boolean;
+/** Is this the sign-in page, or a body that only makes sense when logged out? */
+export declare function looksSignedOut(body: string, status: number): boolean;
+/** Pull a human-usable message out of whatever came back. */
+export declare function describeBody(body: string): string;
+/** Turn a page-side response into the right error class. */
+export declare function errorFor(status: number, endpoint: string, body: string): MidjourneyError;
+/** Statuses worth another attempt. */
+export declare const RETRYABLE: Set<number>;

package/dist/api/errors.js

@@ -0,0 +1,166 @@
+/**
+ * Typed failures, each one carrying the fix.
+ *
+ * Midjourney has no error contract to lean on: it is a web app talking to its
+ * own backend, so a failure arrives as a bare status, an HTML interstitial, or
+ * a redirect to the sign-in page. Handing a model "HTTP 403" from any of those
+ * tells it nothing and it gives up. Every failure here is classified into one
+ * of a small number of things that actually went wrong, and each says what to
+ * do about it, because the recovery is genuinely different every time: log in
+ * again, wait for a challenge to clear, buy more fast hours, fix the prompt.
+ */
+export class MidjourneyError extends Error {
+    status;
+    endpoint;
+    detail;
+    constructor(message, status, endpoint, detail = "") {
+        super(message);
+        this.name = new.target.name;
+        this.status = status;
+        this.endpoint = endpoint;
+        this.detail = detail;
+    }
+    toJSON() {
+        return {
+            error: this.message,
+            type: this.name,
+            ...(this.status ? { status: this.status } : {}),
+            endpoint: this.endpoint,
+            ...(this.detail ? { detail: this.detail.slice(0, 500) } : {}),
+        };
+    }
+}
+/** Chrome could not be found, started, or driven. Nothing reached Midjourney. */
+export class BrowserError extends MidjourneyError {
+    constructor(message) {
+        super(message, 0, "(browser)", "");
+    }
+}
+/** The browser profile is not signed in to Midjourney. */
+export class NotSignedInError extends MidjourneyError {
+}
+/**
+ * Cloudflare served an interstitial instead of the API.
+ *
+ * Distinct from a sign-in failure and worth its own class, because the fix is
+ * to let the browser window solve it once, not to re-authenticate.
+ */
+export class ChallengeError extends MidjourneyError {
+}
+/** Midjourney rejected the request as malformed, or the prompt as unacceptable. */
+export class ValidationError extends MidjourneyError {
+}
+/** The job, folder or asset is not there. */
+export class NotFoundError extends MidjourneyError {
+}
+/** Too many requests, or out of fast hours. */
+export class RateLimitError extends MidjourneyError {
+}
+/** Upstream 5xx. Usually transient. */
+export class ServerError extends MidjourneyError {
+}
+/** Our own deadline expired. */
+export class TimeoutError extends MidjourneyError {
+}
+/** A job was submitted but never reached a terminal state in time. */
+export class JobTimeoutError extends MidjourneyError {
+    jobId;
+    constructor(message, jobId) {
+        super(message, 0, "(local)", "");
+        this.jobId = jobId;
+    }
+    toJSON() {
+        return { ...super.toJSON(), job_id: this.jobId };
+    }
+}
+/** Writes are off, or a spending tool was called without confirmation. */
+export class WriteBlockedError extends MidjourneyError {
+    constructor(message) {
+        super(message, 0, "(local)", "");
+    }
+}
+/**
+ * Is this body a Cloudflare interstitial rather than an answer?
+ *
+ * The challenge is served with a 403 and an HTML body, and so is a genuine
+ * permission failure, so the status alone cannot separate them. These markers
+ * are the ones Cloudflare has kept stable across its managed-challenge and
+ * JS-challenge pages.
+ */
+export function looksLikeChallenge(body) {
+    const head = body.slice(0, 4000).toLowerCase();
+    return (head.includes("just a moment") ||
+        head.includes("cf-browser-verification") ||
+        head.includes("cf_chl_opt") ||
+        head.includes("challenges.cloudflare.com") ||
+        head.includes("enable javascript and cookies to continue"));
+}
+/** Is this the sign-in page, or a body that only makes sense when logged out? */
+export function looksSignedOut(body, status) {
+    if (status === 401)
+        return true;
+    const head = body.slice(0, 4000).toLowerCase();
+    return (head.includes('"error":"unauthorized"') ||
+        head.includes("you must be logged in") ||
+        (head.includes("<html") && head.includes("/auth/signin")));
+}
+/** Pull a human-usable message out of whatever came back. */
+export function describeBody(body) {
+    const text = body.trim();
+    if (!text)
+        return "";
+    try {
+        const parsed = JSON.parse(text);
+        if (parsed && typeof parsed === "object") {
+            const record = parsed;
+            for (const key of ["message", "error", "detail", "reason"]) {
+                const value = record[key];
+                if (typeof value === "string" && value)
+                    return value.slice(0, 500);
+            }
+        }
+        return text.slice(0, 500);
+    }
+    catch {
+        // HTML or plain text. Strip tags so an error page does not drown the message.
+        return text
+            .replace(/<script[\s\S]*?<\/script>/gi, " ")
+            .replace(/<style[\s\S]*?<\/style>/gi, " ")
+            .replace(/<[^>]+>/g, " ")
+            .replace(/\s+/g, " ")
+            .trim()
+            .slice(0, 300);
+    }
+}
+/** Turn a page-side response into the right error class. */
+export function errorFor(status, endpoint, body) {
+    const detail = describeBody(body);
+    if (looksLikeChallenge(body)) {
+        return new ChallengeError(`Cloudflare served a challenge instead of ${endpoint}. Open the Midjourney window this server controls and let the check finish, then try again. Run \`midjourney-cli doctor\` to see the browser state.`, status, endpoint, detail);
+    }
+    if (looksSignedOut(body, status)) {
+        return new NotSignedInError(`The browser profile is not signed in to Midjourney, so ${endpoint} was refused. Run \`midjourney-cli login\` to open the window and sign in once. The session then persists.`, status, endpoint, detail);
+    }
+    if (status === 429) {
+        return new RateLimitError(`Midjourney rate limited ${endpoint}. The client already spaces requests out and retries; this failed after the last attempt.`, status, endpoint, detail);
+    }
+    if (status === 402) {
+        return new RateLimitError(`Midjourney refused ${endpoint} for billing reasons. This usually means the plan is out of fast hours, or the subscription lapsed.`, status, endpoint, detail);
+    }
+    if (status === 403) {
+        return new NotSignedInError(`Midjourney refused ${endpoint} for this account. Either the session lapsed, or the plan does not include this feature.`, status, endpoint, detail);
+    }
+    if (status === 400 || status === 422) {
+        return new ValidationError(`Midjourney rejected the request to ${endpoint}. ${detail || "Check the prompt and its parameters."}`, status, endpoint, detail);
+    }
+    if (status === 404) {
+        return new NotFoundError(`Not found via ${endpoint}. Check the job id. A job belonging to another account looks the same as one that never existed.`, status, endpoint, detail);
+    }
+    if (status >= 500) {
+        return new ServerError(`Midjourney returned ${status} for ${endpoint}. This is upstream and usually transient.`, status, endpoint, detail);
+    }
+    return new MidjourneyError(`Midjourney returned ${status} for ${endpoint}.`, status, endpoint, detail);
+}
+/** Statuses worth another attempt. */
+export const RETRYABLE = new Set([429, 500, 502, 503, 504]);
+//# sourceMappingURL=errors.js.map

package/dist/api/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/api/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAC/B,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,MAAM,CAAS;IAExB,YAAY,OAAe,EAAE,MAAc,EAAE,QAAgB,EAAE,MAAM,GAAG,EAAE;QACxE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,OAAO;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9D,CAAC;IACJ,CAAC;CACF;AAED,iFAAiF;AACjF,MAAM,OAAO,YAAa,SAAQ,eAAe;IAC/C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;CACF;AAED,0DAA0D;AAC1D,MAAM,OAAO,gBAAiB,SAAQ,eAAe;CAAG;AAExD;;;;;GAKG;AACH,MAAM,OAAO,cAAe,SAAQ,eAAe;CAAG;AAEtD,mFAAmF;AACnF,MAAM,OAAO,eAAgB,SAAQ,eAAe;CAAG;AAEvD,6CAA6C;AAC7C,MAAM,OAAO,aAAc,SAAQ,eAAe;CAAG;AAErD,+CAA+C;AAC/C,MAAM,OAAO,cAAe,SAAQ,eAAe;CAAG;AAEtD,uCAAuC;AACvC,MAAM,OAAO,WAAY,SAAQ,eAAe;CAAG;AAEnD,gCAAgC;AAChC,MAAM,OAAO,YAAa,SAAQ,eAAe;CAAG;AAEpD,sEAAsE;AACtE,MAAM,OAAO,eAAgB,SAAQ,eAAe;IACzC,KAAK,CAAS;IAEvB,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEQ,MAAM;QACb,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACnD,CAAC;CACF;AAED,0EAA0E;AAC1E,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACpD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC9B,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,MAAc;IACzD,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;QACtC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAC1D,CAAC;AACJ,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;QAC3C,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAiC,CAAC;YACjD,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK;oBAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,8EAA8E;QAC9E,OAAO,IAAI;aACR,OAAO,CAAC,6BAA6B,EAAE,GAAG,CAAC;aAC3C,OAAO,CAAC,2BAA2B,EAAE,GAAG,CAAC;aACzC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;aACxB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;aACpB,IAAI,EAAE;aACN,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,QAAQ,CAAC,MAAc,EAAE,QAAgB,EAAE,IAAY;IACrE,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,cAAc,CACvB,4CAA4C,QAAQ,qJAAqJ,EACzM,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,gBAAgB,CACzB,0DAA0D,QAAQ,4GAA4G,EAC9K,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,cAAc,CACvB,2BAA2B,QAAQ,2FAA2F,EAC9H,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,cAAc,CACvB,sBAAsB,QAAQ,qGAAqG,EACnI,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,gBAAgB,CACzB,sBAAsB,QAAQ,0FAA0F,EACxH,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACrC,OAAO,IAAI,eAAe,CACxB,sCAAsC,QAAQ,KAAK,MAAM,IAAI,sCAAsC,EAAE,EACrG,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,aAAa,CACtB,iBAAiB,QAAQ,kGAAkG,EAC3H,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;QAClB,OAAO,IAAI,WAAW,CACpB,uBAAuB,MAAM,QAAQ,QAAQ,2CAA2C,EACxF,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,eAAe,CAAC,uBAAuB,MAAM,QAAQ,QAAQ,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzG,CAAC;AAED,sCAAsC;AACtC,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC"}

package/dist/api/jobs.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Submitting work and following it to the end.
+ *
+ * This is the part the reference CLI for this API does not have, and it is the
+ * part that makes the difference between a toy and something an agent can use.
+ * Submitting returns a job id in about a second; the image does not exist for
+ * another thirty to ninety. A tool that returns the id and stops has handed the
+ * caller a polling loop to write, and a model asked to "make me a logo" will
+ * either return an id nobody can use or invent a wait and guess wrong.
+ *
+ * So submission and completion are one operation here, with the polling,
+ * back-off and terminal-state detection on this side of the boundary.
+ */
+import type { MidjourneyClient } from "./client.js";
+import { type Job } from "../format/jobs.js";
+export type Speed = "fast" | "relax" | "turbo";
+export declare const ENDPOINTS: {
+    readonly submit: "/api/submit-jobs";
+    readonly jobs: "/api/imagine";
+    readonly updates: "/api/imagine-update";
+    readonly queue: "/api/user-queue";
+    readonly folders: "/api/folders";
+    readonly moodboards: "/api/moodboards";
+    readonly storage: "/api/storage";
+    readonly explore: "/api/explore";
+    readonly exploreStyleLikes: "/api/explore-styles-likes";
+    readonly personalizedProfiles: "/api/personalized-profiles";
+    readonly following: "/api/following-for-user";
+    readonly modelRatings: "/api/model-ratings";
+    readonly contestsRankingCount: "/api/contests-ranking-count";
+    readonly jobStatus: "/api/job-status";
+};
+/** `singleplayer_<uuid>` is what the web app calls a solo user's own channel. */
+export declare function channelIdFor(userId: string): string;
+export type SubmitOptions = {
+    speed?: Speed;
+    /**
+     * Reload the open window once the request lands.
+     *
+     * Off for a call that is about to wait: reloading tears down the page context
+     * the poll loop is talking to, so every poll then pays for a reconnect and an
+     * eleven-second job takes minutes. A waiting caller refreshes once at the end
+     * instead, which is also the only moment there is anything to look at.
+     */
+    refresh?: boolean;
+    private?: boolean;
+    /** Counts the web app reports alongside a submission. */
+    imagePromptCount?: number;
+    styleRefCount?: number;
+    omniRefCount?: number;
+};
+/** Job ids out of a submission response, whatever it is wrapped in. */
+export declare function extractJobIds(payload: unknown, depth?: number): string[];
+/** Submit an imagine. Returns the job ids Midjourney accepted. */
+export declare function submitImagine(client: MidjourneyClient, prompt: string, options?: SubmitOptions): Promise<{
+    jobIds: string[];
+    raw: unknown;
+}>;
+/** Re-run an existing job, unchanged or with a new prompt. */
+export declare function submitRerun(client: MidjourneyClient, jobId: string, options?: SubmitOptions & {
+    newPrompt?: string;
+}): Promise<{
+    jobIds: string[];
+    raw: unknown;
+}>;
+/**
+ * Vary one image from a finished grid.
+ *
+ * Captured from the web app rather than guessed: `Vary Subtle` and `Vary
+ * Strong` are the same job type with a `strong` boolean, addressing one tile by
+ * `index`. Note the metadata block here is all nulls, where an imagine sends
+ * counts. That difference is what the app sends, so it is what we send.
+ */
+export declare function submitVary(client: MidjourneyClient, jobId: string, index: number, options?: SubmitOptions & {
+    strong?: boolean;
+}): Promise<{
+    jobIds: string[];
+    raw: unknown;
+}>;
+/**
+ * Submit an arbitrary job type.
+ *
+ * The escape hatch, and deliberately not dressed up as anything else. Only
+ * `imagine` and `reroll` are confirmed against observed traffic. The web app
+ * sends other values of `t` for upscales and variations, but guessing at their
+ * payloads and shipping them as named tools would mean charging the user for
+ * requests that quietly do nothing. Capture the real traffic first:
+ * `midjourney-cli capture` records what the app actually sends.
+ */
+export declare function submitRaw(client: MidjourneyClient, jobType: string, extra: Record<string, unknown>, options?: SubmitOptions): Promise<{
+    jobIds: string[];
+    raw: unknown;
+}>;
+export type ListOptions = {
+    limit?: number;
+    cursor?: string;
+    userId?: string;
+};
+/** Recent jobs for the signed-in account. */
+export declare function listJobs(client: MidjourneyClient, options?: ListOptions): Promise<{
+    jobs: Job[];
+    raw: unknown;
+}>;
+/** The update feed, which is what the web app polls while work is running. */
+export declare function jobUpdates(client: MidjourneyClient, options?: ListOptions & {
+    checkpoint?: string;
+}): Promise<{
+    jobs: Job[];
+    raw: unknown;
+}>;
+/**
+ * Ask about specific jobs by id.
+ *
+ * The one endpoint that answers "is this done?" honestly. It carries
+ * `current_status`, and it works for a job that has not reached the history
+ * feed yet, which is every job while it is still rendering.
+ *
+ * Everything else here was built before this was found, by inferring completion
+ * from whether image URLs could be derived. That inference happened to be right
+ * because the history feed only lists finished work, but it could never have
+ * reported "running" for anything.
+ */
+export declare function jobStatus(client: MidjourneyClient, jobIds: string[]): Promise<Job[]>;
+/** One job by id, asking the status endpoint first. */
+export declare function findJob(client: MidjourneyClient, jobId: string): Promise<Job | undefined>;
+export type WaitOptions = {
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    /** Called on every poll, for a CLI progress line. */
+    onProgress?: (job: Job | undefined, elapsedMs: number) => void;
+};
+/**
+ * Poll until a job reaches a terminal state.
+ *
+ * The interval widens as the wait goes on. A generation is quick at fast speed
+ * and can be twenty minutes at relax, and polling every three seconds for
+ * twenty minutes is four hundred requests nobody needs, on an endpoint we would
+ * rather not be conspicuous on.
+ */
+export declare function waitForJob(client: MidjourneyClient, jobId: string, options?: WaitOptions): Promise<Job>;