@tscircuit/core 0.0.282 → 0.0.284

package/dist/index.d.ts

@@ -781,7 +781,7 @@ declare class Port extends PrimitiveComponent<typeof portProps> {
 }
 
 interface INormalComponent {
-    _getInternallyConnectedPorts(): Port[][];
+    _getInternallyConnectedPins(): Port[][];
 }
 
 type PortMap<T extends string> = {
@@ -813,8 +813,8 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
     /**
      * Override this property for component defaults
      */
-    get defaultInternallyConnectedPortNames(): string[][];
-    get internallyConnectedPortNames(): string[][];
+    get defaultInternallyConnectedPinNames(): string[][];
+    get internallyConnectedPinNames(): string[][];
     constructor(props: z.input<ZodProps>);
     /**
      * Override this method for better control over the auto-discovery of ports.
@@ -848,7 +848,7 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
      */
     doInitialSchematicComponentRender(): void;
     _getSchematicSymbolDisplayValue(): string | undefined;
-    _getInternallyConnectedPorts(): Port[][];
+    _getInternallyConnectedPins(): Port[][];
     _doInitialSchematicComponentRenderWithSymbol(): void;
     _doInitialSchematicComponentRenderWithSchematicBoxDimensions(): void;
     doInitialPcbComponentRender(): void;
@@ -2051,8 +2051,108 @@ declare class Chip<PinLabels extends string = never> extends NormalComponent<typ
         }>, {
             manufacturerPartNumber: zod.ZodOptional<zod.ZodString>;
             pinLabels: zod.ZodOptional<zod.ZodRecord<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, zod.ZodUnion<[zod.ZodString, zod.ZodReadonly<zod.ZodArray<zod.ZodString, "many">>]>>>;
-            internallyConnectedPorts: zod.ZodOptional<zod.ZodArray<zod.ZodArray<zod.ZodString, "many">, "many">>;
-            externallyConnectedPorts: zod.ZodOptional<zod.ZodArray<zod.ZodArray<zod.ZodString, "many">, "many">>;
+            internallyConnectedPins: zod.ZodOptional<zod.ZodArray<zod.ZodArray<zod.ZodString, "many">, "many">>;
+            externallyConnectedPins: zod.ZodOptional<zod.ZodArray<zod.ZodArray<zod.ZodString, "many">, "many">>;
+            schPinArrangement: zod.ZodOptional<zod.ZodObject<{
+                leftSize: zod.ZodOptional<zod.ZodNumber>;
+                topSize: zod.ZodOptional<zod.ZodNumber>;
+                rightSize: zod.ZodOptional<zod.ZodNumber>;
+                bottomSize: zod.ZodOptional<zod.ZodNumber>;
+                leftPinCount: zod.ZodOptional<zod.ZodNumber>;
+                rightPinCount: zod.ZodOptional<zod.ZodNumber>;
+                topPinCount: zod.ZodOptional<zod.ZodNumber>;
+                bottomPinCount: zod.ZodOptional<zod.ZodNumber>;
+                leftSide: zod.ZodOptional<zod.ZodObject<{
+                    pins: zod.ZodArray<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, "many">;
+                    direction: zod.ZodUnion<[zod.ZodLiteral<"top-to-bottom">, zod.ZodLiteral<"left-to-right">, zod.ZodLiteral<"bottom-to-top">, zod.ZodLiteral<"right-to-left">]>;
+                }, "strip", zod.ZodTypeAny, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }>>;
+                rightSide: zod.ZodOptional<zod.ZodObject<{
+                    pins: zod.ZodArray<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, "many">;
+                    direction: zod.ZodUnion<[zod.ZodLiteral<"top-to-bottom">, zod.ZodLiteral<"left-to-right">, zod.ZodLiteral<"bottom-to-top">, zod.ZodLiteral<"right-to-left">]>;
+                }, "strip", zod.ZodTypeAny, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }>>;
+                topSide: zod.ZodOptional<zod.ZodObject<{
+                    pins: zod.ZodArray<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, "many">;
+                    direction: zod.ZodUnion<[zod.ZodLiteral<"top-to-bottom">, zod.ZodLiteral<"left-to-right">, zod.ZodLiteral<"bottom-to-top">, zod.ZodLiteral<"right-to-left">]>;
+                }, "strip", zod.ZodTypeAny, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }>>;
+                bottomSide: zod.ZodOptional<zod.ZodObject<{
+                    pins: zod.ZodArray<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, "many">;
+                    direction: zod.ZodUnion<[zod.ZodLiteral<"top-to-bottom">, zod.ZodLiteral<"left-to-right">, zod.ZodLiteral<"bottom-to-top">, zod.ZodLiteral<"right-to-left">]>;
+                }, "strip", zod.ZodTypeAny, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }, {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                }>>;
+            }, "strip", zod.ZodTypeAny, {
+                leftSize?: number | undefined;
+                topSize?: number | undefined;
+                rightSize?: number | undefined;
+                bottomSize?: number | undefined;
+                leftSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                topSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                rightSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                bottomSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                leftPinCount?: number | undefined;
+                rightPinCount?: number | undefined;
+                topPinCount?: number | undefined;
+                bottomPinCount?: number | undefined;
+            }, {
+                leftSize?: number | undefined;
+                topSize?: number | undefined;
+                rightSize?: number | undefined;
+                bottomSize?: number | undefined;
+                leftSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                topSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                rightSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                bottomSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                leftPinCount?: number | undefined;
+                rightPinCount?: number | undefined;
+                topPinCount?: number | undefined;
+                bottomPinCount?: number | undefined;
+            }>>;
             schPortArrangement: zod.ZodOptional<zod.ZodObject<{
                 leftSize: zod.ZodOptional<zod.ZodNumber>;
                 topSize: zod.ZodOptional<zod.ZodNumber>;
@@ -2242,8 +2342,34 @@ declare class Chip<PinLabels extends string = never> extends NormalComponent<typ
             symbolName?: string | undefined;
             manufacturerPartNumber?: string | undefined;
             pinLabels?: Record<string | number, string | readonly string[]> | undefined;
-            internallyConnectedPorts?: string[][] | undefined;
-            externallyConnectedPorts?: string[][] | undefined;
+            internallyConnectedPins?: string[][] | undefined;
+            externallyConnectedPins?: string[][] | undefined;
+            schPinArrangement?: {
+                leftSize?: number | undefined;
+                topSize?: number | undefined;
+                rightSize?: number | undefined;
+                bottomSize?: number | undefined;
+                leftSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                topSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                rightSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                bottomSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                leftPinCount?: number | undefined;
+                rightPinCount?: number | undefined;
+                topPinCount?: number | undefined;
+                bottomPinCount?: number | undefined;
+            } | undefined;
             schPortArrangement?: {
                 leftSize?: number | undefined;
                 topSize?: number | undefined;
@@ -2351,8 +2477,34 @@ declare class Chip<PinLabels extends string = never> extends NormalComponent<typ
             symbolName?: string | undefined;
             manufacturerPartNumber?: string | undefined;
             pinLabels?: Record<string | number, string | readonly string[]> | undefined;
-            internallyConnectedPorts?: string[][] | undefined;
-            externallyConnectedPorts?: string[][] | undefined;
+            internallyConnectedPins?: string[][] | undefined;
+            externallyConnectedPins?: string[][] | undefined;
+            schPinArrangement?: {
+                leftSize?: number | undefined;
+                topSize?: number | undefined;
+                rightSize?: number | undefined;
+                bottomSize?: number | undefined;
+                leftSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                topSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                rightSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                bottomSide?: {
+                    pins: (string | number)[];
+                    direction: "top-to-bottom" | "left-to-right" | "bottom-to-top" | "right-to-left";
+                } | undefined;
+                leftPinCount?: number | undefined;
+                rightPinCount?: number | undefined;
+                topPinCount?: number | undefined;
+                bottomPinCount?: number | undefined;
+            } | undefined;
             schPortArrangement?: {
                 leftSize?: number | undefined;
                 topSize?: number | undefined;
@@ -5607,6 +5759,45 @@ declare class SmtPad extends PrimitiveComponent<typeof smtPadProps> {
                 name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
             } | undefined;
             portHints?: (string | number)[] | undefined;
+        }>, zod.ZodObject<zod.objectUtil.extendShape<Omit<{
+            pcbX: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            pcbY: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            pcbRotation: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            layer: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>, zod.ZodObject<{
+                name: zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>;
+            }, "strip", zod.ZodTypeAny, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>]>, "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6", "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>>;
+        }, "pcbRotation">, {
+            shape: zod.ZodLiteral<"pill">;
+            width: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            height: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            radius: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            portHints: zod.ZodOptional<zod.ZodArray<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, "many">>;
+        }>, "strip", zod.ZodTypeAny, {
+            shape: "pill";
+            width: number;
+            height: number;
+            radius: number;
+            pcbX?: number | undefined;
+            pcbY?: number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | undefined;
+            portHints?: (string | number)[] | undefined;
+        }, {
+            shape: "pill";
+            width: string | number;
+            height: string | number;
+            radius: string | number;
+            pcbX?: string | number | undefined;
+            pcbY?: string | number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            } | undefined;
+            portHints?: (string | number)[] | undefined;
         }>]>;
     };
     getPcbSize(): {
@@ -8253,7 +8444,9 @@ declare class PushButton extends NormalComponent<typeof pushButtonProps, Passive
             }>]>>;
             children: zod.ZodOptional<zod.ZodAny>;
             symbolName: zod.ZodOptional<zod.ZodString>;
-        }>, {}>, "strip", zod.ZodTypeAny, {
+        }>, {
+            internallyConnectedPins: zod.ZodOptional<zod.ZodArray<zod.ZodArray<zod.ZodString, "many">, "many">>;
+        }>, "strip", zod.ZodTypeAny, {
             name: string;
             pcbX?: number | undefined;
             pcbY?: number | undefined;
@@ -8320,6 +8513,7 @@ declare class PushButton extends NormalComponent<typeof pushButtonProps, Passive
             } | undefined;
             children?: any;
             symbolName?: string | undefined;
+            internallyConnectedPins?: string[][] | undefined;
         }, {
             name: string;
             pcbX?: string | number | undefined;
@@ -8389,10 +8583,11 @@ declare class PushButton extends NormalComponent<typeof pushButtonProps, Passive
             } | undefined;
             children?: any;
             symbolName?: string | undefined;
+            internallyConnectedPins?: string[][] | undefined;
         }>;
         sourceFtype: "simple_push_button";
     };
-    get defaultInternallyConnectedPortNames(): string[][];
+    get defaultInternallyConnectedPinNames(): string[][];
     initPorts(): void;
     doInitialSourceRender(): void;
 }

package/dist/index.js

@@ -2052,8 +2052,8 @@ var Port = class extends PrimitiveComponent {
   }
   _getPortsInternallyConnectedToThisPort() {
     const parent = this.parent;
-    if (!parent || !parent._getInternallyConnectedPorts) return [];
-    const internallyConnectedPorts = parent._getInternallyConnectedPorts();
+    if (!parent || !parent._getInternallyConnectedPins) return [];
+    const internallyConnectedPorts = parent._getInternallyConnectedPins();
     for (const ports of internallyConnectedPorts) {
       if (ports.some((port) => port === this)) {
         return ports;
@@ -2877,11 +2877,11 @@ var NormalComponent = class extends PrimitiveComponent {
   /**
    * Override this property for component defaults
    */
-  get defaultInternallyConnectedPortNames() {
+  get defaultInternallyConnectedPinNames() {
     return [];
   }
-  get internallyConnectedPortNames() {
-    return this._parsedProps.internallyConnectedPorts ?? this.defaultInternallyConnectedPortNames;
+  get internallyConnectedPinNames() {
+    return this._parsedProps.internallyConnectedPins ?? this.defaultInternallyConnectedPinNames;
   }
   constructor(props) {
     super(props);
@@ -2906,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;
@@ -2998,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(
@@ -3009,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)
       );
@@ -3028,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
@@ -3124,10 +3124,10 @@ var NormalComponent = class extends PrimitiveComponent {
   _getSchematicSymbolDisplayValue() {
     return void 0;
   }
-  _getInternallyConnectedPorts() {
-    if (this.internallyConnectedPortNames.length === 0) return [];
+  _getInternallyConnectedPins() {
+    if (this.internallyConnectedPinNames.length === 0) return [];
     const internallyConnectedPorts = [];
-    for (const netPortNames of this.internallyConnectedPortNames) {
+    for (const netPortNames of this.internallyConnectedPinNames) {
       const ports = [];
       for (const portName of netPortNames) {
         ports.push(this.portMap[portName]);
@@ -3171,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,
@@ -3179,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({
@@ -3436,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;
@@ -6390,7 +6389,7 @@ var PushButton = class extends NormalComponent {
       sourceFtype: FTYPE.simple_push_button
     };
   }
-  get defaultInternallyConnectedPortNames() {
+  get defaultInternallyConnectedPinNames() {
     return [
       ["pin1", "pin4"],
       ["pin2", "pin3"]

package/package.json

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