@tscircuit/props 0.0.647 → 0.0.648

package/lib/common/fanoutTracePath.ts

@@ -0,0 +1,67 @@
+import { layer_ref } from "circuit-json"
+import { z } from "zod"
+import { distance } from "./distance"
+
+const coordinate = distance.refine(Number.isFinite, "Coordinate must be finite")
+const positiveDistance = distance.refine(
+  (value) => Number.isFinite(value) && value > 0,
+  "Distance must be positive and finite",
+)
+const routePoint = z.discriminatedUnion("route_type", [
+  z.object({
+    route_type: z.literal("wire"),
+    x: coordinate,
+    y: coordinate,
+    width: positiveDistance,
+    layer: layer_ref,
+  }),
+  z.object({
+    route_type: z.literal("via"),
+    x: coordinate,
+    y: coordinate,
+    from_layer: layer_ref,
+    to_layer: layer_ref,
+    via_diameter: positiveDistance.optional(),
+    via_hole_diameter: positiveDistance.optional(),
+  }),
+])
+
+/**
+ * A saved route from a selected port to a fanout exit. Points are in the
+ * fanout's local PCB frame, in mm: +X right, +Y up, right-handed with +Z
+ * above the board. They are points (placement adds translation), not
+ * directions. Numeric distances are mm; unit strings are parsed to mm.
+ * Layers are physical board layers, independent of placement.
+ */
+export const fanoutTracePath = z.object({
+  connection: z.string().min(1),
+  route: z
+    .array(routePoint)
+    .min(2)
+    .superRefine((route, ctx) => {
+      if (
+        route[0]?.route_type !== "wire" ||
+        route.at(-1)?.route_type !== "wire"
+      ) {
+        ctx.addIssue({
+          code: "custom",
+          message: "A fanout trace path must start and end with wire points",
+        })
+      }
+      let layer = route[0]?.route_type === "wire" ? route[0].layer : undefined
+      for (const point of route) {
+        if (
+          (point.route_type === "wire" ? point.layer : point.from_layer) !==
+          layer
+        ) {
+          ctx.addIssue({
+            code: "custom",
+            message: "A fanout trace path must use vias for layer changes",
+          })
+        }
+        if (point.route_type === "via") layer = point.to_layer
+      }
+    }),
+})
+
+export type FanoutTracePath = z.input<typeof fanoutTracePath>

package/lib/components/breakout.ts

@@ -1,3 +1,7 @@
+import {
+  fanoutTracePath,
+  type FanoutTracePath,
+} from "lib/common/fanoutTracePath"
 import { distance, type Distance } from "lib/common/distance"
 import { type FanoutProps, fanoutProps } from "lib/common/fanoutProps"
 import { expectTypesMatch } from "lib/typecheck"
@@ -17,6 +21,17 @@ export interface BreakoutProps
    * Defaults to the multilayer fanout autorouter.
    */
   autorouter?: AutorouterProp
+  /**
+   * Saved port-to-exit wire/via routes in the fanout's local PCB frame.
+   * Numeric distances are mm; unit strings are normalized to mm. Each route
+   * must start at its selected port and end at its fanout exit. Layers name
+   * physical board layers. Core creates the exits and preserves saved copper.
+   * When supplied, replaces automatic routing (including `autorouter`) for
+   * this fanout and must cover all its routing connections. Do not also add
+   * a breakoutpoint/fanoutpoint for the same port. Omitted by default; existing
+   * automatic fanouts are unchanged. No aliases or migration are required.
+   */
+  pcbTracePaths?: FanoutTracePath[]
   padding?: Distance
   paddingLeft?: Distance
   paddingRight?: Distance
@@ -35,6 +50,7 @@ const nonnegativeFanoutMargin = distance.refine((value) => value >= 0, {
 
 export const breakoutProps = subcircuitGroupProps.extend({
   autorouter: autorouterProp.default("fanout"),
+  pcbTracePaths: z.array(fanoutTracePath).optional(),
   padding: distance.optional(),
   paddingLeft: distance.optional(),
   paddingRight: distance.optional(),

package/lib/index.ts

@@ -145,3 +145,5 @@ export * from "./common/ninePointAnchor"
 export * from "./common/fanoutBoundaryPadding"
 export * from "./common/fanoutProps"
 export * from "./common/implicitBreakoutPointSolver"
+
+export * from "./common/fanoutTracePath"

package/package.json

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