@tscircuit/core 0.0.241 → 0.0.243

package/dist/index.d.ts

@@ -82,14 +82,21 @@ interface SchematicBoxDimensions {
 }
 
 type RootCircuitEventName = "asyncEffectComplete" | "renderable:renderLifecycle:anyEvent" | `renderable:renderLifecycle:${RenderPhase}:start` | `renderable:renderLifecycle:${RenderPhase}:end` | "external:evalError";
-declare class Circuit {
+declare class RootCircuit {
     firstChild: PrimitiveComponent | null;
     children: PrimitiveComponent[];
     db: SoupUtilObjects;
-    root: Circuit | null;
+    root: RootCircuit | null;
     isRoot: boolean;
     schematicDisabled: boolean;
     pcbDisabled: boolean;
+    pcbRoutingDisabled: boolean;
+    /**
+     * The RootCircuit name is usually set by the platform, it's not required but
+     * if supplied can identify the circuit in certain effects, e.g. it is passed
+     * as the display_name parameter for autorouting effects.
+     */
+    name?: string;
     _hasRenderedAtleastOnce: boolean;
     constructor();
     add(componentOrElm: PrimitiveComponent | ReactElement): void;
@@ -129,7 +136,7 @@ declare class Circuit {
 /**
  * @deprecated
  */
-declare const Project: typeof Circuit;
+declare const Project: typeof RootCircuit;
 
 interface ISubcircuit extends PrimitiveComponent {
     _shouldUseTraceByTraceRouting(): boolean;
@@ -268,7 +275,7 @@ declare abstract class PrimitiveComponent<ZodProps extends ZodType = any> extend
         x: number;
         y: number;
     };
-    get root(): Circuit | null;
+    get root(): RootCircuit | null;
     onAddToParent(parent: PrimitiveComponent): void;
     /**
      * Called whenever the props change
@@ -8297,7 +8304,7 @@ declare class Crystal extends NormalComponent<typeof crystalProps, PolarizedPass
 declare const useRenderedCircuit: (reactElements: React.ReactElement) => {
     isLoading: boolean;
     error?: Error | null;
-    circuit?: Circuit;
+    circuit?: RootCircuit;
     circuitJson?: AnyCircuitElement[];
 };
 
@@ -8664,4 +8671,4 @@ declare module "react/jsx-runtime" {
     }
 }
 
-export { Battery, Board, Capacitor, Chip, Circuit, type ComponentWithPins, Constraint, Crystal, Diode, FabricationNotePath, FabricationNoteText, Footprint, Group, Hole, type IRenderable, Inductor, Jumper, Keepout, Led, Net, NetAlias, NormalComponent, PinHeader, type PinLabelSpec, PlatedHole, Port, Potentiometer, PowerSource, PrimitiveComponent, Project, PushButton, Renderable, Resistor, SilkscreenCircle, SilkscreenLine, SilkscreenPath, SilkscreenRect, SilkscreenText, SmtPad, Subcircuit, Trace, TraceHint, Via, applyEditEventsToManualEditsFile, createUseComponent, useCapacitor, useChip, useDiode, useLed, useRenderedCircuit, useResistor };
+export { Battery, Board, Capacitor, Chip, type ComponentWithPins, Constraint, Crystal, Diode, FabricationNotePath, FabricationNoteText, Footprint, Group, Hole, type IRenderable, Inductor, Jumper, Keepout, Led, Net, NetAlias, NormalComponent, PinHeader, type PinLabelSpec, PlatedHole, Port, Potentiometer, PowerSource, PrimitiveComponent, Project, PushButton, Renderable, Resistor, RootCircuit, SilkscreenCircle, SilkscreenLine, SilkscreenPath, SilkscreenRect, SilkscreenText, SmtPad, Subcircuit, Trace, TraceHint, Via, applyEditEventsToManualEditsFile, createUseComponent, useCapacitor, useChip, useDiode, useLed, useRenderedCircuit, useResistor };

package/dist/index.js

@@ -3552,7 +3552,8 @@ var Group = class extends NormalComponent {
           body: JSON.stringify({
             input_circuit_json: this.root.db.toArray(),
             provider: "freerouting",
-            autostart: true
+            autostart: true,
+            display_name: this.root?.name
           }),
           headers: { "Content-Type": "application/json" }
         }
@@ -5883,11 +5884,11 @@ var Crystal = class extends NormalComponent {
   }
 };
 
-// lib/Circuit.ts
+// lib/RootCircuit.ts
 import { su } from "@tscircuit/soup-util";
 import { isValidElement as isValidElement2 } from "react";
 import { identity as identity5 } from "transformation-matrix";
-var Circuit = class {
+var RootCircuit = class {
   firstChild = null;
   children;
   db;
@@ -5895,6 +5896,13 @@ var Circuit = class {
   isRoot = true;
   schematicDisabled = false;
   pcbDisabled = false;
+  pcbRoutingDisabled = false;
+  /**
+   * The RootCircuit name is usually set by the platform, it's not required but
+   * if supplied can identify the circuit in certain effects, e.g. it is passed
+   * as the display_name parameter for autorouting effects.
+   */
+  name;
   _hasRenderedAtleastOnce = false;
   constructor() {
     this.children = [];
@@ -6026,7 +6034,7 @@ var Circuit = class {
     return "";
   }
 };
-var Project = Circuit;
+var Project = RootCircuit;
 
 // lib/hooks/use-rendered-circuit.ts
 import React from "react";
@@ -6041,7 +6049,7 @@ var useRenderedCircuit = (reactElements) => {
     if (reactElements) {
       setTimeout(() => {
         try {
-          const circuit2 = new Circuit();
+          const circuit2 = new RootCircuit();
           circuit2.add(reactElements);
           setCircuit(circuit2);
           setCircuitJson(circuit2.toJson());
@@ -6192,7 +6200,6 @@ export {
   Board,
   Capacitor,
   Chip,
-  Circuit,
   Constraint2 as Constraint,
   Crystal,
   Diode,
@@ -6218,6 +6225,7 @@ export {
   PushButton,
   Renderable,
   Resistor,
+  RootCircuit,
   SilkscreenCircle,
   SilkscreenLine,
   SilkscreenPath,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.241",
+  "version": "0.0.243",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",