@tscircuit/props 0.0.169 → 0.0.171

package/dist/index.d.ts

@@ -5701,7 +5701,77 @@ declare const boardProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.exte
 }>;
 
 type ConnectionTarget = string;
+/**
+ * Defines a mapping of strings to connection paths e.g.
+ *
+ * const connections: Connections = {
+ *   GND: ".U1 > .GND",
+ *   VCC: ".U1 > .VCC",
+ * }
+ *
+ * Connections are used as both inputs and outputs. For example, you might
+ * receive connections when using `sel` to select a chip.
+ *
+ * const u1Connections = sel.U1(MyChip)
+ *
+ * You can also define a module with connections like this:
+ *
+ * export const MyModule = (props: { connections: { GND: string, VCC: string } }) => {
+ *   return (
+ *     <group>
+ *       <capacitor name="C1" connections={{
+ *         anode: props.connections.GND,
+ *         cathode: props.connections.VCC,
+ *       }} />
+ *     </group>
+ *   )
+ * }
+ */
 type Connections<PinLabel extends string = string> = Partial<Record<PinLabel, ConnectionTarget | ConnectionTarget[] | readonly ConnectionTarget[]>>;
+/**
+ * Defines a mapping of strings (usually chip names) to connections e.g.
+ *
+ * const selectors: Selectors = {
+ *   U1: { GND: ".U1 > .GND", VCC: ".U1 > .VCC" },
+ *   U2: {
+ *     GND: ".U2 > .pin1",
+ *     VCC: ".U2 > .pin2",
+ *     CUSTOM_DATA_1: ".U2 > .pin3",
+ *     CUSTOM_DATA_2: ".U2 > .pin4",
+ *   },
+ * }
+ *
+ * A user can also use selectors to define the connections, this is helpful when
+ * there's multiple chips in the group.
+ *
+ * ```tsx
+ * const MyModule = (props: {
+ *   selectors: {
+ *     U1: { GND: string, VCC: string },
+ *     R1: { GND: string, VCC: string }
+ *   }
+ * }) => {
+ *   return (
+ *     <group>
+ *       <resistor name="R1" connections={{
+ *         pin1: props.selectors.R1.GND,
+ *         pin2: props.selectors.R1.VCC,
+ *       }} />
+ *       <capacitor name="C1" connections={{
+ *         anode: props.selectors.U1.GND,
+ *         cathode: props.selectors.U1.VCC,
+ *       }} />
+ *     </group>
+ *   )
+ * }
+ * ```
+ *
+ * These selectors can also be used with "sel":
+ *
+ * sel.M1(MyModule).U1.GND // ".M1 > .C1 > .anode"
+ */
+type Selectors = Record<string, Connections>;
+
 type PinLabelsProp<PinNumber extends string = string, PinLabel extends string = string> = Record<PinNumber, PinLabel | readonly PinLabel[] | PinLabel[]>;
 type PinLabelFromPinLabelMap<PinLabelMap extends PinLabelsProp> = PinLabelMap extends PinLabelsProp<infer PinNumber, infer PinLabel> ? PinLabel : never;
 interface ChipPropsSU<PinLabel extends string = string> extends CommonComponentProps {
@@ -8251,12 +8321,15 @@ declare const platedHoleProps: z.ZodEffects<z.ZodUnion<[z.ZodObject<z.objectUtil
     padShape?: "rect" | undefined;
 }>;
 
+declare const resistorPinLabels: readonly ["pin1", "pin2", "pos", "neg"];
+type ResistorPinLabels = (typeof resistorPinLabels)[number];
 interface ResistorProps extends CommonComponentProps {
     resistance: number | string;
     pullupFor?: string;
     pullupTo?: string;
     pulldownFor?: string;
     pulldownTo?: string;
+    connections?: Connections<ResistorPinLabels>;
 }
 declare const resistorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     pcbX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -8520,6 +8593,7 @@ declare const resistorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
     pullupTo: z.ZodOptional<z.ZodString>;
     pulldownFor: z.ZodOptional<z.ZodString>;
     pulldownTo: z.ZodOptional<z.ZodString>;
+    connections: z.ZodOptional<z.ZodRecord<z.ZodEnum<["pin1", "pin2", "pos", "neg"]>, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>;
 }>, "strip", z.ZodTypeAny, {
     name: string;
     resistance: number;
@@ -8588,6 +8662,7 @@ declare const resistorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
     } | undefined;
     children?: any;
     symbolName?: string | undefined;
+    connections?: Partial<Record<"pin1" | "pin2" | "pos" | "neg", string | readonly string[] | string[]>> | undefined;
     pullupFor?: string | undefined;
     pullupTo?: string | undefined;
     pulldownFor?: string | undefined;
@@ -8662,6 +8737,7 @@ declare const resistorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
     } | undefined;
     children?: any;
     symbolName?: string | undefined;
+    connections?: Partial<Record<"pin1" | "pin2" | "pos" | "neg", string | readonly string[] | string[]>> | undefined;
     pullupFor?: string | undefined;
     pullupTo?: string | undefined;
     pulldownFor?: string | undefined;
@@ -10552,6 +10628,8 @@ declare const stampboardProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil
     innerHoles?: boolean | undefined;
 }>;
 
+declare const capacitorPinLabels: readonly ["pin1", "pin2", "pos", "neg", "anode", "cathode"];
+type CapacitorPinLabels = (typeof capacitorPinLabels)[number];
 interface CapacitorProps extends CommonComponentProps {
     capacitance: number | string;
     maxVoltageRating?: number | string;
@@ -10562,6 +10640,7 @@ interface CapacitorProps extends CommonComponentProps {
     bypassFor?: string;
     bypassTo?: string;
     maxDecouplingTraceLength?: number;
+    connections?: Connections<CapacitorPinLabels>;
 }
 declare const capacitorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     pcbX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -10829,6 +10908,7 @@ declare const capacitorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.
     bypassFor: z.ZodOptional<z.ZodString>;
     bypassTo: z.ZodOptional<z.ZodString>;
     maxDecouplingTraceLength: z.ZodOptional<z.ZodNumber>;
+    connections: z.ZodOptional<z.ZodRecord<z.ZodEnum<["pin1", "pin2", "pos", "neg", "anode", "cathode"]>, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>;
 }>, "strip", z.ZodTypeAny, {
     name: string;
     capacitance: number;
@@ -10899,6 +10979,7 @@ declare const capacitorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.
     } | undefined;
     children?: any;
     symbolName?: string | undefined;
+    connections?: Partial<Record<"pin1" | "pin2" | "anode" | "pos" | "cathode" | "neg", string | readonly string[] | string[]>> | undefined;
     maxVoltageRating?: number | undefined;
     decouplingFor?: string | undefined;
     decouplingTo?: string | undefined;
@@ -10975,6 +11056,7 @@ declare const capacitorProps: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.
     } | undefined;
     children?: any;
     symbolName?: string | undefined;
+    connections?: Partial<Record<"pin1" | "pin2" | "anode" | "pos" | "cathode" | "neg", string | readonly string[] | string[]>> | undefined;
     maxVoltageRating?: string | number | undefined;
     schShowRatings?: boolean | undefined;
     polarized?: boolean | undefined;
@@ -18092,4 +18174,4 @@ declare const platformConfig: z.ZodObject<{
     cloudAutorouterUrl?: string | undefined;
 }>;
 
-export { type AutorouterConfig, type AutorouterProp, type BaseGroupProps, type BaseManualEditEvent, type BaseManualEditEventInput, type BatteryProps, type BoardProps, type CadModelBase, type CadModelJscad, type CadModelObj, type CadModelProp, type CadModelStl, type CapacitorProps, type ChipConnections, type ChipPinLabels, type ChipProps, type ChipPropsSU, type CirclePlatedHoleProps, type CircleSmtPadProps, type CircleSolderPasteProps, type CircularHoleWithRectPlatedProps, type CommonComponentProps, type CommonLayoutProps, type ComponentProps, type ConnectionTarget, type Connections, type ConstrainedLayoutProps, type ConstraintProps, type CrystalProps, type DiodeProps, type Direction, type DirectionAlongEdge, type EditPcbComponentLocationEvent, type EditPcbComponentLocationEventInput, type EditSchematicComponentLocationEvent, type EditSchematicComponentLocationEventInput, type EditTraceHintEvent, type EditTraceHintEventInput, type FabricationNotePathProps, type FabricationNoteTextProps, type Footprint, type FootprintProps, type FootprintPropsInput, type FootprintSoupElements, type GroupProps, type HoleProps, type InductorProps, type InferredChipProps, type InferredConstrainedLayoutProps, type InferredDiodeProps, type InferredHoleProps, type InferredSmtPadProps, type InferredSolderPasteProps, type InferredSwitchProps, type JumperProps, type LayoutConfig, type LedProps, type ManualEditEvent, type ManualEditEventInput, type ManualEditsFile, type ManualEditsFileInput, type ManualPcbPlacement, type ManualPcbPlacementInput, type ManualSchematicPlacement, type ManualSchematicPlacementInput, type ManualTraceHint, type ManualTraceHintInput, type MosfetProps, type NetAliasProps, type NetProps, type NonSubcircuitGroupProps, type OvalPlatedHoleProps, type PartsEngine, type PcbKeepoutProps, type PcbLayoutProps, type PcbRouteCache, type PcbSameXConstraint, type PcbSameYConstraint, type PcbTraceProps, type PcbXDistConstraint, type PcbYDistConstraint, type PillPlatedHoleProps, type PillSmtPadProps, type PinHeaderProps, type PinLabelFromPinLabelMap, type PinLabelsProp, type PinSideDefinition, type PinVariant, type PlatedHoleProps, type PlatformConfig, type PortHints, type PortProps, type PotentiometerPinVariant, type PotentiometerProps, type PowerSourceProps, type PushButtonProps, type RectSmtPadProps, type RectSolderPasteProps, type ResistorProps, type ResonatorPinVariant, type ResonatorProps, type RotatedRectSmtPadProps, type SchematicBoxProps, type SchematicLineProps, type SchematicPathProps, type SchematicPinArrangement, type SchematicPinArrangementWithPinCounts, type SchematicPinArrangementWithSides, type SchematicPinArrangementWithSizes, type SchematicPinStyle, type SchematicPortArrangement, type SchematicPortArrangementWithPinCounts, type SchematicPortArrangementWithSides, type SchematicPortArrangementWithSizes, type SchematicTextProps, type SilkscreenCircleProps, type SilkscreenLineProps, type SilkscreenPathProps, type SilkscreenRectProps, type SilkscreenTextProps, type SmtPadProps, type SolderPasteProps, type StampboardProps, type SubcircuitGroupProps, type SubcircuitGroupPropsWithBool, type SubcircuitProps, type SupplierName, type SupplierPartNumbers, type SupplierProps, type SwitchProps, type TraceHintProps, type TraceProps, type TransistorProps, type ViaProps, autorouterConfig, autorouterProp, baseGroupProps, base_manual_edit_event, batteryPins, batteryProps, boardProps, bugProps, cadModelBase, cadModelJscad, cadModelObj, cadModelProp, cadModelStl, capacitorPins, capacitorProps, chipProps, circleSmtPadProps, circleSolderPasteProps, commonComponentProps, commonLayoutProps, componentProps, constrainedLayoutProps, constraintProps, crystalPins, crystalProps, diodePins, diodeProps, direction, directionAlongEdge, distanceOrMultiplier, edit_component_location_event, edit_pcb_component_location_event, edit_schematic_component_location_event, edit_trace_hint_event, explicitPinSideDefinition, fabricationNotePathProps, fabricationNoteTextProps, footprintProp, footprintProps, groupProps, holeProps, inductorPins, inductorProps, jumperProps, layoutConfig, ledPins, ledProps, lrPins, lrPolarPins, manual_edit_event, manual_edits_file, manual_pcb_placement, manual_schematic_placement, manual_trace_hint, mosfetPins, mosfetProps, netAliasProps, netProps, partsEngine, pcbKeepoutProps, pcbLayoutProps, pcbSameXConstraintProps, pcbSameYConstraintProps, pcbTraceProps, pcbXDistConstraintProps, pcbYDistConstraintProps, pillSmtPadProps, pinHeaderProps, pinLabelsProp, platedHoleProps, platformConfig, point3, portHints, portProps, portRef, potentiometerProps, powerSourceProps, pushButtonProps, rectSmtPadProps, rectSolderPasteProps, resistorPins, resistorProps, resonatorProps, rotatedRectSmtPadProps, rotationPoint3, routeHintPointProps, schematicBoxProps, schematicLineProps, schematicPathProps, schematicPinArrangement, schematicPinStyle, schematicPortArrangement, schematicTextProps, silkscreenCircleProps, silkscreenLineProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, solderPasteProps, stampboardProps, subcircuitGroupProps, subcircuitGroupPropsWithBool, subcircuitProps, supplierProps, switchProps, traceHintProps, traceProps, transistorPins, transistorProps, viaProps };
+export { type AutorouterConfig, type AutorouterProp, type BaseGroupProps, type BaseManualEditEvent, type BaseManualEditEventInput, type BatteryProps, type BoardProps, type CadModelBase, type CadModelJscad, type CadModelObj, type CadModelProp, type CadModelStl, type CapacitorPinLabels, type CapacitorProps, type ChipConnections, type ChipPinLabels, type ChipProps, type ChipPropsSU, type CirclePlatedHoleProps, type CircleSmtPadProps, type CircleSolderPasteProps, type CircularHoleWithRectPlatedProps, type CommonComponentProps, type CommonLayoutProps, type ComponentProps, type ConnectionTarget, type Connections, type ConstrainedLayoutProps, type ConstraintProps, type CrystalProps, type DiodeProps, type Direction, type DirectionAlongEdge, type EditPcbComponentLocationEvent, type EditPcbComponentLocationEventInput, type EditSchematicComponentLocationEvent, type EditSchematicComponentLocationEventInput, type EditTraceHintEvent, type EditTraceHintEventInput, type FabricationNotePathProps, type FabricationNoteTextProps, type Footprint, type FootprintProps, type FootprintPropsInput, type FootprintSoupElements, type GroupProps, type HoleProps, type InductorProps, type InferredChipProps, type InferredConstrainedLayoutProps, type InferredDiodeProps, type InferredHoleProps, type InferredSmtPadProps, type InferredSolderPasteProps, type InferredSwitchProps, type JumperProps, type LayoutConfig, type LedProps, type ManualEditEvent, type ManualEditEventInput, type ManualEditsFile, type ManualEditsFileInput, type ManualPcbPlacement, type ManualPcbPlacementInput, type ManualSchematicPlacement, type ManualSchematicPlacementInput, type ManualTraceHint, type ManualTraceHintInput, type MosfetProps, type NetAliasProps, type NetProps, type NonSubcircuitGroupProps, type OvalPlatedHoleProps, type PartsEngine, type PcbKeepoutProps, type PcbLayoutProps, type PcbRouteCache, type PcbSameXConstraint, type PcbSameYConstraint, type PcbTraceProps, type PcbXDistConstraint, type PcbYDistConstraint, type PillPlatedHoleProps, type PillSmtPadProps, type PinHeaderProps, type PinLabelFromPinLabelMap, type PinLabelsProp, type PinSideDefinition, type PinVariant, type PlatedHoleProps, type PlatformConfig, type PortHints, type PortProps, type PotentiometerPinVariant, type PotentiometerProps, type PowerSourceProps, type PushButtonProps, type RectSmtPadProps, type RectSolderPasteProps, type ResistorPinLabels, type ResistorProps, type ResonatorPinVariant, type ResonatorProps, type RotatedRectSmtPadProps, type SchematicBoxProps, type SchematicLineProps, type SchematicPathProps, type SchematicPinArrangement, type SchematicPinArrangementWithPinCounts, type SchematicPinArrangementWithSides, type SchematicPinArrangementWithSizes, type SchematicPinStyle, type SchematicPortArrangement, type SchematicPortArrangementWithPinCounts, type SchematicPortArrangementWithSides, type SchematicPortArrangementWithSizes, type SchematicTextProps, type Selectors, type SilkscreenCircleProps, type SilkscreenLineProps, type SilkscreenPathProps, type SilkscreenRectProps, type SilkscreenTextProps, type SmtPadProps, type SolderPasteProps, type StampboardProps, type SubcircuitGroupProps, type SubcircuitGroupPropsWithBool, type SubcircuitProps, type SupplierName, type SupplierPartNumbers, type SupplierProps, type SwitchProps, type TraceHintProps, type TraceProps, type TransistorProps, type ViaProps, autorouterConfig, autorouterProp, baseGroupProps, base_manual_edit_event, batteryPins, batteryProps, boardProps, bugProps, cadModelBase, cadModelJscad, cadModelObj, cadModelProp, cadModelStl, capacitorPinLabels, capacitorPins, capacitorProps, chipProps, circleSmtPadProps, circleSolderPasteProps, commonComponentProps, commonLayoutProps, componentProps, constrainedLayoutProps, constraintProps, crystalPins, crystalProps, diodePins, diodeProps, direction, directionAlongEdge, distanceOrMultiplier, edit_component_location_event, edit_pcb_component_location_event, edit_schematic_component_location_event, edit_trace_hint_event, explicitPinSideDefinition, fabricationNotePathProps, fabricationNoteTextProps, footprintProp, footprintProps, groupProps, holeProps, inductorPins, inductorProps, jumperProps, layoutConfig, ledPins, ledProps, lrPins, lrPolarPins, manual_edit_event, manual_edits_file, manual_pcb_placement, manual_schematic_placement, manual_trace_hint, mosfetPins, mosfetProps, netAliasProps, netProps, partsEngine, pcbKeepoutProps, pcbLayoutProps, pcbSameXConstraintProps, pcbSameYConstraintProps, pcbTraceProps, pcbXDistConstraintProps, pcbYDistConstraintProps, pillSmtPadProps, pinHeaderProps, pinLabelsProp, platedHoleProps, platformConfig, point3, portHints, portProps, portRef, potentiometerProps, powerSourceProps, pushButtonProps, rectSmtPadProps, rectSolderPasteProps, resistorPinLabels, resistorPins, resistorProps, resonatorProps, rotatedRectSmtPadProps, rotationPoint3, routeHintPointProps, schematicBoxProps, schematicLineProps, schematicPathProps, schematicPinArrangement, schematicPinStyle, schematicPortArrangement, schematicTextProps, silkscreenCircleProps, silkscreenLineProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, solderPasteProps, stampboardProps, subcircuitGroupProps, subcircuitGroupPropsWithBool, subcircuitProps, supplierProps, switchProps, traceHintProps, traceProps, transistorPins, transistorProps, viaProps };