@tscircuit/schematic-trace-solver 0.0.44 → 0.0.46

package/.github/workflows/bun-formatcheck.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: latest
+          bun-version: 1.3.1
 
       - name: Install dependencies
         run: bun install

package/.github/workflows/bun-pver-release.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: latest
+          bun-version: 1.3.1
       - uses: actions/setup-node@v3
         with:
           node-version: 20

package/.github/workflows/bun-test.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: latest
+          bun-version: 1.3.1
 
       - name: Install dependencies
         run: bun install

package/.github/workflows/bun-typecheck.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: latest
+          bun-version: 1.3.1
 
       - name: Install dependencies
         run: bun i

package/dist/index.d.ts

@@ -396,13 +396,20 @@ interface LabelMergingSolverOutput {
 }
 /**
  * Merges multiple net labels into a single, larger label if they are on the
- * same side of the same chip, reducing schematic clutter.
+ * same side of the same chip and physically adjacent.
  */
 declare class MergedNetLabelObstacleSolver extends BaseSolver {
     private input;
     private output;
     private inputProblem;
     private traces;
+    private pipelineStep;
+    private filteredLabels;
+    private labelGroups;
+    private groupKeysToProcess;
+    private finalPlacements;
+    private mergedLabelNetIdMap;
+    private activeMergingGroupKey;
     constructor(solverInput: LabelMergingSolverInput);
     _step(): void;
     getOutput(): LabelMergingSolverOutput;
@@ -436,7 +443,8 @@ declare class SingleOverlapSolver extends BaseSolver {
 interface OverlapCollectionSolverInput {
     inputProblem: InputProblem;
     traces: SolvedTracePath[];
-    netLabelPlacements: NetLabelPlacement[];
+    initialNetLabelPlacements: NetLabelPlacement[];
+    mergedNetLabelPlacements: NetLabelPlacement[];
     mergedLabelNetIdMap: Record<string, Set<string>>;
 }
 /**
@@ -445,7 +453,8 @@ interface OverlapCollectionSolverInput {
  */
 declare class OverlapAvoidanceStepSolver extends BaseSolver {
     inputProblem: InputProblem;
-    netLabelPlacements: NetLabelPlacement[];
+    initialNetLabelPlacements: NetLabelPlacement[];
+    mergedNetLabelPlacements: NetLabelPlacement[];
     mergedLabelNetIdMap: Record<string, Set<string>>;
     allTraces: SolvedTracePath[];
     modifiedTraces: SolvedTracePath[];
@@ -454,6 +463,8 @@ declare class OverlapAvoidanceStepSolver extends BaseSolver {
     activeSubSolver: SingleOverlapSolver | null;
     private overlapQueue;
     private recentlyFailed;
+    private currentlyProcessingOverlap;
+    private decomposedChildLabels;
     constructor(solverInput: OverlapCollectionSolverInput);
     _step(): void;
     getOutput(): {
@@ -469,8 +480,21 @@ interface TraceLabelOverlapAvoidanceSolverInput {
     netLabelPlacements: NetLabelPlacement[];
 }
 /**
- * This solver is a pipeline that runs a series of sub-solvers to resolve
- * trace-label overlaps and clean up the resulting traces.
+ * A pipeline solver responsible for resolving overlaps between schematic traces and net labels.
+ *
+ * This solver orchestrates a sequence of sub-solvers to achieve its goal:
+ * 1. **MergedNetLabelObstacleSolver**: This solver first merges labels that are
+ *    close to each other to form larger "obstacle" groups. This simplifies the
+ *    problem by reducing the number of individual obstacles the traces need to avoid.
+ * 2. **OverlapAvoidanceStepSolver**: This solver then takes the output of the merging
+ *    step and iteratively attempts to reroute traces to avoid the merged label obstacles.
+ *    It handles one overlap at a time, making it a step-by-step process.
+ *
+ * The final output is a set of modified traces that have been rerouted to avoid
+ * labels, and the set of merged labels that were used as obstacles.
+ *
+ * @param {TraceLabelOverlapAvoidanceSolverInput} solverInput - The input for the solver,
+ *   containing the initial traces, label placements, and the input problem definition.
  */
 declare class TraceLabelOverlapAvoidanceSolver extends BaseSolver {
     inputProblem: InputProblem;
@@ -517,17 +541,23 @@ declare class LongDistancePairSolver extends BaseSolver {
     };
 }
 
+/**
+ * Defines the input structure for the TraceCleanupSolver.
+ */
 interface TraceCleanupSolverInput {
     inputProblem: InputProblem;
     allTraces: SolvedTracePath[];
-    targetTraceIds: Set<string>;
     allLabelPlacements: NetLabelPlacement[];
     mergedLabelNetIdMap: Record<string, Set<string>>;
     paddingBuffer: number;
 }
 /**
- * Cleans up traces by minimizing turns and balancing L-shapes to improve
- * the overall aesthetics and readability of the schematic.
+ * The TraceCleanupSolver is responsible for improving the aesthetics and readability of schematic traces.
+ * It operates in a multi-step pipeline:
+ * 1. **Untangling Traces**: It first attempts to untangle any overlapping or highly convoluted traces using a sub-solver.
+ * 2. **Minimizing Turns**: After untangling, it iterates through each trace to minimize the number of turns, simplifying their paths.
+ * 3. **Balancing L-Shapes**: Finally, it balances L-shaped trace segments to create more visually appealing and consistent layouts.
+ * The solver processes traces one by one, applying these cleanup steps sequentially to refine the overall trace layout.
  */
 declare class TraceCleanupSolver extends BaseSolver {
     private input;
@@ -536,8 +566,13 @@ declare class TraceCleanupSolver extends BaseSolver {
     private tracesMap;
     private pipelineStep;
     private activeTraceId;
+    activeSubSolver: BaseSolver | null;
     constructor(solverInput: TraceCleanupSolverInput);
     _step(): void;
+    private _runUntangleTracesStep;
+    private _runMinimizeTurnsStep;
+    private _runBalanceLShapesStep;
+    private _processTrace;
     getOutput(): {
         traces: SolvedTracePath[];
     };