@finbheara/domain 0.0.0-stage → 0.2.0

package/dist/types/school-name.d.ts

@@ -0,0 +1,82 @@
+import { type Place } from "./place.ts";
+import { type NotASchool, type RefusalReason, type SchoolNameException } from "./school-exception-vocabulary.ts";
+import { type InstitutionType } from "./school-institution-vocabulary.ts";
+export interface LexiconFlags {
+    surname: boolean;
+    given: boolean;
+    place: boolean;
+    tradename: boolean;
+    concept: boolean;
+    ambiguous: boolean;
+    raw: string;
+}
+export type SchoolLexicon = (key: string) => LexiconFlags | undefined;
+export interface SchoolPart {
+    readonly base: string;
+    readonly parts: readonly SchoolPart[];
+    readonly lexicon: LexiconFlags | null;
+}
+export interface SchoolRefusal {
+    readonly reason: RefusalReason;
+    readonly printed: string;
+    readonly row: NotASchool;
+    readonly value: typeof SCHOOL_REFUSED;
+}
+export declare const SCHOOL_REFUSED = "!!!NOTASCHOOL";
+export type SchoolConcern = "institution-inside-name" | "promoted-name" | "no-name-part" | "truncated-tail" | "lexicon-absent" | "ambiguous-part" | "place-from-lexicon";
+export type Refusal = SchoolRefusal;
+export type Concern = SchoolConcern;
+export interface SchoolName {
+    readonly [Symbol.toStringTag]: "SchoolName";
+    toString(): string;
+    readonly sn0: string;
+    readonly sn1: string;
+    readonly sn2: string;
+    readonly sn3: string;
+    readonly sn4: string;
+    readonly parts: readonly SchoolPart[];
+    readonly institution: InstitutionType | null;
+    readonly location: Place | null;
+    readonly refusal: SchoolRefusal | null;
+    isEmpty(): boolean;
+    isSchool(): boolean;
+    surnames(): readonly string[];
+    readonly concerns: readonly SchoolConcern[];
+}
+export declare const TITLE_CASE_STATE_CODES: ReadonlySet<string>;
+export declare function schoolInitials(name: SchoolName): SchoolInitials;
+export interface SchoolPrintSplit {
+    readonly name: string;
+    readonly qualifier: string | null;
+    readonly location: Place | null;
+    readonly annotation: string | null;
+}
+export declare function schoolPrintSplit(print: string, reader: SchoolNameParser): SchoolPrintSplit;
+export interface SchoolInitials {
+    readonly declared: string | null;
+    readonly derived: readonly string[];
+}
+export declare function realWords(name: SchoolName): readonly string[];
+export declare function realWordsInPrintOrder(name: SchoolName): readonly string[];
+export declare const DEFAULT_SCHOOL_NAME_CAPACITY = 16384;
+export interface SchoolNameReaderOptions {
+    readonly lexicon?: SchoolLexicon;
+    readonly exceptions?: readonly SchoolNameException[];
+    readonly refusals?: readonly NotASchool[];
+    readonly garbage?: readonly NotASchool[];
+    readonly capacity?: number;
+}
+export declare function createSchoolNameReader(options?: SchoolNameReaderOptions): {
+    lexicon: SchoolLexicon | undefined;
+    schoolName: (print: string) => SchoolName;
+    schoolNameStats: () => {
+        hits: number;
+        misses: number;
+        evictions: number;
+    };
+    resetSchoolNameCache: (next?: number) => void;
+    capacity: () => number;
+};
+export type SchoolNameReader = ReturnType<typeof createSchoolNameReader>;
+export type SchoolNameParser = Pick<SchoolNameReader, "schoolName">;
+export declare const DEFAULT_SCHOOL_NAME_READER: SchoolNameReader;

package/dist/types/school-tokens.d.ts

@@ -0,0 +1,20 @@
+import type { InstitutionType as RegisterType } from "./school-institution-vocabulary.ts";
+export declare const LEGACY_EXCEPTION_PHRASES: ReadonlySet<string>;
+export type SchoolTokenClass = "NAME_PART" | "INSTITUTION_TYPE" | "FLUFF" | "LOCATION_HINT";
+export interface SchoolToken {
+    text: string;
+    class: SchoolTokenClass;
+    exception?: string;
+    short?: true;
+    institution?: InstitutionType;
+    place?: string;
+    promoted?: true;
+}
+export type InstitutionType = Exclude<RegisterType, "club">;
+export declare const SCHOOL_FLUFF_TOKENS: ReadonlySet<string>;
+export declare function canonicalPlace(token: string): string | undefined;
+export declare function schoolTokens(raw: string): SchoolToken[];
+export declare function nameParts(raw: string): string[];
+export declare function promotedKey(raw: string): boolean;
+export declare function institutionTypes(raw: string): InstitutionType[];
+export declare function locationHints(raw: string): string[];

package/dist/types/school.d.ts

@@ -0,0 +1,11 @@
+export { createSchoolNameReader, DEFAULT_SCHOOL_NAME_CAPACITY, DEFAULT_SCHOOL_NAME_READER, realWords, realWordsInPrintOrder, schoolInitials, schoolPrintSplit, } from "./school-name.ts";
+export type { LexiconFlags, SchoolConcern, SchoolInitials, SchoolLexicon, SchoolName, SchoolNameParser, SchoolNameReader, SchoolNameReaderOptions, SchoolPart, SchoolPrintSplit, SchoolRefusal, } from "./school-name.ts";
+export { isColumnCutOf, isInitialismOf, isLadderLevel, mapOfSchools, probablySameSchool, SCHOOL_LEVEL_COLUMNS, schoolColumns, sameInEveryPart, schoolCompare, schoolTokensAt, setOfSchools, } from "./school-compare.ts";
+export type { SchoolDop, SchoolLevelColumn, SchoolMap, SchoolSet } from "./school-compare.ts";
+export { schoolEncoder } from "./school-encoder.ts";
+export type { SchoolEncoderOptions } from "./school-encoder.ts";
+export { compareSchoolNames, compareSchools } from "./school-identity.ts";
+export type { IdentityResult, IdentityVerdict } from "./school-identity.ts";
+export { foldSchoolName, hasSpecificToken, schoolKeyTokens } from "./school-match-key.ts";
+export { NOT_A_SCHOOL, SCHOOL_NAME_EXCEPTIONS, } from "./school-exception-vocabulary.ts";
+export type { NotASchool, RefusalReason, SchoolNameException, } from "./school-exception-vocabulary.ts";

package/dist/types/tune.d.ts

@@ -0,0 +1,63 @@
+import { type DanceMatch, type DanceRelation } from "./dance-match.ts";
+import { type SetRhythm, type TimeSignature } from "./dance-types.ts";
+export type TuneSetting = "traditional" | "contemporary";
+export interface SpeedRange {
+    readonly min: number;
+    readonly max: number | null;
+}
+export declare const SET_MIN_SPEED: Readonly<Record<SetRhythm, number>>;
+export declare const PLAUSIBLE_SET_TEMPO_MAX = 150;
+export interface TuneNode {
+    readonly id: string;
+    readonly name: string;
+    readonly irish: string | null;
+    readonly prints: readonly string[];
+    readonly irishPrints: readonly string[];
+    readonly time: TimeSignature;
+    readonly traditionalSpeed: number | null;
+    readonly maxSpeed: number | null;
+}
+export declare const TUNE_NODES: readonly TuneNode[];
+export interface Tune {
+    readonly [Symbol.toStringTag]: "Tune";
+    readonly id: string;
+    readonly name: string;
+    readonly irish: string | null;
+    readonly node: TuneNode;
+    toString(): string;
+    isTraditional(): boolean;
+    isContemporary(): boolean;
+    time(): TimeSignature;
+    rhythm(): SetRhythm;
+    speed(setting?: TuneSetting): number | SpeedRange | null;
+}
+export declare function allTunes(): readonly Tune[];
+export declare function tuneById(id: string): Tune | undefined;
+export declare function tempoLegal(tune: Tune | TuneReading, bpm: number, setting?: TuneSetting): boolean;
+export declare function settingAt(tune: Tune, bpm: number): TuneSetting | null;
+export interface TuneContext {
+    readonly setting?: TuneSetting;
+    readonly bpm?: number;
+    readonly rhythm?: SetRhythm;
+    readonly time?: TimeSignature;
+}
+export type TuneRefusal = "empty" | "dance-type" | "unmatched";
+export interface TuneReading {
+    readonly [Symbol.toStringTag]: "TuneReading";
+    readonly print: string;
+    readonly folded: string;
+    readonly bpm: number | null;
+    readonly candidates: readonly Tune[];
+    readonly score: number;
+    readonly match: DanceMatch | null;
+    readonly refusal: TuneRefusal | null;
+    readonly misses: readonly string[];
+    readonly tune: Tune | undefined;
+    isTune(): boolean;
+    isSingular(): boolean;
+    isAmbiguous(): boolean;
+    refine(ctx: TuneContext): TuneReading;
+    toString(): string;
+}
+export declare function tune(print: string, ctx?: TuneContext): TuneReading;
+export declare function tuneRelation(a: TuneReading, b: TuneReading): DanceRelation;

package/package.json

@@ -1,6 +1,74 @@
 {
-  "name": "@finbheara/domain",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@finbheara/domain",
+	"version": "0.2.0",
+	"description": "Places, CLRG regions, school names, ages and dances as they are printed: read, compared and told apart",
+	"keywords": [
+		"places",
+		"regions",
+		"school-names",
+		"ages",
+		"set-dances",
+		"normalization",
+		"irish-dance",
+		"gazetteer"
+	],
+	"license": "MIT",
+	"author": "Finbheara Systems",
+	"type": "module",
+	"sideEffects": false,
+	"exports": {
+		"./place": {
+			"types": "./dist/types/place.d.ts",
+			"default": "./dist/place.js"
+		},
+		"./clrg-regions": {
+			"types": "./dist/types/clrg-regions.d.ts",
+			"default": "./dist/clrg-regions.js"
+		},
+		"./school": {
+			"types": "./dist/types/school.d.ts",
+			"default": "./dist/school.js"
+		},
+		"./tune": {
+			"types": "./dist/types/tune.d.ts",
+			"default": "./dist/tune.js"
+		},
+		"./ceili": {
+			"types": "./dist/types/ceili.d.ts",
+			"default": "./dist/ceili.js"
+		},
+		"./dance": {
+			"types": "./dist/types/dance.d.ts",
+			"default": "./dist/dance.js"
+		},
+		"./age": {
+			"types": "./dist/types/age.d.ts",
+			"default": "./dist/age.js"
+		},
+		"./dance-types": {
+			"types": "./dist/types/dance-types.d.ts",
+			"default": "./dist/dance-types.js"
+		},
+		"./noun-index": {
+			"types": "./dist/types/noun-index.d.ts",
+			"default": "./dist/noun-index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"files": ["dist/*.js", "dist/chunks/*.js", "dist/types/**/*.d.ts", "README.md", "LICENSE"],
+	"engines": {
+		"node": ">=22",
+		"bun": ">=1.4.2"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "bun scripts/build.ts",
+		"guard": "bun scripts/guard-tarball.ts",
+		"prepublishOnly": "bun scripts/build.ts && bun scripts/guard-tarball.ts"
+	},
+	"dependencies": {
+		"@finbheara/names": "0.12.0"
+	}
+}