circuit-json 0.0.521 → 0.0.523

package/README.md

@@ -113,6 +113,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
   - [CAD Components](#cad-components)
     - [CadCable](#cadcable)
     - [CadComponent](#cadcomponent)
+    - [CadReferenceSurface](#cadreferencesurface)
   - [PCB Elements](#pcb-elements)
     - [PcbFabricatorExtraChargeWarning](#pcbfabricatorextrachargewarning)
     - [PcbAutoroutingError](#pcbautoroutingerror)
@@ -219,6 +220,8 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
     - [SchematicTrace](#schematictrace)
     - [SchematicVoltageProbe](#schematicvoltageprobe)
   - [Simulation Elements](#simulation-elements)
+    - [SimulationReturnCurrentContact](#simulationreturncurrentcontact)
+    - [SimulationReturnCurrentGridJson](#simulationreturncurrentgridjson)
     - [SimulationAcSweepCurrentGraph](#simulationacsweepcurrentgraph)
     - [SimulationAcSweepVoltageGraph](#simulationacsweepvoltagegraph)
     - [SimulationAnalysisResult](#simulationanalysisresult)
@@ -234,8 +237,14 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
     - [SimulationOscilloscopeTrace](#simulationoscilloscopetrace)
     - [SimulationParameterSweep](#simulationparametersweep)
     - [SimulationParameterSweepCoordinate](#simulationparametersweepcoordinate)
+    - [SimulationPcbReturnCurrentField](#simulationpcbreturncurrentfield)
+    - [SimulationPcbReturnCurrentHeatmap](#simulationpcbreturncurrentheatmap)
+    - [SimulationPcbReturnCurrentMarker](#simulationpcbreturncurrentmarker)
+    - [SimulationPcbReturnCurrentResult](#simulationpcbreturncurrentresult)
+    - [SimulationReturnCurrentExcitation](#simulationreturncurrentexcitation)
     - [SimulationSpiceSubcircuit](#simulationspicesubcircuit)
     - [SimulationSwitch](#simulationswitch)
+    - [SimulationTerminalPort](#simulationterminalport)
     - [SimulationTransientCurrentGraph](#simulationtransientcurrentgraph)
     - [SimulationTransientVoltageGraph](#simulationtransientvoltagegraph)
     - [SimulationUnknownExperimentError](#simulationunknownexperimenterror)
@@ -1516,6 +1525,32 @@ interface CadComponent {
 }
 ```
 
+### CadReferenceSurface
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/cad/cad_reference_surface.ts)
+
+```typescript
+/** Resolved reference frame in right-handed circuit world: +X right, +Y top,
+ * +Z above. Center and extents are mm; normal and x_axis are dimensionless,
+ * perpendicular unit directions, within 1e-6 numerical tolerance. The frame's
+ * Y direction is normal cross x_axis. Names are unique within source_component_id.
+ * Width and height are both present or both omitted; omission adds no default.
+ * This record describes mounting reference geometry for optional visualization. */
+interface CadReferenceSurface {
+  type: "cad_reference_surface"
+  cad_reference_surface_id: string
+  source_component_id: string
+  name: string
+  shape: "rect"
+  center: Point3
+  normal: Point3
+  x_axis: Point3
+  width?: number
+  height?: number
+  subcircuit_id?: string
+}
+```
+
 ## PCB Elements
 
 ### PcbFabricatorExtraChargeWarning
@@ -4134,6 +4169,53 @@ interface SchematicVoltageProbe {
 
 ## Simulation Elements
 
+### SimulationReturnCurrentContact
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_return_current_contact.ts)
+
+```typescript
+interface SimulationReturnCurrentContactBase {
+  x: number
+  y: number
+  layer: LayerRef
+}
+
+interface SimulationReturnCurrentPortContact extends SimulationReturnCurrentContactBase {
+  contact_type: "pcb_port"
+  pcb_port_id: string
+}
+
+interface SimulationReturnCurrentViaContact extends SimulationReturnCurrentContactBase {
+  contact_type: "pcb_via"
+  pcb_via_id: string
+}
+
+interface SimulationReturnCurrentCopperPourContact extends SimulationReturnCurrentContactBase {
+  contact_type: "pcb_copper_pour"
+  pcb_copper_pour_id: string
+}
+```
+
+### SimulationReturnCurrentGridJson
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_return_current_grid_json.ts)
+
+```typescript
+type SimulationReturnCurrentGridJson =
+  | {
+      field_type: "real"
+      sheet_current_x: (number | null)[]
+      sheet_current_y: (number | null)[]
+    }
+  | {
+      field_type: "complex_phasor"
+      sheet_current_x_real: (number | null)[]
+      sheet_current_x_imag: (number | null)[]
+      sheet_current_y_real: (number | null)[]
+      sheet_current_y_imag: (number | null)[]
+    }
+```
+
 ### SimulationAcSweepCurrentGraph
 
 [Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_ac_sweep_current_graph.ts)
@@ -4483,6 +4565,122 @@ interface SimulationParameterSweepCoordinate {
 }
 ```
 
+### SimulationPcbReturnCurrentField
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_pcb_return_current_field.ts)
+
+```typescript
+interface SimulationPcbReturnCurrentField {
+  type: "simulation_pcb_return_current_field"
+  simulation_pcb_return_current_field_id: string
+  simulation_pcb_return_current_result_id: string
+  layer: LayerRef
+  source_net_id: string
+  field_type: "real" | "complex_phasor"
+  min_x: number
+  min_y: number
+  columns: number
+  rows: number
+  cell_width: number
+  cell_height: number
+  copper_thickness: number
+  data_format: "simulation_return_current_grid_json_v1"
+  field_asset: Asset
+}
+```
+
+### SimulationPcbReturnCurrentHeatmap
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_pcb_return_current_heatmap.ts)
+
+```typescript
+interface SimulationPcbReturnCurrentHeatmap {
+  type: "simulation_pcb_return_current_heatmap"
+  simulation_pcb_return_current_heatmap_id: string
+  simulation_pcb_return_current_result_id: string
+  layer: LayerRef
+  source_net_id: string
+  min_x: number
+  min_y: number
+  max_x: number
+  max_y: number
+  image_asset: Asset
+}
+```
+
+### SimulationPcbReturnCurrentMarker
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_pcb_return_current_marker.ts)
+
+```typescript
+type SimulationPcbReturnCurrentMarker =
+  | SimulationPcbReturnCurrentPortMarker
+  | SimulationPcbReturnCurrentViaMarker
+
+interface SimulationReturnCurrentMarkerBase {
+  type: "simulation_pcb_return_current_marker"
+  simulation_pcb_return_current_marker_id: string
+  simulation_pcb_return_current_result_id: string
+  role:
+    | "signal_source"
+    | "signal_load"
+    | "return_source"
+    | "return_sink"
+    | "signal_transition"
+    | "return_transition"
+  label?: string
+  label_x?: number
+  label_y?: number
+}
+
+interface SimulationPcbReturnCurrentPortMarker extends SimulationReturnCurrentMarkerBase {
+  target_type: "pcb_port"
+  pcb_port_id: string
+  layer: LayerRef
+}
+
+interface SimulationPcbReturnCurrentViaMarker extends SimulationReturnCurrentMarkerBase {
+  target_type: "pcb_via"
+  pcb_via_id: string
+  from_layer: LayerRef
+  to_layer: LayerRef
+}
+```
+
+### SimulationPcbReturnCurrentResult
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_pcb_return_current_result.ts)
+
+```typescript
+interface SimulationPcbReturnCurrentResult {
+  type: "simulation_pcb_return_current_result"
+  simulation_pcb_return_current_result_id: string
+  simulation_experiment_id: string
+  pcb_board_id: string
+  simulation_return_current_excitation_ids: string[]
+  frequency_hz?: number
+}
+```
+
+### SimulationReturnCurrentExcitation
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_return_current_excitation.ts)
+
+```typescript
+interface SimulationReturnCurrentExcitation {
+  type: "simulation_return_current_excitation"
+  simulation_return_current_excitation_id: string
+  simulation_experiment_id: string
+  pcb_trace_id: string
+  ground_source_net_id: string
+  current: number
+  return_source: SimulationReturnCurrentContact
+  return_sink: SimulationReturnCurrentContact
+  source_port?: SimulationTerminalPort
+  load_port?: SimulationTerminalPort
+}
+```
+
 ### SimulationSpiceSubcircuit
 
 [Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_spice_subcircuit.ts)
@@ -4522,6 +4720,19 @@ interface SimulationSwitch {
 }
 ```
 
+### SimulationTerminalPort
+
+[Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_terminal_port.ts)
+
+```typescript
+interface SimulationTerminalPort {
+  signal_pcb_port_id: string
+  reference_pcb_port_id?: string
+  reference_layer: LayerRef
+  resistance: number
+}
+```
+
 ### SimulationTransientCurrentGraph
 
 [Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_transient_current_graph.ts)