@wral/hsot-data 0.1.0

package/README.md

@@ -0,0 +1,83 @@
+# @wral/hsot-data
+
+Lit web components for the HighSchoolOT public data pages, rendered from
+[api-hsot](https://bitbucket.org/cbcnm/api-hsot) v1 read payloads. One
+component per page function; the sport arrives as an attribute, so the
+sport-first site hierarchy (`/football/` → standings) is a publishing concern,
+not a code one. Each published `templates.hsot-web.data-page` document carries
+exactly one of these elements.
+
+| Component | Page | Key attributes |
+|---|---|---|
+| `<hsot-scores>` | Scores/Schedules (the scoreboard; future dates are schedules) | `sport`, `date` (YYYY-MM-DD, default today, deep-linkable via `?date=`), `season`, `refresh-interval` |
+| `<hsot-standings>` | Standings, every conference for a sport | `sport`, `season` |
+| `<hsot-rankings>` | The weekly Top 25 with movement + rank history | `sport`, `gender` (poll family), `season`, deep link `?poll=YYYY-MM-DD` |
+| `<hsot-school>` | School hub: hero, team tabs, schedule, roster, honors | `school-id`, `sport` (initial tab, deep link `?sport=`), `season` |
+| `<hsot-boxscore>` | Game detail: line score, coverage, season context | `game-id`, `refresh-interval` |
+
+Shared attributes on every component:
+
+- `api` — base URL of api-hsot v1 (e.g. `https://api.highschoolot.com/v1`).
+  Alternatively set the `.client` **property** to any object with the client
+  method surface (see `src/lib/client.mjs`) — the demo client, a test double,
+  or the future `@wral/sdk-hsot`. The property wins over the attribute.
+- `game-href`, `school-href`, `section-href` — link templates with `{sport}`,
+  `{id}` and `{view}` tokens for cross-page links. Defaults follow the
+  sport-first hierarchy: `/{sport}/game/{id}/`, `/school/{id}/`,
+  `/{sport}/{view}/`. The site's URL space belongs to Studio publications, so
+  these are overridable per mount.
+- `refresh-interval` — milliseconds between reloads (live surfaces). 0 = off.
+
+## Derivation lives here, for now
+
+Standings, records, streaks and rank badges are **derived client-side** from
+Game and Ranking payloads:
+
+- Winner rule: forfeit (names the awarded side) → score → tiebreakWinner.
+- gameType semantics: scrimmage counts toward nothing; conference counts
+  toward overall **and** conference records; nonconference/playoff toward
+  overall only.
+- Poll resolution (behavioral contract §8): the poll in effect for a date is
+  the latest one on or before it, per gender family — so past box scores keep
+  the ranks they were played under.
+
+That logic is `src/lib/records.mjs` and `src/lib/polls.mjs`, unit-tested with
+`node --test`. If api-hsot ever grows derived read endpoints, those two files
+are what they replace.
+
+## Development
+
+Requires Node 18+.
+
+```bash
+npm install
+npm run dev     # demo harness on the vite dev server
+npm test        # node --test over src/lib
+npm run lint
+npm run build   # dist/index.mjs + dist/define.mjs (lit external)
+                # and dist/define.standalone.js (self-contained, for <script src> on pages)
+```
+
+The demo harness (`index.html`) runs the components against a seeded
+in-memory client (`src/demo/demo-client.mjs`): a full football season with
+live, overtime, forfeit and postponed games, nine weekly polls, and three
+rosters. **Player names in the demo data are pseudonyms** — real rosters stay
+out of this repo pending the minors-data review. No live api-hsot call is
+made by the harness.
+
+## Consuming
+
+From a page template (the data-page pattern):
+
+```html
+<script type="module" src="https://d2sxodt54h49c7.cloudfront.net/@wral/hsot-data/v0/define.standalone.js"></script>
+<hsot-standings sport="football" api="https://api.highschoolot.com/v1"></hsot-standings>
+```
+
+From an app:
+
+```js
+import '@wral/hsot-data/define';           // defines all five elements
+// or
+import { HsotStandings } from '@wral/hsot-data';
+```

package/dist/define.mjs

@@ -0,0 +1,18 @@
+import { H as e, b as n, a as c, d as i, c as a } from "./hsot-boxscore-BYV62gYv.js";
+const r = {
+  "hsot-scores": a,
+  "hsot-standings": i,
+  "hsot-rankings": c,
+  "hsot-school": n,
+  "hsot-boxscore": e
+};
+function f() {
+  const s = globalThis?.customElements;
+  if (s)
+    for (const [o, t] of Object.entries(r))
+      s.get(o) || s.define(o, t);
+}
+typeof window < "u" && globalThis.customElements && f();
+export {
+  f as defineAll
+};