@johnmorrisdotca/kyogijo-stadiums 0.50.0 → 0.51.0

package/dist/catalogue.js

@@ -0,0 +1,74 @@
+// The catalogue: every venue the package draws today (supported), the ones being built (working on) and the ones wanted, with their facts, in one list. The same data is published as a static
+// file, `catalogue.json`, in the npm package and on the demo's site (`CATALOGUE_ADDRESS`). There is no server: a reader fetches the file or imports this entry.
+import { CATALOGUE_DATA } from "./catalogue.data.js";
+/** Every venue: the supported ones first, then those being built, then the wanted ones, each group in its order. */
+export const CATALOGUE = CATALOGUE_DATA.venues;
+/** The leagues (every venue of the season, NBA, MLB, NFL, CFL and NHL) and the collections of the Working on and Wanted sections, each with its venues in order and its name in both languages. */
+export const CATALOGUE_GROUPS = CATALOGUE_DATA.groups;
+/** The sports, with their names in both languages and the `sport` of `drawKyogijo` that draws each (`null`: not drawn yet). */
+export const CATALOGUE_SPORTS = CATALOGUE_DATA.sports;
+/** The countries of the catalogue by ISO code, with their names in English and Japanese (Wikidata's labels). */
+export const CATALOGUE_COUNTRIES = CATALOGUE_DATA.countries;
+/** Where `catalogue.json` is published: the same data as this entry, for a page or a program that does not install the package. */
+export const CATALOGUE_ADDRESS = CATALOGUE_DATA.address;
+/** The demo's address: a supported venue's `demo` is relative to it. */
+export const CATALOGUE_SITE = CATALOGUE_DATA.site;
+/** The counts, the day the sources were read and where they are kept, and the licence of the facts. */
+export const CATALOGUE_ABOUT = {
+    schemaVersion: CATALOGUE_DATA.schemaVersion,
+    generatedAt: CATALOGUE_DATA.generatedAt,
+    package: CATALOGUE_DATA.package,
+    licence: CATALOGUE_DATA.licence,
+    source: CATALOGUE_DATA.source,
+    counts: CATALOGUE_DATA.counts,
+};
+const BY_ID = new Map(CATALOGUE.map((entry) => [entry.id, entry]));
+/**
+ * A venue by its id, or `undefined`.
+ * @example
+ * ```ts
+ * import { catalogueById } from "@johnmorrisdotca/kyogijo-stadiums/catalogue";
+ * const ashe = catalogueById("arthur-ashe-stadium")!;
+ * console.log(ashe.status, ashe.ticket, ashe.wikidata);
+ * // working-on KYOGIJO-STADIUMS-22 Q609551
+ * ```
+ */
+export function catalogueById(id) {
+    return BY_ID.get(id);
+}
+/** The venues of a status, in the catalogue's order. */
+export function catalogueByStatus(status) {
+    return CATALOGUE.filter((entry) => entry.status === status);
+}
+/** The venues of a sport (any of a venue's sports), in the catalogue's order. */
+export function catalogueBySport(sport) {
+    return CATALOGUE.filter((entry) => entry.sports.includes(sport));
+}
+/** The venues of a group (a league or a collection), in the group's order; empty for a group that does not exist. */
+export function catalogueByGroup(group) {
+    return (CATALOGUE_GROUPS.find((one) => one.id === group)?.ids ?? []).map((id) => BY_ID.get(id)).filter((entry) => entry !== undefined);
+}
+/** Every venue whose building or whole venue is wanted: the venues of the Wanted section and the supported venues of a league or a collection that are drawn as a surface only. */
+export function catalogueWanted() {
+    return CATALOGUE.filter((entry) => entry.want !== undefined && entry.status !== "working-on");
+}
+/**
+ * How much of a league the package draws: its venues this season, how many in their buildings, how many as a field only, how many not yet.
+ * @example
+ * ```ts
+ * import { catalogueCoverage } from "@johnmorrisdotca/kyogijo-stadiums/catalogue";
+ * const nhl = catalogueCoverage("nhl");
+ * console.log(nhl.venues, nhl.outline, nhl.notYet);
+ * // 32 32 0
+ * ```
+ */
+export function catalogueCoverage(league) {
+    const venues = catalogueByGroup(league);
+    return {
+        league,
+        venues: venues.length,
+        outline: venues.filter((entry) => entry.drawn === "outline").length,
+        surface: venues.filter((entry) => entry.drawn === "surface").length,
+        notYet: venues.filter((entry) => entry.status !== "supported").length,
+    };
+}

package/dist/catalogue.types.d.ts

@@ -0,0 +1,143 @@
+import type { PlaceSurface } from "./atlas.ts";
+/** Where a venue stands with the package: drawn today, being built (an open ticket), or wanted. */
+export type CatalogueStatus = "supported" | "working-on" | "wanted";
+/**
+ * How a supported venue is drawn: `outline`, inside the outline of its real building with a bowl of its seats (`STADIUMS` and the NHL's `VENUES`), or `surface`, its field, court, rink, park or
+ * floor only, at the venue's own size where the data gives one (a key of `PARKS`, `GROUNDS`, `ARENAS` or `HALLS`), or `circuit`, the lap as OpenStreetMap maps it with its pit lane and no stands
+ * (a key of `CIRCUITS`, drawn by `drawCircuit` of the `circuits` entry).
+ */
+export type CatalogueDrawn = "outline" | "surface" | "circuit";
+/** What is wanted of a venue: its building's `outline` (a venue drawn today as a surface only), or the `venue` itself (one the package does not draw at all). */
+export type CatalogueWant = "outline" | "venue";
+/** What has to exist before a wanted venue can be drawn: a `circuit-surface` for motor racing, which the package does not draw yet. */
+export type CatalogueNeed = "circuit-surface";
+/** The sports of the catalogue, in kebab case. Every one but `motor-racing` names a surface the package draws (`CATALOGUE_SPORTS[sport].surface`). */
+export type CatalogueSport = "baseball" | "basketball" | "hockey" | "american-football" | "canadian-football" | "soccer" | "cricket" | "rugby" | "australian-football" | "gaelic-games" | "tennis" | "budo" | "athletics" | "swimming" | "skating" | "curling" | "volleyball" | "badminton" | "handball" | "boxing" | "motor-racing";
+/** The leagues whose every venue of the season is in the catalogue. */
+export type CatalogueLeague = "nba" | "mlb" | "nfl" | "cfl" | "nhl";
+/** A club that plays its home games at a venue this season. */
+export interface CatalogueTeam {
+    name: string;
+    nameJa?: string;
+    league: CatalogueLeague;
+}
+/** The options that draw a supported venue with `drawKyogijo`: its surface (a park, a ground, an arena or a hall), or its real building (`stadium` or `arena` with `crowd: { real: true }`). */
+export type CatalogueDraw = PlaceSurface | {
+    sport: "nfl" | "cfl" | "soccer" | "mlb" | "boxing" | "nba" | "nhl";
+    stadium?: string;
+    park?: string;
+    arena?: string;
+    crowd: {
+        real: true;
+    };
+};
+/** One venue of the catalogue. */
+export interface CatalogueEntry {
+    /** Kebab case, unique: the package's own key for a venue it draws (`fenway-park`, `bc-place`), else one made from the venue's English name. */
+    id: string;
+    status: CatalogueStatus;
+    /** How a supported venue is drawn. */
+    drawn?: CatalogueDrawn;
+    /** What is wanted: the building's outline of a venue drawn as a surface that a league or a group lists, or the venue itself. */
+    want?: CatalogueWant;
+    /** What must be built first. */
+    needs?: CatalogueNeed;
+    /** Which of the package's lists a supported venue comes from: a real stadium or NHL venue (`stadium`, `venue`), or a `park`, `ground`, `arena` or `hall`. */
+    kind?: "stadium" | "venue" | "park" | "ground" | "arena" | "hall" | "circuit";
+    /** The everyday name in English. */
+    name: string;
+    /** The name in Japanese; absent where no source gives one (`missing.nameJa` says so). */
+    nameJa?: string;
+    /** Where the Japanese name was read: the package's own data, Wikidata's label, the title of the Japanese Wikipedia's article, or a name a reviewer checked. */
+    nameJaFrom?: "package" | "wikidata" | "jawiki" | "reviewed";
+    city?: string;
+    cityJa?: string;
+    /** ISO 3166-1 alpha-2. */
+    country?: string;
+    /** Wikidata's coordinates (P625), in degrees. */
+    lat?: number;
+    lon?: number;
+    sports: CatalogueSport[];
+    /** The Wikidata item. */
+    wikidata: string;
+    /** The seats, where Wikidata gives one figure (P1083), for a venue that is not drawn yet. */
+    capacity?: number;
+    /** `current` or `past`, for a supported venue. */
+    era?: "current" | "past";
+    /** The leagues that play there this season, and their clubs. */
+    leagues?: CatalogueLeague[];
+    teams?: CatalogueTeam[];
+    /** The groups the venue is listed in (a league, a collection of the Wanted section). */
+    groups: string[];
+    /** The ticket of a venue being built. */
+    ticket?: string;
+    /** The options that draw a supported venue with `drawKyogijo` (a circuit has none: `drawCircuit({ circuit: id })` of the `circuits` entry draws it). */
+    draw?: CatalogueDraw;
+    /** The demo page that shows a supported venue, relative to the demo's address (`CATALOGUE_SITE`). */
+    demo?: string;
+    /** The facts left out, each with why. */
+    missing?: Partial<Record<"nameJa" | "city" | "country" | "coordinates", string>>;
+}
+/** A group: a league (every venue of its season) or a collection of the Wanted or Working on section, in its order. */
+export interface CatalogueGroup {
+    id: string;
+    kind: "league" | "collection";
+    en: string;
+    ja: string;
+    /** For a league: its sport and its season. */
+    sport?: CatalogueSport;
+    season?: string;
+    /** For a collection that is being built. */
+    status?: "working-on";
+    needs?: CatalogueNeed;
+    ids: string[];
+}
+/** The whole catalogue, as `catalogue.json` holds it. */
+export interface CatalogueData {
+    /** The shape's version: a change that breaks a reader raises it. */
+    schemaVersion: 1;
+    /** The day the sources were read (not the day the file was written). */
+    generatedAt: string;
+    package: {
+        name: string;
+        version: string;
+    };
+    /** Where the JSON is published. */
+    address: string;
+    /** The demo's address, which `demo` is relative to. */
+    site: string;
+    licence: string;
+    source: {
+        read: string;
+        rawAnswers: string;
+        articles: Record<string, number>;
+    };
+    counts: {
+        supported: number;
+        outline: number;
+        surface: number;
+        circuit: number;
+        workingOn: number;
+        wanted: number;
+        outlineWanted: number;
+    };
+    sports: Record<CatalogueSport, {
+        en: string;
+        ja: string;
+        surface: string | null;
+    }>;
+    groups: CatalogueGroup[];
+    countries: Record<string, {
+        en: string;
+        ja?: string;
+    }>;
+    venues: CatalogueEntry[];
+}
+/** How many venues of a league the package draws in their buildings, as a surface only, or not at all. */
+export interface CatalogueCoverage {
+    league: CatalogueLeague;
+    venues: number;
+    outline: number;
+    surface: number;
+    notYet: number;
+}

package/dist/catalogue.types.js

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

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.50.0";
+export declare const VERSION = "0.51.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.50.0";
+export const VERSION = "0.51.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johnmorrisdotca/kyogijo-stadiums",
-  "version": "0.50.0",
+  "version": "0.51.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",
@@ -297,6 +297,12 @@
       "import": "./dist/flythrough-entry.js",
       "default": "./dist/flythrough-entry.js"
     },
+    "./catalogue": {
+      "types": "./dist/catalogue-entry.d.ts",
+      "import": "./dist/catalogue-entry.js",
+      "default": "./dist/catalogue-entry.js"
+    },
+    "./catalogue.json": "./catalogue.json",
     "./element/define": {
       "types": "./dist/element-define.d.ts",
       "import": "./dist/element-define.js",
@@ -308,7 +314,8 @@
     "README.md",
     "LICENSE",
     "NOTICE.md",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "catalogue.json"
   ],
   "engines": {
     "node": ">=22"
@@ -350,6 +357,8 @@
     "venues:rink": "node scripts/fetch-rink-evidence.mjs",
     "stadiums": "node scripts/build-stadiums.mjs",
     "stadiums:fetch": "node scripts/fetch-stadiums.mjs",
+    "catalogue": "node scripts/build-catalogue.mjs",
+    "catalogue:fetch": "node scripts/fetch-catalogue.mjs",
     "walk": "node scripts/build-walk.mjs",
     "circuits": "node scripts/build-circuits.mjs",
     "circuits:fetch": "node scripts/fetch-circuits.mjs",