@finbheara/archive-client 0.45.0 → 0.47.0

package/README.md

@@ -95,6 +95,7 @@ c.features;   // [{ feature: "dancers", state: "full" | "missing", missing: [...
 | `dancers.years` | `dancers.years` | 245 |
 | `results.stream.competitors_printed`, `majors.stream.competitors_printed` | the `competitors_printed` a streamed row carries (the competed count the page printed); absent, never refused, without it | 345 |
 | `results.attach_basis`, `majors.attach_basis` | the `attach_basis` a row of `results.query`, `majors.results`, `results.stream` and `results.entries` carries (how its `dancer_id` was answered, or why not); absent, never refused, without it | 345 |
+| `results.major`, `majors.major` | the `major` a row of `results.stream` and `results.entries` carries (1 where its competition is a main event of a T1-T3 event, exactly the rows `majors.sqlite` holds); absent without it, and the stream filter `major` is refused by name without it | 345 |
 | `dancers.records.birth_consistency`, `dancers.years.birth_consistency` | the `birth_consistency` (0-100, floored: the percent of the dancer's, or the dancer-year's, readable rows that fit the birth window) and its denominator `birth_consistency_rows` a record of `dancers.records` and a dancer-year of `dancers.years` carry; absent, never refused, without it | 345 |
 | `dancers.records.birth_deadband`, `dancers.years.birth_deadband` | the `birth_deadband_rows` a record of `dancers.records` and a dancer-year of `dancers.years` carry (the readable rows a one-year dance-up alone keeps off the birth window, outside `birth_consistency` and its denominator); absent, never refused, without it | 345 |
 | `dancers.years.printed` | the `printed_regions` a dancer-year of `dancers.years` carries (every region the year printed, where `region` picks one); absent, never refused, without it | 341 |
@@ -643,7 +644,7 @@ THE COMPETITION FIELDS, where the release carries them (`rel.capability("results
 | `dance` | the competition's one dance as the release reads it (`reel`), null where it reads none |
 | `recalled_only` | true where the page printed the recalled dancers only |
 | `comp_flags` | what the page printed about itself, int-packed, one bit a flag (bit 10: recalled only). The release's `DATA-DICTIONARY.md` carries the register of every bit, and a published bit never moves |
-| `competitors_basis` | what `competitors` stands on: `printed` (the page printed a competed count), `counted` (the page printed the whole field, its cards counted), `entered` or `registered` (only the top was printed: the page's entered or registered count), `estimated` (a majors sheet with no count that does not show its whole field: the recall rule over a recall-only sheet (twice the recalled, plus or minus 1, or the recalled where fewer than 10), else the dancers it printed, a FLOOR; never a count, so leave it out where a real count is needed), null where there is no number |
+| `competitors_basis` | what `competitors` stands on: `printed` (the page printed a competed count), `counted` (the page printed the whole field, its cards counted), `net-entered` (FeisWeb: the entered count less the withdrawn one, who danced), `awards` (FeisWeb: the fewest dancers its `Awards To Top N Finishers ( p% )` line is a share of, who danced), `entered` or `registered` (only the top was printed: the page's entered or registered count, a REGISTRATION figure holding the no-shows), `estimated` (a majors sheet with no count that does not show its whole field: the recall rule over a recall-only sheet (twice the recalled, plus or minus 1, or the recalled where fewer than 10), else the dancers it printed, a FLOOR; never a count, so leave it out where a real count is needed), null where there is no number |
 
 A release without them streams every row with the six fields ABSENT, never null.
 
@@ -651,6 +652,8 @@ A release without them streams every row with the six fields ABSENT, never null.
 
 `attach_basis` (feature `results.attach_basis`, `majors.attach_basis` for scope `majors` and `rel.majors.results`) says how a row's `dancer_id` was answered, or why it was not, in one integer: `attach_basis & 63` is the feis attach's outcome for the row's address (`0` on a majors row, `1` a platform row it carded no card for, else attached how or the gate that refused it), `attach_basis & ~63` the bits of where the id came from (none where `dancer_id` is null). `unpackAttachBasis(n)` decodes it, `{ outcome: "birth-window", via: ["feis-local"] }`, off the register `ATTACH_OUTCOMES` and `ATTACH_VIA` the package exports, and the release's `DATA-DICTIONARY.md` says what each value means. `rel.results.query` and `rel.majors.results` rows carry it too. A release without it returns the field ABSENT.
 
+`major` (feature `results.major`, `majors.major` for scope `majors`) is 1 where the row's competition is a MAJOR'S MAIN EVENT: a solo championship (open or adult) or an either/or traditional set at a T1-T3 event, the competition a dancer came to the major for. A grade, a preliminary competition (a prelim-only one, or a prelim re-ranking of the open's field), a special, a traditional set co-entered with the championship, a mini championship beside its age group's full one and every feis row are 0. `majors.sqlite` holds exactly the 1s, so a reader of the full `results` set filters `rel.results.stream({ scope: "all", major: true })` to read what the majors stream reads. `tier` stays the event's. A release without the column returns the field absent and refuses the `major` filter by name (`needsRelease`).
+
 THE COMPETITION'S KEY is `competition` (`<event-year>.<comp>` at a major, `<platform>:<host>.<comp>`
 at a feis), which holds across releases. Inside one release `(file, competition_line)` is exact: a
 competition captured twice (two files of one platform) carries one `competition` in both and two

package/dist/chunks/{index-kfc7hz90.js → index-f9hvd661.js}

@@ -558,6 +558,18 @@ var FEATURES2 = [
     since: 345,
     calls: "the `attach_basis` a row of results.query, results.stream and results.entries carries (how its dancer_id was answered, or why not): absent, never refused, on a release without it"
   },
+  {
+    feature: "results.major",
+    needs: ["results:results.major", "results:competitions.major"],
+    since: 345,
+    calls: "the `major` a row of results.stream and results.entries carries (1 where its competition is a main event of a T1-T3 event, the rows majors.sqlite holds): absent on a release without it; the stream filter `major` is refused on a release without it"
+  },
+  {
+    feature: "majors.major",
+    needs: ["majors:results.major", "majors:competitions.major"],
+    since: 345,
+    calls: "the same on a row of results.stream and results.entries (scope majors)"
+  },
   {
     feature: "majors.attach_basis",
     needs: ["majors:results.attach_basis"],
@@ -1501,8 +1513,10 @@ function streamSql(q, shape = {}) {
   }
   if (q.primary === true)
     where.push("(r.primary_source IS NULL OR r.primary_source = '')");
+  if (q.major !== undefined)
+    where.push(q.major ? "r.major = 1" : "r.major = 0");
   return {
-    sql: `SELECT ${COLUMNS}${shape.competition === true ? COMPETITION_COLUMNS : ""}${shape.competitorsPrinted === true ? ", c.competitors_printed AS competitors_printed" : ""}${shape.attachBasis === true ? ", r.attach_basis AS attach_basis" : ""} FROM results r JOIN competitions c ON c.file = r.file AND c.line = r.competition_line${where.length === 0 ? "" : ` WHERE ${where.join(" AND ")}`} ORDER BY r.file, r.line`,
+    sql: `SELECT ${COLUMNS}${shape.competition === true ? COMPETITION_COLUMNS : ""}${shape.competitorsPrinted === true ? ", c.competitors_printed AS competitors_printed" : ""}${shape.attachBasis === true ? ", r.attach_basis AS attach_basis" : ""}${shape.major === true ? ", r.major AS major" : ""} FROM results r JOIN competitions c ON c.file = r.file AND c.line = r.competition_line${where.length === 0 ? "" : ` WHERE ${where.join(" AND ")}`} ORDER BY r.file, r.line`,
     args
   };
 }
@@ -1647,7 +1661,13 @@ class ResultFinder2 {
     const competition = (await this.rel.capability(`${db}.stream.competition`)).state === "full";
     const competitorsPrinted = (await this.rel.capability(`${db}.stream.competitors_printed`)).state === "full";
     const attachBasis = (await this.rel.capability(`${db}.attach_basis`)).state === "full";
-    return { db: this.rel.db(db), shape: { competition, competitorsPrinted, attachBasis } };
+    if (q.major !== undefined)
+      await this.rel.require(`${db}.major`);
+    const major = (await this.rel.capability(`${db}.major`)).state === "full";
+    return {
+      db: this.rel.db(db),
+      shape: { competition, competitorsPrinted, attachBasis, major }
+    };
   }
   async* stream(q) {
     const { db, shape } = await this.streamDb(q);

package/dist/cli.js

@@ -23,7 +23,7 @@ import {
   staleWarning2,
   progressMode2,
   progressRenderer2
-} from "./chunks/index-kfc7hz90.js";
+} from "./chunks/index-f9hvd661.js";
 import"./chunks/index-hghdy980.js";
 
 var USAGE_HEADER = "usage: idq <verb> [--cache <dir>] [--repo <owner/name>] [--json] [--live] [--progress tty|plain|none]";

package/dist/index.js

@@ -85,7 +85,7 @@ import {
   PROGRESS_MODES2,
   progressMode2,
   progressRenderer2
-} from "./chunks/index-kfc7hz90.js";
+} from "./chunks/index-f9hvd661.js";
 import {
   cacheRoot2,
   repoOf2

package/dist/types/stream.d.ts

@@ -10,6 +10,7 @@ export interface StreamQuery {
     dancer_id?: number[];
     school_id?: string;
     primary?: boolean;
+    major?: boolean;
 }
 export interface StreamCompetition {
     competition_line: number;
@@ -58,6 +59,7 @@ export interface StreamRow extends Partial<StreamCompetition> {
     dancer_id: number | null;
     dancer_scope: "per-release" | "stable" | null;
     attach_basis?: number;
+    major?: 0 | 1;
     yob: number | null;
     yob_printed: string | null;
     points_printed: string | null;
@@ -74,6 +76,7 @@ export interface StreamShape {
     competition?: boolean;
     competitorsPrinted?: boolean;
     attachBasis?: boolean;
+    major?: boolean;
 }
 export declare const scopeDb: (s: StreamScope) => "majors" | "results";
 export declare function streamSql(q: StreamQuery, shape?: StreamShape): {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@finbheara/archive-client",
-	"version": "0.45.0",
+	"version": "0.47.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.58.0",
+		"@finbheara/domain": "0.59.0",
 		"@finbheara/names": "0.30.0",
 		"hyparquet": "1.31.2"
 	},