Merge pull request #101 from tscircuit/feature/traceHint-trace-width-…

…prop

feat: add trace width

package.json

@@ -25,7 +25,8 @@
     "@semantic-release/release-notes-generator": "^10.0.3",
     "@tscircuit/footprinter": "^0.0.44",
     "@tscircuit/log-soup": "^1.0.2",
-    "@tscircuit/props": "^0.0.21",
+    "@tscircuit/props": "^0.0.27",
+    "@tscircuit/soup": "^0.0.49",
     "@tscircuit/soup-util": "^0.0.13",
     "@types/node": "^22.0.0",
     "ava": "^4.3.3",

src/lib/builder/trace-builder/build-pcb-trace-elements.ts

@@ -1,22 +1,22 @@
-import { BuildContext } from "lib/types"
 import type {
   AnySoupElement,
-  PCBTraceError,
-  SourcePort,
   InputPoint,
+  PCBPort,
   PCBTrace,
+  PCBTraceError,
   PCBVia,
-  PCBPort,
+  SourcePort,
 } from "@tscircuit/soup"
-import { TracePcbRoutingContext } from "./pcb-routing/trace-pcb-routing-context"
 import { su } from "@tscircuit/soup-util"
-import { solveForRoute } from "./pcb-routing/solve-for-route"
-import { findPossibleTraceLayerCombinations } from "./pcb-routing/find-possible-trace-layer-combinations"
-import { createNoCommonLayersError } from "./pcb-errors"
+import Debug from "debug"
+import type { BuildContext } from "lib/types"
 import { pairs } from "lib/utils/pairs"
-import { mergeRoutes } from "./pcb-routing/merge-routes"
+import { createNoCommonLayersError } from "./pcb-errors"
+import { findPossibleTraceLayerCombinations } from "./pcb-routing/find-possible-trace-layer-combinations"
 import { getPcbObstacles } from "./pcb-routing/get-pcb-obstacles"
-import Debug from "debug"
+import { mergeRoutes } from "./pcb-routing/merge-routes"
+import { solveForRoute } from "./pcb-routing/solve-for-route"
+import type { TracePcbRoutingContext } from "./pcb-routing/trace-pcb-routing-context"
 
 const debug = Debug("tscircuit:builder:trace-builder")
 
@@ -98,11 +98,11 @@ export const buildPcbTraceElements = (
       pcb_port_id: pcb_terminal_port_ids[1],
     })
 
-    if (port0_hint) {
-      pcb_route_hints.push(...port0_hint.route)
+    if (port0_hint && port0_hint.route !== undefined) {
+      pcb_route_hints.push(...port0_hint.route.map((p) => p ?? { x: 0, y: 0 }))
     }
     if (port1_hint) {
-      pcb_route_hints.push(...[...port1_hint.route].reverse())
+      pcb_route_hints.push(...port1_hint.route.map((p) => p ?? { x: 0, y: 0 }))
     }
   }
 
@@ -140,21 +140,20 @@ export const buildPcbTraceElements = (
               ...t,
               via_to_layer: layer_selection[idx],
             }
-          } else {
-            return { ...t, layers: [layer_selection[idx]] }
           }
+          return { ...t, layers: [layer_selection[idx]] }
         }
       )
 
-      for (let [a, b] of pairs(ordered_with_layer_hints)) {
+      for (const [a, b] of pairs(ordered_with_layer_hints)) {
         routes.push(solveForRoute([a, b], pcb_routing_ctx))
       }
       if (routes.some((route) => route.length === 0)) {
         pcb_errors.push({
           pcb_error_id: bc.getId("pcb_error"),
           type: "pcb_error",
           error_type: "pcb_trace_error",
-          message: `No route could be found for terminals`,
+          message: "No route could be found for terminals",
           pcb_trace_id,
           source_trace_id,
           pcb_component_ids: [], // TODO

src/lib/builder/trace-hint-builder/index.ts

@@ -1,26 +1,19 @@
 import {
-  route_hint_point,
+  type TraceHintProps as TraceHintPropsInput,
+  traceHintProps,
+} from "@tscircuit/props"
+import {
   type AnySoupElement,
   type PcbTraceHint,
   type RouteHintPoint,
+  route_hint_point,
 } from "@tscircuit/soup"
 import { su } from "@tscircuit/soup-util"
 import { applySelector } from "lib/apply-selector"
 import type { BuildContext } from "lib/types"
-import { z } from "zod"
 import type { BuilderInterface } from "../builder-interface"
 import type { ProjectBuilder } from "../project-builder"
 
-const trace_hints_props = z.object({
-  for: z.string(),
-  order: z.number().optional(),
-  offset: route_hint_point.optional(),
-  offsets: z.array(route_hint_point).optional(),
-})
-
-type TraceHintProps = z.infer<typeof trace_hints_props>
-type TraceHintPropsInput = z.input<typeof trace_hints_props>
-
 export interface TraceHintBuilder extends BuilderInterface {
   setProps(new_props: Partial<TraceHintPropsInput>): this
   build(parent_elements: AnySoupElement[], bc: BuildContext): AnySoupElement[]
@@ -45,7 +38,7 @@ class TraceHintBuilderClass {
   }
 
   build(parent_elements: AnySoupElement[], bc: BuildContext): AnySoupElement[] {
-    const props = trace_hints_props.parse(this.props)
+    const props = traceHintProps.parse(this.props)
     if (!props.for) {
       // TODO source error
       throw new Error("TraceHintBuilder requires a 'for' prop")
@@ -59,7 +52,7 @@ class TraceHintBuilderClass {
     }
     if (target_elms.length > 1) {
       // TODO source error
-      throw new Error(`<tracehint /> does not yet support multiple selectors`)
+      throw new Error("<tracehint /> does not yet support multiple selectors")
     }
 
     const [target_elm] = target_elms
@@ -103,7 +96,7 @@ class TraceHintBuilderClass {
 
     if (route.length === 0) {
       // TODO source error
-      throw new Error(`No route defined for tracehint (try adding an offset)`)
+      throw new Error("No route defined for tracehint (try adding an offset)")
     }
 
     // Construct pcb_trace_hint
@@ -113,6 +106,7 @@ class TraceHintBuilderClass {
       pcb_port_id: pcb_port.pcb_port_id,
       pcb_component_id: pcb_port.pcb_component_id,
       route,
+      trace_width: this.props.traceWidth,
     }
 
     return [trace_hint]

tests/tracehint/trace-hint-1.test.ts

@@ -1,5 +1,5 @@
-import test from "ava"
 import { su } from "@tscircuit/soup-util"
+import test from "ava"
 import { getTestFixture } from "tests/fixtures/get-test-fixture"
 
 test("trace hint 1: basic trace_hint for pad", async (t) => {
@@ -26,8 +26,12 @@ test("trace hint 1: basic trace_hint for pad", async (t) => {
   // waiting for select
   const pcb_port = su(soup).pcb_port.select(".R1 > .left")!
 
-  t.is(trace_hint.route[0].x, pcb_port.x - 1)
-  t.is(trace_hint.route[0].y, pcb_port.y + 1)
+  if (pcb_port) {
+    t.is(trace_hint.route[0]?.x, pcb_port.x - 1)
+    t.is(trace_hint.route[0]?.y, pcb_port.y + 1)
+  } else {
+    t.fail("pcb_port is undefined")
+  }
 
   logSoup(soup)
 })