anamnesis-backend/src/models/shelf.ts

import { viewPermissionType } from "./variables";
import { Word } from "./word";

interface RevisionHistoryRecord {
    day: Date,
    wasRecallSuccessful: boolean
}

interface AddedWord {
    word: Word,
    notes: Array<string>,
    isFavourite: boolean,
    nextRevisionDateTime: Date,
    spaceBetweenRecall: number, // in Days
    revisionHistory : Array<RevisionHistoryRecord>,
    isArchived: boolean,
}

export interface Shelf {
    name: string,
    description?: string,
    viewType: viewPermissionType,
    isArchived: boolean,
    addedWords?: Array<AddedWord>
}

interface MongoAddedWord extends Omit<AddedWord, "word"> {
    word: string,
}

export interface MongoShelf extends Omit<Shelf, "addedWords"> {
    addedWords?: Array<MongoAddedWord>
}