@tscircuit/props 0.0.633 → 0.0.634

package/lib/common/fanoutProps.ts

@@ -1,4 +1,4 @@
-import { layer_ref, type LayerRef, type LayerRefInput } from "circuit-json"
+import { type LayerRef, type LayerRefInput, layer_ref } from "circuit-json"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 import type { BusName } from "../components/bus"
@@ -8,10 +8,59 @@ import {
 } from "./fanoutBoundaryPadding"
 import { type NinePointAnchor, ninePointAnchor } from "./ninePointAnchor"
 
-export type BusFanoutDirection =
+/**
+ * An unambiguous fanout direction and boundary position.
+ *
+ * The prefix before `side` names the physical boundary edge. The suffix names
+ * the region along that edge; for corner regions it also names the local
+ * direction used to escape the source pads. For example, `rightside_top`
+ * terminates on the right edge in its upper region after escaping the source
+ * pads toward the top, while `topside_right` terminates on the top edge in its
+ * right region after escaping toward the right. Center regions escape toward
+ * their named edge. Directions are in board/circuit world coordinates, where
+ * right is +X and top is +Y; they do not rotate with the source component.
+ * `center` leaves the fanout direction unconstrained.
+ */
+export const canonicalBusFanoutDirectionValues = [
+  "topside_left",
+  "topside_center",
+  "topside_right",
+  "rightside_top",
+  "rightside_center",
+  "rightside_bottom",
+  "bottomside_right",
+  "bottomside_center",
+  "bottomside_left",
+  "leftside_bottom",
+  "leftside_center",
+  "leftside_top",
+  "center",
+] as const
+
+export const canonicalBusFanoutDirection = z.enum(
+  canonicalBusFanoutDirectionValues,
+)
+
+export type CanonicalBusFanoutDirection =
+  (typeof canonicalBusFanoutDirectionValues)[number]
+
+/**
+ * Legacy NinePointAnchor fanout names. `top_left`, `top_center`, `top_right`,
+ * `center_left`, `center`, `center_right`, `bottom_left`, `bottom_center`, and
+ * `bottom_right` remain accepted unchanged and retain their destination-guided
+ * behavior. Prefer `CanonicalBusFanoutDirection` when the physical exit edge
+ * matters.
+ */
+export type LegacyBusFanoutDirection = NinePointAnchor
+
+export type BusFanoutDirectionLiteral =
   | NinePointAnchor
+  | CanonicalBusFanoutDirection
+
+export type BusFanoutDirection =
+  | BusFanoutDirectionLiteral
   | {
-      direction: NinePointAnchor
+      direction: BusFanoutDirectionLiteral
     }
 
 export type FanoutPourNetMap = Partial<
@@ -23,8 +72,14 @@ export type FanoutPourNetMap = Partial<
  */
 export interface FanoutProps {
   /**
-   * Fanout direction for each named bus. `center` leaves the direction
-   * unconstrained.
+   * Fanout direction and boundary position for each named bus. Prefer the
+   * edge-first names such as `rightside_top` and `topside_right` when selecting
+   * a corner region; their physical exit edges are unambiguous. All legacy
+   * NinePointAnchor names remain accepted unchanged and retain their
+   * destination-guided behavior. `center` leaves the direction unconstrained.
+   * Directions use board/circuit world coordinates. For a bus that terminates
+   * on a copper plane, the physical-edge prefix is ignored and only the
+   * position's local escape direction is used.
    */
   busFanoutDirections?: Record<BusName, BusFanoutDirection>
   /**
@@ -50,7 +105,10 @@ export interface FanoutProps {
 
 export const busFanoutDirection = z.union([
   ninePointAnchor,
-  z.object({ direction: ninePointAnchor }),
+  canonicalBusFanoutDirection,
+  z.object({
+    direction: z.union([ninePointAnchor, canonicalBusFanoutDirection]),
+  }),
 ])
 
 export const fanoutProps = z.object({

package/lib/components/autoroutingphase.ts

@@ -10,7 +10,10 @@ import {
 
 export type {
   BusFanoutDirection,
+  BusFanoutDirectionLiteral,
+  CanonicalBusFanoutDirection,
   FanoutPourNetMap,
+  LegacyBusFanoutDirection,
 } from "../common/fanoutProps"
 
 export interface AutoroutingPhaseProps extends RoutingTolerances, FanoutProps {

package/package.json

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