💥 Simpler credentials passing around (#918)

Fix #149 Should have backwards compatibilty, just marked as deprecated
huggingface · Sep 23, 2024 · 400ea89 · 400ea89
1 parent 68602cd
commit 400ea89
Show file tree

Hide file tree

Showing 31 changed files with 466 additions and 452 deletions.
diff --git a/README.md b/README.md
@@ -14,12 +14,12 @@
 
 await createRepo({
   repo: {type: "model", name: "my-user/nlp-model"},
-  credentials: {accessToken: HF_TOKEN}
+  accessToken: HF_TOKEN
 });
 
 await uploadFile({
   repo: "my-user/nlp-model",
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   // Can work with native File in browsers
   file: {
     path: "pytorch_model.bin",
@@ -79,7 +79,7 @@ Then import the libraries in your code:
 import { HfInference } from "@huggingface/inference";
 import { HfAgent } from "@huggingface/agents";
 import { createRepo, commit, deleteRepo, listFiles } from "@huggingface/hub";
-import type { RepoId, Credentials } from "@huggingface/hub";
+import type { RepoId } from "@huggingface/hub";
 ```
 
 ### From CDN or Static hosting
@@ -182,12 +182,12 @@ const HF_TOKEN = "hf_...";
 
 await createRepo({
   repo: "my-user/nlp-model", // or {type: "model", name: "my-user/nlp-test"},
-  credentials: {accessToken: HF_TOKEN}
+  accessToken: HF_TOKEN
 });
 
 await uploadFile({
   repo: "my-user/nlp-model",
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   // Can work with native File in browsers
   file: {
     path: "pytorch_model.bin",
@@ -197,7 +197,7 @@ await uploadFile({
 
 await deleteFiles({
   repo: {type: "space", name: "my-user/my-space"}, // or "spaces/my-user/my-space"
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   paths: ["README.md", ".gitattributes"]
 });
 ```

diff --git a/packages/hub/README.md b/packages/hub/README.md
@@ -31,22 +31,21 @@ Learn how to find free models using the hub package in this [interactive tutoria
 
 ```ts
 import { createRepo, uploadFiles, uploadFilesWithProgress, deleteFile, deleteRepo, listFiles, whoAmI } from "@huggingface/hub";
-import type { RepoDesignation, Credentials } from "@huggingface/hub";
+import type { RepoDesignation } from "@huggingface/hub";
 
 const repo: RepoDesignation = { type: "model", name: "myname/some-model" };
-const credentials: Credentials = { accessToken: "hf_..." };
 
-const {name: username} = await whoAmI({credentials});
+const {name: username} = await whoAmI({accessToken: "hf_..."});
 
-for await (const model of listModels({search: {owner: username}, credentials})) {
+for await (const model of listModels({search: {owner: username}, accessToken: "hf_..."})) {
   console.log("My model:", model);
 }
 
-await createRepo({ repo, credentials, license: "mit" });
+await createRepo({ repo, accessToken: "hf_...", license: "mit" });
 
 await uploadFiles({
   repo,
-  credentials,
+  accessToken: "hf_...",
   files: [
     // path + blob content
     {
@@ -70,23 +69,23 @@ await uploadFiles({
 
 for await (const progressEvent of await uploadFilesWithProgress({
   repo,
-  credentials,
+  accessToken: "hf_...",
   files: [
     ...
   ],
 })) {
   console.log(progressEvent);
 }
 
-await deleteFile({repo, credentials, path: "myfile.bin"});
+await deleteFile({repo, accessToken: "hf_...", path: "myfile.bin"});
 
 await (await downloadFile({ repo, path: "README.md" })).text();
 
 for await (const fileInfo of listFiles({repo})) {
   console.log(fileInfo);
 }
 
-await deleteRepo({ repo, credentials });
+await deleteRepo({ repo, accessToken: "hf_..." });
 ```
 
 ## OAuth Login

diff --git a/packages/hub/src/lib/commit.spec.ts b/packages/hub/src/lib/commit.spec.ts
@@ -25,9 +25,7 @@ describe("commit", () => {
 		};
 
 		await createRepo({
-			credentials: {
-				accessToken: TEST_ACCESS_TOKEN,
-			},
+			accessToken: TEST_ACCESS_TOKEN,
 			hubUrl: TEST_HUB_URL,
 			repo,
 			license: "mit",
@@ -50,9 +48,7 @@ describe("commit", () => {
 			await commit({
 				repo,
 				title: "Some commit",
-				credentials: {
-					accessToken: TEST_ACCESS_TOKEN,
-				},
+				accessToken: TEST_ACCESS_TOKEN,
 				hubUrl: TEST_HUB_URL,
 				operations: [
 					{
@@ -135,9 +131,7 @@ size ${lfsContent.length}
 		};
 
 		await createRepo({
-			credentials: {
-				accessToken: TEST_ACCESS_TOKEN,
-			},
+			accessToken: TEST_ACCESS_TOKEN,
 			repo,
 			hubUrl: TEST_HUB_URL,
 		});
@@ -163,9 +157,7 @@ size ${lfsContent.length}
 			);
 			await commit({
 				repo,
-				credentials: {
-					accessToken: TEST_ACCESS_TOKEN,
-				},
+				accessToken: TEST_ACCESS_TOKEN,
 				hubUrl: TEST_HUB_URL,
 				title: "upload model",
 				operations,

diff --git a/packages/hub/src/lib/commit.ts b/packages/hub/src/lib/commit.ts
@@ -10,7 +10,7 @@ import type {
 	ApiPreuploadRequest,
 	ApiPreuploadResponse,
 } from "../types/api/api-commit";
-import type { Credentials, RepoDesignation } from "../types/public";
+import type { CredentialsParams, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
 import { chunk } from "../utils/chunk";
 import { promisesQueue } from "../utils/promisesQueue";
@@ -54,12 +54,11 @@ type CommitBlob = Omit<CommitFile, "content"> & { content: Blob };
 export type CommitOperation = CommitDeletedEntry | CommitFile /* | CommitRenameFile */;
 type CommitBlobOperation = Exclude<CommitOperation, CommitFile> | CommitBlob;
 
-export interface CommitParams {
+export type CommitParams = {
 	title: string;
 	description?: string;
 	repo: RepoDesignation;
 	operations: CommitOperation[];
-	credentials?: Credentials;
 	/** @default "main" */
 	branch?: string;
 	/**
@@ -82,7 +81,8 @@ export interface CommitParams {
 	 */
 	fetch?: typeof fetch;
 	abortSignal?: AbortSignal;
-}
+	// Credentials are optional due to custom fetch functions or cookie auth
+} & Partial<CredentialsParams>;
 
 export interface CommitOutput {
 	pullRequestUrl?: string;
@@ -121,7 +121,7 @@ export type CommitProgressEvent =
  * Can be exposed later to offer fine-tuned progress info
  */
 export async function* commitIter(params: CommitParams): AsyncGenerator<CommitProgressEvent, CommitOutput> {
-	checkCredentials(params.credentials);
+	const accessToken = checkCredentials(params);
 	const repoId = toRepoId(params.repo);
 	yield { event: "phase", phase: "preuploading" };
 
@@ -189,7 +189,7 @@ export async function* commitIter(params: CommitParams): AsyncGenerator<CommitPr
 				{
 					method: "POST",
 					headers: {
-						...(params.credentials && { Authorization: `Bearer ${params.credentials.accessToken}` }),
+						...(accessToken && { Authorization: `Bearer ${accessToken}` }),
 						"Content-Type": "application/json",
 					},
 					body: JSON.stringify(payload),
@@ -263,7 +263,7 @@ export async function* commitIter(params: CommitParams): AsyncGenerator<CommitPr
 				{
 					method: "POST",
 					headers: {
-						...(params.credentials && { Authorization: `Bearer ${params.credentials.accessToken}` }),
+						...(accessToken && { Authorization: `Bearer ${accessToken}` }),
 						Accept: "application/vnd.git-lfs+json",
 						"Content-Type": "application/vnd.git-lfs+json",
 					},
@@ -468,7 +468,7 @@ export async function* commitIter(params: CommitParams): AsyncGenerator<CommitPr
 					{
 						method: "POST",
 						headers: {
-							...(params.credentials && { Authorization: `Bearer ${params.credentials.accessToken}` }),
+							...(accessToken && { Authorization: `Bearer ${accessToken}` }),
 							"Content-Type": "application/x-ndjson",
 						},
 						body: [

diff --git a/packages/hub/src/lib/count-commits.ts b/packages/hub/src/lib/count-commits.ts
@@ -1,20 +1,21 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
-import type { Credentials, RepoDesignation } from "../types/public";
+import type { CredentialsParams, RepoDesignation } from "../types/public";
 import { checkCredentials } from "../utils/checkCredentials";
 import { toRepoId } from "../utils/toRepoId";
 
-export async function countCommits(params: {
-	credentials?: Credentials;
-	repo: RepoDesignation;
-	/**
-	 * Revision to list commits from. Defaults to the default branch.
-	 */
-	revision?: string;
-	hubUrl?: string;
-	fetch?: typeof fetch;
-}): Promise<number> {
-	checkCredentials(params.credentials);
+export async function countCommits(
+	params: {
+		repo: RepoDesignation;
+		/**
+		 * Revision to list commits from. Defaults to the default branch.
+		 */
+		revision?: string;
+		hubUrl?: string;
+		fetch?: typeof fetch;
+	} & Partial<CredentialsParams>
+): Promise<number> {
+	const accessToken = checkCredentials(params);
 	const repoId = toRepoId(params.repo);
 
 	// Could upgrade to 1000 commits per page
@@ -23,7 +24,7 @@ export async function countCommits(params: {
 	}?limit=1`;
 
 	const res: Response = await (params.fetch ?? fetch)(url, {
-		headers: params.credentials ? { Authorization: `Bearer ${params.credentials.accessToken}` } : {},
+		headers: accessToken ? { Authorization: `Bearer ${accessToken}` } : {},
 	});
 
 	if (!res.ok) {

diff --git a/packages/hub/src/lib/create-repo.spec.ts b/packages/hub/src/lib/create-repo.spec.ts
@@ -11,9 +11,7 @@ describe("createRepo", () => {
 		const repoName = `${TEST_USER}/TEST-${insecureRandomString()}`;
 
 		const result = await createRepo({
-			credentials: {
-				accessToken: TEST_ACCESS_TOKEN,
-			},
+			accessToken: TEST_ACCESS_TOKEN,
 			repo: {
 				name: repoName,
 				type: "model",
@@ -62,9 +60,7 @@ describe("createRepo", () => {
 		const repoName = `${TEST_USER}/TEST-${insecureRandomString()}`;
 
 		const result = await createRepo({
-			credentials: {
-				accessToken: TEST_ACCESS_TOKEN,
-			},
+			accessToken: TEST_ACCESS_TOKEN,
 			hubUrl: TEST_HUB_URL,
 			repo: repoName,
 			files: [{ path: ".gitattributes", content: new Blob(["*.html filter=lfs diff=lfs merge=lfs -text"]) }],
@@ -88,9 +84,7 @@ describe("createRepo", () => {
 		const repoName = `datasets/${TEST_USER}/TEST-${insecureRandomString()}`;
 
 		const result = await createRepo({
-			credentials: {
-				accessToken: TEST_ACCESS_TOKEN,
-			},
+			accessToken: TEST_ACCESS_TOKEN,
 			hubUrl: TEST_HUB_URL,
 			repo: repoName,
 			files: [{ path: ".gitattributes", content: new Blob(["*.html filter=lfs diff=lfs merge=lfs -text"]) }],

diff --git a/packages/hub/src/lib/create-repo.ts b/packages/hub/src/lib/create-repo.ts
@@ -1,29 +1,30 @@
 import { HUB_URL } from "../consts";
 import { createApiError } from "../error";
 import type { ApiCreateRepoPayload } from "../types/api/api-create-repo";
-import type { Credentials, RepoDesignation, SpaceSdk } from "../types/public";
+import type { CredentialsParams, 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: RepoDesignation;
-	credentials: Credentials;
-	private?: boolean;
-	license?: string;
-	/**
-	 * Only a few lightweight files are supported at repo creation
-	 */
-	files?: Array<{ content: ArrayBuffer | Blob; path: string }>;
-	/** @required for when {@link repo.type} === "space" */
-	sdk?: SpaceSdk;
-	hubUrl?: string;
-	/**
-	 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
-	 */
-	fetch?: typeof fetch;
-}): Promise<{ repoUrl: string }> {
-	checkCredentials(params.credentials);
+export async function createRepo(
+	params: {
+		repo: RepoDesignation;
+		private?: boolean;
+		license?: string;
+		/**
+		 * Only a few lightweight files are supported at repo creation
+		 */
+		files?: Array<{ content: ArrayBuffer | Blob; path: string }>;
+		/** @required for when {@link repo.type} === "space" */
+		sdk?: SpaceSdk;
+		hubUrl?: string;
+		/**
+		 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
+		 */
+		fetch?: typeof fetch;
+	} & CredentialsParams
+): Promise<{ repoUrl: string }> {
+	const accessToken = checkCredentials(params);
 	const repoId = toRepoId(params.repo);
 	const [namespace, repoName] = repoId.name.split("/");
 
@@ -61,7 +62,7 @@ export async function createRepo(params: {
 				: undefined,
 		} satisfies ApiCreateRepoPayload),
 		headers: {
-			Authorization: `Bearer ${params.credentials.accessToken}`,
+			Authorization: `Bearer ${accessToken}`,
 			"Content-Type": "application/json",
 		},
 	});

diff --git a/packages/hub/src/lib/delete-file.spec.ts b/packages/hub/src/lib/delete-file.spec.ts
@@ -12,13 +12,10 @@ describe("deleteFile", () => {
 	it("should delete a file", async () => {
 		const repoName = `${TEST_USER}/TEST-${insecureRandomString()}`;
 		const repo = { type: "model", name: repoName } satisfies RepoId;
-		const credentials = {
-			accessToken: TEST_ACCESS_TOKEN,
-		};
 
 		try {
 			const result = await createRepo({
-				credentials,
+				accessToken: TEST_ACCESS_TOKEN,
 				hubUrl: TEST_HUB_URL,
 				repo,
 				files: [
@@ -39,7 +36,7 @@ describe("deleteFile", () => {
 
 			assert.strictEqual(await content?.text(), "file1");
 
-			await deleteFile({ path: "file1", repo, credentials, hubUrl: TEST_HUB_URL });
+			await deleteFile({ path: "file1", repo, accessToken: TEST_ACCESS_TOKEN, hubUrl: TEST_HUB_URL });
 
 			content = await downloadFile({
 				repo,
@@ -59,7 +56,7 @@ describe("deleteFile", () => {
 		} finally {
 			await deleteRepo({
 				repo,
-				credentials,
+				accessToken: TEST_ACCESS_TOKEN,
 				hubUrl: TEST_HUB_URL,
 			});
 		}