@tscircuit/core 0.0.29 → 0.0.31

package/lib/Project.ts

@@ -7,15 +7,18 @@ import { createInstanceFromReactElement } from "./fiber/create-instance-from-rea
 import { identity, type Matrix } from "transformation-matrix"
 
 export class Circuit {
-  rootComponent: PrimitiveComponent | null = null
+  firstChild: PrimitiveComponent | null = null
   children: PrimitiveComponent[]
   db: SoupUtilObjects
+  root: Circuit | null = null
+  isRoot = true
 
   _hasRenderedAtleastOnce = false
 
   constructor() {
     this.children = []
     this.db = su([])
+    this.root = this
   }
 
   add(componentOrElm: PrimitiveComponent | ReactElement) {
@@ -30,9 +33,9 @@ export class Circuit {
   }
 
   _guessRootComponent() {
-    if (this.rootComponent) return
+    if (this.firstChild) return
     if (this.children.length === 1) {
-      this.rootComponent = this.children[0]
+      this.firstChild = this.children[0]
       return
     }
     if (this.children.length === 0) {
@@ -46,7 +49,7 @@ export class Circuit {
         this.children.find((c) => c.componentName === "Board") ?? null
 
       if (board) {
-        this.rootComponent = board
+        this.firstChild = board
         return
       }
     }
@@ -56,16 +59,14 @@ export class Circuit {
   }
 
   render() {
-    if (!this.rootComponent) {
+    if (!this.firstChild) {
       this._guessRootComponent()
     }
-    const { rootComponent, db } = this
+    const { firstChild, db } = this
 
-    if (!rootComponent) throw new Error("Project has no root component")
-
-    rootComponent.setProject(this)
-
-    rootComponent.runRenderCycle()
+    if (!firstChild) throw new Error("Project has no root component")
+    firstChild.parent = this as any
+    firstChild.runRenderCycle()
     this._hasRenderedAtleastOnce = true
   }
 
@@ -103,24 +104,27 @@ export class Circuit {
     throw new Error("project.preview is not yet implemented")
   }
 
-  computeGlobalSchematicTransform(): Matrix {
+  computeSchematicGlobalTransform(): Matrix {
     return identity()
   }
 
-  computeGlobalPcbTransform(): Matrix {
+  _computePcbGlobalTransformBeforeLayout(): Matrix {
     return identity()
   }
 
   selectAll(selector: string): PrimitiveComponent[] {
-    return this.rootComponent?.selectAll(selector) ?? []
+    return this.firstChild?.selectAll(selector) ?? []
   }
 
   selectOne(
     selector: string,
     opts?: { type?: "component" | "port" },
   ): PrimitiveComponent | null {
-    return this.rootComponent?.selectOne(selector, opts) ?? null
+    return this.firstChild?.selectOne(selector, opts) ?? null
   }
 }
 
+/**
+ * @deprecated
+ */
 export const Project = Circuit

package/lib/components/base-components/NormalComponent.ts

@@ -46,6 +46,8 @@ export class NormalComponent<
 > extends PrimitiveComponent<ZodProps> {
   reactSubtrees: Array<ReactSubtree> = []
 
+  isPrimitiveContainer = true
+
   constructor(props: z.input<ZodProps>) {
     super(props)
     this._addChildrenFromStringFootprint()
@@ -68,6 +70,7 @@ export class NormalComponent<
    */
   initPorts() {
     const { config } = this
+    const portsToCreate: Port[] = []
     if (config.schematicSymbolName) {
       const sym = symbols[
         `${config.schematicSymbolName}_horz` as keyof typeof symbols
@@ -79,32 +82,36 @@ export class NormalComponent<
 
         if (port) {
           port.schematicSymbolPortDef = symPort
-          this.add(port)
+          portsToCreate.push(port)
         }
       }
 
+      this.addAll(portsToCreate)
       return
     }
 
     const portsFromFootprint = this.getPortsFromFootprint()
-
-    this.addAll(portsFromFootprint)
+    portsToCreate.push(...portsFromFootprint)
 
     const pinLabels: Record<string, string> | undefined =
       this._parsedProps.pinLabels
     if (pinLabels) {
       for (let [pinNumber, label] of Object.entries(pinLabels)) {
         pinNumber = pinNumber.replace("pin", "")
-        const port = this.selectOne(`port[pinNumber='${pinNumber}']`)
-        if (!port) {
+        const existingPort = portsToCreate.find(
+          (p) => p._parsedProps.pinNumber === Number(pinNumber),
+        )
+        if (!existingPort) {
           throw new Error(
             `Could not find port for pin number ${pinNumber} in chip ${this.getString()}`,
           )
         }
-        port.externallyAddedAliases.push(label)
-        port.props.name = label
+        existingPort.externallyAddedAliases.push(label)
+        existingPort.props.name = label
       }
     }
+
+    this.addAll(portsToCreate)
   }
 
   _addChildrenFromStringFootprint() {
@@ -148,7 +155,7 @@ export class NormalComponent<
   doInitialSourceRender() {
     const ftype = this.config.sourceFtype
     if (!ftype) return
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     const source_component = db.source_component.insert({
       ftype,
@@ -166,7 +173,7 @@ export class NormalComponent<
    * You can override this method to do more complicated things.
    */
   doInitialSchematicComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { schematicSymbolName } = this.config
     if (!schematicSymbolName) return
     // TODO switch between horizontal and vertical based on schRotation
@@ -191,10 +198,10 @@ export class NormalComponent<
   }
 
   doInitialPcbComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     const pcb_component = db.pcb_component.insert({
-      center: this.getGlobalPcbPosition(),
+      center: this._getGlobalPcbPositionBeforeLayout(),
       // width/height are computed in the PcbComponentSizeCalculation phase
       width: 0,
       height: 0,
@@ -211,7 +218,7 @@ export class NormalComponent<
    */
   doInitialPcbComponentSizeCalculation(): void {
     if (!this.pcb_component_id) return
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     let minX = Infinity
@@ -221,7 +228,7 @@ export class NormalComponent<
 
     for (const child of this.children) {
       if (child.isPcbPrimitive) {
-        const { x, y } = child.getGlobalPcbPosition()
+        const { x, y } = child._getGlobalPcbPositionBeforeLayout()
         const { width, height } = child.getPcbSize()
         minX = Math.min(minX, x - width / 2)
         minY = Math.min(minY, y - height / 2)
@@ -246,6 +253,10 @@ export class NormalComponent<
     }
   }
 
+  doInitialInitializePortsFromChildren(): void {
+    this.initPorts()
+  }
+
   doInitialReactSubtreesRender(): void {
     if (isReactElement(this.props.footprint)) {
       if (this.reactSubtrees.some((rs) => rs.element === this.props.footprint))
@@ -256,6 +267,20 @@ export class NormalComponent<
     }
   }
 
+  _hasExistingPortExactly(port1: Port): boolean {
+    const existingPorts = this.children.filter(
+      (c) => c.componentName === "Port",
+    ) as Port[]
+    return existingPorts.some((port2) => {
+      const aliases1 = port1.getNameAndAliases()
+      const aliases2 = port2.getNameAndAliases()
+      return (
+        aliases1.length === aliases2.length &&
+        aliases1.every((alias) => aliases2.includes(alias))
+      )
+    })
+  }
+
   add(componentOrElm: PrimitiveComponent | ReactElement) {
     let component: PrimitiveComponent
     if (isReactElement(componentOrElm)) {
@@ -266,6 +291,23 @@ export class NormalComponent<
       component = componentOrElm as PrimitiveComponent
     }
 
+    if (component.componentName === "Port") {
+      if (this._hasExistingPortExactly(component as Port)) return
+      // Check if this port is already contained in the children, skip if it's
+      // already defined
+      const existingPorts = this.children.filter(
+        (c) => c.componentName === "Port",
+      ) as Port[]
+      const conflictingPort = existingPorts.find((p) =>
+        p.isMatchingAnyOf(component.getNameAndAliases()),
+      )
+      if (conflictingPort) {
+        throw new Error(
+          `Conflicting ports added. Port 1: ${conflictingPort}, Port 2: ${component}`,
+        )
+      }
+    }
+
     super.add(component)
   }
 
@@ -304,6 +346,12 @@ export class NormalComponent<
         newPorts.push(newPort)
       }
 
+      if (newPorts.length === 0) {
+        throw new Error(
+          `No ports found in chip ${this} (define a schPortArrangement, a footprint or add portHints to elements of the footprint)`,
+        )
+      }
+
       return newPorts
     }
 

package/lib/components/base-components/PrimitiveComponent.ts

@@ -41,7 +41,6 @@ export abstract class PrimitiveComponent<
     }
   }
 
-  project: Circuit | null = null
   props: z.input<ZodProps>
   _parsedProps: z.infer<ZodProps>
 
@@ -60,11 +59,22 @@ export abstract class PrimitiveComponent<
     return (
       Boolean(this.props.subcircuit) ||
       // Implied opaque group for top-level group
-      (this.lowercaseComponentName === "group" &&
-        this?.parent?.props?.name === "$root")
+      (this.lowercaseComponentName === "group" && (this?.parent as any)?.isRoot)
     )
   }
 
+  /**
+   * A primitive container is a component that contains one or more ports and
+   * primitive components that are designed to interact.
+   *
+   * For example a resistor contains ports and smtpads that interact, so the
+   * resistor is a primitive container. Inside a primitive container, the ports
+   * and pads are likely to reference each other and look for eachother during
+   * the port matching phase.
+   *
+   */
+  isPrimitiveContainer = false
+
   source_group_id: string | null = null
   source_component_id: string | null = null
   schematic_component_id: string | null = null
@@ -86,13 +96,6 @@ export abstract class PrimitiveComponent<
     }
   }
 
-  setProject(project: Circuit) {
-    this.project = project
-    for (const c of this.children) {
-      c.setProject(project)
-    }
-  }
-
   setProps(props: Partial<z.input<ZodProps>>) {
     const newProps = this.config.zodProps.parse({
       ...this.props,
@@ -129,9 +132,9 @@ export abstract class PrimitiveComponent<
    * components, including this component's translation and rotation.
    *
    * This is used to compute this component's position as well as all children
-   * components positions
+   * components positions before layout is applied
    */
-  computePcbGlobalTransform(): Matrix {
+  _computePcbGlobalTransformBeforeLayout(): Matrix {
     const { _parsedProps: props } = this
     const manualPlacement =
       this.getSubcircuit()._getManualPlacementForComponent(this)
@@ -143,7 +146,7 @@ export abstract class PrimitiveComponent<
       this.props.pcbY === undefined
     ) {
       return compose(
-        this.parent?.computePcbGlobalTransform() ?? identity(),
+        this.parent?._computePcbGlobalTransformBeforeLayout() ?? identity(),
         compose(
           translate(manualPlacement.x, manualPlacement.y),
           rotate(((props.pcbRotation ?? 0) * Math.PI) / 180),
@@ -152,11 +155,46 @@ export abstract class PrimitiveComponent<
     }
 
     return compose(
-      this.parent?.computePcbGlobalTransform() ?? identity(),
+      this.parent?._computePcbGlobalTransformBeforeLayout() ?? identity(),
       this.computePcbPropsTransform(),
     )
   }
 
+  getPrimitiveContainer(): PrimitiveComponent | null {
+    if (this.isPrimitiveContainer) return this
+    return this.parent?.getPrimitiveContainer?.() ?? null
+  }
+
+  /**
+   * Compute the bounds of this component the circuit json elements associated
+   * with it.
+   */
+  _getCircuitJsonBounds(): {
+    center: { x: number; y: number }
+    bounds: { left: number; top: number; right: number; bottom: number }
+    width: number
+    height: number
+  } {
+    return {
+      center: { x: 0, y: 0 },
+      bounds: { left: 0, top: 0, right: 0, bottom: 0 },
+      width: 0,
+      height: 0,
+    }
+  }
+
+  /**
+   * Set the position of this component from the layout solver. This method
+   * should operate using CircuitJson associated with this component, like
+   * _getCircuitJsonBounds it can be called multiple times as different
+   * parents apply layout to their children.
+   */
+  _setPositionFromLayout(newCenter: { x: number; y: number }) {
+    throw new Error(
+      `_setPositionFromLayout not implemented for ${this.componentName}`,
+    )
+  }
+
   /**
    * Computes a transformation matrix from the props of this component for
    * schematic components
@@ -209,7 +247,7 @@ export abstract class PrimitiveComponent<
     for (const position of placementConfig.positions) {
       if (isMatchingSelector(component, position.selector)) {
         const center = applyToPoint(
-          this.computePcbGlobalTransform(),
+          this._computePcbGlobalTransformBeforeLayout(),
           position.center,
         )
         return center
@@ -219,17 +257,23 @@ export abstract class PrimitiveComponent<
     return null
   }
 
-  getGlobalPcbPosition(): { x: number; y: number } {
-    return applyToPoint(this.computePcbGlobalTransform(), { x: 0, y: 0 })
+  _getGlobalPcbPositionBeforeLayout(): { x: number; y: number } {
+    return applyToPoint(this._computePcbGlobalTransformBeforeLayout(), {
+      x: 0,
+      y: 0,
+    })
   }
 
-  getGlobalSchematicPosition(): { x: number; y: number } {
+  _getGlobalSchematicPositionBeforeLayout(): { x: number; y: number } {
     return applyToPoint(this.computeSchematicGlobalTransform(), { x: 0, y: 0 })
   }
 
+  get root(): Circuit | null {
+    return this.parent?.root ?? null
+  }
+
   onAddToParent(parent: PrimitiveComponent) {
     this.parent = parent
-    this.project = parent.project
   }
 
   /**

package/lib/components/base-components/Renderable.ts

@@ -2,12 +2,13 @@ import type { PCBPlacementError, PCBTraceError } from "@tscircuit/soup"
 import { Component, createElement, type ReactElement } from "react"
 
 export const orderedRenderPhases = [
-  "ReactSubtreesRender", // probably going to be removed b/c subtrees should render instantly
+  "ReactSubtreesRender",
+  "InitializePortsFromChildren",
   "CreateNetsFromProps",
   "CreateTracesFromProps",
   "SourceRender",
   "SourceParentAttachment",
-  "PortDiscovery", // probably going to be removed b/c port discovery can always be done on prop change
+  "PortDiscovery",
   "PortMatching",
   "SourceTraceRender",
   "SchematicComponentRender",
@@ -15,8 +16,9 @@ export const orderedRenderPhases = [
   "SchematicPortRender",
   "SchematicTraceRender",
   "PcbComponentRender",
-  "PcbPortRender",
   "PcbPrimitiveRender",
+  "PcbFootprintLayout",
+  "PcbPortRender",
   "PcbParentAttachment",
   "PcbLayout",
   "PcbTraceRender",

package/lib/components/index.ts

@@ -16,3 +16,4 @@ export { Chip } from "./normal-components/Chip"
 export { Jumper } from "./normal-components/Jumper"
 export { SilkscreenPath } from "./primitive-components/SilkscreenPath"
 export { PlatedHole } from "./primitive-components/PlatedHole"
+export { Constraint } from "./primitive-components/Constraint"

package/lib/components/normal-components/Board.ts

@@ -18,7 +18,7 @@ export class Board extends Group<typeof boardProps> {
   }
 
   doInitialPcbComponentRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     if (!props.width || !props.height) {
@@ -36,13 +36,13 @@ export class Board extends Group<typeof boardProps> {
   }
 
   removePcbComponentRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     if (!this.pcb_board_id) return
     db.pcb_board.delete(this.pcb_board_id!)
     this.pcb_board_id = null
   }
 
-  computePcbGlobalTransform(): Matrix {
+  _computePcbGlobalTransformBeforeLayout(): Matrix {
     return identity()
   }
 }

package/lib/components/normal-components/Capacitor.ts

@@ -54,7 +54,7 @@ export class Capacitor extends NormalComponent<
   }
 
   doInitialSourceRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     const source_component = db.source_component.insert({
       ftype: "simple_capacitor",

package/lib/components/normal-components/Chip.ts

@@ -22,7 +22,7 @@ export class Chip<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialSourceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const source_component = db.source_component.insert({
@@ -36,7 +36,7 @@ export class Chip<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialSchematicComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const ports = this.children.filter((child) => child instanceof Port)
@@ -81,7 +81,7 @@ export class Chip<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialPcbComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const pcb_component = db.pcb_component.insert({

package/lib/components/normal-components/Jumper.ts

@@ -22,7 +22,7 @@ export class Jumper<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialSourceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const source_component = db.source_component.insert({
@@ -36,7 +36,7 @@ export class Jumper<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialSchematicComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const ports = this.children.filter((child) => child instanceof Port)
@@ -84,7 +84,7 @@ export class Jumper<PinLabels extends string = never> extends NormalComponent<
   }
 
   doInitialPcbComponentRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const pcb_component = db.pcb_component.insert({

package/lib/components/normal-components/Resistor.ts

@@ -43,7 +43,7 @@ export class Resistor extends NormalComponent<
   }
 
   doInitialSourceRender() {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     const source_component = db.source_component.insert({
       ftype: "simple_resistor",

package/lib/components/primitive-components/Constraint.ts

@@ -0,0 +1,49 @@
+import { constraintProps } from "@tscircuit/props"
+import { z } from "zod"
+import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+
+export class Constraint extends PrimitiveComponent<typeof constraintProps> {
+  get config() {
+    return {
+      zodProps: constraintProps,
+    }
+  }
+
+  constructor(props: z.input<typeof constraintProps>) {
+    super(props)
+    if ("xdist" in props || "ydist" in props) {
+      if (!("edgeToEdge" in props) && !("centerToCenter" in props)) {
+        throw new Error(
+          "edgeToEdge, centerToCenter (or from*/to* props) must be set for xdist or ydist for <constraint />",
+        )
+      }
+    }
+  }
+
+  _getAllReferencedComponents(): {
+    componentsWithSelectors: Array<{
+      component: PrimitiveComponent<any>
+      selector: string
+    }>
+  } {
+    const componentsWithSelectors: Array<{
+      component: PrimitiveComponent<any>
+      selector: string
+    }> = []
+
+    for (const key of ["left", "right", "top", "bottom"]) {
+      if (key in this._parsedProps) {
+        const selector = (this._parsedProps as any)[key] as string
+        const component = this.getSubcircuit().selectOne(selector)
+        if (component) {
+          componentsWithSelectors.push({
+            selector,
+            component,
+          })
+        }
+      }
+    }
+
+    return { componentsWithSelectors }
+  }
+}