@tscircuit/core 0.0.73 → 0.0.74

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

@@ -1,635 +0,0 @@
-import { traceProps } from "@tscircuit/props"
-import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
-import type { Port } from "./Port"
-import {
-  MultilayerIjump,
-  IJumpAutorouter,
-  autoroute,
-  getObstaclesFromSoup,
-  markObstaclesAsConnected,
-} from "@tscircuit/infgrid-ijump-astar"
-import type {
-  AnySoupElement,
-  LayerRef,
-  PCBTrace,
-  RouteHintPoint,
-  SchematicTrace,
-  SourceTrace,
-} from "@tscircuit/soup"
-import type {
-  Obstacle,
-  SimpleRouteConnection,
-  SimpleRouteJson,
-  SimplifiedPcbTrace,
-} from "lib/utils/autorouting/SimpleRouteJson"
-import { computeObstacleBounds } from "lib/utils/autorouting/computeObstacleBounds"
-import { projectPointInDirection } from "lib/utils/projectPointInDirection"
-import type { TraceHint } from "./TraceHint"
-import {
-  findPossibleTraceLayerCombinations,
-  type CandidateTraceLayerCombination,
-} from "lib/utils/autorouting/findPossibleTraceLayerCombinations"
-import { pairs } from "lib/utils/pairs"
-import { mergeRoutes } from "lib/utils/autorouting/mergeRoutes"
-import type { Net } from "./Net"
-import { getClosest } from "lib/utils/getClosest"
-import { z } from "zod"
-import { createNetsFromProps } from "lib/utils/components/createNetsFromProps"
-import {
-  isMatchingPathSelector,
-  isMatchingSelector,
-} from "lib/utils/selector-matching"
-import { tryNow } from "lib/utils/try-now"
-import { getFullConnectivityMapFromCircuitJson } from "circuit-json-to-connectivity-map"
-
-type PcbRouteObjective =
-  | RouteHintPoint
-  | {
-      layers: string[]
-      x: number
-      y: number
-      via?: boolean
-      pcb_port_id?: string
-    }
-
-const portToObjective = (port: Port): PcbRouteObjective => {
-  const portPosition = port._getGlobalPcbPositionAfterLayout()
-  return {
-    ...portPosition,
-    layers: port.getAvailablePcbLayers(),
-  }
-}
-
-const SHOULD_USE_SINGLE_LAYER_ROUTING = false
-
-export class Trace extends PrimitiveComponent<typeof traceProps> {
-  source_trace_id: string | null = null
-  pcb_trace_id: string | null = null
-  schematic_trace_id: string | null = null
-  _portsRoutedOnPcb: Port[]
-
-  constructor(props: z.input<typeof traceProps>) {
-    super(props)
-    this._portsRoutedOnPcb = []
-  }
-
-  get config() {
-    return {
-      zodProps: traceProps,
-    }
-  }
-
-  _getTracePortOrNetSelectorListFromProps(): string[] {
-    if ("from" in this.props && "to" in this.props) {
-      return [
-        typeof this.props.from === "string"
-          ? this.props.from
-          : this.props.from.getPortSelector(),
-        typeof this.props.to === "string"
-          ? this.props.to
-          : this.props.to.getPortSelector(),
-      ]
-    }
-    if ("path" in this.props) {
-      return this.props.path.map((p) =>
-        typeof p === "string" ? p : p.getPortSelector(),
-      )
-    }
-    return []
-  }
-
-  getTracePortPathSelectors(): string[] {
-    return this._getTracePortOrNetSelectorListFromProps().filter(
-      (selector) => !selector.includes("net."),
-    )
-  }
-
-  getTracePathNetSelectors(): string[] {
-    return this._getTracePortOrNetSelectorListFromProps().filter((selector) =>
-      selector.includes("net."),
-    )
-  }
-
-  _findConnectedPorts():
-    | {
-        allPortsFound: true
-        ports: Port[]
-        portsWithSelectors: Array<{ selector: string; port: Port }>
-      }
-    | {
-        allPortsFound: false
-        ports?: undefined
-        portsWithSelectors?: undefined
-      } {
-    const { db } = this.root!
-    const { _parsedProps: props, parent } = this
-
-    if (!parent) throw new Error("Trace has no parent")
-
-    const portSelectors = this.getTracePortPathSelectors()
-
-    const portsWithSelectors = portSelectors.map((selector) => ({
-      selector,
-      port:
-        (this.getSubcircuit().selectOne(selector, { type: "port" }) as Port) ??
-        null,
-    }))
-
-    for (const { selector, port } of portsWithSelectors) {
-      if (!port) {
-        const parentSelector = selector.replace(/\>.*$/, "")
-        const targetComponent = this.getSubcircuit().selectOne(parentSelector)
-        if (!targetComponent) {
-          this.renderError(`Could not find port for selector "${selector}"`)
-        } else {
-          this.renderError(
-            `Could not find port for selector "${selector}"\nsearched component ${targetComponent.getString()}, which has ports: ${targetComponent.children
-              .filter((c) => c.componentName === "Port")
-              .map(
-                (c) => `${c.getString()}(${c.getNameAndAliases().join(",")})`,
-              )
-              .join(" & ")}`,
-          )
-        }
-      }
-    }
-
-    if (portsWithSelectors.some((p) => !p.port)) {
-      return { allPortsFound: false }
-    }
-
-    return {
-      allPortsFound: true,
-      portsWithSelectors,
-      ports: portsWithSelectors.map(({ port }) => port),
-    }
-  }
-
-  _findConnectedNets(): {
-    nets: Net[]
-    netsWithSelectors: Array<{ selector: string; net: Net }>
-  } {
-    const netsWithSelectors = this.getTracePathNetSelectors().map(
-      (selector) => ({
-        selector,
-        net: this.getSubcircuit().selectOne(selector, { type: "net" }) as Net,
-      }),
-    )
-
-    const undefinedNets = netsWithSelectors.filter((n) => !n.net)
-    if (undefinedNets.length > 0) {
-      this.renderError(
-        `Could not find net for selector "${undefinedNets[0].selector}" inside ${this}`,
-      )
-    }
-
-    return { netsWithSelectors, nets: netsWithSelectors.map((n) => n.net) }
-  }
-
-  /**
-   * Get all the traces that are connected in any degree to this trace, this is
-   * used during autorouting to routes to pass through traces connected to the
-   * same net.
-   */
-  _getAllTracesConnectedToSameNet(): Trace[] {
-    const traces = this.getSubcircuit().selectAll("trace") as Trace[]
-
-    const myNets = this._findConnectedNets().nets
-    const myPorts = this._findConnectedPorts().ports ?? []
-
-    return traces.filter((t) => {
-      if (t === this) return false
-      const tNets = t._findConnectedNets().nets
-      const tPorts = t._findConnectedPorts().ports ?? []
-      return (
-        tNets.some((n) => myNets.includes(n)) ||
-        tPorts.some((p) => myPorts.includes(p))
-      )
-    })
-  }
-
-  /**
-   * Determine if a trace is explicitly connected to a port (not via a net)
-   */
-  _isExplicitlyConnectedToPort(port: Port) {
-    const { allPortsFound, portsWithSelectors: portsWithMetadata } =
-      this._findConnectedPorts()
-    if (!allPortsFound) return false
-    const ports = portsWithMetadata.map((p) => p.port)
-    return ports.includes(port)
-  }
-
-  /**
-   * Determine if a trace is explicitly connected to a net (not via a port)
-   */
-  _isExplicitlyConnectedToNet(net: Net) {
-    const nets = this._findConnectedNets().nets
-    return nets.includes(net)
-  }
-
-  doInitialCreateNetsFromProps(): void {
-    createNetsFromProps(this, this.getTracePathNetSelectors())
-  }
-
-  doInitialSourceTraceRender(): void {
-    const { db } = this.root!
-    const { _parsedProps: props, parent } = this
-
-    if (!parent) {
-      this.renderError("Trace has no parent")
-      return
-    }
-
-    const { allPortsFound, portsWithSelectors: ports } =
-      this._findConnectedPorts()
-    if (!allPortsFound) return
-
-    const nets = this._findConnectedNets().nets
-
-    const trace = db.source_trace.insert({
-      connected_source_port_ids: ports.map((p) => p.port.source_port_id!),
-      connected_source_net_ids: nets.map((n) => n.source_net_id!),
-    })
-
-    this.source_trace_id = trace.source_trace_id
-  }
-
-  doInitialPcbTraceRender(): void {
-    const { db } = this.root!
-    const { _parsedProps: props, parent } = this
-
-    if (!parent) throw new Error("Trace has no parent")
-
-    if (this.getSubcircuit()._parsedProps.routingDisabled) {
-      return
-    }
-
-    const { allPortsFound, ports } = this._findConnectedPorts()
-    const portsConnectedOnPcbViaNet: Port[] = []
-
-    if (!allPortsFound) return
-
-    const nets = this._findConnectedNets().netsWithSelectors
-
-    if (ports.length === 0 && nets.length === 2) {
-      // Find the two optimal points to connect the two nets
-      this.renderError(
-        `Trace connects two nets, we haven't implemented a way to route this yet`,
-      )
-      return
-      // biome-ignore lint/style/noUselessElse: <explanation>
-    } else if (ports.length === 1 && nets.length === 1) {
-      // Add a port from the net that is closest to the port
-      const port = ports[0]
-      const portsInNet = nets[0].net.getAllConnectedPorts()
-      const otherPortsInNet = portsInNet.filter((p) => p !== port)
-      if (otherPortsInNet.length === 0) {
-        console.log(
-          "Nothing to connect this port to, the net is empty. TODO should emit a warning!",
-        )
-        return
-      }
-      const closestPortInNet = getClosest(port, otherPortsInNet)
-
-      portsConnectedOnPcbViaNet.push(closestPortInNet)
-
-      ports.push(closestPortInNet)
-    } else if (ports.length > 1 && nets.length >= 1) {
-      this.renderError(
-        `Trace has more than one port and one or more nets, we don't currently support this type of complex trace routing`,
-      )
-      return
-    }
-
-    const hints = ports.flatMap((port) =>
-      port.matchedComponents.filter((c) => c.componentName === "TraceHint"),
-    ) as TraceHint[]
-
-    const pcbRouteHints = (this._parsedProps.pcbRouteHints ?? []).concat(
-      hints.flatMap((h) => h.getPcbRouteHints()),
-    )
-
-    if (ports.length > 2) {
-      this.renderError(
-        `Trace has more than two ports (${ports
-          .map((p) => p.getString())
-          .join(
-            ", ",
-          )}), routing between more than two ports for a single trace is not implemented`,
-      )
-      return
-    }
-
-    const alreadyRoutedTraces = this.getSubcircuit()
-      .selectAll("trace")
-      .filter(
-        (trace) => trace.renderPhaseStates.PcbTraceRender.initialized,
-      ) as Trace[]
-
-    const isAlreadyRouted = alreadyRoutedTraces.some(
-      (trace) =>
-        trace._portsRoutedOnPcb.length === ports.length &&
-        trace._portsRoutedOnPcb.every((portRoutedByOtherTrace) =>
-          ports.includes(portRoutedByOtherTrace),
-        ),
-    )
-
-    if (isAlreadyRouted) {
-      return
-    }
-
-    let orderedRouteObjectives: PcbRouteObjective[] = []
-
-    if (pcbRouteHints.length === 0) {
-      orderedRouteObjectives = [
-        portToObjective(ports[0]),
-        portToObjective(ports[1]),
-      ]
-    } else {
-      // When we have hints, we have to order the hints then route between each
-      // terminal of the trace and the hints
-      // TODO order based on proximity to ports
-      orderedRouteObjectives = [
-        portToObjective(ports[0]),
-        ...pcbRouteHints,
-        portToObjective(ports[1]),
-      ]
-    }
-
-    // Hints can indicate where there should be a via, but the layer is allowed
-    // to be unspecified, therefore we need to find possible layer combinations
-    // to go to each hint and still route to the start and end points
-    const candidateLayerCombinations = findPossibleTraceLayerCombinations(
-      orderedRouteObjectives,
-    )
-
-    if (
-      SHOULD_USE_SINGLE_LAYER_ROUTING &&
-      candidateLayerCombinations.length === 0
-    ) {
-      this.renderError(
-        `Could not find a common layer (using hints) for trace ${this.getString()}`,
-      )
-      return
-    }
-
-    const connMap = getFullConnectivityMapFromCircuitJson(
-      this.root!.db.toArray(),
-    )
-
-    // Cache the PCB obstacles, they'll be needed for each segment between
-    // ports/hints
-    const [obstacles, errGettingObstacles] = tryNow(() =>
-      getObstaclesFromSoup(this.root!.db.toArray()),
-    )
-
-    if (errGettingObstacles) {
-      this.renderError({
-        type: "pcb_error",
-        error_type: "pcb_trace_error",
-        message: `Error getting obstacles for autorouting: ${errGettingObstacles.message}`,
-        source_trace_id: this.source_trace_id!,
-        center: { x: 0, y: 0 },
-        pcb_port_ids: ports.map((p) => p.pcb_port_id!),
-        pcb_trace_id: this.pcb_trace_id!,
-        pcb_component_ids: [],
-      })
-      return
-    }
-
-    for (const obstacle of obstacles) {
-      const connectedTo = obstacle.connectedTo
-      if (connectedTo.length > 0) {
-        const netId = connMap.getNetConnectedToId(obstacle.connectedTo[0])
-        if (netId) {
-          obstacle.connectedTo.push(netId)
-        }
-      }
-    }
-
-    let orderedRoutePoints: PcbRouteObjective[] = []
-    if (candidateLayerCombinations.length === 0) {
-      orderedRoutePoints = orderedRouteObjectives
-    } else {
-      // TODO explore all candidate layer combinations if one fails
-      const candidateLayerSelections = candidateLayerCombinations[0].layer_path
-
-      /**
-       * Apply the candidate layer selections to the route objectives, now we
-       * have a set of points that have definite layers
-       */
-      orderedRoutePoints = orderedRouteObjectives.map((t, idx) => {
-        if (t.via) {
-          return {
-            ...t,
-            via_to_layer: candidateLayerSelections[idx],
-          }
-        }
-        return { ...t, layers: [candidateLayerSelections[idx]] }
-      })
-    }
-    ;(orderedRoutePoints[0] as any).pcb_port_id = ports[0].pcb_port_id
-    ;(orderedRoutePoints[orderedRoutePoints.length - 1] as any).pcb_port_id =
-      ports[1].pcb_port_id
-
-    const routes: PCBTrace["route"][] = []
-    for (const [a, b] of pairs(orderedRoutePoints)) {
-      const dominantLayer =
-        "via_to_layer" in a ? (a.via_to_layer as LayerRef) : null
-      const BOUNDS_MARGIN = 2 //mm
-
-      const aLayer =
-        "layers" in a && a.layers.length === 1
-          ? a.layers[0]
-          : (dominantLayer ?? "top")
-      const bLayer =
-        "layers" in b && b.layers.length === 1
-          ? b.layers[0]
-          : (dominantLayer ?? "top")
-
-      const pcbPortA = "pcb_port_id" in a ? a.pcb_port_id : null
-      const pcbPortB = "pcb_port_id" in b ? b.pcb_port_id : null
-
-      const minTraceWidth =
-        this.getSubcircuit()._parsedProps.minTraceWidth ?? 0.16
-
-      const ijump = new MultilayerIjump({
-        OBSTACLE_MARGIN: minTraceWidth * 2,
-        // isRemovePathLoopsEnabled: true,
-        optimizeWithGoalBoxes: Boolean(pcbPortA && pcbPortB),
-        connMap,
-        input: {
-          obstacles,
-          minTraceWidth,
-          connections: [
-            {
-              name: this.source_trace_id!,
-              pointsToConnect: [
-                { ...a, layer: aLayer, pcb_port_id: pcbPortA! },
-                { ...b, layer: bLayer, pcb_port_id: pcbPortB! },
-              ],
-            },
-          ],
-          layerCount: 2,
-          bounds: {
-            minX: Math.min(a.x, b.x) - BOUNDS_MARGIN,
-            maxX: Math.max(a.x, b.x) + BOUNDS_MARGIN,
-            minY: Math.min(a.y, b.y) - BOUNDS_MARGIN,
-            maxY: Math.max(a.y, b.y) + BOUNDS_MARGIN,
-          },
-        },
-      })
-      let traces: SimplifiedPcbTrace[] | null = null
-      try {
-        traces = ijump.solveAndMapToTraces()
-      } catch (e: any) {
-        this.renderError({
-          type: "pcb_error",
-          error_type: "pcb_trace_error",
-          message: `error solving route: ${e.message}`,
-          source_trace_id: this.source_trace_id!,
-          center: { x: (a.x + b.x) / 2, y: (a.y + b.y) / 2 },
-          pcb_port_ids: ports.map((p) => p.pcb_port_id!),
-          pcb_trace_id: this.pcb_trace_id!,
-          pcb_component_ids: ports.map((p) => p.pcb_component_id!),
-        })
-      }
-      if (!traces) return
-      if (traces.length === 0) {
-        this.renderError({
-          type: "pcb_error",
-          error_type: "pcb_trace_error",
-          message: `Could not find a route for ${this}`,
-          source_trace_id: this.source_trace_id!,
-          center: { x: (a.x + b.x) / 2, y: (a.y + b.y) / 2 },
-          pcb_port_ids: ports.map((p) => p.pcb_port_id!),
-          pcb_trace_id: this.pcb_trace_id!,
-          pcb_component_ids: ports.map((p) => p.pcb_component_id!),
-        })
-        return
-      }
-      const [trace] = traces as PCBTrace[]
-
-      // If the autorouter didn't specify a layer, use the dominant layer
-      // Some of the single-layer autorouters don't add the layer property
-      if (dominantLayer) {
-        trace.route = trace.route.map((p) => {
-          if (p.route_type === "wire" && !p.layer) {
-            p.layer = dominantLayer
-          }
-          return p
-        })
-      }
-      routes.push(trace.route)
-    }
-
-    const mergedRoute = mergeRoutes(routes)
-
-    for (const point of mergedRoute) {
-      if (point.route_type === "via") {
-        db.pcb_via.insert({
-          x: point.x,
-          y: point.y,
-          hole_diameter: 0.3,
-          outer_diameter: 0.6,
-          layers: [point.from_layer as LayerRef, point.to_layer as LayerRef],
-          from_layer: point.from_layer as LayerRef,
-          to_layer: point.to_layer as LayerRef,
-        })
-      }
-    }
-
-    const pcb_trace = db.pcb_trace.insert({
-      route: mergedRoute,
-      source_trace_id: this.source_trace_id!,
-    })
-    this._portsRoutedOnPcb = ports
-    this.pcb_trace_id = pcb_trace.pcb_trace_id
-  }
-
-  doInitialSchematicTraceRender(): void {
-    const { db } = this.root!
-    const { _parsedProps: props, parent } = this
-
-    if (!parent) throw new Error("Trace has no parent")
-
-    const { allPortsFound, portsWithSelectors: ports } =
-      this._findConnectedPorts()
-
-    if (!allPortsFound) return
-
-    const obstacles: Obstacle[] = []
-    const connection: SimpleRouteConnection = {
-      name: this.source_trace_id!,
-      pointsToConnect: [],
-    }
-
-    for (const elm of db.toArray()) {
-      if (elm.type === "schematic_component") {
-        obstacles.push({
-          type: "rect",
-          layers: ["top"],
-          center: elm.center,
-          width: elm.size.width,
-          height: elm.size.height,
-          connectedTo: [],
-        })
-      }
-    }
-
-    for (const { port } of ports) {
-      connection.pointsToConnect.push({
-        ...projectPointInDirection(
-          port._getGlobalSchematicPositionBeforeLayout(),
-          port.facingDirection!,
-          0.1501,
-        ),
-        layer: "top",
-      })
-    }
-
-    const bounds = computeObstacleBounds(obstacles)
-
-    const simpleRouteJsonInput: SimpleRouteJson = {
-      minTraceWidth: 0.1,
-      obstacles,
-      connections: [connection],
-      bounds,
-      layerCount: 1,
-    }
-
-    const autorouter = new IJumpAutorouter({
-      input: simpleRouteJsonInput,
-    })
-    const results = autorouter.solve()
-
-    if (results.length === 0) return
-
-    const [result] = results
-
-    if (!result.solved) return
-
-    const { route } = result
-
-    const edges: SchematicTrace["edges"] = []
-
-    for (let i = 0; i < route.length - 1; i++) {
-      const from = route[i]
-      const to = route[i + 1]
-
-      edges.push({
-        from,
-        to,
-        // TODO to_schematic_port_id and from_schematic_port_id
-      })
-    }
-
-    const trace = db.schematic_trace.insert({
-      source_trace_id: this.source_trace_id!,
-
-      edges,
-    })
-
-    this.schematic_trace_id = trace.schematic_trace_id
-  }
-}

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

@@ -1,71 +0,0 @@
-import { PrimitiveComponent } from "lib/components/base-components/PrimitiveComponent"
-import { traceHintProps } from "@tscircuit/props"
-import type { Port } from "./Port"
-import type { RouteHintPoint } from "@tscircuit/soup"
-import { applyToPoint } from "transformation-matrix"
-
-export class TraceHint extends PrimitiveComponent<typeof traceHintProps> {
-  matchedPort: Port | null = null
-
-  doInitialPortMatching(): void {
-    const { db } = this.root!
-    const { _parsedProps: props, parent } = this
-
-    if (!parent) return
-
-    if (parent.componentName === "Trace") {
-      this.renderError(
-        `Port inference inside trace is not yet supported (${this})`,
-      )
-      return
-    }
-
-    if (!parent) throw new Error("TraceHint has no parent")
-
-    if (!props.for) {
-      this.renderError(`TraceHint has no for property (${this})`)
-      return
-    }
-
-    const port = parent.selectOne(props.for, { type: "port" }) as Port
-
-    if (!port) {
-      this.renderError(
-        `${this} could not find port for selector "${props.for}"`,
-      )
-    }
-
-    this.matchedPort = port
-    port.registerMatch(this)
-  }
-
-  getPcbRouteHints(): Array<RouteHintPoint> {
-    const { _parsedProps: props } = this
-
-    const offsets = props.offset ? [props.offset] : props.offsets
-
-    if (!offsets) return []
-
-    const globalTransform = this._computePcbGlobalTransformBeforeLayout()
-
-    return offsets.map(
-      (offset): RouteHintPoint => ({
-        ...applyToPoint(globalTransform, offset),
-        via: offset.via,
-        to_layer: (offset as any).to_layer,
-        trace_width: (offset as any).trace_width,
-      }),
-    )
-  }
-
-  doInitialPcbTraceHintRender(): void {
-    const { db } = this.root!
-    const { _parsedProps: props } = this
-
-    db.pcb_trace_hint.insert({
-      pcb_component_id: this.matchedPort?.pcb_component_id!,
-      pcb_port_id: this.matchedPort?.pcb_port_id!,
-      route: this.getPcbRouteHints(),
-    })
-  }
-}