Files
gerbeur/api/lib/site-icons.ts
khannurien d62e4a9883
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 47s
Build and deploy docs / build-and-push (push) Successful in 26s
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>
2026-09-27 21:07:40 +00:00

154 lines
5.0 KiB
TypeScript
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* Generates the full favicon set and web manifest from a single emoji.
*
* Twemoji ships each emoji as a plain vector-path SVG, so it rasterizes without
* any system emoji font (which matters in the minimal Alpine runtime image).
* `@resvg/resvg-wasm` does the rasterization; the .ico is assembled by hand.
*
* Invoked by api/scripts/generate-icons.ts at server startup (into dist/ in
* prod, public/ in dev) — see that script for how the output dir is chosen.
*
* @module
*/
import { initWasm, Resvg } from "@resvg/resvg-wasm";
import { fetchTwemojiSvg } from "../remote/twemoji.ts";
const PNG_SIZES = [16, 32, 48, 64, 96, 128, 192, 256, 512];
const APPLE_SIZE = 180;
const ICO_SIZES = [16, 32, 48];
/**
* Returns the name Twemoji files `emoji` under: its codepoints joined with
* "-", variation selectors (FE0F) stripped unless the emoji is a ZWJ sequence.
* Also doubles as a stable cache-busting version string for the icon URLs.
*/
export function emojiToCodepoint(emoji: string): string {
const cleaned = emoji.includes("‍") ? emoji : emoji.replace(/️/g, "");
return [...cleaned].map((ch) => ch.codePointAt(0)!.toString(16)).join("-");
}
let wasmReady: Promise<unknown> | undefined;
function ensureWasm(): Promise<unknown> {
if (!wasmReady) {
const wasmUrl = new URL(
import.meta.resolve("@resvg/resvg-wasm/index_bg.wasm"),
);
wasmReady = Deno.readFile(wasmUrl).then((bytes) => initWasm(bytes));
}
return wasmReady;
}
function renderPng(svg: string, size: number, background?: string): Uint8Array {
const resvg = new Resvg(svg, {
fitTo: { mode: "width", value: size },
background,
});
return resvg.render().asPng();
}
/** Packs PNG payloads into a (PNG-compressed) .ico container. */
function buildIco(images: { size: number; png: Uint8Array }[]): Uint8Array {
const HEADER = 6;
const ENTRY = 16;
const offsetBase = HEADER + ENTRY * images.length;
const total = offsetBase + images.reduce((sum, i) => sum + i.png.length, 0);
const buf = new Uint8Array(total);
const dv = new DataView(buf.buffer);
dv.setUint16(2, 1, true); // type: icon
dv.setUint16(4, images.length, true);
let offset = offsetBase;
images.forEach((img, idx) => {
const e = HEADER + idx * ENTRY;
buf[e] = img.size >= 256 ? 0 : img.size; // width (0 means 256)
buf[e + 1] = img.size >= 256 ? 0 : img.size; // height
dv.setUint16(e + 4, 1, true); // color planes
dv.setUint16(e + 6, 32, true); // bits per pixel
dv.setUint32(e + 8, img.png.length, true); // size of image data
dv.setUint32(e + 12, offset, true); // offset of image data
buf.set(img.png, offset);
offset += img.png.length;
});
return buf;
}
function buildManifest(siteName: string, bgColor: string): string {
const manifest = {
name: siteName,
short_name: siteName,
start_url: "/",
display: "standalone",
background_color: bgColor,
theme_color: bgColor,
icons: [
{ src: "/favicon.svg", type: "image/svg+xml", sizes: "any" },
{ src: "/favicon-192x192.png", type: "image/png", sizes: "192x192" },
{
src: "/favicon-512x512.png",
type: "image/png",
sizes: "512x512",
purpose: "any maskable",
},
],
share_target: {
action: "/",
method: "GET",
params: { url: "share_url", title: "share_title", text: "share_text" },
},
};
return JSON.stringify(manifest, null, 2) + "\n";
}
/** What {@link generateSiteIcons} renders, and where. */
export interface GenerateSiteIconsOptions {
/** Emoji to render the icons from. */
emoji: string;
/** Directory to write the assets into (created if missing). */
outDir: string;
/** Site name written into the manifest. */
siteName: string;
/**
* Background color for the Apple touch icon and manifest (iOS ignores
* transparency).
*/
bgColor: string;
}
/**
* Generates `favicon.svg`, `favicon.ico`, `favicon-<size>x<size>.png` (16–512),
* `apple-touch-icon.png` and `manifest.webmanifest` into `outDir`.
*
* @throws {Error} When the emoji's glyph can't be fetched.
*/
export async function generateSiteIcons(
opts: GenerateSiteIconsOptions,
): Promise<void> {
const { emoji, outDir, siteName, bgColor } = opts;
const svg = await fetchTwemojiSvg(emoji, emojiToCodepoint(emoji));
await ensureWasm();
await Deno.mkdir(outDir, { recursive: true });
const out = (name: string) => `${outDir}/${name}`;
await Deno.writeTextFile(out("favicon.svg"), svg);
const pngs = new Map<number, Uint8Array>();
for (const size of PNG_SIZES) pngs.set(size, renderPng(svg, size));
for (const size of PNG_SIZES) {
await Deno.writeFile(out(`favicon-${size}x${size}.png`), pngs.get(size)!);
}
// Apple touch icon gets a solid background — iOS doesn't honor transparency.
await Deno.writeFile(
out("apple-touch-icon.png"),
renderPng(svg, APPLE_SIZE, bgColor),
);
await Deno.writeFile(
out("favicon.ico"),
buildIco(ICO_SIZES.map((size) => ({ size, png: pngs.get(size)! }))),
);
await Deno.writeTextFile(
out("manifest.webmanifest"),
buildManifest(siteName, bgColor),
);
}