add queued commit support

Author: coyotte508

packages/hub/src/lib/commit.ts

@@ -127,15 +127,26 @@ export type CommitParams = {
 	 */
 	useXet?: boolean;
 	// Credentials are optional due to custom fetch functions or cookie auth
+
+	/**
+	 * If queued, will not return commit information in the output
+	 */
+	mode?: "queued" | "immediate";
 } & Partial<CredentialsParams>;
 
 export interface CommitOutput {
 	pullRequestUrl?: string;
-	commit: {
+	/**
+	 * Unset if queued commit, or empty commit
+	 */
+	commit?: {
 		oid: string;
 		url: string;
 	};
-	hookOutput: string;
+	/**
+	 * Unset if queued commit, or empty commit
+	 */
+	hookOutput?: string;
 }
 
 function isFileOperation(op: CommitOperation): op is CommitBlob {
@@ -640,6 +651,7 @@ export async function* commitIter(params: CommitParams): AsyncGenerator<CommitPr
 									summary: params.title,
 									description: params.description,
 									parentCommit: params.parentCommit,
+									mode: params.mode,
 								} satisfies ApiCommitHeader,
 							},
 							...((await Promise.all(
@@ -692,6 +704,11 @@ export async function* commitIter(params: CommitParams): AsyncGenerator<CommitPr
 							throw await createApiError(res);
 						}
 
+						if (res.status === 202) {
+							// Queued commit
+							returnCallback({});
+						}
+
 						const json = await res.json();
 
 						returnCallback({

packages/hub/src/lib/delete-file.ts

@@ -13,6 +13,7 @@ export function deleteFile(
 		branch?: CommitParams["branch"];
 		isPullRequest?: CommitParams["isPullRequest"];
 		parentCommit?: CommitParams["parentCommit"];
+		mode?: CommitParams["mode"];
 	} & CredentialsParams
 ): Promise<CommitOutput> {
 	return commit({
@@ -31,5 +32,6 @@ export function deleteFile(
 		isPullRequest: params.isPullRequest,
 		parentCommit: params.parentCommit,
 		fetch: params.fetch,
+		mode: params.mode,
 	});
 }

packages/hub/src/lib/delete-files.ts

@@ -12,6 +12,7 @@ export function deleteFiles(
 		branch?: CommitParams["branch"];
 		isPullRequest?: CommitParams["isPullRequest"];
 		parentCommit?: CommitParams["parentCommit"];
+		mode?: CommitParams["mode"];
 		fetch?: CommitParams["fetch"];
 	} & CredentialsParams
 ): Promise<CommitOutput> {
@@ -29,5 +30,6 @@ export function deleteFiles(
 		isPullRequest: params.isPullRequest,
 		parentCommit: params.parentCommit,
 		fetch: params.fetch,
+		mode: params.mode,
 	});
 }

packages/hub/src/lib/upload-file.ts

@@ -16,6 +16,7 @@ export function uploadFile(
 		useWebWorkers?: CommitParams["useWebWorkers"];
 		abortSignal?: CommitParams["abortSignal"];
 		useXet?: CommitParams["useXet"];
+		mode?: CommitParams["mode"];
 	} & Partial<CredentialsParams>
 ): Promise<CommitOutput> {
 	const path =
@@ -45,5 +46,6 @@ export function uploadFile(
 		useWebWorkers: params.useWebWorkers,
 		abortSignal: params.abortSignal,
 		useXet: params.useXet,
+		mode: params.mode,
 	});
 }

packages/hub/src/lib/upload-files-with-progress.ts

@@ -30,6 +30,7 @@ export async function* uploadFilesWithProgress(
 		abortSignal?: CommitParams["abortSignal"];
 		maxFolderDepth?: CommitParams["maxFolderDepth"];
 		useXet?: CommitParams["useXet"];
+		mode?: CommitParams["mode"];
 		/**
 		 * Set this to true in order to have progress events for hashing
 		 */
@@ -53,6 +54,7 @@ export async function* uploadFilesWithProgress(
 		useWebWorkers: params.useWebWorkers,
 		abortSignal: params.abortSignal,
 		useXet: params.useXet,
+		mode: params.mode,
 		fetch: async (input, init) => {
 			if (!init) {
 				return fetch(input);

packages/hub/src/lib/upload-files.ts

@@ -15,6 +15,7 @@ export function uploadFiles(
 		fetch?: CommitParams["fetch"];
 		useWebWorkers?: CommitParams["useWebWorkers"];
 		maxFolderDepth?: CommitParams["maxFolderDepth"];
+		mode?: CommitParams["mode"];
 		abortSignal?: CommitParams["abortSignal"];
 		useXet?: CommitParams["useXet"];
 	} & Partial<CredentialsParams>
@@ -37,5 +38,6 @@ export function uploadFiles(
 		useWebWorkers: params.useWebWorkers,
 		abortSignal: params.abortSignal,
 		useXet: params.useXet,
+		mode: params.mode,
 	});
 }

packages/hub/src/types/api/api-commit.ts

@@ -143,6 +143,12 @@ export interface ApiCommitHeader {
 	 * - When committing on a branch: Will make sure that there were no intermediate commits
 	 */
 	parentCommit?: string;
+	/**
+	 * queued => commit is pending
+	 * immediate => commit is processed immediately
+	 * flush => all pending commits are processed and merged into one commit
+	 */
+	mode?: "queued" | "immediate" | "flush";
 }
 
 export interface ApiCommitDeletedEntry {