@tscircuit/core 0.0.102 → 0.0.103

package/dist/index.d.ts

@@ -2762,6 +2762,20 @@ declare class TraceHint extends PrimitiveComponent<typeof traceHintProps> {
     doInitialPcbTraceHintRender(): void;
 }
 
+/**
+ * Get the dimensions of a schematic box based on the provided parameters.
+ *
+ * A schematic box is a rectangular box with a set of pins on the sides.
+ *
+ * The user can customize the position of the pins and the spacing between them,
+ * this makes computing the box fairly complicated.
+ *
+ * A note on the internals:
+ * * A "true port" refers to a pin/port before it's remapped by the user to a
+ *   different position. True Pin 1 is guaranteed to be in the top-left corner
+ * * We basically iterate over each side and compute how far we are from the
+ *   edge for that side by adding margins together
+ */
 interface SchematicBoxDimensions {
     pinCount: number;
     getPortPositionByPinNumber(pinNumber: number): {

package/dist/index.js

@@ -3231,7 +3231,7 @@ function isExplicitPinMappingArrangement(arrangement) {
   return arrangement.leftSide !== void 0;
 }
 var getAllDimensionsForSchematicBox = (params) => {
-  const portDistanceFromEdge = params.portDistanceFromEdge ?? params.schPinSpacing * 2;
+  const componentMargin = params.schPinSpacing;
   let sidePinCounts = params.schPortArrangement ? getSizeOfSidesFromPortArrangement(params.schPortArrangement) : null;
   const sideLengths = {
     left: 0,
@@ -3242,7 +3242,7 @@ var getAllDimensionsForSchematicBox = (params) => {
   let pinCount = params.pinCount ?? null;
   if (pinCount === null) {
     if (sidePinCounts) {
-      pinCount = sidePinCounts.leftSize + sidePinCounts.rightSize + sidePinCounts.topSize;
+      pinCount = sidePinCounts.leftSize + sidePinCounts.rightSize + sidePinCounts.topSize + sidePinCounts.bottomSize;
     } else {
       throw new Error("Could not determine pin count for the schematic box");
     }
@@ -3264,139 +3264,135 @@ var getAllDimensionsForSchematicBox = (params) => {
       bottomSize: 0
     };
   }
+  const schWidth = params.schWidth ?? Math.max(sidePinCounts.topSize, sidePinCounts.bottomSize) * params.schPinSpacing + 2 * componentMargin;
+  const schHeight = params.schHeight ?? Math.max(sidePinCounts.leftSize, sidePinCounts.rightSize) * params.schPinSpacing + 2 * componentMargin;
+  const distributePorts = (sideSize, sideLength, totalMargin) => {
+    if (sideSize <= 1) return 0;
+    return (sideLength - totalMargin) / (sideSize - 1);
+  };
   const orderedTruePorts = [];
-  let currentDistanceFromEdge = 0;
   let truePinIndex = 0;
-  for (let sideIndex = 0; sideIndex < sidePinCounts.leftSize; sideIndex++) {
-    const pinNumber = params.schPortArrangement && isExplicitPinMappingArrangement(params.schPortArrangement) ? params.schPortArrangement?.leftSide?.pins[sideIndex] : truePinIndex + 1;
-    const pinStyle = params.schPinStyle?.[`pin${pinNumber}`] ?? params.schPinStyle?.[pinNumber];
-    if (pinStyle?.topMargin) {
-      currentDistanceFromEdge += pinStyle.topMargin;
-    }
-    orderedTruePorts.push({
-      trueIndex: truePinIndex,
-      pinNumber,
-      side: "left",
-      distanceFromEdge: currentDistanceFromEdge
-    });
-    if (pinStyle?.bottomMargin) {
-      currentDistanceFromEdge += pinStyle.bottomMargin;
+  const processSide = (side, pins, direction) => {
+    const isVertical = side === "left" || side === "right";
+    const sideLength = isVertical ? schHeight : schWidth;
+    let totalMargin = 0;
+    for (const pin of pins) {
+      const pinStyle = params.schPinStyle?.[`pin${pin}`] ?? params.schPinStyle?.[pin];
+      if (pinStyle) {
+        if (isVertical) {
+          totalMargin += (pinStyle.topMargin ?? 0) + (pinStyle.bottomMargin ?? 0);
+        } else {
+          totalMargin += (pinStyle.leftMargin ?? 0) + (pinStyle.rightMargin ?? 0);
+        }
+      }
     }
-    const isLastPinOnSide = sideIndex === sidePinCounts.leftSize - 1;
-    if (!isLastPinOnSide) {
-      currentDistanceFromEdge += params.schPinSpacing;
-    } else {
-      sideLengths.left = currentDistanceFromEdge;
-    }
-    truePinIndex++;
-  }
-  currentDistanceFromEdge = 0;
-  for (let sideIndex = 0; sideIndex < sidePinCounts.bottomSize; sideIndex++) {
-    const pinNumber = params.schPortArrangement && isExplicitPinMappingArrangement(params.schPortArrangement) ? params.schPortArrangement.bottomSide?.pins[sideIndex] : truePinIndex + 1;
-    const pinStyle = params.schPinStyle?.[`pin${pinNumber}`] ?? params.schPinStyle?.[pinNumber];
-    if (pinStyle?.leftMargin) {
-      currentDistanceFromEdge += pinStyle.leftMargin;
-    }
-    orderedTruePorts.push({
-      trueIndex: truePinIndex,
-      pinNumber,
-      side: "bottom",
-      distanceFromEdge: currentDistanceFromEdge
+    const spacing = distributePorts(
+      pins.length,
+      sideLength - 2 * componentMargin,
+      totalMargin
+    );
+    let currentDistanceFromEdge = componentMargin;
+    pins.forEach((pinNumber, index) => {
+      const pinStyle = params.schPinStyle?.[`pin${pinNumber}`] ?? params.schPinStyle?.[pinNumber];
+      if (pinStyle) {
+        if (isVertical) {
+          if (side === "left") {
+            currentDistanceFromEdge += direction === "top-to-bottom" ? pinStyle.topMargin ?? 0 : pinStyle.bottomMargin ?? 0;
+          } else {
+            currentDistanceFromEdge += direction === "top-to-bottom" ? pinStyle.bottomMargin ?? 0 : pinStyle.topMargin ?? 0;
+          }
+        } else {
+          if (side === "top") {
+            currentDistanceFromEdge += direction === "left-to-right" ? pinStyle.leftMargin ?? 0 : pinStyle.rightMargin ?? 0;
+          } else {
+            currentDistanceFromEdge += direction === "left-to-right" ? pinStyle.rightMargin ?? 0 : pinStyle.leftMargin ?? 0;
+          }
+        }
+      }
+      orderedTruePorts.push({
+        trueIndex: truePinIndex,
+        pinNumber,
+        side,
+        distanceFromEdge: currentDistanceFromEdge
+      });
+      if (pinStyle) {
+        if (isVertical) {
+          if (side === "left") {
+            currentDistanceFromEdge += direction === "top-to-bottom" ? pinStyle.bottomMargin ?? 0 : pinStyle.topMargin ?? 0;
+          } else {
+            currentDistanceFromEdge += direction === "top-to-bottom" ? pinStyle.topMargin ?? 0 : pinStyle.bottomMargin ?? 0;
+          }
+        } else {
+          if (side === "top") {
+            currentDistanceFromEdge += direction === "left-to-right" ? pinStyle.rightMargin ?? 0 : pinStyle.leftMargin ?? 0;
+          } else {
+            currentDistanceFromEdge += direction === "left-to-right" ? pinStyle.leftMargin ?? 0 : pinStyle.rightMargin ?? 0;
+          }
+        }
+      }
+      currentDistanceFromEdge += spacing;
+      truePinIndex++;
     });
-    if (pinStyle?.rightMargin) {
-      currentDistanceFromEdge += pinStyle.rightMargin;
+    sideLengths[side] = sideLength;
+  };
+  if (params.schPortArrangement && isExplicitPinMappingArrangement(params.schPortArrangement)) {
+    if (params.schPortArrangement.leftSide) {
+      processSide(
+        "left",
+        params.schPortArrangement.leftSide.pins,
+        params.schPortArrangement.leftSide.direction ?? "top-to-bottom"
+      );
     }
-    const isLastPinOnSide = sideIndex === sidePinCounts.bottomSize - 1;
-    if (!isLastPinOnSide) {
-      currentDistanceFromEdge += params.schPinSpacing;
-    } else {
-      sideLengths.bottom = currentDistanceFromEdge;
-    }
-    truePinIndex++;
-  }
-  currentDistanceFromEdge = 0;
-  for (let sideIndex = 0; sideIndex < sidePinCounts.rightSize; sideIndex++) {
-    const pinNumber = params.schPortArrangement && isExplicitPinMappingArrangement(params.schPortArrangement) ? params.schPortArrangement.rightSide?.pins[sideIndex] : truePinIndex + 1;
-    const pinStyle = params.schPinStyle?.[`pin${pinNumber}`] ?? params.schPinStyle?.[pinNumber];
-    if (pinStyle?.bottomMargin) {
-      currentDistanceFromEdge += pinStyle.bottomMargin;
-    }
-    orderedTruePorts.push({
-      trueIndex: truePinIndex,
-      pinNumber,
-      side: "right",
-      distanceFromEdge: currentDistanceFromEdge
-    });
-    if (pinStyle?.topMargin) {
-      currentDistanceFromEdge += pinStyle.topMargin;
+    if (params.schPortArrangement.rightSide) {
+      processSide(
+        "right",
+        params.schPortArrangement.rightSide.pins,
+        params.schPortArrangement.rightSide.direction ?? "bottom-to-top"
+      );
     }
-    const isLastPinOnSide = sideIndex === sidePinCounts.rightSize - 1;
-    if (!isLastPinOnSide) {
-      currentDistanceFromEdge += params.schPinSpacing;
-    } else {
-      sideLengths.right = currentDistanceFromEdge;
-    }
-    truePinIndex++;
-  }
-  currentDistanceFromEdge = 0;
-  for (let sideIndex = 0; sideIndex < sidePinCounts.topSize; sideIndex++) {
-    const pinNumber = params.schPortArrangement && isExplicitPinMappingArrangement(params.schPortArrangement) ? params.schPortArrangement.topSide?.pins[sideIndex] : truePinIndex + 1;
-    const pinStyle = params.schPinStyle?.[`pin${pinNumber}`] ?? params.schPinStyle?.[pinNumber];
-    if (pinStyle?.rightMargin) {
-      currentDistanceFromEdge += pinStyle.rightMargin;
-    }
-    orderedTruePorts.push({
-      trueIndex: truePinIndex,
-      pinNumber,
-      side: "top",
-      distanceFromEdge: currentDistanceFromEdge
-    });
-    if (pinStyle?.leftMargin) {
-      currentDistanceFromEdge += pinStyle.leftMargin;
+    if (params.schPortArrangement.topSide) {
+      processSide(
+        "top",
+        params.schPortArrangement.topSide.pins,
+        params.schPortArrangement.topSide.direction ?? "left-to-right"
+      );
     }
-    const isLastPinOnSide = sideIndex === sidePinCounts.topSize - 1;
-    if (!isLastPinOnSide) {
-      currentDistanceFromEdge += params.schPinSpacing;
-    } else {
-      sideLengths.top = currentDistanceFromEdge;
+    if (params.schPortArrangement.bottomSide) {
+      processSide(
+        "bottom",
+        params.schPortArrangement.bottomSide.pins,
+        params.schPortArrangement.bottomSide.direction ?? "left-to-right"
+      );
     }
-    truePinIndex++;
-  }
-  let schWidth = params.schWidth;
-  if (!schWidth) {
-    schWidth = Math.max(
-      sideLengths.top + params.schPinSpacing * 2,
-      sideLengths.bottom + params.schPinSpacing * 2
+  } else {
+    const leftSide = Array.from(
+      { length: sidePinCounts.leftSize },
+      (_, i) => i + 1
     );
-  }
-  let schHeight = params.schHeight;
-  if (!schHeight) {
-    schHeight = Math.max(
-      sideLengths.left + params.schPinSpacing * 2,
-      sideLengths.right + params.schPinSpacing * 2
+    const rightSide = Array.from(
+      { length: sidePinCounts.rightSize },
+      (_, i) => i + sidePinCounts.leftSize + 1
+    );
+    const topSide = Array.from(
+      { length: sidePinCounts.topSize },
+      (_, i) => i + sidePinCounts.leftSize + sidePinCounts.rightSize + 1
+    );
+    const bottomSide = Array.from(
+      {
+        length: pinCount - sidePinCounts.leftSize - sidePinCounts.rightSize - sidePinCounts.topSize
+      },
+      (_, i) => i + sidePinCounts.leftSize + sidePinCounts.rightSize + sidePinCounts.topSize + 1
     );
+    processSide("left", leftSide, "top-to-bottom");
+    processSide("right", rightSide, "top-to-bottom");
+    processSide("top", topSide, "left-to-right");
+    processSide("bottom", bottomSide, "left-to-right");
   }
   const trueEdgePositions = {
-    // Top left corner
-    left: {
-      x: -schWidth / 2 - portDistanceFromEdge,
-      y: sideLengths.left / 2
-    },
-    // bottom left corner
-    bottom: {
-      x: -sideLengths.bottom / 2,
-      y: -schHeight / 2 - portDistanceFromEdge
-    },
-    // bottom right corner
-    right: {
-      x: schWidth / 2 + portDistanceFromEdge,
-      y: -sideLengths.right / 2
-    },
-    // top right corner
-    top: {
-      x: sideLengths.top / 2,
-      y: schHeight / 2 + portDistanceFromEdge
-    }
+    left: { x: -schWidth / 2, y: schHeight / 2 },
+    bottom: { x: -schWidth / 2, y: schHeight / 2 },
+    right: { x: schWidth / 2, y: -schHeight / 2 },
+    top: { x: schWidth / 2, y: -schHeight / 2 }
   };
   const trueEdgeTraversalDirections = {
     left: { x: 0, y: -1 },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.102",
+  "version": "0.0.103",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",