@finbheara/domain 0.4.0 → 0.6.2

package/dist/types/place-types.d.ts

@@ -8,13 +8,16 @@ export interface PlaceNode {
     readonly prints: readonly string[];
     readonly codes: readonly string[];
     readonly truncations?: readonly string[];
+    readonly headings?: readonly string[];
+    readonly runPrints?: readonly string[];
+    readonly listedCutsOnly?: true;
     readonly iso2?: string;
     readonly iso3?: string;
     readonly isoNumeric?: string;
     readonly oireachtas?: string;
 }
-export type PlaceMatch = "id" | "code" | "print" | "phrase" | "iso" | "county" | "truncation";
-export type PlaceRefusal = "school" | "organization" | "placeholder" | "damaged";
+export type PlaceMatch = "id" | "code" | "print" | "phrase" | "iso" | "county" | "truncation" | "desmushed";
+export type PlaceRefusal = "school" | "organization" | "placeholder" | "damaged" | "web" | "online" | "notice";
 export type PlaceRelation = "same" | "contains" | "overlaps" | "conflict" | "silent";
 export interface PlaceContext {
     readonly region?: string;

package/dist/types/place.d.ts

@@ -1,7 +1,8 @@
 import type { PlaceContext, PlaceKind, PlaceMatch, PlaceNode, PlaceRefusal, PlaceRelation } from "./place-types.ts";
-export type { PlaceContext, PlaceKind, PlaceMatch, PlaceNode, PlaceRefusal, PlaceRelation };
+import { type EmptyReason, type Validated } from "./validated.ts";
+export type { EmptyReason, PlaceContext, PlaceKind, PlaceMatch, PlaceNode, PlaceRefusal, PlaceRelation, Validated, };
 export type PlaceArm = "resolved" | "plural" | "ambiguous" | "unread";
-export interface AbstractPlace {
+export interface AbstractPlace extends Validated<PlaceRefusal> {
     readonly [Symbol.toStringTag]: "Place";
     toString(): string;
     readonly arm: PlaceArm;
@@ -18,7 +19,6 @@ export interface AbstractPlace {
     readonly refusal: PlaceRefusal | null;
     readonly misses: readonly string[];
     readonly length: number;
-    isEmpty(): boolean;
     isPlace(): boolean;
     isSingular(): this is ResolvedPlace;
     isPlural(): this is PluralPlaces;

package/dist/types/promotion.d.ts

@@ -12,5 +12,7 @@ export declare const collapse: (s: string) => string;
 export declare function samePromotedSchool(was: string, now: string): boolean;
 export declare function samePromotedRow(was: PromotedPrint, now: PromotedPrint): boolean;
 export declare function questionMarksRead(was: string, now: string): string | null;
+export declare function mojibakeRead(print: string): string;
 export declare function samePromotedName(was: string, now: string): boolean;
 export declare function samePromotedHeir(was: PromotedPrint, now: PromotedPrint): boolean;
+export declare function samePromotedPair(was: PromotedPrint, now: PromotedPrint): boolean;

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

@@ -12,5 +12,6 @@ export interface PrintZones {
         readonly only: boolean;
     } | null;
 }
+export declare function printsWeb(raw: string): boolean;
 export declare function printZones(raw: string): PrintZones;
 export declare function opensLocation(folded: string, at: PrintZones, index?: number): boolean;

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

@@ -1,6 +1,7 @@
 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";
+import { type Validated } from "./validated.ts";
 export interface LexiconFlags {
     surname: boolean;
     given: boolean;
@@ -26,7 +27,7 @@ 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 {
+export interface SchoolName extends Validated<RefusalReason> {
     readonly [Symbol.toStringTag]: "SchoolName";
     toString(): string;
     readonly sn0: string;
@@ -38,7 +39,6 @@ export interface SchoolName {
     readonly institution: InstitutionType | null;
     readonly location: Place | null;
     readonly refusal: SchoolRefusal | null;
-    isEmpty(): boolean;
     isSchool(): boolean;
     surnames(): readonly string[];
     readonly concerns: readonly SchoolConcern[];

package/dist/types/school.d.ts

@@ -8,4 +8,5 @@ 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 { EmptyReason, Validated } from "./validated.ts";
 export type { NotASchool, RefusalReason, SchoolNameException, } from "./school-exception-vocabulary.ts";

package/dist/types/tune.d.ts

@@ -1,5 +1,7 @@
 import { type DanceMatch, type DanceRelation } from "./dance-match.ts";
 import { type SetRhythm, type TimeSignature } from "./dance-types.ts";
+import { type Validated } from "./validated.ts";
+export type { EmptyReason, Validated } from "./validated.ts";
 export type TuneSetting = "traditional" | "contemporary";
 export interface SpeedRange {
     readonly min: number;
@@ -16,7 +18,10 @@ export interface TuneNode {
     readonly time: TimeSignature;
     readonly traditionalSpeed: number | null;
     readonly maxSpeed: number | null;
+    readonly stepBars: number;
+    readonly setBars: number;
 }
+export type TuneBars = readonly [step: number, set: number];
 export declare const TUNE_NODES: readonly TuneNode[];
 export interface Tune {
     readonly [Symbol.toStringTag]: "Tune";
@@ -30,6 +35,8 @@ export interface Tune {
     time(): TimeSignature;
     rhythm(): SetRhythm;
     speed(setting?: TuneSetting): number | SpeedRange | null;
+    stepBars(): number;
+    setBars(): number;
 }
 export declare function allTunes(): readonly Tune[];
 export declare function tuneById(id: string): Tune | undefined;
@@ -42,7 +49,7 @@ export interface TuneContext {
     readonly time?: TimeSignature;
 }
 export type TuneRefusal = "empty" | "dance-type" | "unmatched";
-export interface TuneReading {
+export interface TuneReading extends Validated<Exclude<TuneRefusal, "empty">> {
     readonly [Symbol.toStringTag]: "TuneReading";
     readonly print: string;
     readonly folded: string;

package/dist/types/validated.d.ts

@@ -1,4 +1,8 @@
-export interface Validated<Reason extends string> {
+export type EmptyReason = "empty";
+export interface Validated<Refusal extends string> {
+    isEmpty(): boolean;
+    isRefused(): boolean;
     isValid(): boolean;
-    invalidReason(): Reason | null;
+    invalidReason(): EmptyReason | Refusal | null;
 }
+export declare function validity<Refusal extends string>(empty: boolean, refusal: Refusal | null): Validated<Refusal>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@finbheara/domain",
-	"version": "0.4.0",
+	"version": "0.6.2",
 	"description": "Places, CLRG regions, school names, ages and dances as they are printed: read, compared and told apart",
 	"keywords": [
 		"places",
@@ -73,6 +73,6 @@
 		"prepublishOnly": "bun scripts/build.ts && bun scripts/guard-tarball.ts"
 	},
 	"dependencies": {
-		"@finbheara/names": "0.17.0"
+		"@finbheara/names": "0.18.0"
 	}
 }