@tscircuit/schematic-trace-solver 0.0.151 → 0.0.153

package/dist/index.d.ts

@@ -59,6 +59,11 @@ type NetId = string;
 type SectionId = string;
 interface InputPin {
     pinId: PinId;
+    /**
+     * User-facing label for this schematic port. `pinId` remains the stable,
+     * opaque routing identity and must not be shown in schematic output.
+     */
+    displayName?: string;
     x: number;
     y: number;
     _facingDirection?: "x+" | "x-" | "y+" | "y-";
@@ -103,11 +108,11 @@ interface InputDirectConnection {
     netLabelText?: string;
     netLabelWidth?: number;
     /**
-     * Width of the conventional anchored label to use only when an inline label
-     * cannot be placed. Unlike `netLabelWidth`, this does not affect whether or
-     * how the point-to-point connection is routed.
+     * Width of the conventional label anchored to a trace endpoint. Unlike
+     * `netLabelWidth`, this does not affect whether or how the point-to-point
+     * connection is routed.
      */
-    fallbackNetLabelWidth?: number;
+    anchoredNetLabelWidth?: number;
     /**
      * When true, this point-to-point connection may be labeled with an "inline
      * net label": the net name is drawn parallel to (and offset from) the routed
@@ -144,7 +149,7 @@ interface InputNetConnection {
      */
     netLabelText?: string;
     netLabelWidth?: number;
-    fallbackNetLabelWidth?: number;
+    anchoredNetLabelWidth?: number;
     netLabelHeight?: number;
     /**
      * When true, a named one- or two-pin net may use inline labels. A single-pin

package/dist/index.js

@@ -168,7 +168,7 @@ var visualizeInputProblem = (inputProblem, opts = {}) => {
     });
     for (const pin of chip.pins) {
       graphics.points.push({
-        label: `${pin.pinId}
+        label: `${pin.displayName ?? pin.pinId}
 ${pin._facingDirection ?? getPinDirection(pin, chip)}`,
         x: pin.x,
         y: pin.y,
@@ -679,21 +679,20 @@ import "graphics-debug";
 import { calculateElbow as calculateElbow2 } from "calculate-elbow";
 
 // lib/utils/getNetLabelWidthForConnection.ts
-var getConfiguredWidth = (connections, includeFallbackNetLabelWidth) => {
-  const explicitWidth = connections.find(
+var getConfiguredWidth = (connections, isPortOnlyLabel2) => {
+  const width = connections.find(
     (connection) => connection?.netLabelWidth !== void 0
   )?.netLabelWidth;
-  if (explicitWidth !== void 0) return explicitWidth;
-  if (!includeFallbackNetLabelWidth) return void 0;
+  if (width !== void 0 || !isPortOnlyLabel2) return width;
   return connections.find(
-    (connection) => connection?.fallbackNetLabelWidth !== void 0
-  )?.fallbackNetLabelWidth;
+    (connection) => connection?.anchoredNetLabelWidth !== void 0
+  )?.anchoredNetLabelWidth;
 };
 var getNetLabelWidthForConnection = ({
   inputProblem,
   netId,
   pinIds,
-  includeFallbackNetLabelWidth = true
+  isPortOnlyLabel: isPortOnlyLabel2
 }) => {
   if (netId) {
     const widthByNetId = getConfiguredWidth(
@@ -705,7 +704,7 @@ var getNetLabelWidthForConnection = ({
           (connection) => connection.netId === netId
         )
       ],
-      includeFallbackNetLabelWidth
+      isPortOnlyLabel2
     );
     if (widthByNetId !== void 0) return widthByNetId;
   }
@@ -718,7 +717,7 @@ var getNetLabelWidthForConnection = ({
         (connection) => connection.pinIds.some((pinId) => pinIds.includes(pinId))
       )
     ],
-    includeFallbackNetLabelWidth
+    isPortOnlyLabel2
   );
 };
 
@@ -1329,7 +1328,7 @@ var SchematicTraceSingleLineSolver2 = class extends BaseSolver {
       inputProblem: this.inputProblem,
       netId,
       pinIds: this.pins.map((pin) => pin.pinId),
-      includeFallbackNetLabelWidth: false
+      isPortOnlyLabel: false
     });
     const netLabelHeight = this.getNetLabelHeightForConnectionPair(netId);
     const padding = {
@@ -3270,7 +3269,8 @@ var NetLabelPlacementSolver = class extends BaseSolver {
     return getNetLabelWidthForConnection({
       inputProblem: this.inputProblem,
       netId: group.netId,
-      pinIds
+      pinIds,
+      isPortOnlyLabel: group.portOnlyPinId !== void 0
     });
   }
   getNetLabelHeightForGroup(group) {
@@ -8620,7 +8620,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
     const blockedLabelWidth = getNetLabelWidthForConnection({
       inputProblem: this.inputProblem,
       netId: blockedLabel.netId,
-      pinIds: blockedLabel.pinIds
+      pinIds: blockedLabel.pinIds,
+      isPortOnlyLabel: this.isPortOnlyLabel(blockedLabel)
     });
     let columnLabelIndex;
     if (blockedLabelWidth !== void 0) {
@@ -8630,7 +8631,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
         return getNetLabelWidthForConnection({
           inputProblem: this.inputProblem,
           netId: label.netId,
-          pinIds: label.pinIds
+          pinIds: label.pinIds,
+          isPortOnlyLabel: this.isPortOnlyLabel(label)
         }) === blockedLabelWidth;
       });
     }
@@ -8855,7 +8857,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
       netLabelWidth: getNetLabelWidthForConnection({
         inputProblem: this.inputProblem,
         netId: label.netId,
-        pinIds: label.pinIds
+        pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label)
       }),
       netLabelHeight: this.getNetLabelHeight(label)
     });
@@ -9293,7 +9296,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
       netLabelWidth: getNetLabelWidthForConnection({
         inputProblem: this.inputProblem,
         netId: label.netId,
-        pinIds: label.pinIds
+        pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label)
       }),
       netLabelHeight: this.getNetLabelHeight(label)
     });
@@ -9315,7 +9319,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
       netLabelWidth: getNetLabelWidthForConnection({
         inputProblem: this.inputProblem,
         netId: label.netId,
-        pinIds: label.pinIds
+        pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label)
       }),
       netLabelHeight: this.getNetLabelHeight(label)
     });
@@ -9374,7 +9379,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
       netLabelWidth: getNetLabelWidthForConnection({
         inputProblem: this.inputProblem,
         netId: label.netId,
-        pinIds: label.pinIds
+        pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label)
       }),
       netLabelHeight: this.getNetLabelHeight(label)
     });
@@ -9429,7 +9435,8 @@ var AvailableNetOrientationSolver = class extends BaseSolver {
       netLabelWidth: getNetLabelWidthForConnection({
         inputProblem: this.inputProblem,
         netId: label.netId,
-        pinIds: label.pinIds
+        pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label)
       }),
       netLabelHeight: this.getNetLabelHeight(label)
     });
@@ -10643,7 +10650,8 @@ var getNetLabelWidth = (inputProblem, label) => {
   const configuredWidth = getNetLabelWidthForConnection({
     inputProblem,
     netId: label.netId,
-    pinIds: label.pinIds
+    pinIds: label.pinIds,
+    isPortOnlyLabel: label.mspConnectionPairIds.length === 0
   });
   if (configuredWidth !== void 0) return configuredWidth;
   if (label.orientation === "y+" || label.orientation === "y-") {

package/lib/solvers/AvailableNetOrientationSolver/AvailableNetOrientationSolver.ts

@@ -185,6 +185,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
       inputProblem: this.inputProblem,
       netId: blockedLabel.netId,
       pinIds: blockedLabel.pinIds,
+      isPortOnlyLabel: this.isPortOnlyLabel(blockedLabel),
     })
     let columnLabelIndex: number | undefined
     if (blockedLabelWidth !== undefined) {
@@ -196,6 +197,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
             inputProblem: this.inputProblem,
             netId: label.netId,
             pinIds: label.pinIds,
+            isPortOnlyLabel: this.isPortOnlyLabel(label),
           }) === blockedLabelWidth
         )
       })
@@ -496,6 +498,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
         inputProblem: this.inputProblem,
         netId: label.netId,
         pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label),
       }),
       netLabelHeight: this.getNetLabelHeight(label),
     })
@@ -1113,6 +1116,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
         inputProblem: this.inputProblem,
         netId: label.netId,
         pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label),
       }),
       netLabelHeight: this.getNetLabelHeight(label),
     })
@@ -1141,6 +1145,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
         inputProblem: this.inputProblem,
         netId: label.netId,
         pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label),
       }),
       netLabelHeight: this.getNetLabelHeight(label),
     })
@@ -1224,6 +1229,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
         inputProblem: this.inputProblem,
         netId: label.netId,
         pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label),
       }),
       netLabelHeight: this.getNetLabelHeight(label),
     })
@@ -1309,6 +1315,7 @@ export class AvailableNetOrientationSolver extends BaseSolver {
         inputProblem: this.inputProblem,
         netId: label.netId,
         pinIds: label.pinIds,
+        isPortOnlyLabel: this.isPortOnlyLabel(label),
       }),
       netLabelHeight: this.getNetLabelHeight(label),
     })

package/lib/solvers/NetLabelPlacementSolver/NetLabelPlacementSolver.ts

@@ -286,6 +286,7 @@ export class NetLabelPlacementSolver extends BaseSolver {
       inputProblem: this.inputProblem,
       netId: group.netId,
       pinIds,
+      isPortOnlyLabel: group.portOnlyPinId !== undefined,
     })
   }
 

package/lib/solvers/SchematicTraceLinesSolver/SchematicTraceSingleLineSolver2/SchematicTraceSingleLineSolver2.ts

@@ -206,7 +206,7 @@ export class SchematicTraceSingleLineSolver2 extends BaseSolver {
       inputProblem: this.inputProblem,
       netId,
       pinIds: this.pins.map((pin) => pin.pinId),
-      includeFallbackNetLabelWidth: false,
+      isPortOnlyLabel: false,
     })
     const netLabelHeight = this.getNetLabelHeightForConnectionPair(netId)
     const padding: Required<RectPadding> = {

package/lib/solvers/SchematicTracePipelineSolver/visualizeInputProblem.ts

@@ -44,7 +44,7 @@ export const visualizeInputProblem = (
 
     for (const pin of chip.pins) {
       graphics.points.push({
-        label: `${pin.pinId}\n${pin._facingDirection ?? getPinDirection(pin, chip)}`,
+        label: `${pin.displayName ?? pin.pinId}\n${pin._facingDirection ?? getPinDirection(pin, chip)}`,
         x: pin.x,
         y: pin.y,
         color: getColorFromString(pin.pinId, 0.8),

package/lib/solvers/TraceAnchoredNetLabelOverlapSolver/candidates.ts

@@ -315,6 +315,7 @@ const getNetLabelWidth = (
     inputProblem,
     netId: label.netId,
     pinIds: label.pinIds,
+    isPortOnlyLabel: label.mspConnectionPairIds.length === 0,
   })
   if (configuredWidth !== undefined) return configuredWidth
 

package/lib/types/InputProblem.ts

@@ -8,6 +8,13 @@ export type SectionId = string
 
 export interface InputPin {
   pinId: PinId
+
+  /**
+   * User-facing label for this schematic port. `pinId` remains the stable,
+   * opaque routing identity and must not be shown in schematic output.
+   */
+  displayName?: string
+
   x: number
   y: number
 
@@ -53,11 +60,11 @@ export interface InputDirectConnection {
   netLabelWidth?: number
 
   /**
-   * Width of the conventional anchored label to use only when an inline label
-   * cannot be placed. Unlike `netLabelWidth`, this does not affect whether or
-   * how the point-to-point connection is routed.
+   * Width of the conventional label anchored to a trace endpoint. Unlike
+   * `netLabelWidth`, this does not affect whether or how the point-to-point
+   * connection is routed.
    */
-  fallbackNetLabelWidth?: number
+  anchoredNetLabelWidth?: number
 
   /**
    * When true, this point-to-point connection may be labeled with an "inline
@@ -99,7 +106,7 @@ export interface InputNetConnection {
    */
   netLabelText?: string
   netLabelWidth?: number
-  fallbackNetLabelWidth?: number
+  anchoredNetLabelWidth?: number
   netLabelHeight?: number
 
   /**

package/lib/utils/getNetLabelWidthForConnection.ts

@@ -10,29 +10,28 @@ type ConnectionWithLabelWidth = InputDirectConnection | InputNetConnection
 
 const getConfiguredWidth = (
   connections: Array<ConnectionWithLabelWidth | undefined>,
-  includeFallbackNetLabelWidth: boolean,
+  isPortOnlyLabel: boolean,
 ) => {
-  const explicitWidth = connections.find(
+  const width = connections.find(
     (connection) => connection?.netLabelWidth !== undefined,
   )?.netLabelWidth
-  if (explicitWidth !== undefined) return explicitWidth
-  if (!includeFallbackNetLabelWidth) return undefined
+  if (width !== undefined || !isPortOnlyLabel) return width
 
   return connections.find(
-    (connection) => connection?.fallbackNetLabelWidth !== undefined,
-  )?.fallbackNetLabelWidth
+    (connection) => connection?.anchoredNetLabelWidth !== undefined,
+  )?.anchoredNetLabelWidth
 }
 
 export const getNetLabelWidthForConnection = ({
   inputProblem,
   netId,
   pinIds,
-  includeFallbackNetLabelWidth = true,
+  isPortOnlyLabel,
 }: {
   inputProblem: InputProblem
   netId?: NetId
   pinIds: readonly PinId[]
-  includeFallbackNetLabelWidth?: boolean
+  isPortOnlyLabel: boolean
 }): number | undefined => {
   if (netId) {
     const widthByNetId = getConfiguredWidth(
@@ -44,7 +43,7 @@ export const getNetLabelWidthForConnection = ({
           (connection) => connection.netId === netId,
         ),
       ],
-      includeFallbackNetLabelWidth,
+      isPortOnlyLabel,
     )
     if (widthByNetId !== undefined) return widthByNetId
   }
@@ -58,6 +57,6 @@ export const getNetLabelWidthForConnection = ({
         connection.pinIds.some((pinId) => pinIds.includes(pinId)),
       ),
     ],
-    includeFallbackNetLabelWidth,
+    isPortOnlyLabel,
   )
 }

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/tscircuit/schematic-trace-solver.git"
   },
   "main": "dist/index.js",
-  "version": "0.0.151",
+  "version": "0.0.153",
   "type": "module",
   "scripts": {
     "start": "cosmos",