Restructure

src-shared/interfaces/download.interface.ts

@@ -0,0 +1,38 @@
+import { DriveChart } from './songDetails.interface'
+
+/**
+ * Represents a user's request to interact with the download system.
+ */
+export interface Download {
+	action: 'add' | 'retry' | 'cancel'
+	versionID: number
+	data?: NewDownload // Should be defined if action == 'add'
+}
+
+/**
+ * Contains the data required to start downloading a single chart.
+ */
+export interface NewDownload {
+	chartName: string
+	artist: string
+	charter: string
+	driveData: DriveChart & { inChartPack: boolean }
+}
+
+/**
+ * Represents the download progress of a single chart.
+ */
+export interface DownloadProgress {
+	versionID: number
+	title: string
+	header: string
+	description: string
+	percent: number
+	type: ProgressType
+	/** If `description` contains a filepath that can be clicked */
+	isLink: boolean
+	/** If the download should not appear in the total download progress */
+	stale?: boolean
+}
+
+export type ProgressType = 'good' | 'error' | 'cancel' | 'done'

src-shared/interfaces/search.interface.ts

@@ -0,0 +1,91 @@
+/**
+ * Represents a user's song search query.
+ */
+export interface SongSearch { // TODO: make limit a setting that's not always 51
+	query: string
+	quantity: 'all' | 'any'
+	similarity: 'similar' | 'exact'
+	fields: SearchFields
+	tags: SearchTags
+	instruments: SearchInstruments
+	difficulties: SearchDifficulties
+	minDiff: number
+	maxDiff: number
+	limit: number
+	offset: number
+}
+
+export function getDefaultSearch(): SongSearch {
+	return {
+		query: '',
+		quantity: 'all',
+		similarity: 'similar',
+		fields: { name: true, artist: true, album: true, genre: true, year: true, charter: true, tag: true },
+		tags: {
+			'sections': false, 'star power': false, 'forcing': false, 'taps': false, 'lyrics': false,
+			'video': false, 'stems': false, 'solo sections': false, 'open notes': false
+		},
+		instruments: {
+			guitar: false, bass: false, rhythm: false, keys: false,
+			drums: false, guitarghl: false, bassghl: false, vocals: false
+		},
+		difficulties: { expert: false, hard: false, medium: false, easy: false },
+		minDiff: 0,
+		maxDiff: 6,
+		limit: 50 + 1,
+		offset: 0,
+	}
+}
+
+export interface SearchFields {
+	name: boolean
+	artist: boolean
+	album: boolean
+	genre: boolean
+	year: boolean
+	charter: boolean
+	tag: boolean
+}
+
+export interface SearchTags {
+	'sections': boolean    // Tag inverted
+	'star power': boolean  // Tag inverted
+	'forcing': boolean     // Tag inverted
+	'taps': boolean
+	'lyrics': boolean
+	'video': boolean
+	'stems': boolean
+	'solo sections': boolean
+	'open notes': boolean
+}
+
+export interface SearchInstruments {
+	guitar: boolean
+	bass: boolean
+	rhythm: boolean
+	keys: boolean
+	drums: boolean
+	guitarghl: boolean
+	bassghl: boolean
+	vocals: boolean
+}
+
+export interface SearchDifficulties {
+	expert: boolean
+	hard: boolean
+	medium: boolean
+	easy: boolean
+}
+
+/**
+ * Represents a single song search result.
+ */
+export interface SongResult {
+	id: number
+	chartCount: number
+	name: string
+	artist: string
+	album: string
+	genre: string
+	year: string
+}

src-shared/interfaces/songDetails.interface.ts

@@ -0,0 +1,101 @@
+/**
+ * The image data for a song's album art.
+ */
+export interface AlbumArtResult {
+	base64Art: string
+}
+
+/**
+ * Represents a single chart version.
+ */
+export interface VersionResult {
+	versionID: number
+	chartID: number
+	songID: number
+	latestVersionID: number
+	latestSetlistVersionID: number
+	name: string
+	chartName: string
+	artist: string
+	album: string
+	genre: string
+	year: string
+	songDataIncorrect: boolean
+	driveData: DriveChart & { inChartPack: boolean }
+	md5: string
+	lastModified: string
+	icon: string
+	charters: string
+	charterIDs: string
+	tags: string | null
+	songLength: number
+	diff_band: number
+	diff_guitar: number
+	diff_bass: number
+	diff_rhythm: number
+	diff_drums: number
+	diff_keys: number
+	diff_guitarghl: number
+	diff_bassghl: number
+	chartData: ChartData
+}
+
+export interface DriveChart {
+	source: DriveSource
+	isArchive: boolean
+	downloadPath: string
+	filesHash: string
+	folderName: string
+	folderID: string
+	files: DriveFile[]
+}
+
+export interface DriveSource {
+	isSetlistSource: boolean
+	isDriveFileSource?: boolean
+	setlistIcon?: string
+	sourceUserIDs: number[]
+	sourceName: string
+	sourceDriveID: string
+	proxyLink?: string
+}
+
+export interface DriveFile {
+	id: string
+	name: string
+	mimeType: string
+	webContentLink: string
+	modifiedTime: string
+	md5Checksum: string
+	size: string
+}
+
+export interface ChartData {
+	hasSections: boolean
+	hasStarPower: boolean
+	hasForced: boolean
+	hasTap: boolean
+	hasOpen: {
+		[instrument: string]: boolean
+	}
+	hasSoloSections: boolean
+	hasLyrics: boolean
+	is120: boolean
+	hasBrokenNotes: boolean
+	noteCounts: {
+		[instrument in Instrument]: {
+			[difficulty in ChartedDifficulty]: number
+		}
+	}
+	/** number of seconds */
+	length: number
+	/** number of seconds */
+	effectiveLength: number
+}
+
+export type Instrument = 'guitar' | 'bass' | 'rhythm' | 'keys' | 'drums' | 'guitarghl' | 'bassghl' | 'vocals' | 'undefined'
+export type ChartedDifficulty = 'x' | 'h' | 'm' | 'e'
+
+export function getInstrumentIcon(instrument: Instrument) {
+	return `${instrument}.png`
+}