@tscircuit/core 0.0.281 → 0.0.283

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";
@@ -2050,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) {
@@ -2065,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;
@@ -2200,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;
@@ -2571,7 +2629,7 @@ var getAllDimensionsForSchematicBox = (params) => {
   };
 };
 
-// lib/components/base-components/NormalComponent.ts
+// lib/components/base-components/NormalComponent/NormalComponent.ts
 import {
   isValidElement as isReactElement,
   isValidElement
@@ -2803,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,
@@ -2816,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();
@@ -2839,7 +2906,7 @@ var NormalComponent = class extends PrimitiveComponent {
     if (this.root?.schematicDisabled) return;
     const { config } = this;
     const portsToCreate = [];
-    const schPortArrangement = this._parsedProps.schPortArrangement;
+    const schPortArrangement = this._getSchematicPortArrangement();
     if (schPortArrangement && !this._parsedProps.pinLabels) {
       for (const side in schPortArrangement) {
         const pins = schPortArrangement[side].pins;
@@ -2931,7 +2998,7 @@ var NormalComponent = class extends PrimitiveComponent {
       }
       this.addAll(portsToCreate);
     }
-    if (!this._parsedProps.schPortArrangement) {
+    if (!this._getSchematicPortArrangement()) {
       const portsFromFootprint = this.getPortsFromFootprint(opts);
       for (const port of portsFromFootprint) {
         if (!portsToCreate.some(
@@ -2942,13 +3009,13 @@ var NormalComponent = class extends PrimitiveComponent {
       }
     }
     for (let pn = 1; pn <= (opts.pinCount ?? this._getPinCount()); pn++) {
-      if (!this._parsedProps.schPortArrangement) continue;
+      if (!schPortArrangement) continue;
       if (portsToCreate.find((p) => p._parsedProps.pinNumber === pn)) continue;
       let explicitlyListedPinNumbersInSchPortArrangement = [
-        ...this._parsedProps.schPortArrangement?.leftSide?.pins ?? [],
-        ...this._parsedProps.schPortArrangement?.rightSide?.pins ?? [],
-        ...this._parsedProps.schPortArrangement?.topSide?.pins ?? [],
-        ...this._parsedProps.schPortArrangement?.bottomSide?.pins ?? []
+        ...schPortArrangement.leftSide?.pins ?? [],
+        ...schPortArrangement.rightSide?.pins ?? [],
+        ...schPortArrangement.topSide?.pins ?? [],
+        ...schPortArrangement.bottomSide?.pins ?? []
       ].map(
         (pn2) => parsePinNumberFromLabelsOrThrow(pn2, this._parsedProps.pinLabels)
       );
@@ -2961,7 +3028,7 @@ var NormalComponent = class extends PrimitiveComponent {
         "rightPinCount",
         "topPinCount",
         "bottomPinCount"
-      ].some((key) => key in this._parsedProps.schPortArrangement)) {
+      ].some((key) => key in schPortArrangement)) {
         explicitlyListedPinNumbersInSchPortArrangement = Array.from(
           { length: this._getPinCount() },
           (_, i) => i + 1
@@ -3057,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;
@@ -3092,6 +3171,7 @@ var NormalComponent = class extends PrimitiveComponent {
       }
     }
     const center = this._getGlobalSchematicPositionBeforeLayout();
+    const schPortArrangement = this._getSchematicPortArrangement();
     const schematic_component2 = db.schematic_component.insert({
       center,
       rotation: props.schRotation ?? 0,
@@ -3100,16 +3180,14 @@ var NormalComponent = class extends PrimitiveComponent {
       // uses the schematic_component size to draw boxes instead of the
       // schematic_box size
       // size: dimensions.getSizeIncludingPins(),
-      port_arrangement: underscorifyPortArrangement(
-        props.schPortArrangement
-      ),
+      port_arrangement: underscorifyPortArrangement(schPortArrangement),
       pin_spacing: props.schPinSpacing ?? 0.2,
       // @ts-ignore soup needs to support distance for pin_styles
       pin_styles: underscorifyPinStyles(props.schPinStyle, props.pinLabels),
       port_labels: primaryPortLabels,
       source_component_id: this.source_component_id
     });
-    const hasTopOrBottomPins = props.schPortArrangement?.topSide !== void 0 || props.schPortArrangement?.bottomSide !== void 0;
+    const hasTopOrBottomPins = schPortArrangement?.topSide !== void 0 || schPortArrangement?.bottomSide !== void 0;
     const schematic_box_width = dimensions?.getSize().width;
     const schematic_box_height = dimensions?.getSize().height;
     const manufacturer_part_number_schematic_text = db.schematic_text.insert({
@@ -3357,7 +3435,7 @@ var NormalComponent = class extends PrimitiveComponent {
    * appear on a schematic box, e.g. for a pin header
    */
   _getSchematicPortArrangement() {
-    return this._parsedProps.schPortArrangement;
+    return this._parsedProps.schPinArrangement ?? this._parsedProps.schPortArrangement;
   }
   _getSchematicBoxDimensions() {
     if (this.getSchematicSymbol()) return null;
@@ -6311,6 +6389,12 @@ var PushButton = class extends NormalComponent {
       sourceFtype: FTYPE.simple_push_button
     };
   }
+  get defaultInternallyConnectedPortNames() {
+    return [
+      ["pin1", "pin4"],
+      ["pin2", "pin3"]
+    ];
+  }
   initPorts() {
     super.initPorts({
       pinCount: 4,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.281",
+  "version": "0.0.283",
   "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.136",
     "@tscircuit/schematic-autolayout": "^0.0.6",
     "@tscircuit/soup-util": "^0.0.41",
     "circuit-json": "^0.0.134",