@tscircuit/props 0.0.529 → 0.0.531

package/README.md

@@ -234,8 +234,9 @@ export interface AutoroutingPhaseProps extends RoutingTolerances {
 ### BatteryProps `<battery />`
 
 ```ts
-export interface BatteryProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface BatteryProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   capacity?: number | string;
   voltage?: number | string;
   standard?: "AA" | "AAA" | "9V" | "CR2032" | "18650" | "C";
@@ -248,8 +249,10 @@ export interface BatteryProps<PinLabel extends string = string>
 ### BoardProps `<board />`
 
 ```ts
-export interface BoardProps
-  extends Omit<SubcircuitGroupProps, "subcircuit" | "connections"> {
+export interface BoardProps extends Omit<
+  SubcircuitGroupProps,
+  "subcircuit" | "connections"
+> {
   title?: string;
   material?: "fr4" | "fr1" | "flex";
   /** Number of layers for the PCB */
@@ -283,8 +286,10 @@ export interface BoardProps
 ### BreakoutProps `<breakout />`
 
 ```ts
-export interface BreakoutProps
-  extends Omit<SubcircuitGroupProps, "subcircuit"> {
+export interface BreakoutProps extends Omit<
+  SubcircuitGroupProps,
+  "subcircuit"
+> {
   padding?: Distance;
   paddingLeft?: Distance;
   paddingRight?: Distance;
@@ -298,8 +303,10 @@ export interface BreakoutProps
 ### BreakoutPointProps `<breakoutpoint />`
 
 ```ts
-export interface BreakoutPointProps
-  extends Omit<PcbLayoutProps, "pcbRotation" | "layer"> {
+export interface BreakoutPointProps extends Omit<
+  PcbLayoutProps,
+  "pcbRotation" | "layer"
+> {
   connection: string;
 }
 ```
@@ -351,8 +358,9 @@ export interface CadModelProps extends CadModelBase {
 ### CapacitorProps `<capacitor />`
 
 ```ts
-export interface CapacitorProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface CapacitorProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   capacitance: number | string;
   maxVoltageRating?: number | string;
   schShowRatings?: boolean;
@@ -513,8 +521,9 @@ export type CourtyardRectProps = z.input<typeof courtyardRectProps>;
 ### CrystalProps `<crystal />`
 
 ```ts
-export interface CrystalProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface CrystalProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   frequency: number | string;
   loadCapacitance: number | string;
   manufacturerPartNumber?: string;
@@ -530,8 +539,9 @@ export interface CrystalProps<PinLabel extends string = string>
 ### CurrentSourceProps `<currentsource />`
 
 ```ts
-export interface CurrentSourceProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface CurrentSourceProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   current?: number | string;
   frequency?: number | string;
   peakToPeakCurrent?: number | string;
@@ -547,8 +557,10 @@ export interface CurrentSourceProps<PinLabel extends string = string>
 ### RectCutoutProps `<cutout />`
 
 ```ts
-export interface RectCutoutProps
-  extends Omit<PcbLayoutProps, "layer" | "pcbRotation"> {
+export interface RectCutoutProps extends Omit<
+  PcbLayoutProps,
+  "layer" | "pcbRotation"
+> {
   name?: string;
   shape: "rect";
   width: Distance;
@@ -561,8 +573,9 @@ export interface RectCutoutProps
 ### DiodeProps `<diode />`
 
 ```ts
-export interface DiodeProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface DiodeProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   connections?: {
     anode?: string | string[] | readonly string[];
     cathode?: string | string[] | readonly string[];
@@ -587,19 +600,18 @@ export interface DiodeProps<PinLabel extends string = string>
 ### FabricationNoteDimensionProps `<fabricationnotedimension />`
 
 ```ts
-export interface FabricationNoteDimensionProps
-  extends Omit<
-    PcbLayoutProps,
-    | "pcbLeftEdgeX"
-    | "pcbRightEdgeX"
-    | "pcbTopEdgeY"
-    | "pcbBottomEdgeY"
-    | "pcbX"
-    | "pcbY"
-    | "pcbOffsetX"
-    | "pcbOffsetY"
-    | "pcbRotation"
-  > {
+export interface FabricationNoteDimensionProps extends Omit<
+  PcbLayoutProps,
+  | "pcbLeftEdgeX"
+  | "pcbRightEdgeX"
+  | "pcbTopEdgeY"
+  | "pcbBottomEdgeY"
+  | "pcbX"
+  | "pcbY"
+  | "pcbOffsetX"
+  | "pcbOffsetY"
+  | "pcbRotation"
+> {
   from: string | Point;
   to: string | Point;
   text?: string;
@@ -700,8 +712,9 @@ export interface FootprintProps {
 ### FuseProps `<fuse />`
 
 ```ts
-export interface FuseProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface FuseProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   /**
    * Current rating of the fuse in amperes
    */
@@ -879,8 +892,9 @@ export interface CircleHoleProps extends PcbLayoutProps {
 ### InductorProps `<inductor />`
 
 ```ts
-export interface InductorProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface InductorProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   inductance: number | string;
   maxCurrentRating?: number | string;
   schOrientation?: SchematicOrientation;
@@ -962,8 +976,9 @@ export type LedProps = z.input<typeof ledProps>;
 ### MosfetProps `<mosfet />`
 
 ```ts
-export interface MosfetProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface MosfetProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   channelType: "n" | "p";
   mosfetMode: "enhancement" | "depletion";
 }
@@ -975,8 +990,7 @@ export interface MosfetProps<PinLabel extends string = string>
 
 ```ts
 export interface MountedBoardProps
-  extends SubcircuitGroupProps,
-    MountedBoardChipProps {
+  extends SubcircuitGroupProps, MountedBoardChipProps {
   boardToBoardDistance?: Distance;
   mountOrientation?: "faceDown" | "faceUp";
 }
@@ -1033,8 +1047,9 @@ export interface NetLabelProps {
 ### OpAmpProps `<opamp />`
 
 ```ts
-export interface OpAmpProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface OpAmpProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   connections?: Connections<OpAmpPinLabels>;
 }
 ```
@@ -1044,8 +1059,10 @@ export interface OpAmpProps<PinLabel extends string = string>
 ### PanelProps `<panel />`
 
 ```ts
-export interface PanelProps
-  extends Omit<BaseGroupProps, "height" | "layoutMode" | "width"> {
+export interface PanelProps extends Omit<
+  BaseGroupProps,
+  "height" | "layoutMode" | "width"
+> {
   width?: Distance;
   height?: Distance;
   children?: BaseGroupProps["children"];
@@ -1088,19 +1105,18 @@ export type PcbKeepoutProps = z.input<typeof pcbKeepoutProps>;
 ### PcbNoteDimensionProps `<pcbnotedimension />`
 
 ```ts
-export interface PcbNoteDimensionProps
-  extends Omit<
-    PcbLayoutProps,
-    | "pcbLeftEdgeX"
-    | "pcbRightEdgeX"
-    | "pcbTopEdgeY"
-    | "pcbBottomEdgeY"
-    | "pcbX"
-    | "pcbY"
-    | "pcbOffsetX"
-    | "pcbOffsetY"
-    | "pcbRotation"
-  > {
+export interface PcbNoteDimensionProps extends Omit<
+  PcbLayoutProps,
+  | "pcbLeftEdgeX"
+  | "pcbRightEdgeX"
+  | "pcbTopEdgeY"
+  | "pcbBottomEdgeY"
+  | "pcbX"
+  | "pcbY"
+  | "pcbOffsetX"
+  | "pcbOffsetY"
+  | "pcbRotation"
+> {
   from: string | Point;
   to: string | Point;
   text?: string;
@@ -1121,19 +1137,18 @@ export interface PcbNoteDimensionProps
 ### PcbNoteLineProps `<pcbnoteline />`
 
 ```ts
-export interface PcbNoteLineProps
-  extends Omit<
-    PcbLayoutProps,
-    | "pcbLeftEdgeX"
-    | "pcbRightEdgeX"
-    | "pcbTopEdgeY"
-    | "pcbBottomEdgeY"
-    | "pcbX"
-    | "pcbY"
-    | "pcbOffsetX"
-    | "pcbOffsetY"
-    | "pcbRotation"
-  > {
+export interface PcbNoteLineProps extends Omit<
+  PcbLayoutProps,
+  | "pcbLeftEdgeX"
+  | "pcbRightEdgeX"
+  | "pcbTopEdgeY"
+  | "pcbBottomEdgeY"
+  | "pcbX"
+  | "pcbY"
+  | "pcbOffsetX"
+  | "pcbOffsetY"
+  | "pcbRotation"
+> {
   x1: string | number;
   y1: string | number;
   x2: string | number;
@@ -1149,19 +1164,18 @@ export interface PcbNoteLineProps
 ### PcbNotePathProps `<pcbnotepath />`
 
 ```ts
-export interface PcbNotePathProps
-  extends Omit<
-    PcbLayoutProps,
-    | "pcbLeftEdgeX"
-    | "pcbRightEdgeX"
-    | "pcbTopEdgeY"
-    | "pcbBottomEdgeY"
-    | "pcbX"
-    | "pcbY"
-    | "pcbOffsetX"
-    | "pcbOffsetY"
-    | "pcbRotation"
-  > {
+export interface PcbNotePathProps extends Omit<
+  PcbLayoutProps,
+  | "pcbLeftEdgeX"
+  | "pcbRightEdgeX"
+  | "pcbTopEdgeY"
+  | "pcbBottomEdgeY"
+  | "pcbX"
+  | "pcbY"
+  | "pcbOffsetX"
+  | "pcbOffsetY"
+  | "pcbRotation"
+> {
   route: RouteHintPointInput[];
   strokeWidth?: string | number;
   color?: string;
@@ -1321,8 +1335,10 @@ export interface PinHeaderProps extends CommonComponentProps {
 ### CirclePlatedHoleProps `<platedhole />`
 
 ```ts
-export interface CirclePlatedHoleProps
-  extends Omit<PcbLayoutProps, "pcbRotation" | "layer"> {
+export interface CirclePlatedHoleProps extends Omit<
+  PcbLayoutProps,
+  "pcbRotation" | "layer"
+> {
   name?: string;
   connectsTo?: string | string[];
   shape: "circle";
@@ -1348,8 +1364,9 @@ export type PortProps = z.input<typeof portProps>;
 ### PotentiometerProps `<potentiometer />`
 
 ```ts
-export interface PotentiometerProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface PotentiometerProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   maxResistance: number | string;
   pinVariant?: PotentiometerPinVariant;
   connections?: Connections<PotentiometerPinLabels>;
@@ -1378,8 +1395,9 @@ export type PushButtonProps<T extends PinLabelsProp | string = string> =
 ### ResistorProps `<resistor />`
 
 ```ts
-export interface ResistorProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface ResistorProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   resistance: number | string;
   tolerance?: number | string;
   pullupFor?: string;
@@ -1668,8 +1686,10 @@ export interface SolderJumperProps extends JumperProps {
 ### RectSolderPasteProps `<solderpaste />`
 
 ```ts
-export interface RectSolderPasteProps
-  extends Omit<PcbLayoutProps, "pcbRotation"> {
+export interface RectSolderPasteProps extends Omit<
+  PcbLayoutProps,
+  "pcbRotation"
+> {
   shape: "rect";
   width: Distance;
   height: Distance;
@@ -1808,8 +1828,9 @@ export type TraceHintProps = z.input<typeof traceHintProps>;
 ### TransistorProps `<transistor />`
 
 ```ts
-export interface TransistorProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface TransistorProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   type: "npn" | "pnp" | "bjt" | "jfet" | "mosfet" | "igbt";
   connections?: Connections<transistorPinsLabels>;
 }
@@ -1849,8 +1870,9 @@ export interface VoltageProbeProps extends Omit<CommonComponentProps, "name"> {
 ### VoltageSourceProps `<voltagesource />`
 
 ```ts
-export interface VoltageSourceProps<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface VoltageSourceProps<
+  PinLabel extends string = string,
+> extends CommonComponentProps<PinLabel> {
   voltage?: number | string;
   frequency?: number | string;
   peakToPeakVoltage?: number | string;
@@ -1911,7 +1933,7 @@ export interface PlatformConfig {
   spiceEngineMap?: Record<string, SpiceEngine>;
 
   footprintLibraryMap?: Record<
-    string,
+    FootprintLibraryPrefix,
     | ((
         path: string,
         options?: { resolvedPcbStyle?: PcbStyle },
@@ -1926,7 +1948,12 @@ export interface PlatformConfig {
       >
   >;
 
-  footprintFileParserMap?: Record<string, FootprintFileParserEntry>;
+  footprintFileParserMap?: Record<FileExtension, FootprintFileParserEntry>;
+
+  staticFileLoaderMap?: Record<
+    FileExtension,
+    (fileContent: FileContent) => Promise<EsModuleImportResult>
+  >;
 
   resolveProjectStaticFileImportUrl?: (path: string) => Promise<string>;
   nodeModulesResolver?: (modulePath: string) => Promise<string | null>;
@@ -1945,18 +1972,17 @@ export interface PlatformConfig {
 ### ProjectConfig
 
 ```ts
-export interface ProjectConfig
-  extends Pick<
-    PlatformConfig,
-    | "projectName"
-    | "projectBaseUrl"
-    | "version"
-    | "url"
-    | "printBoardInformationToSilkscreen"
-    | "includeBoardFiles"
-    | "snapshotsDir"
-    | "defaultSpiceEngine"
-  > {}
+export interface ProjectConfig extends Pick<
+  PlatformConfig,
+  | "projectName"
+  | "projectBaseUrl"
+  | "version"
+  | "url"
+  | "printBoardInformationToSilkscreen"
+  | "includeBoardFiles"
+  | "snapshotsDir"
+  | "defaultSpiceEngine"
+> {}
 ```
 
 [Source](https://github.com/tscircuit/props/blob/main/lib/projectConfig.ts)