fix: make hole circuit json parse against circuit-json schemas (#2843)

lib/components/primitive-components/Hole.ts

@@ -8,6 +8,7 @@ import type {
   PcbHoleRect,
   PcbHoleCircle,
 } from "circuit-json"
+import { optionalId } from "lib/utils/optional-id"
 
 export class Hole extends PrimitiveComponent<typeof holeProps> {
   pcb_hole_id: string | null = null
@@ -52,9 +53,13 @@ export class Hole extends PrimitiveComponent<typeof holeProps> {
     const position = this._getGlobalPcbPositionBeforeLayout()
     const soldermaskMargin = props.solderMaskMargin
     const isCoveredWithSolderMask = props.coveredWithSolderMask ?? false
-    const pcb_component_id =
+    // `pcb_component_id` is `string | null` on PrimitiveComponent, and `??`
+    // only falls through on `undefined` — a board-level hole has no owning
+    // component, so the `null` used to reach circuit JSON and fail validation.
+    const pcb_component_id = optionalId(
       this.parent?.pcb_component_id ??
-      this.getPrimitiveContainer()?.pcb_component_id
+        this.getPrimitiveContainer()?.pcb_component_id,
+    )
 
     this.emitSolderMaskMarginWarning(isCoveredWithSolderMask, soldermaskMargin)
 

lib/components/primitive-components/PlatedHole.ts

@@ -13,6 +13,7 @@ import type {
 } from "circuit-json"
 import { decomposeTSR } from "transformation-matrix"
 import { selectPortForPcbPrimitive } from "./Port/selectPortForPcbPrimitive"
+import { optionalId } from "lib/utils/optional-id"
 
 export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
   pcb_plated_hole_id: string | null = null
@@ -125,9 +126,12 @@ export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
     const { db } = this.root!
     const { _parsedProps: props } = this
     const position = this._getGlobalPcbPositionBeforeLayout()
-    const pcb_component_id =
+    // See `optionalId`: `pcb_component_id` is `string | null`, and a
+    // board-level plated hole has no owning component.
+    const pcb_component_id = optionalId(
       this.parent?.pcb_component_id ??
-      this.getPrimitiveContainer()?.pcb_component_id!
+        this.getPrimitiveContainer()?.pcb_component_id,
+    )
     const subcircuit = this.getSubcircuit()
     const platedHoleLayers = this.getAvailablePcbLayers()
     const soldermaskMargin = props.solderMaskMargin
@@ -265,6 +269,10 @@ export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
         rect_pad_width: props.rectPadWidth,
         rect_pad_height: props.rectPadHeight,
         shape: "circular_hole_with_rect_pad" as const,
+        // Required by the `circular_hole_with_rect_pad` schema variant; the
+        // sibling pill variants below already set them.
+        hole_shape: "circle" as const,
+        pad_shape: "rect" as const,
         port_hints: this.getNameAndAliases(),
         x: position.x,
         y: position.y,

lib/utils/optional-id.ts

@@ -0,0 +1,13 @@
+/**
+ * Normalizes an id that may be `null` into `undefined`.
+ *
+ * `PrimitiveComponent` initialises its id fields to `null`
+ * (`pcb_component_id: string | null = null`), but circuit-json types every id
+ * as `z.string().optional()` — which accepts `undefined` and rejects `null`.
+ *
+ * Primitives placed directly on a board have no owning `pcb_component`, so the
+ * `null` was reaching circuit JSON and making the whole element fail
+ * `any_circuit_element.parse()`.
+ */
+export const optionalId = (id: string | null | undefined): string | undefined =>
+  id ?? undefined

tests/components/primitive-components/hole-board-level-circuit-json-validity.test.tsx

@@ -0,0 +1,57 @@
+import { expect, test } from "bun:test"
+import { any_circuit_element } from "circuit-json"
+import { getTestFixture } from "tests/fixtures/get-test-fixture"
+
+test("board-level holes produce valid circuit json", async () => {
+  const { circuit } = getTestFixture()
+
+  circuit.add(
+    <board width="30mm" height="30mm" routingDisabled>
+      <hole name="H1" pcbX={-5} pcbY={5} diameter="1mm" />
+      <platedhole
+        name="PH1"
+        pcbX={5}
+        pcbY={-5}
+        shape="circle"
+        holeDiameter="0.5mm"
+        outerDiameter="0.9mm"
+      />
+      {/* A footprint whose holes DO belong to a component. */}
+      <chip name="U1" footprint="dip8" pcbX={0} />
+    </board>,
+  )
+
+  await circuit.renderUntilSettled()
+
+  const circuitJson = circuit.getCircuitJson()
+  const holes = circuitJson.filter(
+    (e: any) => e.type === "pcb_hole" || e.type === "pcb_plated_hole",
+  ) as any[]
+
+  const boardLevelHoles = holes.filter((h) => h.pcb_component_id === undefined)
+  const componentHoles = holes.filter((h) => h.pcb_component_id !== undefined)
+
+  expect(boardLevelHoles.length).toBeGreaterThan(0)
+  expect(componentHoles.length).toBeGreaterThan(0)
+
+  // `pcb_component_id` is `z.string().optional()` on these schemas, so `null`
+  // is rejected while an absent value is fine. A board-level hole has no
+  // owning component, and the `null` used to make the element fail
+  // `any_circuit_element.parse()` entirely.
+  for (const hole of boardLevelHoles) {
+    expect(hole.pcb_component_id).toBeUndefined()
+  }
+
+  // Holes that belong to a footprint must keep their component id.
+  for (const hole of componentHoles) {
+    expect(typeof hole.pcb_component_id).toBe("string")
+  }
+
+  for (const hole of holes) {
+    const result = any_circuit_element.safeParse(hole)
+    expect({ type: hole.type, valid: result.success }).toEqual({
+      type: hole.type,
+      valid: true,
+    })
+  }
+})

tests/components/primitive-components/plated-hole-pill-rotated2.test.tsx

@@ -33,7 +33,7 @@ test("PlatedHole pill shape", () => {
       ],
       "outer_height": 4,
       "outer_width": 2,
-      "pcb_component_id": null,
+      "pcb_component_id": undefined,
       "pcb_group_id": undefined,
       "pcb_plated_hole_id": "pcb_plated_hole_0",
       "pcb_port_id": undefined,