@tscircuit/props 0.0.490 → 0.0.492

package/lib/common/layout.ts

@@ -20,6 +20,7 @@ import {
 } from "./kicadSymbolMetadata"
 import { type PcbStyle, pcbStyle } from "./pcbStyle"
 import { type PcbSx, pcbSx } from "./pcbSx"
+import { pinAttributeMap, type PinAttributeMap } from "./pinAttributeMap"
 import { type SchStyle, schStyle } from "./schStyle"
 import { type SymbolProp, symbolProp } from "./symbolProp"
 import { url } from "./url"
@@ -229,129 +230,6 @@ export const supplierProps = z.object({
 
 expectTypesMatch<SupplierProps, z.input<typeof supplierProps>>(true)
 
-export interface PinAttributeMap {
-  capabilities?: Array<
-    | "i2c_sda"
-    | "i2c_scl"
-    | "spi_cs"
-    | "spi_sck"
-    | "spi_mosi"
-    | "spi_miso"
-    | "uart_tx"
-    | "uart_rx"
-  >
-  activeCapabilities?: Array<
-    | "i2c_sda"
-    | "i2c_scl"
-    | "spi_cs"
-    | "spi_sck"
-    | "spi_mosi"
-    | "spi_miso"
-    | "uart_tx"
-    | "uart_rx"
-  >
-  activeCapability?:
-    | "i2c_sda"
-    | "i2c_scl"
-    | "spi_cs"
-    | "spi_sck"
-    | "spi_mosi"
-    | "spi_miso"
-    | "uart_tx"
-    | "uart_rx"
-  providesPower?: boolean
-  requiresPower?: boolean
-  providesGround?: boolean
-  requiresGround?: boolean
-  providesVoltage?: string | number
-  requiresVoltage?: string | number
-  doNotConnect?: boolean
-  includeInBoardPinout?: boolean
-  highlightColor?: string
-  mustBeConnected?: boolean
-  canUseInternalPullup?: boolean
-  isUsingInternalPullup?: boolean
-  needsExternalPullup?: boolean
-  canUseInternalPulldown?: boolean
-  isUsingInternalPulldown?: boolean
-  needsExternalPulldown?: boolean
-  canUseOpenDrain?: boolean
-  isUsingOpenDrain?: boolean
-  canUsePushPull?: boolean
-  isUsingPushPull?: boolean
-  shouldHaveDecouplingCapacitor?: boolean
-  recommendedDecouplingCapacitorCapacitance?: string | number
-}
-
-export const pinAttributeMap = z.object({
-  capabilities: z
-    .array(
-      z.enum([
-        "i2c_sda",
-        "i2c_scl",
-        "spi_cs",
-        "spi_sck",
-        "spi_mosi",
-        "spi_miso",
-        "uart_tx",
-        "uart_rx",
-      ]),
-    )
-    .optional(),
-  activeCapabilities: z
-    .array(
-      z.enum([
-        "i2c_sda",
-        "i2c_scl",
-        "spi_cs",
-        "spi_sck",
-        "spi_mosi",
-        "spi_miso",
-        "uart_tx",
-        "uart_rx",
-      ]),
-    )
-    .optional(),
-  activeCapability: z
-    .enum([
-      "i2c_sda",
-      "i2c_scl",
-      "spi_cs",
-      "spi_sck",
-      "spi_mosi",
-      "spi_miso",
-      "uart_tx",
-      "uart_rx",
-    ])
-    .optional(),
-  providesPower: z.boolean().optional(),
-  requiresPower: z.boolean().optional(),
-  providesGround: z.boolean().optional(),
-  requiresGround: z.boolean().optional(),
-  providesVoltage: z.union([z.string(), z.number()]).optional(),
-  requiresVoltage: z.union([z.string(), z.number()]).optional(),
-  doNotConnect: z.boolean().optional(),
-  includeInBoardPinout: z.boolean().optional(),
-  highlightColor: z.string().optional(),
-  mustBeConnected: z.boolean().optional(),
-  canUseInternalPullup: z.boolean().optional(),
-  isUsingInternalPullup: z.boolean().optional(),
-  needsExternalPullup: z.boolean().optional(),
-  canUseInternalPulldown: z.boolean().optional(),
-  isUsingInternalPulldown: z.boolean().optional(),
-  needsExternalPulldown: z.boolean().optional(),
-  canUseOpenDrain: z.boolean().optional(),
-  isUsingOpenDrain: z.boolean().optional(),
-  canUsePushPull: z.boolean().optional(),
-  isUsingPushPull: z.boolean().optional(),
-  shouldHaveDecouplingCapacitor: z.boolean().optional(),
-  recommendedDecouplingCapacitorCapacitance: z
-    .union([z.string(), z.number()])
-    .optional(),
-})
-
-expectTypesMatch<PinAttributeMap, z.input<typeof pinAttributeMap>>(true)
-
 export interface CommonComponentProps<PinLabel extends string = string>
   extends CommonLayoutProps {
   key?: any

package/lib/common/pinAttributeMap.ts

@@ -0,0 +1,77 @@
+import { z } from "zod"
+import { expectTypesMatch } from "../typecheck"
+
+export const pinCapability = z.enum([
+  "i2c_sda",
+  "i2c_scl",
+  "spi_cs",
+  "spi_sck",
+  "spi_mosi",
+  "spi_miso",
+  "uart_tx",
+  "uart_rx",
+])
+
+export type PinCapability = z.input<typeof pinCapability>
+
+export interface PinAttributeMap {
+  capabilities?: Array<PinCapability>
+  activeCapabilities?: Array<PinCapability>
+  activeCapability?: PinCapability
+  providesPower?: boolean
+  requiresPower?: boolean
+  providesGround?: boolean
+  requiresGround?: boolean
+  providesVoltage?: string | number
+  requiresVoltage?: string | number
+  doNotConnect?: boolean
+  includeInBoardPinout?: boolean
+  highlightColor?: string
+  mustBeConnected?: boolean
+  canUseInternalPullup?: boolean
+  isUsingInternalPullup?: boolean
+  needsExternalPullup?: boolean
+  canUseInternalPulldown?: boolean
+  isUsingInternalPulldown?: boolean
+  needsExternalPulldown?: boolean
+  canUseOpenDrain?: boolean
+  isUsingOpenDrain?: boolean
+  canUsePushPull?: boolean
+  isUsingPushPull?: boolean
+  shouldHaveDecouplingCapacitor?: boolean
+  recommendedDecouplingCapacitorCapacitance?: string | number
+  isGpio?: boolean
+}
+
+export const pinAttributeMap = z.object({
+  capabilities: z.array(pinCapability).optional(),
+  activeCapabilities: z.array(pinCapability).optional(),
+  activeCapability: pinCapability.optional(),
+  providesPower: z.boolean().optional(),
+  requiresPower: z.boolean().optional(),
+  providesGround: z.boolean().optional(),
+  requiresGround: z.boolean().optional(),
+  providesVoltage: z.union([z.string(), z.number()]).optional(),
+  requiresVoltage: z.union([z.string(), z.number()]).optional(),
+  doNotConnect: z.boolean().optional(),
+  includeInBoardPinout: z.boolean().optional(),
+  highlightColor: z.string().optional(),
+  mustBeConnected: z.boolean().optional(),
+  canUseInternalPullup: z.boolean().optional(),
+  isUsingInternalPullup: z.boolean().optional(),
+  needsExternalPullup: z.boolean().optional(),
+  canUseInternalPulldown: z.boolean().optional(),
+  isUsingInternalPulldown: z.boolean().optional(),
+  needsExternalPulldown: z.boolean().optional(),
+  canUseOpenDrain: z.boolean().optional(),
+  isUsingOpenDrain: z.boolean().optional(),
+  canUsePushPull: z.boolean().optional(),
+  isUsingPushPull: z.boolean().optional(),
+  shouldHaveDecouplingCapacitor: z.boolean().optional(),
+  recommendedDecouplingCapacitorCapacitance: z
+    .union([z.string(), z.number()])
+    .optional(),
+  isGpio: z.boolean().optional(),
+})
+
+expectTypesMatch<PinAttributeMap, z.input<typeof pinAttributeMap>>(true)

package/lib/components/platedhole.ts

@@ -121,6 +121,51 @@ export type PlatedHoleProps =
   | PillWithRectPadPlatedHoleProps
   | HoleWithPolygonPadPlatedHoleProps
 
+const DEFAULT_PIN_HEADER_HOLE_DIAMETER = "0.04in"
+const DEFAULT_PIN_HEADER_OUTER_DIAMETER = "0.1in"
+
+const inferPlatedHoleShapeAndDefaults = (rawProps: unknown): unknown => {
+  if (!rawProps || typeof rawProps !== "object") return rawProps
+
+  const props = { ...(rawProps as Record<string, unknown>) }
+
+  if (props.shape !== undefined) return props
+
+  if (props.padOutline !== undefined) {
+    props.shape = "hole_with_polygon_pad"
+    return props
+  }
+
+  if (props.rectPadWidth !== undefined || props.rectPadHeight !== undefined) {
+    if (props.holeDiameter !== undefined) {
+      props.shape = "circular_hole_with_rect_pad"
+      return props
+    }
+
+    props.shape = "pill_hole_with_rect_pad"
+    return props
+  }
+
+  if (
+    props.outerDiameter !== undefined ||
+    props.holeDiameter !== undefined ||
+    props.padDiameter !== undefined
+  ) {
+    props.shape = "circle"
+    return props
+  }
+
+  if (props.outerWidth !== undefined || props.outerHeight !== undefined) {
+    props.shape = props.rectPad === true ? "pill" : "oval"
+    return props
+  }
+
+  props.shape = "circle"
+  props.holeDiameter = DEFAULT_PIN_HEADER_HOLE_DIAMETER
+  props.outerDiameter = DEFAULT_PIN_HEADER_OUTER_DIAMETER
+  return props
+}
+
 const distanceHiddenUndefined = z
   .custom<z.input<typeof distance>>()
   .transform((a) => {
@@ -128,7 +173,7 @@ const distanceHiddenUndefined = z
     return distance.parse(a)
   })
 
-export const platedHoleProps = z
+const platedHolePropsByShape = z
   .discriminatedUnion("shape", [
     pcbLayoutProps.omit({ pcbRotation: true, layer: true }).extend({
       name: z.string().optional(),
@@ -220,7 +265,7 @@ export const platedHoleProps = z
       coveredWithSolderMask: z.boolean().optional(),
     }),
   ])
-  .refine((a) => {
+  .transform((a) => {
     if ("innerWidth" in a && a.innerWidth !== undefined) {
       a.holeWidth ??= a.innerWidth
     }
@@ -230,6 +275,11 @@ export const platedHoleProps = z
     return a
   })
 
-type InferredPlatedHoleProps = z.input<typeof platedHoleProps>
+export const platedHoleProps = z.preprocess(
+  inferPlatedHoleShapeAndDefaults,
+  platedHolePropsByShape,
+)
+
+type InferredPlatedHoleProps = z.input<typeof platedHolePropsByShape>
 
 expectTypesMatch<PlatedHoleProps, InferredPlatedHoleProps>(true)

package/lib/index.ts

@@ -1,6 +1,7 @@
 export * from "./common/direction"
 export * from "./common/portHints"
 export * from "./common/layout"
+export * from "./common/pinAttributeMap"
 export * from "./common/point3"
 export * from "./common/portHints"
 export * from "./common/footprintProp"

package/package.json

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