🧑‍💻 Add aliases for repo names (#128)

coyotte508 · web-flow · commit 1766706b39d9 · 2023-04-04T14:08:11.000+02:00
diff --git a/README.md b/README.md
@@ -55,19 +55,19 @@ You can run our packages with vanilla JS, without any bundler, by using a CDN or
 ## Usage example
 
 ```ts
-import { createRepo, uploadFile } from "@huggingface/hub";
+import { createRepo, uploadFile, deleteFiles } from "@huggingface/hub";
 import { HfInference } from "@huggingface/inference";
 
 // use an access token from your free account
 const HF_ACCESS_TOKEN = "hf_...";
 
 await createRepo({
-  repo: {type: "model", name: "my-user/nlp-test"},
+  repo: "my-user/nlp-model", // or {type: "model", name: "my-user/nlp-test"},
   credentials: {accessToken: HF_ACCESS_TOKEN}
 });
 
 await uploadFile({
-  repo: {type: "model", name: "my-user/nlp-test"},
+  repo: "my-user/nlp-model",
   credentials: {accessToken: HF_ACCESS_TOKEN},
   // Can work with native File in browsers
   file: {
@@ -76,6 +76,12 @@ await uploadFile({
   }
 });
 
+await deleteFiles({
+  repo: {type: "space", name: "my-user/my-space"}, // or "spaces/my-user/my-space"
+  credentials: {accessToken: HF_ACCESS_TOKEN},
+  paths: ["README.md", ".gitattributes"]
+});
+
 const inference = new HfInference(HF_ACCESS_TOKEN);
 
 await inference.translation({
diff --git a/packages/hub/README.md b/packages/hub/README.md
@@ -14,9 +14,9 @@ For some of the calls, you need to create an account and generate an [access tok
 
 ```ts
 import { createRepo, uploadFiles, deleteFile, deleteRepo, listFiles, whoAmI } from "@huggingface/hub";
-import type { RepoId, Credentials } from "@huggingface/hub";
+import type { RepoDesignation, Credentials } from "@huggingface/hub";
 
-const repo: RepoId = { type: "model", name: "myname/some-model" };
+const repo: RepoDesignation = { type: "model", name: "myname/some-model" };
 const credentials: Credentials = { accessToken: "hf_..." };
 
 const {name: username} = await whoAmI({credentials});
diff --git a/packages/hub/src/index.ts b/packages/hub/src/index.ts
@@ -5,6 +5,8 @@ export type {
 	AccessTokenRole,
 	AuthType,
 	Credentials,
+	RepoDesignation,
+	RepoFullName,
 	RepoId,
 	RepoType,
 	SpaceHardwareFlavor,
diff --git a/packages/hub/src/lib/commit.ts b/packages/hub/src/lib/commit.ts
@@ -10,14 +10,15 @@ import type {
 	ApiPreuploadRequest,
 	ApiPreuploadResponse,
 } from "../types/api/api-commit";
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials, RepoDesignation } from "../types/public";
 import { base64FromBytes } from "../utils/base64FromBytes";
 import { checkCredentials } from "../utils/checkCredentials";
 import { chunk } from "../utils/chunk";
 import { isFrontend } from "../utils/env-predicates";
 import { promisesQueue } from "../utils/promisesQueue";
 import { promisesQueueStreaming } from "../utils/promisesQueueStreaming";
 import { sha256 } from "../utils/sha256";
+import { toRepoId } from "../utils/toRepoId";
 import { WebBlob } from "../utils/WebBlob";
 
 const CONCURRENT_SHAS = 5;
@@ -54,7 +55,7 @@ type CommitBlobOperation = Exclude<CommitOperation, CommitFile> | CommitBlob;
 export interface CommitParams {
 	title: string;
 	description?: string;
-	repo: RepoId;
+	repo: RepoDesignation;
 	operations: CommitOperation[];
 	credentials: Credentials;
 	/** @default "main" */
@@ -124,6 +125,7 @@ async function createBlob(url: URL): Promise<Blob> {
  */
 async function* commitIter(params: CommitParams): AsyncGenerator<unknown, CommitOutput> {
 	checkCredentials(params.credentials);
+	const repoId = toRepoId(params.repo);
 	yield "preuploading";
 
 	const lfsShas = new Map<string, string | null>();
@@ -163,7 +165,7 @@ async function* commitIter(params: CommitParams): AsyncGenerator<unknown, Commit
 		};
 
 		const res = await fetch(
-			`${params.hubUrl ?? HUB_URL}/api/${params.repo.type}s/${params.repo.name}/preupload/${encodeURIComponent(
+			`${params.hubUrl ?? HUB_URL}/api/${repoId.type}s/${repoId.name}/preupload/${encodeURIComponent(
 				params.branch ?? "main"
 			)}` + (params.isPullRequest ? "?create_pr=1" : ""),
 			{
@@ -221,8 +223,8 @@ async function* commitIter(params: CommitParams): AsyncGenerator<unknown, Commit
 		};
 
 		const res = await fetch(
-			`${params.hubUrl ?? HUB_URL}/${params.repo.type === "model" ? "" : params.repo.type + "s/"}${
-				params.repo.name
+			`${params.hubUrl ?? HUB_URL}/${repoId.type === "model" ? "" : repoId.type + "s/"}${
+				repoId.name
 			}.git/info/lfs/objects/batch`,
 			{
 				method: "POST",
@@ -355,7 +357,7 @@ async function* commitIter(params: CommitParams): AsyncGenerator<unknown, Commit
 	yield "committing";
 
 	const res = await fetch(
-		`${params.hubUrl ?? HUB_URL}/api/${params.repo.type}s/${params.repo.name}/commit/${encodeURIComponent(
+		`${params.hubUrl ?? HUB_URL}/api/${repoId.type}s/${repoId.name}/commit/${encodeURIComponent(
 			params.branch ?? "main"
 		)}` + (params.isPullRequest ? "?create_pr=1" : ""),
 		{
diff --git a/packages/hub/src/lib/create-repo.spec.ts b/packages/hub/src/lib/create-repo.spec.ts
@@ -53,4 +53,49 @@ describe("createRepo", () => {
 
 		await expect(tryCreate).rejects.toBeInstanceOf(TypeError);
 	});
+
+	it("should create a model with a string as name", async () => {
+		const repoName = `${TEST_USER}/TEST-${insecureRandomString()}`;
+
+		const result = await createRepo({
+			credentials: {
+				accessToken: TEST_ACCESS_TOKEN,
+			},
+			repo: repoName,
+			files: [{ path: ".gitattributes", content: new Blob(["*.html filter=lfs diff=lfs merge=lfs -text"]) }],
+		});
+
+		assert.deepStrictEqual(result, {
+			repoUrl: `${HUB_URL}/${repoName}`,
+		});
+
+		await deleteRepo({
+			repo: {
+				name: repoName,
+				type: "model",
+			},
+			credentials: { accessToken: TEST_ACCESS_TOKEN },
+		});
+	});
+
+	it("should create a dataset with a string as name", async () => {
+		const repoName = `datasets/${TEST_USER}/TEST-${insecureRandomString()}`;
+
+		const result = await createRepo({
+			credentials: {
+				accessToken: TEST_ACCESS_TOKEN,
+			},
+			repo: repoName,
+			files: [{ path: ".gitattributes", content: new Blob(["*.html filter=lfs diff=lfs merge=lfs -text"]) }],
+		});
+
+		assert.deepStrictEqual(result, {
+			repoUrl: `${HUB_URL}/${repoName}`,
+		});
+
+		await deleteRepo({
+			repo: repoName,
+			credentials: { accessToken: TEST_ACCESS_TOKEN },
+		});
+	});
 });
diff --git a/packages/hub/src/lib/create-repo.ts b/packages/hub/src/lib/create-repo.ts
@@ -1,12 +1,13 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
 import type { ApiCreateRepoPayload } from "../types/api/api-create-repo";
-import type { Credentials, RepoId, SpaceSdk } from "../types/public";
+import type { Credentials, RepoDesignation, SpaceSdk } from "../types/public";
 import { base64FromBytes } from "../utils/base64FromBytes";
 import { checkCredentials } from "../utils/checkCredentials";
+import { toRepoId } from "../utils/toRepoId";
 
 export async function createRepo(params: {
-	repo: RepoId;
+	repo: RepoDesignation;
 	credentials: Credentials;
 	private?: boolean;
 	license?: string;
@@ -19,11 +20,12 @@ export async function createRepo(params: {
 	hubUrl?: string;
 }): Promise<{ repoUrl: string }> {
 	checkCredentials(params.credentials);
-	const [namespace, repoName] = params.repo.name.split("/");
+	const repoId = toRepoId(params.repo);
+	const [namespace, repoName] = repoId.name.split("/");
 
 	if (!namespace || !repoName) {
 		throw new TypeError(
-			`"${params.repo.name}" is not a fully qualified repo name. It should be of the form "{namespace}/{repoName}".`
+			`"${repoId.name}" is not a fully qualified repo name. It should be of the form "{namespace}/{repoName}".`
 		);
 	}
 
@@ -34,13 +36,13 @@ export async function createRepo(params: {
 			private: params.private,
 			organization: namespace,
 			license: params.license,
-			...(params.repo.type === "space"
+			...(repoId.type === "space"
 				? {
 						type: "space",
 						sdk: "static",
 				  }
 				: {
-						type: params.repo.type,
+						type: repoId.type,
 				  }),
 			files: params.files
 				? await Promise.all(
diff --git a/packages/hub/src/lib/delete-repo.ts b/packages/hub/src/lib/delete-repo.ts
@@ -1,18 +1,24 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
+import { toRepoId } from "../utils/toRepoId";
 
-export async function deleteRepo(params: { repo: RepoId; credentials: Credentials; hubUrl?: string }): Promise<void> {
+export async function deleteRepo(params: {
+	repo: RepoDesignation;
+	credentials: Credentials;
+	hubUrl?: string;
+}): Promise<void> {
 	checkCredentials(params.credentials);
-	const [namespace, repoName] = params.repo.name.split("/");
+	const repoId = toRepoId(params.repo);
+	const [namespace, repoName] = repoId.name.split("/");
 
 	const res = await fetch(`${params.hubUrl ?? HUB_URL}/api/repos/delete`, {
 		method: "DELETE",
 		body: JSON.stringify({
 			name: repoName,
 			organization: namespace,
-			type: params.repo.type,
+			type: repoId.type,
 		}),
 		headers: {
 			Authorization: `Bearer ${params.credentials.accessToken}`,
diff --git a/packages/hub/src/lib/deleteFile.ts b/packages/hub/src/lib/deleteFile.ts
@@ -1,10 +1,10 @@
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials } from "../types/public";
 import type { CommitOutput, CommitParams } from "./commit";
 import { commit } from "./commit";
 
 export function deleteFile(params: {
 	credentials: Credentials;
-	repo: RepoId;
+	repo: CommitParams["repo"];
 	path: string;
 	commitTitle?: CommitParams["title"];
 	commitDescription?: CommitParams["description"];
diff --git a/packages/hub/src/lib/deleteFiles.ts b/packages/hub/src/lib/deleteFiles.ts
@@ -1,10 +1,10 @@
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials } from "../types/public";
 import type { CommitOutput, CommitParams } from "./commit";
 import { commit } from "./commit";
 
 export function deleteFiles(params: {
 	credentials: Credentials;
-	repo: RepoId;
+	repo: CommitParams["repo"];
 	paths: string[];
 	commitTitle?: CommitParams["title"];
 	commitDescription?: CommitParams["description"];
diff --git a/packages/hub/src/lib/download-file.ts b/packages/hub/src/lib/download-file.ts
@@ -1,13 +1,14 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
+import { toRepoId } from "../utils/toRepoId";
 
 /**
  * @returns null when the file doesn't exist
  */
 export async function downloadFile(params: {
-	repo: RepoId;
+	repo: RepoDesignation;
 	path: string;
 	/**
 	 * If true, will download the raw git file.
@@ -20,9 +21,10 @@ export async function downloadFile(params: {
 	hubUrl?: string;
 }): Promise<Response | null> {
 	checkCredentials(params.credentials);
-	const url = `${params.hubUrl ?? HUB_URL}/${params.repo.type === "model" ? "" : `${params.repo.type}s/`}${
-		params.repo.name
-	}/${params.raw ? "raw" : "resolve"}/${encodeURIComponent(params.revision ?? "main")}/${params.path}`;
+	const repoId = toRepoId(params.repo);
+	const url = `${params.hubUrl ?? HUB_URL}/${repoId.type === "model" ? "" : `${repoId.type}s/`}${repoId.name}/${
+		params.raw ? "raw" : "resolve"
+	}/${encodeURIComponent(params.revision ?? "main")}/${params.path}`;
 
 	const resp = await fetch(url, {
 		headers: params.credentials
diff --git a/packages/hub/src/lib/file-download-info.ts b/packages/hub/src/lib/file-download-info.ts
@@ -1,7 +1,8 @@
 import { HUB_URL } from "../consts";
 import { createApiError, InvalidApiResponseFormatError } from "../error";
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
+import { toRepoId } from "../utils/toRepoId";
 
 export interface FileDownloadInfoOutput {
 	size: number;
@@ -15,7 +16,7 @@ export interface FileDownloadInfoOutput {
  * @returns null when the file doesn't exist
  */
 export async function fileDownloadInfo(params: {
-	repo: RepoId;
+	repo: RepoDesignation;
 	path: string;
 	revision?: string;
 	credentials?: Credentials;
@@ -32,10 +33,11 @@ export async function fileDownloadInfo(params: {
 	noContentDisposition?: boolean;
 }): Promise<FileDownloadInfoOutput | null> {
 	checkCredentials(params.credentials);
+	const repoId = toRepoId(params.repo);
 
 	const hubUrl = params.hubUrl ?? HUB_URL;
 	const url =
-		`${hubUrl}/${params.repo.type === "model" ? "" : `${params.repo.type}s/`}${params.repo.name}/${
+		`${hubUrl}/${repoId.type === "model" ? "" : `${repoId.type}s/`}${repoId.name}/${
 			params.raw ? "raw" : "resolve"
 		}/${encodeURIComponent(params.revision ?? "main")}/${params.path}` +
 		(params.noContentDisposition ? "?noContentDisposition=1" : "");
diff --git a/packages/hub/src/lib/list-files.ts b/packages/hub/src/lib/list-files.ts
@@ -1,9 +1,10 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
 import type { ApiIndexTreeEntry } from "../types/api/api-index-tree";
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
 import { parseLinkHeader } from "../utils/parseLinkHeader";
+import { toRepoId } from "../utils/toRepoId";
 
 export interface ListFileEntry {
 	type: "file" | "directory" | "unknown";
@@ -29,7 +30,7 @@ export interface ListFileEntry {
  * with {@link params.recursive} set to `true`.
  */
 export async function* listFiles(params: {
-	repo: RepoId;
+	repo: RepoDesignation;
 	/**
 	 * Do we want to list files in subdirectories?
 	 */
@@ -44,7 +45,8 @@ export async function* listFiles(params: {
 	hubUrl?: string;
 }): AsyncGenerator<ListFileEntry> {
 	checkCredentials(params.credentials);
-	let url: string | undefined = `${params.hubUrl || HUB_URL}/api/${params.repo.type}s/${params.repo.name}/tree/${
+	const repoId = toRepoId(params.repo);
+	let url: string | undefined = `${params.hubUrl || HUB_URL}/api/${repoId.type}s/${repoId.name}/tree/${
 		params.revision || "main"
 	}${params.path ? "/" + params.path : ""}${params.recursive ? "?recursive=true" : ""}`;
 
diff --git a/packages/hub/src/lib/uploadFile.ts b/packages/hub/src/lib/uploadFile.ts
@@ -1,10 +1,10 @@
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials } from "../types/public";
 import type { CommitOutput, CommitParams, ContentSource } from "./commit";
 import { commit } from "./commit";
 
 export function uploadFile(params: {
 	credentials: Credentials;
-	repo: RepoId;
+	repo: CommitParams["repo"];
 	file: URL | File | { path: string; content: ContentSource };
 	commitTitle?: CommitParams["title"];
 	commitDescription?: CommitParams["description"];
diff --git a/packages/hub/src/lib/uploadFiles.ts b/packages/hub/src/lib/uploadFiles.ts
@@ -1,10 +1,10 @@
-import type { Credentials, RepoId } from "../types/public";
+import type { Credentials } from "../types/public";
 import type { CommitOutput, CommitParams, ContentSource } from "./commit";
 import { commit } from "./commit";
 
 export function uploadFiles(params: {
 	credentials: Credentials;
-	repo: RepoId;
+	repo: CommitParams["repo"];
 	files: Array<URL | File | { path: string; content: ContentSource }>;
 	commitTitle?: CommitParams["title"];
 	commitDescription?: CommitParams["description"];
diff --git a/packages/hub/src/types/public.d.ts b/packages/hub/src/types/public.d.ts
diff --git a/packages/hub/src/utils/toRepoId.ts b/packages/hub/src/utils/toRepoId.ts
