v3: the backend is documented for deno doc, one way in every file, and the docs build and publish themselves — comments were in three shapes: file headers as // lines, as an untagged /** */ (which deno doc drops, only an @module block counts) or missing; 43 exports described by a // deno doc can't see, two JSDoc blocks sitting on the wrong declaration and one duplicated; endpoints commented in 5 of 18 route files, three ways, on router.get() calls no doc tool reads. The rule, applied to every non-test module of api/, migrations included: each opens with a /** … @module */ block; every export has JSDoc, and so does every field of an exported interface; a comment describing a declaration is /** */, // only notes code; functions open with a verb, everything else with a noun phrase; parameters are named in the prose, {@link} only for symbols in scope; whatever throws to its caller says so with @throws (for an APIException, the statuses and when); a router's JSDoc lists its endpoints, method and path, who may call it, what it does. deno doc --lint goes from 528 errors to none in api/ (shared/ keeps its 385; it is next). The lint also wanted explicit types on config.ts's settings and a few return types, JsonLdResult exported, and the routers typed Router. deno task doc builds the HTML reference into docs/ from every module of api/ and shared/ but the tests, deno task doc:lint lints it; the index page is the module doc of a root mod.ts (deno.json's exports), which introduces the backend, shared/ and the frontend to come and links every module, and mod.test.ts fails when one is missing. The docs workflow builds it on every push to main that touches them and publishes it to the gh-pages branch, like publish-assistant's. Two defects found along the way are fixed: a private playlist's cover was served to anyone who had its id or slug, and now needs its owner's media token, as private dump files do (playlistImageUrl adds it for private playlists only, so public cover URLs stay the same for everyone); og.ts and static.ts each filled index.html's placeholders, and now share lib/index-html.ts, so the OG middleware picks up a rebuilt index.html instead of keeping the first it read. The README states the documentation rule. 205 backend and 628 frontend tests pass.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

api/remote/bandcamp-streams.ts

@@ -1,9 +1,3 @@
-import { APIErrorCode } from "../../shared/api.ts";
-import { APIException } from "../lib/api-exception.ts";
-import { fetchWithTimeout, isValidHttpUrl, readTextCapped } from "./fetch.ts";
-import { BANDCAMP_HOST_RE, parseTralbum } from "./bandcamp-tralbum.ts";
-import type { Tralbum } from "../../shared/player.ts";
-
 /**
  * Resolves a Bandcamp page to its streamable tracks, at play time.
  *
@@ -11,16 +5,31 @@ import type { Tralbum } from "../../shared/player.ts";
  * never be baked into `rich_content` at dump-creation time the way `embedUrl`
  * is. This service is the play-time counterpart: the frontend asks for a page,
  * gets a whole tracklist back, and plays the mp3s directly from bcbits.
+ *
+ * @module
  */
 
-/** Comfortably inside the 24h signature life, so a cache hit is never a URL
- * that is about to expire mid-listen. */
+import { APIErrorCode } from "../../shared/api.ts";
+import { APIException } from "../lib/api-exception.ts";
+import { fetchWithTimeout, isValidHttpUrl, readTextCapped } from "./fetch.ts";
+import { BANDCAMP_HOST_RE, parseTralbum } from "./bandcamp-tralbum.ts";
+import type { Tralbum } from "../../shared/player.ts";
+
+/**
+ * How long a resolved page is cached: comfortably inside the 24h signature
+ * life, so a cache hit is never a URL that is about to expire mid-listen.
+ */
 const TTL_MS = 12 * 60 * 60 * 1000;
+/** The most pages cached; the oldest write goes first. */
 const MAX_ENTRIES = 200;
 
+/** Resolved pages, by {@link cacheKey}. */
 const cache = new Map<string, Tralbum>();
 
-/** Cache key: a page is the same page regardless of query, fragment or case. */
+/**
+ * Returns the cache key of `url`: a page is the same page regardless of query,
+ * fragment or case.
+ */
 function cacheKey(url: string): string {
   try {
     const u = new URL(url);
@@ -52,10 +61,14 @@ function writeCache(key: string, value: Tralbum): void {
 }
 
 /**
- * Fetch and parse a Bandcamp page.
+ * Fetches a Bandcamp page and returns its tracklist, cached.
  *
  * `force` bypasses the cache — used by the client's re-resolve path, so a
  * cached entry whose URLs have started 403ing can't keep being handed back.
+ *
+ * @throws {APIException} 400 when `pageUrl` isn't a public bandcamp.com URL,
+ * 502 when Bandcamp can't be reached or doesn't answer with a page, 404 when
+ * the page has nothing streamable.
  */
 export async function resolveBandcamp(
   pageUrl: string,