circuit-json 0.0.320 → 0.0.322

package/README.md

@@ -453,6 +453,7 @@ interface SourcePort {
   source_group_id?: string
   subcircuit_id?: string
   subcircuit_connectivity_map_key?: string
+  must_be_connected?: boolean
 }
 ```
 
@@ -2712,17 +2713,19 @@ interface SimulationUnknownExperimentError {
 
 [Source](https://github.com/tscircuit/circuit-json/blob/main/src/simulation/simulation_voltage_probe.ts)
 
-Defines a voltage probe for simulation, connected to a port or a net.
-
 ```typescript
-/** Defines a voltage probe for simulation, connected to a port or a net. */
+/** Defines a voltage probe for simulation. If a reference input is not provided,
+ * it measures against ground. If a reference input is provided, it measures
+ * the differential voltage between two points. */
 interface SimulationVoltageProbe {
   type: "simulation_voltage_probe"
   simulation_voltage_probe_id: string
   source_component_id?: string
   name?: string
-  source_port_id?: string
-  source_net_id?: string
+  signal_input_source_port_id?: string
+  signal_input_source_net_id?: string
+  reference_input_source_port_id?: string
+  reference_input_source_net_id?: string
   subcircuit_id?: string
   color?: string
 }

package/dist/index.d.mts

@@ -9713,8 +9713,10 @@ declare const simulation_voltage_probe: z.ZodEffects<z.ZodObject<{
     simulation_voltage_probe_id: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     source_component_id: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
-    source_port_id: z.ZodOptional<z.ZodString>;
-    source_net_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_port_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_net_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_port_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_net_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     color: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -9723,48 +9725,60 @@ declare const simulation_voltage_probe: z.ZodEffects<z.ZodObject<{
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>, {
     type: "simulation_voltage_probe";
     simulation_voltage_probe_id: string;
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>;
 type SimulationVoltageProbeInput = z.input<typeof simulation_voltage_probe>;
 /**
- * Defines a voltage probe for simulation, connected to a port or a net.
+ * Defines a voltage probe for simulation. If a reference input is not provided,
+ * it measures against ground. If a reference input is provided, it measures
+ * the differential voltage between two points.
  */
 interface SimulationVoltageProbe {
     type: "simulation_voltage_probe";
     simulation_voltage_probe_id: string;
     source_component_id?: string;
     name?: string;
-    source_port_id?: string;
-    source_net_id?: string;
+    signal_input_source_port_id?: string;
+    signal_input_source_net_id?: string;
+    reference_input_source_port_id?: string;
+    reference_input_source_net_id?: string;
     subcircuit_id?: string;
     color?: string;
 }
@@ -12240,6 +12254,7 @@ declare const source_port: z.ZodObject<{
     source_group_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     subcircuit_connectivity_map_key: z.ZodOptional<z.ZodString>;
+    must_be_connected: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type: "source_port";
     name: string;
@@ -12250,6 +12265,7 @@ declare const source_port: z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }, {
     type: "source_port";
     name: string;
@@ -12260,6 +12276,7 @@ declare const source_port: z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }>;
 type SourcePortInput = z.input<typeof source_port>;
 /**
@@ -12275,6 +12292,7 @@ interface SourcePort {
     source_group_id?: string;
     subcircuit_id?: string;
     subcircuit_connectivity_map_key?: string;
+    must_be_connected?: boolean;
 }
 
 interface SourceTrace {
@@ -12785,6 +12803,7 @@ declare const any_circuit_element: z.ZodUnion<[z.ZodObject<{
     source_group_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     subcircuit_connectivity_map_key: z.ZodOptional<z.ZodString>;
+    must_be_connected: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type: "source_port";
     name: string;
@@ -12795,6 +12814,7 @@ declare const any_circuit_element: z.ZodUnion<[z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }, {
     type: "source_port";
     name: string;
@@ -12805,6 +12825,7 @@ declare const any_circuit_element: z.ZodUnion<[z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }>, z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"source_component">;
     source_component_id: z.ZodString;
@@ -20614,8 +20635,10 @@ declare const any_circuit_element: z.ZodUnion<[z.ZodObject<{
     simulation_voltage_probe_id: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     source_component_id: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
-    source_port_id: z.ZodOptional<z.ZodString>;
-    source_net_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_port_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_net_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_port_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_net_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     color: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -20624,36 +20647,44 @@ declare const any_circuit_element: z.ZodUnion<[z.ZodObject<{
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>, {
     type: "simulation_voltage_probe";
     simulation_voltage_probe_id: string;
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"simulation_unknown_experiment_error">;
     simulation_unknown_experiment_error_id: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -20719,6 +20750,7 @@ declare const any_soup_element: z.ZodUnion<[z.ZodObject<{
     source_group_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     subcircuit_connectivity_map_key: z.ZodOptional<z.ZodString>;
+    must_be_connected: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type: "source_port";
     name: string;
@@ -20729,6 +20761,7 @@ declare const any_soup_element: z.ZodUnion<[z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }, {
     type: "source_port";
     name: string;
@@ -20739,6 +20772,7 @@ declare const any_soup_element: z.ZodUnion<[z.ZodObject<{
     subcircuit_connectivity_map_key?: string | undefined;
     source_group_id?: string | undefined;
     pin_number?: number | undefined;
+    must_be_connected?: boolean | undefined;
 }>, z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"source_component">;
     source_component_id: z.ZodString;
@@ -28548,8 +28582,10 @@ declare const any_soup_element: z.ZodUnion<[z.ZodObject<{
     simulation_voltage_probe_id: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     source_component_id: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
-    source_port_id: z.ZodOptional<z.ZodString>;
-    source_net_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_port_id: z.ZodOptional<z.ZodString>;
+    signal_input_source_net_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_port_id: z.ZodOptional<z.ZodString>;
+    reference_input_source_net_id: z.ZodOptional<z.ZodString>;
     subcircuit_id: z.ZodOptional<z.ZodString>;
     color: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -28558,36 +28594,44 @@ declare const any_soup_element: z.ZodUnion<[z.ZodObject<{
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>, {
     type: "simulation_voltage_probe";
     simulation_voltage_probe_id: string;
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }, {
     type: "simulation_voltage_probe";
     name?: string | undefined;
     source_component_id?: string | undefined;
     subcircuit_id?: string | undefined;
-    source_port_id?: string | undefined;
-    source_net_id?: string | undefined;
     color?: string | undefined;
     simulation_voltage_probe_id?: string | undefined;
+    signal_input_source_port_id?: string | undefined;
+    signal_input_source_net_id?: string | undefined;
+    reference_input_source_port_id?: string | undefined;
+    reference_input_source_net_id?: string | undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"simulation_unknown_experiment_error">;
     simulation_unknown_experiment_error_id: z.ZodDefault<z.ZodOptional<z.ZodString>>;

package/dist/index.mjs

@@ -677,7 +677,8 @@ var source_port = z37.object({
   source_component_id: z37.string().optional(),
   source_group_id: z37.string().optional(),
   subcircuit_id: z37.string().optional(),
-  subcircuit_connectivity_map_key: z37.string().optional()
+  subcircuit_connectivity_map_key: z37.string().optional(),
+  must_be_connected: z37.boolean().optional()
 });
 expectTypesMatch(true);
 
@@ -2890,18 +2891,48 @@ var simulation_voltage_probe = z130.object({
   ),
   source_component_id: z130.string().optional(),
   name: z130.string().optional(),
-  source_port_id: z130.string().optional(),
-  source_net_id: z130.string().optional(),
+  signal_input_source_port_id: z130.string().optional(),
+  signal_input_source_net_id: z130.string().optional(),
+  reference_input_source_port_id: z130.string().optional(),
+  reference_input_source_net_id: z130.string().optional(),
   subcircuit_id: z130.string().optional(),
   color: z130.string().optional()
 }).describe(
-  "Defines a voltage probe for simulation, connected to a port or a net"
-).refine(
-  (data) => Boolean(data.source_port_id) !== Boolean(data.source_net_id),
-  {
-    message: "Exactly one of source_port_id or source_net_id must be provided to simulation_voltage_probe"
+  "Defines a voltage probe for simulation. If a reference input is not provided, it measures against ground. If a reference input is provided, it measures the differential voltage between two points."
+).superRefine((data, ctx) => {
+  const is_differential = data.reference_input_source_port_id || data.reference_input_source_net_id;
+  if (is_differential) {
+    const has_ports = !!data.signal_input_source_port_id || !!data.reference_input_source_port_id;
+    const has_nets = !!data.signal_input_source_net_id || !!data.reference_input_source_net_id;
+    if (has_ports && has_nets) {
+      ctx.addIssue({
+        code: z130.ZodIssueCode.custom,
+        message: "Cannot mix port and net connections in a differential probe."
+      });
+    } else if (has_ports) {
+      if (!data.signal_input_source_port_id || !data.reference_input_source_port_id) {
+        ctx.addIssue({
+          code: z130.ZodIssueCode.custom,
+          message: "Differential port probe requires both signal_input_source_port_id and reference_input_source_port_id."
+        });
+      }
+    } else if (has_nets) {
+      if (!data.signal_input_source_net_id || !data.reference_input_source_net_id) {
+        ctx.addIssue({
+          code: z130.ZodIssueCode.custom,
+          message: "Differential net probe requires both signal_input_source_net_id and reference_input_source_net_id."
+        });
+      }
+    }
+  } else {
+    if (!!data.signal_input_source_port_id === !!data.signal_input_source_net_id) {
+      ctx.addIssue({
+        code: z130.ZodIssueCode.custom,
+        message: "A voltage probe must have exactly one of signal_input_source_port_id or signal_input_source_net_id."
+      });
+    }
   }
-);
+});
 expectTypesMatch(true);
 
 // src/simulation/simulation_unknown_experiment_error.ts