@pierre/storage 0.7.0 → 0.9.0

package/src/types.ts

@@ -9,10 +9,15 @@ import type {
 	ListBranchesResponseRaw,
 	ListCommitsResponseRaw,
 	ListFilesResponseRaw,
+	ListReposResponseRaw,
+	NoteReadResponseRaw,
+	NoteWriteResponseRaw,
 	RawBranchInfo as SchemaRawBranchInfo,
 	RawCommitInfo as SchemaRawCommitInfo,
 	RawFileDiff as SchemaRawFileDiff,
 	RawFilteredFile as SchemaRawFilteredFile,
+	RawRepoBaseInfo as SchemaRawRepoBaseInfo,
+	RawRepoInfo as SchemaRawRepoInfo,
 } from './schemas';
 
 export interface OverrideableGitStorageOptions {
@@ -31,7 +36,7 @@ export interface GitStorageOptions extends OverrideableGitStorageOptions {
 export type ValidAPIVersion = 1;
 
 export interface GetRemoteURLOptions {
-	permissions?: ('git:write' | 'git:read' | 'repo:write')[];
+	permissions?: ('git:write' | 'git:read' | 'repo:write' | 'org:read')[];
 	ttl?: number;
 }
 
@@ -45,6 +50,10 @@ export interface Repo {
 	listFiles(options?: ListFilesOptions): Promise<ListFilesResult>;
 	listBranches(options?: ListBranchesOptions): Promise<ListBranchesResult>;
 	listCommits(options?: ListCommitsOptions): Promise<ListCommitsResult>;
+	getNote(options: GetNoteOptions): Promise<GetNoteResult>;
+	createNote(options: CreateNoteOptions): Promise<NoteWriteResult>;
+	appendNote(options: AppendNoteOptions): Promise<NoteWriteResult>;
+	deleteNote(options: DeleteNoteOptions): Promise<NoteWriteResult>;
 	getBranchDiff(options: GetBranchDiffOptions): Promise<GetBranchDiffResult>;
 	getCommitDiff(options: GetCommitDiffOptions): Promise<GetCommitDiffResult>;
 	grep(options: GrepOptions): Promise<GrepResult>;
@@ -74,7 +83,7 @@ export interface FindOneOptions {
 
 export type SupportedRepoProvider = 'github';
 
-export interface BaseRepo {
+export interface GitHubBaseRepo {
 	/**
 	 * @default github
 	 */
@@ -84,6 +93,45 @@ export interface BaseRepo {
 	defaultBranch?: string;
 }
 
+export interface ForkBaseRepo {
+	id: string;
+	ref?: string;
+	sha?: string;
+}
+
+export type BaseRepo = GitHubBaseRepo | ForkBaseRepo;
+
+export interface ListReposOptions extends GitStorageInvocationOptions {
+	cursor?: string;
+	limit?: number;
+}
+
+export type RawRepoBaseInfo = SchemaRawRepoBaseInfo;
+
+export interface RepoBaseInfo {
+	provider: string;
+	owner: string;
+	name: string;
+}
+
+export type RawRepoInfo = SchemaRawRepoInfo;
+
+export interface RepoInfo {
+	repoId: string;
+	url: string;
+	defaultBranch: string;
+	createdAt: string;
+	baseRepo?: RepoBaseInfo;
+}
+
+export type ListReposResponse = ListReposResponseRaw;
+
+export interface ListReposResult {
+	repos: RepoInfo[];
+	nextCursor?: string;
+	hasMore: boolean;
+}
+
 export interface CreateRepoOptions extends GitStorageInvocationOptions {
 	id?: string;
 	baseRepo?: BaseRepo;
@@ -192,6 +240,52 @@ export interface ListCommitsResult {
 	hasMore: boolean;
 }
 
+// Git notes API types
+export interface GetNoteOptions extends GitStorageInvocationOptions {
+	sha: string;
+}
+
+export type GetNoteResponse = NoteReadResponseRaw;
+
+export interface GetNoteResult {
+	sha: string;
+	note: string;
+	refSha: string;
+}
+
+interface NoteWriteBaseOptions extends GitStorageInvocationOptions {
+	sha: string;
+	note: string;
+	expectedRefSha?: string;
+	author?: CommitSignature;
+}
+
+export type CreateNoteOptions = NoteWriteBaseOptions;
+
+export type AppendNoteOptions = NoteWriteBaseOptions;
+
+export interface DeleteNoteOptions extends GitStorageInvocationOptions {
+	sha: string;
+	expectedRefSha?: string;
+	author?: CommitSignature;
+}
+
+export interface NoteWriteResultPayload {
+	success: boolean;
+	status: string;
+	message?: string;
+}
+
+export type NoteWriteResponse = NoteWriteResponseRaw;
+
+export interface NoteWriteResult {
+	sha: string;
+	targetRef: string;
+	baseCommit?: string;
+	newRefSha: string;
+	result: NoteWriteResultPayload;
+}
+
 // Branch Diff API types
 export interface GetBranchDiffOptions extends GitStorageInvocationOptions {
 	branch: string;