@pierre/storage 0.0.9 → 0.0.11

package/src/types.ts

@@ -32,6 +32,8 @@ export interface Repo {
 	getBranchDiff(options: GetBranchDiffOptions): Promise<GetBranchDiffResponse>;
 	getCommitDiff(options: GetCommitDiffOptions): Promise<GetCommitDiffResponse>;
 	getCommit(options: GetCommitOptions): Promise<GetCommitResponse>;
+	pullUpstream(options: PullUpstreamOptions): Promise<void>;
+	createCommit(options: CreateCommitOptions): CommitBuilder;
 }
 
 export type ValidMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
@@ -80,7 +82,7 @@ export interface GetFileOptions extends GitStorageInvocationOptions {
 	ref?: string;
 }
 
-export interface RepullOptions extends GitStorageInvocationOptions {
+export interface PullUpstreamOptions extends GitStorageInvocationOptions {
 	ref?: string;
 }
 
@@ -211,6 +213,61 @@ export interface GetCommitResponse {
 	};
 }
 
+export interface CreateCommitOptions extends GitStorageInvocationOptions {
+	targetRef: string;
+	commitMessage: string;
+	baseRef?: string;
+	author?: CommitSignature;
+	committer?: CommitSignature;
+	signal?: AbortSignal;
+}
+
+export interface CommitSignature {
+	name: string;
+	email: string;
+	date?: string;
+}
+
+export type CommitFileSource =
+	| string
+	| Uint8Array
+	| ArrayBuffer
+	| AsyncIterable<Uint8Array | ArrayBuffer>
+	| Iterable<Uint8Array | ArrayBuffer>;
+
+export interface CommitFileOptions {
+	mode?: string;
+}
+
+export interface CommitTextFileOptions extends CommitFileOptions {
+	encoding?: 'utf8' | 'utf-8';
+}
+
+export interface CommitBuilder {
+	addFile(path: string, source: CommitFileSource, options?: CommitFileOptions): CommitBuilder;
+	addFileFromString(path: string, contents: string, options?: CommitTextFileOptions): CommitBuilder;
+	deletePath(path: string): CommitBuilder;
+	send(): Promise<CommitResponse>;
+}
+
+export interface CommitResponse {
+	commit: {
+		commit_sha: string;
+		tree_sha: string;
+		target_ref: string;
+		pack_bytes: number;
+		blob_count: number;
+	};
+	result: {
+		ref: string;
+		old_sha: string; // 40-hex previous tip; all zeroes when the ref is newly created.
+		new_sha: string;
+		success: boolean;
+		status: string;
+		message?: string;
+	};
+}
+
 // Webhook types
 export interface WebhookValidationOptions {
 	/**