@tscircuit/core 0.0.280 → 0.0.282

package/dist/index.js

@@ -50,7 +50,7 @@ __export(components_exports, {
   Via: () => Via
 });
 
-// lib/components/base-components/NormalComponent.ts
+// lib/components/base-components/NormalComponent/NormalComponent.ts
 import { fp } from "@tscircuit/footprinter";
 import { point3, rotation } from "circuit-json";
 import Debug4 from "debug";
@@ -72,7 +72,6 @@ var orderedRenderPhases = [
   "CreateTraceHintsFromProps",
   "SourceRender",
   "SourceParentAttachment",
-  "PortDiscovery",
   "PortMatching",
   "SourceTraceRender",
   "SourceAddConnectivityMapKey",
@@ -2051,14 +2050,67 @@ var Port = class extends PrimitiveComponent {
   _getGlobalPcbPositionAfterLayout() {
     return this._getPcbCircuitJsonBounds().center;
   }
+  _getPortsInternallyConnectedToThisPort() {
+    const parent = this.parent;
+    if (!parent || !parent._getInternallyConnectedPorts) return [];
+    const internallyConnectedPorts = parent._getInternallyConnectedPorts();
+    for (const ports of internallyConnectedPorts) {
+      if (ports.some((port) => port === this)) {
+        return ports;
+      }
+    }
+    return [];
+  }
+  /**
+   * Return true if this port has a schematic representation and can be rendered
+   * to the schematic.
+   *
+   * Sometimes things like mounting holes don't have a schematic representation
+   * and aren't rendered to the schematic.
+   *
+   * It's common for a schematic symbol to not have a representation for all of
+   * the pins on a footprint, e.g. a pushbutton has 4 pins but is typically
+   * represented by a two-pin symbol. In these cases, it's best to use
+   * internallyConnectedPorts or externallyConnectedPorts to ensure the things
+   * are rendered properly.
+   */
+  _hasSchematicPort() {
+    const symbol = this.parent?.getSchematicSymbol();
+    if (symbol) {
+      if (this.schematicSymbolPortDef) return true;
+      const portsInternallyConnectedToThisPort = this._getPortsInternallyConnectedToThisPort();
+      if (portsInternallyConnectedToThisPort.some((p) => p.schematicSymbolPortDef))
+        return true;
+      return false;
+    }
+    const parentBoxDim = this?.parent?._getSchematicBoxDimensions();
+    if (parentBoxDim && this.props.pinNumber !== void 0) {
+      const localPortPosition = parentBoxDim.getPortPositionByPinNumber(
+        this.props.pinNumber
+      );
+      if (localPortPosition) return true;
+    }
+    return false;
+  }
   _getGlobalSchematicPositionBeforeLayout() {
     const symbol = this.parent?.getSchematicSymbol();
-    if (symbol && this.schematicSymbolPortDef) {
+    if (symbol) {
+      let schematicSymbolPortDef = this.schematicSymbolPortDef;
+      if (!schematicSymbolPortDef) {
+        schematicSymbolPortDef = this._getPortsInternallyConnectedToThisPort().find(
+          (p) => p.schematicSymbolPortDef
+        )?.schematicSymbolPortDef ?? null;
+        if (!schematicSymbolPortDef) {
+          throw new Error(
+            `Couldn't find schematicSymbolPortDef for port ${this.getString()}, searched internally connected ports and none had a schematicSymbolPortDef. Why are we trying to get the schematic position of this port?`
+          );
+        }
+      }
       const transform = compose2(
         this.parent.computeSchematicGlobalTransform(),
         translate2(-symbol.center.x, -symbol.center.y)
       );
-      return applyToPoint3(transform, this.schematicSymbolPortDef);
+      return applyToPoint3(transform, schematicSymbolPortDef);
     }
     const parentBoxDim = this?.parent?._getSchematicBoxDimensions();
     if (parentBoxDim && this.props.pinNumber !== void 0) {
@@ -2066,14 +2118,18 @@ var Port = class extends PrimitiveComponent {
         this.props.pinNumber
       );
       if (!localPortPosition) {
-        return { x: 0, y: 0 };
+        throw new Error(
+          `Couldn't find position for schematic_port for port ${this.getString()} inside of the schematic box`
+        );
       }
       return applyToPoint3(
         this.parent.computeSchematicGlobalTransform(),
         localPortPosition
       );
     }
-    return { x: 0, y: 0 };
+    throw new Error(
+      `Couldn't find position for schematic_port for port ${this.getString()}`
+    );
   }
   _getGlobalSchematicPositionAfterLayout() {
     const { db } = this.root;
@@ -2201,6 +2257,7 @@ var Port = class extends PrimitiveComponent {
     const { _parsedProps: props } = this;
     const container = this.getPrimitiveContainer();
     if (!container) return;
+    if (!this._hasSchematicPort()) return;
     const containerCenter = container._getGlobalSchematicPositionBeforeLayout();
     const portCenter = this._getGlobalSchematicPositionBeforeLayout();
     let localPortInfo = null;
@@ -2267,14 +2324,19 @@ var getPinNumberFromLabels = (labels) => {
   if (!pinNumber) return null;
   return Number.parseInt(pinNumber.replace(/^pin/, ""));
 };
-function getPortFromHints(hints) {
+function getPortFromHints(hints, opts) {
   const pinNumber = getPinNumberFromLabels(hints);
   if (!pinNumber) return null;
+  const aliasesFromHints = hints.filter(
+    (p) => p.toString() !== pinNumber.toString() && p !== `pin${pinNumber}`
+  );
+  const aliases = [
+    ...aliasesFromHints,
+    ...opts?.additionalAliases?.[`pin${pinNumber}`] ?? []
+  ];
   return new Port({
     pinNumber,
-    aliases: hints.filter(
-      (p) => p.toString() !== pinNumber.toString() && p !== `pin${pinNumber}`
-    )
+    aliases
   });
 }
 
@@ -2567,7 +2629,7 @@ var getAllDimensionsForSchematicBox = (params) => {
   };
 };
 
-// lib/components/base-components/NormalComponent.ts
+// lib/components/base-components/NormalComponent/NormalComponent.ts
 import {
   isValidElement as isReactElement,
   isValidElement
@@ -2799,7 +2861,7 @@ var getNumericSchPinStyle = (pinStyles, pinLabels) => {
   return numericPinStyles;
 };
 
-// lib/components/base-components/NormalComponent.ts
+// lib/components/base-components/NormalComponent/NormalComponent.ts
 var debug3 = Debug4("tscircuit:core");
 var rotation3 = z5.object({
   x: rotation,
@@ -2812,6 +2874,15 @@ var NormalComponent = class extends PrimitiveComponent {
   isPrimitiveContainer = true;
   _asyncSupplierPartNumbers;
   pcb_missing_footprint_error_id;
+  /**
+   * Override this property for component defaults
+   */
+  get defaultInternallyConnectedPortNames() {
+    return [];
+  }
+  get internallyConnectedPortNames() {
+    return this._parsedProps.internallyConnectedPorts ?? this.defaultInternallyConnectedPortNames;
+  }
   constructor(props) {
     super(props);
     this._addChildrenFromStringFootprint();
@@ -2926,10 +2997,9 @@ var NormalComponent = class extends PrimitiveComponent {
         }
       }
       this.addAll(portsToCreate);
-      return;
     }
     if (!this._parsedProps.schPortArrangement) {
-      const portsFromFootprint = this.getPortsFromFootprint();
+      const portsFromFootprint = this.getPortsFromFootprint(opts);
       for (const port of portsFromFootprint) {
         if (!portsToCreate.some(
           (p) => p.isMatchingAnyOf(port.getNameAndAliases())
@@ -2938,7 +3008,7 @@ var NormalComponent = class extends PrimitiveComponent {
         }
       }
     }
-    for (let pn = 1; pn <= this._getPinCount(); pn++) {
+    for (let pn = 1; pn <= (opts.pinCount ?? this._getPinCount()); pn++) {
       if (!this._parsedProps.schPortArrangement) continue;
       if (portsToCreate.find((p) => p._parsedProps.pinNumber === pn)) continue;
       let explicitlyListedPinNumbersInSchPortArrangement = [
@@ -3054,6 +3124,18 @@ var NormalComponent = class extends PrimitiveComponent {
   _getSchematicSymbolDisplayValue() {
     return void 0;
   }
+  _getInternallyConnectedPorts() {
+    if (this.internallyConnectedPortNames.length === 0) return [];
+    const internallyConnectedPorts = [];
+    for (const netPortNames of this.internallyConnectedPortNames) {
+      const ports = [];
+      for (const portName of netPortNames) {
+        ports.push(this.portMap[portName]);
+      }
+      internallyConnectedPorts.push(ports);
+    }
+    return internallyConnectedPorts;
+  }
   _doInitialSchematicComponentRenderWithSymbol() {
     if (this.root?.schematicDisabled) return;
     const { db } = this.root;
@@ -3241,7 +3323,7 @@ var NormalComponent = class extends PrimitiveComponent {
     }
     super.add(component);
   }
-  getPortsFromFootprint() {
+  getPortsFromFootprint(opts) {
     let { footprint } = this.props;
     if (!footprint || isValidElement(footprint)) {
       footprint = this.children.find((c) => c.componentName === "Footprint");
@@ -3251,7 +3333,7 @@ var NormalComponent = class extends PrimitiveComponent {
       const newPorts2 = [];
       for (const elm of fpSoup) {
         if ("port_hints" in elm && elm.port_hints) {
-          const newPort = getPortFromHints(elm.port_hints);
+          const newPort = getPortFromHints(elm.port_hints, opts);
           if (!newPort) continue;
           newPort.originDescription = `footprint:string:${footprint}:port_hints[0]:${elm.port_hints[0]}`;
           newPorts2.push(newPort);
@@ -3310,41 +3392,6 @@ var NormalComponent = class extends PrimitiveComponent {
   _createNetsFromProps(propsWithConnections) {
     createNetsFromProps(this, propsWithConnections);
   }
-  /**
-   * Use data from our props to create ports for this component.
-   *
-   * Generally, this is done by looking at the schematic and the footprint,
-   * reading the pins, making sure there aren't duplicates.
-   *
-   * Can probably be removed in favor of initPorts()
-   *
-   */
-  doInitialPortDiscovery() {
-    const { _parsedProps: props } = this;
-    let newPorts = [];
-    if (!props.schPortArrangement) {
-      newPorts = [
-        ...this.getPortsFromFootprint(),
-        ...this.getPortsFromSchematicSymbol()
-      ];
-    }
-    const existingPorts = this.children.filter(
-      (c) => c.componentName === "Port"
-    );
-    for (const newPort of newPorts) {
-      const existingPort = existingPorts.find(
-        (p) => p.isMatchingAnyOf(newPort.getNameAndAliases())
-      );
-      if (existingPort) {
-        if (!existingPort.schematicSymbolPortDef && newPort.schematicSymbolPortDef) {
-          existingPort.schematicSymbolPortDef = newPort.schematicSymbolPortDef;
-        }
-        continue;
-      }
-      existingPorts.push(newPort);
-      this.add(newPort);
-    }
-  }
   _getPcbCircuitJsonBounds() {
     const { db } = this.root;
     if (!this.pcb_component_id) return super._getPcbCircuitJsonBounds();
@@ -3361,20 +3408,26 @@ var NormalComponent = class extends PrimitiveComponent {
       height: pcb_component.height
     };
   }
+  _getPinCountFromSchematicPortArrangement() {
+    const schPortArrangement = this._getSchematicPortArrangement();
+    if (!schPortArrangement) return 0;
+    const isExplicitPinMapping = isExplicitPinMappingArrangement(schPortArrangement);
+    if (!isExplicitPinMapping) {
+      return (schPortArrangement.leftSize ?? schPortArrangement.leftPinCount ?? 0) + (schPortArrangement.rightSize ?? schPortArrangement.rightPinCount ?? 0) + (schPortArrangement.topSize ?? schPortArrangement.topPinCount ?? 0) + (schPortArrangement.bottomSize ?? schPortArrangement.bottomPinCount ?? 0);
+    }
+    const { leftSide, rightSide, topSide, bottomSide } = schPortArrangement;
+    return Math.max(
+      ...leftSide?.pins ?? [],
+      ...rightSide?.pins ?? [],
+      ...topSide?.pins ?? [],
+      ...bottomSide?.pins ?? []
+    );
+  }
   _getPinCount() {
     const schPortArrangement = this._getSchematicPortArrangement();
     if (schPortArrangement) {
-      const isExplicitPinMapping = isExplicitPinMappingArrangement(schPortArrangement);
-      if (!isExplicitPinMapping) {
-        return (schPortArrangement.leftSize ?? schPortArrangement.leftPinCount ?? 0) + (schPortArrangement.rightSize ?? schPortArrangement.rightPinCount ?? 0) + (schPortArrangement.topSize ?? schPortArrangement.topPinCount ?? 0) + (schPortArrangement.bottomSize ?? schPortArrangement.bottomPinCount ?? 0);
-      }
-      const { leftSide, rightSide, topSide, bottomSide } = schPortArrangement;
-      return Math.max(
-        ...leftSide?.pins ?? [],
-        ...rightSide?.pins ?? [],
-        ...topSide?.pins ?? [],
-        ...bottomSide?.pins ?? []
-      );
+      const pinCountFromSchematicPortArrangement = this._getPinCountFromSchematicPortArrangement();
+      return pinCountFromSchematicPortArrangement;
     }
     return this.getPortsFromFootprint().length;
   }
@@ -6337,8 +6390,15 @@ var PushButton = class extends NormalComponent {
       sourceFtype: FTYPE.simple_push_button
     };
   }
+  get defaultInternallyConnectedPortNames() {
+    return [
+      ["pin1", "pin4"],
+      ["pin2", "pin3"]
+    ];
+  }
   initPorts() {
     super.initPorts({
+      pinCount: 4,
       additionalAliases: {
         pin1: ["side1"],
         pin3: ["side2"]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.280",
+  "version": "0.0.282",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -55,7 +55,7 @@
     "@tscircuit/footprinter": "^0.0.97",
     "@tscircuit/infgrid-ijump-astar": "^0.0.33",
     "@tscircuit/math-utils": "^0.0.9",
-    "@tscircuit/props": "^0.0.130",
+    "@tscircuit/props": "^0.0.134",
     "@tscircuit/schematic-autolayout": "^0.0.6",
     "@tscircuit/soup-util": "^0.0.41",
     "circuit-json": "^0.0.134",