@tscircuit/props 0.0.600 → 0.0.602

package/lib/common/fanoutProps.ts

@@ -0,0 +1,65 @@
+import { layer_ref, type LayerRef, type LayerRefInput } from "circuit-json"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+import type { BusName } from "../components/bus"
+import {
+  type FanoutBoundaryPadding,
+  fanoutBoundaryPadding,
+} from "./fanoutBoundaryPadding"
+import { type NinePointAnchor, ninePointAnchor } from "./ninePointAnchor"
+
+export type BusFanoutDirection =
+  | NinePointAnchor
+  | {
+      direction: NinePointAnchor
+    }
+
+export type FanoutPourNetMap = Partial<
+  Record<Extract<LayerRef, string>, string | string[]>
+>
+
+/**
+ * Routing controls shared by fanout autorouting phases and breakout groups.
+ */
+export interface FanoutProps {
+  /**
+   * Fanout direction for each named bus. `center` leaves the direction
+   * unconstrained.
+   */
+  busFanoutDirections?: Record<BusName, BusFanoutDirection>
+  /**
+   * Padding between the union of the fanout source pads and the shared
+   * boundary where fanout traces terminate.
+   */
+  fanoutBoundaryPadding?: FanoutBoundaryPadding
+  /**
+   * Copper layers available to boundary-terminated fanout buses. Source-only
+   * traces whose nets are mapped by `fanoutPourNetMap` terminate on their
+   * mapped plane layer.
+   */
+  fanoutRoutingLayers?: LayerRefInput[]
+  /**
+   * Maps copper layers to the net or nets poured on them. During fanout,
+   * source-only traces on those nets drop to the mapped layer instead of
+   * routing to the breakout boundary.
+   *
+   * This is inferred from `<copperpour>` components when omitted.
+   */
+  fanoutPourNetMap?: FanoutPourNetMap
+}
+
+export const busFanoutDirection = z.union([
+  ninePointAnchor,
+  z.object({ direction: ninePointAnchor }),
+])
+
+export const fanoutProps = z.object({
+  busFanoutDirections: z.record(busFanoutDirection).optional(),
+  fanoutBoundaryPadding: fanoutBoundaryPadding.optional(),
+  fanoutRoutingLayers: z.array(layer_ref).min(1).optional(),
+  fanoutPourNetMap: z
+    .record(layer_ref, z.union([z.string(), z.array(z.string()).min(1)]))
+    .optional(),
+})
+
+expectTypesMatch<FanoutProps, z.input<typeof fanoutProps>>(true)

package/lib/components/autoroutingphase.ts

@@ -1,15 +1,6 @@
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
-import { layer_ref, type LayerRef, type LayerRefInput } from "circuit-json"
-import {
-  type FanoutBoundaryPadding,
-  fanoutBoundaryPadding,
-} from "../common/fanoutBoundaryPadding"
-import {
-  type NinePointAnchor,
-  ninePointAnchor,
-} from "../common/ninePointAnchor"
-import type { BusName } from "./bus"
+import { type FanoutProps, fanoutProps } from "../common/fanoutProps"
 import {
   type AutorouterProp,
   type RoutingTolerances,
@@ -17,17 +8,12 @@ import {
   routingTolerances,
 } from "./group"
 
-export type BusFanoutDirection =
-  | NinePointAnchor
-  | {
-      direction: NinePointAnchor
-    }
-
-export type FanoutPourNetMap = Partial<
-  Record<Extract<LayerRef, string>, string | string[]>
->
+export type {
+  BusFanoutDirection,
+  FanoutPourNetMap,
+} from "../common/fanoutProps"
 
-export interface AutoroutingPhaseProps extends RoutingTolerances {
+export interface AutoroutingPhaseProps extends RoutingTolerances, FanoutProps {
   key?: any
   name?: string
   autorouter?: AutorouterProp
@@ -42,37 +28,8 @@ export interface AutoroutingPhaseProps extends RoutingTolerances {
   connection?: string
   connections?: string[]
   reroute?: boolean
-  /**
-   * Fanout direction for each named bus in this phase. `center` leaves the
-   * direction unconstrained.
-   */
-  busFanoutDirections?: Record<BusName, BusFanoutDirection>
-  /**
-   * Padding between the union of the fanout source pads and the shared
-   * boundary where fanout traces terminate.
-   */
-  fanoutBoundaryPadding?: FanoutBoundaryPadding
-  /**
-   * Copper layers available to boundary-terminated fanout buses. Source-only
-   * traces whose nets are mapped by `fanoutPourNetMap` terminate on their
-   * mapped plane layer.
-   */
-  fanoutRoutingLayers?: LayerRefInput[]
-  /**
-   * Maps copper layers to the net or nets poured on them. During fanout,
-   * source-only traces on those nets drop to the mapped layer instead of
-   * routing to the breakout boundary.
-   *
-   * This is inferred from `<copperpour>` components when omitted.
-   */
-  fanoutPourNetMap?: FanoutPourNetMap
 }
 
-const busFanoutDirection = z.union([
-  ninePointAnchor,
-  z.object({ direction: ninePointAnchor }),
-])
-
 export const autoroutingPhaseProps = z
   .object({
     key: z.any().optional(),
@@ -92,12 +49,7 @@ export const autoroutingPhaseProps = z
     connection: z.string().optional(),
     connections: z.array(z.string()).optional(),
     reroute: z.boolean().optional(),
-    busFanoutDirections: z.record(busFanoutDirection).optional(),
-    fanoutBoundaryPadding: fanoutBoundaryPadding.optional(),
-    fanoutRoutingLayers: z.array(layer_ref).min(1).optional(),
-    fanoutPourNetMap: z
-      .record(layer_ref, z.union([z.string(), z.array(z.string()).min(1)]))
-      .optional(),
+    ...fanoutProps.shape,
   })
   .superRefine((value, ctx) => {
     if (

package/lib/components/breakout.ts

@@ -1,8 +1,5 @@
 import { distance, type Distance } from "lib/common/distance"
-import {
-  type FanoutBoundaryPadding,
-  fanoutBoundaryPadding,
-} from "lib/common/fanoutBoundaryPadding"
+import { type FanoutProps, fanoutProps } from "lib/common/fanoutProps"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 import {
@@ -13,7 +10,8 @@ import {
 } from "./group"
 
 export interface BreakoutProps
-  extends Omit<SubcircuitGroupProps, "subcircuit"> {
+  extends Omit<SubcircuitGroupProps, "subcircuit">,
+    FanoutProps {
   /**
    * Autorouter used to escape the components inside the breakout boundary.
    * Defaults to the multilayer fanout autorouter.
@@ -24,12 +22,6 @@ export interface BreakoutProps
   paddingRight?: Distance
   paddingTop?: Distance
   paddingBottom?: Distance
-  /**
-   * Padding between the union of the fanout source pads and the shared
-   * boundary where fanout traces terminate. This is independent of the
-   * breakout group's layout padding.
-   */
-  fanoutBoundaryPadding?: FanoutBoundaryPadding
 }
 
 export const breakoutProps = subcircuitGroupProps.extend({
@@ -39,7 +31,7 @@ export const breakoutProps = subcircuitGroupProps.extend({
   paddingRight: distance.optional(),
   paddingTop: distance.optional(),
   paddingBottom: distance.optional(),
-  fanoutBoundaryPadding: fanoutBoundaryPadding.optional(),
+  ...fanoutProps.shape,
 })
 
 type InferredBreakoutProps = z.input<typeof breakoutProps>

package/lib/components/bus.ts

@@ -11,11 +11,14 @@ export interface BusProps {
   name?: string
   /** Trace names or port selectors for the connections in the bus. */
   connections: string[]
+  /** Autorouting phase in which this bus constraint should be applied. */
+  routingPhaseIndex?: number | null
 }
 
 export const busProps = z.object({
   name: z.string().optional(),
   connections: z.array(z.string()).min(2),
+  routingPhaseIndex: z.number().nullable().optional(),
 })
 
 type InferredBusProps = z.input<typeof busProps>

package/lib/index.ts

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

package/package.json

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