freezmo/lib/settings.ts
Martin Dvorak e4a8e0ba01 Phase 2: learning engine — history, SRS review, mistakes, stats, exam, reminders
Answer history and schedules
- Every answer is recorded (deck, activity, topic, correct/wrong, time)
  in a versioned IndexedDB log (freezmo-learning v1, stores answers +
  srs), mirrored in memory for synchronous React reads and capped at
  20k answers (oldest pruned). StudyFeed records as it grades.
- Light SM-2 schedule per activity: 1 day, 3 days, then interval x
  ease; wrong answers return in ten minutes with the ease nudged down.

Review, mistakes, stats
- Library 'Smart review' card: due count, mistakes count (latest
  answer wrong — clears itself when answered correctly), today's goal
  progress. Review sessions freeze their item list at start.
- New /review (due across decks, ?mistakes=1 global or ?deck= per
  deck) built on a shared SessionFeed with the study feed's snap/keyboard
  mechanics, wake lock and a results slide.
- New /stats: day streak, five-week calendar, accuracy per subject and
  per deck, weakest topics (>=3 answers), daily-goal progress.
- Daily goal configurable in Settings (10/20/30/50).

Exam mode
- New /exam: pick decks, question count, optional timer; no hints
  (a NoHints context hides hint rows and the self-check escape);
  results with score, per-deck and per-topic breakdown; wrong answers
  land in the mistakes set through the normal history.

Reminders (conditional)
- VAPID-gated: GET/POST/DELETE /api/push and POST /api/push/test with
  the standard route pattern, RATE_LIMIT_PUSH, zod, auth before body.
  Subscriptions stored server-side as endpoint + keys only (PUSH_DIR).
  UI hidden entirely without keys; iOS install note; service worker
  push/notificationclick handlers; scripts/send-reminders.mjs for a
  cron/systemd timer; web-push added as the one server dependency.

Verified: new phase-2 suite 42/42 (history/SRS shapes from a real study
run, mistakes clearing, review session, stats math, exam timer and
breakdowns, VAPID-less hidden state plus the configured
subscribe/validate/test/delete path against a second instance) plus
regression 74/74, mobile 52/52, wizard 80/80, declutter 116/116,
animation 8/8, native 35/35, phase1 38/38, i18n 25/25. Key parity
709/709. Lint + build clean. SW freezmo-v26.
2026-10-10 14:15:21 +00:00

102 lines
3.2 KiB
TypeScript

"use client";
/**
* Browser-side settings, including the user's own Ollama API key.
*
* The key lives ONLY here, in this browser's localStorage. It is never sent
* anywhere except to Freezmo's own API routes on this server (in the
* `x-ollama-key` header), which forward it to Ollama for that single request
* and never write it to disk, a log, a cookie or the environment.
*/
const STORAGE_KEY = "freezmo.settings.v1";
/** Header that carries the browser's key to Freezmo's own API routes. */
export const API_KEY_HEADER = "x-ollama-key";
export type BrowserSettings = {
/**
* The user's own Ollama API key. Nothing else is stored here — the endpoint
* and model names always come from the server's .env, never from the client.
*/
apiKey: string;
/** Best-effort haptics on supported devices (phones). On by default. */
haptics: boolean;
/** How many answers count as a finished day in the Library/stats. */
dailyGoal: number;
};
const DEFAULT_GOAL = 20;
const EMPTY: BrowserSettings = { apiKey: "", haptics: true, dailyGoal: DEFAULT_GOAL };
let cached: BrowserSettings | null = null;
const listeners = new Set<() => void>();
function read(): BrowserSettings {
if (typeof window === "undefined") return EMPTY;
try {
const raw = window.localStorage.getItem(STORAGE_KEY);
if (!raw) return EMPTY;
const parsed = JSON.parse(raw) as Partial<BrowserSettings>;
const goal = Number.parseInt(String(parsed.dailyGoal ?? DEFAULT_GOAL), 10);
return {
apiKey: typeof parsed.apiKey === "string" ? parsed.apiKey.slice(0, 512) : "",
haptics: parsed.haptics !== false,
dailyGoal: Number.isFinite(goal) ? Math.min(500, Math.max(1, goal)) : DEFAULT_GOAL,
};
} catch {
return EMPTY;
}
}
function write(next: BrowserSettings): void {
cached = next;
try {
if (next.apiKey || next.haptics === false || next.dailyGoal !== DEFAULT_GOAL) {
window.localStorage.setItem(
STORAGE_KEY,
JSON.stringify({ apiKey: next.apiKey, haptics: next.haptics, dailyGoal: next.dailyGoal }),
);
} else {
window.localStorage.removeItem(STORAGE_KEY);
}
} catch (error) {
console.warn("[freezmo] could not save settings (storage disabled?)", error);
}
listeners.forEach((listener) => listener());
}
export const settingsStore = {
subscribe(listener: () => void): () => void {
if (cached === null) cached = read();
listeners.add(listener);
return () => listeners.delete(listener);
},
getSnapshot(): BrowserSettings {
if (cached === null) cached = read();
return cached;
},
getServerSnapshot(): BrowserSettings {
return EMPTY;
},
};
export function getApiKey(): string {
return settingsStore.getSnapshot().apiKey;
}
/** Merge-update: callers only pass what they changed. */
export function saveSettings(next: Partial<BrowserSettings>): void {
write({ ...settingsStore.getSnapshot(), ...next });
}
export function clearApiKey(): void {
write({ ...settingsStore.getSnapshot(), apiKey: "" });
}
/** Header used to hand the key to our own API routes for one request. */
export function authHeaders(): Record<string, string> {
const { apiKey } = settingsStore.getSnapshot();
return apiKey ? { [API_KEY_HEADER]: apiKey } : {};
}