@tscircuit/checks 0.0.173 → 0.0.175

package/README.md

@@ -15,6 +15,7 @@ and output an array of arrays for any issues found.
 | [`checkNoPowerPinDefined`](./lib/check-no-power-pin-defined.ts) | Returns `source_no_power_pin_defined_warning` when a chip has no pin with `requires_power=true`. |
 | [`checkNoGroundPinDefined`](./lib/check-no-ground-pin-defined.ts) | Returns `source_no_ground_pin_defined_warning` when a chip has no pin with `requires_ground=true`. |
 | [`checkSchematicComponentExcessiveVerticalPadding`](./lib/check-schematic-component-excessive-vertical-padding.ts) | Returns a `schematic_component_styling_warning` with `styling_issue_type: "excessive_top_padding"` or `"excessive_bottom_padding"` when a box-style component has more than three pin spacings of empty space above or below its left/right pins. |
+| [`checkSchematicComponentPortsOutsideBody`](./lib/check-schematic-component-ports-outside-body.ts) | Returns a `schematic_component_styling_warning` with `styling_issue_type: "ports_outside_body"` when pins fall beyond the body edge they enter, with an actionable minimum `schHeight` or `schWidth`. |
 | [`checkDifferentNetViaSpacing`](./lib/check-different-net-via-spacing.ts) | Returns `pcb_via_clearance_error` if vias on different nets are too close together. |
 | [`checkEachPcbPortConnectedToPcbTraces`](./lib/check-each-pcb-port-connected-to-pcb-trace.ts) | Returns `pcb_trace_error` if any `source_port` is not connected to its corresponding PCB traces. |
 | [`checkEachPcbTraceNonOverlapping`](./lib/check-each-pcb-trace-non-overlapping/check-each-pcb-trace-non-overlapping.ts) | Returns `pcb_trace_error` when `pcb_trace` segments physically overlap incompatible geometry on the same layer. Pad/via near-misses are reported by the typed clearance checks instead. |

package/dist/index.d.ts

@@ -168,6 +168,13 @@ declare function checkNoGroundPinDefined(circuitJson: AnyCircuitElement[]): Sour
  */
 declare function checkSchematicComponentExcessiveVerticalPadding(circuitJson: AnyCircuitElement[]): SchematicComponentStylingWarning[];
 
+/**
+ * Warns when a box-style component's pins are positioned beyond the body edge
+ * they enter. Left/right pins are checked against the body's vertical span,
+ * while top/bottom pins are checked against its horizontal span.
+ */
+declare function checkSchematicComponentPortsOutsideBody(circuitJson: AnyCircuitElement[]): SchematicComponentStylingWarning[];
+
 declare function runAllPlacementChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbPadPadClearanceError | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
 declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<{
     type: "source_pin_must_be_connected_error";
@@ -200,4 +207,4 @@ declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElem
  */
 declare function checkTestPointAccessibility(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
 
-export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSchematicComponentPortsOutsideBody, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };

package/dist/index.js

@@ -3960,6 +3960,106 @@ function checkSchematicComponentExcessiveVerticalPadding(circuitJson) {
   return warnings;
 }
 
+// lib/check-schematic-component-ports-outside-body.ts
+var FLOATING_POINT_TOLERANCE2 = 1e-9;
+var getPortLabel = (port) => port.display_pin_label ?? `pin ${port.pin_number}`;
+function checkSchematicComponentPortsOutsideBody(circuitJson) {
+  const schematicComponents = circuitJson.filter(
+    (element) => element.type === "schematic_component"
+  );
+  const schematicPorts = circuitJson.filter(
+    (element) => element.type === "schematic_port"
+  );
+  const sourceComponents = circuitJson.filter(
+    (element) => element.type === "source_component"
+  );
+  const sourceComponentById = new Map(
+    sourceComponents.map((component) => [
+      component.source_component_id,
+      component
+    ])
+  );
+  const portsByComponentId = /* @__PURE__ */ new Map();
+  for (const port of schematicPorts) {
+    if (!port.schematic_component_id) continue;
+    const componentPorts = portsByComponentId.get(port.schematic_component_id) ?? [];
+    componentPorts.push(port);
+    portsByComponentId.set(port.schematic_component_id, componentPorts);
+  }
+  const warnings = [];
+  for (const component of schematicComponents) {
+    if (component.is_box_with_pins === false || component.size.width <= 0 || component.size.height <= 0) {
+      continue;
+    }
+    const componentLeftX = component.center.x - component.size.width / 2;
+    const componentRightX = component.center.x + component.size.width / 2;
+    const componentBottomY = component.center.y - component.size.height / 2;
+    const componentTopY = component.center.y + component.size.height / 2;
+    const componentPorts = portsByComponentId.get(component.schematic_component_id) ?? [];
+    const portsOutsideBody = componentPorts.filter((port) => {
+      if (port.side_of_component === "left" || port.side_of_component === "right") {
+        return port.center.y < componentBottomY - FLOATING_POINT_TOLERANCE2 || port.center.y > componentTopY + FLOATING_POINT_TOLERANCE2;
+      }
+      if (port.side_of_component === "top" || port.side_of_component === "bottom") {
+        return port.center.x < componentLeftX - FLOATING_POINT_TOLERANCE2 || port.center.x > componentRightX + FLOATING_POINT_TOLERANCE2;
+      }
+      return false;
+    }).sort((portA, portB) => {
+      const portAIsVertical = portA.side_of_component === "left" || portA.side_of_component === "right";
+      const portBIsVertical = portB.side_of_component === "left" || portB.side_of_component === "right";
+      if (portAIsVertical && portBIsVertical) {
+        return portB.center.y - portA.center.y;
+      }
+      if (!portAIsVertical && !portBIsVertical) {
+        return portA.center.x - portB.center.x;
+      }
+      return portAIsVertical ? -1 : 1;
+    });
+    if (portsOutsideBody.length === 0) continue;
+    const requiredHeight = Math.max(
+      component.size.height,
+      ...portsOutsideBody.filter(
+        (port) => port.side_of_component === "left" || port.side_of_component === "right"
+      ).map((port) => 2 * Math.abs(port.center.y - component.center.y))
+    );
+    const requiredWidth = Math.max(
+      component.size.width,
+      ...portsOutsideBody.filter(
+        (port) => port.side_of_component === "top" || port.side_of_component === "bottom"
+      ).map((port) => 2 * Math.abs(port.center.x - component.center.x))
+    );
+    const suggestedDimensionChanges = [];
+    if (requiredHeight > component.size.height + FLOATING_POINT_TOLERANCE2) {
+      suggestedDimensionChanges.push(
+        `increase schHeight to at least ${requiredHeight.toFixed(2)}mm`
+      );
+    }
+    if (requiredWidth > component.size.width + FLOATING_POINT_TOLERANCE2) {
+      suggestedDimensionChanges.push(
+        `increase schWidth to at least ${requiredWidth.toFixed(2)}mm`
+      );
+    }
+    const sourceComponent = component.source_component_id ? sourceComponentById.get(component.source_component_id) : void 0;
+    const componentName = sourceComponent?.name ?? component.schematic_component_id;
+    const portLabels = portsOutsideBody.map(getPortLabel).join(", ");
+    warnings.push({
+      type: "schematic_component_styling_warning",
+      schematic_component_styling_warning_id: `schematic_component_styling_warning_${component.schematic_component_id}_ports_outside_body`,
+      warning_type: "schematic_component_styling_warning",
+      message: `${componentName} has schematic pins outside its body (${portLabels}); ${suggestedDimensionChanges.join(" and ")}`,
+      schematic_component_id: component.schematic_component_id,
+      styling_issue_type: "ports_outside_body",
+      schematic_port_ids: portsOutsideBody.map(
+        (port) => port.schematic_port_id
+      ),
+      source_component_id: component.source_component_id,
+      schematic_sheet_id: component.schematic_sheet_id,
+      subcircuit_id: component.subcircuit_id
+    });
+  }
+  return warnings;
+}
+
 // lib/check-connector-accessible-orientation.ts
 import { getBoardBounds } from "@tscircuit/circuit-json-util";
 function getFacingDirectionFromInsertionDirection(component) {
@@ -4247,7 +4347,10 @@ async function runAllNetlistChecks(circuitJson) {
   return [...checkPinMustBeConnected(circuitJson)];
 }
 async function runAllSchematicChecks(circuitJson) {
-  return checkSchematicComponentExcessiveVerticalPadding(circuitJson);
+  return [
+    ...checkSchematicComponentExcessiveVerticalPadding(circuitJson),
+    ...checkSchematicComponentPortsOutsideBody(circuitJson)
+  ];
 }
 async function runAllPinSpecificationChecks(circuitJson) {
   return [
@@ -4304,6 +4407,7 @@ export {
   checkPinMustBeConnected,
   checkSameNetViaSpacing,
   checkSchematicComponentExcessiveVerticalPadding,
+  checkSchematicComponentPortsOutsideBody,
   checkSourceTracesHavePcbTraces,
   checkSourceTracesMatchPcbTraceThickness,
   checkTestPointAccessibility,