In user-key mode a browser with no stored Ollama key now gets a polished gate instead of the app shell: one masked input with a show/hide toggle, a single Continue button, inline validation errors, and a "?" help sheet with the steps to a free key. - Validates the draft key through /api/health (real 1-token probe) before saving; invalid-key and network failures read differently. - Key still lives only in this browser's localStorage; nothing server-side. - Gate wraps /, /create and deck study; server-key and local-daemon modes skip it; removing the key in Settings brings it back. - Removes the now-redundant dashboard/create API-key banner. - Monochrome corner glows (dark near-black / light near-white), 24px card, 48px field and button, gentle fade/slide-in, reduced-motion aware. - Help modal: centred dialog on desktop, bottom sheet on mobile, closes via X, Escape or backdrop. - README and browser suites updated (34 gate checks, 15 key-flow checks, 12 shipped-default checks; ui/folders/docs/pwa/security/contrast green).
265 lines
7.8 KiB
TypeScript
265 lines
7.8 KiB
TypeScript
"use client";
|
|
|
|
import type { Activity, Difficulty } from "./schemas";
|
|
import { API_KEY_HEADER, authHeaders } from "./settings";
|
|
|
|
export type GenerateInput = {
|
|
images?: string[];
|
|
text?: string;
|
|
difficulty: Difficulty;
|
|
count?: number;
|
|
focus?: string;
|
|
language?: string;
|
|
mode?: "create" | "more";
|
|
existing?: { title: string; types: string[]; count: number };
|
|
};
|
|
|
|
export type StreamedDeck = {
|
|
title: string;
|
|
subject?: string;
|
|
summary?: string;
|
|
language?: string;
|
|
sourceText: string;
|
|
difficulty: Difficulty;
|
|
activities: Activity[];
|
|
};
|
|
|
|
export type GenerateProgress = {
|
|
stage: "vision" | "generation" | "done";
|
|
message: string;
|
|
};
|
|
|
|
type StreamEvent =
|
|
| { type: "stage"; stage: "vision" | "generation" | "done"; message: string }
|
|
| { type: "deck"; deck: StreamedDeck; meta: Record<string, unknown> }
|
|
| { type: "error"; error: string; kind?: string };
|
|
|
|
export class ApiError extends Error {
|
|
kind: string;
|
|
constructor(message: string, kind = "unknown") {
|
|
super(message);
|
|
this.name = "ApiError";
|
|
this.kind = kind;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Calls POST /api/generate and consumes the NDJSON progress stream.
|
|
* Progress events arrive between the vision and generation steps.
|
|
*/
|
|
export async function generateDeck(
|
|
input: GenerateInput,
|
|
options: { onProgress?: (progress: GenerateProgress) => void; signal?: AbortSignal } = {},
|
|
): Promise<{ deck: StreamedDeck; meta: Record<string, unknown> }> {
|
|
let response: Response;
|
|
try {
|
|
response = await fetch("/api/generate", {
|
|
method: "POST",
|
|
headers: { "Content-Type": "application/json", ...authHeaders() },
|
|
body: JSON.stringify(input),
|
|
signal: options.signal,
|
|
});
|
|
} catch (error) {
|
|
if (error instanceof Error && error.name === "AbortError") {
|
|
throw new ApiError("Generation was cancelled.", "aborted");
|
|
}
|
|
throw new ApiError("Could not reach the Freezmo server. Is it still running?", "network");
|
|
}
|
|
|
|
if (!response.ok) {
|
|
const body = (await response.json().catch(() => null)) as { error?: string; kind?: string } | null;
|
|
throw new ApiError(body?.error ?? `The server returned HTTP ${response.status}.`, body?.kind);
|
|
}
|
|
if (!response.body) {
|
|
throw new ApiError("The server sent an empty response.", "bad_response");
|
|
}
|
|
|
|
const reader = response.body.getReader();
|
|
const decoder = new TextDecoder();
|
|
let buffer = "";
|
|
let deck: StreamedDeck | null = null;
|
|
let meta: Record<string, unknown> = {};
|
|
let streamError: ApiError | null = null;
|
|
let sawActivity = false;
|
|
|
|
const handleLine = (line: string) => {
|
|
if (!line.trim()) return;
|
|
let event: StreamEvent;
|
|
try {
|
|
event = JSON.parse(line) as StreamEvent;
|
|
} catch {
|
|
return;
|
|
}
|
|
if (event.type === "stage") {
|
|
options.onProgress?.({ stage: event.stage, message: event.message });
|
|
} else if (event.type === "deck") {
|
|
deck = event.deck;
|
|
meta = event.meta ?? {};
|
|
sawActivity = true;
|
|
options.onProgress?.({ stage: "done", message: "Almost there…" });
|
|
} else if (event.type === "error") {
|
|
streamError = new ApiError(event.error, event.kind);
|
|
}
|
|
};
|
|
|
|
while (true) {
|
|
const { done, value } = await reader.read();
|
|
if (done) break;
|
|
buffer += decoder.decode(value, { stream: true });
|
|
let newline = buffer.indexOf("\n");
|
|
while (newline !== -1) {
|
|
handleLine(buffer.slice(0, newline));
|
|
buffer = buffer.slice(newline + 1);
|
|
newline = buffer.indexOf("\n");
|
|
}
|
|
}
|
|
handleLine(buffer);
|
|
|
|
if (streamError) throw streamError;
|
|
if (!deck) {
|
|
throw new ApiError(
|
|
sawActivity
|
|
? "The server finished without sending a deck."
|
|
: "No deck came back from the server. Check your Ollama settings and try again.",
|
|
"bad_response",
|
|
);
|
|
}
|
|
|
|
const valid = (deck as StreamedDeck).activities?.filter(
|
|
(activity) => activity && typeof activity.type === "string" && typeof activity.id === "string",
|
|
);
|
|
if (!valid || valid.length === 0) {
|
|
throw new ApiError("The generated deck had no usable activities. Try again.", "bad_response");
|
|
}
|
|
|
|
return { deck: { ...(deck as StreamedDeck), activities: valid }, meta };
|
|
}
|
|
|
|
export async function gradeAnswer(input: {
|
|
question: string;
|
|
referenceAnswer: string;
|
|
keyPoints: string[];
|
|
userAnswer: string;
|
|
language?: string;
|
|
signal?: AbortSignal;
|
|
}): Promise<{ correct: boolean; score: number; feedback: string; missing: string[] }> {
|
|
let response: Response;
|
|
try {
|
|
response = await fetch("/api/grade", {
|
|
method: "POST",
|
|
headers: { "Content-Type": "application/json", ...authHeaders() },
|
|
body: JSON.stringify(input),
|
|
signal: input.signal,
|
|
});
|
|
} catch (error) {
|
|
if (error instanceof Error && error.name === "AbortError") {
|
|
throw new ApiError("Grading was cancelled.", "aborted");
|
|
}
|
|
throw new ApiError("Could not reach the Freezmo server.", "network");
|
|
}
|
|
|
|
const body = (await response.json().catch(() => null)) as
|
|
| { correct: boolean; score: number; feedback: string; missing?: string[]; error?: string; kind?: string }
|
|
| null;
|
|
|
|
if (!response.ok || !body || body.error) {
|
|
throw new ApiError(body?.error ?? `Grading failed with HTTP ${response.status}.`, body?.kind);
|
|
}
|
|
|
|
return {
|
|
correct: Boolean(body.correct),
|
|
score: Math.max(0, Math.min(100, Math.round(body.score))),
|
|
feedback: body.feedback,
|
|
missing: body.missing ?? [],
|
|
};
|
|
}
|
|
|
|
export type HealthModel = {
|
|
configured: string;
|
|
resolved: string;
|
|
available: boolean | null;
|
|
note?: string;
|
|
};
|
|
|
|
export type Health = {
|
|
ok: boolean;
|
|
reachable: boolean;
|
|
mode: "local-daemon" | "direct-cloud";
|
|
authMode: "user-key" | "server" | "local";
|
|
needsKey: boolean;
|
|
keyAccepted: boolean | null;
|
|
baseUrl: string;
|
|
hasApiKey: boolean;
|
|
vision: HealthModel;
|
|
text: HealthModel;
|
|
latencyMs: number | null;
|
|
modelCount: number | null;
|
|
error: string | null;
|
|
kind?: string;
|
|
checkedAt: string;
|
|
};
|
|
|
|
export async function fetchHealth(): Promise<Health> {
|
|
try {
|
|
const response = await fetch("/api/health", { cache: "no-store", headers: authHeaders() });
|
|
return (await response.json()) as Health;
|
|
} catch {
|
|
throw new ApiError("Could not reach the Freezmo server.", "network");
|
|
}
|
|
}
|
|
|
|
export type KeyCheck =
|
|
| { result: "valid" }
|
|
| { result: "invalid"; message: string }
|
|
| { result: "offline"; message: string };
|
|
|
|
/**
|
|
* Checks a *draft* key before it is saved anywhere, by asking our own
|
|
* `/api/health` route (which performs a real one-token chat probe against
|
|
* Ollama — model listings alone prove nothing). The key travels in the
|
|
* request header for this single call and is never stored server-side.
|
|
*/
|
|
export async function verifyOllamaKey(apiKey: string): Promise<KeyCheck> {
|
|
let response: Response;
|
|
try {
|
|
response = await fetch("/api/health", {
|
|
cache: "no-store",
|
|
headers: { [API_KEY_HEADER]: apiKey },
|
|
});
|
|
} catch {
|
|
return {
|
|
result: "offline",
|
|
message: "Could not reach the Freezmo server. Is it still running?",
|
|
};
|
|
}
|
|
|
|
const body = (await response.json().catch(() => null)) as Health | null;
|
|
if (!response.ok || !body) {
|
|
return {
|
|
result: "offline",
|
|
message: "The Freezmo server answered unexpectedly. Try again in a moment.",
|
|
};
|
|
}
|
|
|
|
if (body.keyAccepted === false) {
|
|
return {
|
|
result: "invalid",
|
|
message:
|
|
body.error ??
|
|
"Ollama rejected this key. Check for typos, or create a new one at ollama.com/settings/keys.",
|
|
};
|
|
}
|
|
if (body.keyAccepted === true) return { result: "valid" };
|
|
|
|
if (!body.reachable) {
|
|
return {
|
|
result: "offline",
|
|
message:
|
|
body.error ?? "Couldn't reach Ollama just now. Check your connection and try again.",
|
|
};
|
|
}
|
|
|
|
// Reachable, but the probe was inconclusive (usually a model-availability
|
|
// matter rather than a bad key). Let the user in — Settings shows details.
|
|
return { result: "valid" };
|
|
}
|