Add EvidenceStore for tracking activity evidence (#496)

src/app/model/data-store.ts

@@ -2,16 +2,19 @@ import { ActivityStore } from './activity-store';
 import { Progress } from './types';
 import { MetaStore, MetaStrings } from './meta-store';
 import { ProgressStore } from './progress-store';
+import { EvidenceData, EvidenceStore } from './evidence-store';
 
 export class DataStore {
   public meta: MetaStore | null = null;
   public activityStore: ActivityStore | null = null;
   public progressStore: ProgressStore | null = null;
+  public evidenceStore: EvidenceStore | null = null;
 
   constructor() {
     this.meta = new MetaStore();
     this.activityStore = new ActivityStore();
     this.progressStore = new ProgressStore();
+    this.evidenceStore = new EvidenceStore();
   }
 
   public addActivities(activities: ActivityStore): void {
@@ -20,6 +23,9 @@ export class DataStore {
   public addProgressData(progress: Progress): void {
     this.progressStore?.addProgressData(progress);
   }
+  public addEvidenceData(evidence: EvidenceData): void {
+    this.evidenceStore?.addEvidenceData(evidence);
+  }
 
   public getMetaStrings(): MetaStrings {
     if (this.meta == null) {

src/app/model/evidence-store.ts

@@ -0,0 +1,197 @@
+import { YamlService } from '../service/yaml-loader/yaml-loader.service';
+import { ActivityId, EvidenceId } from './types';
+
+export interface EvidenceAttachment {
+  type: string; // e.g. 'document', 'image', 'link'
+  externalLink: string; // URL
+}
+
+export interface EvidenceEntry {
+  id: EvidenceId; // stable UUID for this entry
+  teams: string[];
+  title: string;
+  evidenceRecorded: string; // ISO date string
+  reviewer?: string;
+  description: string;
+  attachment?: EvidenceAttachment[];
+}
+
+export type EvidenceData = Record<ActivityId, EvidenceEntry[]>;
+
+const LOCALSTORAGE_KEY: string = 'evidence';
+
+export class EvidenceStore {
+  private yamlService: YamlService = new YamlService();
+  private _evidence: EvidenceData = {};
+
+  // ─── Lifecycle ────────────────────────────────────────────
+
+  public initFromLocalStorage(): void {
+    const stored = this.retrieveStoredEvidence();
+    if (stored) {
+      this.addEvidenceData(stored);
+    }
+  }
+
+  // ─── Accessors ────────────────────────────────────────────
+
+  public getEvidenceData(): EvidenceData {
+    return this._evidence;
+  }
+
+  public getEvidence(activityUuid: ActivityId): EvidenceEntry[] {
+    return this._evidence[activityUuid] || [];
+  }
+
+  public hasEvidence(activityUuid: ActivityId): boolean {
+    return (this._evidence[activityUuid]?.length || 0) > 0;
+  }
+
+  public getEvidenceCount(activityUuid: ActivityId): number {
+    return this._evidence[activityUuid]?.length ?? 0;
+  }
+
+  public getTotalEvidenceCount(): number {
+    let count = 0;
+    for (const uuid in this._evidence) {
+      count += this._evidence[uuid].length;
+    }
+    return count;
+  }
+
+  public getActivityUuidsWithEvidence(): ActivityId[] {
+    return Object.keys(this._evidence).filter(uuid => this._evidence[uuid].length > 0);
+  }
+
+  // ─── Mutators ────────────────────────────────────────────
+
+  public addEvidenceData(newEvidence: EvidenceData): void {
+    if (!newEvidence) return;
+
+    for (const activityUuid in newEvidence) {
+      if (!this._evidence[activityUuid]) {
+        this._evidence[activityUuid] = [];
+      }
+
+      const newEntries = newEvidence[activityUuid];
+      if (Array.isArray(newEntries)) {
+        for (const entry of newEntries) {
+          const existingIndex = this._evidence[activityUuid].findIndex(e => e.id === entry.id);
+          if (existingIndex !== -1) {
+            this._evidence[activityUuid][existingIndex] = entry;
+          } else {
+            this._evidence[activityUuid].push(entry);
+          }
+        }
+      }
+    }
+  }
+
+  public replaceEvidenceData(data: EvidenceData): void {
+    this._evidence = data;
+    this.saveToLocalStorage();
+  }
+
+  public addEvidence(activityUuid: ActivityId, entry: EvidenceEntry): void {
+    if (!this._evidence[activityUuid]) {
+      this._evidence[activityUuid] = [];
+    }
+    this._evidence[activityUuid].push(entry);
+    this.saveToLocalStorage();
+  }
+
+  public updateEvidence(
+    activityUuid: ActivityId,
+    entryId: EvidenceId,
+    updatedEntry: Partial<EvidenceEntry>
+  ): void {
+    const entries = this._evidence[activityUuid];
+    if (!entries) {
+      console.warn(`No evidence found for activity ${activityUuid}`);
+      return;
+    }
+    const index = entries.findIndex(e => e.id === entryId);
+    if (index === -1) {
+      console.warn(`Cannot find evidence with id ${entryId} for activity ${activityUuid}`);
+      return;
+    }
+    // Immutable update for Angular change detection
+    entries[index] = { ...entries[index], ...updatedEntry };
+    this.saveToLocalStorage();
+  }
+
+  public deleteEvidence(activityUuid: ActivityId, entryId: EvidenceId): void {
+    const entries = this._evidence[activityUuid];
+    if (!entries) {
+      console.warn(`No evidence found for activity ${activityUuid}`);
+      return;
+    }
+    const index = entries.findIndex(e => e.id === entryId);
+    if (index === -1) {
+      console.warn(`Cannot find evidence with id ${entryId} for activity ${activityUuid}`);
+      return;
+    }
+    entries.splice(index, 1);
+
+    if (entries.length === 0) {
+      delete this._evidence[activityUuid];
+    }
+    this.saveToLocalStorage();
+  }
+
+  public renameTeam(oldName: string, newName: string): void {
+    console.log(`Renaming team '${oldName}' to '${newName}' in evidence store`);
+    for (const uuid in this._evidence) {
+      this._evidence[uuid].forEach(entry => {
+        entry.teams = entry.teams.map(t => (t === oldName ? newName : t));
+      });
+    }
+    this.saveToLocalStorage();
+  }
+
+  // ─── Serialization ──────────────────────────────────────
+
+  public asYamlString(): string {
+    return this.yamlService.stringify({ evidence: this._evidence });
+  }
+
+  public saveToLocalStorage(): void {
+    const yamlStr = this.asYamlString();
+    localStorage.setItem(LOCALSTORAGE_KEY, yamlStr);
+  }
+
+  public deleteBrowserStoredEvidence(): void {
+    console.log('Deleting evidence from browser storage');
+    localStorage.removeItem(LOCALSTORAGE_KEY);
+  }
+
+  public retrieveStoredEvidenceYaml(): string | null {
+    return localStorage.getItem(LOCALSTORAGE_KEY);
+  }
+
+  public retrieveStoredEvidence(): EvidenceData | null {
+    const yamlStr = this.retrieveStoredEvidenceYaml();
+    if (!yamlStr) return null;
+
+    const parsed = this.yamlService.parse(yamlStr);
+    return parsed?.evidence ?? null;
+  }
+
+  // ─── Helpers ─────────────────────────────────────────────
+
+  private isDuplicateEntry(activityUuid: ActivityId, entry: EvidenceEntry): boolean {
+    const existing = this._evidence[activityUuid];
+    if (!existing) return false;
+    return existing.some(e => e.id === entry.id);
+  }
+
+  public static todayDateString(): string {
+    const now = new Date();
+    return now.toISOString().substring(0, 10);
+  }
+
+  // to be used when creating new evidence entries to ensure they have a stable UUID
+  public static generateId(): string {
+    return crypto.randomUUID?.() ?? `${Date.now()}-${Math.random().toString(36).substring(2, 9)}`;
+  }
+}

src/app/model/meta-store.ts

@@ -35,6 +35,7 @@ export class MetaStore {
   teams: TeamNames = [];
   activityFiles: string[] = [];
   teamProgressFile: string = '';
+  teamEvidenceFile: string = '';
   allowChangeTeamNameInBrowser: boolean = true;
 
   dimensionIcons: Record<string, string> = {
@@ -67,6 +68,7 @@ export class MetaStore {
       this.teams = metaData.teams || this.teams || [];
       this.activityFiles = metaData.activityFiles || this.activityFiles || [];
       this.teamProgressFile = metaData.teamProgressFile || this.teamProgressFile || '';
+      this.teamEvidenceFile = metaData.teamEvidenceFile || this.teamEvidenceFile || '';
       if (metaData.allowChangeTeamNameInBrowser !== undefined)
         this.allowChangeTeamNameInBrowser = metaData.allowChangeTeamNameInBrowser;
     }

src/app/model/types.ts

@@ -15,6 +15,8 @@ export type Progress = Record<Uuid, ActivityProgress>;
 export type ActivityProgress = Record<TeamName, TeamProgress>;
 export type TeamProgress = Record<ProgressTitle, Date>;
 export type Uuid = string;
+export type ActivityId = Uuid;
+export type EvidenceId = Uuid;
 export type TeamName = string;
 export type GroupName = string;
 export type ProgressTitle = string;

src/app/service/loader/data-loader.service.ts

@@ -84,6 +84,14 @@ export class LoaderService {
         this.dataStore.addProgressData(browserProgress?.progress);
       }
 
+      // Load evidence data
+      const evidenceData = await this.loadEvidence(this.dataStore.meta);
+      this.dataStore.addEvidenceData(evidenceData.evidence);
+      this.dataStore.evidenceStore?.initFromLocalStorage();
+
+      // DEBUG ONLY
+      console.log('Merged EvidenceStore:', this.dataStore.evidenceStore?.getEvidenceData());
+
       console.log(`${perfNow()}: YAML: All YAML files loaded`);
 
       return this.dataStore;
@@ -134,6 +142,10 @@ export class LoaderService {
     meta.activityFiles = meta.activityFiles.map(file =>
       this.yamlService.makeFullPath(file, this.META_FILE)
     );
+    if (!meta.teamEvidenceFile) {
+      throw Error("The meta.yaml has no 'teamEvidenceFile' to be loaded");
+    }
+    meta.teamEvidenceFile = this.yamlService.makeFullPath(meta.teamEvidenceFile, this.META_FILE);
 
     if (this.debug) console.log(`${perfNow()} s: meta loaded`);
     console.log(`${perfNow()} s: Loaded teams: ${meta.teams.join(', ')}`);
@@ -145,6 +157,11 @@ export class LoaderService {
     return this.yamlService.loadYaml(meta.teamProgressFile);
   }
 
+  private async loadEvidence(meta: MetaStore): Promise<{ evidence: any }> {
+    if (this.debug) console.log(`${perfNow()}s: Loading Team Evidence: ${meta.teamEvidenceFile}`);
+    return this.yamlService.loadYaml(meta.teamEvidenceFile);
+  }
+
   private async loadActivities(meta: MetaStore): Promise<ActivityStore> {
     const activityStore = new ActivityStore();
     const errors: string[] = [];

src/assets/YAML/meta.yaml

@@ -5,6 +5,7 @@ browserSettings:
 
 
 teamProgressFile: 'team-progress.yaml' 
+teamEvidenceFile: 'team-evidence.yaml'
 progressDefinition:
   Not implemented:
     score: 0%

src/assets/YAML/team-evidence.yaml

@@ -0,0 +1,2 @@
+  # Export team evidence from the browser, and replace this file
+evidence: