@johnmorrisdotca/dougu-sports 0.28.1 → 0.30.0

package/dist/emblems/ball/ball.baseball.vintage.js

@@ -7,7 +7,14 @@ import { seamedBall } from "./ball.family.seamed.js";
 import { gores } from "./ball.tilings.js";
 import { BALL_BASEBALL } from "./ball.baseball.js";
 const SIZE = BALL_BASEBALL.size;
-/** The 1850s and 1860s: a cover of four pieces sewn along four seams that run from one point to the opposite one, like the peel of a lemon, in aged leather with a dark thread. No rule fixed the ball then, so it is drawn at the size of today's. */
+/**
+ * The 1850s and 1860s: a cover of four pieces sewn along four seams that run from one point to the opposite one, like the peel of a lemon, in aged leather with a dark thread. No rule fixed the ball then, so it is drawn at the size of today's.
+ * @example
+ * ```ts
+ * import { BALL_BASEBALL_LEMON_PEEL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASEBALL_LEMON_PEEL.id, BALL_BASEBALL_LEMON_PEEL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASEBALL_LEMON_PEEL = /* @__PURE__ */ defineBall({
     id: "ball:baseball-lemon-peel",
     en: "Baseball, lemon-peel",
@@ -32,11 +39,32 @@ export const BALL_BASEBALL_LEMON_PEEL = /* @__PURE__ */ defineBall({
 const STITCH = { count: 108, half: 0.075, width: 0.85, lean: 0.032 };
 const WHITE = "#f4f0e6";
 const common = { size: SIZE, base: WHITE, b: 0.4, view: { yaw: 18, pitch: 28, roll: -10 }, mat: { gloss: 0.3, shade: "#4a3a2a", grain: { f: 1.4, a: 0.12 } }, groove: "#8a7a62" };
-/** The figure-8 seam stitched with alternate red and blue stitches (the American League's laces, in the recollection of a 1930s player). */
+/**
+ * The figure-8 seam stitched with alternate red and blue stitches (the American League's laces, in the recollection of a 1930s player).
+ * @example
+ * ```ts
+ * import { BALL_BASEBALL_RED_BLUE } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASEBALL_RED_BLUE.id, BALL_BASEBALL_RED_BLUE.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASEBALL_RED_BLUE = /* @__PURE__ */ seamedBall({ ...common, id: "ball:baseball-red-blue", en: "Baseball, red and blue", ja: "赤青の縫い糸の野球ボール", stitch: { ...STITCH, colour: "#c4262e", colour2: "#2257a8" } });
-/** The figure-8 seam stitched with alternate black and red stitches (the National League's laces, in the same recollection). */
+/**
+ * The figure-8 seam stitched with alternate black and red stitches (the National League's laces, in the same recollection).
+ * @example
+ * ```ts
+ * import { BALL_BASEBALL_BLACK_RED } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASEBALL_BLACK_RED.id, BALL_BASEBALL_BLACK_RED.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASEBALL_BLACK_RED = /* @__PURE__ */ seamedBall({ ...common, id: "ball:baseball-black-red", en: "Baseball, black and red", ja: "黒赤の縫い糸の野球ボール", stitch: { ...STITCH, colour: "#c4262e", colour2: "#1d1d20" } });
-/** An old ball: the leather gone the colour of tea and scuffed, the red thread faded. */
+/**
+ * An old ball: the leather gone the colour of tea and scuffed, the red thread faded.
+ * @example
+ * ```ts
+ * import { BALL_BASEBALL_VINTAGE_LEATHER } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASEBALL_VINTAGE_LEATHER.id, BALL_BASEBALL_VINTAGE_LEATHER.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASEBALL_VINTAGE_LEATHER = /* @__PURE__ */ seamedBall({
     ...common,
     id: "ball:baseball-vintage-leather",
@@ -48,7 +76,14 @@ export const BALL_BASEBALL_VINTAGE_LEATHER = /* @__PURE__ */ seamedBall({
     stitch: { ...STITCH, colour: "#a23a2c" },
     wear: { dark: 16, pale: 8, seed: 6 },
 });
-/** The optic yellow 11 inch softball: 27.9 cm (circumference 27.6 to 28.3 cm, 166.5 to 173.6 g), red stitch, as the WBSC's Slow Pitch rules set it for women and girls. */
+/**
+ * The optic yellow 11 inch softball: 27.9 cm (circumference 27.6 to 28.3 cm, 166.5 to 173.6 g), red stitch, as the WBSC's Slow Pitch rules set it for women and girls.
+ * @example
+ * ```ts
+ * import { BALL_SOFTBALL_11_OPTIC } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_SOFTBALL_11_OPTIC.id, BALL_SOFTBALL_11_OPTIC.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_SOFTBALL_11_OPTIC = /* @__PURE__ */ seamedBall({
     id: "ball:softball-11-optic",
     en: "Softball, 11 in, optic",

package/dist/emblems/ball/ball.basketball.d.ts

@@ -4,4 +4,12 @@ import type { V3 } from "./ball.math.ts";
 export declare const basketballChannel: (sign: 1 | -1, n?: number) => V3[];
 /** The spec of a basketball: its colour, and the colour of its lower half for a two-tone ball. */
 export declare function basketballSpec(base: string, lower?: string): BallSpec;
+/**
+ * The Basketball emblem (バスケットボール in Japanese): id `ball:basketball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL.id, BALL_BASKETBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_BASKETBALL: import("./ball.core.ts").Piece<BallSpec>;

package/dist/emblems/ball/ball.basketball.js

@@ -29,4 +29,12 @@ export function basketballSpec(base, lower) {
     };
 }
 const SIZE7 = { extentMm: 241.9, diameterMm: 241.9, circumferenceMm: 760.0, massG: [580, 620], rule: "FIBA Basketball Equipment 2026, Rule 2 Basketballs, 2.4 and Table 1 (size 7 = men's competitions)", note: "Diameter worked out from the middle of the circumference range." };
+/**
+ * The Basketball emblem (バスケットボール in Japanese): id `ball:basketball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL.id, BALL_BASKETBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASKETBALL = /* @__PURE__ */ defineBall({ id: "ball:basketball", en: "Basketball", ja: "バスケットボール", size: SIZE7, spec: basketballSpec("#e0701f") });

package/dist/emblems/ball/ball.basketball3x3.d.ts

@@ -1 +1,9 @@
+/**
+ * The Basketball, 3x3 emblem (3x3バスケットボール in Japanese): id `ball:basketball-3x3`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL_3X3 } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL_3X3.id, BALL_BASKETBALL_3X3.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_BASKETBALL_3X3: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.basketball3x3.js

@@ -1,6 +1,14 @@
 // The 3x3 basketball: two-tone, orange above and charcoal below, the size of a 6 and the weight of a 7. Our own two-tone scheme; the rules fix the size and the weight.
 import { defineBall } from "./ball.engine.js";
 import { basketballSpec } from "./ball.basketball.js";
+/**
+ * The Basketball, 3x3 emblem (3x3バスケットボール in Japanese): id `ball:basketball-3x3`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL_3X3 } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL_3X3.id, BALL_BASKETBALL_3X3.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASKETBALL_3X3 = /* @__PURE__ */ defineBall({
     id: "ball:basketball-3x3",
     en: "Basketball, 3x3",

package/dist/emblems/ball/ball.basketball6.d.ts

@@ -1 +1,9 @@
+/**
+ * The Basketball, size 6 emblem (バスケットボール6号球 in Japanese): id `ball:basketball-6`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL_6 } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL_6.id, BALL_BASKETBALL_6.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_BASKETBALL_6: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.basketball6.js

@@ -1,6 +1,14 @@
 // Basketball, size 6 (women's competitions): the same pattern a little smaller, here a shade lighter.
 import { defineBall } from "./ball.engine.js";
 import { basketballSpec } from "./ball.basketball.js";
+/**
+ * The Basketball, size 6 emblem (バスケットボール6号球 in Japanese): id `ball:basketball-6`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_BASKETBALL_6 } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_BASKETBALL_6.id, BALL_BASKETBALL_6.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_BASKETBALL_6 = /* @__PURE__ */ defineBall({
     id: "ball:basketball-6",
     en: "Basketball, size 6",

package/dist/emblems/ball/ball.core.d.ts

@@ -49,6 +49,12 @@ export type PrintRenderer = (s: Surface, p: PrintOptions | undefined, word: stri
 /**
  * The back number sewn on the back of a judogi (IJF Sport and Organisation Rules, C1.8): the competitor's family name and the three letters of the National Olympic Committee, on a white patch under a coloured band.
  * Only `gear:judogi-back` and `gear:judogi-blue-back` take it; anything else ignores it.
+ * @example
+ * ```ts
+ * import type { Backnumber } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const back: Backnumber = { name: "AOKI", code: "JPN", band: "gold" };
+ * console.log(back.name);
+ * ```
  */
 export interface Backnumber {
     /** The family name, in capitals: letters, digits, spaces, hyphens and apostrophes, 16 characters at most (accents are drawn as the plain letter). Without it the patch reads `TANAKA`. */
@@ -68,7 +74,16 @@ export interface BallFrameOptions extends PieceOptions {
 export type PieceSource = "generated" | "drawn";
 /** `ball` is turned in 3D; `gear` is a flat drawing in a metal, a colour and a line style, which flips like a coin when turned. */
 export type PieceKind = "ball" | "gear";
-/** The official size of a ball or an implement, from the rulebook that governs it. Lengths in millimetres, mass in grams. */
+/**
+ * The official size of a ball or an implement, from the rulebook that governs it. Lengths in millimetres, mass in grams.
+ * @example
+ * ```ts
+ * import { emblemInfo } from "@johnmorrisdotca/dougu-sports/emblems";
+ * import type { PieceSize } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const size: PieceSize | undefined = emblemInfo("ball:soccer").size;
+ * console.log(size?.diameterMm, size?.rule);
+ * ```
+ */
 export interface PieceSize {
     /** The largest extent of the drawing (a ball's diameter, a football's length), in millimetres: the scale `lineup` draws at. */
     extentMm: number;

package/dist/emblems/ball/ball.cricket.d.ts

@@ -1,5 +1,29 @@
 import type { Piece } from "./ball.core.ts";
 import type { BallSpec } from "./ball.engine.ts";
+/**
+ * The Cricket ball, red emblem (クリケットボール（赤） in Japanese): id `ball:cricket-red`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_RED } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_RED.id, BALL_CRICKET_RED.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_CRICKET_RED: Piece<BallSpec>;
+/**
+ * The Cricket ball, white emblem (クリケットボール（白） in Japanese): id `ball:cricket-white`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_WHITE } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_WHITE.id, BALL_CRICKET_WHITE.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_CRICKET_WHITE: Piece<BallSpec>;
+/**
+ * The Cricket ball, pink emblem (ピンクのクリケット球 in Japanese): id `ball:cricket-pink`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_PINK } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_PINK.id, BALL_CRICKET_PINK.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_CRICKET_PINK: Piece<BallSpec>;

package/dist/emblems/ball/ball.cricket.js

@@ -26,6 +26,30 @@ function cricket(id, en, ja, base, thread, size, shade) {
     });
 }
 const SIZE = { extentMm: 72.1, diameterMm: 72.1, circumferenceMm: 226.5, massG: [156, 163], rule: "Laws of Cricket, Law 4 The Ball, 4.1 Weight and size (Size 1, Size 2, Size 3)", note: "Size 1 (men's). Diameter worked out from the middle of the circumference range. The Laws do not set a colour." };
+/**
+ * The Cricket ball, red emblem (クリケットボール（赤） in Japanese): id `ball:cricket-red`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_RED } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_RED.id, BALL_CRICKET_RED.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_CRICKET_RED = /* @__PURE__ */ cricket("ball:cricket-red", "Cricket ball, red", "クリケットボール（赤）", "#a9161e", "#f2e8d2", SIZE, "#2a0408");
+/**
+ * The Cricket ball, white emblem (クリケットボール（白） in Japanese): id `ball:cricket-white`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_WHITE } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_WHITE.id, BALL_CRICKET_WHITE.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_CRICKET_WHITE = /* @__PURE__ */ cricket("ball:cricket-white", "Cricket ball, white", "クリケットボール（白）", "#f3f0e8", "#2a2a2a", SIZE, "#4a4a58");
+/**
+ * The Cricket ball, pink emblem (ピンクのクリケット球 in Japanese): id `ball:cricket-pink`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CRICKET_PINK } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CRICKET_PINK.id, BALL_CRICKET_PINK.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_CRICKET_PINK = /* @__PURE__ */ cricket("ball:cricket-pink", "Cricket ball, pink", "ピンクのクリケット球", "#e45a8c", "#2a2a2a", SIZE, "#4a0a22");

package/dist/emblems/ball/ball.curlingstone.d.ts

@@ -1,3 +1,11 @@
+/**
+ * The Curling stone emblem (カーリングストーン in Japanese): id `ball:curling-stone`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CURLING_STONE } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CURLING_STONE.id, BALL_CURLING_STONE.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_CURLING_STONE: import("./ball.core.ts").Piece<{
     slices: number;
 } & {

package/dist/emblems/ball/ball.curlingstone.js

@@ -11,6 +11,14 @@ const HANDLE = "#d4202c";
 // below are where the profile changes, as a fraction of H.
 const H = 114 / 290.9;
 const y = (t) => t * H;
+/**
+ * The Curling stone emblem (カーリングストーン in Japanese): id `ball:curling-stone`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_CURLING_STONE } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_CURLING_STONE.id, BALL_CURLING_STONE.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_CURLING_STONE = /* @__PURE__ */ defineObject({
     id: "ball:curling-stone",
     en: "Curling stone",

package/dist/emblems/ball/ball.discus.d.ts

@@ -1 +1,9 @@
+/**
+ * The Discus emblem (円盤 in Japanese): id `ball:discus`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_DISCUS } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_DISCUS.id, BALL_DISCUS.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_DISCUS: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.discus.js

@@ -1,6 +1,14 @@
 // Discus: a lens, thin at the rim, with a metal plate let into each face and a metal rim. Drawn as a flattened ellipsoid.
 import { defineBall } from "./ball.engine.js";
 import { greatCircle, smallCircle } from "./ball.math.js";
+/**
+ * The Discus emblem (円盤 in Japanese): id `ball:discus`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_DISCUS } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_DISCUS.id, BALL_DISCUS.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_DISCUS = /* @__PURE__ */ defineBall({
     id: "ball:discus",
     en: "Discus",

package/dist/emblems/ball/ball.face.d.ts

@@ -1,8 +1,32 @@
-/** The designs a face starts from. */
+/**
+ * The designs a face starts from.
+ * @example
+ * ```ts
+ * import type { PuckDesign } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const design: PuckDesign = "souvenir";
+ * console.log(design);
+ * ```
+ */
 export type PuckDesign = "canada" | "canada-red" | "canada-white" | "usa" | "usa-navy" | "player" | "souvenir";
-/** How a flag is framed: `round` in a circle, `square`, or `rect` in its own proportions (the puck asks for `rect`). */
+/**
+ * How a flag is framed: `round` in a circle, `square`, or `rect` in its own proportions (the puck asks for `rect`).
+ * @example
+ * ```ts
+ * import type { FlagShape } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const shape: FlagShape = "round";
+ * console.log(shape);
+ * ```
+ */
 export type FlagShape = "round" | "square" | "rect";
-/** What a drawing asks a `flags` renderer for: the shape, a width and height in pixels, and the look (`inherit` for a page whose ink is its own). */
+/**
+ * What a drawing asks a `flags` renderer for: the shape, a width and height in pixels, and the look (`inherit` for a page whose ink is its own).
+ * @example
+ * ```ts
+ * import type { FlagRequest } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const request: FlagRequest = { shape: "rect", size: 24, theme: "light" };
+ * console.log(request.shape);
+ * ```
+ */
 export interface FlagRequest {
     shape: FlagShape;
     size: number;
@@ -11,9 +35,23 @@ export interface FlagRequest {
 /**
  * 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: the same renderer taisen-brackets and kyogijo take, so one adapter over hata serves them
  * all. It must be synchronous (a drawing is a pure function of its options): hata's `flag()` is asynchronous, so load the flags first and pass `(code) => loaded[code]`. Pass it as the `flags` option of the call.
+ * @example
+ * ```ts
+ * import type { FlagRenderer } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const flags: FlagRenderer = (code, request) => (code === "ca" ? `<svg width="${request.size}" height="${request.size}"/>` : undefined);
+ * console.log(flags("ca", { shape: "round", size: 24, theme: "inherit" }));
+ * ```
  */
 export type FlagRenderer = (code: string, request: FlagRequest) => string | null | undefined;
-/** The colours of a face, by name. The array form is the same list in this order: field, ring, ink, accent, signature. */
+/**
+ * The colours of a face, by name. The array form is the same list in this order: field, ring, ink, accent, signature.
+ * @example
+ * ```ts
+ * import type { FaceColors } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const colors: FaceColors = { field: "#111111", ring: "#c4202e", ink: "#ffffff" };
+ * console.log(colors.field);
+ * ```
+ */
 export interface FaceColors {
     /** The disc's own colour. */
     field?: string;
@@ -29,6 +67,12 @@ export interface FaceColors {
 /**
  * The print on a puck's top face. Everything is optional, and what is not given comes from the design (the puck's own id says which, or `design`). Text is cleaned (no control characters, 24 letters a line) and
  * drawn in our own vector lettering, so any letter, digit or `- . , ' / : &` is available and any other character is left out.
+ * @example
+ * ```ts
+ * import type { PuckFace } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const face: PuckFace = { design: "souvenir", text: "CHAMPIONS", number: 9, colors: { field: "#111111" } };
+ * console.log(face.text);
+ * ```
  */
 export interface PuckFace {
     /** The design to start from. A puck with an id of its own already has one; `puck:souvenir` and `ball:puck` take it from here. */

package/dist/emblems/ball/ball.fieldhockey.d.ts

@@ -1 +1,9 @@
+/**
+ * The Field hockey ball emblem (フィールドホッケーボール in Japanese): id `ball:field-hockey`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FIELD_HOCKEY } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FIELD_HOCKEY.id, BALL_FIELD_HOCKEY.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_FIELD_HOCKEY: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.fieldhockey.js

@@ -1,5 +1,13 @@
 // Field hockey ball: a hard white plastic ball with dimples.
 import { dottedBall } from "./ball.family.dotted.js";
+/**
+ * The Field hockey ball emblem (フィールドホッケーボール in Japanese): id `ball:field-hockey`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FIELD_HOCKEY } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FIELD_HOCKEY.id, BALL_FIELD_HOCKEY.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_FIELD_HOCKEY = /* @__PURE__ */ dottedBall({
     id: "ball:field-hockey",
     en: "Field hockey ball",

package/dist/emblems/ball/ball.football.d.ts

@@ -1,3 +1,27 @@
+/**
+ * The Football (NFL) emblem (アメフトボール（NFL） in Japanese): id `ball:football`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL.id, BALL_FOOTBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_FOOTBALL: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;
+/**
+ * The Football (CFL) emblem (フットボール（CFL） in Japanese): id `ball:football-cfl`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL_CFL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL_CFL.id, BALL_FOOTBALL_CFL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_FOOTBALL_CFL: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;
+/**
+ * The Football (IFAF) emblem (アメフトボール（IFAF） in Japanese): id `ball:football-ifaf`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL_IFAF } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL_IFAF.id, BALL_FOOTBALL_IFAF.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_FOOTBALL_IFAF: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.football.js

@@ -48,6 +48,30 @@ function football(id, en, ja, size, shape, stripes, colour) {
 }
 const NFL_SHAPE = { width: 0.6044, point: 0.541 };
 const SIZE = { extentMm: 282.6, lengthMm: 282.6, circumferenceMm: 536.58, longCircumferenceMm: 717.55, massG: [396.89, 425.24], rule: "NFL Rulebook, Rule 2 The Ball, Section 1 (Dimensions)" };
+/**
+ * The Football (NFL) emblem (アメフトボール（NFL） in Japanese): id `ball:football`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL.id, BALL_FOOTBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_FOOTBALL = /* @__PURE__ */ football("ball:football", "Football (NFL)", "アメフトボール（NFL）", SIZE, NFL_SHAPE, "none", BROWN);
+/**
+ * The Football (CFL) emblem (フットボール（CFL） in Japanese): id `ball:football-cfl`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL_CFL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL_CFL.id, BALL_FOOTBALL_CFL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_FOOTBALL_CFL = /* @__PURE__ */ football("ball:football-cfl", "Football (CFL)", "フットボール（CFL）", { extentMm: 282.6, lengthMm: 282.6, circumferenceMm: 536.58, longCircumferenceMm: 717.55, massG: [396.89, 425.24], rule: "CFL Official Playing Rules, Rule 1 Conduct of the Game, Section 2 The Ball" }, NFL_SHAPE, "ring", BROWN);
+/**
+ * The Football (IFAF) emblem (アメフトボール（IFAF） in Japanese): id `ball:football-ifaf`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_FOOTBALL_IFAF } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_FOOTBALL_IFAF.id, BALL_FOOTBALL_IFAF.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_FOOTBALL_IFAF = /* @__PURE__ */ football("ball:football-ifaf", "Football (IFAF)", "アメフトボール（IFAF）", { extentMm: 283.4, lengthMm: 283.4, circumferenceMm: 533.4, longCircumferenceMm: 714.38, massG: [396.89, 425.24], rule: "IFAF Football Rules and Interpretations 2026, Rule 1 (The Game, Field, Players and Equipment), Section 3 The Ball, Article 1 a-i", note: "The IFAF figures are in a diagram of the rules, read from the rendered page." }, { width: 0.599, point: 0.567 }, "top", "#a8693a");

package/dist/emblems/ball/ball.gaelic.d.ts

@@ -1,2 +1,18 @@
+/**
+ * The Gaelic football emblem (ゲーリックフットボール in Japanese): id `ball:gaelic-football`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_GAELIC_FOOTBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_GAELIC_FOOTBALL.id, BALL_GAELIC_FOOTBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_GAELIC_FOOTBALL: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;
+/**
+ * The Netball emblem (ネットボール in Japanese): id `ball:netball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_NETBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_NETBALL.id, BALL_NETBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_NETBALL: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.gaelic.js

@@ -2,6 +2,14 @@
 // each face and the netball in orange and cream.
 import { defineBall } from "./ball.engine.js";
 import { strips18 } from "./ball.family.panelled.js";
+/**
+ * The Gaelic football emblem (ゲーリックフットボール in Japanese): id `ball:gaelic-football`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_GAELIC_FOOTBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_GAELIC_FOOTBALL.id, BALL_GAELIC_FOOTBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_GAELIC_FOOTBALL = /* @__PURE__ */ defineBall({
     id: "ball:gaelic-football",
     en: "Gaelic football",
@@ -15,6 +23,14 @@ export const BALL_GAELIC_FOOTBALL = /* @__PURE__ */ defineBall({
         draw: (s, base) => strips18(s, [["#f7f6f0", base]], "#5a6a60", 1.25),
     },
 });
+/**
+ * The Netball emblem (ネットボール in Japanese): id `ball:netball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_NETBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_NETBALL.id, BALL_NETBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_NETBALL = /* @__PURE__ */ defineBall({
     id: "ball:netball",
     en: "Netball",

package/dist/emblems/ball/ball.golf.d.ts

@@ -1 +1,9 @@
+/**
+ * The Golf ball emblem (ゴルフボール in Japanese): id `ball:golf`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_GOLF } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_GOLF.id, BALL_GOLF.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_GOLF: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.golf.js

@@ -1,5 +1,13 @@
 // Golf ball (not one of our sports; a bonus): white, with a dimple pattern. The rules fix the size and mass, not the dimples.
 import { dottedBall } from "./ball.family.dotted.js";
+/**
+ * The Golf ball emblem (ゴルフボール in Japanese): id `ball:golf`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_GOLF } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_GOLF.id, BALL_GOLF.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_GOLF = /* @__PURE__ */ dottedBall({
     id: "ball:golf",
     en: "Golf ball",

package/dist/emblems/ball/ball.hammer.d.ts

@@ -1 +1,9 @@
+/**
+ * The Hammer emblem (ハンマー（ハンマー投） in Japanese): id `ball:hammer`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_HAMMER } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_HAMMER.id, BALL_HAMMER.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_HAMMER: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.hammer.js

@@ -6,6 +6,14 @@ const U = norm(cross(D, [0, 0, 1]));
 const HEAD = mul(D, -1.25);
 const WIRE_START = -0.25;
 const WIRE_END = 1.25;
+/**
+ * The Hammer emblem (ハンマー（ハンマー投） in Japanese): id `ball:hammer`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_HAMMER } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_HAMMER.id, BALL_HAMMER.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_HAMMER = /* @__PURE__ */ defineBall({
     id: "ball:hammer",
     en: "Hammer",

package/dist/emblems/ball/ball.handball.d.ts

@@ -1 +1,9 @@
+/**
+ * The Handball emblem (ハンドボール in Japanese): id `ball:handball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_HANDBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_HANDBALL.id, BALL_HANDBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export declare const BALL_HANDBALL: import("./ball.core.ts").Piece<import("./ball.engine.ts").BallSpec>;

package/dist/emblems/ball/ball.handball.js

@@ -2,6 +2,14 @@
 import { defineBall } from "./ball.engine.js";
 import { truncatedIcosahedron } from "./ball.polyhedra.js";
 import { mix } from "./ball.core.js";
+/**
+ * The Handball emblem (ハンドボール in Japanese): id `ball:handball`, a ball turned in 3D.
+ * @example
+ * ```ts
+ * import { BALL_HANDBALL } from "@johnmorrisdotca/dougu-sports";
+ * console.log(BALL_HANDBALL.id, BALL_HANDBALL.svg({ size: 48 }).startsWith("<svg"));
+ * ```
+ */
 export const BALL_HANDBALL = /* @__PURE__ */ defineBall({
     id: "ball:handball",
     en: "Handball",

package/dist/emblems/ball/ball.index.d.ts

@@ -24,6 +24,15 @@ export declare function renderBall(name: string, options?: PieceOptions): string
 export declare function ballFrame(name: string, options?: BallFrameOptions): string;
 /** The official size of a ball, with the rule it comes from. */
 export declare function ballSize(name: string): PieceSize | undefined;
+/**
+ * What `lineup` takes: the scale, height, gap and alignment, and the usual piece options.
+ * @example
+ * ```ts
+ * import type { LineupOptions } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const options: LineupOptions = { scale: "same", height: 64, gap: 12, align: "centre" };
+ * console.log(options.height);
+ * ```
+ */
 export interface LineupOptions extends PieceOptions {
     /** `true` (the default): each ball at its real size next to the others. `same`: every ball as large as the largest. */
     scale?: "true" | "same";
@@ -37,12 +46,14 @@ export interface LineupOptions extends PieceOptions {
 /**
  * Several balls side by side. At the true scale each ball is as big, next to the others, as the rulebook makes it: a puck beside a basketball looks right. `extentMm` is what a ball's drawing is
  * scaled by (the ball's largest size in a box of 92 units), so the sizes are the rules' sizes, not a guess. The result is one document of SVG.
+ * @param names - Ball ids (`ball:golf`), in the order they stand.
+ * @param options - The scale, height, gap and alignment.
+ * @returns One document of SVG with all the balls.
  * @example
  * ```ts
- * import { lineup } from "@johnmorrisdotca/kyogijo-stadiums/balls";
- * const svg = lineup(["golf", "tennis", "soccer", "puck"], { scale: "true", height: 80 });
- * console.log(svg.includes("<title>"));
- * // true
+ * import { lineup } from "@johnmorrisdotca/dougu-sports/emblems";
+ * const svg = lineup(["ball:golf", "ball:tennis", "ball:soccer"], { scale: "true", height: 80 });
+ * console.log(svg.startsWith("<svg"));
  * ```
  */
 export declare function lineup(names: readonly string[], options?: LineupOptions): string;