@gradio/client 0.0.1 → 0.1.0

package/src/globals.d.ts

@@ -0,0 +1,31 @@
+declare global {
+	interface Window {
+		__gradio_mode__: "app" | "website";
+		launchGradio: Function;
+		launchGradioFromSpaces: Function;
+		gradio_config: Config;
+		scoped_css_attach: (link: HTMLLinkElement) => void;
+		__is_colab__: boolean;
+	}
+}
+
+export interface Config {
+	auth_required: boolean | undefined;
+	auth_message: string;
+	components: any[];
+	css: string | null;
+	dependencies: any[];
+	dev_mode: boolean;
+	enable_queue: boolean;
+	layout: any;
+	mode: "blocks" | "interface";
+	root: string;
+	theme: string;
+	title: string;
+	version: string;
+	is_space: boolean;
+	is_colab: boolean;
+	show_api: boolean;
+	stylesheets: string[];
+	path: string;
+}

package/src/index.ts

@@ -1,2 +1,2 @@
-export { client, post_data, upload_files } from "./client";
-export type { SpaceStatus } from "./types";
+export { client, post_data, upload_files, duplicate } from "./client.js";
+export type { SpaceStatus } from "./types.js";

package/src/types.ts

@@ -21,7 +21,9 @@ export interface Config {
 
 export interface Payload {
 	data: Array<unknown>;
-	fn_index: number;
+	fn_index?: number;
+	event_data?: unknown;
+	time?: Date;
 }
 
 export interface PostResponse {
@@ -35,18 +37,21 @@ export interface UploadResponse {
 
 export interface Status {
 	queue: boolean;
-	status: "pending" | "error" | "complete" | "generating";
+	code?: string;
+	success?: boolean;
+	stage: "pending" | "error" | "complete" | "generating";
 	size?: number;
 	position?: number;
 	eta?: number;
 	message?: string;
-	progress?: Array<{
+	progress_data?: Array<{
 		progress: number | null;
 		index: number | null;
 		length: number | null;
 		unit: string | null;
 		desc: string | null;
 	}>;
+	time?: Date;
 }
 
 export interface SpaceStatusNormal {
@@ -75,7 +80,7 @@ export type SpaceStatusCallback = (a: SpaceStatus) => void;
 export type EventType = "data" | "status";
 
 export interface EventMap {
-	data: Record<string, any>;
+	data: Payload;
 	status: Status;
 }
 

package/src/utils.ts

@@ -1,4 +1,4 @@
-import type { Config } from "./types";
+import type { Config } from "./types.js";
 
 export function determine_protocol(endpoint: string): {
 	ws_protocol: "ws" | "wss";
@@ -33,24 +33,40 @@ export function determine_protocol(endpoint: string): {
 
 export const RE_SPACE_NAME = /^[^\/]*\/[^\/]*$/;
 export const RE_SPACE_DOMAIN = /.*hf\.space\/{0,1}$/;
-export async function process_endpoint(app_reference: string): Promise<{
+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)) {
-		const _host = (
-			await (
-				await fetch(`https://huggingface.co/api/spaces/${_app_reference}/host`)
-			).json()
-		).host;
-		return {
-			space_id: app_reference,
-			...determine_protocol(_host)
-		};
+		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) {
+			throw new Error("Space metadata could not be loaded." + e.message);
+		}
 	}
 
 	if (RE_SPACE_DOMAIN.test(_app_reference)) {
@@ -99,3 +115,97 @@ export async function discussions_enabled(space_id: string) {
 		return false;
 	}
 }
+
+export async function get_space_hardware(
+	space_id: string,
+	token: `hf_${string}`
+) {
+	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) {
+		throw new Error(e.message);
+	}
+}
+
+export async function set_space_hardware(
+	space_id: string,
+	new_hardware: typeof hardware_types[number],
+	token: `hf_${string}`
+) {
+	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) {
+		throw new Error(e.message);
+	}
+}
+
+export async function set_space_timeout(
+	space_id: string,
+	timeout: number,
+	token: `hf_${string}`
+) {
+	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) {
+		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;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+	"include": ["src/**/*"],
+	"exclude": ["src/**/*.test.ts", "src/**/*.node-test.ts"],
+	"compilerOptions": {
+		"allowJs": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"outDir": "dist",
+		"declarationMap": true,
+		"module": "es2020",
+		"moduleResolution": "node16",
+		"skipDefaultLibCheck": true
+	}
+}

package/vite.config.js

@@ -0,0 +1,23 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	build: {
+		// minify: true,
+		lib: {
+			entry: "src/index.ts",
+			formats: ["es"]
+		},
+		rollupOptions: {
+			input: "src/index.ts",
+			output: {
+				dir: "dist"
+			}
+		}
+	},
+
+	ssr: {
+		target: "node",
+		format: "esm",
+		noExternal: "ws"
+	}
+});