Add bus routing constraint props

README.md

@@ -34,6 +34,7 @@ resistorProps.parse({ resistance: "10k" } as ResistorPropsInput);
 | `<board />`                             | [`BoardProps`](#boardprops-board)                                                                                  |
 | `<breakout />`                          | [`BreakoutProps`](#breakoutprops-breakout)                                                                         |
 | `<breakoutpoint />`                     | [`BreakoutPointProps`](#breakoutpointprops-breakoutpoint)                                                          |
+| `<bus />`                               | [`BusProps`](#busprops-bus)                                                                                        |
 | `<cadassembly />`                       | [`CadAssemblyProps`](#cadassemblyprops-cadassembly)                                                                |
 | `<cadmodel />`                          | [`CadModelProps`](#cadmodelprops-cadmodel)                                                                         |
 | `<capacitor />`                         | [`CapacitorProps`](#capacitorprops-capacitor)                                                                      |
@@ -429,6 +430,18 @@ export interface BreakoutPointProps extends Omit<
 
 [Source](https://github.com/tscircuit/props/blob/main/lib/components/breakoutpoint.ts)
 
+### BusProps `<bus />`
+
+```ts
+export interface BusProps {
+  name?: string;
+  /** Trace names or port selectors for the connections in the bus. */
+  connections: string[];
+}
+```
+
+[Source](https://github.com/tscircuit/props/blob/main/lib/components/bus.ts)
+
 ### CadAssemblyProps `<cadassembly />`
 
 ```ts

generated/COMPONENT_TYPES.md

@@ -1275,6 +1275,24 @@ export const breakoutPointProps = pcbLayoutProps
   })
 ```
 
+### bus
+
+```typescript
+/**
+ * Declares a group of connections that an autorouter should keep together.
+ * Each connection may be a trace name or a port selector.
+ */
+export interface BusProps {
+  name?: string
+  connections: string[]
+}
+/** Trace names or port selectors for the connections in the bus. */
+export const busProps = z.object({
+  name: z.string().optional(),
+  connections: z.array(z.string()).min(2),
+})
+```
+
 ### cadassembly
 
 ```typescript

generated/PROPS_OVERVIEW.md

@@ -408,6 +408,13 @@ export interface BreakoutProps
 }
 
 
+export interface BusProps {
+  name?: string
+  /** Trace names or port selectors for the connections in the bus. */
+  connections: string[]
+}
+
+
 export interface CadAssemblyProps {
   /**
    * The layer that the CAD assembly is designed for. If you set this to "top"

lib/components/bus.ts

@@ -0,0 +1,20 @@
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/**
+ * Declares a group of connections that an autorouter should keep together.
+ * Each connection may be a trace name or a port selector.
+ */
+export interface BusProps {
+  name?: string
+  /** Trace names or port selectors for the connections in the bus. */
+  connections: string[]
+}
+
+export const busProps = z.object({
+  name: z.string().optional(),
+  connections: z.array(z.string()).min(2),
+})
+
+type InferredBusProps = z.input<typeof busProps>
+expectTypesMatch<BusProps, InferredBusProps>(true)

lib/index.ts

@@ -58,6 +58,7 @@ export * from "./components/smtpad"
 export * from "./components/solderpaste"
 export * from "./components/hole"
 export * from "./components/trace"
+export * from "./components/bus"
 export * from "./components/differentialpair"
 export * from "./components/footprint"
 export * from "./components/symbol"

tests/bus.test.ts

@@ -0,0 +1,20 @@
+import { expect, test } from "bun:test"
+import { busProps, type BusProps } from "lib/components/bus"
+
+test("busProps accepts two or more connection references", () => {
+  const rawProps: BusProps = {
+    name: "DATA",
+    connections: ["D0", ".U1 > .D1"],
+  }
+
+  expect(busProps.parse(rawProps)).toEqual(rawProps)
+})
+
+test("busProps rejects a single connection", () => {
+  expect(
+    busProps.safeParse({
+      name: "DATA",
+      connections: ["D0"],
+    }).success,
+  ).toBe(false)
+})