@gradio/client 2.5.0 → 2.5.1

package/dist/index.cjs

@@ -1594,6 +1594,27 @@ function consume_run_history_replay_impl(scope) {
 		return null;
 	}
 }
+function restore_run_impl(config, run) {
+	const dependency = config.dependencies.find((item) => item.id === run.fn_index || typeof item.api_name === "string" && `/${item.api_name.replace(/^\//, "")}` === run.api_name);
+	if (!dependency) return false;
+	const inputs = Array.isArray(run.inputs) ? run.inputs : Object.values(run.inputs ?? {});
+	const outputs = Array.isArray(run.outputs) ? run.outputs : run.outputs === null || run.outputs === void 0 ? [] : [run.outputs];
+	const restore = (ids, saved) => {
+		for (const [index, id] of ids.entries()) {
+			const component = config.components.find((item) => item.id === id);
+			if (!component || index >= saved.length) continue;
+			if (component.type === "state") continue;
+			component.props.value = saved[index];
+		}
+	};
+	restore(dependency.inputs, inputs);
+	restore(dependency.outputs, outputs);
+	return true;
+}
+function apply_run_history_replay_impl(config) {
+	const run = consume_run_history_replay_impl(config);
+	return run ? restore_run_impl(config, run) : false;
+}
 function start_run_history_impl(options) {
 	const key = storage_key(options);
 	if (!key) return null;
@@ -1686,6 +1707,16 @@ function stage_run_history_replay(scope, run) {
 function consume_run_history_replay(scope) {
 	return safely(() => consume_run_history_replay_impl(scope), null);
 }
+/**
+* Applies the run staged by the history page, if this page load is the one it
+* was staged for. Every entry point that renders an app has to call this, or
+* "Load run" silently does nothing on that entry point.
+*
+* @returns whether a staged run was found and applied.
+*/
+function apply_run_history_replay(config) {
+	return safely(() => apply_run_history_replay_impl(config), false);
+}
 function start_run_history(options) {
 	return safely(() => start_run_history_impl(options), null);
 }
@@ -2567,6 +2598,7 @@ async function duplicate_space(app_reference, options) {
 exports.Client = Client;
 exports.FileData = FileData;
 exports.MISSING_CREDENTIALS_MSG = MISSING_CREDENTIALS_MSG;
+exports.apply_run_history_replay = apply_run_history_replay;
 exports.clear_run_history = clear_run_history;
 exports.client = client;
 exports.consume_run_history_replay = consume_run_history_replay;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { submit } from "./utils/submit";
 export { upload_files } from "./utils/upload_files";
 export { FileData, upload, prepare_files } from "./upload";
 export { handle_file } from "./helpers/data";
-export { clear_run_history, consume_run_history_replay, delete_run_history, on_run_history_change, read_run_history, run_history_url, stage_run_history_replay, type RunHistoryScope, type StoredRunComponent, type StoredRun } from "./utils/run_history";
+export { apply_run_history_replay, clear_run_history, consume_run_history_replay, delete_run_history, on_run_history_change, read_run_history, run_history_url, stage_run_history_replay, type ReplayTarget, type RunHistoryScope, type StoredRunComponent, type StoredRun } from "./utils/run_history";
 export type { SpaceStatus, StatusMessage, Status, client_return, UploadResponse, RenderMessage, LogMessage, Payload, Config, ValidationError } from "./types";
 export { MISSING_CREDENTIALS_MSG } from "./constants";
 export { client } from "./client";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACN,iBAAiB,EACjB,0BAA0B,EAC1B,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACX,WAAW,EACX,aAAa,EACb,MAAM,EACN,aAAa,EACb,cAAc,EACd,aAAa,EACb,UAAU,EACV,OAAO,EACP,MAAM,EACN,eAAe,EACf,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACN,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACX,WAAW,EACX,aAAa,EACb,MAAM,EACN,aAAa,EACb,cAAc,EACd,aAAa,EACb,UAAU,EACV,OAAO,EACP,MAAM,EACN,eAAe,EACf,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -1593,6 +1593,27 @@ function consume_run_history_replay_impl(scope) {
 		return null;
 	}
 }
+function restore_run_impl(config, run) {
+	const dependency = config.dependencies.find((item) => item.id === run.fn_index || typeof item.api_name === "string" && `/${item.api_name.replace(/^\//, "")}` === run.api_name);
+	if (!dependency) return false;
+	const inputs = Array.isArray(run.inputs) ? run.inputs : Object.values(run.inputs ?? {});
+	const outputs = Array.isArray(run.outputs) ? run.outputs : run.outputs === null || run.outputs === void 0 ? [] : [run.outputs];
+	const restore = (ids, saved) => {
+		for (const [index, id] of ids.entries()) {
+			const component = config.components.find((item) => item.id === id);
+			if (!component || index >= saved.length) continue;
+			if (component.type === "state") continue;
+			component.props.value = saved[index];
+		}
+	};
+	restore(dependency.inputs, inputs);
+	restore(dependency.outputs, outputs);
+	return true;
+}
+function apply_run_history_replay_impl(config) {
+	const run = consume_run_history_replay_impl(config);
+	return run ? restore_run_impl(config, run) : false;
+}
 function start_run_history_impl(options) {
 	const key = storage_key(options);
 	if (!key) return null;
@@ -1685,6 +1706,16 @@ function stage_run_history_replay(scope, run) {
 function consume_run_history_replay(scope) {
 	return safely(() => consume_run_history_replay_impl(scope), null);
 }
+/**
+* Applies the run staged by the history page, if this page load is the one it
+* was staged for. Every entry point that renders an app has to call this, or
+* "Load run" silently does nothing on that entry point.
+*
+* @returns whether a staged run was found and applied.
+*/
+function apply_run_history_replay(config) {
+	return safely(() => apply_run_history_replay_impl(config), false);
+}
 function start_run_history(options) {
 	return safely(() => start_run_history_impl(options), null);
 }
@@ -2563,4 +2594,4 @@ async function duplicate_space(app_reference, options) {
 	return await Client.duplicate(app_reference, options);
 }
 //#endregion
-export { Client, FileData, MISSING_CREDENTIALS_MSG, clear_run_history, client, consume_run_history_replay, delete_run_history, duplicate_space as duplicate, handle_file, on_run_history_change, predict, prepare_files, read_run_history, run_history_url, stage_run_history_replay, submit, upload, upload_files };
+export { Client, FileData, MISSING_CREDENTIALS_MSG, apply_run_history_replay, clear_run_history, client, consume_run_history_replay, delete_run_history, duplicate_space as duplicate, handle_file, on_run_history_change, predict, prepare_files, read_run_history, run_history_url, stage_run_history_replay, submit, upload, upload_files };

package/dist/index.min.js

@@ -1227,7 +1227,22 @@ function St(e) {
 		return null;
 	}
 }
-function Ct(e) {
+function Ct(e, t) {
+	let n = e.dependencies.find((e) => e.id === t.fn_index || typeof e.api_name == "string" && `/${e.api_name.replace(/^\//, "")}` === t.api_name);
+	if (!n) return !1;
+	let r = Array.isArray(t.inputs) ? t.inputs : Object.values(t.inputs ?? {}), i = Array.isArray(t.outputs) ? t.outputs : t.outputs === null || t.outputs === void 0 ? [] : [t.outputs], a = (t, n) => {
+		for (let [r, i] of t.entries()) {
+			let t = e.components.find((e) => e.id === i);
+			!t || r >= n.length || t.type !== "state" && (t.props.value = n[r]);
+		}
+	};
+	return a(n.inputs, r), a(n.outputs, i), !0;
+}
+function wt(e) {
+	let t = St(e);
+	return t ? Ct(e, t) : !1;
+}
+function Tt(e) {
 	let t = Y(e);
 	if (!t) return null;
 	pt(t);
@@ -1246,74 +1261,77 @@ function Ct(e) {
 	};
 	return ht(e, [n, ...Z(e)]), yt(), n.id;
 }
-function wt(e, t, n) {
+function Et(e, t, n) {
 	if (!t) return;
 	let r = Z(e), i = r.find((e) => e.id === t);
 	i && (i.inputs = X(n), ht(e, r));
 }
-function Tt(e, t, n) {
+function Dt(e, t, n) {
 	if (!t) return;
 	let r = Z(e), i = r.find((e) => e.id === t);
 	if (!i) return;
 	let a = !1;
 	if (n.type === "data") i.outputs = X(n.data), Q.set(t, i.outputs);
-	else if (n.type === "status" && n.original_msg === "process_starts") Ot(i, n.time);
+	else if (n.type === "status" && n.original_msg === "process_starts") At(i, n.time);
 	else if (n.type === "status" && (n.stage === "generating" || n.stage === "streaming")) i.streamed = !0;
-	else if (n.type === "status" && n.stage === "complete") i.status = "completed", kt(i, n), a = !0;
-	else if (n.type === "status" && n.stage === "error") i.status = "failed", i.error = typeof n.message == "string" ? n.message : JSON.stringify(n.message || "Unknown error"), kt(i, n), a = !0;
+	else if (n.type === "status" && n.stage === "complete") i.status = "completed", jt(i, n), a = !0;
+	else if (n.type === "status" && n.stage === "error") i.status = "failed", i.error = typeof n.message == "string" ? n.message : JSON.stringify(n.message || "Unknown error"), jt(i, n), a = !0;
 	else return;
-	if (a) Q.has(t) && (i.outputs = Q.get(t)), Q.delete(t), Dt.delete(t);
+	if (a) Q.has(t) && (i.outputs = Q.get(t)), Q.delete(t), kt.delete(t);
 	else if (i.streamed) {
-		if (Date.now() - (Dt.get(t) ?? 0) < Et) return;
-		Dt.set(t, Date.now()), Q.delete(t);
+		if (Date.now() - (kt.get(t) ?? 0) < Ot) return;
+		kt.set(t, Date.now()), Q.delete(t);
 	}
 	ht(e, r);
 }
-var Et = 500, Dt = /* @__PURE__ */ new Map(), Q = /* @__PURE__ */ new Map();
-function Ot(e, t) {
+var Ot = 500, kt = /* @__PURE__ */ new Map(), Q = /* @__PURE__ */ new Map();
+function At(e, t) {
 	if (e.process_started_at) return;
 	let n = t || /* @__PURE__ */ new Date();
 	e.process_started_at = n.toISOString(), e.queued_ms = Math.max(0, n.getTime() - Date.parse(e.started_at));
 }
-function kt(e, t) {
+function jt(e, t) {
 	let n = t.time || /* @__PURE__ */ new Date();
 	e.completed_at = n.toISOString(), e.duration_ms = (!e.streamed && typeof t.cache_duration == "number" && t.cache_duration >= 0 ? t.cache_duration * 1e3 : null) ?? Math.max(0, n.getTime() - Date.parse(e.process_started_at || e.started_at));
 }
-function At(e) {
+function Mt(e) {
 	return J(() => Z(e), []);
 }
-function jt(e) {
+function Nt(e) {
 	J(() => gt(e), void 0);
 }
-function Mt(e, t) {
+function Pt(e, t) {
 	J(() => _t(e, t), void 0);
 }
-function Nt(e, t) {
+function Ft(e, t) {
 	J(() => xt(e, t), void 0);
 }
-function Pt(e) {
+function It(e) {
 	return J(() => St(e), null);
 }
-function Ft(e) {
-	return J(() => Ct(e), null);
+function Lt(e) {
+	return J(() => wt(e), !1);
 }
-function It(e, t, n) {
-	J(() => wt(e, t, n), void 0);
+function Rt(e) {
+	return J(() => Tt(e), null);
 }
-function Lt(e, t, n) {
-	J(() => Tt(e, t, n), void 0);
+function zt(e, t, n) {
+	J(() => Et(e, t, n), void 0);
 }
-function Rt(e) {
+function Bt(e, t, n) {
+	J(() => Dt(e, t, n), void 0);
+}
+function Vt(e) {
 	return J(() => bt(() => J(e, void 0)), () => {});
 }
 //#endregion
 //#region src/utils/submit.ts
-function zt(e, t = {}, n, r, i, a) {
+function Ht(e, t = {}, n, r, i, a) {
 	try {
 		let { token: o } = this.options, { fetch: s, app_reference: c, config: l, session_hash: f, api_info: p, api_map: m, stream_status: h, pending_stream_messages: g, pending_diff_streams: ee, event_callbacks: _, unclosed_events: te, post_data: v, options: b, api_prefix: x } = this, S = a || { "x-gradio-user": "api" }, C = this;
 		if (!p) throw Error(se);
 		if (!l) throw Error("Could not resolve app config");
-		let { fn_index: w, endpoint_info: T, dependency: E } = Vt(p, e, m, l), ae = ye(t, T), D = l.protocol ?? "ws";
+		let { fn_index: w, endpoint_info: T, dependency: E } = Wt(p, e, m, l), ae = ye(t, T), D = l.protocol ?? "ws";
 		if (D === "ws") throw Error(ce);
 		let oe = typeof E.api_name == "string" ? `/${E.api_name}` : e, le = typeof E.api_name == "string" ? `/${E.api_name}` : `Function ${w}`, O = (e) => {
 			let t = l.components.find((t) => t.id === e);
@@ -1325,7 +1343,7 @@ function zt(e, t = {}, n, r, i, a) {
 		}, ue = E.api_visibility === "public", de = l.run_history !== !1 && this.options.record_history !== !1, k = {
 			app_id: l.app_id,
 			username: l.username
-		}, fe = !de || !ue ? null : Ft({
+		}, fe = !de || !ue ? null : Rt({
 			...k,
 			endpoint: oe,
 			api_name: le,
@@ -1335,7 +1353,7 @@ function zt(e, t = {}, n, r, i, a) {
 			output_components: E.outputs.map(O)
 		}), A, j = "", M = typeof e == "number" ? "/predict" : e, N, P = null, F = !1, I = {}, L = typeof window < "u" && typeof document < "u" ? new URLSearchParams(window.location.search).toString() : "", pe = b?.events?.reduce((e, t) => (e[t] = !0, e), {}) || {};
 		function R(e) {
-			Lt(k, fe, e), (i || pe[e.type]) && U(e);
+			Bt(k, fe, e), (i || pe[e.type]) && U(e);
 		}
 		async function me() {
 			let e = {}, t = {};
@@ -1376,7 +1394,7 @@ function zt(e, t = {}, n, r, i, a) {
 		}
 		let _e = this.handle_blob(l.root, ae, T).then(async (e) => {
 			let t = G(e, E, l.components, "input", !0);
-			if (It(k, fe, t || []), N = {
+			if (zt(k, fe, t || []), N = {
 				data: t || [],
 				event_data: n,
 				fn_index: w,
@@ -1678,7 +1696,7 @@ function zt(e, t = {}, n, r, i, a) {
 			B.length > 0 ? B.shift()(e) : z.push(e);
 		}
 		function xe(e) {
-			H(Bt(e)), V();
+			H(Ut(e)), V();
 		}
 		function U(e) {
 			H({
@@ -1718,10 +1736,10 @@ function zt(e, t = {}, n, r, i, a) {
 		throw console.error("Submit function encountered an error:", e), e;
 	}
 }
-function Bt(e) {
+function Ut(e) {
 	return { then: (t, n) => n(e) };
 }
-function Vt(e, t, n, r) {
+function Wt(e, t, n, r) {
 	let i, a, o;
 	if (typeof t == "number") i = t, a = e.unnamed_endpoints[i], o = r.dependencies.find((e) => e.id == t);
 	else {
@@ -1809,7 +1827,7 @@ var $ = class {
 	resolve_config;
 	resolve_cookies;
 	constructor(e, t = { events: ["data"] }) {
-		this.app_reference = e, this.deep_link = t.query_params?.deep_link || null, t.events ||= ["data"], k(t), this.options = t, this.current_payload = {}, t.cookies && (this.cookies = t.cookies), this.view_api = be.bind(this), this.upload_files = z.bind(this), this.handle_blob = ke.bind(this), this.post_data = Ne.bind(this), this.submit = zt.bind(this), this.predict = Pe.bind(this), this.open_stream = et.bind(this), this.resolve_config = j.bind(this), this.resolve_cookies = N.bind(this), this.upload = H.bind(this), this.fetch = this.fetch.bind(this), this.handle_space_success = this.handle_space_success.bind(this), this.stream = this.stream.bind(this);
+		this.app_reference = e, this.deep_link = t.query_params?.deep_link || null, t.events ||= ["data"], k(t), this.options = t, this.current_payload = {}, t.cookies && (this.cookies = t.cookies), this.view_api = be.bind(this), this.upload_files = z.bind(this), this.handle_blob = ke.bind(this), this.post_data = Ne.bind(this), this.submit = Ht.bind(this), this.predict = Pe.bind(this), this.open_stream = et.bind(this), this.resolve_config = j.bind(this), this.resolve_cookies = N.bind(this), this.upload = H.bind(this), this.fetch = this.fetch.bind(this), this.handle_space_success = this.handle_space_success.bind(this), this.stream = this.stream.bind(this);
 	}
 	async init() {
 		qe(), this.options.auth && await this.resolve_cookies(), await this._resolve_config().then((e) => e?.config && this._resolve_heartbeat(e.config));
@@ -1881,7 +1899,7 @@ var $ = class {
 		}
 	}
 	async config_success(e) {
-		if (this.config = e, this.api_prefix = e.api_prefix || "", e.run_history === !1 && jt({
+		if (this.config = e, this.api_prefix = e.api_prefix || "", e.run_history === !1 && Nt({
 			app_id: e.app_id,
 			username: e.username
 		}), this.config.auth_required) return this.prepare_return_obj();
@@ -1952,11 +1970,11 @@ var $ = class {
 		};
 	}
 };
-async function Ht(e, t = { events: ["data"] }) {
+async function Gt(e, t = { events: ["data"] }) {
 	return await $.connect(e, t);
 }
-async function Ut(e, t) {
+async function Kt(e, t) {
 	return await $.duplicate(e, t);
 }
 //#endregion
-export { $ as Client, U as FileData, ae as MISSING_CREDENTIALS_MSG, jt as clear_run_history, Ht as client, Pt as consume_run_history_replay, Mt as delete_run_history, Ut as duplicate, De as handle_file, Rt as on_run_history_change, Pe as predict, xe as prepare_files, At as read_run_history, ut as run_history_url, Nt as stage_run_history_replay, zt as submit, H as upload, z as upload_files };
+export { $ as Client, U as FileData, ae as MISSING_CREDENTIALS_MSG, Lt as apply_run_history_replay, Nt as clear_run_history, Gt as client, It as consume_run_history_replay, Pt as delete_run_history, Kt as duplicate, De as handle_file, Vt as on_run_history_change, Pe as predict, xe as prepare_files, Mt as read_run_history, ut as run_history_url, Ft as stage_run_history_replay, Ht as submit, H as upload, z as upload_files };

package/dist/utils/run_history.d.ts

@@ -51,11 +51,37 @@ interface StartRunOptions extends RunHistoryScope {
  * slash, so it cannot simply be concatenated with the path.
  */
 export declare function run_history_url(root: string, api_prefix?: string): string;
+/**
+ * The parts of an app config a replayed run writes back into. Kept structural
+ * so every entry point — the SPA and the SSR app each carry their own `Config`
+ * declaration — can hand its config straight over.
+ */
+export interface ReplayTarget {
+    components: {
+        id: number;
+        type: string;
+        props: Record<string, any>;
+    }[];
+    dependencies: {
+        id: number;
+        api_name?: string | null;
+        inputs: number[];
+        outputs: number[];
+    }[];
+}
 export declare function read_run_history(scope: RunHistoryScope | null | undefined): StoredRun[];
 export declare function clear_run_history(scope: RunHistoryScope | null | undefined): void;
 export declare function delete_run_history(scope: RunHistoryScope | null | undefined, id: string): void;
 export declare function stage_run_history_replay(scope: RunHistoryScope | null | undefined, run: StoredRun): void;
 export declare function consume_run_history_replay(scope: RunHistoryScope | null | undefined): StoredRun | null;
+/**
+ * Applies the run staged by the history page, if this page load is the one it
+ * was staged for. Every entry point that renders an app has to call this, or
+ * "Load run" silently does nothing on that entry point.
+ *
+ * @returns whether a staged run was found and applied.
+ */
+export declare function apply_run_history_replay(config: ReplayTarget & RunHistoryScope): boolean;
 export declare function start_run_history(options: StartRunOptions): string | null;
 export declare function update_run_inputs(scope: RunHistoryScope | null | undefined, id: string | null, inputs: unknown): void;
 export declare function update_run_history(scope: RunHistoryScope | null | undefined, id: string | null, event: GradioEvent): void;

package/dist/utils/run_history.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run_history.d.ts","sourceRoot":"","sources":["../../src/utils/run_history.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAiB,MAAM,UAAU,CAAC;AAgB3D,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAgBD,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,SAAS;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,gBAAgB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IACjD,iBAAiB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IAClD,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,eAAgB,SAAQ,eAAe;IAChD,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,gBAAgB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IACjD,iBAAiB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC9B,IAAI,EAAE,MAAM,EACZ,UAAU,SAAgB,GACxB,MAAM,CAER;AAkXD,wBAAgB,gBAAgB,CAC/B,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,SAAS,EAAE,CAEb;AAED,wBAAgB,iBAAiB,CAChC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,IAAI,CAEN;AAED,wBAAgB,kBAAkB,CACjC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GACR,IAAI,CAEN;AAED,wBAAgB,wBAAwB,CACvC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,GAAG,EAAE,SAAS,GACZ,IAAI,CAEN;AAED,wBAAgB,0BAA0B,CACzC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,SAAS,GAAG,IAAI,CAElB;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,CAEzE;AAED,wBAAgB,iBAAiB,CAChC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,MAAM,EAAE,OAAO,GACb,IAAI,CAEN;AAED,wBAAgB,kBAAkB,CACjC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,KAAK,EAAE,WAAW,GAChB,IAAI,CAEN;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAKtE"}
+{"version":3,"file":"run_history.d.ts","sourceRoot":"","sources":["../../src/utils/run_history.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAiB,MAAM,UAAU,CAAC;AAgB3D,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAgBD,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,SAAS;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,gBAAgB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IACjD,iBAAiB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IAClD,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,eAAgB,SAAQ,eAAe;IAChD,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,gBAAgB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;IACjD,iBAAiB,CAAC,EAAE,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC9B,IAAI,EAAE,MAAM,EACZ,UAAU,SAAgB,GACxB,MAAM,CAER;AA0ND;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,EAAE,CAAC;IACvE,YAAY,EAAE;QACb,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,EAAE,CAAC;KAClB,EAAE,CAAC;CACJ;AAmMD,wBAAgB,gBAAgB,CAC/B,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,SAAS,EAAE,CAEb;AAED,wBAAgB,iBAAiB,CAChC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,IAAI,CAEN;AAED,wBAAgB,kBAAkB,CACjC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GACR,IAAI,CAEN;AAED,wBAAgB,wBAAwB,CACvC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,GAAG,EAAE,SAAS,GACZ,IAAI,CAEN;AAED,wBAAgB,0BAA0B,CACzC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GACvC,SAAS,GAAG,IAAI,CAElB;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACvC,MAAM,EAAE,YAAY,GAAG,eAAe,GACpC,OAAO,CAET;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,CAEzE;AAED,wBAAgB,iBAAiB,CAChC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,MAAM,EAAE,OAAO,GACb,IAAI,CAEN;AAED,wBAAgB,kBAAkB,CACjC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,KAAK,EAAE,WAAW,GAChB,IAAI,CAEN;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAKtE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradio/client",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "Gradio API client",
   "type": "module",
   "main": "dist/index.cjs",

package/src/index.ts

@@ -6,6 +6,7 @@ export { upload_files } from "./utils/upload_files";
 export { FileData, upload, prepare_files } from "./upload";
 export { handle_file } from "./helpers/data";
 export {
+	apply_run_history_replay,
 	clear_run_history,
 	consume_run_history_replay,
 	delete_run_history,
@@ -13,6 +14,7 @@ export {
 	read_run_history,
 	run_history_url,
 	stage_run_history_replay,
+	type ReplayTarget,
 	type RunHistoryScope,
 	type StoredRunComponent,
 	type StoredRun

package/src/test/run_history.test.ts

@@ -1,6 +1,7 @@
 import { afterEach, describe, expect, test, vi } from "vitest";
 
 import {
+	apply_run_history_replay,
 	clear_run_history,
 	consume_run_history_replay,
 	delete_run_history,
@@ -314,6 +315,72 @@ describe.skipIf(!in_browser)("run history", () => {
 	});
 });
 
+describe.skipIf(!in_browser)("replaying a run", () => {
+	function make_config() {
+		return {
+			app_id,
+			components: [
+				{ id: 1, type: "textbox", props: { value: "default in" } },
+				{ id: 2, type: "state", props: { value: "server side" } },
+				{ id: 3, type: "image", props: { value: null } },
+				{ id: 4, type: "textbox", props: { value: "default out" } }
+			],
+			dependencies: [
+				{ id: 7, api_name: "transform", inputs: [1, 2], outputs: [3, 4] }
+			]
+		};
+	}
+
+	const stored = {
+		id: "run-1",
+		endpoint: "/transform",
+		api_name: "/transform",
+		fn_index: 7,
+		page: "/",
+		inputs: ["prompt", null],
+		outputs: [{ url: "http://localhost/image.webp" }, "described"],
+		status: "completed" as const,
+		started_at: new Date().toISOString()
+	};
+
+	test("writes the saved inputs and outputs back into the config", () => {
+		stage_run_history_replay(scope, stored);
+		const config = make_config();
+
+		expect(apply_run_history_replay(config)).toBe(true);
+		expect(config.components.map((component) => component.props.value)).toEqual(
+			["prompt", "server side", stored.outputs[0], "described"]
+		);
+		expect(apply_run_history_replay(make_config())).toBe(false);
+	});
+
+	test("matches the endpoint by api name when the fn index has moved", () => {
+		stage_run_history_replay(scope, { ...stored, fn_index: 99 });
+		const config = make_config();
+
+		expect(apply_run_history_replay(config)).toBe(true);
+		expect(config.components[3].props.value).toBe("described");
+	});
+
+	test("leaves the config alone when the endpoint is gone", () => {
+		stage_run_history_replay(scope, {
+			...stored,
+			fn_index: 99,
+			api_name: "/removed"
+		});
+		const config = make_config();
+
+		expect(apply_run_history_replay(config)).toBe(false);
+		expect(config.components.map((component) => component.props.value)).toEqual(
+			["default in", "server side", null, "default out"]
+		);
+	});
+
+	test("is a no-op when nothing was staged", () => {
+		expect(apply_run_history_replay(make_config())).toBe(false);
+	});
+});
+
 describe("run history url", () => {
 	test("joins the app root and the api prefix", () => {
 		expect(run_history_url("http://localhost:7860")).toBe(

package/src/utils/run_history.ts

@@ -308,6 +308,62 @@ function consume_run_history_replay_impl(
 	}
 }
 
+/**
+ * The parts of an app config a replayed run writes back into. Kept structural
+ * so every entry point — the SPA and the SSR app each carry their own `Config`
+ * declaration — can hand its config straight over.
+ */
+export interface ReplayTarget {
+	components: { id: number; type: string; props: Record<string, any> }[];
+	dependencies: {
+		id: number;
+		api_name?: string | null;
+		inputs: number[];
+		outputs: number[];
+	}[];
+}
+
+function restore_run_impl(config: ReplayTarget, run: StoredRun): boolean {
+	const dependency = config.dependencies.find(
+		(item) =>
+			item.id === run.fn_index ||
+			(typeof item.api_name === "string" &&
+				`/${item.api_name.replace(/^\//, "")}` === run.api_name)
+	);
+	if (!dependency) return false;
+
+	const inputs = Array.isArray(run.inputs)
+		? run.inputs
+		: Object.values((run.inputs ?? {}) as Record<string, unknown>);
+	const outputs = Array.isArray(run.outputs)
+		? run.outputs
+		: run.outputs === null || run.outputs === undefined
+			? []
+			: [run.outputs];
+
+	const restore = (ids: number[], saved: unknown[]): void => {
+		for (const [index, id] of ids.entries()) {
+			const component = config.components.find((item) => item.id === id);
+			if (!component || index >= saved.length) continue;
+			// `gr.State` is held on the server and always saved as null, so
+			// writing it back would wipe out the component's real default.
+			if (component.type === "state") continue;
+			component.props.value = saved[index];
+		}
+	};
+
+	restore(dependency.inputs, inputs);
+	restore(dependency.outputs, outputs);
+	return true;
+}
+
+function apply_run_history_replay_impl(
+	config: ReplayTarget & RunHistoryScope
+): boolean {
+	const run = consume_run_history_replay_impl(config);
+	return run ? restore_run_impl(config, run) : false;
+}
+
 function start_run_history_impl(options: StartRunOptions): string | null {
 	const key = storage_key(options);
 	if (!key) return null;
@@ -492,6 +548,19 @@ export function consume_run_history_replay(
 	return safely(() => consume_run_history_replay_impl(scope), null);
 }
 
+/**
+ * Applies the run staged by the history page, if this page load is the one it
+ * was staged for. Every entry point that renders an app has to call this, or
+ * "Load run" silently does nothing on that entry point.
+ *
+ * @returns whether a staged run was found and applied.
+ */
+export function apply_run_history_replay(
+	config: ReplayTarget & RunHistoryScope
+): boolean {
+	return safely(() => apply_run_history_replay_impl(config), false);
+}
+
 export function start_run_history(options: StartRunOptions): string | null {
 	return safely(() => start_run_history_impl(options), null);
 }