@finbheara/archive-client 0.24.0 → 0.26.0

package/dist/types/tabs.d.ts

@@ -0,0 +1,132 @@
+import type { Release } from "./release.js";
+export interface TabRow {
+    address: string;
+    competition: string;
+    card: string;
+    line: number;
+    event: string | null;
+    year: number | null;
+    tier: string | null;
+    round: string;
+    true_round: number;
+    seat_index: number;
+    section: string;
+    panel_size: number;
+    column_order: string;
+    drop_rule: string;
+    judge_name: string | null;
+    judge_name_printed: string | null;
+    judge_clrg: number | null;
+    judge_id: number | null;
+    judge_unmatched: string | null;
+    mark: number | null;
+    mark_printed: string | null;
+    place: number | null;
+    place_printed: string | null;
+    tie: number;
+    points: number | null;
+    points_printed: string | null;
+}
+export interface TabQuery {
+    competition?: string;
+    address?: string;
+    round?: string;
+}
+export interface TabStreamQuery {
+    event?: string | string[];
+    year?: number | [number, number];
+    tier?: string[];
+    competition?: string[];
+}
+export interface TabAnswer {
+    tag: string;
+    asked: TabQuery;
+    rows: TabRow[];
+}
+export interface PanelSeat {
+    competition: string;
+    panel: string;
+    round: string;
+    seat_index: number;
+    address: string | null;
+    judge_name_printed: string | null;
+    judge_clrg: number | null;
+    judge_id: number | null;
+    judge_unmatched: string | null;
+}
+export interface FeisPanelSeat {
+    address: string;
+    platform: string;
+    round: string;
+    seat_index: number;
+    panel_size: number;
+    panel_kind: string;
+    judge_name_printed: string;
+    judge_state_printed: string | null;
+    judge_clrg: number | null;
+    judge_id: number | null;
+    judge_unmatched: string | null;
+    judge_basis: string | null;
+}
+export interface RegisterRow {
+    judge_clrg: number;
+    year: number;
+    cat: string;
+    name_printed: string;
+    country: string;
+    country_printed: string;
+    country_code: string | null;
+    region: string;
+    region_printed: string;
+    region_code: string | null;
+    geohash: string | null;
+    src: string;
+}
+export declare const TAB_NEEDS: readonly string[];
+export declare class TabFinder {
+    private readonly rel;
+    constructor(rel: Release);
+    private db;
+    private sheets;
+    query(q: TabQuery): Promise<TabAnswer>;
+    stream(q?: TabStreamQuery): AsyncGenerator<TabRow>;
+}
+export declare class PanelFinder {
+    private readonly rel;
+    constructor(rel: Release);
+    query(q?: {
+        competition?: string;
+    }): Promise<{
+        tag: string;
+        asked: {
+            competition?: string;
+        };
+        seats: PanelSeat[];
+    }>;
+}
+export declare class FeisPanelFinder {
+    private readonly rel;
+    constructor(rel: Release);
+    query(q?: {
+        address?: string;
+        platform?: string;
+    }): Promise<{
+        tag: string;
+        asked: {
+            address?: string;
+            platform?: string;
+        };
+        seats: FeisPanelSeat[];
+    }>;
+}
+export declare function registerRows(rel: Release, q: {
+    year?: number;
+    judge_clrg?: number;
+}): Promise<{
+    tag: string;
+    asked: {
+        year?: number;
+        judge_clrg?: number;
+    };
+    rows: RegisterRow[];
+}>;

package/dist/types/upcoming.d.ts

@@ -0,0 +1,138 @@
+import type { Release } from "./release.js";
+export type FieldState = "pending" | "results" | "passed" | "withdrawn";
+export declare const FIELD_STATES: readonly FieldState[];
+export type UpcomingFeisState = "upcoming" | "no-results";
+export interface UpcomingHost {
+    source: string;
+    host_id: string;
+    feis_id: string | null;
+    series: string | null;
+    name_printed: string | null;
+    date_lo: string | null;
+    date_hi: string | null;
+    url: string | null;
+}
+export interface UpcomingFeis {
+    occurrence_id: string;
+    occurrence_ids: string[];
+    name_printed: string;
+    date_lo: string;
+    date_hi: string | null;
+    year: number;
+    hosts: UpcomingHost[];
+    feis_brand_id: string | null;
+    feis_instance_id: string | null;
+    series_basis: string;
+    brand_candidates: string[];
+    captured_id: string;
+    state: UpcomingFeisState;
+}
+export interface FieldComp {
+    arm: "unique" | "ambiguous" | "none";
+    source: string | null;
+    kind: string | null;
+    level: string | null;
+    feis_level: number | null;
+    age: string | null;
+    population: string | null;
+    title: string | null;
+    why: string | null;
+}
+export interface UpcomingField {
+    field_id: string;
+    feis_id: string;
+    source: string;
+    host_id: string;
+    competition_code: string | null;
+    count_only: boolean;
+    occurrence_id: string | null;
+    name_printed: string;
+    date_lo: string | null;
+    date_hi: string | null;
+    year: number;
+    feis_brand_id: string | null;
+    comp: FieldComp | null;
+    state: FieldState;
+    results_competitions: string[];
+    results_feis_ids: string[];
+    version: string;
+    versions: string[];
+    captured_date: string;
+    sha256: string;
+    limits: string[];
+    entrants: number;
+    stated_rows: number | null;
+    printed_total: unknown;
+}
+export interface EntrantCandidate {
+    dancer_id: number;
+    scope: string;
+    kind: string | null;
+    score: number;
+    name: string | null;
+    age: string | null;
+    school: string | null;
+}
+export interface UpcomingEntrant {
+    feis_id: string;
+    captured_id: string;
+    row_id: string;
+    source: string;
+    host_id: string;
+    row_kind: string;
+    count_only: boolean;
+    n: number;
+    name_printed: string | null;
+    school_printed: string | null;
+    school_id: string | null;
+    school_rung: string;
+    school_candidates: string[];
+    competitions: string[];
+    field_ids: string[];
+    level_counts: Record<string, number> | null;
+    yob: number | null;
+    asked: Record<string, unknown> | null;
+    arm: "unique" | "ambiguous" | "none" | null;
+    candidates: EntrantCandidate[];
+    flags: string[];
+}
+export interface UpcomingFeisQuery {
+    state?: UpcomingFeisState;
+    brand?: string;
+    from?: string;
+    to?: string;
+}
+export interface UpcomingFieldQuery {
+    state?: FieldState | readonly FieldState[];
+    feis?: string;
+    field_id?: string;
+    from?: string;
+    to?: string;
+}
+export interface UpcomingEntrantQuery {
+    field_id: string;
+    version?: string;
+}
+export interface UpcomingFeisAnswer {
+    tag: string;
+    feises: UpcomingFeis[];
+}
+export interface UpcomingFieldAnswer {
+    tag: string;
+    fields: UpcomingField[];
+}
+export interface UpcomingEntrantAnswer {
+    tag: string;
+    field: UpcomingField | null;
+    version: string | null;
+    entrants: UpcomingEntrant[];
+    why?: string;
+}
+export declare class UpcomingFinder {
+    private readonly rel;
+    constructor(rel: Release);
+    private db;
+    feises(q?: UpcomingFeisQuery): Promise<UpcomingFeisAnswer>;
+    fields(q?: UpcomingFieldQuery): Promise<UpcomingFieldAnswer>;
+    entrants(q: UpcomingEntrantQuery): Promise<UpcomingEntrantAnswer>;
+}

package/package.json

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