@tscircuit/core 0.0.985 → 0.0.986

package/dist/index.d.ts

@@ -16,115 +16,6 @@ import { CopperPourPipelineSolver } from '@tscircuit/copper-pour-solver';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 import { GraphicsObject } from 'graphics-debug';
 
-declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SchematicPrimitiveRender", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicTraceRender", "SchematicReplaceNetLabelsWithSymbols", "PanelBoardLayout", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbTraceHintRender", "PcbManualTraceRender", "PcbTraceRender", "PcbRouteNetIslands", "PcbCopperPourRender", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "SimulationSpiceEngineRender"];
-type RenderPhase = (typeof orderedRenderPhases)[number];
-declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SchematicPrimitiveRender" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicTraceRender" | "SchematicReplaceNetLabelsWithSymbols" | "PanelBoardLayout" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbCopperPourRender" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "SimulationSpiceEngineRender", number>;
-type RenderPhaseFn<K extends RenderPhase = RenderPhase> = `doInitial${K}` | `update${K}` | `remove${K}`;
-type RenderPhaseStates = Record<RenderPhase, {
-    initialized: boolean;
-    dirty: boolean;
-}>;
-type AsyncEffect = {
-    effectName: string;
-    promise: Promise<void>;
-    phase: RenderPhase;
-    complete: boolean;
-};
-type RenderPhaseFunctions = {
-    [T in RenderPhaseFn]?: () => void;
-};
-type IRenderable = RenderPhaseFunctions & {
-    renderPhaseStates: RenderPhaseStates;
-    runRenderPhase(phase: RenderPhase): void;
-    runRenderPhaseForChildren(phase: RenderPhase): void;
-    shouldBeRemoved: boolean;
-    children: IRenderable[];
-    runRenderCycle(): void;
-};
-declare abstract class Renderable implements IRenderable {
-    renderPhaseStates: RenderPhaseStates;
-    shouldBeRemoved: boolean;
-    children: IRenderable[];
-    /** PCB-only SMTPads, PlatedHoles, Holes, Silkscreen elements etc. */
-    isPcbPrimitive: boolean;
-    /** Schematic-only, lines, boxes, indicators etc. */
-    isSchematicPrimitive: boolean;
-    _renderId: string;
-    _currentRenderPhase: RenderPhase | null;
-    private _asyncEffects;
-    parent: Renderable | null;
-    constructor(props: any);
-    _markDirty(phase: RenderPhase): void;
-    _queueAsyncEffect(effectName: string, effect: () => Promise<void>): void;
-    protected _emitRenderLifecycleEvent(phase: RenderPhase, startOrEnd: "start" | "end"): void;
-    getString(): string;
-    _hasIncompleteAsyncEffects(): boolean;
-    _hasIncompleteAsyncEffectsInSubtreeForPhase(phase: RenderPhase): boolean;
-    getCurrentRenderPhase(): RenderPhase | null;
-    getRenderGraph(): Record<string, any>;
-    getTopLevelRenderable(): Renderable;
-    runRenderCycle(): void;
-    /**
-     * This runs all the render methods for a given phase, calling one of:
-     * - doInitial*
-     * - update*
-     *  -remove*
-     *  ...depending on the current state of the component.
-     */
-    runRenderPhase(phase: RenderPhase): void;
-    runRenderPhaseForChildren(phase: RenderPhase): void;
-    renderError(message: string | Omit<PcbTraceError, "pcb_error_id"> | Omit<PcbPlacementError, "pcb_error_id"> | Omit<PcbManualEditConflictWarning, "pcb_error_id"> | Omit<PcbViaClearanceError, "pcb_error_id">): void;
-}
-
-/**
- * This is how we render in React. This can be a confusing part of the codebase,
- * but here are some helpful reference implementations:
- *
- * https://github.com/diegomura/react-pdf/blob/fabecc56727dfb6d590a3fa1e11f50250ecbbea1/packages/reconciler/src/reconciler-31.js
- * https://github.com/pmndrs/react-three-fiber/blob/ec4f00bb61cc4f6e28b3a12b1dca9daa5594f10e/packages/fiber/src/core/renderer.ts
- *
- *
- */
-
-type ReactSubtree = {
-    element: ReactElement;
-    component: NormalComponent;
-};
-
-type SchematicBoxPortPositionWithMetadata = {
-    trueIndex: number;
-    pinNumber: number;
-    side: "left" | "right" | "top" | "bottom";
-    distanceFromOrthogonalEdge: number;
-    x: number;
-    y: number;
-};
-interface SchematicBoxDimensions {
-    pinCount: number;
-    getPortPositionByPinNumber(pinNumber: number): SchematicBoxPortPositionWithMetadata | null;
-    getSize(): {
-        width: number;
-        height: number;
-    };
-    getSizeIncludingPins(): {
-        width: number;
-        height: number;
-    };
-}
-interface SchematicBoxComponentDimensions {
-    schWidth: number;
-    schHeight: number;
-}
-
-interface BoardI {
-    componentName: string;
-    boardThickness: number;
-    _connectedSchematicPortPairs: Set<string>;
-    allLayers: ReadonlyArray<LayerRef>;
-    _getBoardCalcVariables(): Record<string, number>;
-    pcb_board_id?: string | null;
-}
-
 declare const SOLVERS: {
     PackSolver2: typeof PackSolver2;
     AutoroutingPipelineSolver: typeof AutoroutingPipelineSolver;
@@ -271,6 +162,124 @@ interface DebugLogOutputEvent {
     content: any;
 }
 
+interface IRootCircuit {
+    emit(event: RootCircuitEventName, ...args: any[]): void;
+    on(event: RootCircuitEventName, listener: (...args: any[]) => void): void;
+    _hasIncompleteAsyncEffectsForPhase(phase: RenderPhase): boolean;
+}
+
+declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SchematicPrimitiveRender", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicTraceRender", "SchematicReplaceNetLabelsWithSymbols", "PanelBoardLayout", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbTraceHintRender", "PcbManualTraceRender", "PcbTraceRender", "PcbRouteNetIslands", "PcbCopperPourRender", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "SimulationSpiceEngineRender"];
+type RenderPhase = (typeof orderedRenderPhases)[number];
+declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SchematicPrimitiveRender" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicTraceRender" | "SchematicReplaceNetLabelsWithSymbols" | "PanelBoardLayout" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbCopperPourRender" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "SimulationSpiceEngineRender", number>;
+type RenderPhaseFn<K extends RenderPhase = RenderPhase> = `doInitial${K}` | `update${K}` | `remove${K}`;
+type RenderPhaseStates = Record<RenderPhase, {
+    initialized: boolean;
+    dirty: boolean;
+}>;
+type AsyncEffect = {
+    asyncEffectId: string;
+    effectName: string;
+    promise: Promise<void>;
+    phase: RenderPhase;
+    complete: boolean;
+};
+type RenderPhaseFunctions = {
+    [T in RenderPhaseFn]?: () => void;
+};
+type IRenderable = RenderPhaseFunctions & {
+    renderPhaseStates: RenderPhaseStates;
+    runRenderPhase(phase: RenderPhase): void;
+    runRenderPhaseForChildren(phase: RenderPhase): void;
+    shouldBeRemoved: boolean;
+    children: IRenderable[];
+    runRenderCycle(): void;
+};
+declare abstract class Renderable implements IRenderable {
+    renderPhaseStates: RenderPhaseStates;
+    shouldBeRemoved: boolean;
+    children: IRenderable[];
+    /** PCB-only SMTPads, PlatedHoles, Holes, Silkscreen elements etc. */
+    isPcbPrimitive: boolean;
+    /** Schematic-only, lines, boxes, indicators etc. */
+    isSchematicPrimitive: boolean;
+    _renderId: string;
+    _currentRenderPhase: RenderPhase | null;
+    private _asyncEffects;
+    parent: Renderable | null;
+    constructor(props: any);
+    _markDirty(phase: RenderPhase): void;
+    _queueAsyncEffect(effectName: string, effect: () => Promise<void>): void;
+    protected _emitRenderLifecycleEvent(phase: RenderPhase, startOrEnd: "start" | "end"): void;
+    getString(): string;
+    _hasIncompleteAsyncEffects(): boolean;
+    _hasIncompleteAsyncEffectsInSubtreeForPhase(phase: RenderPhase): boolean;
+    _hasIncompleteAsyncEffectsForPhase(phase: RenderPhase): boolean;
+    getCurrentRenderPhase(): RenderPhase | null;
+    getRenderGraph(): Record<string, any>;
+    getTopLevelRenderable(): Renderable;
+    runRenderCycle(): void;
+    /**
+     * This runs all the render methods for a given phase, calling one of:
+     * - doInitial*
+     * - update*
+     *  -remove*
+     *  ...depending on the current state of the component.
+     */
+    runRenderPhase(phase: RenderPhase): void;
+    runRenderPhaseForChildren(phase: RenderPhase): void;
+    protected _getRootCircuit(): IRootCircuit | null;
+    renderError(message: string | Omit<PcbTraceError, "pcb_error_id"> | Omit<PcbPlacementError, "pcb_error_id"> | Omit<PcbManualEditConflictWarning, "pcb_error_id"> | Omit<PcbViaClearanceError, "pcb_error_id">): void;
+}
+
+/**
+ * This is how we render in React. This can be a confusing part of the codebase,
+ * but here are some helpful reference implementations:
+ *
+ * https://github.com/diegomura/react-pdf/blob/fabecc56727dfb6d590a3fa1e11f50250ecbbea1/packages/reconciler/src/reconciler-31.js
+ * https://github.com/pmndrs/react-three-fiber/blob/ec4f00bb61cc4f6e28b3a12b1dca9daa5594f10e/packages/fiber/src/core/renderer.ts
+ *
+ *
+ */
+
+type ReactSubtree = {
+    element: ReactElement;
+    component: NormalComponent;
+};
+
+type SchematicBoxPortPositionWithMetadata = {
+    trueIndex: number;
+    pinNumber: number;
+    side: "left" | "right" | "top" | "bottom";
+    distanceFromOrthogonalEdge: number;
+    x: number;
+    y: number;
+};
+interface SchematicBoxDimensions {
+    pinCount: number;
+    getPortPositionByPinNumber(pinNumber: number): SchematicBoxPortPositionWithMetadata | null;
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    getSizeIncludingPins(): {
+        width: number;
+        height: number;
+    };
+}
+interface SchematicBoxComponentDimensions {
+    schWidth: number;
+    schHeight: number;
+}
+
+interface BoardI {
+    componentName: string;
+    boardThickness: number;
+    _connectedSchematicPortPairs: Set<string>;
+    allLayers: ReadonlyArray<LayerRef>;
+    _getBoardCalcVariables(): Record<string, number>;
+    pcb_board_id?: string | null;
+}
+
 declare function resolveStaticFileImport(path: string, platform?: PlatformConfig): Promise<string>;
 
 declare class RootCircuit {
@@ -299,6 +308,8 @@ declare class RootCircuit {
      */
     projectUrl?: string;
     _hasRenderedAtleastOnce: boolean;
+    private _asyncEffectIdsByPhase;
+    private _asyncEffectPhaseById;
     constructor({ platform, projectUrl, }?: {
         platform?: PlatformConfig;
         projectUrl?: string;
@@ -313,6 +324,7 @@ declare class RootCircuit {
     render(): void;
     renderUntilSettled(): Promise<void>;
     private _hasIncompleteAsyncEffects;
+    _hasIncompleteAsyncEffectsForPhase(phase: RenderPhase): boolean;
     getCircuitJson(): AnyCircuitElement[];
     toJson(): AnyCircuitElement[];
     getSvg(options: {
@@ -336,6 +348,8 @@ declare class RootCircuit {
     removeListener(event: RootCircuitEventName, listener: (...args: any[]) => void): void;
     enableDebug(debug: string | null | false): void;
     getClientOrigin(): string;
+    private _registerAsyncEffectStart;
+    private _registerAsyncEffectEnd;
 }
 /**
  * @deprecated

package/dist/index.js

@@ -185,6 +185,7 @@ var asyncPhaseDependencies = {
   PcbComponentAnchorAlignment: ["PcbFootprintStringRender"]
 };
 var globalRenderCounter = 0;
+var globalAsyncEffectCounter = 0;
 var Renderable = class _Renderable {
   renderPhaseStates;
   shouldBeRemoved = false;
@@ -219,7 +220,9 @@ var Renderable = class _Renderable {
     }
   }
   _queueAsyncEffect(effectName, effect) {
+    const asyncEffectId = `${this._renderId}:${globalAsyncEffectCounter++}`;
     const asyncEffect = {
+      asyncEffectId,
       promise: effect(),
       // TODO don't start effects until end of render cycle
       phase: this._currentRenderPhase,
@@ -227,9 +230,10 @@ var Renderable = class _Renderable {
       complete: false
     };
     this._asyncEffects.push(asyncEffect);
-    if ("root" in this && this.root) {
-      ;
-      this.root.emit("asyncEffect:start", {
+    const root = this._getRootCircuit();
+    if (root) {
+      root.emit("asyncEffect:start", {
+        asyncEffectId,
         effectName,
         componentDisplayName: this.getString(),
         phase: asyncEffect.phase
@@ -237,9 +241,10 @@ var Renderable = class _Renderable {
     }
     asyncEffect.promise.then(() => {
       asyncEffect.complete = true;
-      if ("root" in this && this.root) {
-        ;
-        this.root.emit("asyncEffect:end", {
+      const root2 = this._getRootCircuit();
+      if (root2) {
+        root2.emit("asyncEffect:end", {
+          asyncEffectId,
           effectName,
           componentDisplayName: this.getString(),
           phase: asyncEffect.phase
@@ -251,9 +256,10 @@ var Renderable = class _Renderable {
 ${error.stack}`
       );
       asyncEffect.complete = true;
-      if ("root" in this && this.root) {
-        ;
-        this.root.emit("asyncEffect:end", {
+      const root2 = this._getRootCircuit();
+      if (root2) {
+        root2.emit("asyncEffect:end", {
+          asyncEffectId,
           effectName,
           componentDisplayName: this.getString(),
           phase: asyncEffect.phase,
@@ -270,10 +276,10 @@ ${error.stack}`
       componentDisplayName: this.getString(),
       type: granular_event_type
     };
-    if ("root" in this && this.root) {
-      ;
-      this.root.emit(granular_event_type, eventPayload);
-      this.root.emit("renderable:renderLifecycle:anyEvent", {
+    const root = this._getRootCircuit();
+    if (root) {
+      root.emit(granular_event_type, eventPayload);
+      root.emit("renderable:renderLifecycle:anyEvent", {
         ...eventPayload,
         type: granular_event_type
       });
@@ -299,6 +305,13 @@ ${error.stack}`
     }
     return false;
   }
+  _hasIncompleteAsyncEffectsForPhase(phase) {
+    const root = this._getRootCircuit();
+    if (root?._hasIncompleteAsyncEffectsForPhase) {
+      return root._hasIncompleteAsyncEffectsForPhase(phase);
+    }
+    return this._hasIncompleteAsyncEffectsInSubtreeForPhase(phase);
+  }
   getCurrentRenderPhase() {
     return this._currentRenderPhase;
   }
@@ -355,9 +368,8 @@ ${error.stack}`
     }
     const deps = asyncPhaseDependencies[phase] || [];
     if (deps.length > 0) {
-      const root = this.getTopLevelRenderable();
       for (const depPhase of deps) {
-        if (root._hasIncompleteAsyncEffectsInSubtreeForPhase(depPhase)) {
+        if (this._hasIncompleteAsyncEffectsForPhase(depPhase)) {
           return;
         }
       }
@@ -383,6 +395,12 @@ ${error.stack}`
       child.runRenderPhase(phase);
     }
   }
+  _getRootCircuit() {
+    if ("root" in this) {
+      return this.root ?? null;
+    }
+    return null;
+  }
   renderError(message) {
     if (typeof message === "string") {
       throw new Error(message);
@@ -21002,7 +21020,7 @@ import { identity as identity5 } from "transformation-matrix";
 var package_default = {
   name: "@tscircuit/core",
   type: "module",
-  version: "0.0.984",
+  version: "0.0.985",
   types: "dist/index.d.ts",
   main: "dist/index.js",
   module: "dist/index.js",
@@ -21152,6 +21170,8 @@ var RootCircuit = class {
    */
   projectUrl;
   _hasRenderedAtleastOnce = false;
+  _asyncEffectIdsByPhase = /* @__PURE__ */ new Map();
+  _asyncEffectPhaseById = /* @__PURE__ */ new Map();
   constructor({
     platform,
     projectUrl
@@ -21244,8 +21264,12 @@ var RootCircuit = class {
     this.emit("renderComplete");
   }
   _hasIncompleteAsyncEffects() {
+    if (this._asyncEffectPhaseById.size > 0) return true;
     return this.children.some((child) => child._hasIncompleteAsyncEffects());
   }
+  _hasIncompleteAsyncEffectsForPhase(phase) {
+    return (this._asyncEffectIdsByPhase.get(phase)?.size ?? 0) > 0;
+  }
   getCircuitJson() {
     if (!this._hasRenderedAtleastOnce) this.render();
     return this.db.toArray();
@@ -21295,6 +21319,11 @@ var RootCircuit = class {
   }
   _eventListeners = {};
   emit(event, ...args) {
+    if (event === "asyncEffect:start") {
+      this._registerAsyncEffectStart(args[0]);
+    } else if (event === "asyncEffect:end") {
+      this._registerAsyncEffectEnd(args[0]);
+    }
     if (!this._eventListeners[event]) return;
     for (const listener of this._eventListeners[event]) {
       listener(...args);
@@ -21328,6 +21357,32 @@ var RootCircuit = class {
     }
     return "";
   }
+  _registerAsyncEffectStart(payload) {
+    if (!payload?.asyncEffectId || !payload.phase) return;
+    const { asyncEffectId, phase } = payload;
+    const existingPhase = this._asyncEffectPhaseById.get(asyncEffectId);
+    if (existingPhase && existingPhase !== phase) {
+      this._asyncEffectIdsByPhase.get(existingPhase)?.delete(asyncEffectId);
+    }
+    if (!this._asyncEffectIdsByPhase.has(phase)) {
+      this._asyncEffectIdsByPhase.set(phase, /* @__PURE__ */ new Set());
+    }
+    this._asyncEffectIdsByPhase.get(phase).add(asyncEffectId);
+    this._asyncEffectPhaseById.set(asyncEffectId, phase);
+  }
+  _registerAsyncEffectEnd(payload) {
+    if (!payload?.asyncEffectId) return;
+    const { asyncEffectId } = payload;
+    const phase = this._asyncEffectPhaseById.get(asyncEffectId) ?? payload.phase;
+    if (phase) {
+      const phaseSet = this._asyncEffectIdsByPhase.get(phase);
+      phaseSet?.delete(asyncEffectId);
+      if (phaseSet && phaseSet.size === 0) {
+        this._asyncEffectIdsByPhase.delete(phase);
+      }
+    }
+    this._asyncEffectPhaseById.delete(asyncEffectId);
+  }
 };
 var Project = RootCircuit;
 var Circuit = RootCircuit;

package/package.json

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