calculate-packing 0.0.50 → 0.0.52

package/README.md

@@ -3,6 +3,8 @@
 **calculate-packing** is a small TypeScript library that ships the placement /
 packing algorithm used by the [tscircuit tool-chain](https://github.com/tscircuit/tscircuit) for automatically laying out PCB components.
 
+[Paste PackInput and Debug Online](https://calculate-packing.tscircuit.com/?fixture=%7B%22path%22%3A%22site%2Fpack%2Fpack-debugger-from-input.page.tsx%22%7D)
+
 The solver turns a user-supplied `PackInput` (components, pads & strategy
 settings) into a collision-free `PackOutput` while
 

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { CircuitJson } from 'circuit-json';
 import { GraphicsObject, Point as Point$3 } from 'graphics-debug';
+import { BaseSolver as BaseSolver$1 } from '@tscircuit/solver-utils';
 import { Bounds, Point as Point$2 } from '@tscircuit/math-utils';
 
 type ComponentId = string;
@@ -122,40 +123,6 @@ declare const getGraphicsFromPackOutput: (packOutput: PackOutput) => GraphicsObj
  */
 declare const convertPackOutputToPackInput: (packed: PackOutput) => PackInput;
 
-declare class BaseSolver {
-    MAX_ITERATIONS: number;
-    solved: boolean;
-    failed: boolean;
-    iterations: number;
-    progress: number;
-    error: string | null;
-    activeSubSolver?: BaseSolver | null;
-    failedSubSolvers?: BaseSolver[];
-    timeToSolve?: number;
-    stats: Record<string, any>;
-    _setupDone: boolean;
-    setup(): void;
-    /** DO NOT OVERRIDE! Override _step() instead */
-    step(): void;
-    _setup(): void;
-    _step(): void;
-    getConstructorParams(): void;
-    solve(): void;
-    visualize(): GraphicsObject;
-    /**
-     * Called when the solver is about to fail, but we want to see if we have an
-     * "acceptable" or "passable" solution. Mostly used for optimizers that
-     * have an aggressive early stopping criterion.
-     */
-    tryFinalAcceptance(): void;
-    /**
-     * A lightweight version of the visualize method that can be used to stream
-     * progress
-     */
-    preview(): GraphicsObject;
-    noisySolve(): void;
-}
-
 type Point$1 = {
     x: number;
     y: number;
@@ -170,7 +137,7 @@ type Rect = {
 };
 
 type GlobalBounds = Bounds;
-declare class LargestRectOutsideOutlineFromPointSolver extends BaseSolver {
+declare class LargestRectOutsideOutlineFromPointSolver extends BaseSolver$1 {
     fullOutline: Point$1[];
     origin: Point$1;
     globalBounds: Bounds;
@@ -199,6 +166,47 @@ declare class LargestRectOutsideOutlineFromPointSolver extends BaseSolver {
     getLargestRect(): Rect | null;
     getLargestRectBounds(): Bounds;
     visualize(): GraphicsObject;
+    getOutput(): Rect | null;
+}
+
+declare class BaseSolver {
+    MAX_ITERATIONS: number;
+    solved: boolean;
+    failed: boolean;
+    iterations: number;
+    progress: number;
+    error: string | null;
+    activeSubSolver?: BaseSolver | null;
+    failedSubSolvers?: BaseSolver[];
+    timeToSolve?: number;
+    stats: Record<string, any>;
+    _setupDone: boolean;
+    setup(): void;
+    /** DO NOT OVERRIDE! Override _step() instead */
+    step(): void;
+    _setup(): void;
+    _step(): void;
+    getConstructorParams(): void;
+    solve(): void;
+    visualize(): GraphicsObject;
+    /**
+     * Called when the solver is about to fail, but we want to see if we have an
+     * "acceptable" or "passable" solution. Mostly used for optimizers that
+     * have an aggressive early stopping criterion.
+     */
+    tryFinalAcceptance(): void;
+    /**
+     * Override this method to return the standardized output of the solver.
+     * This method should only be called after the solver has completed successfully.
+     * Returns null by default - solvers with outputs should override this method.
+     */
+    getOutput(): any;
+    /**
+     * A lightweight version of the visualize method that can be used to stream
+     * progress
+     */
+    preview(): GraphicsObject;
+    noisySolve(): void;
 }
 
 interface Point {
@@ -273,6 +281,7 @@ declare class MultiOffsetIrlsSolver extends BaseSolver {
     getDistanceForPad(padId: string, position?: Point): number;
     computeProgress(): number;
     visualize(): GraphicsObject;
+    getOutput(): Point;
 }
 
 interface TwoPhaseIrlsSolverParams extends Omit<MultiOffsetIrlsSolverParams, "useSquaredDistance"> {
@@ -339,6 +348,10 @@ declare class TwoPhaseIrlsSolver extends BaseSolver {
         y: number;
     }): number;
     visualize(): GraphicsObject;
+    getOutput(): {
+        x: number;
+        y: number;
+    };
 }
 
 /**
@@ -351,7 +364,7 @@ declare class TwoPhaseIrlsSolver extends BaseSolver {
  * at the site/algorithm-visualizations/irls-weiszfeld-algorithm.page.tsx for
  * an interactive visualization of how it works.
  */
-declare class OutlineSegmentCandidatePointSolver extends BaseSolver {
+declare class OutlineSegmentCandidatePointSolver extends BaseSolver$1 {
     outlineSegment: [Point$2, Point$2];
     viableOutlineSegment: [Point$2, Point$2] | null;
     fullOutline: [Point$2, Point$2][];
@@ -413,6 +426,7 @@ declare class OutlineSegmentCandidatePointSolver extends BaseSolver {
      */
     private adjustPositionForOutlineCollision;
     visualize(): GraphicsObject;
+    getOutput(): Point$2 | null;
 }
 
 type Phase = "outline" | "segment_candidate" | "evaluate";
@@ -443,7 +457,7 @@ interface CandidateResult {
  *          where step=0 is the best point (lowest distance) and step=N is the
  *          worst point.
  */
-declare class SingleComponentPackSolver extends BaseSolver {
+declare class SingleComponentPackSolver extends BaseSolver$1 {
     componentToPack: InputComponent;
     packedComponents: PackedComponent[];
     packPlacementStrategy: PackPlacementStrategy;
@@ -490,6 +504,7 @@ declare class SingleComponentPackSolver extends BaseSolver {
     private visualizeSegmentCandidatePhase;
     private visualizeEvaluatePhase;
     getResult(): PackedComponent | undefined;
+    getOutput(): PackedComponent | undefined;
     getConstructorParams(): {
         componentToPack: InputComponent;
         packedComponents: PackedComponent[];
@@ -504,7 +519,7 @@ declare class SingleComponentPackSolver extends BaseSolver {
     };
 }
 
-declare class PackSolver2 extends BaseSolver {
+declare class PackSolver2 extends BaseSolver$1 {
     activeSubSolver: SingleComponentPackSolver | null | undefined;
     packInput: PackInput;
     unpackedComponentQueue: InputComponent[];
@@ -516,6 +531,10 @@ declare class PackSolver2 extends BaseSolver {
     private packFirstComponent;
     _step(): void;
     visualize(): GraphicsObject;
+    getOutput(): {
+        packedComponents: PackedComponent[];
+        unpackedComponents: InputComponent[];
+    };
 }
 
 export { type ComponentId, type GlobalBounds, type InputComponent, type InputObstacle, type InputPad, LargestRectOutsideOutlineFromPointSolver, type NetworkId, type OutputPad, type PackInput, type PackOutput, type PackPlacementStrategy, PackSolver2, type PackedComponent, type PadId, type Point$1 as Point, type Rect, convertCircuitJsonToPackOutput, convertPackOutputToPackInput, getGraphicsFromPackOutput, pack };

package/dist/index.js

@@ -320,6 +320,7 @@ var constructOutlinesFromPackedComponents = (components, opts = {}) => {
 
 // lib/OutlineSegmentCandidatePointSolver/OutlineSegmentCandidatePointSolver.ts
 import { clamp } from "@tscircuit/math-utils";
+import { BaseSolver as BaseSolver3 } from "@tscircuit/solver-utils";
 
 // lib/solver-utils/makeNumbersRounded.ts
 var makeNumbersRounded = (obj) => {
@@ -413,6 +414,14 @@ var BaseSolver = class {
    */
   tryFinalAcceptance() {
   }
+  /**
+   * Override this method to return the standardized output of the solver.
+   * This method should only be called after the solver has completed successfully.
+   * Returns null by default - solvers with outputs should override this method.
+   */
+  getOutput() {
+    return null;
+  }
   /**
    * A lightweight version of the visualize method that can be used to stream
    * progress
@@ -662,6 +671,9 @@ var MultiOffsetIrlsSolver = class extends BaseSolver {
     }
     return graphics;
   }
+  getOutput() {
+    return this.optimalPosition ?? this.currentPosition;
+  }
 };
 
 // lib/solver-utils/TwoPhaseIrlsSolver.ts
@@ -914,6 +926,9 @@ var TwoPhaseIrlsSolver = class extends BaseSolver {
     }
     return graphics;
   }
+  getOutput() {
+    return this.optimalPosition ?? this.currentPosition;
+  }
 };
 
 // lib/testing/createColorMapFromStrings.ts
@@ -1082,7 +1097,8 @@ function getOutlineBoundsWithMargin(fullOutline, margin = 0) {
 }
 
 // lib/LargestRectOutsideOutlineFromPointSolver.ts
-var LargestRectOutsideOutlineFromPointSolver = class extends BaseSolver {
+import { BaseSolver as BaseSolver2 } from "@tscircuit/solver-utils";
+var LargestRectOutsideOutlineFromPointSolver = class extends BaseSolver2 {
   fullOutline;
   origin;
   globalBounds;
@@ -1338,6 +1354,9 @@ var LargestRectOutsideOutlineFromPointSolver = class extends BaseSolver {
     }
     return graphics;
   }
+  getOutput() {
+    return this.largestRect ?? null;
+  }
 };
 
 // lib/geometry/getInputComponentBounds.ts
@@ -1424,7 +1443,7 @@ function isPointInPolygon(point, polygon) {
 }
 
 // lib/OutlineSegmentCandidatePointSolver/OutlineSegmentCandidatePointSolver.ts
-var OutlineSegmentCandidatePointSolver = class extends BaseSolver {
+var OutlineSegmentCandidatePointSolver = class extends BaseSolver3 {
   outlineSegment;
   viableOutlineSegment = null;
   fullOutline;
@@ -1932,8 +1951,14 @@ var OutlineSegmentCandidatePointSolver = class extends BaseSolver {
     }
     return graphics;
   }
+  getOutput() {
+    return this.optimalPosition ?? null;
+  }
 };
 
+// lib/SingleComponentPackSolver/SingleComponentPackSolver.ts
+import { BaseSolver as BaseSolver4 } from "@tscircuit/solver-utils";
+
 // lib/testing/getGraphicsFromPackOutput.ts
 var getGraphicsFromPackOutput = (packOutput) => {
   const rects = [];
@@ -2054,7 +2079,7 @@ function checkOverlapWithPackedComponents({
 
 // lib/SingleComponentPackSolver/SingleComponentPackSolver.ts
 import { computeDistanceBetweenBoxes as computeDistanceBetweenBoxes2 } from "@tscircuit/math-utils";
-var SingleComponentPackSolver = class extends BaseSolver {
+var SingleComponentPackSolver = class extends BaseSolver4 {
   componentToPack;
   packedComponents;
   packPlacementStrategy;
@@ -2504,6 +2529,9 @@ gap_distance=${candidate.gapDistance}`,
   getResult() {
     return this.outputPackedComponent;
   }
+  getOutput() {
+    return this.getResult();
+  }
   getConstructorParams() {
     return {
       componentToPack: this.componentToPack,
@@ -2518,6 +2546,7 @@ gap_distance=${candidate.gapDistance}`,
 };
 
 // lib/PackSolver2/PackSolver2.ts
+import { BaseSolver as BaseSolver5 } from "@tscircuit/solver-utils";
 import { computeDistanceBetweenBoxes as computeDistanceBetweenBoxes3 } from "@tscircuit/math-utils";
 
 // lib/math/getPolygonCentroid.ts
@@ -2551,7 +2580,7 @@ function getPolygonCentroid(points) {
 }
 
 // lib/PackSolver2/PackSolver2.ts
-var PackSolver2 = class extends BaseSolver {
+var PackSolver2 = class extends BaseSolver5 {
   packInput;
   unpackedComponentQueue = [];
   packedComponents = [];
@@ -2792,6 +2821,12 @@ var PackSolver2 = class extends BaseSolver {
     }
     return graphics;
   }
+  getOutput() {
+    return {
+      packedComponents: this.packedComponents,
+      unpackedComponents: this.unpackedComponentQueue
+    };
+  }
 };
 
 // lib/pack.ts

package/package.json

@@ -2,7 +2,7 @@
   "name": "calculate-packing",
   "main": "dist/index.js",
   "type": "module",
-  "version": "0.0.50",
+  "version": "0.0.52",
   "description": "Calculate a packing layout with support for different strategy configurations",
   "scripts": {
     "start": "cosmos",
@@ -22,6 +22,7 @@
     "@tscircuit/circuit-json-util": "^0.0.66",
     "@tscircuit/footprinter": "^0.0.203",
     "@tscircuit/math-utils": "^0.0.25",
+    "@tscircuit/solver-utils": "^0.0.3",
     "@types/bun": "latest",
     "@types/react": "^19.1.8",
     "@types/react-dom": "^19.1.6",