@tungstenstudio/outschart-generator 1.0.0-rc.0

package/src/types.ts

@@ -0,0 +1,141 @@
+// === Out Modes ===
+
+export type OutMode = 'double' | 'single';
+
+// === Dartboard Types ===
+
+export type BedType =
+  | 'treble'
+  | 'double'
+  | 'smallSingle'
+  | 'largeSingle'
+  | 'Bull'
+  | '25'
+  | 'off'
+  | null; // bare single (e.g. "20")
+
+export type MissType = 'radialIn' | 'radialOut' | 'lateralCW' | 'lateralCCW';
+
+export interface ParsedTarget {
+  bed: BedType;
+  number: number | null;
+  value: number;
+}
+
+export interface FormattedTarget {
+  label: string;
+  value: number;
+}
+
+export interface MissTarget extends FormattedTarget {
+  missType: MissType;
+}
+
+export interface ThrowEvaluation {
+  target: string;
+  targetValue: number;
+  remaining: number;
+  misses: EvaluatedMiss[];
+  bustCount: number;
+  totalMisses: number;
+}
+
+export interface EvaluatedMiss extends MissTarget {
+  newRemaining: number;
+  busts: boolean;
+}
+
+// === Checkout Types ===
+
+export interface CheckoutEntry {
+  darts: string[];
+  numDarts: number;
+  alternates?: string[][];
+}
+
+export type CheckoutChart = Record<number, CheckoutEntry>;
+
+// === Enumeration Types ===
+
+export interface EnumeratedEntry {
+  options: string[][];
+  count: number;
+}
+
+export type EnumeratedCheckoutMap = Record<number, EnumeratedEntry>;
+
+export interface EnumeratedResult {
+  checkouts: EnumeratedCheckoutMap;
+  bogeyNumbers: number[];
+  totalOptions: number;
+}
+
+// === Generation Options ===
+
+export interface GenerateOptions {
+  outMode: OutMode;
+  min?: number;
+  max?: number;
+}
+
+export interface RecommendOptions extends GenerateOptions {
+  includeAlternates?: boolean;
+  altThreshold?: number;
+  overrides?: Record<number, { darts: string[] }>;
+}
+
+export interface CheckoutResult {
+  checkouts: CheckoutChart;
+  bogeyNumbers: number[];
+}
+
+// === Miss Analysis Types ===
+
+export interface DartAnnotation {
+  dart: number;
+  target: string;
+  missRelevant: boolean;
+  missResult?: string;
+  missRemaining?: number;
+  stillCheckable?: boolean;
+  remainderCheckout?: string[] | null;
+}
+
+export interface MissAnalysisResult {
+  score: number;
+  path: string[];
+  annotations: DartAnnotation[];
+  missResiliency: string;
+}
+
+// === Dartboard Layout Types ===
+
+export interface DartboardNeighbor {
+  clockwise: number;
+  counterClockwise: number;
+}
+
+export interface DartboardLayout {
+  boardOrder: number[];
+  neighbors: Record<string, DartboardNeighbor>;
+}
+
+// === Error Handling ===
+
+export type OutsChartErrorCode =
+  | 'INVALID_TARGET'
+  | 'INVALID_SCORE'
+  | 'INVALID_OUT_MODE'
+  | 'INVALID_RANGE'
+  | 'SCORE_NOT_CHECKABLE'
+  | 'INVALID_OVERRIDE';
+
+export class OutsChartError extends Error {
+  code: OutsChartErrorCode;
+
+  constructor(code: OutsChartErrorCode, message: string) {
+    super(message);
+    this.name = 'OutsChartError';
+    this.code = code;
+  }
+}