@flashcard/core@0.0.4

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
import Card from './card.ts'
import Note, { type NoteContent } from './note.ts'
import Template, { type TemplateType } from './template.ts'
import type Scheduler from './scheduler.ts'

/**
 * A `Deck` represents a collection of notes.
 */
export default class Deck {
  id: string
  idNum: number // For exports that use id number (Anki)
  name = ''
  desc = ''
  fields: string[] = [] // Names of different content fields
  watch: string[] = [] // Names of fields that are watched for updates
  notes: Record<string, Note> = {}
  meta: Record<string, string> = {}
  // deno-lint-ignore no-explicit-any
  scheduler?: Scheduler<any, any>
  templates: Record<string, Template> = {}
  currCard?: Card

  constructor(id: string, props: {
    idNum?: number
    name?: string
    desc?: string
    fields?: string[]
    watch?: string[]
    notes?: Record<string, Note>
    meta?: Record<string, string>
    // deno-lint-ignore no-explicit-any
    scheduler?: Scheduler<any, any>
  }) {
    this.id = id
    this.idNum = props.idNum || encode(id)
    if (props.name) this.name = props.name
    if (props.notes) this.notes = props.notes
    if (props.fields) this.fields = props.fields
    if (props.watch) this.watch = props.watch
    if (props.scheduler) this.scheduler = props.scheduler
    if (props.desc) this.desc = props.desc
    if (props.meta) this.meta = props.meta
  }

  addNote(id: string, content: NoteContent, templates?: Template[]): void {
    const note = new Note(id, content, templates)
    const deckFields = this.fields
    const noteFields = Object.keys(note.content)
    const uniqueToDeck = deckFields.filter((f) => !noteFields.includes(f))
    const uniqueToNote = noteFields.filter((f) => !deckFields.includes(f))

    if (uniqueToDeck.length) {
      throw new Error(`Note is missing fields req by deck: ${uniqueToDeck}`)
    } else if (uniqueToNote.length) {
      throw new Error(`Deck is missing fields req by note: ${uniqueToNote}`)
    }

    this.notes[note.id] = note
  }

  addTemplate(
    id: string,
    q: string,
    a: string,
    type?: TemplateType,
    style?: string,
  ): void {
    this.templates[id] = new Template(id, q, a, type, style)
  }

  getCards(): Card[] {
    if (!this.scheduler) return []
    const { init, sort, name } = this.scheduler
    return Object.values(this.notes)
      .map((note) => note.getCards(this.templates))
      .flat()
      .toSorted((cardA: Card, cardB: Card) => {
        return sort(
          init(cardA.scheduling[name]),
          init(cardB.scheduling[name]),
        )
      })
  }

  getCurrent(): Card | void {
    return this.currCard
  }

  getNext(numCards = 1): Card[] | Card | void {
    if (!this.scheduler) return
    const { init, filter, name } = this.scheduler
    const cards = this.getCards().filter((card: Card) => {
      return filter(init(card.scheduling[name]))
    }).slice(0, numCards)
    this.currCard = cards[0]
    const next = numCards > 1 ? cards : this.currCard
    return next
  }

  getNotes(): Note[] {
    return Object.values(this.notes)
  }

  getTemplates(): Template[] {
    return Object.values(this.templates) || []
  }

  answerCurrent(quality: number): void {
    const currCard = this.getCurrent()
    if (currCard instanceof Card) currCard.answer(this, quality)
  }

  answerNext(quality: number): void {
    const currCard = this.getNext()
    if (currCard instanceof Card) currCard.answer(this, quality)
  }
}

function encode(str: string): number {
  let num = ''
  for (let i = 0; i < str.length; i++) {
    num = num + String(str.charCodeAt(i))
  }
  return parseInt(num.slice(0, 10))
}