Update resolveFullClueAnswer interface (BREAKING CHANGE)

Also: improve tests, improve type checking in test files

Author: samanpwbb

README.md

@@ -4565,7 +4565,7 @@ The main `xd-crossword-tools` package provides comprehensive functionality for f
 | `xdDiff`                       | Creates semantic diff between two XD files      | `beforeXD: string`, `afterXD: string`                  | `DiffResults`                                   | Line-by-line differences with metadata awareness     |
 | `runLinterForClue`             | Runs linting checks on individual clues         | `clue: Clue`, `ordinal: "across" \| "down"`            | `Report[]`                                      | Checks for common crossword construction issues      |
 | `validateClueAnswersMatchGrid` | Validates clue answers match grid tiles         | `json: CrosswordJSON`                                  | `Report[]`                                      | Checks consistency between answers and grid          |
-| `resolveFullClueAnswer`        | Resolves clue answer with rebus and splits      | `rebusMap: Rebuses`, `clue: Clue`, `splitChar: string` | `string`                                        | Handles rebus substitution and split characters      |
+| `resolveFullClueAnswer`        | Resolves clue answer with rebus and splits      | `clue: Clue`, `splitChar: string`                      | `string`                                        | Handles rebus substitution and split characters      |
 
 ### xd-crossword-tools-parser Utility Functions
 

packages/xd-crossword-tools/src/JSONtoXD.ts

@@ -1,6 +1,6 @@
 import type { Clue, CrosswordJSON, Tile } from "xd-crossword-tools-parser"
 
-export function resolveFullClueAnswer(rebusMap: CrosswordJSON["rebuses"], clue: Clue, splitChar: string) {
+export function resolveFullClueAnswer(clue: Clue, splitChar: string) {
   // For simple cases (no rebus, no splits, no internal splits), just return the answer directly
   const hasRebus = clue.tiles.some((t) => t.type === "rebus")
   const hasSplits = clue.splits && clue.splits.length > 0
@@ -112,7 +112,7 @@ export const JSONToXD = (json: CrosswordJSON): string => {
   const getCluesXD = (clues: Clue[], direction: "A" | "D") => {
     return clues
       .map((clue) => {
-        const final = resolveFullClueAnswer(json.rebuses, clue, splitChar)
+        const final = resolveFullClueAnswer(clue, splitChar)
         let line = `${direction}${clue.number}. ${clue.body} ~ ${final}`
         if (clue.metadata) {
           let printed = false

packages/xd-crossword-tools/tests/JSONtoXD.test.ts

@@ -19,7 +19,7 @@ describe("resolveFullClueAnswer", () => {
       ],
       metadata: undefined,
     } as Clue
-    expect(resolveFullClueAnswer(rebuses, clue, "")).toEqual(clue.answer)
+    expect(resolveFullClueAnswer(clue, "")).toEqual(clue.answer)
   })
 
   it("Returns answer for rebus clue", () => {
@@ -35,7 +35,7 @@ describe("resolveFullClueAnswer", () => {
       ],
       metadata: undefined,
     } as Clue
-    expect(resolveFullClueAnswer(rebuses, clue, "")).toEqual(clue.answer)
+    expect(resolveFullClueAnswer(clue, "")).toEqual(clue.answer)
   })
 
   it("Returns answer for clue with pipes", () => {
@@ -54,7 +54,7 @@ describe("resolveFullClueAnswer", () => {
       metadata: undefined,
       splits: [1],
     } as Clue
-    expect(resolveFullClueAnswer(rebuses, clue, "|")).toEqual("OK|GO")
+    expect(resolveFullClueAnswer(clue, "|")).toEqual("OK|GO")
   })
 
   it("Returns answer for rebus clue with pipes", () => {
@@ -78,7 +78,7 @@ describe("resolveFullClueAnswer", () => {
       metadata: undefined,
       splits: [5, 6, 7],
     } as Clue
-    expect(resolveFullClueAnswer(rebuses, clue, "|")).toEqual("TWITCH|DOT|T|V")
+    expect(resolveFullClueAnswer(clue, "|")).toEqual("TWITCH|DOT|T|V")
   })
 
   it("Demonstrates correct pipe position handling with rebus squares", () => {
@@ -99,17 +99,19 @@ describe("resolveFullClueAnswer", () => {
         { type: "letter", letter: "H" },
       ],
       metadata: undefined,
+      display: [["text", "Not too much!"]],
+      direction: "across" as const,
       // Internal splits within the rebus at tile position 3
       rebusInternalSplits: { 3: [0, 1] }, // T|A|SK
     } as Clue
 
     // Should produce JUST|A|SKOSH (perfect internal rebus splits)
-    expect(resolveFullClueAnswer(rebuses, clue, "|")).toEqual("JUST|A|SKOSH")
+    expect(resolveFullClueAnswer(clue, "|")).toEqual("JUST|A|SKOSH")
   })
 
   it("Returns answer for clue with Schrödinger square", () => {
     const rebuses = {}
-    const schrodingerTile: SchrodingerTile = { type: "schrodinger", validLetters: ["O", "A"] }
+    const schrodingerTile: SchrodingerTile = { type: "schrodinger", validLetters: ["O", "A"], validRebuses: [] }
     const clue = {
       body: "Sugar ____",
       answer: "CONE",
@@ -120,7 +122,7 @@ describe("resolveFullClueAnswer", () => {
       display: [["text", "Sugar ____"]],
       metadata: { alt: "CANE" },
     } as Clue
-    expect(resolveFullClueAnswer(rebuses, clue, "")).toEqual("CONE")
+    expect(resolveFullClueAnswer(clue, "")).toEqual("CONE")
   })
 })
 
@@ -404,6 +406,7 @@ D4. Former intimates ~ EXES`
 title: Pipe Bug Test
 author: Test
 date: 2025-01-01
+editor: Penelope Rudow
 rebus: ❶=TASK
 splitcharacter: |
 
@@ -413,32 +416,13 @@ JUS❶OSH
 
 ## Clues
 
-A1. Not too much! ~ JUST|A|SKOSH`
-
-    const expectedOutput = `## Metadata
-
-title: Pipe Bug Test
-author: Test
-date: 2025-01-01
-editor: Not set
-rebus: ❶=TASK
-splitcharacter: |
-
-## Grid
-
-JUS❶OSH
-
-## Clues
-
-A1. Not too much! ~ JUST|A|SKOSH
-
-`
+A1. Not too much! ~ JUST|A|SKOSH\n\n`
 
     const json = xdToJSON(puzzle)
     const newXD = JSONToXD(json)
 
     // Perfect round-trip: internal rebus splits are preserved
-    expect(newXD).toEqual(expectedOutput)
+    expect(newXD).toEqual(puzzle)
   })
 
   it("Handles mixed regular and internal rebus splits", () => {
@@ -466,14 +450,13 @@ A1. Not too much! ~ JUST|A|SKOSH
       splits: [5, 6, 7], // Split after TWITCH, after rebus, and after T
       rebusInternalSplits: { 6: [0] }, // D|OT within rebus
     } as Clue
-    
+
     // Should produce TWITCH|D|OT|T|V
-    expect(resolveFullClueAnswer(rebuses, clue, "|")).toEqual("TWITCH|D|OT|T|V")
+    expect(resolveFullClueAnswer(clue, "|")).toEqual("TWITCH|D|OT|T|V")
   })
 
   it("Handles multiple internal splits in same rebus", () => {
     // Test case with multiple internal splits in the same rebus
-    const rebuses = { "❶": "TASK" }
     const clue = {
       body: "All internal splits",
       answer: "JUSTASKOSH",
@@ -491,10 +474,10 @@ A1. Not too much! ~ JUST|A|SKOSH
       metadata: undefined,
       display: [["text", "All internal splits"]],
       direction: "across" as const,
-      rebusInternalSplits: { 3: [0, 1, 2] }, // T|A|S|K
+      rebusInternalSplits: { 3: [0, 1] },
     } as Clue
-    
-    // Should produce JUST|A|S|KOSH
-    expect(resolveFullClueAnswer(rebuses, clue, "|")).toEqual("JUST|A|S|KOSH")
+
+    // Should produce JUST|A|SKOSH
+    expect(resolveFullClueAnswer(clue, "|")).toEqual("JUST|A|SKOSH")
   })
 })

packages/xd-crossword-tools/tests/amuseJSONToXD.test.ts

@@ -24,14 +24,16 @@ describeConditional("amuseJSONToXD", () => {
     expect(result.tiles[0][0].type).toBe("schrodinger")
 
     expect(result.tiles[0][0]).toHaveProperty("validLetters")
-    expect(result.tiles[0][0].validLetters).toEqual(["H", "J"])
+    if (result.tiles[0][0].type === "schrodinger") {
+      expect(result.tiles[0][0].validLetters).toEqual(["H", "J"])
+    }
 
     expect(result.clues.down[0]).toHaveProperty("answer")
     expect(result.clues.down[0].answer).toEqual("HELLO")
 
     expect(result.clues.down[0]).toHaveProperty("metadata")
     expect(result.clues.down[0].metadata).toHaveProperty("alt")
-    expect(result.clues.down[0].metadata.alt).toEqual("JELLO")
+    expect(result.clues.down[0].metadata?.alt).toEqual("JELLO")
   })
 
   it("handles rebus clues correctly", () => {
@@ -41,10 +43,14 @@ describeConditional("amuseJSONToXD", () => {
     expect(result.tiles[3][0].type).toBe("rebus")
 
     expect(result.tiles[3][0]).toHaveProperty("word")
-    expect(result.tiles[3][0].word).toBe("LD")
+    if (result.tiles[3][0].type === "rebus") {
+      expect(result.tiles[3][0].word).toBe("LD")
+    }
 
     expect(result.tiles[3][0]).toHaveProperty("symbol")
-    expect(result.tiles[3][0].symbol).toBe("ⓐ")
+    if (result.tiles[3][0].type === "rebus") {
+      expect(result.tiles[3][0].symbol).toBe("ⓐ")
+    }
 
     expect(result.meta).toHaveProperty("rebus")
     expect(result.meta.rebus).toContain("ⓐ=LD")

packages/xd-crossword-tools/tests/index.test.ts

@@ -1,6 +1,6 @@
 // Careful of this resolving to the .js version!
 import { puzToXD } from "../src/puzToXD"
-import { uclickXMLToXd } from "../src/uclickToXD"
+import { uclickXMLToXD } from "../src/uclickToXD"
 
 import { xdToJSON } from "xd-crossword-tools-parser"
 

packages/xd-crossword-tools/tsconfig.json

@@ -1,10 +1,9 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
+    "outDir": "./dist"
   },
-  "include": ["src/**/*"],
+  "include": ["src/**/*", "tests/**/*"],
   "exclude": ["node_modules", "dist"],
   "types": ["vitest/globals"]
 }