@finbheara/archive-client 0.17.0 → 0.19.0

package/README.md

@@ -100,7 +100,10 @@ A spec is `pinned` (the default: the user-local pin, else the latest), `latest`,
 
 EVERY FILE IS CHECKED before it lands: the downloaded bytes against the host's own sha256 digest,
 and the content against the manifest (a database's decompressed bytes against
-`databases.<name>.sha256`, a parquet file against `parquet.files[<name>].sha256`). A mismatch
+`databases.<name>.sha256`, a side file's decompressed bytes against `sideFiles.<name>.sha256`, a
+parquet file against `parquet.files[<name>].sha256`). A side file the manifest names under
+`sideFiles` is published zstd'd (`<name>.zst`, or the `file` it states) and lands plain under its
+own name. A mismatch
 refuses and leaves nothing in place. A file nothing vouches for is kept and its receipt says so
 (`strict: true` refuses it). A database is decompressed in process, streamed, never through a
 `zstd` binary.
@@ -558,16 +561,22 @@ c.dance;      // "reel", "light-jig", "single-jig", "slip-jig", "treble-jig", "h
               // "treble-reel", "traditional-set", "set-dance", or null where the release names none
 c.from;       // { feis_ids: ["fweb:ABC25"], year: 2025 } where an earlier year answered
 c.check;      // "unchecked", or what the caller's `title` says about the earlier comp
-c.syllabus_source;  // "results": what the syllabus the answer read is read from
+c.syllabus_source;  // "syllabus-document" | "results": what the syllabus the answer read is read from
+c.candidates[0].syllabus_entry;  // the `syllabi` row the comp's number joined, or null
 await rel.comps.syllabus("fweb:ABC25");   // one feis-year's competitions, in printed order
 const syl = await rel.comps.syllabusFor("Ardvarna Spring", 2026);  // or a `feises.series` answer
 syl.year;     // the asked year where the release holds it, else its newest (syl.held, syl.why)
-syl.source;   // "results" (a syllabus document is a source of its own name, shipped by no release yet)
+syl.source;   // "syllabus-document" where every entry joins a `syllabi` row, else "results"
 syl.entries;  // the comps, syl.championships how many are championships, syl.note where none
 ```
 
-EVERY SYLLABUS SAYS WHAT IT IS READ FROM. Today that is the comps the release's result captures
-list (`results`): a comp the feis held whose results the platform did not tabulate is not in it.
+EVERY SYLLABUS SAYS WHAT IT IS READ FROM. The comps are the ones the release's result captures
+list: a comp the feis held whose results the platform did not tabulate is not in it. Where every
+comp an answer read joins a row of the release's `syllabi` table (the syllabus document the event
+published, the entry its number was read in), the answer says `syllabus-document`, else
+`results`. A release ships the syllabi the corpus transcribes, today the majors' and a few
+feiseanna's: a platform feis's answer says `results` until the corpus publishes that platform's
+syllabi, and a release older than the table says `results` everywhere.
 A feis whose platform tabulated its grades only has a syllabus with no championship, and
 `syllabusFor` says so (`note`), as does a `none` answer of `resolve` on such a series.
 

package/dist/chunks/{index-598c5w9d.js → index-gpaf165j.js}

@@ -27,6 +27,17 @@ function planAsset2(name, manifest) {
       contentSha256: manifest?.databases?.[name]?.sha256 ?? null
     };
   }
+  const side = manifest?.sideFiles?.[name];
+  if (side !== undefined) {
+    const file = side.file ?? `${name}.zst`;
+    return {
+      asked: name,
+      published: file === name ? [name] : [file, name],
+      local: name,
+      decompress: true,
+      contentSha256: side.sha256 ?? null
+    };
+  }
   return {
     asked: name,
     published: [name],
@@ -1811,7 +1822,7 @@ CREATE TABLE comp(
   code TEXT NOT NULL, code_fold TEXT NOT NULL, title TEXT, age TEXT, gender TEXT,
   feis_level INTEGER, round TEXT, platform TEXT NOT NULL, captures INTEGER NOT NULL,
   file TEXT NOT NULL, line INTEGER NOT NULL, age_source TEXT, age_printed TEXT,
-  gender_source TEXT, level_printed TEXT, dance_printed TEXT, dance TEXT
+  gender_source TEXT, level_printed TEXT, dance_printed TEXT, dance TEXT, syllabus_entry TEXT
 );
 `;
 var INDEXES2 = [
@@ -1829,7 +1840,7 @@ var OPTIONAL = [
 var fold = (code) => code.trim().toLowerCase();
 var compsIndex = {
   name: "comps",
-  version: "3",
+  version: "4",
   inputs: ["results"],
   says: "every competition by its feis and its own code, with its series and year",
   build(rel, out) {
@@ -1842,12 +1853,14 @@ var compsIndex = {
     const captures = new Map;
     for (const r of src.query("SELECT competition, count(*) AS n FROM competitions GROUP BY competition").all())
       captures.set(r.competition, r.n);
-    const put = out.prepare("INSERT OR IGNORE INTO comp VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
+    const put = out.prepare("INSERT OR IGNORE INTO comp VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");
     const has = new Set(src.query("PRAGMA table_info(competitions)").all().map((r) => r.name));
     const opt = (col) => has.has(col) ? col : `NULL AS ${col}`;
-    for (const c of src.query(`SELECT competition, event, year, comp_no, title, age, gender, feis_level, round, source, file, line, ${OPTIONAL.map(opt).join(", ")} FROM competitions WHERE comp_no IS NOT NULL AND trim(comp_no) != '' ORDER BY file, line`).iterate()) {
+    const syllabi = has.has("syllabus_entry") && src.query("SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = 'syllabi'").get() !== null;
+    const entry = syllabi ? "(SELECT s.entry FROM syllabi s WHERE s.entry = competitions.syllabus_entry) AS syllabus_entry" : "NULL AS syllabus_entry";
+    for (const c of src.query(`SELECT competition, event, year, comp_no, title, age, gender, feis_level, round, source, file, line, ${OPTIONAL.map(opt).join(", ")}, ${entry} FROM competitions WHERE comp_no IS NOT NULL AND trim(comp_no) != '' ORDER BY file, line`).iterate()) {
       const f = brand.get(c.event);
-      put.run(c.competition, c.event, f?.brand ?? null, c.year ?? f?.year ?? null, c.comp_no.trim(), fold(c.comp_no), c.title, c.age, c.gender, c.feis_level, c.round, c.source, captures.get(c.competition) ?? 1, c.file, c.line, c.age_source, c.age_printed, c.gender_source, c.level_printed, c.dance_printed, c.dance);
+      put.run(c.competition, c.event, f?.brand ?? null, c.year ?? f?.year ?? null, c.comp_no.trim(), fold(c.comp_no), c.title, c.age, c.gender, c.feis_level, c.round, c.source, captures.get(c.competition) ?? 1, c.file, c.line, c.age_source, c.age_printed, c.gender_source, c.level_printed, c.dance_printed, c.dance, c.syllabus_entry);
     }
     for (const s of INDEXES2)
       out.run(s);
@@ -1878,9 +1891,13 @@ function compOf(r, codes = []) {
     round,
     canonical: canonicalOf2(lv, r.age),
     platform: r.platform,
-    captures: r.captures
+    captures: r.captures,
+    syllabus_entry: r.syllabus_entry ?? null
   };
 }
+function syllabusSourceOf2(comps) {
+  return comps.length > 0 && comps.every((c) => c.syllabus_entry !== null) ? "syllabus-document" : "results";
+}
 function canonicalOf2(level, age) {
   if (level !== 600 && level !== 700 || age === null)
     return null;
@@ -2018,7 +2035,7 @@ class CompResolver2 {
         feis: place,
         year: read?.year ?? null,
         held: place.held,
-        source: read === null ? null : "results",
+        source: read === null ? null : syllabusSourceOf2(entries),
         feis_ids: read?.feis_ids ?? [],
         entries,
         years,
@@ -2068,7 +2085,7 @@ class CompResolver2 {
         title: u?.title ?? null,
         competition: u?.competition ?? null,
         candidates,
-        syllabus_source: source === null ? null : "results",
+        syllabus_source: source === null ? null : syllabusSourceOf2(candidates),
         ...more
       };
     };
@@ -3740,7 +3757,8 @@ class ReleaseManager2 {
         copyFileSync(src, raw);
       }
       const base = name.replace(/\.sqlite(\.zst)?$/, "");
-      const asked = base !== name && isDatabase(base) ? base : name;
+      const side = Object.entries(manifest.sideFiles ?? {}).find(([k, f]) => (f.file ?? `${k}.zst`) === name)?.[0];
+      const asked = base !== name && isDatabase(base) ? base : side ?? name;
       const plan = planAsset2(asked, manifest);
       const landed = await land(raw, { name, digest: null }, plan, join4(dest, plan.local), this.opts, log);
       receipt.files[plan.local] = landed;
@@ -3836,4 +3854,4 @@ function releases2(opts = {}) {
   return new ReleaseManager2(opts);
 }
 
-export { DATABASES2, planAsset2, sha256File2, unzstdTo2, NAME_LEVELS2, nameLevel2, NO_CALENDAR2, FeisFinder2, entryRank2, FEIS_LOCAL_ID_FLOOR2, ResultFinder2, MajorsFinder2, LINEAGE_FILE2, linksOfLineage2, releaseSchoolGraph2, readsSpanishNames2, SchoolResolver2, initialsOnly2, nameOrderOf, DancerResolver2, readPopulation2, canonicalOf2, CompResolver2, StaffFinder2, TeamFinder2, EventFinder2, defaultBuilders2, indexPath2, indexKey2, isCurrent2, buildIndex2, ensureIndex2, listIndexes2, readPin2, youngest2, dancerResolverOf2, RegistrationResolver2, ghRemote2, httpsRemote2, fallbackRemote2, setRemote2, columnsOf2, FEATURES2, capabilityOf2, needsRelease2, resolveTag2, Release2, openRelease2, openCached2, ReleaseManager2, releases2 };
+export { DATABASES2, planAsset2, sha256File2, unzstdTo2, NAME_LEVELS2, nameLevel2, NO_CALENDAR2, FeisFinder2, entryRank2, FEIS_LOCAL_ID_FLOOR2, ResultFinder2, MajorsFinder2, LINEAGE_FILE2, linksOfLineage2, releaseSchoolGraph2, readsSpanishNames2, SchoolResolver2, initialsOnly2, nameOrderOf, DancerResolver2, readPopulation2, syllabusSourceOf2, canonicalOf2, CompResolver2, StaffFinder2, TeamFinder2, EventFinder2, defaultBuilders2, indexPath2, indexKey2, isCurrent2, buildIndex2, ensureIndex2, listIndexes2, readPin2, youngest2, dancerResolverOf2, RegistrationResolver2, ghRemote2, httpsRemote2, fallbackRemote2, setRemote2, columnsOf2, FEATURES2, capabilityOf2, needsRelease2, resolveTag2, Release2, openRelease2, openCached2, ReleaseManager2, releases2 };

package/dist/cli.js

@@ -4,7 +4,7 @@ import {
   nameOrderOf,
   openRelease2,
   releases2
-} from "./chunks/index-598c5w9d.js";
+} from "./chunks/index-gpaf165j.js";
 import"./chunks/index-hne1wadw.js";
 import"./chunks/index-hghdy980.js";
 

package/dist/index.js

@@ -20,6 +20,7 @@ import {
   initialsOnly2,
   DancerResolver2,
   readPopulation2,
+  syllabusSourceOf2,
   canonicalOf2,
   CompResolver2,
   StaffFinder2,
@@ -50,7 +51,7 @@ import {
   openCached2,
   ReleaseManager2,
   releases2
-} from "./chunks/index-598c5w9d.js";
+} from "./chunks/index-gpaf165j.js";
 import {
   cacheRoot2,
   repoOf2
@@ -122,6 +123,7 @@ export {
   resolveTag2 as resolveTag,
   setRemote2 as setRemote,
   sha256File2 as sha256File,
+  syllabusSourceOf2 as syllabusSourceOf,
   unzstdTo2 as unzstdTo,
   youngest2 as youngest
 };

package/dist/types/assets.d.ts

@@ -14,6 +14,11 @@ export interface ReleaseManifest {
             table?: string;
         }>;
     };
+    sideFiles?: Record<string, {
+        file?: string;
+        bytes?: number;
+        sha256?: string;
+    }>;
     [k: string]: unknown;
 }
 export declare const DATABASES: readonly ["results", "majors"];

package/dist/types/comps.d.ts

@@ -25,6 +25,7 @@ export interface Comp {
     canonical: string | null;
     platform: string;
     captures: number;
+    syllabus_entry: string | null;
 }
 export interface CompQuery {
     feis: string;
@@ -118,8 +119,10 @@ interface CompRow {
     level_printed?: string | null;
     dance_printed?: string | null;
     dance?: string | null;
+    syllabus_entry?: string | null;
 }
 export declare function compOf(r: CompRow, codes?: readonly string[]): Comp;
+export declare function syllabusSourceOf(comps: readonly Comp[]): SyllabusSource;
 export declare function canonicalOf(level: number | null, age: string | null): string | null;
 export declare const CODE_READER: import("@finbheara/domain/code").CodeReader;
 export declare class CompResolver {

package/dist/types/index.d.ts

@@ -2,7 +2,7 @@ export { type AssetPlan, DATABASES, type DatabaseName, type LandedFile, type Rec
 export { sha256File, unzstdTo } from "./bytes.js";
 export { type AgeAsked, type AgeEvidence, type DancerAnswer, type DancerBulkRecord, type DancerCandidate, type DancerQuery, type DancerRecord, DancerResolver, type DancerRegion, type DancerSchool, type DancerSearchQuery, type DancerYear, type ExcludedCandidate, FEIS_LOCAL_ID_FLOOR, type InitialsRefuted, type Narrowing, initialsOnly, type OireachtasAsked, type PopulationEvidence, type RegionEvidence, type SchoolEvidence, readPopulation, } from "./dancers.js";
 export { NAME_LEVELS, type NameLevel, nameLevel } from "./dancers-names.js";
-export { type Comp, type CompAnswer, type CompDance, type CompKind, type CompQuery, CompResolver, type CompSource, type FeisPlace, type SyllabusAnswer, type SyllabusForAnswer, type SyllabusSource, type TitleCheck, canonicalOf, } from "./comps.js";
+export { type Comp, type CompAnswer, type CompDance, type CompKind, type CompQuery, CompResolver, type CompSource, type FeisPlace, type SyllabusAnswer, type SyllabusForAnswer, type SyllabusSource, type TitleCheck, canonicalOf, syllabusSourceOf, } from "./comps.js";
 export { type ClientOptions, cacheRoot, repoOf } from "./config.js";
 export { type Feis, type FeisAnswer, FeisFinder, type FeisQuery, NO_CALENDAR, type Series, type SeriesAnswer, type SeriesInstance, type SeriesNext, } from "./feises.js";
 export { type IndexBuilder, type IndexFile, buildIndex, defaultBuilders, ensureIndex, indexKey, indexPath, isCurrent, listIndexes, } from "./indexes.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@finbheara/archive-client",
-	"version": "0.17.0",
+	"version": "0.19.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",