@finbheara/domain 0.53.0 → 0.54.0

package/README.md

@@ -7,6 +7,8 @@ person names.
 
 - **Places**: a print in, the set of place-tree nodes it may mean out. A country, a state or
   province, a county, a city, or a CLRG region, with a relation between any two readings.
+- **CLRG events**: the Worlds, the nationals and the regional Oireachtais by event code, with
+  tier, canonical name, jurisdiction and North American eligibility.
 - **CLRG regions**: the CLRG's dance regions and their Oireachtas codes, and the region a
   location phrase falls in.
 - **School names**: a printed school name in, a `SchoolName` out, with a display form, a
@@ -40,6 +42,7 @@ ESM, Node ≥ 22 or Bun ≥ 1.4.2. MIT. Not affiliated with or endorsed by any d
 | `@finbheara/domain/place` | `place()`, `createPlaceReader`, `placeRelation`, the `Place` types |
 | `@finbheara/domain/geocode` | `geocode()`: a location field read by the place store, then by every GeoNames town of AU, CA, GB, IE, NZ and US; `townCell` |
 | `@finbheara/domain/clrg-regions` | `REGIONS`, `regionOf`, `resolvePhrase` |
+| `@finbheara/domain/event` | `EVENT_REGISTER`, `EVENT_REGISTER_BY_CODE`, `EVENT_TIER`, `eventTier`, `isMajorEvent`, `eventCodeOfSlug`, the `EventRegisterRow` type: the CLRG championships of tier 1 to 3 (below) |
 | `@finbheara/domain/school` | `createSchoolNameReader`, `DEFAULT_SCHOOL_NAME_READER`, `compareSchoolNames`, `foldSchoolName`, `schoolEncoder`, `schoolColumns` |
 | `@finbheara/domain/tune` | `tune()`, `tuneRelation`, `tempoLegal`, `settingAt`, `TUNE_NODES`: the CLRG set dance list, each tune with its time, speeds and bars |
 | `@finbheara/domain/ceili` | `ceili()`, `ceiliRelation`, `CEILI_NODES`: the céilí handbook dances |
@@ -181,6 +184,21 @@ A region is always the CLRG council that runs a place, and never its province or
 the two differ. County Louth lies in the province of Leinster and is run by the Ulster council,
 so it reads `ULSTER`, as Northern Ireland reads `ULSTER` and Wales `ENG_MIDLANDS`.
 
+## Look up a CLRG event
+
+```ts
+import { EVENT_REGISTER_BY_CODE, eventCodeOfSlug, eventTier, isMajorEvent } from "@finbheara/domain/event";
+
+EVENT_REGISTER_BY_CODE.get("sro")?.canonicalName;  // "Southern Region Oireachtas"
+eventTier("naidc");                                // 2
+isMajorEvent("bucharest");                         // false: a local feis has no row
+eventCodeOfSlug("naidc2024.514tsb");               // "naidc"
+```
+
+The register carries the Worlds (tier 1), the nationals (2) and the regional Oireachtais (3),
+in that order. It is complete for those tiers and silent below: a code it does not carry is a
+local event or no event code, and `eventTier` answers `null` for both rather than a guess.
+
 ## Read a school name
 
 ```ts

package/dist/event.js

@@ -0,0 +1,231 @@
+var EVENT_REGISTER = [
+  {
+    code: "ornc",
+    canonicalName: "Oireachtas Rince na Cruinne — Worlds",
+    tier: 1,
+    jurisdiction: "Global (target)",
+    naEligible: null
+  },
+  {
+    code: "ornh",
+    canonicalName: "Oireachtas Rince na hÉireann — All-Irelands",
+    tier: 2,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "crn",
+    canonicalName: "Craobhacha Rince Náisiúnta — Irish Nationals",
+    tier: 2,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "naidc",
+    canonicalName: "North American Nationals",
+    tier: 2,
+    jurisdiction: "IDTANA",
+    naEligible: true
+  },
+  {
+    code: "cnidc",
+    canonicalName: "Canadian National Irish Dance Championships",
+    tier: 2,
+    jurisdiction: "IDTANA (Can)",
+    naEligible: false
+  },
+  {
+    code: "gbc",
+    canonicalName: "Great Britain Championships",
+    tier: 2,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "asc",
+    canonicalName: "All-Scotland Championships",
+    tier: 2,
+    jurisdiction: "Scotland",
+    naEligible: false
+  },
+  {
+    code: "brnat",
+    canonicalName: "British National Championships",
+    tier: 2,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "nero",
+    canonicalName: "New England Region Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (US)",
+    naEligible: true
+  },
+  {
+    code: "maro",
+    canonicalName: "Mid-Atlantic Region Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (US)",
+    naEligible: true
+  },
+  {
+    code: "sro",
+    canonicalName: "Southern Region Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (US)",
+    naEligible: true
+  },
+  {
+    code: "mao",
+    canonicalName: "Mid-America Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (US)",
+    naEligible: true
+  },
+  {
+    code: "wusro",
+    canonicalName: "Western US Region Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (US)",
+    naEligible: true
+  },
+  {
+    code: "ecro",
+    canonicalName: "Eastern Canadian Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (Can)",
+    naEligible: true
+  },
+  {
+    code: "wcro",
+    canonicalName: "Western Canadian Region Oireachtas",
+    tier: 3,
+    jurisdiction: "IDTANA (Can)",
+    naEligible: true
+  },
+  {
+    code: "orl",
+    canonicalName: "Oir. Rince Laighean — Leinster",
+    tier: 3,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "orm",
+    canonicalName: "Oir. Rince na Mumhan — Munster",
+    tier: 3,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "oru",
+    canonicalName: "Oir. Rince Uladh — Ulster",
+    tier: 3,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "orc",
+    canonicalName: "Oir. Rince Chonnacht — Connacht",
+    tier: 3,
+    jurisdiction: "Ireland",
+    naEligible: false
+  },
+  {
+    code: "sno",
+    canonicalName: "Scottish National Oireachtas",
+    tier: 3,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "emid",
+    canonicalName: "England-Midlands (Lár na Breataine)",
+    tier: 3,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "enw",
+    canonicalName: "England-North-West Oireachtas (NWRC)",
+    tier: 3,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "ene",
+    canonicalName: "North East England Regional Oireachtas",
+    tier: 3,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "seo",
+    canonicalName: "Southern England Oireachtas",
+    tier: 3,
+    jurisdiction: "GB",
+    naEligible: false
+  },
+  {
+    code: "rccea",
+    canonicalName: "Continental Europe & Asia Oireachtas",
+    tier: 3,
+    jurisdiction: "RCCEA",
+    naEligible: false
+  },
+  {
+    code: "tida",
+    canonicalName: "New Zealand National Championships",
+    tier: 2,
+    jurisdiction: "NZ",
+    naEligible: false
+  },
+  {
+    code: "aidc",
+    canonicalName: "Australian National Championships",
+    tier: 2,
+    jurisdiction: "Australia",
+    naEligible: false
+  },
+  {
+    code: "aio",
+    canonicalName: "Australian International Oireachtas",
+    tier: 2,
+    jurisdiction: "Australia",
+    naEligible: false
+  },
+  {
+    code: "rsa",
+    canonicalName: "South Africa Oireachtas",
+    tier: 3,
+    jurisdiction: "South Africa",
+    naEligible: false
+  },
+  {
+    code: "orsam",
+    canonicalName: "Oir. Rince An Meiriceá Theas — S. America",
+    tier: 3,
+    jurisdiction: "South America",
+    naEligible: false
+  }
+];
+var EVENT_REGISTER_BY_CODE = new Map(EVENT_REGISTER.map((r) => [r.code, r]));
+var EVENT_TIER = new Map(EVENT_REGISTER.map((r) => [r.code, r.tier]));
+function eventTier(code) {
+  return EVENT_TIER.get(code) ?? null;
+}
+function isMajorEvent(code) {
+  return EVENT_TIER.has(code);
+}
+function eventCodeOfSlug(slug) {
+  return /^([a-z]+)\d{4}(?:[.\-]|$)/.exec(slug)?.[1] ?? null;
+}
+export {
+  EVENT_REGISTER,
+  EVENT_REGISTER_BY_CODE,
+  EVENT_TIER,
+  eventCodeOfSlug,
+  eventTier,
+  isMajorEvent
+};

package/dist/types/event.d.ts

@@ -0,0 +1,13 @@
+export interface EventRegisterRow {
+    code: string;
+    canonicalName: string;
+    tier: 1 | 2 | 3;
+    jurisdiction: string;
+    naEligible: boolean | null;
+}
+export declare const EVENT_REGISTER: readonly EventRegisterRow[];
+export declare const EVENT_REGISTER_BY_CODE: ReadonlyMap<string, EventRegisterRow>;
+export declare const EVENT_TIER: ReadonlyMap<string, 1 | 2 | 3>;
+export declare function eventTier(code: string): 1 | 2 | 3 | null;
+export declare function isMajorEvent(code: string): boolean;
+export declare function eventCodeOfSlug(slug: string): string | null;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@finbheara/domain",
-	"version": "0.53.0",
-	"description": "Places, CLRG regions, school names, ages, dances, competition titles, codes and schedules, and a person's print in its role, as they are printed: read, compared and told apart",
+	"version": "0.54.0",
+	"description": "Places, CLRG regions and events, school names, ages, dances, competition titles, codes and schedules, and a person's print in its role, as they are printed: read, compared and told apart",
 	"keywords": [
 		"places",
 		"regions",
@@ -77,6 +77,10 @@
 			"types": "./dist/types/code.d.ts",
 			"default": "./dist/code.js"
 		},
+		"./event": {
+			"types": "./dist/types/event.d.ts",
+			"default": "./dist/event.js"
+		},
 		"./package.json": "./package.json"
 	},
 	"files": ["dist/*.js", "dist/chunks/*.js", "dist/types/**/*.d.ts", "README.md", "LICENSE"],
@@ -93,7 +97,7 @@
 		"prepublishOnly": "bun scripts/build.ts && bun scripts/guard-tarball.ts"
 	},
 	"dependencies": {
-		"@finbheara/names": "0.25.0"
+		"@finbheara/names": "0.26.0"
 	},
 	"devDependencies": {
 		"typescript": "7.0.2"