feat: persistence selected mode

This commit is contained in:
Xiaohan-Tian
2025-12-10 21:54:16 -08:00
parent fa201d11c5
commit dcd2d89d0f
6 changed files with 87 additions and 14 deletions
+15 -2
View File
@@ -31,11 +31,15 @@ export class KGProject {
@WithDefault("C major")
private keySignature: KeySignature = "C major";
@Expose()
@WithDefault("ionian")
private selectedMode: string = "ionian";
@Expose()
@WithDefault(0)
private projectStructureVersion: number = 0;
public static readonly CURRENT_PROJECT_STRUCTURE_VERSION: number = 1;
public static readonly CURRENT_PROJECT_STRUCTURE_VERSION: number = 2;
@Expose()
@Type(() => KGTrack, {
@@ -50,13 +54,14 @@ export class KGProject {
private tracks: KGTrack[] = [];
// Constructor
constructor(name: string = "Untitled Project", maxBars: number = 32, currentBars: number = 0, bpm: number = 125, timeSignature: TimeSignature = { numerator: 4, denominator: 4 }, keySignature: KeySignature = "C major", tracks: KGTrack[] = [], projectStructureVersion: number = KGProject.CURRENT_PROJECT_STRUCTURE_VERSION) {
constructor(name: string = "Untitled Project", maxBars: number = 32, currentBars: number = 0, bpm: number = 125, timeSignature: TimeSignature = { numerator: 4, denominator: 4 }, keySignature: KeySignature = "C major", selectedMode: string = "ionian", tracks: KGTrack[] = [], projectStructureVersion: number = KGProject.CURRENT_PROJECT_STRUCTURE_VERSION) {
this.name = name;
this.maxBars = maxBars;
this.currentBars = currentBars;
this.bpm = bpm;
this.timeSignature = timeSignature;
this.keySignature = keySignature;
this.selectedMode = selectedMode;
this.tracks = tracks;
this.projectStructureVersion = projectStructureVersion;
}
@@ -90,6 +95,10 @@ export class KGProject {
return this.keySignature;
}
public getSelectedMode(): string {
return this.selectedMode;
}
public getTracks(): KGTrack[] {
return this.tracks;
}
@@ -115,6 +124,10 @@ export class KGProject {
this.keySignature = keySignature;
}
public setSelectedMode(selectedMode: string): void {
this.selectedMode = selectedMode;
}
public setTracks(tracks: KGTrack[]): void {
this.tracks = tracks;
}
@@ -13,6 +13,7 @@ export interface ProjectUpdateProperties {
bpm?: number;
timeSignature?: TimeSignature;
keySignature?: KeySignature;
selectedMode?: string;
}
/**
@@ -42,6 +43,7 @@ export class ChangeProjectPropertyCommand extends KGCommand {
bpm: this.targetProject.getBpm(),
timeSignature: { ...this.targetProject.getTimeSignature() }, // Create a copy
keySignature: this.targetProject.getKeySignature(),
selectedMode: this.targetProject.getSelectedMode(),
};
// Apply updates and track what actually changes
@@ -95,6 +97,13 @@ export class ChangeProjectPropertyCommand extends KGCommand {
updatedProperties.push(`keySignature: "${this.originalProperties.keySignature}" → "${this.newProperties.keySignature}"`);
}
// Update selected mode
if (this.newProperties.selectedMode !== undefined && this.newProperties.selectedMode !== this.originalProperties.selectedMode) {
this.targetProject.setSelectedMode(this.newProperties.selectedMode);
this.changedProperties.add('selectedMode');
updatedProperties.push(`selectedMode: "${this.originalProperties.selectedMode}" → "${this.newProperties.selectedMode}"`);
}
if (updatedProperties.length > 0) {
console.log(`Updated project: ${updatedProperties.join(', ')}`);
} else {
@@ -147,6 +156,12 @@ export class ChangeProjectPropertyCommand extends KGCommand {
restoredProperties.push(`keySignature: "${this.originalProperties.keySignature}"`);
}
// Restore selected mode (only if it was changed)
if (this.changedProperties.has('selectedMode') && this.originalProperties.selectedMode !== undefined) {
this.targetProject.setSelectedMode(this.originalProperties.selectedMode);
restoredProperties.push(`selectedMode: "${this.originalProperties.selectedMode}"`);
}
console.log(`Restored project: ${restoredProperties.join(', ')}`);
}
@@ -171,6 +186,9 @@ export class ChangeProjectPropertyCommand extends KGCommand {
if (this.newProperties.keySignature !== undefined) {
updatedProps.push('key signature');
}
if (this.newProperties.selectedMode !== undefined) {
updatedProps.push('selected mode');
}
if (updatedProps.length === 1) {
return `Change project ${updatedProps[0]}`;
@@ -1,5 +1,6 @@
import { KGProject } from '../KGProject';
import { upgradeToV1 } from './upgradeToV1';
import { upgradeToV2 } from './upgradeToV2';
/**
* Upgrade the given project to the latest structure version, one version at a time.
@@ -23,6 +24,10 @@ export function upgradeProjectToLatest(project: KGProject): KGProject {
workingProject = upgradeToV1(workingProject);
break;
}
case 2: {
workingProject = upgradeToV2(workingProject);
break;
}
default: {
// If an upgrader is missing, throw to prevent loading incompatible structures
throw new Error(`No upgrader found for project structure version ${nextVersion}`);
+20
View File
@@ -0,0 +1,20 @@
import { KGProject } from '../KGProject';
/**
* Upgrade a project from structure version 1 to 2.
* Adds the selectedMode field with default value "ionian".
*/
export function upgradeToV2(project: KGProject): KGProject {
try {
// Set default selectedMode to "ionian" if not already set
const currentMode = project.getSelectedMode?.();
if (!currentMode) {
project.setSelectedMode("ionian");
}
} finally {
// Always set the project structure version to 2 to mark migration complete
project.setProjectStructureVersion(2);
}
return project;
}