@finbheara/archive-client 0.26.0 → 0.28.0

package/README.md

@@ -661,8 +661,8 @@ o.feises;    // [{ occurrence_id, occurrence_ids, name_printed, date_lo, date_hi
              //    feis_brand_id, feis_instance_id, series_basis, brand_candidates, captured_id, state }]
 const f = await rel.upcoming.fields({ state: "pending" });  // state, feis, field_id, from, to
 f.fields;    // [{ field_id, feis_id, source, host_id, competition_code, count_only, occurrence_id,
-             //    name_printed, date_lo, date_hi, year, feis_brand_id, comp, state,
-             //    results_competitions, results_feis_ids, version, versions, captured_date, sha256,
+             //    name_printed, date_lo, date_hi, year, feis_brand_id, comp, state, flags,
+             //    results_competitions, results_feis_ids, held_out, version, versions, captured_date, sha256,
              //    limits, entrants, stated_rows, printed_total }]
 const e = await rel.upcoming.entrants({ field_id: "fweb:ABC26/101" });  // version: an older capture
 e.entrants;  // [{ name_printed, school_printed, school_id, yob, arm, candidates, flags,
@@ -677,18 +677,25 @@ says how; `none` leaves `feis_brand_id` null, the unjoined ones).
 A FIELD is one competition a competitor list names, `<feis_id>/<code>`, the same id on every cut. A later capture of the host is a new `version`
 (a capture id; `versions` lists them), never a new field. `state` says how it stands on the cut:
 `pending` (on the list), `results` (the release holds its results, `results_competitions` the
-join), `passed` (its first day is before the cut's day and no result is held) or `withdrawn` (the
-host's newest capture no longer lists it). `comp` is the competition reading of its code (`arm`,
-`level`, `feis_level`, `age`, `population`, `kind`, `title`, `why`), null on a count list.
+join), `held-out` (the results exist and the release holds them out: the platform door's knockout
+lists the competition, a team, music or arts event, and `held_out` names each competition with the
+knockout's reason, so there is nothing to score against), `passed` (its first day is before the
+cut's day and no result is held) or `withdrawn` (the host's newest capture no longer lists it). `comp` is the competition reading of its code (`arm`,
+`level`, `feis_level`, `age`, `population`, `kind`, `title`, `why`), null on a count list. A
+QuickFeis registrant list's field reads it off the list's own by-event label (`source`
+`registration-list`, `title` the label as printed), and `flags` holds the cross-check of the
+list's two documents (`no-event-section`, `event-rows-differ`); `[]` on any other field.
 `limits` names what the capture cannot show (`registered-not-danced`, `paid-in-full-only`, ...).
 
 `upcoming.entrants` answers a field's rows in one version, its current one by default. A
 registrant carries the resolver's `arm` and `candidates`, NEVER A `dancer_id`: a list shows who
 registered, not who danced, and a `unique` row's one candidate is read with its `flags`
-(`initial-only`: a FeisWeb print is a surname and an initial). `count_only` marks a field read from
-a registration-by-school page of the corpus `entrants/` part: its rows are schools' counts
-(`level_counts`), with no names. A QuickFeis registrant list (`transcripts/*.registrationlist.jsonl`)
-is not read into these tables yet. An unknown field or version answers no rows and says
+(`initial-only`: a FeisWeb print is a surname and an initial; `name-hidden`: QuickFeis printed
+`(Name Hidden)`, so the row has no name and no answer). A QuickFeis registrant list
+(`transcripts/*.registrationlist.jsonl`) is one field per printed code, each registrant a row as
+printed. `count_only` marks a field read from an older registration-by-school page of
+the corpus `entrants/` part: its rows are schools' counts (`level_counts`), with no names, and a
+host with a registrant list publishes no such field. An unknown field or version answers no rows and says
 why. On a release without the tables each call refuses by name.
 
 ## Teachers and adjudicators

package/dist/chunks/{index-8mwx3n9j.js → index-5rnb63kw.js}

@@ -3950,7 +3950,13 @@ function needsRelease2(tag, c) {
   return new Error(`archive-client: ${tag} is too old for ${c.feature} (${c.calls}): it lacks ${c.missing.join(", ")}. Open a release of cut ${c.since} or later`);
 }
 
-var FIELD_STATES2 = ["pending", "results", "passed", "withdrawn"];
+var FIELD_STATES2 = [
+  "pending",
+  "results",
+  "held-out",
+  "passed",
+  "withdrawn"
+];
 var json = (s, empty) => typeof s === "string" && s !== "" ? JSON.parse(s) : empty;
 function fieldOf(r) {
   const countOnly = r.count_only === 1;
@@ -3979,8 +3985,10 @@ function fieldOf(r) {
       why: r.comp_why ?? null
     },
     state: r.state,
+    flags: json(r.flags, []),
     results_competitions: json(r.results_competitions, []),
     results_feis_ids: json(r.results_feis_ids, []),
+    held_out: json(r.held_out, []),
     version: r.version,
     versions: json(r.versions, []),
     captured_date: r.captured_date,

package/dist/cli.js

@@ -21,7 +21,7 @@ import {
   latestCheck2,
   within,
   staleWarning2
-} from "./chunks/index-8mwx3n9j.js";
+} from "./chunks/index-5rnb63kw.js";
 import"./chunks/index-hghdy980.js";
 
 var USAGE_HEADER = "usage: idq <verb> [--cache <dir>] [--repo <owner/name>] [--json] [--live]";
@@ -374,7 +374,7 @@ var VERBS = [
     ],
     bool: ["--feises"],
     usage: [
-      "  upcoming [--release <spec>] [--state pending,results,passed,withdrawn] [--feis <id>]",
+      "  upcoming [--release <spec>] [--state pending,results,held-out,passed,withdrawn] [--feis <id>]",
       "           [--from <date>] [--to <date>]",
       "                                    the competitor lists' fields, each with its state, version",
       "                                    and competition reading; --feis a feis, series or",

package/dist/index.js

@@ -74,7 +74,7 @@ import {
   readLatestCheck2,
   latestCheck2,
   staleWarning2
-} from "./chunks/index-8mwx3n9j.js";
+} from "./chunks/index-5rnb63kw.js";
 import {
   cacheRoot2,
   repoOf2

package/dist/types/index.d.ts

@@ -24,5 +24,5 @@ export { type Capability, FEATURES, type Feature, type SchemaProbe, capabilityOf
 export { type EntryRow, type StreamQuery, type StreamRow, type StreamScope, entryRank, } from "./stream.js";
 export { type FeisPanelSeat, FeisPanelFinder, PanelFinder, type PanelSeat, type RegisterRow, type TabAnswer, TabFinder, type TabQuery, type TabRow, type TabStreamQuery, } from "./tabs.js";
 export { EventFinder, type EventYear, type EventYearQuery, type ResultRoster, type RosterMember, type RosterTeam, TeamFinder, type TeamResult, } from "./teams.js";
-export { type EntrantCandidate, FIELD_STATES, type FieldComp, type FieldState, type UpcomingEntrant, type UpcomingEntrantAnswer, type UpcomingEntrantQuery, type UpcomingFeis, type UpcomingFeisAnswer, type UpcomingFeisQuery, type UpcomingFeisState, type UpcomingField, type UpcomingFieldAnswer, type UpcomingFieldQuery, UpcomingFinder, type UpcomingHost, } from "./upcoming.js";
+export { type EntrantCandidate, FIELD_STATES, type FieldComp, type FieldState, type HeldOut, type UpcomingEntrant, type UpcomingEntrantAnswer, type UpcomingEntrantQuery, type UpcomingFeis, type UpcomingFeisAnswer, type UpcomingFeisQuery, type UpcomingFeisState, type UpcomingField, type UpcomingFieldAnswer, type UpcomingFieldQuery, UpcomingFinder, type UpcomingHost, } from "./upcoming.js";
 export { ARCHIVE_TAG, type ArchiveTag, type ReleaseSpec, compareTagsNewestFirst, cutOf, parseArchiveTag, parseReleaseSpec, pickTag, renderArchiveTag, } from "./tag.js";

package/dist/types/upcoming.d.ts

@@ -1,6 +1,10 @@
 import type { Release } from "./release.js";
-export type FieldState = "pending" | "results" | "passed" | "withdrawn";
+export type FieldState = "pending" | "results" | "held-out" | "passed" | "withdrawn";
 export declare const FIELD_STATES: readonly FieldState[];
+export interface HeldOut {
+    competition: string;
+    reason: string;
+}
 export type UpcomingFeisState = "upcoming" | "no-results";
 export interface UpcomingHost {
     source: string;
@@ -53,8 +57,10 @@ export interface UpcomingField {
     feis_brand_id: string | null;
     comp: FieldComp | null;
     state: FieldState;
+    flags: string[];
     results_competitions: string[];
     results_feis_ids: string[];
+    held_out: HeldOut[];
     version: string;
     versions: string[];
     captured_date: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@finbheara/archive-client",
-	"version": "0.26.0",
+	"version": "0.28.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",
@@ -44,7 +44,7 @@
 		"prepublishOnly": "bun scripts/build.ts && bun ../../tools/checks/archive-client-tarball.ts"
 	},
 	"dependencies": {
-		"@finbheara/domain": "0.57.2",
+		"@finbheara/domain": "0.58.0",
 		"@finbheara/names": "0.30.0",
 		"hyparquet": "1.31.2"
 	},