@johnmorrisdotca/taisen-brackets 0.2.1 → 0.4.0

package/dist/types.d.ts

@@ -25,6 +25,11 @@ export interface Team {
     names?: Readonly<Record<string, string>>;
     /** An ISO 3166 region code (`DE`), for `countryName` and a `teamName` that uses it. */
     region?: string;
+    /**
+     * A country code (`ca`, `GB-ENG`) for a round flag drawn by the `flags` option's renderer (`@johnmorrisdotca/hata` has one). With no
+     * renderer, or one that has no flag for the code, the team's `mark` is drawn, or its initials: it never throws.
+     */
+    flag?: string;
 }
 /** One game of a tie: a match of a knockout, a game of a series, a leg of an aggregate, a replay. */
 export interface Game {
@@ -259,6 +264,33 @@ export interface Words {
     columnDate: string;
     /** The `<title>` of a drawing with no `title` option. */
     title: string;
+    /** The road-to-the-final chart (`roadToFinal`): its title, the "v" between two finalists, the group stage, FT, AET, `{a}`, `{b}` the shoot-out, and the results. */
+    roadTitle: string;
+    roadVs: string;
+    roadGroup: string;
+    roadFt: string;
+    roadAet: string;
+    roadPens: string;
+    roadWon: string;
+    roadLost: string;
+    roadDrew: string;
+    /** The names of the two rounds a road names one match of (the other rounds come from the round names of the language). */
+    roadQuarterFinal: string;
+    roadSemiFinal: string;
+    /** The road's table: the headings, the caption (`{a}`, `{b}`), the chart's name (`{a}`, `{b}`, `{title}`), the summary (`{a}`, `{b}`, `{an}`, `{bn}`) and its sentences. */
+    roadTableTeam: string;
+    roadTableOpponent: string;
+    roadTableScore: string;
+    roadTableDecided: string;
+    roadTableResult: string;
+    roadCaption: string;
+    roadName: string;
+    roadSummary: string;
+    /** `{a}`, `{b}`, `{score}`, `{how}`. */
+    roadFinal: string;
+    /** `{name}`. */
+    roadChampion: string;
+    roadToPlay: string;
 }
 /** A language: its words, the names of the rounds (by their English names), and the tag `Intl` formats numbers and dates for. */
 export interface Locale {
@@ -270,7 +302,7 @@ export interface Locale {
     rounds: Readonly<Record<string, string>>;
 }
 export type ThemeName = "auto" | "light" | "dark" | "poster" | "none";
-export type SizeName = "wide" | "square" | "phone";
+export type SizeName = "wide" | "square" | "phone" | "card";
 export interface Size {
     /** The width of the drawing, in pixels. */
     width: number;
@@ -279,8 +311,40 @@ export interface Size {
 }
 /** How much a box shows: both names and scores, an abbreviation and the score, or only the marks. */
 export type Detail = "auto" | "full" | "compact" | "mark";
+/** How a flag is framed: `round` in a circle, `square`, or `rect` in its own proportions. */
+export type FlagShape = "round" | "square" | "rect";
+/** What a drawing asks a `flags` renderer for. */
+export interface FlagRequest {
+    shape: FlagShape;
+    /** Width and height in pixels (the diameter, for a round flag). */
+    size: number;
+    /** `light` or `dark` for a drawing in that look (`poster` is dark); `inherit` for `auto` and `none`. */
+    theme: "inherit" | "light" | "dark";
+}
+/**
+ * A function from a country code and a request to an SVG string, or `null` or `undefined` for a code it has no flag for. It must be
+ * synchronous: a drawing is a pure function of its options. `@johnmorrisdotca/hata`'s `flag()` is asynchronous, so load the flags first
+ * (`await flag(code, { shape: "round" })` for each code) and pass `(code) => loaded[code]`.
+ */
+export type FlagRenderer = (code: string, request: FlagRequest) => string | null | undefined;
+/** How a bracket is drawn: `classic` (the default) or `road`, with large round marks, big scores and a dotted path. */
+export type Look = "classic" | "road";
+/** How an emblem is drawn; the names are those of `@johnmorrisdotca/dougu-sports`. */
+export type EmblemStyle = "metal" | "line" | "color";
+/** What `drawBracket` asks an `emblems` renderer for. */
+export interface EmblemRequest {
+    style: EmblemStyle;
+    /** Width and height in pixels. */
+    size: number;
+    /** The colour of the main part, when `emblemTint` is set. */
+    tint?: string;
+    /** `light` or `dark` for a bracket in that look (`poster` is dark); `inherit` for `auto` and `none`, where the drawing's stylesheet or the page sets the ink. */
+    theme: "inherit" | "light" | "dark";
+}
+/** A function from an emblem id and a request to an SVG string; `renderEmblem` of `@johnmorrisdotca/dougu-sports/emblems` is one. */
+export type EmblemRenderer = (id: string, options: EmblemRequest) => string;
 export interface DrawOptions extends LayoutOptions {
-    /** `wide` 1200 by 675, `square` 1080 by 1080, `phone` 390 wide and as tall as it needs; or a size of your own. Default `wide`. */
+    /** `wide` 1200 by 675, `square` 1080 by 1080, `card` 1080 by 1350 (a tall post), `phone` 390 wide and as tall as it needs; or a size of your own. Default `wide`. */
     size?: SizeName | {
         width: number;
         height?: number | null;
@@ -310,8 +374,39 @@ export interface DrawOptions extends LayoutOptions {
     markShape?: "round" | "square" | "none";
     /** Show the champion in the centre once the final is played. Default true. */
     champion?: boolean;
-    /** A trophy for the centre: inline SVG or an image address. Drawn above the champion. */
+    /**
+     * A trophy for the centre, drawn above the champion: inline SVG, an image address, or (with `emblems`) an emblem id such as
+     * `"trophy:hockey-cup"`. An emblem id with no `emblems` renderer draws nothing and takes no room.
+     */
     trophy?: string;
+    /**
+     * Draws the emblem a `trophy` id names: any function from an id and a request to an SVG string, such as `renderEmblem` from
+     * `@johnmorrisdotca/dougu-sports/emblems`. Called once per champion, with the size the trophy has in the drawing. Its SVG is cleaned
+     * like any inline SVG; a renderer that throws, or returns something that is not an `<svg>`, draws no trophy.
+     */
+    emblems?: EmblemRenderer;
+    /** The style an emblem is drawn in: `metal` (the default), `line` or `color`. */
+    emblemStyle?: EmblemStyle;
+    /** A colour for the emblem's main part (a hex colour or `rgb()`), passed to the renderer as `tint`. */
+    emblemTint?: string;
+    /**
+     * Draws the flag a team's `flag` code names: a synchronous function from a code and `{ shape, size, theme }` to an SVG string, such as one
+     * made from `@johnmorrisdotca/hata`. With none, or when it returns nothing for a code, the team's `mark` or its initials are drawn.
+     */
+    flags?: FlagRenderer;
+    /**
+     * `classic` (the default) or `road`: the look of the road-to-the-final chart, with large round marks, big bold scores, the loser quiet, the
+     * rounds named on pills and a dotted path. Every other option works in both.
+     */
+    look?: Look;
+    /**
+     * A link for each tie's box, from the tie and, for a link on one team's row, its side (0 or 1). Called with the tie alone first: an address
+     * makes the whole box a link; when that gives none, each side is asked, and a row with an address is a link of its own. Each is a real
+     * `<a href>` in the SVG with an accessible name; an address that is not http(s), relative or a `#` fragment is refused. `undefined` is no link.
+     */
+    href?: (tie: Tie, side?: 0 | 1) => string | null | undefined;
+    /** The id of a team whose path to the final is drawn as a dotted line in the look's highlight, the rest quieter. */
+    highlightPath?: SideId;
     /** Where the third-place match goes: `below` the final (the default) or `hide`. */
     thirdPlace?: "below" | "hide";
     /** Highlight the side that went through. Default true. */

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.4.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.2.1";
+export const VERSION = "0.4.0";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@johnmorrisdotca/taisen-brackets",
-  "version": "0.2.1",
-  "description": "Taisen Brackets 対戦, knockout brackets as SVG: from a list of ties (games, best-of series, two legs, replays, byes, a third-place match) it works out the rounds and halves and draws the bracket with the halves meeting at the final, or left to right, wide, square or for a phone, in light, dark or a gold-on-navy poster look, with each team's logo or round flag, the champion in the centre, and an accessible table. NHL, NBA, MLB, NFL, CFL, MLS and World Cup formats by era, in English, French, Japanese, Spanish and German. Zero dependencies.",
+  "version": "0.4.0",
+  "description": "Taisen Brackets 対戦, knockout brackets as SVG: from a list of ties (games, best-of series, two legs, replays, byes, a third-place match) it works out the rounds and halves and draws the bracket with the halves meeting at the final, or left to right, wide, square, as a tall card or for a phone, in a classic or a road look (large round flags, big scores, a team's dotted path, a link on every box), in light, dark or a gold-on-navy poster look, with each team's logo or round flag, the champion in the centre, and an accessible table; and the road to the final of either finalist. NHL, NBA, MLB, NFL, CFL, MLS and World Cup formats by era, in English, French, Japanese, Spanish and German. Zero dependencies.",
   "keywords": [
     "bracket",
     "tournament",
@@ -62,6 +62,11 @@
       "types": "./dist/presets-entry.d.ts",
       "import": "./dist/presets-entry.js",
       "default": "./dist/presets-entry.js"
+    },
+    "./road": {
+      "types": "./dist/road-entry.d.ts",
+      "import": "./dist/road-entry.js",
+      "default": "./dist/road-entry.js"
     }
   },
   "files": [
@@ -90,8 +95,21 @@
     "test:demo": "pnpm site && playwright test",
     "screenshots": "pnpm site && node scripts/screenshots.mjs"
   },
+  "peerDependencies": {
+    "@johnmorrisdotca/dougu-sports": ">=0.1.0 <1",
+    "@johnmorrisdotca/hata": ">=1.5.0 <2"
+  },
+  "peerDependenciesMeta": {
+    "@johnmorrisdotca/dougu-sports": {
+      "optional": true
+    },
+    "@johnmorrisdotca/hata": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@eslint/js": "^9.0.0",
+    "@johnmorrisdotca/dougu-sports": "0.1.0",
     "@johnmorrisdotca/hata": "1.5.0",
     "@playwright/test": "^1.63.0",
     "@types/node": "^24.0.0",