@tscircuit/props 0.0.627 → 0.0.628

package/lib/common/implicitBreakoutPointSolver.ts

@@ -0,0 +1,71 @@
+export interface ImplicitBreakoutPoint {
+  readonly x: number
+  readonly y: number
+}
+
+export interface ImplicitBreakoutBounds {
+  readonly minX: number
+  readonly maxX: number
+  readonly minY: number
+  readonly maxY: number
+}
+
+export type ImplicitBreakoutEdge = "left" | "right" | "bottom" | "top"
+
+export interface ImplicitBreakoutRegion {
+  readonly regionId: string
+  readonly bounds: ImplicitBreakoutBounds
+  readonly edge: ImplicitBreakoutEdge
+}
+
+export interface ImplicitBreakoutConnectionEndpoint {
+  readonly regionId: string
+  readonly position: ImplicitBreakoutPoint
+}
+
+export interface ImplicitBreakoutConnection {
+  readonly connectionId: string
+  readonly endpoints: readonly ImplicitBreakoutConnectionEndpoint[]
+}
+
+export interface ImplicitBreakoutDifferentialPair {
+  readonly type: "differential"
+  readonly connections: readonly [
+    ImplicitBreakoutConnection,
+    ImplicitBreakoutConnection,
+  ]
+}
+
+export type ImplicitBreakoutConnectionOrDifferentialPair =
+  | ImplicitBreakoutConnection
+  | ImplicitBreakoutDifferentialPair
+
+export interface ImplicitBreakoutBus {
+  readonly busId: string
+  readonly connectionIds: readonly string[]
+  /** Ordered candidate layers that the solver may distribute this bus over. */
+  readonly targetLayers?: readonly string[]
+}
+
+export interface ImplicitBreakoutPointSolverInput {
+  readonly regions: readonly ImplicitBreakoutRegion[]
+  readonly connections: readonly ImplicitBreakoutConnectionOrDifferentialPair[]
+  readonly buses: readonly ImplicitBreakoutBus[]
+  readonly boundaryPointSpacing: number
+}
+
+export interface ImplicitBreakoutSolverPoint extends ImplicitBreakoutPoint {
+  readonly regionId: string
+  readonly connectionId: string
+  readonly layer: string
+}
+
+export interface ImplicitBreakoutPointSolverOutput {
+  readonly breakoutPoints: readonly ImplicitBreakoutSolverPoint[]
+}
+
+export type ImplicitBreakoutPointSolverFn = (
+  input: ImplicitBreakoutPointSolverInput,
+) =>
+  | ImplicitBreakoutPointSolverOutput
+  | Promise<ImplicitBreakoutPointSolverOutput>

package/lib/components/group.ts

@@ -33,6 +33,7 @@ import {
 } from "lib/common/schematicPinStyle"
 import { url } from "lib/common/url"
 import type { Connections } from "lib/utility-types/connections-and-selectors"
+import type { ImplicitBreakoutPointSolverFn } from "lib/common/implicitBreakoutPointSolver"
 
 export const layoutConfig = z.object({
   layoutMode: z
@@ -342,6 +343,8 @@ export interface AutorouterConfig {
     | /** @deprecated Use "sequential_trace" */ "sequential-trace"
   local?: boolean
   algorithmFn?: (simpleRouteJson: any) => Promise<any>
+  /** Override the solver used to place implicit breakout points. */
+  implicitBreakoutPointSolverFn?: ImplicitBreakoutPointSolverFn
   preset?:
     | "sequential_trace"
     | "subcircuit"
@@ -423,6 +426,11 @@ export const autorouterConfig = z.object({
       (v) => typeof v === "function" || v === undefined,
     )
     .optional(),
+  implicitBreakoutPointSolverFn: z
+    .custom<ImplicitBreakoutPointSolverFn>(
+      (value) => typeof value === "function" || value === undefined,
+    )
+    .optional(),
   preset: z
     .enum([
       "sequential_trace",

package/lib/index.ts

@@ -141,3 +141,4 @@ export * from "./utility-types/connections-and-selectors"
 export * from "./common/ninePointAnchor"
 export * from "./common/fanoutBoundaryPadding"
 export * from "./common/fanoutProps"
+export * from "./common/implicitBreakoutPointSolver"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.627",
+  "version": "0.0.628",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",