@tscircuit/checks 0.0.146 → 0.0.148

package/README.md

@@ -10,6 +10,7 @@ and output an array of arrays for any issues found.
 | Function | Description |
 | --- | --- |
 | [`checkConnectorAccessibleOrientation`](./lib/check-connector-accessible-orientation.ts) | Returns `pcb_accessibility_error` for connectors whose orientation makes them inaccessible. |
+| [`checkTestPointAccessibility`](./lib/check-testpoint-accessibility.ts) | Returns `pcb_placement_error` when a test point is inside another component's courtyard on the same PCB side. |
 | [`checkAllPinsInComponentAreUnderspecified`](./lib/check-all-pins-in-component-are-underspecified.ts) | Returns `source_component_pins_underspecified_warning` when every pin on a chip lacks pin attributes. |
 | [`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`. |
@@ -31,7 +32,7 @@ and output an array of arrays for any issues found.
 
 | Function | Description |
 | --- | --- |
-| [`runAllPlacementChecks`](./lib/run-all-checks.ts) | Runs placement checks (`checkViasOffBoard`, `checkPcbComponentsOutOfBoard`, `checkPcbComponentOverlap`, `checkPadPadClearance`, and `checkConnectorAccessibleOrientation`). |
+| [`runAllPlacementChecks`](./lib/run-all-checks.ts) | Runs placement checks (`checkViasOffBoard`, `checkPcbComponentsOutOfBoard`, `checkPcbComponentOverlap`, `checkPadPadClearance`, `checkCourtyardOverlap`, `checkConnectorAccessibleOrientation`, and `checkTestPointAccessibility`). |
 | [`runAllNetlistChecks`](./lib/run-all-checks.ts) | Runs netlist connectivity checks (currently `checkPinMustBeConnected`). |
 | [`runAllPinSpecificationChecks`](./lib/run-all-checks.ts) | Runs pin specification checks (e.g. `checkAllPinsInComponentAreUnderspecified`, `checkNoPowerPinDefined`, and `checkNoGroundPinDefined`). |
 | [`runAllRoutingChecks`](./lib/run-all-checks.ts) | Runs all routing checks currently enabled (`checkEachPcbPortConnectedToPcbTraces`, `checkSourceTracesHavePcbTraces`, `checkEachPcbTraceNonOverlapping`, `checkPadTraceClearance`, `checkViaTraceClearance`, same/different net via spacing, and `checkPcbTracesOutOfBoard`). Trace-obstacle pairs are classified before aggregation, so each pair produces one overlap or clearance diagnostic, never both. |

package/dist/index.d.ts

@@ -152,4 +152,11 @@ declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circui
 
 declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElement[]): PcbConnectorNotInAccessibleOrientationWarning[];
 
-export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTracesAreContiguous, checkViaTraceClearance, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };
+/**
+ * Test points are intended to be contacted from their PCB side. A test point
+ * whose access center is covered by another component's courtyard cannot be
+ * reliably reached by a probe after assembly.
+ */
+declare function checkTestPointAccessibility(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
+
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaTraceClearance, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };

package/dist/index.js

@@ -1232,6 +1232,11 @@ var getRadiusOfCircuitJsonElement = (obj) => {
 };
 
 // lib/check-each-pcb-trace-non-overlapping/check-each-pcb-trace-non-overlapping.ts
+var getPcbComponentConnectionElementId = (element) => {
+  if (element.type === "pcb_port") return element.pcb_port_id;
+  if (element.type === "pcb_smtpad") return element.pcb_smtpad_id;
+  return element.pcb_plated_hole_id;
+};
 function checkEachPcbTraceNonOverlapping(circuitJson, {
   connMap,
   minClearance
@@ -1266,9 +1271,28 @@ function checkEachPcbTraceNonOverlapping(circuitJson, {
   });
   const pcbSmtPads = cju2(circuitJson).pcb_smtpad.list();
   const pcbPlatedHoles = cju2(circuitJson).pcb_plated_hole.list();
+  const pcbPorts = cju2(circuitJson).pcb_port.list();
   const pcbHoles = cju2(circuitJson).pcb_hole.list();
   const pcbVias = cju2(circuitJson).pcb_via.list();
   const pcbKeepouts = cju2(circuitJson).pcb_keepout.list();
+  const pcbComponentConnectionElements = [
+    ...pcbPorts,
+    ...pcbSmtPads,
+    ...pcbPlatedHoles
+  ];
+  const excludedConnectionIdsByKeepoutId = /* @__PURE__ */ new Map();
+  for (const keepout of pcbKeepouts) {
+    const excludedPcbComponentIds = new Set(
+      keepout.excluded_pcb_component_ids ?? []
+    );
+    if (excludedPcbComponentIds.size === 0) continue;
+    excludedConnectionIdsByKeepoutId.set(
+      keepout.pcb_keepout_id,
+      pcbComponentConnectionElements.filter(
+        (element) => element.pcb_component_id && excludedPcbComponentIds.has(element.pcb_component_id)
+      ).map(getPcbComponentConnectionElementId)
+    );
+  }
   const allObjects = [
     ...pcbTraceSegments,
     ...pcbSmtPads,
@@ -1301,6 +1325,11 @@ function checkEachPcbTraceNonOverlapping(circuitJson, {
       if (!getLayersOfPcbElement(obj).includes(segmentA.layer)) {
         continue;
       }
+      if (obj.type === "pcb_keepout" && (excludedConnectionIdsByKeepoutId.get(obj.pcb_keepout_id) ?? []).some(
+        (connectionId) => connMap.areIdsConnected(segmentA.pcb_trace_id, connectionId)
+      )) {
+        continue;
+      }
       if (obj.type === "pcb_trace_segment") {
         const segmentB = obj;
         if (segmentA.layer !== segmentB.layer) continue;
@@ -3150,6 +3179,79 @@ function checkCourtyardOverlap(circuitJson) {
   return errors;
 }
 
+// lib/check-testpoint-accessibility.ts
+import { isPointInsidePolygon as isPointInsidePolygon3 } from "@tscircuit/math-utils";
+var isCourtyardElement2 = (element) => element.type === "pcb_courtyard_circle" || element.type === "pcb_courtyard_outline" || element.type === "pcb_courtyard_polygon" || element.type === "pcb_courtyard_rect";
+var isPointInsideCourtyard = (point, courtyard) => {
+  if (courtyard.type === "pcb_courtyard_circle") {
+    const dx = point.x - courtyard.center.x;
+    const dy = point.y - courtyard.center.y;
+    return dx * dx + dy * dy <= courtyard.radius * courtyard.radius;
+  }
+  if (courtyard.type === "pcb_courtyard_rect") {
+    const angle = -1 * (courtyard.ccw_rotation ?? 0) * Math.PI / 180;
+    const dx = point.x - courtyard.center.x;
+    const dy = point.y - courtyard.center.y;
+    const localX = dx * Math.cos(angle) - dy * Math.sin(angle);
+    const localY = dx * Math.sin(angle) + dy * Math.cos(angle);
+    return Math.abs(localX) <= courtyard.width / 2 && Math.abs(localY) <= courtyard.height / 2;
+  }
+  const polygon = courtyard.type === "pcb_courtyard_polygon" ? courtyard.points : courtyard.outline;
+  return isPointInsidePolygon3(point, polygon);
+};
+var getPcbComponentName = (circuitJson, pcbComponentId) => {
+  const pcbComponent = circuitJson.find(
+    (element) => element.type === "pcb_component" && element.pcb_component_id === pcbComponentId
+  );
+  const sourceComponent = circuitJson.find(
+    (element) => element.type === "source_component" && element.source_component_id === pcbComponent?.source_component_id
+  );
+  return (sourceComponent && "name" in sourceComponent ? sourceComponent.name : void 0) ?? getReadableNameForComponent(circuitJson, pcbComponentId);
+};
+function checkTestPointAccessibility(circuitJson) {
+  const sourceTestPoints = circuitJson.filter(
+    (element) => element.type === "source_component" && element.ftype === "simple_test_point"
+  );
+  const sourceTestPointIds = new Set(
+    sourceTestPoints.map((testPoint) => testPoint.source_component_id)
+  );
+  const testPointNames = new Map(
+    sourceTestPoints.map((testPoint) => [
+      testPoint.source_component_id,
+      testPoint.name
+    ])
+  );
+  const testPointComponents = circuitJson.filter(
+    (element) => element.type === "pcb_component" && sourceTestPointIds.has(element.source_component_id)
+  );
+  const courtyards = circuitJson.filter(isCourtyardElement2);
+  const errors = [];
+  const reportedComponentPairs = /* @__PURE__ */ new Set();
+  for (const testPoint of testPointComponents) {
+    for (const courtyard of courtyards) {
+      if (courtyard.pcb_component_id === testPoint.pcb_component_id) continue;
+      if (courtyard.layer !== testPoint.layer) continue;
+      if (!isPointInsideCourtyard(testPoint.center, courtyard)) continue;
+      const componentPair = `${testPoint.pcb_component_id}:${courtyard.pcb_component_id}`;
+      if (reportedComponentPairs.has(componentPair)) continue;
+      reportedComponentPairs.add(componentPair);
+      const testPointName = testPointNames.get(testPoint.source_component_id) ?? "Test point";
+      const obstructingComponentName = getPcbComponentName(
+        circuitJson,
+        courtyard.pcb_component_id
+      );
+      errors.push({
+        type: "pcb_placement_error",
+        pcb_placement_error_id: `testpoint_in_courtyard_${testPoint.pcb_component_id}_${courtyard.pcb_component_id}`,
+        error_type: "pcb_placement_error",
+        message: `Test point ${testPointName} is not accessible because it is inside the courtyard of ${obstructingComponentName}`,
+        subcircuit_id: testPoint.subcircuit_id
+      });
+    }
+  }
+  return errors;
+}
+
 // lib/run-all-checks.ts
 async function runAllPlacementChecks(circuitJson) {
   return [
@@ -3158,7 +3260,8 @@ async function runAllPlacementChecks(circuitJson) {
     ...checkPcbComponentOverlap(circuitJson),
     ...checkPadPadClearance(circuitJson),
     ...checkCourtyardOverlap(circuitJson),
-    ...checkConnectorAccessibleOrientation(circuitJson)
+    ...checkConnectorAccessibleOrientation(circuitJson),
+    ...checkTestPointAccessibility(circuitJson)
   ];
 }
 async function runAllNetlistChecks(circuitJson) {
@@ -3212,6 +3315,7 @@ export {
   checkSameNetViaSpacing,
   checkSourceTracesHavePcbTraces,
   checkSourceTracesMatchPcbTraceThickness,
+  checkTestPointAccessibility,
   checkTracesAreContiguous,
   checkViaTraceClearance,
   checkViasOffBoard,