@tscircuit/core 0.0.146 → 0.0.147

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import * as _tscircuit_props from '@tscircuit/props';
+import { traceProps, SchematicPortArrangement, groupProps, boardProps, capacitorProps, chipProps, diodeProps, jumperProps, ledProps, powerSourceProps, resistorProps, constraintProps, fabricationNotePathProps, fabricationNoteTextProps, footprintProps, holeProps, pcbKeepoutProps, netAliasProps, platedHoleProps, silkscreenCircleProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, traceHintProps, viaProps, batteryProps, pinHeaderProps, inductorProps, CapacitorProps, ChipProps, ResistorProps } from '@tscircuit/props';
 import React, { ReactElement } from 'react';
 import * as zod from 'zod';
 import { ZodType, z } from 'zod';
@@ -5,8 +7,6 @@ import { SchSymbol, BaseSymbolName } from 'schematic-symbols';
 import { PcbTraceError, PcbPlacementError, LayerRef, AnyCircuitElement, AnySourceComponent, RouteHintPoint } from 'circuit-json';
 import { Matrix } from 'transformation-matrix';
 import { SoupUtilObjects } from '@tscircuit/soup-util';
-import * as _tscircuit_props from '@tscircuit/props';
-import { traceProps, groupProps, boardProps, capacitorProps, chipProps, diodeProps, jumperProps, ledProps, powerSourceProps, resistorProps, constraintProps, fabricationNotePathProps, fabricationNoteTextProps, footprintProps, holeProps, pcbKeepoutProps, netAliasProps, platedHoleProps, silkscreenCircleProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, traceHintProps, viaProps, batteryProps, pinHeaderProps, inductorProps, CapacitorProps, ChipProps, ResistorProps } from '@tscircuit/props';
 import * as _tscircuit_layout from '@tscircuit/layout';
 
 declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "InitializePortsFromChildren", "CreateNetsFromProps", "CreateTracesFromProps", "CreateTraceHintsFromProps", "SourceRender", "SourceParentAttachment", "PortDiscovery", "PortMatching", "SourceTraceRender", "SchematicComponentRender", "SchematicPortRender", "SchematicLayout", "SchematicTraceRender", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbLayout", "PcbTraceRender", "PcbTraceHintRender", "PcbRouteNetIslands", "PcbComponentSizeCalculation", "CadModelRender"];
@@ -111,11 +111,43 @@ interface ISubcircuit extends PrimitiveComponent {
     _shouldUseTraceByTraceRouting(): boolean;
 }
 
+type SchematicBoxPortPositionWithMetadata = {
+    trueIndex: number;
+    pinNumber: number;
+    side: "left" | "right" | "top" | "bottom";
+    distanceFromEdge: number;
+    x: number;
+    y: number;
+};
+/**
+ * Get the dimensions of a schematic box based on the provided parameters.
+ *
+ * A schematic box is a rectangular box with a set of pins on the sides.
+ *
+ * The user can customize the position of the pins and the spacing between them,
+ * this makes computing the box fairly complicated.
+ *
+ * A note on the internals:
+ * * A "true port" refers to a pin/port before it's remapped by the user to a
+ *   different position. True Pin 1 is guaranteed to be in the top-left corner
+ * * We basically iterate over each side and compute how far we are from the
+ *   edge for that side by adding margins together
+ */
+interface SchematicBoxDimensions {
+    pinCount: number;
+    getPortPositionByPinNumber(pinNumber: number): SchematicBoxPortPositionWithMetadata | null;
+    getSize(): {
+        width: number;
+        height: number;
+    };
+}
+
 interface BaseComponentConfig {
     componentName: string;
     schematicSymbolName?: BaseSymbolName | null;
     zodProps: ZodType;
     sourceFtype?: AnySourceComponent["ftype"] | null;
+    shouldRenderAsSchematicBox?: boolean;
 }
 /**
  * A PrimitiveComponent (SmtPad, Port etc.) doesn't have the ability to contain
@@ -271,6 +303,16 @@ declare abstract class PrimitiveComponent<ZodProps extends ZodType = any> extend
     }): PrimitiveComponent | null;
     getAvailablePcbLayers(): string[];
     getDescendants(): PrimitiveComponent[];
+    /**
+     * Return the number of pins in this component, this is important for
+     * NormalComponents
+     */
+    _getPinCount(): number;
+    /**
+     * If this component represents a SchematicBox (like a Chip), return the
+     * dimensions of the box, which allows computing the position of ports etc.
+     */
+    _getSchematicBoxDimensions(): SchematicBoxDimensions | null;
     renderError(message: Parameters<typeof Renderable.prototype.renderError>[0]): void;
     getString(): string;
     get [Symbol.toStringTag](): string;
@@ -696,11 +738,14 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
     doInitialSourceRender(): void;
     /**
      * Render the schematic component for this NormalComponent using the
-     * config.schematicSymbolName if it exists.
+     * config.schematicSymbolName if it exists, or create a generic box if
+     * no symbol is defined.
      *
      * You can override this method to do more complicated things.
      */
     doInitialSchematicComponentRender(): void;
+    _doInitialSchematicComponentRenderWithSymbol(): void;
+    _doInitialSchematicComponentRenderWithSchematicBoxDimensions(): void;
     doInitialPcbComponentRender(): void;
     /**
      * At this stage, the smtpads/pcb primitives are placed, so we can compute
@@ -739,6 +784,13 @@ declare class NormalComponent<ZodProps extends ZodType = any, PortNames extends
         width: number;
         height: number;
     };
+    _getPinCount(): number;
+    /**
+     * Override the schematic port arrangement if you want to customize where pins
+     * appear on a schematic box, e.g. for a pin header
+     */
+    _getSchematicPortArrangement(): SchematicPortArrangement | null;
+    _getSchematicBoxDimensions(): SchematicBoxDimensions | null;
     doInitialCadModelRender(): void;
 }
 
@@ -1310,39 +1362,8 @@ declare class Capacitor extends NormalComponent<typeof capacitorProps, PassivePo
     doInitialSourceRender(): void;
 }
 
-type PortInfo = {
-    trueIndex: number;
-    pinNumber: number;
-    side: "left" | "right" | "top" | "bottom" | "center";
-    distanceFromEdge: number;
-    x: number;
-    y: number;
-};
-/**
- * Get the dimensions of a schematic box based on the provided parameters.
- *
- * A schematic box is a rectangular box with a set of pins on the sides.
- *
- * The user can customize the position of the pins and the spacing between them,
- * this makes computing the box fairly complicated.
- *
- * A note on the internals:
- * * A "true port" refers to a pin/port before it's remapped by the user to a
- *   different position. True Pin 1 is guaranteed to be in the top-left corner
- * * We basically iterate over each side and compute how far we are from the
- *   edge for that side by adding margins together
- */
-interface SchematicBoxDimensions {
-    pinCount: number;
-    getPortPositionByPinNumber(pinNumber: number): PortInfo;
-    getSize(): {
-        width: number;
-        height: number;
-    };
-}
-
 declare class Chip<PinLabels extends string = never> extends NormalComponent<typeof chipProps, PinLabels> {
-    schematicDimensions: SchematicBoxDimensions | null;
+    schematicBoxDimensions: SchematicBoxDimensions | null;
     get config(): {
         componentName: string;
         zodProps: zod.ZodObject<zod.objectUtil.extendShape<zod.objectUtil.extendShape<zod.objectUtil.extendShape<{
@@ -1934,9 +1955,9 @@ declare class Chip<PinLabels extends string = never> extends NormalComponent<typ
             schWidth?: string | number | undefined;
             schHeight?: string | number | undefined;
         }>;
+        shouldRenderAsSchematicBox: boolean;
     };
     doInitialSourceRender(): void;
-    doInitialSchematicComponentRender(): void;
     doInitialPcbComponentRender(): void;
 }
 
@@ -2942,9 +2963,9 @@ declare class Jumper<PinLabels extends string = never> extends NormalComponent<t
             schHeight?: string | number | undefined;
             schDirection?: "left" | "right" | undefined;
         }>;
+        shouldRenderAsSchematicBox: boolean;
     };
     doInitialSourceRender(): void;
-    doInitialSchematicComponentRender(): void;
     doInitialPcbComponentRender(): void;
 }
 
@@ -6234,12 +6255,12 @@ declare class PinHeader extends NormalComponent<typeof pinHeaderProps> {
             doubleRow?: boolean | undefined;
             platedDiameter?: string | number | undefined;
         }>;
-        schematicSymbolName: BaseSymbolName;
+        shouldRenderAsSchematicBox: boolean;
     };
     _getImpliedFootprintString(): string | null;
     initPorts(): void;
+    _getSchematicPortArrangement(): SchematicPortArrangement | null;
     doInitialSourceRender(): void;
-    doInitialSchematicComponentRender(): void;
 }
 
 declare class Inductor extends NormalComponent<typeof inductorProps, PassivePorts> {