review

type FirestoreStore struct {
	// contains filtered or unexported fields
}

type Flashcard struct {
	// Metadata stores immutable data like the prompt and answer.
	Metadata FlashcardMetadata `firestore:"metadata" json:"metadata"`
	// Stats stores mutable data like the view count.
	Stats FlashcardStats `firestore:"stats" json:"stats"`
}

type FlashcardMetadata struct {
	// ID uniquely identifies the flashcard.
	ID int64 `firestore:"id" json:"id"`
	// Prompt is the text to be shown to the user.
	Prompt string `firestore:"prompt" json:"prompt"`
	// Context helps narrow down possible answers.
	Context string `firestore:"context,omitempty" json:"context,omitempty"`
	// Answer is the accepted answer.
	Answer string `firestore:"answer" json:"answer"`
}

type FlashcardMetadataSource interface {
	// GetAll returns the metadata for all flashcards.
	GetAll(ctx context.Context) ([]*FlashcardMetadata, error)
}

type FlashcardStats struct {
	// ViewCount is the number of times the flashcard has been reviewed.
	ViewCount int `firestore:"viewCount" json:"viewCount"`
	// Repetitions is the number of successful reviews in a row.
	Repetitions int `firestore:"repetitions,omitempty" json:"repetitions"`
	// NextReview is the round in which the card is due to be reviewed next.
	NextReview int `firestore:"nextReview,omitempty"`
}

type MemorySource struct {
	// contains filtered or unexported fields
}

type MemoryStore struct {
	// contains filtered or unexported fields
}

type Reviewer struct {
	// contains filtered or unexported fields
}

type Session struct {
	// ID uniquely identifies a review session.
	ID string `firestore:"id" json:"id"`
	// Round is an incrementing counter that identifies the current round.
	Round int `firestore:"round"`
	// IsNewRound is true if and only if the round has just started.
	IsNewRound bool `firestore:"isNewRound"`
	// ProficiencyCounts is the number of flashcards at each proficiency level.
	ProficiencyCounts []int `firestore:"proficiencyCounts" json:"proficiencyCounts"`
	// UnreviewedCount is the number of flashcards that haven't been reviewed yet.
	UnreviewedCount int `firestore:"unreviewedCount" json:"unreviewedCount"`
}

type SessionStore interface {
	// DeleteFlashcards deletes the specified flashcards.
	DeleteFlashcards(ctx context.Context, sessionID string, ids []int64) error
	// GetFlashcard returns the specified flashcard.
	GetFlashcard(ctx context.Context, sessionID string, flashcardID int64) (*Flashcard, error)
	// GetFlashcards returns all flashcards.
	GetFlashcards(ctx context.Context, sessionID string) ([]*Flashcard, error)
	// SetFlashcards upserts the specified flashcards, clearing any existing stats.
	SetFlashcards(ctx context.Context, sessionID string, metadata []*FlashcardMetadata) error
	// SetFlashcardStats updates a flashcard's stats.
	SetFlashcardStats(ctx context.Context, sessionID string, flashcardID int64, stats *FlashcardStats) error
	// NextReviewed returns a flashcard that is due to be reviewed again.
	NextReviewed(ctx context.Context, sessionID string, round int) (*Flashcard, error)
	// NextUnreviewed returns a flashcard that has never been reviewed before.
	NextUnreviewed(ctx context.Context, sessionID string) (*Flashcard, error)
	// GetSession returns the current session metadata.
	GetSession(ctx context.Context, sessionID string) (*Session, error)
	// GetSessions returns the metadata for all existing sessions.
	GetSessions(ctx context.Context) ([]*Session, error)
	// SetSession updates the session metadata.
	SetSession(ctx context.Context, sessionID string, session *Session) error
}

type SheetSource struct {
	// SpreadsheetID uniquely identifies the spreadsheet.
	SpreadsheetID string `json:"spreadsheetId"`
	// CellRange is the range of cells containing the data.
	CellRange string `json:"cellRange"`
	// IDHeader is the name of the column containing unique IDs.
	IDHeader string `json:"idHeader"`
	// PromptHeader is the name of the column containing the prompts.
	PromptHeader string `json:"promptHeader"`
	// ContextHeader is the name of the column containing the context (if any).
	ContextHeader string `json:"contextHeader"`
	// AnswerHeader is the name of the column containing the answers.
	AnswerHeader string `json:"answerHeader"`
}

type Submission struct {
	// Answer is the submitted answer.
	Answer string `json:"answer"`
	// IsFirstGuess is true if and only if this is the user's first guess.
	IsFirstGuess bool `firestore:"isFirstGuess"`
}