@tscircuit/schematic-trace-solver 0.0.149 → 0.0.151

package/lib/solvers/InlineNetLabelSolver/InlineNetLabelSolver.ts

@@ -1,5 +1,5 @@
 import type { Bounds, Point } from "@tscircuit/math-utils"
-import type { GraphicsObject, Rect } from "graphics-debug"
+import type { GraphicsObject, Rect, Text } from "graphics-debug"
 import { BaseSolver } from "lib/solvers/BaseSolver/BaseSolver"
 import type { NetLabelPlacement } from "lib/solvers/NetLabelPlacementSolver/NetLabelPlacementSolver"
 import type { SolvedTracePath } from "lib/solvers/SchematicTraceLinesSolver/SchematicTraceLinesSolver"
@@ -52,6 +52,8 @@ export const INLINE_NET_LABEL_MAX_SPAN_JOG = 0.4
 export interface InlineNetLabelPlacement {
   globalConnNetId: string
   netId?: string
+  /** User-facing label content, separate from the connectivity identifier. */
+  netLabelText?: string
   mspPairId?: string
   pinIds: PinId[]
 
@@ -90,6 +92,13 @@ interface InlineNetLabelSolverInput {
   netLabelPlacements: NetLabelPlacement[]
 }
 
+export interface InlineNetLabelOutput {
+  inputProblem: InputProblem
+  traces: SolvedTracePath[]
+  netLabelPlacements: NetLabelPlacement[]
+  inlineNetLabelPlacements: InlineNetLabelPlacement[]
+}
+
 type InlineEligibleConnection = InputDirectConnection | InputNetConnection
 
 const getPinPairKey = (pinIds: readonly string[]) =>
@@ -236,10 +245,11 @@ export class InlineNetLabelSolver extends BaseSolver {
 
     const height =
       connection.inlineNetLabelHeight ?? DEFAULT_INLINE_NET_LABEL_HEIGHT
+    const netLabelText = connection.netLabelText?.trim() || undefined
     const width =
       connection.inlineNetLabelWidth ??
       connection.netLabelWidth ??
-      estimateInlineNetLabelWidth(connection.netId, height)
+      estimateInlineNetLabelWidth(netLabelText ?? connection.netId, height)
 
     // Leave a small wire tail at both ends of the text so it unmistakably
     // reads as a label on a trace rather than free-standing text.
@@ -310,6 +320,7 @@ export class InlineNetLabelSolver extends BaseSolver {
     return {
       globalConnNetId: anchoredPlacement.globalConnNetId,
       netId: connection.netId,
+      netLabelText,
       pinIds: [pinId],
       stubTracePath: [start, end],
       axis,
@@ -336,10 +347,11 @@ export class InlineNetLabelSolver extends BaseSolver {
 
     const height =
       connection.inlineNetLabelHeight ?? DEFAULT_INLINE_NET_LABEL_HEIGHT
+    const netLabelText = connection.netLabelText?.trim() || undefined
     const width =
       connection.inlineNetLabelWidth ??
       connection.netLabelWidth ??
-      estimateInlineNetLabelWidth(connection.netId!, height)
+      estimateInlineNetLabelWidth(netLabelText ?? connection.netId!, height)
 
     const offset = height / 2 + INLINE_NET_LABEL_TRACE_MARGIN
 
@@ -397,6 +409,7 @@ export class InlineNetLabelSolver extends BaseSolver {
           return {
             globalConnNetId: trace.globalConnNetId,
             netId: connection.netId,
+            netLabelText,
             mspPairId: trace.mspPairId,
             pinIds: [...connection.pinIds],
             axis: segment.axis,
@@ -417,6 +430,7 @@ export class InlineNetLabelSolver extends BaseSolver {
     const spanPlacement = this.computeSpanPlacement({
       trace,
       connection,
+      netLabelText,
       width,
       height,
       offset,
@@ -437,12 +451,14 @@ export class InlineNetLabelSolver extends BaseSolver {
   private computeSpanPlacement({
     trace,
     connection,
+    netLabelText,
     width,
     height,
     offset,
   }: {
     trace: SolvedTracePath
     connection: InlineEligibleConnection
+    netLabelText?: string
     width: number
     height: number
     offset: number
@@ -533,6 +549,7 @@ export class InlineNetLabelSolver extends BaseSolver {
         return {
           globalConnNetId: trace.globalConnNetId,
           netId: connection.netId,
+          netLabelText,
           mspPairId: trace.mspPairId,
           pinIds: [...connection.pinIds],
           axis,
@@ -636,95 +653,117 @@ export class InlineNetLabelSolver extends BaseSolver {
     // Mirrors the previous pipeline stage's visualization so that a problem
     // with no inline labels renders identically, then layers the inline labels
     // on top.
-    const graphics = visualizeInputProblem(this.inputProblem)
-    graphics.lines ??= []
-    graphics.rects ??= []
-    graphics.points ??= []
-    graphics.texts ??= []
-
-    const output = this.getOutput()
-    for (const trace of output.traces) {
+    return visualizeInlineNetLabelOutput({
+      inputProblem: this.inputProblem,
+      ...this.getOutput(),
+    })
+  }
+}
+
+export const visualizeInlineNetLabelOutput = ({
+  inputProblem,
+  traces,
+  netLabelPlacements,
+  inlineNetLabelPlacements,
+}: InlineNetLabelOutput): GraphicsObject => {
+  const graphics = visualizeInputProblem(inputProblem)
+  graphics.lines ??= []
+  graphics.rects ??= []
+  graphics.points ??= []
+  graphics.texts ??= []
+
+  for (const trace of traces) {
+    graphics.lines.push({
+      points: trace.tracePath,
+      strokeColor: "purple",
+    })
+  }
+
+  for (const label of netLabelPlacements) {
+    graphics.rects.push({
+      center: label.center,
+      width: label.width,
+      height: label.height,
+      fill: getColorFromString(label.globalConnNetId, 0.35),
+      strokeColor: getColorFromString(label.globalConnNetId, 0.9),
+      label: `netId: ${label.netId}\nglobalConnNetId: ${label.globalConnNetId}`,
+    } as Rect & { strokeColor: string })
+    graphics.points.push({
+      x: label.anchorPoint.x,
+      y: label.anchorPoint.y,
+      color: getColorFromString(label.globalConnNetId, 0.9),
+      label: `anchorPoint\norientation: ${label.orientation}`,
+    })
+  }
+
+  for (const inlineLabel of inlineNetLabelPlacements) {
+    if (inlineLabel.stubTracePath) {
       graphics.lines.push({
-        points: trace.tracePath,
+        points: inlineLabel.stubTracePath,
         strokeColor: "purple",
       })
     }
-
-    const { netLabelPlacements } = this.getOutput()
-    for (const label of netLabelPlacements) {
-      graphics.rects.push({
-        center: label.center,
-        width: label.width,
-        height: label.height,
-        fill: getColorFromString(label.globalConnNetId, 0.35),
-        strokeColor: getColorFromString(label.globalConnNetId, 0.9),
-        label: `netId: ${label.netId}\nglobalConnNetId: ${label.globalConnNetId}`,
-      } as Rect & { strokeColor: string })
-      graphics.points.push({
-        x: label.anchorPoint.x,
-        y: label.anchorPoint.y,
-        color: getColorFromString(label.globalConnNetId, 0.9),
-        label: `anchorPoint\norientation: ${label.orientation}`,
-      })
+    const isHorizontal = inlineLabel.axis === "x"
+    let renderedWidth = inlineLabel.width
+    let renderedHeight = inlineLabel.height
+    if (!isHorizontal) {
+      renderedWidth = inlineLabel.height
+      renderedHeight = inlineLabel.width
     }
-
-    for (const inlineLabel of this.inlineNetLabelPlacements) {
-      if (inlineLabel.stubTracePath) {
-        graphics.lines.push({
-          points: inlineLabel.stubTracePath,
-          strokeColor: "purple",
-        })
+    graphics.rects.push({
+      center: inlineLabel.center,
+      width: renderedWidth,
+      height: renderedHeight,
+      fill: getColorFromString(inlineLabel.globalConnNetId, 0.35),
+      strokeColor: "green",
+      label: [
+        `INLINE netId: ${inlineLabel.netId}`,
+        `axis: ${inlineLabel.axis}`,
+        `side: ${inlineLabel.side}`,
+      ].join("\n"),
+    } as Rect & { strokeColor: string })
+
+    let textX = inlineLabel.center.x
+    let textY = inlineLabel.center.y
+    let anchorSide: Text["anchorSide"] = "center"
+    let rotation: Text["rotation"]
+    if (inlineLabel.stubTracePath) {
+      const stubStart = inlineLabel.stubTracePath[0]
+      const stubEnd = inlineLabel.stubTracePath[1]
+      let labelOffset = inlineLabel.width / 2
+      if (stubEnd[inlineLabel.axis] > stubStart[inlineLabel.axis]) {
+        labelOffset = -inlineLabel.width / 2
+        anchorSide = "center_left"
+      } else {
+        anchorSide = "center_right"
+      }
+      if (inlineLabel.axis === "x") {
+        textX += labelOffset
+      } else {
+        textY += labelOffset
       }
-      const isHorizontal = inlineLabel.axis === "x"
-      graphics.rects.push({
-        center: inlineLabel.center,
-        width: isHorizontal ? inlineLabel.width : inlineLabel.height,
-        height: isHorizontal ? inlineLabel.height : inlineLabel.width,
-        fill: getColorFromString(inlineLabel.globalConnNetId, 0.35),
-        strokeColor: "green",
-        label: [
-          `INLINE netId: ${inlineLabel.netId}`,
-          `axis: ${inlineLabel.axis}`,
-          `side: ${inlineLabel.side}`,
-        ].join("\n"),
-      } as Rect & { strokeColor: string })
-      graphics.texts.push({
-        x:
-          inlineLabel.stubTracePath && inlineLabel.axis === "x"
-            ? inlineLabel.center.x +
-              (inlineLabel.stubTracePath[1].x > inlineLabel.stubTracePath[0].x
-                ? -inlineLabel.width / 2
-                : inlineLabel.width / 2)
-            : inlineLabel.center.x,
-        y:
-          inlineLabel.stubTracePath && inlineLabel.axis === "y"
-            ? inlineLabel.center.y +
-              (inlineLabel.stubTracePath[1].y > inlineLabel.stubTracePath[0].y
-                ? -inlineLabel.width / 2
-                : inlineLabel.width / 2)
-            : inlineLabel.center.y,
-        text: inlineLabel.netId ?? "",
-        color: "green",
-        fontSize: inlineLabel.height,
-        anchorSide: inlineLabel.stubTracePath
-          ? inlineLabel.stubTracePath[1][inlineLabel.axis] >
-            inlineLabel.stubTracePath[0][inlineLabel.axis]
-            ? "center_left"
-            : "center_right"
-          : "center",
-        // Vertical labels read bottom-to-top, alongside the wire they name.
-        rotation: inlineLabel.axis === "y" ? 90 : undefined,
-      })
-      graphics.points.push({
-        x: inlineLabel.anchorPoint.x,
-        y: inlineLabel.anchorPoint.y,
-        color: "green",
-        label: `inline anchor\n${inlineLabel.netId}`,
-      })
     }
-
-    return graphics
+    if (inlineLabel.axis === "y") rotation = 90
+
+    graphics.texts.push({
+      x: textX,
+      y: textY,
+      text: inlineLabel.netLabelText ?? inlineLabel.netId ?? "",
+      color: "green",
+      fontSize: inlineLabel.height,
+      anchorSide,
+      // Vertical labels read bottom-to-top, alongside the wire they name.
+      rotation,
+    })
+    graphics.points.push({
+      x: inlineLabel.anchorPoint.x,
+      y: inlineLabel.anchorPoint.y,
+      color: "green",
+      label: `inline anchor\n${inlineLabel.netLabelText ?? inlineLabel.netId}`,
+    })
   }
+
+  return graphics
 }
 
 /**

package/lib/solvers/NetLabelPlacementSolver/NetLabelPlacementSolver.ts

@@ -18,6 +18,7 @@ import { getNetLabelWidthForConnection } from "lib/utils/getNetLabelWidthForConn
 export type OverlappingSameNetTraceGroup = {
   globalConnNetId: string
   netId?: string
+  netLabelText?: string
   overlappingTraces?: SolvedTracePath
   portOnlyPinId?: string
   mspConnectionPairIds?: MspConnectionPairId[]
@@ -30,6 +31,8 @@ export interface NetLabelPlacement {
    * Optional user-provided net identifier (if present in the input problem).
    */
   netId?: string
+  /** User-facing label content, separate from the connectivity identifier. */
+  netLabelText?: string
   /**
    * MSP pair ids that the label is associated with. Port-only labels use [].
    */
@@ -116,18 +119,27 @@ export class NetLabelPlacementSolver extends BaseSolver {
       }
     }
 
-    // Map pins to user-provided netIds (if any)
+    // Map pins to user-provided connectivity ids and display text (if any).
     const userNetIdByPinId: Record<string, string | undefined> = {}
+    const netLabelTextByPinId: Record<string, string | undefined> = {}
     for (const dc of this.inputProblem.directConnections) {
       if (dc.netId) {
         const [a, b] = dc.pinIds
         userNetIdByPinId[a] = dc.netId
         userNetIdByPinId[b] = dc.netId
       }
+      const netLabelText = dc.netLabelText?.trim()
+      if (netLabelText) {
+        const [a, b] = dc.pinIds
+        netLabelTextByPinId[a] = netLabelText
+        netLabelTextByPinId[b] = netLabelText
+      }
     }
     for (const nc of this.inputProblem.netConnections) {
       for (const pid of nc.pinIds) {
         userNetIdByPinId[pid] = nc.netId
+        const netLabelText = nc.netLabelText?.trim()
+        if (netLabelText) netLabelTextByPinId[pid] = netLabelText
       }
     }
 
@@ -237,6 +249,9 @@ export class NetLabelPlacementSolver extends BaseSolver {
           const group = {
             globalConnNetId,
             netId: userNetId,
+            netLabelText: [...component]
+              .map((pinId) => netLabelTextByPinId[pinId])
+              .find((text): text is string => Boolean(text)),
             overlappingTraces: rep,
             mspConnectionPairIds,
           }
@@ -249,6 +264,7 @@ export class NetLabelPlacementSolver extends BaseSolver {
             groups.push({
               globalConnNetId,
               netId: userNetId,
+              netLabelText: netLabelTextByPinId[p],
               portOnlyPinId: p,
             })
           }

package/lib/solvers/NetLabelPlacementSolver/SingleNetLabelPlacementSolver/SingleNetLabelPlacementSolver.ts

@@ -354,6 +354,7 @@ export class SingleNetLabelPlacementSolver extends BaseSolver {
                 this.overlappingSameNetTraceGroup.globalConnNetId,
               dcConnNetId: curr.dcConnNetId,
               netId: this.overlappingSameNetTraceGroup.netId,
+              netLabelText: this.overlappingSameNetTraceGroup.netLabelText,
               mspConnectionPairIds: [curr.mspPairId],
               pinIds: [curr.pins[0].pinId, curr.pins[1].pinId],
               orientation,
@@ -374,6 +375,7 @@ export class SingleNetLabelPlacementSolver extends BaseSolver {
         globalConnNetId: this.overlappingSameNetTraceGroup.globalConnNetId,
         dcConnNetId: bestCandidate.dcConnNetId,
         netId: this.overlappingSameNetTraceGroup.netId,
+        netLabelText: this.overlappingSameNetTraceGroup.netLabelText,
         mspConnectionPairIds: [bestCandidate.mspPairId],
         pinIds: bestCandidate.pinIds,
         orientation: bestCandidate.orientation,

package/lib/solvers/NetLabelPlacementSolver/SingleNetLabelPlacementSolver/solvePortOnlyPin.ts

@@ -195,6 +195,7 @@ export function solveNetLabelPlacementForPortOnlyPin(params: {
       globalConnNetId: overlappingSameNetTraceGroup.globalConnNetId,
       dcConnNetId: undefined,
       netId: overlappingSameNetTraceGroup.netId,
+      netLabelText: overlappingSameNetTraceGroup.netLabelText,
       mspConnectionPairIds: [],
       pinIds: [pinId],
       orientation,
@@ -230,6 +231,7 @@ export function solveNetLabelPlacementForPortOnlyPin(params: {
     globalConnNetId: overlappingSameNetTraceGroup.globalConnNetId,
     dcConnNetId: undefined,
     netId: overlappingSameNetTraceGroup.netId,
+    netLabelText: overlappingSameNetTraceGroup.netLabelText,
     mspConnectionPairIds: [],
     pinIds: [pinId],
     orientation: fallbackOrientation,