@tscircuit/checks 0.0.198 → 0.0.200

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, PcbTraceTooLongWarning, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentMisconfiguredError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning, SourceConfusingNetNameWarning } 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 { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 /** Detect accidental copper contact, rather than enforcing a clearance margin. */
@@ -105,7 +105,7 @@ declare function checkPcbComponentOverlap(circuitJson: AnyCircuitElement[]): Pcb
 /** Returns warnings for PCB components without courtyards, excluding manually placed vias. */
 declare function checkPcbComponentsMissingCourtyard(circuitJson: AnyCircuitElement[]): PcbComponentMissingCourtyardWarning[];
 
-declare const checkPcbTraceLengths: (circuitJson: AnyCircuitElement[]) => PcbTraceTooLongWarning[];
+declare const checkPcbTraceLengths: (circuitJson: AnyCircuitElement[]) => PcbTraceTooLongError[];
 
 /** Return a routing error when a source trace exceeds its maximum via count. */
 declare const checkPcbTraceViaCounts: (circuitJson: AnyCircuitElement[]) => PcbTraceError[];
@@ -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.PcbTraceTooLongWarning | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError)[]>;
-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.PcbTraceTooLongWarning | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
+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 | {
     type: "source_pin_must_be_connected_error";
     source_pin_must_be_connected_error_id: string;
     error_type: "source_pin_must_be_connected_error";
@@ -225,7 +225,7 @@ declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circui
     source_component_id: string;
     source_port_id: string;
     subcircuit_id?: string;
-} | circuit_json.SourceComponentMisconfiguredError | circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning | circuit_json.SchematicComponentStylingWarning | circuit_json.SourceConfusingNetNameWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning)[]>;
+} | circuit_json.SourceComponentMisconfiguredError | circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning | circuit_json.SchematicComponentStylingWarning | circuit_json.PcbBusLengthSkewError | circuit_json.SourceConfusingNetNameWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning)[]>;
 
 declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElement[]): PcbConnectorNotInAccessibleOrientationWarning[];
 
@@ -239,4 +239,9 @@ declare function checkTestPointAccessibility(circuitJson: AnyCircuitElement[]):
 /** Warn once per name when its source nets belong to multiple electrical islands. */
 declare function checkSameNameNetsAreConnected(circuitJson: AnyCircuitElement[]): SourceConfusingNetNameWarning[];
 
-export { NetManager, type PcbComponentOverlapError, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperPourShorts, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNameNetsAreConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSchematicComponentMissingReferenceDesignatorText, checkSchematicComponentPortsOutsideBody, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkTwoTerminalSwitchContactsOnDifferentNets, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, consolidatePcbOverlapErrors, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };
+/** Compare total routed lengths of resolved bus members. Unrouted members are
+ * left to connectivity checks, never treated as zero-length routes.
+ */
+declare const checkPcbBusLengthSkew: (circuitJson: AnyCircuitElement[]) => PcbBusLengthSkewError[];
+
+export { NetManager, type PcbComponentOverlapError, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperPourShorts, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbBusLengthSkew, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNameNetsAreConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSchematicComponentMissingReferenceDesignatorText, checkSchematicComponentPortsOutsideBody, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkTwoTerminalSwitchContactsOnDifferentNets, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, consolidatePcbOverlapErrors, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };

package/dist/index.js

@@ -1239,7 +1239,7 @@ function getCopperPourConnectivity(circuitJson, connectivity) {
           polygon: getSmtPadPolygon(copper),
           layers: [copper.layer],
           netId,
-          portId: copper.pcb_port_id
+          portIds: copper.pcb_port_id ? [copper.pcb_port_id] : []
         });
       } else if (copper.type === "pcb_plated_hole") {
         add({
@@ -1249,7 +1249,7 @@ function getCopperPourConnectivity(circuitJson, connectivity) {
           ),
           layers: copper.layers,
           netId,
-          portId: copper.pcb_port_id
+          portIds: copper.pcb_port_id ? [copper.pcb_port_id] : []
         });
       } else {
         add({
@@ -1259,7 +1259,8 @@ function getCopperPourConnectivity(circuitJson, connectivity) {
             copper.hole_diameter
           ),
           layers: copper.layers,
-          netId
+          netId,
+          portIds: copper.pcb_port_ids
         });
       }
     }
@@ -1300,10 +1301,12 @@ function getCopperPourConnectivity(circuitJson, connectivity) {
   );
   const rootsByPort = /* @__PURE__ */ new Map();
   for (const [i, conductor] of conductors.entries()) {
-    if (!conductor.portId || !pourRoots.has(find(i))) continue;
-    const roots = rootsByPort.get(conductor.portId) ?? /* @__PURE__ */ new Set();
-    roots.add(find(i));
-    rootsByPort.set(conductor.portId, roots);
+    if (!pourRoots.has(find(i))) continue;
+    for (const portId of conductor.portIds ?? []) {
+      const roots = rootsByPort.get(portId) ?? /* @__PURE__ */ new Set();
+      roots.add(find(i));
+      rootsByPort.set(portId, roots);
+    }
   }
   const portsByNet = /* @__PURE__ */ new Map();
   for (const port of circuitJson) {
@@ -4134,30 +4137,30 @@ function checkPcbComponentsMissingCourtyard(circuitJson) {
   });
 }
 
-// lib/check-pcb-trace-lengths.ts
-var DEFAULT_VIA_LENGTH_MM = 1.6;
-var getRoutePointPosition = (routePoint) => routePoint.route_type === "through_pad" ? routePoint.start : { x: routePoint.x, y: routePoint.y };
-var getPcbTraceLength = (pcbTrace) => {
-  if (pcbTrace.trace_length !== void 0) return pcbTrace.trace_length;
-  let traceLength = 0;
-  for (let routePointIndex = 0; routePointIndex < pcbTrace.route.length; routePointIndex++) {
-    const routePoint = pcbTrace.route[routePointIndex];
-    if (!routePoint) continue;
-    if (routePoint.route_type === "via") {
-      traceLength += DEFAULT_VIA_LENGTH_MM;
-      continue;
+// lib/util/get-pcb-trace-length.ts
+var getPcbTraceLength = (trace) => {
+  if (trace.trace_length !== void 0) return trace.trace_length;
+  let length = 0;
+  let previousEnd;
+  for (const point2 of trace.route) {
+    const start = point2.route_type === "through_pad" ? point2.start : point2;
+    if (previousEnd)
+      length += Math.hypot(start.x - previousEnd.x, start.y - previousEnd.y);
+    if (point2.route_type === "via") length += 1.6;
+    if (point2.route_type === "through_pad") {
+      length += Math.hypot(
+        point2.end.x - point2.start.x,
+        point2.end.y - point2.start.y
+      );
+      previousEnd = point2.end;
+    } else {
+      previousEnd = point2;
     }
-    const nextRoutePoint = pcbTrace.route[routePointIndex + 1];
-    if (!nextRoutePoint) continue;
-    const routePointPosition = getRoutePointPosition(routePoint);
-    const nextRoutePointPosition = getRoutePointPosition(nextRoutePoint);
-    traceLength += Math.hypot(
-      nextRoutePointPosition.x - routePointPosition.x,
-      nextRoutePointPosition.y - routePointPosition.y
-    );
   }
-  return traceLength;
+  return length;
 };
+
+// lib/check-pcb-trace-lengths.ts
 var getReferencedPcbPortIds = (pcbTrace) => {
   const pcbPortIds = /* @__PURE__ */ new Set();
   for (const routePoint of pcbTrace.route) {
@@ -4171,7 +4174,7 @@ var getReferencedPcbPortIds = (pcbTrace) => {
   }
   return pcbPortIds;
 };
-var checkPcbTraceLengths = (circuitJson) => {
+var getPcbTracesBySourceTraceId = (circuitJson) => {
   const sourceTraces = circuitJson.filter(
     (element) => element.type === "source_trace"
   );
@@ -4181,12 +4184,6 @@ var checkPcbTraceLengths = (circuitJson) => {
   const pcbPorts = circuitJson.filter(
     (element) => element.type === "pcb_port"
   );
-  const sourceTracesById = new Map(
-    sourceTraces.map((sourceTrace) => [
-      sourceTrace.source_trace_id,
-      sourceTrace
-    ])
-  );
   const pcbPortIdsBySourcePortId = /* @__PURE__ */ new Map();
   for (const pcbPort of pcbPorts) {
     if (!pcbPort.source_port_id) continue;
@@ -4225,23 +4222,35 @@ var checkPcbTraceLengths = (circuitJson) => {
       );
     }
   }
-  const warnings = [];
-  for (const pcbTrace of pcbTraces) {
-    if (!pcbTrace.source_trace_id) continue;
-    const sourceTrace = sourceTracesById.get(pcbTrace.source_trace_id);
+  for (const [id, exactIds] of exactEndpointPcbTraceIdsBySourceTraceId) {
+    pcbTracesBySourceTraceId.set(
+      id,
+      pcbTracesBySourceTraceId.get(id).filter((trace) => exactIds.has(trace.pcb_trace_id))
+    );
+  }
+  return pcbTracesBySourceTraceId;
+};
+var checkPcbTraceLengths = (circuitJson) => {
+  const sourceTracesById = new Map(
+    circuitJson.filter((e) => e.type === "source_trace").map((e) => [e.source_trace_id, e])
+  );
+  const pcbTracesBySourceTraceId = getPcbTracesBySourceTraceId(circuitJson);
+  const errors = [];
+  for (const [sourceTraceId, pcbTraces] of pcbTracesBySourceTraceId) {
+    const pcbTrace = pcbTraces[0];
+    const sourceTrace = sourceTracesById.get(sourceTraceId);
     if (!sourceTrace) continue;
     const maximumTraceLength = sourceTrace.max_length;
     if (typeof maximumTraceLength !== "number") continue;
-    const exactEndpointPcbTraceIds = exactEndpointPcbTraceIdsBySourceTraceId.get(sourceTrace.source_trace_id);
-    if (exactEndpointPcbTraceIds && !exactEndpointPcbTraceIds.has(pcbTrace.pcb_trace_id)) {
-      continue;
-    }
-    const actualTraceLength = getPcbTraceLength(pcbTrace);
-    if (actualTraceLength <= maximumTraceLength) continue;
-    warnings.push({
-      type: "pcb_trace_too_long_warning",
-      pcb_trace_too_long_warning_id: `pcb_trace_too_long_warning_${pcbTrace.pcb_trace_id}`,
-      warning_type: "pcb_trace_too_long_warning",
+    const actualTraceLength = pcbTraces.reduce(
+      (sum, trace) => sum + getPcbTraceLength(trace),
+      0
+    );
+    if (actualTraceLength <= maximumTraceLength + 1e-9) continue;
+    errors.push({
+      type: "pcb_trace_too_long_error",
+      pcb_trace_too_long_error_id: `pcb_trace_too_long_error_${pcbTrace.pcb_trace_id}`,
+      error_type: "pcb_trace_too_long_error",
       message: `PCB trace is ${actualTraceLength.toFixed(2)}mm long, exceeding the ${maximumTraceLength}mm maximum`,
       pcb_trace_id: pcbTrace.pcb_trace_id,
       source_trace_id: sourceTrace.source_trace_id,
@@ -4251,7 +4260,7 @@ var checkPcbTraceLengths = (circuitJson) => {
       subcircuit_id: pcbTrace.subcircuit_id ?? sourceTrace.subcircuit_id
     });
   }
-  return warnings;
+  return errors;
 };
 
 // lib/check-pcb-trace-via-counts.ts
@@ -5116,6 +5125,47 @@ function checkSchematicComponentPortsOutsideBody(circuitJson) {
   return warnings;
 }
 
+// lib/check-pcb-bus-length-skew.ts
+var checkPcbBusLengthSkew = (circuitJson) => {
+  const buses = circuitJson.filter(
+    (e) => e.type === "source_bus"
+  );
+  const tracesBySource = getPcbTracesBySourceTraceId(circuitJson);
+  const errors = [];
+  for (const bus of buses) {
+    if (bus.max_length_skew === void 0) continue;
+    const members = [...new Set(bus.source_trace_ids)].flatMap((id) => {
+      const traces = tracesBySource.get(id)?.filter((t) => t.trace_length !== void 0 || t.route.length > 1);
+      if (!traces?.length) return [];
+      return [
+        {
+          id,
+          traces,
+          length: traces.reduce((sum, t) => sum + getPcbTraceLength(t), 0)
+        }
+      ];
+    });
+    if (members.length < 2) continue;
+    const skew = Math.max(...members.map((m) => m.length)) - Math.min(...members.map((m) => m.length));
+    if (skew <= bus.max_length_skew + 1e-9) continue;
+    errors.push({
+      type: "pcb_bus_length_skew_error",
+      pcb_bus_length_skew_error_id: `pcb_bus_length_skew_error_${bus.source_bus_id}`,
+      error_type: "pcb_bus_length_skew_error",
+      message: `PCB bus ${bus.name ?? bus.source_bus_id} has ${skew.toFixed(2)}mm length skew, exceeding the ${bus.max_length_skew}mm maximum`,
+      source_bus_id: bus.source_bus_id,
+      source_trace_ids: members.map((m) => m.id),
+      pcb_trace_ids: members.flatMap(
+        (m) => m.traces.map((t) => t.pcb_trace_id)
+      ),
+      actual_length_skew: skew,
+      maximum_length_skew: bus.max_length_skew,
+      subcircuit_id: bus.subcircuit_id
+    });
+  }
+  return errors;
+};
+
 // lib/consolidate-pcb-overlap-errors.ts
 import { getPrimaryId as getPrimaryId10 } from "@tscircuit/circuit-json-util";
 function consolidatePcbOverlapErrors(circuitJson, errors) {
@@ -5604,6 +5654,7 @@ async function runAllRoutingChecks(circuitJson) {
     ...checkEachPcbPortConnectedToPcbTraces(circuitJson),
     ...checkSourceTracesHavePcbTraces(circuitJson),
     ...checkPcbTraceLengths(circuitJson),
+    ...checkPcbBusLengthSkew(circuitJson),
     ...checkPcbTraceViaCounts(circuitJson),
     ...checkEachPcbTraceNonOverlapping(circuitJson),
     ...checkCopperPourShorts(circuitJson),
@@ -5638,6 +5689,7 @@ export {
   checkNoPowerPinDefined,
   checkPadPadClearance,
   checkPadTraceClearance,
+  checkPcbBusLengthSkew,
   checkPcbComponentOverCutout,
   checkPcbComponentOverlap,
   checkPcbComponentsMissingCourtyard,