@johnmorrisdotca/kyogijo-stadiums 0.45.1 → 0.45.3

package/dist/walk.d.ts

@@ -1,5 +1,7 @@
 import type { LonLat } from "./venues.geo.ts";
 import type { Pt } from "./crowd.ts";
+/** The metres one whole number of the mask's coordinates is. */
+export declare const WALK_UNIT = 0.25;
 /** What a district's mask is made from, as `walk.data.ts` holds it: lines (`[width in tenths of a metre, first point, steps...]`) and areas (rings, the first the outside, in whole quarter-metres). */
 export interface WalkData {
     /** The raw file the data was made from, and the day it was read and the time of OpenStreetMap's data. */
@@ -36,6 +38,14 @@ export interface WalkMask {
 }
 /** The districts there are masks for. */
 export declare const WALK_IDS: readonly string[];
+/** Hold districts' data for the drawing, under their keys: a later one with a key replaces the earlier. */
+export declare function registerWalk(table: Readonly<Record<string, WalkData>>): void;
+/** The data of a district, if it is held. */
+export declare const heldWalk: (id: string) => WalkData | undefined;
+/** The data of a district, which a crowd outside is made from; throws, saying how to have it, where it is not held. */
+export declare function walkDataOf(id: string): WalkData;
+/** A district's data, read from its own file the first time and held for the drawing after: asking again gives the same promise. A key that is not a district rejects, naming the ones there are. */
+export declare function loadWalk(id: string): Promise<WalkData>;
 /** A path from its packed form: the first point, then the step to each next one, in metres. */
 export declare function unpack(packed: readonly number[], from?: number): Pt[];
 /** What a mask is given besides the data: rings in metres from the mask's origin that stop a crowd (the venues' own buildings), and rings whose surroundings are the venues' own ground. */
@@ -46,7 +56,7 @@ export interface WalkExtras {
     apron: number;
 }
 /**
- * The mask of a district, rasterised from `WALK_DATA` (and kept for the next call): the walkable areas and the paths at their width, the apron round each venue, then the carriageways, cycle tracks, railways, water and buildings cut out
+ * The mask of a district, rasterised from the district's data (`walk/<district>.data.ts`, held by `loadOutside` or by the full table; and kept for the next call): the walkable areas and the paths at their width, the apron round each venue, then the carriageways, cycle tracks, railways, water and buildings cut out
  * of them, and the venues' own buildings last. A person stands in a cell with value 1, and nowhere else.
  */
 export declare function walkMask(id: string, extras: WalkExtras): WalkMask;
@@ -54,3 +64,16 @@ export declare function walkMask(id: string, extras: WalkExtras): WalkMask;
 export declare function walkable(mask: WalkMask, x: number, y: number): boolean;
 /** The mask a set of venues stand on, if there is one: the first mask that names one of them (by id, whatever configuration). */
 export declare const walkIdFor: (venueIds: readonly string[]) => string | undefined;
+/**
+ * The walkable ground the crowd outside some venues stands on, read from its file and held for the drawing: await it before `planDistrict`, `drawDistrict`, `mountDistrict` or `mountDistrictTurn` of the lean district with `outside` asked for
+ * (the district entry holds every district's data and needs no call), and the outline of each arena of the ground (the crowd keeps out of the buildings of the venues that are not shown too). It reads nothing for venues that no mask names, so a page may call it for every choice of venues; asking again reads nothing.
+ * @example
+ * ```ts
+ * import { loadOutside, loadVenueDataFor, outsideCrowd, planDistrict } from "@johnmorrisdotca/kyogijo-stadiums/district-lean";
+ * const venues = ["bc-place:cfl", "rogers-arena"];
+ * await Promise.all([loadVenueDataFor(venues), loadOutside(venues)]);
+ * console.log(outsideCrowd(planDistrict({ venues, outside: { level: 25 } }))?.venues.length);
+ * // 2
+ * ```
+ */
+export declare function loadOutside(venues: readonly string[]): Promise<void>;

package/dist/walk.data.d.ts

@@ -1,4 +1,4 @@
+import { WALK_UNIT } from "./walk.ts";
 import type { WalkData } from "./walk.ts";
-/** The metres one whole number of the mask's coordinates is. */
-export declare const WALK_UNIT = 0.25;
+export { WALK_UNIT };
 export declare const WALK_DATA: Record<string, WalkData>;