@gradio/client 0.16.0 → 0.18.0

package/src/utils/upload_files.ts

@@ -0,0 +1,51 @@
+import type { Client } from "..";
+import { BROKEN_CONNECTION_MSG, UPLOAD_URL } from "../constants";
+import type { UploadResponse } from "../types";
+
+export async function upload_files(
+	this: Client,
+	root_url: string,
+	files: (Blob | File)[],
+	upload_id?: string
+): Promise<UploadResponse> {
+	const headers: {
+		Authorization?: string;
+	} = {};
+	if (this?.options?.hf_token) {
+		headers.Authorization = `Bearer ${this.options.hf_token}`;
+	}
+
+	const chunkSize = 1000;
+	const uploadResponses = [];
+	let response: Response;
+
+	for (let i = 0; i < files.length; i += chunkSize) {
+		const chunk = files.slice(i, i + chunkSize);
+		const formData = new FormData();
+		chunk.forEach((file) => {
+			formData.append("files", file);
+		});
+		try {
+			const upload_url = upload_id
+				? `${root_url}/upload?upload_id=${upload_id}`
+				: `${root_url}/${UPLOAD_URL}`;
+
+			response = await this.fetch(upload_url, {
+				method: "POST",
+				body: formData,
+				headers
+			});
+		} catch (e) {
+			throw new Error(BROKEN_CONNECTION_MSG + (e as Error).message);
+		}
+		if (!response.ok) {
+			const error_text = await response.text();
+			return { error: `HTTP ${response.status}: ${error_text}` };
+		}
+		const output: UploadResponse["files"] = await response.json();
+		if (output) {
+			uploadResponses.push(...output);
+		}
+	}
+	return { files: uploadResponses };
+}

package/src/utils/view_api.ts

@@ -0,0 +1,67 @@
+import type { ApiInfo, ApiData } from "../types";
+import semiver from "semiver";
+import { API_INFO_URL, BROKEN_CONNECTION_MSG } from "../constants";
+import { Client } from "../client";
+import { SPACE_FETCHER_URL } from "../constants";
+import { transform_api_info } from "../helpers/api_info";
+
+export async function view_api(this: Client): Promise<any> {
+	if (this.api_info) return this.api_info;
+
+	const { hf_token } = this.options;
+	const { config } = this;
+
+	const headers: {
+		Authorization?: string;
+		"Content-Type": "application/json";
+	} = { "Content-Type": "application/json" };
+
+	if (hf_token) {
+		headers.Authorization = `Bearer ${hf_token}`;
+	}
+
+	if (!config) {
+		return;
+	}
+
+	try {
+		let response: Response;
+
+		if (semiver(config?.version || "2.0.0", "3.30") < 0) {
+			response = await this.fetch(SPACE_FETCHER_URL, {
+				method: "POST",
+				body: JSON.stringify({
+					serialize: false,
+					config: JSON.stringify(config)
+				}),
+				headers
+			});
+		} else {
+			response = await this.fetch(`${config?.root}/${API_INFO_URL}`, {
+				headers
+			});
+		}
+
+		if (!response.ok) {
+			throw new Error(BROKEN_CONNECTION_MSG);
+		}
+
+		let api_info = (await response.json()) as
+			| ApiInfo<ApiData>
+			| { api: ApiInfo<ApiData> };
+		if ("api" in api_info) {
+			api_info = api_info.api;
+		}
+
+		if (
+			api_info.named_endpoints["/predict"] &&
+			!api_info.unnamed_endpoints["0"]
+		) {
+			api_info.unnamed_endpoints[0] = api_info.named_endpoints["/predict"];
+		}
+
+		return transform_api_info(api_info, config, this.api_map);
+	} catch (e) {
+		"Could not get API info. " + (e as Error).message;
+	}
+}

package/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/tsconfig.json

@@ -7,8 +7,21 @@
 		"emitDeclarationOnly": true,
 		"outDir": "dist",
 		"declarationMap": true,
-		"module": "es2020",
+		"module": "ESNext",
+		"target": "ES2020",
+		"useDefineForClassFields": true,
+		"lib": ["ES2020", "DOM", "DOM.Iterable"],
+		"skipLibCheck": true,
+
+		/* Bundler */
 		"moduleResolution": "bundler",
-		"skipDefaultLibCheck": true
+		"skipDefaultLibCheck": true,
+		"allowImportingTsExtensions": true,
+		"esModuleInterop": true,
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+
+		/* Linting */
+		"strict": true
 	}
 }

package/vite.config.js

@@ -1,14 +1,14 @@
 import { defineConfig } from "vite";
 import { svelte } from "@sveltejs/vite-plugin-svelte";
-import { fileURLToPath } from "url";
-import path from "path";
-const __dirname = fileURLToPath(new URL(".", import.meta.url));
+
+const TEST_MODE = process.env.TEST_MODE || "happy-dom";
 
 export default defineConfig({
 	build: {
 		lib: {
 			entry: "src/index.ts",
-			formats: ["es"]
+			formats: ["es"],
+			fileName: (format) => `index.${format}.js`
 		},
 		rollupOptions: {
 			input: "src/index.ts",
@@ -17,22 +17,16 @@ export default defineConfig({
 			}
 		}
 	},
-	plugins: [
-		svelte()
-		// {
-		// 	name: "resolve-gradio-client",
-		// 	enforce: "pre",
-		// 	resolveId(id) {
-		// 		if (id === "@gradio/client") {
-		// 			return path.join(__dirname, "src", "index.ts");
-		// 		}
-		// 	}
-		// }
-	],
+	plugins: [svelte()],
 
+	mode: process.env.MODE || "development",
+	test: {
+		include: ["./src/test/*.test.*"],
+		environment: TEST_MODE
+	},
 	ssr: {
 		target: "node",
 		format: "esm",
-		noExternal: ["ws", "semiver", "@gradio/upload"]
+		noExternal: ["ws", "semiver", "bufferutil", "@gradio/upload"]
 	}
 });

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC3B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,OAAO,GACtB,MAAM,CAKR;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG;IACrD,WAAW,EAAE,IAAI,GAAG,KAAK,CAAC;IAC1B,aAAa,EAAE,OAAO,GAAG,QAAQ,CAAC;IAClC,IAAI,EAAE,MAAM,CAAC;CACb,CAgCA;AAED,eAAO,MAAM,aAAa,QAAqB,CAAC;AAChD,eAAO,MAAM,eAAe,QAAwB,CAAC;AACrD,wBAAsB,gBAAgB,CACrC,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,MAAM,MAAM,EAAE,GACpB,OAAO,CAAC;IACV,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,IAAI,GAAG,KAAK,CAAC;IAC1B,aAAa,EAAE,OAAO,GAAG,QAAQ,CAAC;CAClC,CAAC,CA4CD;AAED,wBAAgB,gBAAgB,CAC/B,GAAG,EAAE,MAAM,CAAC,cAAc,CAAC,GACzB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQxB;AAID,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAe5E;AAED,wBAAsB,kBAAkB,CACvC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,MAAM,EAAE,GACnB,OAAO,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAqB1C;AAED,wBAAsB,kBAAkB,CACvC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,EAC7C,KAAK,EAAE,MAAM,MAAM,EAAE,GACnB,OAAO,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAuB1C;AAED,wBAAsB,iBAAiB,CACtC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC,CAuBjB;AAED,eAAO,MAAM,cAAc,0GAQjB,CAAC;AAkDX,wBAAgB,UAAU,CACzB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,GACxC,GAAG,CAML;AAED,wBAAgB,YAAY,CAAC,GAAG,GAAG,GAAG,EACrC,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC,GAAG,CAAC,CASd"}

package/src/client.node-test.ts

@@ -1,172 +0,0 @@
-import { test, describe, assert } from "vitest";
-import { readFileSync } from "fs";
-import { join, dirname } from "path";
-import { fileURLToPath } from "url";
-import { Blob } from "node:buffer";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const image_path = join(
-	__dirname,
-	"..",
-	"..",
-	"..",
-	"demo",
-	"kitchen_sink",
-	"files",
-	"lion.jpg"
-);
-
-import { walk_and_store_blobs, client, handle_blob } from "./client";
-
-describe.skip("extract blob parts", () => {
-	test("convert Buffer to Blob", async () => {
-		const image = readFileSync(image_path);
-		await client("gradio/hello_world_main");
-		const parts = walk_and_store_blobs({
-			data: {
-				image
-			}
-		});
-
-		assert.isTrue(parts[0].blob instanceof Blob);
-	});
-
-	test("leave node Blob as Blob", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		await client("gradio/hello_world_main");
-		const parts = walk_and_store_blobs({
-			data: {
-				image
-			}
-		});
-
-		assert.isTrue(parts[0].blob instanceof Blob);
-	});
-
-	test("handle deep structures", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		await client("gradio/hello_world_main");
-		const parts = walk_and_store_blobs({
-			a: {
-				b: {
-					data: {
-						image
-					}
-				}
-			}
-		});
-
-		assert.isTrue(parts[0].blob instanceof Blob);
-	});
-
-	test("handle deep structures with arrays", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		await client("gradio/hello_world_main");
-		const parts = walk_and_store_blobs({
-			a: [
-				{
-					b: [
-						{
-							data: [
-								{
-									image
-								}
-							]
-						}
-					]
-				}
-			]
-		});
-
-		assert.isTrue(parts[0].blob instanceof Blob);
-	});
-
-	test("handle deep structures with arrays 2", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		await client("gradio/hello_world_main");
-		const obj = {
-			a: [
-				{
-					b: [
-						{
-							data: [[image], image, [image, [image]]]
-						}
-					]
-				}
-			]
-		};
-		const parts = walk_and_store_blobs(obj);
-
-		function map_path(
-			obj: Record<string, any>,
-			parts: { path: string[]; blob: any }[]
-		) {
-			const { path, blob } = parts[parts.length - 1];
-			let ref = obj;
-			path.forEach((p) => (ref = ref[p]));
-
-			return ref === blob;
-		}
-
-		assert.isTrue(parts[0].blob instanceof Blob);
-		// assert.isTrue(map_path(obj, parts));
-	});
-});
-
-describe("handle_blob", () => {
-	test("handle blobs", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		const app = await client("gradio/hello_world_main");
-		const obj = [
-			{
-				a: [
-					{
-						b: [
-							{
-								data: [[image], image, [image, [image]]]
-							}
-						]
-					}
-				]
-			}
-		];
-
-		const parts = await handle_blob(app.config.root, obj, undefined);
-		//@ts-ignore
-		// assert.isString(parts.data[0].a[0].b[0].data[0][0]);
-	});
-});
-
-describe.skip("private space", () => {
-	test("can access a private space", async () => {
-		const image = new Blob([readFileSync(image_path)]);
-
-		const app = await client("pngwn/hello_world", {
-			hf_token: "hf_"
-		});
-
-		console.log(app);
-		const obj = [
-			{
-				a: [
-					{
-						b: [
-							{
-								data: [[image], image, [image, [image]]]
-							}
-						]
-					}
-				]
-			}
-		];
-
-		const parts = await handle_blob(app.config.root, obj, "hf_");
-		//@ts-ignore
-		assert.isString(parts.data[0].a[0].b[0].data[0][0]);
-	});
-});

package/src/utils.ts

@@ -1,314 +0,0 @@
-import type { Config } from "./types.js";
-
-/**
- * This function is used to resolve the URL for making requests when the app has a root path.
- * The root path could be a path suffix like "/app" which is appended to the end of the base URL. Or
- * it could be a full URL like "https://abidlabs-test-client-replica--gqf2x.hf.space" which is used when hosting
- * Gradio apps on Hugging Face Spaces.
- * @param {string} base_url The base URL at which the Gradio server is hosted
- * @param {string} root_path The root path, which could be a path suffix (e.g. mounted in FastAPI app) or a full URL (e.g. hosted on Hugging Face Spaces)
- * @param {boolean} prioritize_base Whether to prioritize the base URL over the root path. This is used when both the base path and root paths are full URLs. For example, for fetching files the root path should be prioritized, but for making requests, the base URL should be prioritized.
- * @returns {string} the resolved URL
- */
-export function resolve_root(
-	base_url: string,
-	root_path: string,
-	prioritize_base: boolean
-): string {
-	if (root_path.startsWith("http://") || root_path.startsWith("https://")) {
-		return prioritize_base ? base_url : root_path;
-	}
-	return base_url + root_path;
-}
-
-export function determine_protocol(endpoint: string): {
-	ws_protocol: "ws" | "wss";
-	http_protocol: "http:" | "https:";
-	host: string;
-} {
-	if (endpoint.startsWith("http")) {
-		const { protocol, host } = new URL(endpoint);
-
-		if (host.endsWith("hf.space")) {
-			return {
-				ws_protocol: "wss",
-				host: host,
-				http_protocol: protocol as "http:" | "https:"
-			};
-		}
-		return {
-			ws_protocol: protocol === "https:" ? "wss" : "ws",
-			http_protocol: protocol as "http:" | "https:",
-			host
-		};
-	} else if (endpoint.startsWith("file:")) {
-		// This case is only expected to be used for the Wasm mode (Gradio-lite),
-		// where users can create a local HTML file using it and open the page in a browser directly via the `file:` protocol.
-		return {
-			ws_protocol: "ws",
-			http_protocol: "http:",
-			host: "lite.local" // Special fake hostname only used for this case. This matches the hostname allowed in `is_self_host()` in `js/wasm/network/host.ts`.
-		};
-	}
-
-	// default to secure if no protocol is provided
-	return {
-		ws_protocol: "wss",
-		http_protocol: "https:",
-		host: endpoint
-	};
-}
-
-export const RE_SPACE_NAME = /^[^\/]*\/[^\/]*$/;
-export const RE_SPACE_DOMAIN = /.*hf\.space\/{0,1}$/;
-export async function process_endpoint(
-	app_reference: string,
-	token?: `hf_${string}`
-): Promise<{
-	space_id: string | false;
-	host: string;
-	ws_protocol: "ws" | "wss";
-	http_protocol: "http:" | "https:";
-}> {
-	const headers: { Authorization?: string } = {};
-	if (token) {
-		headers.Authorization = `Bearer ${token}`;
-	}
-
-	const _app_reference = app_reference.trim();
-
-	if (RE_SPACE_NAME.test(_app_reference)) {
-		try {
-			const res = await fetch(
-				`https://huggingface.co/api/spaces/${_app_reference}/host`,
-				{ headers }
-			);
-
-			if (res.status !== 200)
-				throw new Error("Space metadata could not be loaded.");
-			const _host = (await res.json()).host;
-
-			return {
-				space_id: app_reference,
-				...determine_protocol(_host)
-			};
-		} catch (e: any) {
-			throw new Error("Space metadata could not be loaded." + e.message);
-		}
-	}
-
-	if (RE_SPACE_DOMAIN.test(_app_reference)) {
-		const { ws_protocol, http_protocol, host } =
-			determine_protocol(_app_reference);
-
-		return {
-			space_id: host.replace(".hf.space", ""),
-			ws_protocol,
-			http_protocol,
-			host
-		};
-	}
-
-	return {
-		space_id: false,
-		...determine_protocol(_app_reference)
-	};
-}
-
-export function map_names_to_ids(
-	fns: Config["dependencies"]
-): Record<string, number> {
-	let apis: Record<string, number> = {};
-
-	fns.forEach(({ api_name }, i) => {
-		if (api_name) apis[api_name] = i;
-	});
-
-	return apis;
-}
-
-const RE_DISABLED_DISCUSSION =
-	/^(?=[^]*\b[dD]iscussions{0,1}\b)(?=[^]*\b[dD]isabled\b)[^]*$/;
-export async function discussions_enabled(space_id: string): Promise<boolean> {
-	try {
-		const r = await fetch(
-			`https://huggingface.co/api/spaces/${space_id}/discussions`,
-			{
-				method: "HEAD"
-			}
-		);
-		const error = r.headers.get("x-error-message");
-
-		if (error && RE_DISABLED_DISCUSSION.test(error)) return false;
-		return true;
-	} catch (e) {
-		return false;
-	}
-}
-
-export async function get_space_hardware(
-	space_id: string,
-	token: `hf_${string}`
-): Promise<(typeof hardware_types)[number]> {
-	const headers: { Authorization?: string } = {};
-	if (token) {
-		headers.Authorization = `Bearer ${token}`;
-	}
-
-	try {
-		const res = await fetch(
-			`https://huggingface.co/api/spaces/${space_id}/runtime`,
-			{ headers }
-		);
-
-		if (res.status !== 200)
-			throw new Error("Space hardware could not be obtained.");
-
-		const { hardware } = await res.json();
-
-		return hardware;
-	} catch (e: any) {
-		throw new Error(e.message);
-	}
-}
-
-export async function set_space_hardware(
-	space_id: string,
-	new_hardware: (typeof hardware_types)[number],
-	token: `hf_${string}`
-): Promise<(typeof hardware_types)[number]> {
-	const headers: { Authorization?: string } = {};
-	if (token) {
-		headers.Authorization = `Bearer ${token}`;
-	}
-
-	try {
-		const res = await fetch(
-			`https://huggingface.co/api/spaces/${space_id}/hardware`,
-			{ headers, body: JSON.stringify(new_hardware) }
-		);
-
-		if (res.status !== 200)
-			throw new Error(
-				"Space hardware could not be set. Please ensure the space hardware provided is valid and that a Hugging Face token is passed in."
-			);
-
-		const { hardware } = await res.json();
-
-		return hardware;
-	} catch (e: any) {
-		throw new Error(e.message);
-	}
-}
-
-export async function set_space_timeout(
-	space_id: string,
-	timeout: number,
-	token: `hf_${string}`
-): Promise<number> {
-	const headers: { Authorization?: string } = {};
-	if (token) {
-		headers.Authorization = `Bearer ${token}`;
-	}
-
-	try {
-		const res = await fetch(
-			`https://huggingface.co/api/spaces/${space_id}/hardware`,
-			{ headers, body: JSON.stringify({ seconds: timeout }) }
-		);
-
-		if (res.status !== 200)
-			throw new Error(
-				"Space hardware could not be set. Please ensure the space hardware provided is valid and that a Hugging Face token is passed in."
-			);
-
-		const { hardware } = await res.json();
-
-		return hardware;
-	} catch (e: any) {
-		throw new Error(e.message);
-	}
-}
-
-export const hardware_types = [
-	"cpu-basic",
-	"cpu-upgrade",
-	"t4-small",
-	"t4-medium",
-	"a10g-small",
-	"a10g-large",
-	"a100-large"
-] as const;
-
-function apply_edit(
-	target: any,
-	path: (number | string)[],
-	action: string,
-	value: any
-): any {
-	if (path.length === 0) {
-		if (action === "replace") {
-			return value;
-		} else if (action === "append") {
-			return target + value;
-		}
-		throw new Error(`Unsupported action: ${action}`);
-	}
-
-	let current = target;
-	for (let i = 0; i < path.length - 1; i++) {
-		current = current[path[i]];
-	}
-
-	const last_path = path[path.length - 1];
-	switch (action) {
-		case "replace":
-			current[last_path] = value;
-			break;
-		case "append":
-			current[last_path] += value;
-			break;
-		case "add":
-			if (Array.isArray(current)) {
-				current.splice(Number(last_path), 0, value);
-			} else {
-				current[last_path] = value;
-			}
-			break;
-		case "delete":
-			if (Array.isArray(current)) {
-				current.splice(Number(last_path), 1);
-			} else {
-				delete current[last_path];
-			}
-			break;
-		default:
-			throw new Error(`Unknown action: ${action}`);
-	}
-	return target;
-}
-
-export function apply_diff(
-	obj: any,
-	diff: [string, (number | string)[], any][]
-): any {
-	diff.forEach(([action, path, value]) => {
-		obj = apply_edit(obj, path, action, value);
-	});
-
-	return obj;
-}
-
-export function post_message<Res = any>(
-	message: any,
-	origin: string
-): Promise<Res> {
-	return new Promise((res, _rej) => {
-		const channel = new MessageChannel();
-		channel.port1.onmessage = (({ data }) => {
-			channel.port1.close();
-			res(data);
-		}) as (ev: MessageEvent<Res>) => void;
-		window.parent.postMessage(message, origin, [channel.port2]);
-	});
-}