// Copyright: Ankitects Pty Ltd and contributors // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html /* eslint @typescript-eslint/no-explicit-any: "off", */ import type { Stats, Cards } from "../lib/proto"; import { extent, histogram, rollup, sum, scaleLinear, scaleSequential, interpolateGreens, } from "d3"; import type { Bin } from "d3"; import * as tr from "../lib/ftl"; import { CardQueue } from "../lib/cards"; import type { HistogramData } from "./histogram-graph"; import { dayLabel } from "../lib/time"; import { GraphRange } from "./graph-helpers"; import type { TableDatum, SearchDispatch } from "./graph-helpers"; export interface GraphData { dueCounts: Map; haveBacklog: boolean; } export function gatherData(data: Stats.GraphsResponse): GraphData { const isLearning = (card: Cards.Card): boolean => [CardQueue.Learn, CardQueue.PreviewRepeat].includes(card.queue); let haveBacklog = false; const due = (data.cards as Cards.Card[]) .filter((c: Cards.Card) => { // reviews return ( [CardQueue.Review, CardQueue.DayLearn].includes(c.queue) || // or learning cards isLearning(c) ); }) .map((c: Cards.Card) => { let dueDay: number; if (isLearning(c)) { const offset = c.due - data.nextDayAtSecs; dueDay = Math.floor(offset / 86_400) + 1; } else { // - testing just odue fails on day 1 // - testing just odid fails on lapsed cards that // have due calculated at regraduation time const due = c.originalDeckId && c.originalDue ? c.originalDue : c.due; dueDay = due - data.daysElapsed; } haveBacklog = haveBacklog || dueDay < 0; return dueDay; }); const dueCounts = rollup( due, (v) => v.length, (d) => d, ); return { dueCounts, haveBacklog }; } function binValue(d: Bin, number>): number { return sum(d, (d) => d[1]); } export interface FutureDueResponse { histogramData: HistogramData | null; tableData: TableDatum[]; } function makeQuery(start: number, end: number): string { if (start === end) { return `"prop:due=${start}"`; } else { const fromQuery = `"prop:due>=${start}"`; const tillQuery = `"prop:due<=${end}"`; return `${fromQuery} AND ${tillQuery}`; } } export function buildHistogram( sourceData: GraphData, range: GraphRange, backlog: boolean, dispatch: SearchDispatch, browserLinksSupported: boolean, ): FutureDueResponse { const output = { histogramData: null, tableData: [] }; // get min/max const data = sourceData.dueCounts; if (!data) { return output; } const [xMinOrig, origXMax] = extent(data.keys()); let xMin = xMinOrig; if (!backlog) { xMin = 0; } let xMax = origXMax; // cap max to selected range switch (range) { case GraphRange.Month: xMax = 31; break; case GraphRange.ThreeMonths: xMax = 90; break; case GraphRange.Year: xMax = 365; break; case GraphRange.AllTime: break; } // cap bars to available range const desiredBars = Math.min(70, xMax! - xMin!); const x = scaleLinear().domain([xMin!, xMax!]); const bins = histogram() .value((m) => { return m[0]; }) .domain(x.domain() as any) .thresholds(x.ticks(desiredBars))(data.entries() as any); // empty graph? if (!sum(bins, (bin) => bin.length)) { return output; } const adjustedRange = scaleLinear().range([0.7, 0.3]); const colourScale = scaleSequential((n) => interpolateGreens(adjustedRange(n)!), ).domain([xMin!, xMax!]); const total = sum(bins as any, binValue); function hoverText( bin: Bin, cumulative: number, _percent: number, ): string { const days = dayLabel(bin.x0!, bin.x1!); const cards = tr.statisticsCardsDue({ cards: binValue(bin as any), }); const totalLabel = tr.statisticsRunningTotal(); return `${days}:
${cards}
${totalLabel}: ${cumulative}`; } function onClick(bin: Bin): void { const start = bin.x0!; const end = bin.x1! - 1; const query = makeQuery(start, end); dispatch("search", { query }); } const periodDays = xMax! - xMin!; const tableData = [ { label: tr.statisticsTotal(), value: tr.statisticsReviews({ reviews: total }), }, { label: tr.statisticsAverage(), value: tr.statisticsReviewsPerDay({ count: Math.round(total / periodDays), }), }, { label: tr.statisticsDueTomorrow(), value: tr.statisticsReviews({ reviews: sourceData.dueCounts.get(1) ?? 0, }), }, ]; return { histogramData: { scale: x, bins, total, hoverText, onClick: browserLinksSupported ? onClick : null, showArea: true, colourScale, binValue, }, tableData, }; }