@johnmorrisdotca/kyogijo-stadiums 0.49.0 → 0.50.0

package/dist/circuits.types.d.ts

@@ -0,0 +1,121 @@
+import type { LonLat } from "./venues.geo.ts";
+import type { Language } from "./types.ts";
+/** Whether a source says a fact (`documented`) or it is ours (`plausible`). */
+export type CircuitBasis = "documented" | "plausible";
+/** One fact, the source it was read from and in what words. */
+export interface CircuitFact<T> {
+    value: T;
+    basis: CircuitBasis;
+    /** Where it was read: `wikidata` (CC0), `wikipedia` (the article and revision of the record, CC BY-SA 4.0, in our own words) or `openstreetmap` (ODbL); missing for one of ours. */
+    source?: "wikidata" | "wikipedia" | "openstreetmap";
+    /** What was read, in our own words. */
+    read: string;
+}
+/** A circuit's facts: `scripts/circuits.data.json`, checked against the raw answers by `pnpm circuits`. */
+export interface CircuitData {
+    /** The key: kebab case. */
+    id: string;
+    /** The Wikidata item. */
+    wikidata: string;
+    /** The articles and the revisions read. */
+    en: {
+        title: string;
+        revision: number;
+    };
+    ja: {
+        title: string;
+        revision: number;
+    };
+    /** The circuit's name: Wikidata's labels. */
+    names: {
+        en: string;
+        ja: string;
+    };
+    /** The country, as its two-letter code (Wikidata's P17). */
+    country: string;
+    /** The day it opened, `yyyy-mm-dd`. */
+    opened: CircuitFact<string>;
+    /** The length of a lap, in metres, as published. */
+    length: CircuitFact<number>;
+    /** How many corners (turns) the lap has, as published. */
+    corners: CircuitFact<number>;
+    /** Which way the cars go round, seen from above. */
+    direction: CircuitFact<"clockwise" | "counterclockwise">;
+    /** The width of the track the ribbon is drawn at, in metres. */
+    width: CircuitFact<number>;
+    /** The width of the pit lane, in metres. */
+    pitLaneWidth: CircuitFact<number>;
+    /** Where the turns' numbers come from. */
+    turnNumbers: Omit<CircuitFact<never>, "value">;
+    /** Where the pit building comes from. */
+    pitBuilding: Omit<CircuitFact<never>, "value">;
+}
+/** A point of OpenStreetMap's that the drawing places: a turn, the start, the finish. */
+export interface CircuitOsmPoint {
+    /** The node, `node/<id>`. */
+    source: string;
+    at: LonLat;
+}
+/** What OpenStreetMap maps of a circuit (ODbL 1.0): `src/circuits.osm.data.ts`, apart from every other file. */
+export interface CircuitOsm {
+    /** The relation of the circuit, `relation/<id>`. */
+    source: string;
+    /** The day the answer was read, and the base of the data it was read from. */
+    read: string;
+    base: string;
+    licence: "ODbL-1.0";
+    attribution: string;
+    /** The lap: the relation's ways in the order and the direction it runs, joined into one ring, from the start, simplified to `tolerance` metres; longitude and latitude to six decimals. The first point is not repeated. */
+    lap: LonLat[];
+    /** How many points the lap had before it was simplified, and the tolerance it was simplified to, in metres. */
+    points: number;
+    tolerance: number;
+    /** The pit lane, as a line in the way it is driven. */
+    pitLane: {
+        source: string;
+        line: LonLat[];
+    };
+    /** The ground of the circuit (the area its owner holds: the paddock), as a ring. */
+    area: {
+        source: string;
+        ring: LonLat[];
+    };
+    /** The turns, in the order of the lap, each where OpenStreetMap puts its number. */
+    turns: (CircuitOsmPoint & {
+        n: number;
+    })[];
+    start: CircuitOsmPoint;
+    finish: CircuitOsmPoint;
+    /** The pit building beside the pit lane: its outline, its height in metres and its levels, as mapped. */
+    pitBuilding?: {
+        source: string;
+        ring: LonLat[];
+        height: number;
+        levels?: number;
+    };
+}
+/** A circuit: its facts and what OpenStreetMap maps of it. */
+export interface Circuit extends CircuitData {
+    osm: CircuitOsm;
+}
+/** The options of a circuit's drawing. */
+export interface CircuitOptions {
+    /** The circuit's key: `las-vegas`. */
+    circuit: string;
+    /** `en` (the default) or `ja`. */
+    language?: Language;
+    /** `light` or `dark` forces a theme; left out, the drawing follows the page and the device. */
+    theme?: "light" | "dark";
+    /** The name and the line of facts in the top corner: `true` (the default) or `false`. */
+    label?: boolean;
+    /** The turns' numbers: `true` (the default) or `false`. */
+    turns?: boolean;
+    /** The arrows that show which way the lap runs: `true` (the default) or `false`. */
+    arrows?: boolean;
+    /** The prefix of the ids inside the drawing, for a page with more than one; a hash of the options when missing. */
+    id?: string;
+    /** More classes on the root. */
+    className?: string;
+    /** `none` leaves the stylesheet out, for a page that puts `KYOGIJO_CIRCUIT_STYLE` in once. */
+    css?: "none";
+}

package/dist/circuits.types.js

@@ -0,0 +1 @@
+export {};

package/dist/circuits.words.d.ts

@@ -0,0 +1,47 @@
+import type { Language } from "./types.ts";
+/** What a circuit's pictures say. */
+export interface CircuitWords {
+    /** The title: the circuit's name. */
+    title: string;
+    /** The line under the name: the length and the number of turns. */
+    facts: string;
+    /** The description, sentence by sentence. */
+    lap: string;
+    counterclockwise: string;
+    clockwise: string;
+    turns: string;
+    pit: string;
+    building: string;
+    width: string;
+    /** What stands up in the 3D view. */
+    standing: string;
+    standingNoBuilding: string;
+    /** The credit of the data. */
+    credit: string;
+    /** A turn's number, for a screen reader. */
+    turn: string;
+    /** The scale bar's unit. */
+    metres: string;
+    /** The north arrow's name, for a screen reader. */
+    northArrow: string;
+    /** The table: its caption and its heads. */
+    table: {
+        caption: string;
+        fact: string;
+        value: string;
+        basis: string;
+        documented: string;
+        plausible: string;
+        length: string;
+        measured: string;
+        corners: string;
+        direction: string;
+        opened: string;
+        width: string;
+        pitLaneWidth: string;
+        wikidata: string;
+        counterclockwise: string;
+        clockwise: string;
+    };
+}
+export declare const CIRCUIT_WORDS: Readonly<Record<Language, CircuitWords>>;

package/dist/circuits.words.js

@@ -0,0 +1,38 @@
+export const CIRCUIT_WORDS = Object.freeze({
+    en: {
+        title: "{name}",
+        facts: "{km} km · {turns} turns",
+        lap: "A plan of {name}: a lap of {km} km, drawn on the ways OpenStreetMap maps for it (the line measures {measured} km).",
+        counterclockwise: "The lap runs counterclockwise, as the arrows show.",
+        clockwise: "The lap runs clockwise, as the arrows show.",
+        turns: "Its {turns} turns are numbered where OpenStreetMap numbers them, and the start and finish lines are drawn across the track.",
+        pit: "The pit lane runs beside the start.",
+        building: "The pit building stands beside the pit lane.",
+        width: "The track is drawn {width} m wide, which is ours: no source gives it.",
+        standing: "In 3D the pit building stands {height} m high, and each turn's number stands on a post.",
+        standingNoBuilding: "In 3D each turn's number stands on a post.",
+        credit: "Map data: {credit}.",
+        turn: "Turn {n}",
+        metres: "m",
+        northArrow: "North",
+        table: { caption: "{name}: the facts and where they come from", fact: "Fact", value: "Value", basis: "Basis", documented: "documented", plausible: "ours (plausible)", length: "Length of a lap", measured: "Length of the drawn line", corners: "Turns", direction: "Direction", opened: "Opened", width: "Track width drawn", pitLaneWidth: "Pit lane width drawn", wikidata: "Wikidata", counterclockwise: "counterclockwise", clockwise: "clockwise" },
+    },
+    ja: {
+        title: "{name}",
+        facts: "全長{km} km・{turns}コーナー",
+        lap: "{name}の平面図。1周{km} kmのコースを、OpenStreetMapに登録された道路に沿って描いています（描いた線の長さは{measured} km）。",
+        counterclockwise: "矢印のとおり、コースは反時計回りです。",
+        clockwise: "矢印のとおり、コースは時計回りです。",
+        turns: "{turns}か所のコーナーには、OpenStreetMapと同じ番号を同じ位置に記し、スタートラインとフィニッシュラインはコースを横切る線で描いています。",
+        pit: "ピットレーンはスタート地点の脇を通ります。",
+        building: "ピットビルはピットレーンの脇に建っています。",
+        width: "コース幅は{width} mで描いています。この値は独自のもので、出典はありません。",
+        standing: "3D表示では、ピットビルは高さ{height} mで建ち、各コーナーの番号はポールの上に掲げられます。",
+        standingNoBuilding: "3D表示では、各コーナーの番号はポールの上に掲げられます。",
+        credit: "地図データ：{credit}。",
+        turn: "ターン{n}",
+        metres: "m",
+        northArrow: "北",
+        table: { caption: "{name}：データとその出典", fact: "項目", value: "値", basis: "根拠", documented: "出典あり", plausible: "独自の値（妥当な推定）", length: "1周の長さ", measured: "描いた線の長さ", corners: "コーナー数", direction: "走行方向", opened: "開業", width: "描いたコース幅", pitLaneWidth: "描いたピットレーン幅", wikidata: "Wikidata", counterclockwise: "反時計回り", clockwise: "時計回り" },
+    },
+});

package/dist/multi.js

@@ -1,6 +1,6 @@
 // A tournament layout laid out: several of the package's own surfaces on one floor, to scale, where each stands and what it leaves free; the floor the layout needs; and whether it fits a hall's floor. The
 // figures are in multi.data.ts (a rulebook's, with its source); this file only adds them up. Nothing here draws SVG (multi.draw.ts does), and every function returns new values.
-import { inOctagon } from "./budo/plan.js";
+import { budoLeague, budoPlan, inOctagon } from "./budo/plan.js";
 import { fill } from "./strings.core.js";
 import { FEET_PER_METRE } from "./geometry.js";
 import { IJF_CONTEST, WKF_KUMITE } from "./leagues/budo.js";
@@ -136,13 +136,23 @@ export function multiLayout(options = {}) {
     let floor;
     let tatami;
     if (spec.kind === "budo") {
-        // The contest area, the safety area, the common safe zone between areas and the free zone, in metres: judo's from the IJF's figures (or the options'), karate's from the WKF's kumite area.
+        // The contest area, the safety area, the common safe zone between areas and the free zone, in metres. Judo's are the drawing's own (`budoPlan`), so that the floor is laid where the surface is
+        // drawn for every league: the IJF's contest area, its kata area (2 m of safety and common area, not 4) and the AJJF's (sizes made whole numbers of its 91 cm mats). Karate's are its league's.
         const karate = spec.sport === "karate";
-        const opts = spec.surface.budo ?? {};
-        const c = karate ? WKF_KUMITE.area : opts.size ?? IJF_CONTEST.contest.drawn;
-        const s = karate ? WKF_KUMITE.safety : opts.safety ?? IJF_CONTEST.safety.drawn;
-        const gap = karate ? WKF_KUMITE.between : Math.max(IJF_CONTEST.common, s);
-        const free = karate ? 0 : IJF_CONTEST.freeZone;
+        let c, s, gap, free;
+        if (karate) {
+            const dims = budoLeague(spec.surface).dimensions;
+            const k = dims.kind === "karate" ? dims : WKF_KUMITE;
+            [c, s, gap, free] = [k.area, k.safety, k.between, 0];
+        }
+        else {
+            const plan = budoPlan(spec.surface);
+            const first = plan.judo?.contests[0];
+            const fig = plan.figures.kind === "judo" ? plan.figures : IJF_CONTEST;
+            if (plan.judo === undefined || first === undefined)
+                throw new Error(`The layout "${spec.id}" is not a judo floor of contest areas`);
+            [c, s, gap, free] = [first.x1 - first.x0, first.x0, plan.judo.gap, fig.freeZone];
+        }
         const across = spec.columns;
         const down = spec.rows;
         const tw = across * c + (across - 1) * gap + 2 * s;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** The package's version: the same as package.json's, and a test holds them to each other. */
-export declare const VERSION = "0.49.0";
+export declare const VERSION = "0.50.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** The package's version: the same as package.json's, and a test holds them to each other. */
-export const VERSION = "0.49.0";
+export const VERSION = "0.50.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johnmorrisdotca/kyogijo-stadiums",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "description": "Kyogijo Stadiums 競技場, 40 sports' surfaces as SVG, drawn to scale from the rulebooks: NFL, CFL and IFAF football fields, an NHL rink, an NBA court, MLB ballparks, soccer pitches, curling sheets, athletics stadiums, speed skating, short track and figure skating rinks, swimming pools, water polo fields, diving wells, artistic swimming areas, and the courts and fields of tennis, volleyball (indoor, beach and sitting), badminton, pickleball, table tennis, padel, squash, racquetball, sepak takraw, teqball, roundnet, netball, lacrosse, rugby, Australian football, Gaelic games, cricket, field hockey and handball, and the budo of judo, karate, kendo, sumo and kyudo with a dojo of tatami laid as real units, the MMA cage, with each team's name and logo on its side and the score in the middle, stands and a crowd, a pageant of flags, and a 3D view. Light and dark, accessible, a compact badge for lists, a helper for React and a custom element. Zero dependencies.",
   "keywords": [
     "sports",
@@ -287,6 +287,11 @@
       "import": "./dist/turn-entry.js",
       "default": "./dist/turn-entry.js"
     },
+    "./circuits": {
+      "types": "./dist/circuits-entry.d.ts",
+      "import": "./dist/circuits-entry.js",
+      "default": "./dist/circuits-entry.js"
+    },
     "./flythrough": {
       "types": "./dist/flythrough-entry.d.ts",
       "import": "./dist/flythrough-entry.js",
@@ -346,6 +351,8 @@
     "stadiums": "node scripts/build-stadiums.mjs",
     "stadiums:fetch": "node scripts/fetch-stadiums.mjs",
     "walk": "node scripts/build-walk.mjs",
+    "circuits": "node scripts/build-circuits.mjs",
+    "circuits:fetch": "node scripts/fetch-circuits.mjs",
     "osm-context": "node scripts/build-osm-context.mjs",
     "cityctx": "node scripts/build-cityctx.mjs",
     "cityctx:fetch": "node scripts/fetch-cityctx.mjs",