@tscircuit/checks 0.0.200 → 0.0.202

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as circuit_json from 'circuit-json';
-import { AnyCircuitElement, PcbPlacementError, PcbPortNotConnectedError, PcbTraceError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbPadPadClearanceError, PcbCourtyardOverlapError, PcbComponentMissingCourtyardWarning, PcbTraceTooLongError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentMisconfiguredError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning, SourceConfusingNetNameWarning, PcbBusLengthSkewError } from 'circuit-json';
+import { AnyCircuitElement, PcbPlacementError, PcbPortNotConnectedError, PcbTraceError, PcbKeepoutOverlapWarning, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbPadPadClearanceError, PcbCourtyardOverlapError, PcbComponentMissingCourtyardWarning, PcbTraceTooLongError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentMisconfiguredError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning, SourceConfusingNetNameWarning, PcbBusLengthSkewError } from 'circuit-json';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 /** Detect accidental copper contact, rather than enforcing a clearance margin. */
@@ -10,7 +10,7 @@ declare function checkEachPcbPortConnectedToPcbTraces(circuitJson: AnyCircuitEle
 declare function checkEachPcbTraceNonOverlapping(circuitJson: AnyCircuitElement[], { connMap, minClearance, }?: {
     connMap?: ConnectivityMap;
     minClearance?: number;
-}): PcbTraceError[];
+}): (PcbTraceError | PcbKeepoutOverlapWarning)[];
 
 declare class NetManager {
     private networks;
@@ -44,7 +44,7 @@ declare function checkPcbComponentsOutOfBoard(circuitJson: AnyCircuitElement[]):
  */
 declare function checkPcbComponentOverCutout(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
 
-declare function checkPcbCopperOverKeepout(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
+declare function checkPcbCopperOverKeepout(circuitJson: AnyCircuitElement[]): (PcbPlacementError | PcbKeepoutOverlapWarning)[];
 
 declare function checkSameNetViaSpacing(circuitJson: AnyCircuitElement[], { connMap, minClearance, }?: {
     connMap?: ConnectivityMap;
@@ -204,7 +204,7 @@ declare function checkSchematicComponentPortsOutsideBody(circuitJson: AnyCircuit
 
 declare function runAllPlacementChecks(circuitJson: AnyCircuitElement[], { consolidateOverlaps }?: {
     consolidateOverlaps?: boolean | undefined;
-}): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | PcbComponentOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbCourtyardOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning)[]>;
+}): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbKeepoutOverlapWarning | circuit_json.PcbComponentOutsideBoardError | PcbComponentOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbCourtyardOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning)[]>;
 declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<({
     type: "source_pin_must_be_connected_error";
     source_pin_must_be_connected_error_id: string;
@@ -216,8 +216,8 @@ declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<
 } | circuit_json.SourceComponentMisconfiguredError | circuit_json.SourceConfusingNetNameWarning)[]>;
 declare function runAllSchematicChecks(circuitJson: AnyCircuitElement[]): Promise<circuit_json.SchematicComponentStylingWarning[]>;
 declare function runAllPinSpecificationChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning)[]>;
-declare function runAllRoutingChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbTraceTooLongError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | circuit_json.PcbBusLengthSkewError)[]>;
-declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | PcbComponentOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbCourtyardOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbTraceTooLongError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
+declare function runAllRoutingChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbKeepoutOverlapWarning | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbTraceTooLongError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | circuit_json.PcbBusLengthSkewError)[]>;
+declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbKeepoutOverlapWarning | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | PcbComponentOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbCourtyardOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbTraceTooLongError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
     type: "source_pin_must_be_connected_error";
     source_pin_must_be_connected_error_id: string;
     error_type: "source_pin_must_be_connected_error";

package/dist/index.js

@@ -2431,6 +2431,22 @@ function checkEachPcbTraceNonOverlapping(circuitJson, {
         const pcb_trace_error_id = `overlap_${segmentA.pcb_trace_id}_${primaryObjId}`;
         if (errorIds.has(pcb_trace_error_id)) continue;
         errorIds.add(pcb_trace_error_id);
+        if (obj.type === "pcb_keepout" && obj.warning_only) {
+          errors.push({
+            type: "pcb_keepout_overlap_warning",
+            warning_type: "pcb_keepout_overlap_warning",
+            pcb_keepout_overlap_warning_id: `pcb_keepout_overlap_warning_${pcb_trace_error_id}`,
+            pcb_keepout_id: obj.pcb_keepout_id,
+            pcb_trace_ids: [segmentA.pcb_trace_id],
+            message: `PCB trace ${getReadableName(segmentA.pcb_trace_id)} violates advisory PCB keepout "${obj.description ?? obj.pcb_keepout_id}"`,
+            center: getClosestPointBetweenSegmentAndBounds(
+              segmentA,
+              getCollidableBounds(obj)
+            ),
+            subcircuit_id: segmentA._pcbTrace.subcircuit_id ?? obj.subcircuit_id
+          });
+          continue;
+        }
         errors.push({
           type: "pcb_trace_error",
           error_type: "pcb_trace_error",
@@ -3001,6 +3017,30 @@ function checkPcbCopperOverKeepout(circuitJson) {
       if (getPadToPadGap(copperElement, keepout) > EPSILON) continue;
       const ownerId = getErrorOwnerId(copperElement);
       const errorId = `copper_over_keepout_${ownerId}_${keepout.pcb_keepout_id}`;
+      if (keepout.warning_only) {
+        const copperIdField = copperElement.type === "pcb_smtpad" ? "pcb_smtpad_ids" : copperElement.type === "pcb_plated_hole" ? "pcb_plated_hole_ids" : "pcb_via_ids";
+        const existing = errors.get(errorId);
+        if (existing?.type === "pcb_keepout_overlap_warning") {
+          existing[copperIdField] = Array.from(
+            /* @__PURE__ */ new Set([
+              ...existing[copperIdField] ?? [],
+              getPrimaryId3(copperElement)
+            ])
+          );
+        } else {
+          errors.set(errorId, {
+            type: "pcb_keepout_overlap_warning",
+            warning_type: "pcb_keepout_overlap_warning",
+            pcb_keepout_overlap_warning_id: `pcb_keepout_overlap_warning_${errorId}`,
+            pcb_keepout_id: keepout.pcb_keepout_id,
+            message: `Copper for ${getReadableCopperName(circuitJson, copperElement)} overlaps advisory PCB keepout "${keepout.description ?? keepout.pcb_keepout_id}"`,
+            ...copperComponentId ? { pcb_component_ids: [copperComponentId] } : {},
+            [copperIdField]: [getPrimaryId3(copperElement)],
+            subcircuit_id: copperElement.subcircuit_id ?? keepout.subcircuit_id
+          });
+        }
+        continue;
+      }
       if (errors.has(errorId)) continue;
       errors.set(errorId, {
         type: "pcb_placement_error",
@@ -3983,6 +4023,11 @@ var formatOverlapElementDescription = (circuitJson, element) => {
 };
 function checkPcbComponentOverlap(circuitJson) {
   const errors = [];
+  const doNotPlaceComponentIds = new Set(
+    circuitJson.flatMap(
+      (element) => element.type === "pcb_component" && element.do_not_place ? [element.pcb_component_id] : []
+    )
+  );
   const connMap = getFullConnectivityMapFromCircuitJson9(circuitJson);
   const smtPads = cju6(circuitJson).pcb_smtpad.list();
   const platedHoles = cju6(circuitJson).pcb_plated_hole.list();
@@ -4038,6 +4083,7 @@ function checkPcbComponentOverlap(circuitJson) {
     for (let j = i + 1; j < componentsWithElements.length; j++) {
       const comp1 = componentsWithElements[i];
       const comp2 = componentsWithElements[j];
+      const pairIncludesDoNotPlaceComponent = doNotPlaceComponentIds.has(comp1.component_id) || doNotPlaceComponentIds.has(comp2.component_id);
       if (!comp1.bounds || !comp2.bounds) {
         continue;
       }
@@ -4048,6 +4094,9 @@ function checkPcbComponentOverlap(circuitJson) {
         for (const elem2 of comp2.elements) {
           const id1 = getPrimaryId5(elem1);
           const id2 = getPrimaryId5(elem2);
+          if (pairIncludesDoNotPlaceComponent && (isCourtyardElement2(elem1) || isCourtyardElement2(elem2))) {
+            continue;
+          }
           if ((isCourtyardElement2(elem1) || isCourtyardElement2(elem2)) && !isHoleElement(elem1) && !isHoleElement(elem2)) {
             continue;
           }