@tscircuit/core 0.0.1386 → 0.0.1388

package/dist/index.d.ts

@@ -239,9 +239,9 @@ interface IIsolatedCircuit {
 interface IRootCircuit extends IIsolatedCircuit {
 }
 
-declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "RenderIsolatedSubcircuits", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "FetchPartFootprint", "ResolveFootprintPinLabels", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "CreateAutoplacedBreakoutPoints", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "SourceComponentPropertyValidation", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SymbolContainerRender", "SchematicPrimitiveRender", "SchematicSymbolResize", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicSectionRender", "SchematicTraceRender", "SchematicSheetRender", "SchematicReplaceNetLabelsWithSymbols", "PanelBoardLayout", "ValidatePcbCoordinates", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbCalcPlacementResolution", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbAutoplaceBreakoutPoints", "PcbTraceHintRender", "PcbManualTraceRender", "PcbTraceRender", "PcbRouteNetIslands", "PcbCopperPourRender", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "SupplierFootprintMismatchWarning", "SimulationSpiceEngineRender"];
+declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "RenderIsolatedSubcircuits", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "FetchPartFootprint", "ResolveFootprintPinLabels", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "CreateAutoplacedBreakoutPoints", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "CheckRefDesConvention", "SourceComponentPropertyValidation", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SymbolContainerRender", "SchematicPrimitiveRender", "SchematicSymbolResize", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicSectionRender", "SchematicTraceRender", "SchematicSheetRender", "SchematicReplaceNetLabelsWithSymbols", "PanelBoardLayout", "ValidatePcbCoordinates", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbCalcPlacementResolution", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbAutoplaceBreakoutPoints", "PcbTraceHintRender", "PcbManualTraceRender", "PcbTraceRender", "PcbRouteNetIslands", "PcbCopperPourRender", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "SupplierFootprintMismatchWarning", "SimulationSpiceEngineRender"];
 type RenderPhase = (typeof orderedRenderPhases)[number];
-declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "RenderIsolatedSubcircuits" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "FetchPartFootprint" | "ResolveFootprintPinLabels" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "CreateAutoplacedBreakoutPoints" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "SourceComponentPropertyValidation" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SymbolContainerRender" | "SchematicPrimitiveRender" | "SchematicSymbolResize" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicSectionRender" | "SchematicTraceRender" | "SchematicSheetRender" | "SchematicReplaceNetLabelsWithSymbols" | "PanelBoardLayout" | "ValidatePcbCoordinates" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbCalcPlacementResolution" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbAutoplaceBreakoutPoints" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbCopperPourRender" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "SupplierFootprintMismatchWarning" | "SimulationSpiceEngineRender", number>;
+declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "RenderIsolatedSubcircuits" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "FetchPartFootprint" | "ResolveFootprintPinLabels" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "CreateAutoplacedBreakoutPoints" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "CheckRefDesConvention" | "SourceComponentPropertyValidation" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SymbolContainerRender" | "SchematicPrimitiveRender" | "SchematicSymbolResize" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicSectionRender" | "SchematicTraceRender" | "SchematicSheetRender" | "SchematicReplaceNetLabelsWithSymbols" | "PanelBoardLayout" | "ValidatePcbCoordinates" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbCalcPlacementResolution" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbAutoplaceBreakoutPoints" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbCopperPourRender" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "SupplierFootprintMismatchWarning" | "SimulationSpiceEngineRender", number>;
 type RenderPhaseFn<K extends RenderPhase = RenderPhase> = `doInitial${K}` | `update${K}` | `remove${K}`;
 type RenderPhaseStates = Record<RenderPhase, {
     initialized: boolean;
@@ -2211,6 +2211,8 @@ declare class NormalComponent<ZodProps extends z.ZodType = any, PortNames extend
     get portMap(): PortMap<PortNames>;
     getInstanceForReactElement(element: ReactElement): NormalComponent | null;
     doInitialSourceRender(): void;
+    getRefDesPrefixes(): string[] | undefined;
+    doInitialCheckRefDesConvention(): void;
     /**
      * After ports have their source_port_id assigned, create
      * source_component_internal_connection records so that the connectivity
@@ -29514,6 +29516,7 @@ declare class Diode extends NormalComponent<typeof diodeProps, PolarizedPassiveP
     };
     initPorts(): void;
     doInitialSourceRender(): void;
+    getRefDesPrefixes(): string[];
     get pos(): Port;
     get anode(): Port;
     get neg(): Port;

package/dist/index.js

@@ -337,6 +337,7 @@ var orderedRenderPhases = [
   "SourceGroupRender",
   "AssignNameToUnnamedComponents",
   "SourceRender",
+  "CheckRefDesConvention",
   "SourceComponentPropertyValidation",
   "SourceParentAttachment",
   "PortMatching",
@@ -11952,6 +11953,63 @@ var Footprint = class extends PrimitiveComponent2 {
   }
 };
 
+// lib/components/base-components/NormalComponent/NormalComponent_doInitialCheckRefDesConvention.ts
+var defaultExpectedPrefixesByFtype = {
+  simple_ammeter: ["A"],
+  simple_battery: ["B", "BT"],
+  simple_capacitor: ["C"],
+  simple_chip: ["U", "IC"],
+  simple_connector: ["J", "P", "CONN"],
+  simple_crystal: ["Y", "X"],
+  simple_current_source: ["I", "IS"],
+  simple_diode: ["D"],
+  simple_fuse: ["F"],
+  simple_inductor: ["L", "FB"],
+  simple_interconnect: ["ICN"],
+  simple_led: ["D", "LED"],
+  simple_mosfet: ["Q"],
+  simple_op_amp: ["U", "IC"],
+  simple_pin_header: ["J", "P", "JP"],
+  simple_pinout: ["J", "P"],
+  simple_potentiometer: ["RV", "RP"],
+  simple_power_source: ["B", "BT", "V", "VS"],
+  simple_push_button: ["SW", "S"],
+  simple_resistor: ["R"],
+  simple_resonator: ["Y", "X"],
+  simple_switch: ["SW", "S"],
+  simple_test_point: ["TP"],
+  simple_transistor: ["Q"],
+  simple_voltage_probe: ["VP"],
+  simple_voltage_source: ["V", "VS"]
+};
+var getDefaultExpectedRefDesPrefixesForFtype = (ftype) => {
+  if (!ftype) return void 0;
+  return defaultExpectedPrefixesByFtype[ftype];
+};
+var getRefDesPrefix = (refDes) => refDes.match(/^[A-Za-z]+/)?.[0]?.toUpperCase();
+var NormalComponent_doInitialCheckRefDesConvention = (component) => {
+  const { db } = component.root;
+  if (!component.source_component_id) return;
+  const sourceComponent = db.source_component.get(component.source_component_id);
+  if (!sourceComponent?.name || !sourceComponent.ftype) return;
+  const expectedPrefixes = component.getRefDesPrefixes();
+  if (!expectedPrefixes || expectedPrefixes.length === 0) return;
+  const actualPrefix = getRefDesPrefix(sourceComponent.name);
+  if (actualPrefix && expectedPrefixes.includes(actualPrefix)) return;
+  const expectedPrefixMessage = expectedPrefixes.length === 1 ? expectedPrefixes[0] : `one of ${expectedPrefixes.join(", ")}`;
+  db.insert({
+    type: "source_refdes_convention_warning",
+    warning_type: "source_refdes_convention_warning",
+    message: `Component ${sourceComponent.name} has ftype="${sourceComponent.ftype}" but reference designator should start with ${expectedPrefixMessage}`,
+    source_component_id: sourceComponent.source_component_id,
+    refdes: sourceComponent.name,
+    source_component_ftype: sourceComponent.ftype,
+    expected_prefixes: expectedPrefixes,
+    actual_prefix: actualPrefix,
+    subcircuit_id: sourceComponent.subcircuit_id
+  });
+};
+
 // lib/components/base-components/NormalComponent/NormalComponent__getMinimumFlexContainerSize.ts
 import { getBoundsFromPoints as getBoundsFromPoints2 } from "@tscircuit/math-utils";
 var NormalComponent__getMinimumFlexContainerSize = (component) => {
@@ -13370,6 +13428,12 @@ var NormalComponent3 = class extends PrimitiveComponent2 {
     });
     this.source_component_id = source_component.source_component_id;
   }
+  getRefDesPrefixes() {
+    return getDefaultExpectedRefDesPrefixesForFtype(this.config.sourceFtype);
+  }
+  doInitialCheckRefDesConvention() {
+    NormalComponent_doInitialCheckRefDesConvention(this);
+  }
   /**
    * After ports have their source_port_id assigned, create
    * source_component_internal_connection records so that the connectivity
@@ -15103,6 +15167,9 @@ var Diode = class extends NormalComponent3 {
     });
     this.source_component_id = source_component.source_component_id;
   }
+  getRefDesPrefixes() {
+    return ["D"];
+  }
   get pos() {
     return this.portMap.pos;
   }
@@ -25075,7 +25142,7 @@ import { identity as identity5 } from "transformation-matrix";
 var package_default = {
   name: "@tscircuit/core",
   type: "module",
-  version: "0.0.1385",
+  version: "0.0.1387",
   types: "dist/index.d.ts",
   main: "dist/index.js",
   module: "dist/index.js",
@@ -25109,7 +25176,7 @@ var package_default = {
     "@tscircuit/alphabet": "0.0.25",
     "@tscircuit/breakout-point-solver": "github:tscircuit/breakout-point-solver#bac9629",
     "@tscircuit/capacity-autorouter": "^0.0.625",
-    "@tscircuit/checks": "0.0.140",
+    "@tscircuit/checks": "0.0.141",
     "@tscircuit/circuit-json-util": "^0.0.97",
     "@tscircuit/common": "^0.0.20",
     "@tscircuit/copper-pour-solver": "0.0.35",
@@ -25138,7 +25205,7 @@ var package_default = {
     "bun-match-svg": "0.0.12",
     "calculate-elbow": "^0.0.12",
     "chokidar-cli": "^3.0.0",
-    "circuit-json": "^0.0.445",
+    "circuit-json": "^0.0.446",
     "circuit-json-to-bpc": "^0.0.13",
     "circuit-json-to-connectivity-map": "^0.0.23",
     "circuit-json-to-gltf": "^0.0.105",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.1386",
+  "version": "0.0.1388",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -35,7 +35,7 @@
     "@tscircuit/alphabet": "0.0.25",
     "@tscircuit/breakout-point-solver": "github:tscircuit/breakout-point-solver#bac9629",
     "@tscircuit/capacity-autorouter": "^0.0.625",
-    "@tscircuit/checks": "0.0.140",
+    "@tscircuit/checks": "0.0.141",
     "@tscircuit/circuit-json-util": "^0.0.97",
     "@tscircuit/common": "^0.0.20",
     "@tscircuit/copper-pour-solver": "0.0.35",
@@ -64,7 +64,7 @@
     "bun-match-svg": "0.0.12",
     "calculate-elbow": "^0.0.12",
     "chokidar-cli": "^3.0.0",
-    "circuit-json": "^0.0.445",
+    "circuit-json": "^0.0.446",
     "circuit-json-to-bpc": "^0.0.13",
     "circuit-json-to-connectivity-map": "^0.0.23",
     "circuit-json-to-gltf": "^0.0.105",