@tscircuit/props 0.0.169 → 0.0.171

package/lib/components/resistor.ts

@@ -1,18 +1,24 @@
 import { resistance } from "circuit-json"
+import { createConnectionsProp } from "lib/common/connectionsProp"
 import {
   type CommonComponentProps,
   commonComponentProps,
   lrPins,
 } from "lib/common/layout"
 import { expectTypesMatch } from "lib/typecheck"
+import type { Connections } from "lib/utility-types/connections-and-selectors"
 import { z } from "zod"
 
+export const resistorPinLabels = ["pin1", "pin2", "pos", "neg"] as const
+export type ResistorPinLabels = (typeof resistorPinLabels)[number]
+
 export interface ResistorProps extends CommonComponentProps {
   resistance: number | string
   pullupFor?: string
   pullupTo?: string
   pulldownFor?: string
   pulldownTo?: string
+  connections?: Connections<ResistorPinLabels>
 }
 
 export const resistorProps = commonComponentProps.extend({
@@ -23,6 +29,8 @@ export const resistorProps = commonComponentProps.extend({
 
   pulldownFor: z.string().optional(),
   pulldownTo: z.string().optional(),
+
+  connections: createConnectionsProp(resistorPinLabels).optional(),
 })
 export const resistorPins = lrPins
 

package/lib/index.ts

@@ -58,3 +58,4 @@ export * from "./components/silkscreen-circle"
 export * from "./components/trace-hint"
 export * from "./components/port"
 export * from "./platformConfig"
+export * from "./utility-types/connections-and-selectors"

package/lib/utility-types/connections-and-selectors.ts

@@ -0,0 +1,77 @@
+export 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>
+ *   )
+ * }
+ */
+export 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"
+ */
+export type Selectors = Record<string, Connections>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.169",
+  "version": "0.0.171",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",