@finbheara/archive-client 0.47.0 → 0.49.0

package/README.md

@@ -96,6 +96,8 @@ c.features;   // [{ feature: "dancers", state: "full" | "missing", missing: [...
 | `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 |
+| `results.relative_place_err`, `majors.relative_place_err` | the `relative_place_err` a row of `results.stream` and `results.entries` carries (how far below `relative_place` the true value may sit, 0 over an exact field); absent, never refused, without it | 350 |
+| `results.round_points_printed`, `majors.round_points_printed` | the `round_points_printed` a row of `results.stream` and `results.entries` carries (the per-round points a platform served, FeisFWD's, in its slot order, a slot served nothing in null); absent, never refused, without it | 350 |
 | `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 |
@@ -634,6 +636,13 @@ competition beside its own fields: `competition`, `event`, `year`, `tier`, `comp
 `(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 PER-ROUND POINTS A PLATFORM SERVED, where the release carries them
+(`rel.capability("results.round_points_printed")`): `round_points_printed`, FeisFWD's
+served round points in its own slot order, each value a string as served and a slot it served
+nothing in null (`[null, null, "275"]`). No slot is mapped onto a round and nothing is summed;
+null where no slot serves a value and on every other source's row. `points_printed` stays the one
+all-round figure a page prints.
+
 THE COMPETITION FIELDS, where the release carries them (`rel.capability("results.stream.competition")`,
 `"majors.stream.competition"` for scope `majors`), are on every row, null meaning no value:
 
@@ -644,7 +653,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), `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 |
+| `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), `placed` (the page's count fell below the last place of its placed run, so the field is that place: a dancer placed N-th proves N danced; a competed count), null where there is no number |
 
 A release without them streams every row with the six fields ABSENT, never null.
 
@@ -654,6 +663,8 @@ A release without them streams every row with the six fields ABSENT, never null.
 
 `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`).
 
+`relative_place` is read over the LARGEST field the release admits for the competition, so first place is 100 over any field and a recalled dancer's value stays high on a recall list, and `relative_place_err` (feature `results.relative_place_err`, `majors.relative_place_err`) says how far below it the true value may sit: the true value lies in `[relative_place - relative_place_err, relative_place]`. It is 0 where the field is a counted or printed competed count (and on a first place, and over a registration count every entrant of which printed), larger over a registration count (its no-shows), a recall list (the field its cards admit) or a feis page printing no count (a field of up to 150). A consumer wanting only exact values filters `relative_place_err = 0`. A release without it returns the field absent.
+
 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-f9hvd661.js → index-9wetmb53.js}

@@ -570,6 +570,30 @@ var FEATURES2 = [
     since: 345,
     calls: "the same on a row of results.stream and results.entries (scope majors)"
   },
+  {
+    feature: "results.relative_place_err",
+    needs: ["results:results.relative_place_err"],
+    since: 350,
+    calls: "the `relative_place_err` a row of results.stream and results.entries carries (how far below relative_place the true value may sit, 0 over an exact field): absent, never refused, on a release without it"
+  },
+  {
+    feature: "majors.relative_place_err",
+    needs: ["majors:results.relative_place_err"],
+    since: 350,
+    calls: "the same on a row of results.stream and results.entries (scope majors)"
+  },
+  {
+    feature: "results.round_points_printed",
+    needs: ["results:results.round_points_printed"],
+    since: 350,
+    calls: "the `round_points_printed` a row of results.stream and results.entries carries (the per-round points a platform served, FeisFWD's, in its slot order, a slot served nothing in null): absent, never refused, on a release without it"
+  },
+  {
+    feature: "majors.round_points_printed",
+    needs: ["majors:results.round_points_printed"],
+    since: 350,
+    calls: "the same on a row of results.stream and results.entries (scope majors)"
+  },
   {
     feature: "majors.attach_basis",
     needs: ["majors:results.attach_basis"],
@@ -1516,7 +1540,7 @@ function streamSql(q, shape = {}) {
   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" : ""}${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`,
+    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" : ""}${shape.relativePlaceErr === true ? ", r.relative_place_err AS relative_place_err" : ""}${shape.roundPoints === true ? ", r.round_points_printed AS round_points_printed" : ""} 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
   };
 }
@@ -1528,7 +1552,7 @@ function feisDates(db) {
 }
 var text = (v) => v === null || v === "" ? null : v;
 function rowOf(r, dates) {
-  const { atts, withdrawn, recalled_only, ...rest } = r;
+  const { atts, withdrawn, recalled_only, round_points_printed, ...rest } = r;
   const d = dates.get(r.event);
   return {
     ...rest,
@@ -1542,6 +1566,9 @@ function rowOf(r, dates) {
     feis_date_lo: d?.lo ?? null,
     feis_date_hi: d?.hi ?? null,
     atts: atts === "" ? [] : atts.split(","),
+    ...round_points_printed === undefined ? {} : {
+      round_points_printed: round_points_printed === null ? null : JSON.parse(round_points_printed)
+    },
     withdrawn: text(withdrawn),
     qualifier: text(rest.qualifier),
     primary_source: text(rest.primary_source),
@@ -1664,9 +1691,11 @@ class ResultFinder2 {
     if (q.major !== undefined)
       await this.rel.require(`${db}.major`);
     const major = (await this.rel.capability(`${db}.major`)).state === "full";
+    const relativePlaceErr = (await this.rel.capability(`${db}.relative_place_err`)).state === "full";
+    const roundPoints = (await this.rel.capability(`${db}.round_points_printed`)).state === "full";
     return {
       db: this.rel.db(db),
-      shape: { competition, competitorsPrinted, attachBasis, major }
+      shape: { competition, competitorsPrinted, attachBasis, major, relativePlaceErr, roundPoints }
     };
   }
   async* stream(q) {

package/dist/cli.js

@@ -23,7 +23,7 @@ import {
   staleWarning2,
   progressMode2,
   progressRenderer2
-} from "./chunks/index-f9hvd661.js";
+} from "./chunks/index-9wetmb53.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-f9hvd661.js";
+} from "./chunks/index-9wetmb53.js";
 import {
   cacheRoot2,
   repoOf2

package/dist/types/stream.d.ts

@@ -48,6 +48,7 @@ export interface StreamRow extends Partial<StreamCompetition> {
     place_printed: string;
     tie: number;
     relative_place: number | null;
+    relative_place_err?: number | null;
     atts: string[];
     withdrawn: string | null;
     qualifier: string | null;
@@ -63,6 +64,7 @@ export interface StreamRow extends Partial<StreamCompetition> {
     yob: number | null;
     yob_printed: string | null;
     points_printed: string | null;
+    round_points_printed?: (string | null)[] | null;
     platform_dancer_id: string | null;
     primary_source: string | null;
     file: string;
@@ -77,6 +79,8 @@ export interface StreamShape {
     competitorsPrinted?: boolean;
     attachBasis?: boolean;
     major?: boolean;
+    relativePlaceErr?: boolean;
+    roundPoints?: 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.47.0",
+	"version": "0.49.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",