@huggingface/hub/src/utils/toRepoId.ts

Utilities to interact with the Hugging Face hub

import type { RepoDesignation, RepoId } from "../types/public";

export function toRepoId(repo: RepoDesignation): RepoId {
	if (typeof repo !== "string") {
		return repo;
	}

	if (repo.startsWith("model/") || repo.startsWith("models/")) {
		throw new TypeError(
			"A repo designation for a model should not start with 'models/', directly specify the model namespace / name",
		);
	}

	if (repo.startsWith("space/")) {
		throw new TypeError("Spaces should start with 'spaces/', plural, not 'space/'");
	}

	if (repo.startsWith("dataset/")) {
		throw new TypeError("Datasets should start with 'datasets/', plural, not 'dataset/'");
	}

	if (repo.startsWith("bucket/")) {
		throw new TypeError("Buckets should start with 'buckets/', plural, not 'bucket/'");
	}

	if (repo.startsWith("kernel/")) {
		throw new TypeError("Kernels should start with 'kernels/', plural, not 'kernel/'");
	}

	const slashes = repo.split("/").length - 1;

	if (repo.startsWith("spaces/")) {
		if (slashes !== 2) {
			throw new TypeError("Space Id must include namespace and name of the space");
		}

		return {
			type: "space",
			name: repo.slice("spaces/".length),
		};
	}

	if (repo.startsWith("datasets/")) {
		if (slashes > 2) {
			throw new TypeError("Too many slashes in repo designation: " + repo);
		}

		return {
			type: "dataset",
			name: repo.slice("datasets/".length),
		};
	}

	if (repo.startsWith("buckets/")) {
		if (slashes !== 2) {
			throw new TypeError("Bucket Id must include namespace and name of the bucket");
		}

		return {
			type: "bucket",
			name: repo.slice("buckets/".length),
		};
	}

	if (repo.startsWith("kernels/")) {
		if (slashes !== 2) {
			throw new TypeError("Kernel Id must include namespace and name of the kernel");
		}

		return {
			type: "kernel",
			name: repo.slice("kernels/".length),
		};
	}

	if (slashes > 1) {
		throw new TypeError("Too many slashes in repo designation: " + repo);
	}

	return {
		type: "model",
		name: repo,
	};
}