anki/ts/congrats/lib.ts

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html

import pb from "anki/ts/lib/backend_proto";
import { postRequest } from "anki/ts/lib/postrequest";
import { naturalUnit, unitAmount, unitName } from "anki/ts/lib/time";
import type { I18n } from "anki/ts/lib/i18n";

export async function getCongratsInfo(): Promise<pb.BackendProto.CongratsInfoOut> {
    return pb.BackendProto.CongratsInfoOut.decode(
        await postRequest("/_anki/congratsInfo", "")
    );
}

export function buildNextLearnMsg(
    info: pb.BackendProto.CongratsInfoOut,
    i18n: I18n
): string {
    const secsUntil = info.secsUntilNextLearn;
    // next learning card not due (/ until tomorrow)?
    if (secsUntil == 0 || secsUntil > 86_400) {
        return "";
    }

    const unit = naturalUnit(secsUntil);
    const amount = Math.round(unitAmount(unit, secsUntil));
    const unitStr = unitName(unit);
    const nextLearnDue = i18n.tr(i18n.TR.SCHEDULING_NEXT_LEARN_DUE, {
        amount,
        unit: unitStr,
    });
    const remaining = i18n.tr(i18n.TR.SCHEDULING_LEARN_REMAINING, {
        remaining: info.learnRemaining,
    });
    return `${nextLearnDue} ${remaining}`;
}