Homework (/homework — entry points in the drawer and on the create screen) - Assignment intake reuses the study pipeline: pasted text, photos (camera/picker, compressed in the browser) and documents (PDF/DOCX/PPTX/ ODT/text) through lib/image + lib/documents, the same vision step and the same language guard. Raw files never leave the device — only text and JPEG data URLs reach the server. - Two large choice cards: “Just make it” returns the finished homework (answer only, plain text, copy + make it again); “Explain how to make this homework” builds an interactive guide. - The guide is one step per screen in the study-feed snap layout: explanation, three progressive hints (nudge -> hint -> the answer) and an optional checkpoint rendered by the existing activity components (graded through /api/grade). The last screen assembles the solution from the step answers, with a copy button. Checkpoints carry xp 0 so the guide stays free of XP/streak chrome. - Results live in freezmo.homework.v1 with a small history (open/delete); “Make it again” re-runs from the stored assignment text (the vision transcription when photos were used) — no original files are stored. - The answer and the guide are written in the assignment's language, never translated into the UI language. Server - POST /api/homework: NDJSON stage events like /api/generate, the same http-guard, auth checked before parsing, and its own RATE_LIMIT_HOMEWORK (documented in .env.example + the README table). - New prompts in lib/prompts.ts and zod schemas in lib/schemas.ts with the same single repair retry; TEXT_MODEL for content, VISION_MODEL only for photos. New shared client pieces: useNotesIntake, lib/homework store, lib/clipboard, and a shared NDJSON reader in lib/client-api. Also finishing the mobile polish pass from the previous request - Phone ice scene: the top-left orb moved behind the glass header (it sat behind the page heading/subtitle). The settings sheet's scroll cue is now a bare chevron inside a content fade (mask) instead of a chip over the status banner, and the API key card's note/disclosure/actions are tightened. - theme-color now follows the in-app theme (SSR metas still fall back to the OS preference); apple-mobile-web-app-status-bar-style stays “default” because iOS fixes the status-bar text colour at launch. Verified: 78/78 homework checks (text/photo/PDF, both modes, EN+CS, dark+light, 360/390px, copy, history persistence, storage privacy, API language, axe), plus the existing suites re-run (mobile 47/47, pixel contrast 0 below AA, i18n 27/27, desktop regression 72/72). Lint + build clean; service worker freezmo-v6.
185 lines
6.2 KiB
TypeScript
185 lines
6.2 KiB
TypeScript
/**
|
|
* Server-side configuration, read from the environment on every request so
|
|
* that editing `.env.local` only requires a dev-server restart.
|
|
*
|
|
* Never import this into a client component: it would leak the API key.
|
|
*/
|
|
|
|
import { sanitiseApiKey } from "./http-guard";
|
|
import { translate, type Locale } from "./i18n-dict";
|
|
|
|
export type AuthMode = "user-key" | "server" | "local";
|
|
|
|
export type ServerConfig = {
|
|
baseUrl: string;
|
|
apiKey: string;
|
|
authMode: AuthMode;
|
|
visionModel: string;
|
|
textModel: string;
|
|
/** True when talking straight to https://ollama.com (needs an API key). */
|
|
directCloud: boolean;
|
|
timeoutMs: number;
|
|
healthTimeoutMs: number;
|
|
/** `false` sends `think: false`; `null` omits the field entirely. */
|
|
think: boolean | null;
|
|
defaultActivityCount: number;
|
|
rateLimits: {
|
|
windowMs: number;
|
|
generate: number;
|
|
grade: number;
|
|
homework: number;
|
|
health: number;
|
|
};
|
|
};
|
|
|
|
/** What a single request should use to talk to Ollama. */
|
|
export type OllamaAuth = {
|
|
baseUrl: string;
|
|
apiKey: string;
|
|
directCloud: boolean;
|
|
authMode: AuthMode;
|
|
};
|
|
|
|
function positiveInt(value: string | undefined, fallback: number): number {
|
|
const parsed = Number.parseInt(value ?? "", 10);
|
|
return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
|
|
}
|
|
|
|
function trimTrailingSlash(url: string): string {
|
|
return url.replace(/\/+$/, "");
|
|
}
|
|
|
|
export function getServerConfig(): ServerConfig {
|
|
const baseUrl = trimTrailingSlash(
|
|
process.env.OLLAMA_BASE_URL?.trim() || "http://localhost:11434",
|
|
);
|
|
const apiKey = process.env.OLLAMA_API_KEY?.trim() || "";
|
|
|
|
const rawAuthMode = process.env.OLLAMA_AUTH?.trim().toLowerCase();
|
|
const authMode: AuthMode =
|
|
rawAuthMode === "local" || rawAuthMode === "server" || rawAuthMode === "user-key"
|
|
? rawAuthMode
|
|
: rawAuthMode === "none"
|
|
? "local"
|
|
: "user-key";
|
|
|
|
let directCloud = false;
|
|
try {
|
|
const host = new URL(baseUrl).hostname.toLowerCase();
|
|
directCloud = host === "ollama.com" || host.endsWith(".ollama.com");
|
|
} catch {
|
|
directCloud = false;
|
|
}
|
|
|
|
const thinkRaw = process.env.OLLAMA_THINK?.trim().toLowerCase();
|
|
const think =
|
|
thinkRaw === "false" ? false : thinkRaw === "true" ? true : null;
|
|
|
|
const count = Number.parseInt(
|
|
process.env.FREEZMO_DEFAULT_ACTIVITY_COUNT ?? "",
|
|
10,
|
|
);
|
|
|
|
return {
|
|
baseUrl,
|
|
apiKey,
|
|
authMode,
|
|
visionModel: process.env.VISION_MODEL?.trim() || "gemma4:31b-cloud",
|
|
textModel: process.env.TEXT_MODEL?.trim() || "gpt-oss:120b-cloud",
|
|
directCloud,
|
|
timeoutMs: Number.parseInt(process.env.OLLAMA_TIMEOUT_MS ?? "", 10) || 300_000,
|
|
healthTimeoutMs:
|
|
Number.parseInt(process.env.OLLAMA_HEALTH_TIMEOUT_MS ?? "", 10) || 8_000,
|
|
think,
|
|
defaultActivityCount: Number.isFinite(count) ? Math.min(Math.max(count, 6), 20) : 10,
|
|
rateLimits: {
|
|
windowMs: positiveInt(process.env.RATE_LIMIT_WINDOW_MS, 300_000),
|
|
generate: positiveInt(process.env.RATE_LIMIT_GENERATE, 12),
|
|
grade: positiveInt(process.env.RATE_LIMIT_GRADE, 40),
|
|
// Homework is one to two model calls, like a deck.
|
|
homework: positiveInt(process.env.RATE_LIMIT_HOMEWORK, 12),
|
|
health: positiveInt(process.env.RATE_LIMIT_HEALTH, 90),
|
|
},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Human-readable explanation for every auth configuration problem, so the UI
|
|
* never has to show a bare "unauthorised".
|
|
*/
|
|
const AUTH_ERROR_KEYS: Record<"missing_key" | "server_key_missing" | "local_with_cloud_url", string> = {
|
|
missing_key: "server.authMissingKey",
|
|
server_key_missing: "server.authServerKeyMissing",
|
|
local_with_cloud_url: "server.authLocalCloud",
|
|
};
|
|
|
|
export function authErrorMessage(locale: Locale, error: keyof typeof AUTH_ERROR_KEYS): string {
|
|
return translate(locale, AUTH_ERROR_KEYS[error]);
|
|
}
|
|
|
|
export function authErrorKind(error: "missing_key" | "server_key_missing" | "local_with_cloud_url"): string {
|
|
if (error === "missing_key") return "needs_key";
|
|
return "config";
|
|
}
|
|
|
|
/** Header a browser uses to hand over its own key for a single request. */
|
|
export const API_KEY_HEADER = "x-ollama-key";
|
|
|
|
|
|
|
|
/**
|
|
* Works out which credentials a request may use.
|
|
*
|
|
* - `user-key` (default): the key must come from the browser. Nothing is
|
|
* stored server-side, ever — it is used for this request and dropped.
|
|
* - `server`: the key comes from `.env.local` (single-user installs).
|
|
* - `local`: neither; a local daemon signed in with `ollama signin`.
|
|
*/
|
|
export function resolveAuth(
|
|
config: ServerConfig,
|
|
request: Request,
|
|
): { auth: OllamaAuth } | { error: "missing_key" | "server_key_missing" | "local_with_cloud_url" } {
|
|
const headerKey = sanitiseApiKey(request.headers.get(API_KEY_HEADER));
|
|
|
|
if (config.authMode === "local") {
|
|
// A daemon without sign-in can't talk to the cloud API: catch the
|
|
// misconfiguration here instead of returning a confusing 401 later.
|
|
if (config.directCloud) return { error: "local_with_cloud_url" };
|
|
return {
|
|
auth: { baseUrl: config.baseUrl, apiKey: "", directCloud: config.directCloud, authMode: "local" },
|
|
};
|
|
}
|
|
|
|
if (config.authMode === "server") {
|
|
if (!config.apiKey) return { error: "server_key_missing" };
|
|
return {
|
|
auth: { baseUrl: config.baseUrl, apiKey: config.apiKey, directCloud: config.directCloud, authMode: "server" },
|
|
};
|
|
}
|
|
|
|
if (!headerKey) return { error: "missing_key" };
|
|
return {
|
|
auth: { baseUrl: config.baseUrl, apiKey: headerKey, directCloud: config.directCloud, authMode: "user-key" },
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Cloud models are addressed as `<model>:cloud` (or `<model>-cloud`) by a
|
|
* local daemon, but the direct cloud API uses the plain library name
|
|
* (`gemma4:31b-cloud` -> `gemma4:31b`, `glm-5.3-flash:cloud` -> `glm-5.3-flash`).
|
|
* Normalise so the same .env works in both modes.
|
|
*/
|
|
export function resolveModelName(model: string, directCloud: boolean): string {
|
|
if (!directCloud) return model;
|
|
if (model.endsWith(":cloud")) return model.slice(0, -":cloud".length);
|
|
if (model.endsWith("-cloud")) return model.slice(0, -"-cloud".length);
|
|
return model;
|
|
}
|
|
|
|
/** Strip local/daemon routing suffixes so model names can be compared. */
|
|
export function canonicalModelName(model: string): string {
|
|
return model
|
|
.replace(/:cloud$/, "")
|
|
.replace(/-cloud$/, "")
|
|
.toLowerCase();
|
|
}
|