Skip to content

A modern, self-hosted backup solution for secure, encrypted backups across local and cloud storage.

2.2 KB
Raw Blame
import { StrategyMethodTypes } from '../../types/strategy';
import {
	BackupPlanArgs,
	BackupVerifiedResult,
	PlanAddRunSettings,
	RemoveBackupResult,
} from '../../types/plans';
import { BackupRunConfig } from '../../types/backups';

export interface BackupStrategy {
	createBackup(
		planId: string,
		options: BackupPlanArgs,
		runSettings?: PlanAddRunSettings
	): Promise<{ success: boolean; result: string }>;
	performBackup(
		planId: string,
		runConfig?: BackupRunConfig
	): Promise<{ success: boolean; result: string }>;
	updateBackup(
		planId: string,
		options: Record<string, any>
	): Promise<{ success: boolean; result: string }>;
	removeBackup(
		planId: string,
		options: {
			storageName: string;
			storagePath: string;
			removeRemoteData: boolean;
			encryption: boolean;
			replicationStorages?: { storageName: string; storagePath: string }[];
		}
	): Promise<RemoveBackupResult>;
	removeReplicationStorage(
		planId: string,
		options: {
			storageName: string;
			storagePath: string;
			removeData: boolean;
		}
	): Promise<{ success: boolean; result: string }>;
	pauseBackup(planId: string): Promise<{ success: boolean; result: string }>;
	resumeBackup(planId: string): Promise<{ success: boolean; result: string }>;
	pruneBackups(
		planId: string,
		replicationStorages?: { storageName: string; storagePath: string }[]
	): Promise<{
		success: boolean;
		result: string;
	}>;
	getBackupProgress?(
		planId: string,
		backupId: string
	): Promise<{ success: boolean; result: string }>;
	cancelBackup?(planId: string, backupId: string): Promise<{ success: boolean; result: string }>;
	unlockRepo?(
		planId: string,
		replicationStorages?: { storageName: string; storagePath: string }[]
	): Promise<{ success: boolean; result: string }>;

	updatePlanStorageName?(
		storageId: string,
		newStorageName: string
	): Promise<{ success: boolean; result: string }>;
	checkIntegrity(planId: string): Promise<{ success: boolean; result: any }>;
	repairRepo(
		planId: string,
		repairType: 'snapshots' | 'index' | 'packs',
		checkRes: BackupVerifiedResult,
		options: { storageName: string; storagePath: string }
	): Promise<{ success: boolean; result: any }>;
}

export type BackupStrategyTypes = StrategyMethodTypes<BackupStrategy>;