Merge pull request #50 from puzzmo-com/amuse-json-fallbacks

Adds a fallback for missing data on an amuse import

Author: orta

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

@@ -1,5 +1,5 @@
 import { JSONToXD } from "./JSONtoXD"
-import type { Clue, Position as CluePosition, CrosswordJSON } from "xd-crossword-tools-parser"
+import type { Clue, Position as CluePosition, CrosswordJSON, Report } from "xd-crossword-tools-parser"
 
 import type { CellInfo, PlacedWord, AmuseTopLevel } from "./amuseJSONToXD.types.d.ts"
 
@@ -207,11 +207,31 @@ export function convertAmuseToCrosswordJSON(amuseJson: AmuseTopLevel): Crossword
   const cluesStructure: Clues = { across: [], down: [] }
   const cluePositionsMap: Record<string, CluePosition> = {}
 
+  const errorReports: Report[] = []
+
   amuseData.placedWords.forEach((placedWord: PlacedWord) => {
-    const direction = placedWord.clueSection === "Across" ? "across" : "down"
+    let direction: "across" | "down" | null = null
+
+    // I think different ages of amuse json's have different data structures,
+    // as one crossword we have does not include "clueSection" - so we fall back to "acrossNotDown"
+    if (placedWord.clueSection) direction = placedWord.clueSection === "Across" ? "across" : "down"
+    if ("acrossNotDown" in placedWord && !direction) direction = placedWord.acrossNotDown ? "across" : "down"
+    if (!direction) {
+      errorReports.push({
+        type: "syntax",
+        message: `Could not determine a direction for placed word ${placedWord.word}.`,
+        length: -1,
+        position: {
+          col: placedWord.x,
+          index: placedWord.y,
+        },
+      })
+      return
+    }
+
     const clueText = convertHtmlToXdMarkup(placedWord.clue.clue)
     const clueNumberStr = placedWord.clueNum // This is already a string from AmuseData
-    const word = placedWord.word || ""
+    const word = placedWord.word || placedWord.originalTerm || ""
     let answer
     let alt
 
@@ -239,7 +259,7 @@ export function convertAmuseToCrosswordJSON(amuseJson: AmuseTopLevel): Crossword
       body: clueText,
       answer: answer,
       tiles: [],
-      direction: direction,
+      direction,
       display: [],
       position: {
         col: placedWord.x,
@@ -408,9 +428,16 @@ export function convertHtmlToXdMarkup(html: string | undefined): string {
     )
   }
 
+  // Don't think this is actually a goal: https://github.com/puzzmo-com/xd-crossword-tools/issues/46
+  // Convert spaced dots to ellipsis
+  // result = result.replace(/\. \. \./g, "…")
+
   // Clean up excessive whitespace and newlines
   result = result.replace(/\n+/g, "\n").trim()
 
+  // Remove extra HTML entities like "&#039;"
+  result = result.replace(/&#(\d+);/g, (match, dec) => String.fromCharCode(dec))
+
   return result
 }
 

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

@@ -8,15 +8,15 @@ const exampleJSONPath = "/Users/orta/dev/workshop/packages/amuse-to-xd/examples/
 const fullExamplePath = exampleJSONPath
 
 const hasCirclesPath = "/Users/orta/dev/workshop/packages/amuse-to-xd/examples/2025_04_01-themed.json"
-
 const largeGrid = "/Users/orta/dev/workshop/packages/amuse-to-xd/examples/2021_01_01-oversize.json"
+const cartoon = "/Users/orta/dev/workshop/packages/amuse-to-xd/examples/2019_12_23-cartoon.json"
 
 // Only run tests if the example JSON files exist
 const shouldRunTests = existsSync(fullExamplePath) && existsSync(hasCirclesPath)
 
 const describeConditional = shouldRunTests ? describe : describe.skip
 
-describe("amuseJSONToXD", () => {
+describeConditional("amuseJSONToXD", () => {
   it("handles schrodinger clues correctly", () => {
     const result = convertAmuseToCrosswordJSON(schrodingerAmuseExample)
 
@@ -202,6 +202,13 @@ describe("amuseJSONToXD", () => {
       })
     })
 
+    it.skip("handles converting ellipsis", () => {
+      const result = convertAmuseToCrosswordJSON(amuseJSON)
+
+      const across7 = result.clues.across.find((clue) => clue.number === 7)
+      expect(across7?.body).toMatchInlineSnapshot(`"Single ensign full of exuberance … (4)"`)
+    })
+
     describe("amuseToXD", () => {
       it("converts amuse JSON to XD string format", () => {
         const result = amuseToXD(amuseJSON)
@@ -575,4 +582,15 @@ describe("amuseJSONToXD", () => {
       expect(a8Clue?.answer).toEqual("FCC")
     })
   })
+
+  describe(cartoon, () => {
+    it("has answers for the clues", () => {
+      const xdOutput = convertAmuseToCrosswordJSON(JSON.parse(readFileSync(cartoon, "utf-8")))
+
+      const a1Clue = xdOutput.clues.across.find((clue) => clue.number === 1)
+      expect(a1Clue).toBeDefined()
+      expect(a1Clue?.body).toEqual("Hairdo")
+      expect(a1Clue?.answer).toEqual("COIF")
+    })
+  })
 })