@johnmorrisdotca/dougu-sports 0.0.1 → 0.1.0

package/dist/emblems/emblem.core.js

@@ -35,14 +35,26 @@ export function resolve(o) {
     const size = typeof o?.size === "number" && Number.isFinite(o.size) && o.size > 0 ? Math.min(Math.round(o.size * 100) / 100, 4096) : 64;
     const theme = o?.theme === "auto" || o?.theme === "light" || o?.theme === "dark" ? o.theme : "inherit";
     const style = o?.style === "line" || o?.style === "color" ? o.style : "metal";
-    return { style, size, theme, tint: readColour(o?.tint) };
+    const accent = readColour(o?.accent);
+    const initials = typeof o?.initials === "string" ? [...o.initials.trim()].slice(0, 3).join("").toUpperCase() : "";
+    return { style, size, theme, tint: readColour(o?.tint), accent: accent === undefined ? undefined : hexOf(accent), initials };
 }
 /** The main colour of a metal, or the tint when there is one. */
-export const mainOf = (metal, tint) => tint ?? readColour(METALS[metal]);
+export const mainOf = (metal, tint) => tint ?? readColour(metal === "flat" ? "#8a949e" : METALS[metal]);
+/** The relative luminance of a colour, 0 to 1. */
+export function lum(rgb) {
+    const [r, g, b] = rgb.map((c) => {
+        const k = c / 255;
+        return k <= 0.03928 ? k / 12.92 : ((k + 0.055) / 1.055) ** 2.4;
+    });
+    return 0.2126 * r + 0.7152 * g + 0.0722 * b;
+}
+/** Black or white, whichever reads better on a colour. */
+export const onColour = (rgb) => ((lum(rgb) + 0.05) / 0.05 > 1.05 / (lum(rgb) + 0.05) ? "#000000" : "#ffffff");
 /** A turn in degrees, as a finite number (0 for anything else). */
 export const degrees = (value) => (typeof value === "number" && Number.isFinite(value) ? value % 360 : 0);
-/** The paint for a main colour in a style. The gradient's id names the colour, so two of one colour in a page agree. */
-export function paintFor(style, main, kind = "linear") {
+/** The paint of a ball: a radial gradient in the metal style. The gradient's id names the colour, so two of one colour in a page agree. */
+export function paintFor(style, main) {
     if (style === "line")
         return { main: "none", shade: "none", light: "none", ribbon: "none", defs: "" };
     const shade = mix(main, -0.28);
@@ -50,18 +62,50 @@ export function paintFor(style, main, kind = "linear") {
     const ribbon = "#b3362b";
     if (style === "color")
         return { main: hexOf(main), shade, light, ribbon, defs: "" };
-    const id = `dgs${kind === "radial" ? "r" : "l"}${hexOf(main).slice(1)}`;
-    const stops = `<stop offset="0" stop-color="${mix(main, -0.3)}"/><stop offset="0.3" stop-color="${light}"/><stop offset="0.55" stop-color="${hexOf(main)}"/><stop offset="1" stop-color="${mix(main, -0.38)}"/>`;
-    const defs = kind === "linear"
-        ? `<defs><linearGradient id="${id}" x2="1" y2="0.2">${stops}</linearGradient></defs>`
-        : `<defs><radialGradient id="${id}" cx="0.36" cy="0.3" r="0.8"><stop offset="0" stop-color="${light}"/><stop offset="0.55" stop-color="${hexOf(main)}"/><stop offset="1" stop-color="${mix(main, -0.38)}"/></radialGradient></defs>`;
+    const id = `dgsr${hexOf(main).slice(1)}`;
+    const defs = `<defs><radialGradient id="${id}" cx="0.36" cy="0.3" r="0.8"><stop offset="0" stop-color="${light}"/><stop offset="0.55" stop-color="${hexOf(main)}"/><stop offset="1" stop-color="${mix(main, -0.38)}"/></radialGradient></defs>`;
     return { main: `url(#${id})`, shade, light, ribbon, defs };
 }
+const stops = (list) => list.map(([at, colour]) => `<stop offset="${n2(at).replace(/^0\./, ".")}" stop-color="${colour}"/>`).join("");
+/**
+ * The shading of a round metal body: a dark edge, a bright band left of the middle, the metal, a darker side, and a faint light from the rim on the far edge, as polished metal throws it. `shift` slides the bright
+ * band (a turn). The id names the colour and the shift, so two bodies of one colour in a page share one definition.
+ */
+export function cylinderGradient(main, shift = 0) {
+    const h = Math.max(0.14, Math.min(0.5, 0.3 + shift));
+    const id = `dgsc${hexOf(main).slice(1)}${shift === 0 ? "" : `s${Math.round(shift * 100) + 100}`}`;
+    const list = [[0, mix(main, -0.5)], [0.1, mix(main, -0.16)], [h, mix(main, 0.62)], [h + 0.26, mix(main, 0.08)], [0.84, mix(main, -0.36)], [0.95, mix(main, -0.1)], [1, mix(main, -0.52)]];
+    return { id, def: `<linearGradient id="${id}">${stops(list)}</linearGradient>`, fill: `url(#${id})` };
+}
+/** The shading of a round flat or a ball: light from the top left, the metal, then dark at the far edge. */
+export function orbGradient(main) {
+    const id = `dgso${hexOf(main).slice(1)}`;
+    return { id, def: `<radialGradient id="${id}" cx="0.36" cy="0.3" r="0.82">${stops([[0, mix(main, 0.7)], [0.3, mix(main, 0.2)], [0.62, hexOf(main)], [1, mix(main, -0.42)]])}</radialGradient>`, fill: `url(#${id})` };
+}
+/** The shading of a flat sheet of metal, from a bright corner to a dark one. */
+export function sheetGradient(main) {
+    const id = `dgsd${hexOf(main).slice(1)}`;
+    return { id, def: `<linearGradient id="${id}" x2="1" y2="1">${stops([[0, mix(main, 0.55)], [0.35, mix(main, 0.12)], [0.6, hexOf(main)], [1, mix(main, -0.4)]])}</linearGradient>`, fill: `url(#${id})` };
+}
+/** The shading of a raised rim: bright on the top left, dark on the bottom right, as a bevel catches the light (or the other way round, for a groove). */
+export function bevelGradient(main, groove = false) {
+    const id = `dgse${hexOf(main).slice(1)}${groove ? "g" : ""}`;
+    const [a, b] = groove ? [mix(main, -0.45), mix(main, 0.6)] : [mix(main, 0.65), mix(main, -0.5)];
+    return { id, def: `<linearGradient id="${id}" x2="1" y2="1">${stops([[0, a], [0.5, hexOf(main)], [1, b]])}</linearGradient>`, fill: `url(#${id})` };
+}
+/** The gradients' definitions as one `<defs>`, with none twice. */
+export const defsOf = (gradients) => {
+    const seen = new Set();
+    const list = gradients.filter((g) => !seen.has(g.id) && seen.add(g.id));
+    return list.length === 0 ? "" : `<defs>${list.map((g) => g.def).join("")}</defs>`;
+};
 /** A drawing wrapped into a document: the title, the outline's colour for the theme, and the group that strokes it. */
 export function wrap(o) {
     const colour = o.theme === "dark" ? EMBLEM_INK.dark : o.theme === "inherit" ? "" : EMBLEM_INK.light;
     const auto = o.theme === "auto" ? `<style>@media(prefers-color-scheme:dark){svg{color:${EMBLEM_INK.dark}}}</style>` : "";
-    const stroke = o.style === "line" ? 2.6 : 2.2;
+    // `edge` is a colour of the drawing's own for the outline (a metal's darker tone); without it the outline is the page's ink. The `line` style is always the page's ink.
+    const ink = o.edge !== undefined && o.style !== "line" ? o.edge : "currentColor";
+    const stroke = o.width ?? (o.style === "line" ? 2.6 : 2.2);
     return (`<svg xmlns="http://www.w3.org/2000/svg" viewBox="${o.box ?? "0 0 64 64"}" width="${o.size}" height="${o.size}" role="img"${colour === "" ? "" : ` color="${colour}"`}>` +
-        `<title>${escape(o.title)}</title>${auto}${o.defs ?? ""}<g fill="none" stroke="currentColor" stroke-width="${stroke}" stroke-linejoin="round" stroke-linecap="round">${o.body}</g></svg>`);
+        `<title>${escape(o.title)}</title>${auto}${o.defs ?? ""}<g fill="none" stroke="${ink}" stroke-width="${n2(stroke)}" stroke-linejoin="round" stroke-linecap="round">${o.body}</g></svg>`);
 }

package/dist/emblems/emblem.ids.d.ts

@@ -1,49 +1,55 @@
 /** The thirty-three sports the emblems are made for: the names that `ball:<sport>`, `gear:<sport>` and `sport:<sport>` use. */
 export declare const SPORT_NAMES: readonly ["nfl", "cfl", "ifaf", "nhl", "nba", "mlb", "soccer", "curling", "tennis", "volleyball", "badminton", "pickleball", "tabletennis", "padel", "squash", "racquetball", "sepaktakraw", "teqball", "roundnet", "netball", "swimming", "waterpolo", "diving", "artisticswimming", "lacrosse", "rugby", "afl", "gaelic", "cricket", "fieldhockey", "handball", "athletics", "skating"];
 export type SportName = (typeof SPORT_NAMES)[number];
-/** The awards: a medal on a ribbon, and the rest as they arrive. */
-export declare const AWARD_IDS: readonly ["award:medal"];
+/** The awards, drawn from Material Symbols: a medal on a ribbon, a badge, a crown, a star and a shield. */
+export declare const AWARD_IDS: readonly ["award:medal", "award:badge", "award:crown", "award:star", "award:shield"];
 export type AwardId = (typeof AWARD_IDS)[number];
-/** The trophies. */
-export declare const TROPHY_IDS: readonly [];
+/** The trophies: a cup for each league's champion in a descriptive, generic form, the plain cups and dishes, and the flat plaque, belt, wreath and rosette. */
+export declare const TROPHY_IDS: readonly ["trophy:cup", "trophy:lidded-cup", "trophy:bowl", "trophy:salver", "trophy:globe", "trophy:hockey-cup", "trophy:basketball", "trophy:baseball", "trophy:football", "trophy:canadian-bowl", "trophy:soccer-ball", "trophy:soccer-globe", "trophy:tennis-plate", "trophy:tennis-cup", "trophy:cricket-urn", "trophy:rugby-cup", "trophy:plaque", "trophy:belt", "trophy:laurel", "trophy:rosette"];
 export type TrophyId = (typeof TROPHY_IDS)[number];
-/** The medals by place. */
-export declare const MEDAL_IDS: readonly [];
+/** The medals on a ribbon, and the badges for the first three places. */
+export declare const MEDAL_KINDS: readonly ["gold", "silver", "bronze"];
+export type MedalKind = (typeof MEDAL_KINDS)[number];
+export declare const MEDAL_IDS: readonly ["medal:gold", "medal:silver", "medal:bronze", "medal:place-1", "medal:place-2", "medal:place-3"];
 export type MedalId = (typeof MEDAL_IDS)[number];
-/** The crests. */
-export declare const CREST_IDS: readonly [];
+/** The generic crests: tinted by a team's colours, with the team's letters on them when it has any. */
+export declare const CREST_SHAPES: readonly ["shield", "roundel", "diamond", "pennant"];
+export type CrestShape = (typeof CREST_SHAPES)[number];
+export declare const CREST_IDS: readonly ["crest:shield", "crest:roundel", "crest:diamond", "crest:pennant"];
 export type CrestId = (typeof CREST_IDS)[number];
-/** The balls. */
-export declare const BALL_IDS: readonly ["ball:soccer"];
+/** The balls: one for each ball and implement the sports use, in 3D, with the official size it comes from. The balls of one family (the three crickets, the five squash balls) share a module. */
+export declare const BALL_IDS: readonly ["ball:soccer", "ball:soccer-colour", "ball:teqball", "ball:basketball", "ball:basketball-6", "ball:basketball-3x3", "ball:baseball", "ball:softball", "ball:tennis", "ball:padel", "ball:sliotar", "ball:volleyball", "ball:volleyball-8", "ball:beach-volleyball", "ball:cricket-red", "ball:cricket-white", "ball:cricket-pink", "ball:football", "ball:football-cfl", "ball:football-ifaf", "ball:rugby", "ball:afl", "ball:gaelic-football", "ball:netball", "ball:pickleball-outdoor", "ball:pickleball-indoor", "ball:squash", "ball:squash-yellow", "ball:squash-green", "ball:squash-red", "ball:squash-blue", "ball:racquetball", "ball:lacrosse", "ball:field-hockey", "ball:table-tennis", "ball:handball", "ball:water-polo", "ball:golf", "ball:puck", "ball:curling-stone", "ball:shot", "ball:discus", "ball:hammer", "ball:sepak-takraw", "ball:roundnet", "ball:shuttlecock-feather", "ball:shuttlecock-nylon"];
 export type BallId = (typeof BALL_IDS)[number];
-/** The pieces of gear. */
-export declare const GEAR_IDS: readonly [];
+/** The pieces of gear: a piece of equipment for each sport, flat, drawn here or copied from open icon sets (NOTICE.md says which). */
+export declare const GEAR_IDS: readonly ["gear:hockey-stick", "gear:goalie-stick", "gear:hockey-skate", "gear:goalie-mask", "gear:goal-net", "gear:field-hockey-stick", "gear:lacrosse-stick", "gear:cricket-bat", "gear:wicket", "gear:table-tennis-paddle", "gear:badminton-racket", "gear:tennis-racket", "gear:squash-racket", "gear:racquetball-racket", "gear:padel-racket", "gear:pickleball-paddle", "gear:roundnet-set", "gear:volleyball-net", "gear:basketball-hoop", "gear:baseball-bat", "gear:baseball-glove", "gear:football-helmet", "gear:goalposts", "gear:hurley", "gear:curling-broom", "gear:figure-skate", "gear:speed-skate", "gear:diving-board", "gear:swim-goggles", "gear:starting-blocks", "gear:relay-baton", "gear:javelin", "gear:hurdles"];
 export type GearId = (typeof GEAR_IDS)[number];
-/** The sports' own emblems. */
-export declare const SPORT_IDS: readonly [];
-export type SportEmblemId = (typeof SPORT_IDS)[number];
+/** The sports' own emblems: one pictogram for each of the thirty-three. */
+export type SportEmblemId = `sport:${SportName}`;
+export declare const SPORT_IDS: readonly SportEmblemId[];
 /** Every emblem id. */
 export type EmblemId = AwardId | TrophyId | MedalId | CrestId | BallId | GearId | SportEmblemId;
 /** The groups of ids, in the order a gallery shows them. */
 export declare const EMBLEM_GROUPS: {
-    readonly award: readonly ["award:medal"];
-    readonly trophy: readonly [];
-    readonly medal: readonly [];
-    readonly crest: readonly [];
-    readonly ball: readonly ["ball:soccer"];
-    readonly gear: readonly [];
-    readonly sport: readonly [];
+    readonly award: readonly ["award:medal", "award:badge", "award:crown", "award:star", "award:shield"];
+    readonly trophy: readonly ["trophy:cup", "trophy:lidded-cup", "trophy:bowl", "trophy:salver", "trophy:globe", "trophy:hockey-cup", "trophy:basketball", "trophy:baseball", "trophy:football", "trophy:canadian-bowl", "trophy:soccer-ball", "trophy:soccer-globe", "trophy:tennis-plate", "trophy:tennis-cup", "trophy:cricket-urn", "trophy:rugby-cup", "trophy:plaque", "trophy:belt", "trophy:laurel", "trophy:rosette"];
+    readonly medal: readonly ["medal:gold", "medal:silver", "medal:bronze", "medal:place-1", "medal:place-2", "medal:place-3"];
+    readonly crest: readonly ["crest:shield", "crest:roundel", "crest:diamond", "crest:pennant"];
+    readonly ball: readonly ["ball:soccer", "ball:soccer-colour", "ball:teqball", "ball:basketball", "ball:basketball-6", "ball:basketball-3x3", "ball:baseball", "ball:softball", "ball:tennis", "ball:padel", "ball:sliotar", "ball:volleyball", "ball:volleyball-8", "ball:beach-volleyball", "ball:cricket-red", "ball:cricket-white", "ball:cricket-pink", "ball:football", "ball:football-cfl", "ball:football-ifaf", "ball:rugby", "ball:afl", "ball:gaelic-football", "ball:netball", "ball:pickleball-outdoor", "ball:pickleball-indoor", "ball:squash", "ball:squash-yellow", "ball:squash-green", "ball:squash-red", "ball:squash-blue", "ball:racquetball", "ball:lacrosse", "ball:field-hockey", "ball:table-tennis", "ball:handball", "ball:water-polo", "ball:golf", "ball:puck", "ball:curling-stone", "ball:shot", "ball:discus", "ball:hammer", "ball:sepak-takraw", "ball:roundnet", "ball:shuttlecock-feather", "ball:shuttlecock-nylon"];
+    readonly gear: readonly ["gear:hockey-stick", "gear:goalie-stick", "gear:hockey-skate", "gear:goalie-mask", "gear:goal-net", "gear:field-hockey-stick", "gear:lacrosse-stick", "gear:cricket-bat", "gear:wicket", "gear:table-tennis-paddle", "gear:badminton-racket", "gear:tennis-racket", "gear:squash-racket", "gear:racquetball-racket", "gear:padel-racket", "gear:pickleball-paddle", "gear:roundnet-set", "gear:volleyball-net", "gear:basketball-hoop", "gear:baseball-bat", "gear:baseball-glove", "gear:football-helmet", "gear:goalposts", "gear:hurley", "gear:curling-broom", "gear:figure-skate", "gear:speed-skate", "gear:diving-board", "gear:swim-goggles", "gear:starting-blocks", "gear:relay-baton", "gear:javelin", "gear:hurdles"];
+    readonly sport: readonly ("sport:nfl" | "sport:cfl" | "sport:ifaf" | "sport:nhl" | "sport:nba" | "sport:mlb" | "sport:soccer" | "sport:curling" | "sport:tennis" | "sport:volleyball" | "sport:badminton" | "sport:pickleball" | "sport:tabletennis" | "sport:padel" | "sport:squash" | "sport:racquetball" | "sport:sepaktakraw" | "sport:teqball" | "sport:roundnet" | "sport:netball" | "sport:swimming" | "sport:waterpolo" | "sport:diving" | "sport:artisticswimming" | "sport:lacrosse" | "sport:rugby" | "sport:afl" | "sport:gaelic" | "sport:cricket" | "sport:fieldhockey" | "sport:handball" | "sport:athletics" | "sport:skating")[];
 };
 export type EmblemGroup = keyof typeof EMBLEM_GROUPS;
 /** Every id, in group order. */
 export declare const EMBLEM_IDS: readonly EmblemId[];
-/** The folder under `src/emblems/` that holds a group's art, one module per item named by the id's last part: `ball:soccer` is `ball/soccer.ts`. Trophies, medals, crests and sports share the award folder. */
+/** The folder under `src/emblems/` that holds a group's art, one module per item named by the id's last part: `trophy:hockey-cup` is `trophy/hockey-cup.ts`, `ball:soccer` is `ball/soccer.ts`. Each group has a folder of its own, so no two ids share a file name. */
 export declare const EMBLEM_FOLDERS: {
     readonly award: "award";
-    readonly trophy: "award";
-    readonly medal: "award";
-    readonly crest: "award";
+    readonly trophy: "trophy";
+    readonly medal: "medal";
+    readonly crest: "crest";
     readonly ball: "ball";
     readonly gear: "gear";
-    readonly sport: "award";
+    readonly sport: "sport";
 };
+/** The short names of the trophies and awards that stand for a full id: `"cup"` is `"trophy:cup"` and `"crown"` is `"award:crown"`. */
+export declare const EMBLEM_ALIASES: Readonly<Record<string, EmblemId>>;

package/dist/emblems/emblem.ids.js

@@ -5,20 +5,37 @@ export const SPORT_NAMES = [
     "nfl", "cfl", "ifaf", "nhl", "nba", "mlb", "soccer", "curling", "tennis", "volleyball", "badminton", "pickleball", "tabletennis", "padel", "squash", "racquetball", "sepaktakraw", "teqball", "roundnet", "netball",
     "swimming", "waterpolo", "diving", "artisticswimming", "lacrosse", "rugby", "afl", "gaelic", "cricket", "fieldhockey", "handball", "athletics", "skating",
 ];
-/** The awards: a medal on a ribbon, and the rest as they arrive. */
-export const AWARD_IDS = ["award:medal"];
-/** The trophies. */
-export const TROPHY_IDS = [];
-/** The medals by place. */
-export const MEDAL_IDS = [];
-/** The crests. */
-export const CREST_IDS = [];
-/** The balls. */
-export const BALL_IDS = ["ball:soccer"];
-/** The pieces of gear. */
-export const GEAR_IDS = [];
-/** The sports' own emblems. */
-export const SPORT_IDS = [];
+/** The awards, drawn from Material Symbols: a medal on a ribbon, a badge, a crown, a star and a shield. */
+export const AWARD_IDS = ["award:medal", "award:badge", "award:crown", "award:star", "award:shield"];
+/** The trophies: a cup for each league's champion in a descriptive, generic form, the plain cups and dishes, and the flat plaque, belt, wreath and rosette. */
+export const TROPHY_IDS = [
+    "trophy:cup", "trophy:lidded-cup", "trophy:bowl", "trophy:salver", "trophy:globe",
+    "trophy:hockey-cup", "trophy:basketball", "trophy:baseball", "trophy:football", "trophy:canadian-bowl", "trophy:soccer-ball", "trophy:soccer-globe",
+    "trophy:tennis-plate", "trophy:tennis-cup", "trophy:cricket-urn", "trophy:rugby-cup",
+    "trophy:plaque", "trophy:belt", "trophy:laurel", "trophy:rosette",
+];
+/** The medals on a ribbon, and the badges for the first three places. */
+export const MEDAL_KINDS = ["gold", "silver", "bronze"];
+export const MEDAL_IDS = ["medal:gold", "medal:silver", "medal:bronze", "medal:place-1", "medal:place-2", "medal:place-3"];
+/** The generic crests: tinted by a team's colours, with the team's letters on them when it has any. */
+export const CREST_SHAPES = ["shield", "roundel", "diamond", "pennant"];
+export const CREST_IDS = ["crest:shield", "crest:roundel", "crest:diamond", "crest:pennant"];
+/** The balls: one for each ball and implement the sports use, in 3D, with the official size it comes from. The balls of one family (the three crickets, the five squash balls) share a module. */
+export const BALL_IDS = [
+    "ball:soccer", "ball:soccer-colour", "ball:teqball", "ball:basketball", "ball:basketball-6", "ball:basketball-3x3", "ball:baseball", "ball:softball", "ball:tennis", "ball:padel",
+    "ball:sliotar", "ball:volleyball", "ball:volleyball-8", "ball:beach-volleyball", "ball:cricket-red", "ball:cricket-white", "ball:cricket-pink", "ball:football", "ball:football-cfl",
+    "ball:football-ifaf", "ball:rugby", "ball:afl", "ball:gaelic-football", "ball:netball", "ball:pickleball-outdoor", "ball:pickleball-indoor", "ball:squash", "ball:squash-yellow",
+    "ball:squash-green", "ball:squash-red", "ball:squash-blue", "ball:racquetball", "ball:lacrosse", "ball:field-hockey", "ball:table-tennis", "ball:handball", "ball:water-polo", "ball:golf",
+    "ball:puck", "ball:curling-stone", "ball:shot", "ball:discus", "ball:hammer", "ball:sepak-takraw", "ball:roundnet", "ball:shuttlecock-feather", "ball:shuttlecock-nylon"
+];
+/** The pieces of gear: a piece of equipment for each sport, flat, drawn here or copied from open icon sets (NOTICE.md says which). */
+export const GEAR_IDS = [
+    "gear:hockey-stick", "gear:goalie-stick", "gear:hockey-skate", "gear:goalie-mask", "gear:goal-net", "gear:field-hockey-stick", "gear:lacrosse-stick", "gear:cricket-bat", "gear:wicket",
+    "gear:table-tennis-paddle", "gear:badminton-racket", "gear:tennis-racket", "gear:squash-racket", "gear:racquetball-racket", "gear:padel-racket", "gear:pickleball-paddle",
+    "gear:roundnet-set", "gear:volleyball-net", "gear:basketball-hoop", "gear:baseball-bat", "gear:baseball-glove", "gear:football-helmet", "gear:goalposts", "gear:hurley",
+    "gear:curling-broom", "gear:figure-skate", "gear:speed-skate", "gear:diving-board", "gear:swim-goggles", "gear:starting-blocks", "gear:relay-baton", "gear:javelin", "gear:hurdles"
+];
+export const SPORT_IDS = SPORT_NAMES.map((name) => `sport:${name}`);
 /** The groups of ids, in the order a gallery shows them. */
 export const EMBLEM_GROUPS = {
     award: AWARD_IDS,
@@ -31,5 +48,7 @@ export const EMBLEM_GROUPS = {
 };
 /** Every id, in group order. */
 export const EMBLEM_IDS = Object.values(EMBLEM_GROUPS).flat();
-/** The folder under `src/emblems/` that holds a group's art, one module per item named by the id's last part: `ball:soccer` is `ball/soccer.ts`. Trophies, medals, crests and sports share the award folder. */
-export const EMBLEM_FOLDERS = { award: "award", trophy: "award", medal: "award", crest: "award", ball: "ball", gear: "gear", sport: "award" };
+/** The folder under `src/emblems/` that holds a group's art, one module per item named by the id's last part: `trophy:hockey-cup` is `trophy/hockey-cup.ts`, `ball:soccer` is `ball/soccer.ts`. Each group has a folder of its own, so no two ids share a file name. */
+export const EMBLEM_FOLDERS = { award: "award", trophy: "trophy", medal: "medal", crest: "crest", ball: "ball", gear: "gear", sport: "sport" };
+/** The short names of the trophies and awards that stand for a full id: `"cup"` is `"trophy:cup"` and `"crown"` is `"award:crown"`. */
+export const EMBLEM_ALIASES = Object.fromEntries([...TROPHY_IDS, ...AWARD_IDS].map((id) => [id.slice(id.indexOf(":") + 1), id]));

package/dist/emblems/emblem.lathe.d.ts

@@ -0,0 +1,59 @@
+import { type Emblem, type EmblemSource, type Metal } from "./emblem.core.ts";
+/** A point of the profile: the height `y` (0 at the top of the 64 unit box), the radius `r` from the axis (x = 32), 1 for a sharp corner (a smooth run of points ends at one), and the tone of the piece that starts here. */
+export type Pt = readonly [y: number, r: number, corner?: 0 | 1, tone?: string];
+/** Something drawn on the surface, by height and angle (90 degrees is the right side, 0 faces the eye): a `ring` round the body at a height; `mer`idians from one height to another; `helix` strands that wind `turns` times; a diamond `net`; `dots` (beads) round at a height with a size; on an open top, a `disc` of a tone out to a radius and `pills`, short rounded marks, round a radius. */
+export type Decor = readonly ["ring", y: number] | readonly ["mer", y0: number, y1: number, n: number, off?: number] | readonly ["helix", y0: number, y1: number, n: number, turns: number] | readonly ["net", y0: number, y1: number, n: number] | readonly ["dots", y: number, n: number, size: number, off?: number] | readonly ["disc", rho: number, tone: string] | readonly ["pills", rho: number, n: number, length: number, width: number, tone: string];
+/** One solid of revolution: a profile from the top down, whether its top is an open rim, how many flat sides it has (none: round) and what is drawn on it. */
+export interface Solid {
+    p: readonly Pt[];
+    open?: boolean;
+    sides?: number;
+    tone?: string;
+    decor?: readonly Decor[];
+}
+/** A handle: a curve through points `[r, y]` (the distance from the axis and the height) in the plane of the azimuth `a`, drawn as a tube `w` thick. The handle of the other side is `a + 180`. */
+export interface Handle {
+    a: number;
+    pts: readonly (readonly [r: number, y: number])[];
+    w?: number;
+    tone?: string;
+}
+export type BallKind = "plain" | "basket" | "soccer" | "base" | "globe" | "football" | "pine";
+/** A ball on the body: `cy` its centre, `r` its radius (and `ry` when it is longer than it is wide), `rot` the lean of a football in degrees. */
+export interface Ball {
+    kind: BallKind;
+    cx?: number;
+    cy: number;
+    r: number;
+    ry?: number;
+    rot?: number;
+    tone?: string;
+}
+/** A ring of `n` poles that stand from a ring of radius `r0` at `y0` up to a ring of radius `r1`, their tops stepping from the height `top1` down to `top2` once round, each with a pennant `size` tall. */
+export interface Poles {
+    n: number;
+    y0: number;
+    r0: number;
+    r1: number;
+    top1: number;
+    top2: number;
+    size: number;
+}
+/** What a body of revolution is made of. All of it is in the 64 by 64 box with the axis at x = 32. */
+export interface LatheModel {
+    metal: Metal;
+    /** The main colour when the caller gives no tint and the metal is `flat` (the clay of an urn). */
+    color?: string;
+    /** The colours of the other tones the profile names (`gilt`, `dark`, `green`...). The `accent` option replaces the tone named `accent`. */
+    tones?: Readonly<Record<string, string>>;
+    /** The elevation of the eye in degrees at rest: how much of the top of a rim shows. */
+    tilt?: number;
+    solids: readonly Solid[];
+    handles?: readonly Handle[];
+    balls?: readonly Ball[];
+    poles?: Poles;
+}
+/** The radius of the body at a height. */
+export declare function radiusAt(profile: readonly Pt[], y: number): number;
+/** A lathe emblem: the object with its names and its model, the still drawing and the turned one. */
+export declare function defineLathe(id: string, en: string, ja: string, source: EmblemSource, model: LatheModel): Emblem<LatheModel>;