@tscircuit/core 0.0.280 → 0.0.281

package/dist/index.d.ts

@@ -10,7 +10,7 @@ import { Matrix } from 'transformation-matrix';
 import { SoupUtilObjects } from '@tscircuit/soup-util';
 import * as _tscircuit_layout from '@tscircuit/layout';
 
-declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "InitializePortsFromChildren", "CreateNetsFromProps", "CreateTracesFromProps", "CreateTraceHintsFromProps", "SourceRender", "SourceParentAttachment", "PortDiscovery", "PortMatching", "SourceTraceRender", "SourceAddConnectivityMapKey", "SchematicComponentRender", "SchematicPortRender", "SchematicLayout", "SchematicTraceRender", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbLayout", "PcbComponentSizeCalculation", "PcbTraceRender", "PcbTraceHintRender", "PcbRouteNetIslands", "CadModelRender", "PartsEngineRender"];
+declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "InitializePortsFromChildren", "CreateNetsFromProps", "CreateTracesFromProps", "CreateTraceHintsFromProps", "SourceRender", "SourceParentAttachment", "PortMatching", "SourceTraceRender", "SourceAddConnectivityMapKey", "SchematicComponentRender", "SchematicPortRender", "SchematicLayout", "SchematicTraceRender", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbLayout", "PcbComponentSizeCalculation", "PcbTraceRender", "PcbTraceHintRender", "PcbRouteNetIslands", "CadModelRender", "PartsEngineRender"];
 type RenderPhase = (typeof orderedRenderPhases)[number];
 type RenderPhaseFn<K extends RenderPhase = RenderPhase> = `doInitial${K}` | `update${K}` | `remove${K}`;
 type RenderPhaseStates = Record<RenderPhase, {
@@ -808,6 +808,7 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
      */
     initPorts(opts?: {
         additionalAliases?: Record<`pin${number}`, string[]>;
+        pinCount?: number;
     }): void;
     _getImpliedFootprintString(): string | null;
     _addChildrenFromStringFootprint(): void;
@@ -836,19 +837,11 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
     doInitialReactSubtreesRender(): void;
     _hasExistingPortExactly(port1: Port): boolean;
     add(componentOrElm: PrimitiveComponent | ReactElement): void;
-    getPortsFromFootprint(): Port[];
+    getPortsFromFootprint(opts?: {
+        additionalAliases?: Record<string, string[]>;
+    }): Port[];
     getPortsFromSchematicSymbol(): Port[];
     _createNetsFromProps(propsWithConnections: (string | undefined | null)[]): void;
-    /**
-     * 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(): void;
     _getPcbCircuitJsonBounds(): {
         center: {
             x: number;
@@ -863,6 +856,7 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
         width: number;
         height: number;
     };
+    _getPinCountFromSchematicPortArrangement(): number;
     _getPinCount(): number;
     /**
      * Override the schematic port arrangement if you want to customize where pins
@@ -9939,11 +9933,19 @@ type PinNumbers100 = "pin1" | "pin2" | "pin3" | "pin4" | "pin5" | "pin6" | "pin7
 type CommonPinNames = "pos" | "neg" | "V5" | "V3_3" | "VCC" | "VDD" | "GND" | `D${Nums40}` | `GP${Nums40}` | `GPIO${Nums40}` | "DP" | "DN" | "VIN" | "VOUT" | "VREF" | "VIN" | "VOUT" | "VREF" | "VIN" | "VOUT" | "VREF" | `A${Nums40}` | `B${Nums40}` | PinNumbers100;
 type TransistorPinNames = "base" | "collector" | "emitter";
 
-type NonPolarizedSel = Record<`R${Nums40}` | `SW${Nums40}`, {
+type NonPolarizedSel = Record<`R${Nums40}`, {
+    pin1: string;
+    pin2: string;
+    pos: string;
+    neg: string;
+}>;
+type SwSel = Record<`SW${Nums40}`, {
     pin1: string;
     pin2: string;
     pos: string;
     neg: string;
+    side1: string;
+    side2: string;
 }>;
 type PolarizedSel = Record<`C${Nums40}` | `L${Nums40}` | `LED${Nums40}` | `D${Nums40}` | `Y${Nums40}` | `B${Nums16}`, {
     pin1: string;
@@ -9957,7 +9959,7 @@ type TransistorSel = Record<`Q${Nums40}`, Record<TransistorPinNames, string>>;
 type JumperSel = Record<`J${Nums40}`, Record<PinNumbers100, string>>;
 type ChipSel = Record<`U${Nums40}`, Record<CommonPinNames, string>>;
 type NetSel = Record<"net", Record<"VCC" | "GND" | "VDD", string>>;
-type Sel = NonPolarizedSel & PolarizedSel & TransistorSel & JumperSel & ChipSel & NetSel;
+type Sel = NonPolarizedSel & PolarizedSel & TransistorSel & JumperSel & ChipSel & SwSel & NetSel;
 declare const sel: Sel;
 
 interface TscircuitElements {

package/dist/index.js

@@ -72,7 +72,6 @@ var orderedRenderPhases = [
   "CreateTraceHintsFromProps",
   "SourceRender",
   "SourceParentAttachment",
-  "PortDiscovery",
   "PortMatching",
   "SourceTraceRender",
   "SourceAddConnectivityMapKey",
@@ -2267,14 +2266,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
   });
 }
 
@@ -2926,10 +2930,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 +2941,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 = [
@@ -3241,7 +3244,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 +3254,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 +3313,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 +3329,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;
   }
@@ -6339,6 +6313,7 @@ var PushButton = class extends NormalComponent {
   }
   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.281",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",