@finbheara/archive-client 0.5.0 → 0.6.0

package/README.md

@@ -20,7 +20,7 @@ type declarations (`.d.ts`), so a TypeScript project needs Bun's types (`"types"
 `bunx idq <verb>`.
 
 The version is 0.x while the API settles: a minor bump may break, so pin a minor
-(`"@finbheara/archive-client": "0.5.x"`).
+(`"@finbheara/archive-client": "0.6.x"`).
 
 ## Configuration
 
@@ -91,6 +91,7 @@ c.features;   // [{ feature: "dancers", state: "full" | "missing", missing: [...
 | `dancers.years` | `dancers.years` | 245 |
 | `majors.tabs` | `majors.tabulated` | 215 |
 | `teams` | `teams.results`, `teams.rosters`, `teams.resultRosters` | 260 |
+| `teams.fields` | the fields `teams.results` (`age`, `gender`, `printed_status`) and `teams.rosters` (`dance`, `school_printed_as_of`, a member's `gender`) carry; absent, never refused, without it | 266 |
 | `events` | `events.years` | 260 |
 
 A spec is `pinned` (the default: the user-local pin, else the latest), `latest`, a cut number
@@ -301,8 +302,9 @@ competition beside its own fields: `competition`, `event`, `year`, `tier`, `comp
 `feis_date_hi`. Its own: `address`, `section`, `card`, `place`, `place_printed`, `tie`,
 `relative_place`, `atts`, `withdrawn`, `qualifier`, `name_printed`, `name`, `school_printed`,
 `school_loc`, `school_id`, `dancer_id`, `dancer_scope`, `yob`, `yob_printed`, `points_printed`,
-`platform_dancer_id`, `primary_source`. Rows come in the release's own order, a competition's
-rows together.
+`platform_dancer_id`, `primary_source`, and its key in the release, `file` and `line` (one
+`(file, line)` is one row, where an `address` may carry one row per section). Rows come in the
+release's own order, a competition's rows together.
 
 The scopes: `majors` reads the majors (tiers T1 to T3), `transcribed` the transcribed rows of
 every tier, `platform` every row a results platform published, `all` every row.
@@ -328,11 +330,12 @@ await rel.majors.tabulated({ min_true_round: 3 });     // the majors addresses m
 
 ```ts
 const r = await rel.teams.results({ event: "<event>", year: 2024 });
-r.results;   // [{ address, competition, event, year, comp_no, title, category, hands, letter, label,
-             //    school_printed, school_id, place, place_printed, tie, competitors, atts, ... }]
+r.results;   // [{ address, competition, event, year, comp_no, title, category, hands, age, gender,
+             //    letter, label, school_printed, school_id, place, place_printed, printed_status, tie,
+             //    competitors, atts, ... }]
 const t = await rel.teams.rosters({ event: "<event>", year: 2024 });
 t.teams;     // [{ team, kind, event, year, comp_no, title, team_index, seq, school_id, school_printed,
-             //    members: [{ seq, name_printed, name, yob, dancer_id, dancer_scope }] }]
+             //    school_printed_as_of, dance, members: [{ seq, name_printed, name, yob, gender, dancer_id, dancer_scope }] }]
 const j = await rel.teams.resultRosters({ event: "<event>", year: 2024 });
 j.joins;     // [{ team, result_address, join_kind, via_split, roster_index, result_letter, ... }]
 const e = await rel.events.years({ event: "<event>" });
@@ -347,7 +350,21 @@ roster team met the results (`exact`, `card`, `branch`) or why it did not (`no-r
 `no-school`, `no-roster`, `multi-team-unjoined`), and `result_address` is null where none joined.
 An event-year's dates are a window (`date_lo`, `date_hi`) with how fine it is (`resolution`:
 `day`, `month`, `calendar`) and what it is read from (`source`), and `place` is a place-tree node
-where the release knows one. A field the source left empty is null. The rows are read once per
+where the release knows one. A team result's `age` and `gender` are the competition's band and sex
+as the release reads them, `printed_status` the row's printed status cell verbatim. A roster
+team's `school_id` is its members' own school that year. Its `school_printed` is the school a
+registration system held for it on `school_printed_as_of`, often years later, so a rename or a move
+since shows there and it says nothing about the school that year. Its `dance` is the dance it was
+entered for, and a member's `gender` is printed only as `M`:
+the source withholds every other print, so null says nothing about a dancer's sex. A field the
+source left empty is null.
+
+THOSE NEWER FIELDS ARE ABSENT, NEVER NULL, ON A RELEASE THAT DOES NOT CARRY THEM: a team result's
+`age`, `gender`, `printed_status`, a roster team's `school_printed_as_of`, `dance` and a member's
+`gender` (feature `teams.fields`, see the table above). Absent means "this release does not carry it", null
+means the release carries the field and has no value. `teams.results` and `teams.rosters` answer on
+every release the `teams` feature names, and `(await rel.capability("teams.fields")).state` says which shape
+a release has. The rows are read once per
 release into the `teams` and `events` indexes.
 
 ## Teachers and adjudicators

package/dist/chunks/{index-8gna56w2.js → index-gy5xye67.js}

@@ -135,7 +135,7 @@ var COLUMNS = `r.address AS address, r.competition AS competition, c.event AS ev
 	r.school_loc AS school_loc, r.school_id AS school_id, r.dancer_id AS dancer_id, r.yob AS yob,
 	r.yob_printed AS yob_printed, r.points_printed AS points_printed,
 	r.platform_dancer_id AS platform_dancer_id, r.primary_source AS primary_source,
-	r.file AS file`;
+	r.file AS file, r.line AS line`;
 var TRANSCRIBED = "('transcript', 'manifested')";
 var scopeDb = (s) => s === "majors" ? "majors" : "results";
 function streamSql(q) {
@@ -191,7 +191,7 @@ function feisDates(db) {
 }
 var text = (v) => v === null || v === "" ? null : v;
 function rowOf(r, dates) {
-  const { file: _file, atts, withdrawn, ...rest } = r;
+  const { atts, withdrawn, ...rest } = r;
   const d = dates.get(r.event);
   return {
     ...rest,
@@ -1834,12 +1834,13 @@ CREATE TABLE event_year(event_year TEXT PRIMARY KEY, event TEXT NOT NULL, year I
 CREATE TABLE result(address TEXT PRIMARY KEY, competition TEXT, event TEXT, year INTEGER,
 	card TEXT, comp_no TEXT, title TEXT, category TEXT, hands INTEGER, letter TEXT, label TEXT,
 	name_printed TEXT, school_printed TEXT, school_loc TEXT, school_id TEXT, place INTEGER,
-	place_printed TEXT, tie INTEGER, competitors INTEGER, atts TEXT, ord INTEGER);
+	place_printed TEXT, tie INTEGER, competitors INTEGER, atts TEXT, age TEXT, gender TEXT,
+	printed_status TEXT, ord INTEGER);
 CREATE TABLE roster_team(team TEXT PRIMARY KEY, kind TEXT, event TEXT, year INTEGER,
 	comp_no TEXT, title TEXT, team_index TEXT, seq INTEGER, school_id TEXT, school_printed TEXT,
-	ord INTEGER);
+	dance TEXT, school_printed_as_of TEXT, ord INTEGER);
 CREATE TABLE roster_member(team TEXT, seq INTEGER, name_printed TEXT, name TEXT, yob INTEGER,
-	dancer_id INTEGER, ord INTEGER);
+	dancer_id INTEGER, gender TEXT, ord INTEGER);
 CREATE TABLE result_roster(team TEXT, event TEXT, year INTEGER, comp_no TEXT, school_id TEXT,
 	result_address TEXT, join_kind TEXT, via_split INTEGER, roster_teams INTEGER,
 	result_teams INTEGER, roster_index TEXT, result_letter TEXT, ord INTEGER);
@@ -1863,7 +1864,7 @@ async function readTables(rel, tables) {
 }
 var teamsIndex = {
   name: "teams",
-  version: "1",
+  version: "2",
   inputs: TEAM_TABLES.map(tableAsset),
   says: "the team results, the roster teams with their members, and how they join, by event-year",
   load: (rel) => readTables(rel, TEAM_TABLES),
@@ -1881,18 +1882,18 @@ var teamsIndex = {
       ey.set(k, { event, year });
       putEy.run(k, event, year);
     }
-    const putR = out.prepare("INSERT OR IGNORE INTO result VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
+    const putR = out.prepare("INSERT OR IGNORE INTO result VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
     let ord = 0;
     for (const r of t.team_results)
-      putR.run(str(r.address), str(r.slug), str(r.event), num(r.year), str(r.card), str(r.comp_no), str(r.title), str(r.category), num(r.hands), str(r.letter), str(r.label), str(r.name_printed), str(r.school_printed), str(r.school_loc), str(r.school_id), num(r.place), str(r.place_printed), num(r.tie), num(r.competitors), JSON.stringify(strs(r.atts)), ord++);
-    const putT = out.prepare("INSERT OR IGNORE INTO roster_team VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
+      putR.run(str(r.address), str(r.slug), str(r.event), num(r.year), str(r.card), str(r.comp_no), str(r.title), str(r.category), num(r.hands), str(r.letter), str(r.label), str(r.name_printed), str(r.school_printed), str(r.school_loc), str(r.school_id), num(r.place), str(r.place_printed), num(r.tie), num(r.competitors), JSON.stringify(strs(r.atts)), str(r.age), str(r.gender), JSON.stringify(strs(r.printed_status)), ord++);
+    const putT = out.prepare("INSERT OR IGNORE INTO roster_team VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
     for (const r of t.roster_teams) {
       const e = ey.get(str(r.event_year) ?? "");
-      putT.run(str(r.team), str(r.kind), e?.event ?? null, num(r.year) ?? e?.year ?? null, str(r.comp_no), str(r.title), str(r.team_index), num(r.seq), str(r.school_id), str(r.school_print_materialized), ord++);
+      putT.run(str(r.team), str(r.kind), e?.event ?? null, num(r.year) ?? e?.year ?? null, str(r.comp_no), str(r.title), str(r.team_index), num(r.seq), str(r.school_id), str(r.school_print_materialized), str(r.dance), str(r.school_print_as_of), ord++);
     }
-    const putM = out.prepare("INSERT INTO roster_member VALUES (?, ?, ?, ?, ?, ?, ?)");
+    const putM = out.prepare("INSERT INTO roster_member VALUES (?, ?, ?, ?, ?, ?, ?, ?)");
     for (const r of t.roster_members)
-      putM.run(str(r.team), num(r.seq), typeof r.name_printed === "string" ? r.name_printed : "", str(r.name), num(r.yob), num(r.dancer_id), ord++);
+      putM.run(str(r.team), num(r.seq), typeof r.name_printed === "string" ? r.name_printed : "", str(r.name), num(r.yob), num(r.dancer_id), str(r.gender), ord++);
     const putJ = out.prepare("INSERT INTO result_roster VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
     for (const r of t.team_result_rosters) {
       const e = ey.get(str(r.event_year) ?? "");
@@ -1947,27 +1948,37 @@ class TeamFinder2 {
   db() {
     return this.rel.indexDb("teams");
   }
+  async hasFields() {
+    return (await this.rel.capability("teams.fields")).state === "full";
+  }
   async results(q = {}) {
     const db = await this.db();
+    const fields = await this.hasFields();
     const w = whereOf(q);
     const rows = db.query(`SELECT address, competition, event, year, card, comp_no, title, category, hands, letter,
 				        label, name_printed, school_printed, school_loc, school_id, place, place_printed, tie,
-				        competitors, atts
+				        competitors, atts${fields ? ", age, gender, printed_status" : ""}
 				 FROM result${w.sql} ORDER BY year, event, competition, place IS NULL, place, ord`).all(...w.args);
     return {
       tag: this.rel.tag,
       asked: q,
-      results: rows.map((r) => ({ ...r, atts: JSON.parse(r.atts) }))
+      results: rows.map(({ printed_status, ...r }) => ({
+        ...r,
+        atts: JSON.parse(r.atts),
+        ...printed_status === undefined ? {} : { printed_status: JSON.parse(printed_status ?? "[]") }
+      }))
     };
   }
   async rosters(q = {}) {
     const db = await this.db();
+    const fields = await this.hasFields();
     const w = whereOf(q, "t.");
     const teams = db.query(`SELECT team, kind, event, year, comp_no, title, team_index, seq, school_id, school_printed
+				        ${fields ? ", school_printed_as_of, dance" : ""}
 				 FROM roster_team t${w.sql} ORDER BY year, event, ord`).all(...w.args);
     const members = new Map;
     for (const m of db.query(`SELECT m.team AS team, m.seq AS seq, m.name_printed AS name_printed, m.name AS name,
-				        m.yob AS yob, m.dancer_id AS dancer_id
+				        m.yob AS yob, m.dancer_id AS dancer_id${fields ? ", m.gender AS gender" : ""}
 				 FROM roster_member m JOIN roster_team t ON t.team = m.team${w.sql}
 				 ORDER BY m.team, m.seq, m.ord`).all(...w.args)) {
       const { team, ...rest } = m;
@@ -2624,6 +2635,19 @@ var FEATURES2 = [
     since: 260,
     calls: "teams.results, teams.rosters, teams.resultRosters (the teams index)"
   },
+  {
+    feature: "teams.fields",
+    needs: [
+      "table:team_results.age",
+      "table:team_results.gender",
+      "table:team_results.printed_status",
+      "table:roster_teams.dance",
+      "table:roster_teams.school_print_as_of",
+      "table:roster_members.gender"
+    ],
+    since: 266,
+    calls: "the fields teams.results (age, gender, printed_status) and teams.rosters (dance, school_printed_as_of, a member's gender) carry where present: absent, never refused, on a release without them"
+  },
   {
     feature: "events",
     needs: [

package/dist/cli.js

@@ -4,7 +4,7 @@ import {
   nameOrderOf,
   openRelease2,
   releases2
-} from "./chunks/index-8gna56w2.js";
+} from "./chunks/index-gy5xye67.js";
 import"./chunks/index-hne1wadw.js";
 import"./chunks/index-hghdy980.js";
 

package/dist/index.js

@@ -45,7 +45,7 @@ import {
   openCached2,
   ReleaseManager2,
   releases2
-} from "./chunks/index-8gna56w2.js";
+} from "./chunks/index-gy5xye67.js";
 import {
   cacheRoot2,
   repoOf2

package/dist/types/stream.d.ts

@@ -53,6 +53,8 @@ export interface StreamRow {
     points_printed: string | null;
     platform_dancer_id: string | null;
     primary_source: string | null;
+    file: string;
+    line: number;
 }
 export interface EntryRow extends StreamRow {
     recall_place: number | null;

package/dist/types/teams.d.ts

@@ -25,6 +25,9 @@ export interface TeamResult {
     tie: number | null;
     competitors: number | null;
     atts: string[];
+    age?: string | null;
+    gender?: string | null;
+    printed_status?: string[];
 }
 export interface RosterMember {
     seq: number;
@@ -33,6 +36,7 @@ export interface RosterMember {
     yob: number | null;
     dancer_id: number | null;
     dancer_scope: "per-release" | "stable" | null;
+    gender?: string | null;
 }
 export interface RosterTeam {
     team: string;
@@ -45,6 +49,8 @@ export interface RosterTeam {
     seq: number | null;
     school_id: string | null;
     school_printed: string | null;
+    school_printed_as_of?: string | null;
+    dance?: string | null;
     members: RosterMember[];
 }
 export interface ResultRoster {
@@ -78,6 +84,7 @@ export declare class TeamFinder {
     private readonly rel;
     constructor(rel: Release);
     private db;
+    private hasFields;
     results(q?: EventYearQuery): Promise<{
         tag: string;
         asked: EventYearQuery;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@finbheara/archive-client",
-	"version": "0.5.0",
+	"version": "0.6.0",
 	"description": "Open a versioned release of an Irish dance results archive: download, verify, decompress and cache it by tag, keep the cache, and resolve feises and schools against it",
 	"keywords": ["irish-dance", "results", "release", "cache", "sqlite"],
 	"license": "MIT",