@pierre/storage 0.1.0 → 0.1.2

package/src/index.ts

@@ -9,15 +9,15 @@ import snakecaseKeys from 'snakecase-keys';
 import { createCommitBuilder, FetchCommitTransport, resolveCommitTtlSeconds } from './commit';
 import { RefUpdateError } from './errors';
 import { ApiFetcher } from './fetch';
-import type { ResetCommitAckRaw } from './schemas';
+import type { RestoreCommitAckRaw } from './schemas';
 import {
 	branchDiffResponseSchema,
 	commitDiffResponseSchema,
 	listBranchesResponseSchema,
 	listCommitsResponseSchema,
 	listFilesResponseSchema,
-	resetCommitAckSchema,
-	resetCommitResponseSchema,
+	restoreCommitAckSchema,
+	restoreCommitResponseSchema,
 } from './schemas';
 import type {
 	BranchInfo,
@@ -54,8 +54,8 @@ import type {
 	RawFilteredFile,
 	RefUpdate,
 	Repo,
-	ResetCommitOptions,
-	ResetCommitResult,
+	RestoreCommitOptions,
+	RestoreCommitResult,
 	ValidAPIVersion,
 } from './types';
 
@@ -84,7 +84,7 @@ const API_VERSION: ValidAPIVersion = 1;
 
 const apiInstanceMap = new Map<string, ApiFetcher>();
 const DEFAULT_TOKEN_TTL_SECONDS = 60 * 60; // 1 hour
-const RESET_COMMIT_ALLOWED_STATUS = [
+const RESTORE_COMMIT_ALLOWED_STATUS = [
 	400, // Bad Request - validation errors
 	401, // Unauthorized - missing/invalid auth header
 	403, // Forbidden - missing git:write scope
@@ -111,9 +111,9 @@ function resolveInvocationTtlSeconds(
 	return defaultValue;
 }
 
-type ResetCommitAck = ResetCommitAckRaw;
+type RestoreCommitAck = RestoreCommitAckRaw;
 
-function toRefUpdate(result: ResetCommitAck['result']): RefUpdate {
+function toRefUpdate(result: RestoreCommitAck['result']): RefUpdate {
 	return {
 		branch: result.branch,
 		oldSha: result.old_sha,
@@ -121,11 +121,11 @@ function toRefUpdate(result: ResetCommitAck['result']): RefUpdate {
 	};
 }
 
-function buildResetCommitResult(ack: ResetCommitAck): ResetCommitResult {
+function buildRestoreCommitResult(ack: RestoreCommitAck): RestoreCommitResult {
 	const refUpdate = toRefUpdate(ack.result);
 	if (!ack.result.success) {
 		throw new RefUpdateError(
-			ack.result.message ?? `Reset commit failed with status ${ack.result.status}`,
+			ack.result.message ?? `Restore commit failed with status ${ack.result.status}`,
 			{
 				status: ack.result.status,
 				message: ack.result.message,
@@ -142,7 +142,7 @@ function buildResetCommitResult(ack: ResetCommitAck): ResetCommitResult {
 	};
 }
 
-interface ResetCommitFailureInfo {
+interface RestoreCommitFailureInfo {
 	status?: string;
 	message?: string;
 	refUpdate?: Partial<RefUpdate>;
@@ -166,15 +166,15 @@ function toPartialRefUpdate(
 	return Object.keys(refUpdate).length > 0 ? refUpdate : undefined;
 }
 
-function parseResetCommitPayload(
+function parseRestoreCommitPayload(
 	payload: unknown,
-): { ack: ResetCommitAck } | { failure: ResetCommitFailureInfo } | null {
-	const ack = resetCommitAckSchema.safeParse(payload);
+): { ack: RestoreCommitAck } | { failure: RestoreCommitFailureInfo } | null {
+	const ack = restoreCommitAckSchema.safeParse(payload);
 	if (ack.success) {
 		return { ack: ack.data };
 	}
 
-	const failure = resetCommitResponseSchema.safeParse(payload);
+	const failure = restoreCommitResponseSchema.safeParse(payload);
 	if (failure.success) {
 		const result = failure.data.result;
 		return {
@@ -189,7 +189,7 @@ function parseResetCommitPayload(
 	return null;
 }
 
-function httpStatusToResetStatus(status: number): string {
+function httpStatusToRestoreStatus(status: number): string {
 	switch (status) {
 		case 409:
 			return 'conflict';
@@ -500,25 +500,25 @@ class RepoImpl implements Repo {
 		return;
 	}
 
-	async resetCommit(options: ResetCommitOptions): Promise<ResetCommitResult> {
+	async restoreCommit(options: RestoreCommitOptions): Promise<RestoreCommitResult> {
 		const targetBranch = options?.targetBranch?.trim();
 		if (!targetBranch) {
-			throw new Error('resetCommit targetBranch is required');
+			throw new Error('restoreCommit targetBranch is required');
 		}
 		if (targetBranch.startsWith('refs/')) {
-			throw new Error('resetCommit targetBranch must not include refs/ prefix');
+			throw new Error('restoreCommit targetBranch must not include refs/ prefix');
 		}
 
 		const targetCommitSha = options?.targetCommitSha?.trim();
 		if (!targetCommitSha) {
-			throw new Error('resetCommit targetCommitSha is required');
+			throw new Error('restoreCommit targetCommitSha is required');
 		}
 		const commitMessage = options?.commitMessage?.trim();
 
 		const authorName = options.author?.name?.trim();
 		const authorEmail = options.author?.email?.trim();
 		if (!authorName || !authorEmail) {
-			throw new Error('resetCommit author name and email are required');
+			throw new Error('restoreCommit author name and email are required');
 		}
 
 		const ttl = resolveCommitTtlSeconds(options);
@@ -549,7 +549,7 @@ class RepoImpl implements Repo {
 			const committerName = options.committer.name?.trim();
 			const committerEmail = options.committer.email?.trim();
 			if (!committerName || !committerEmail) {
-				throw new Error('resetCommit committer name and email are required when provided');
+				throw new Error('restoreCommit committer name and email are required when provided');
 			}
 			metadata.committer = {
 				name: committerName,
@@ -557,21 +557,25 @@ class RepoImpl implements Repo {
 			};
 		}
 
-		const response = await this.api.post({ path: 'repos/reset-commits', body: { metadata } }, jwt, {
-			allowedStatus: [...RESET_COMMIT_ALLOWED_STATUS],
-		});
+		const response = await this.api.post(
+			{ path: 'repos/restore-commit', body: { metadata } },
+			jwt,
+			{
+				allowedStatus: [...RESTORE_COMMIT_ALLOWED_STATUS],
+			},
+		);
 
 		const payload = await response.json();
-		const parsed = parseResetCommitPayload(payload);
+		const parsed = parseRestoreCommitPayload(payload);
 		if (parsed && 'ack' in parsed) {
-			return buildResetCommitResult(parsed.ack);
+			return buildRestoreCommitResult(parsed.ack);
 		}
 
 		const failure = parsed && 'failure' in parsed ? parsed.failure : undefined;
-		const status = failure?.status ?? httpStatusToResetStatus(response.status);
+		const status = failure?.status ?? httpStatusToRestoreStatus(response.status);
 		const message =
 			failure?.message ??
-			`Reset commit failed with HTTP ${response.status}` +
+			`Restore commit failed with HTTP ${response.status}` +
 				(response.statusText ? ` ${response.statusText}` : '');
 
 		throw new RefUpdateError(message, {

package/src/schemas.ts

@@ -90,7 +90,7 @@ export const commitPackCommitSchema = z.object({
 	blob_count: z.number(),
 });
 
-export const resetCommitCommitSchema = commitPackCommitSchema.omit({ blob_count: true });
+export const restoreCommitCommitSchema = commitPackCommitSchema.omit({ blob_count: true });
 
 export const refUpdateResultWithOptionalsSchema = z.object({
 	branch: z.string().optional(),
@@ -106,8 +106,8 @@ export const commitPackAckSchema = z.object({
 	result: refUpdateResultSchema,
 });
 
-export const resetCommitAckSchema = z.object({
-	commit: resetCommitCommitSchema,
+export const restoreCommitAckSchema = z.object({
+	commit: restoreCommitCommitSchema,
 	result: refUpdateResultSchema.extend({ success: z.literal(true) }),
 });
 
@@ -116,8 +116,8 @@ export const commitPackResponseSchema = z.object({
 	result: refUpdateResultWithOptionalsSchema,
 });
 
-export const resetCommitResponseSchema = z.object({
-	commit: resetCommitCommitSchema.partial().optional().nullable(),
+export const restoreCommitResponseSchema = z.object({
+	commit: restoreCommitCommitSchema.partial().optional().nullable(),
 	result: refUpdateResultWithOptionalsSchema,
 });
 
@@ -135,4 +135,4 @@ export type RawFilteredFile = z.infer<typeof filteredFileRawSchema>;
 export type GetBranchDiffResponseRaw = z.infer<typeof branchDiffResponseSchema>;
 export type GetCommitDiffResponseRaw = z.infer<typeof commitDiffResponseSchema>;
 export type CommitPackAckRaw = z.infer<typeof commitPackAckSchema>;
-export type ResetCommitAckRaw = z.infer<typeof resetCommitAckSchema>;
+export type RestoreCommitAckRaw = z.infer<typeof restoreCommitAckSchema>;

package/src/types.ts

@@ -45,7 +45,7 @@ export interface Repo {
 	getBranchDiff(options: GetBranchDiffOptions): Promise<GetBranchDiffResult>;
 	getCommitDiff(options: GetCommitDiffOptions): Promise<GetCommitDiffResult>;
 	pullUpstream(options: PullUpstreamOptions): Promise<void>;
-	resetCommit(options: ResetCommitOptions): Promise<ResetCommitResult>;
+	restoreCommit(options: RestoreCommitOptions): Promise<RestoreCommitResult>;
 	createCommit(options: CreateCommitOptions): CommitBuilder;
 }
 
@@ -325,7 +325,7 @@ export interface CommitResult {
 	refUpdate: RefUpdate;
 }
 
-export interface ResetCommitOptions extends GitStorageInvocationOptions {
+export interface RestoreCommitOptions extends GitStorageInvocationOptions {
 	targetBranch: string;
 	targetCommitSha: string;
 	commitMessage?: string;
@@ -334,7 +334,7 @@ export interface ResetCommitOptions extends GitStorageInvocationOptions {
 	committer?: CommitSignature;
 }
 
-export interface ResetCommitResult {
+export interface RestoreCommitResult {
 	commitSha: string;
 	treeSha: string;
 	targetBranch: string;