kleckrelay/src/server-types.ts

export enum ImageProxyFormatType {
	WEBP = "webp",
	PNG = "png",
	JPEG = "jpeg",
}

export enum ProxyUserAgentType {
	APPLE_MAIL = "apple-mail",
	GOOGLE_MAIL = "google-mail",
	OUTLOOK_WINDOWS = "outlook-windows",
	OUTLOOK_MACOS = "outlook-macos",
	FIREFOX = "firefox",
	CHROME = "chrome",
}

export enum AliasType {
	RANDOM = "random",
	CUSTOM = "custom",
}

export enum Language {
	EN_US = "en-US",
	DE_DE = "de-DE",
}

export enum Theme {
	LIGHT = "light",
	DARK = "dark",
}

export enum ThemeSettings {
	LIGHT = "light",
	DARK = "dark",
	SYSTEM = "system",
}

export interface ServerUser {
	id: string
	createdAt: Date
	encryptedNotes: string
	isDecrypted: false
	encryptedPassword: string
	salt: string
	isAdmin: boolean
	email: {
		address: string
		isVerified: boolean
	}
	preferences: {
		aliasRemoveTrackers: boolean
		aliasCreateMailReport: boolean
		aliasProxyImages: boolean
		aliasImageProxyFormat: ImageProxyFormatType
		aliasProxyUserAgent: ProxyUserAgentType
		aliasExpandUrlShorteners: boolean
	}
}

export interface SimpleDetailResponse {
	detail: string
}

export interface AuthenticationDetails extends SimpleDetailResponse {
	user: ServerUser
}

export interface ServerSettings {
	mailDomain: string
	appDomain: string
	randomEmailIdMinLength: number
	RandomEmailIdChars: string
	imageProxyEnabled: boolean
	imageProxyLifeTime: number
	disposableEmailsEnabled: boolean
	otherRelaysEnabled: boolean
	otherRelayDomains: string[]
	emailVerificationChars: string
	emailVerificationLength: number
	emailLoginTokenChars: string
	emailLoginTokenLength: number
	emailResendWaitTime: number
	emailLoginExpirationInSeconds: number
	customAliasSuffixLength: number
	instanceSalt: string
	publicKey: string
	allowAliasDeletion: boolean
	apiKeyMaxDays: number
	allowRegistrations: boolean
}

export interface Alias {
	id: string
	domain: string
	local: string
	isActive: boolean
	encryptedNotes: string
	type: AliasType

	prefRemoveTrackers: boolean | null
	prefCreateMailReport: boolean | null
	prefProxyImages: boolean | null
	prefImageProxyFormat: ImageProxyFormatType | null
	prefProxyUserAgent: ProxyUserAgentType | null
	prefExpandUrlShorteners: boolean | null
}

export interface ReservedAlias {
	id: string
	isActive: boolean
	domain: string
	local: string
	users: Array<{
		id: string
		email: {
			address: string
			id: string
		}
	}>
}

export interface AliasNote {
	version: "1.0"
	data: {
		createdAt: Date | null
		createdOn: string | null
		creationContext: "extension" | "extension-inline" | "web"
		personalNotes: string
		websites: Array<{
			url: string
		}>
	}
}

export interface DecryptedAlias extends Omit<Alias, "encryptedNotes"> {
	notes: AliasNote
}

export interface AliasList {
	id: string
	domain: string
	local: string
	isActive: boolean
	type: AliasType
}

export type APIKeyScope =
	| "read:profile"
	| "update:profile"
	| "read:preferences"
	| "update:preferences"
	| "read:alias"
	| "create:alias"
	| "update:alias"
	| "delete:alias"
	| "read:report"
	| "delete:report"
	| "read:admin_cron_report"
	| "read:admin_settings"
	| "update:admin_settings"
	| "read:admin_reserved_alias"
	| "create:admin_reserved_alias"
	| "update:admin_reserved_alias"
	| "delete:admin_reserved_alias"

export interface APIKey {
	id: string
	label: string
	expiresAt: Date
	scopes: APIKeyScope[]
}

export interface Report {
	id: string
	encryptedContent: string
}

export interface DecryptedReportContent {
	version: "1.0"
	id: string
	messageDetails: {
		meta: {
			messageId: string
			from: string
			to: string
			createdAt: Date
		}
		content: {
			subject: string
			proxiedImages: Array<{
				url: string
				imageProxyId: string
				createdAt: Date
				serverUrl: string
			}>
			singlePixelImages: Array<{
				source: string
				trackerName: string
				trackerUrl: string
			}>
			expandedUrls: Array<{
				originalUrl: string
				expandedUrl: string
				queryTrackers: []
			}>
		}
	}
}

export type PaginationResult<T> = {
	items: T[]
	total: number
	page: number
	size: number
}

export interface UserNote {
	theme: Theme
	privateKey: string
}

export interface User extends Omit<ServerUser, "encryptedNotes" | "isDecrypted"> {
	notes: UserNote
	isDecrypted: true
}

export interface GetPageData {
	page?: number
	size?: number
}

export interface AdminSettings {
	randomEmailIdMinLength: number
	randomEmailIdChars: string
	randomEmailLengthIncreaseOnPercentage: number
	customEmailSuffixLength: number
	customEmailSuffixChars: string
	imageProxyStorageLifeTimeInHours: number
	enableImageProxy: boolean
	enableImageProxyStorage: boolean
	userEmailEnableDisposableEmails: boolean
	userEmailEnableOtherRelays: boolean
	allowStatistics: boolean
	allowAliasDeletion: boolean
	maxAliasesPerUser: number
	allowRegistrations: boolean
}

export interface ServerCronReport {
	id: string
	createdAt: Date
	reportData: {
		encryptedReport: string
	}
}

export interface CronReport {
	id: string
	createdAt: Date
	reportData: {
		version: "1.0"
		id: string
		report: {
			startedAt: Date
			finishedAt: Date
			status: "success" | "error"
			expiredImages: number
			nonVerifiedUsers: number
			expiredReports: number
		}
	}
}