anamnesis-shared/models/shelf.ts

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

export interface ShelfWord {
    word: Word,
    notes: Array<string>,
    nextRevisionDateTime: Date,
    spaceBetweenRecall: number, // in Days
    isArchived: boolean,
}

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

export interface MongoShelfWord extends Omit<ShelfWord, "word"> {
    word: string,
}

export interface MongoShelf extends Omit<Shelf, "words"> {
    words?: Array<MongoShelfWord>
}

export interface MobileShelfWord extends Omit<ShelfWord, "word"> {
    word: MobileWord,
}

export interface MobileShelf extends Shelf {
    _id: string,
    words?: Array<MobileShelfWord>,
}