@tscircuit/props 0.0.258 → 0.0.259

package/lib/common/schematicPinLabel.ts

@@ -0,0 +1,8 @@
+import { z } from "zod"
+
+/**
+ * Valid pin label string. Must consist only of letters,
+ * numbers, or underscores.
+ */
+export const schematicPinLabel = z.string().regex(/^[A-Za-z0-9_]+$/)
+export type SchematicPinLabel = z.infer<typeof schematicPinLabel>

package/lib/components/chip.ts

@@ -13,6 +13,10 @@ import {
   type SchematicPinStyle,
   schematicPinStyle,
 } from "lib/common/schematicPinStyle"
+import {
+  schematicPinLabel,
+  type SchematicPinLabel,
+} from "lib/common/schematicPinLabel"
 import { expectTypesMatch } from "lib/typecheck"
 import type { Connections } from "lib/utility-types/connections-and-selectors"
 import { z } from "zod"
@@ -32,10 +36,11 @@ export interface PinCompatibleVariant {
   supplierPartNumber?: SupplierPartNumbers
 }
 
-export interface ChipPropsSU<PinLabel extends string = string>
-  extends CommonComponentProps<PinLabel> {
+export interface ChipPropsSU<
+  PinLabel extends SchematicPinLabel = SchematicPinLabel,
+> extends CommonComponentProps<PinLabel> {
   manufacturerPartNumber?: string
-  pinLabels?: PinLabelsProp<string, PinLabel>
+  pinLabels?: PinLabelsProp<SchematicPinLabel, PinLabel>
   /**
    * Whether to show pin aliases in the schematic
    */
@@ -115,8 +120,10 @@ const connectionsProp = z
   .pipe(z.record(z.string(), connectionTarget))
 
 export const pinLabelsProp = z.record(
-  z.string(),
-  z.string().or(z.array(z.string()).readonly()).or(z.array(z.string())),
+  schematicPinLabel,
+  schematicPinLabel
+    .or(z.array(schematicPinLabel).readonly())
+    .or(z.array(schematicPinLabel)),
 )
 
 expectTypesMatch<PinLabelsProp, z.input<typeof pinLabelsProp>>(true)

package/lib/components/connector.ts

@@ -11,12 +11,19 @@ import {
   type SchematicPinStyle,
   schematicPinStyle,
 } from "lib/common/schematicPinStyle"
+import {
+  schematicPinLabel,
+  type SchematicPinLabel,
+} from "lib/common/schematicPinLabel"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export interface ConnectorProps extends CommonComponentProps {
   manufacturerPartNumber?: string
-  pinLabels?: Record<number | string, string | string[]>
+  pinLabels?: Record<
+    number | SchematicPinLabel,
+    SchematicPinLabel | SchematicPinLabel[]
+  >
   schPinStyle?: SchematicPinStyle
   schPinSpacing?: number | string
   schWidth?: number | string
@@ -37,7 +44,10 @@ export interface ConnectorProps extends CommonComponentProps {
 export const connectorProps = commonComponentProps.extend({
   manufacturerPartNumber: z.string().optional(),
   pinLabels: z
-    .record(z.number().or(z.string()), z.string().or(z.array(z.string())))
+    .record(
+      z.number().or(schematicPinLabel),
+      schematicPinLabel.or(z.array(schematicPinLabel)),
+    )
     .optional(),
   schPinStyle: schematicPinStyle.optional(),
   schPinSpacing: distance.optional(),

package/lib/components/jumper.ts

@@ -12,13 +12,20 @@ import {
   schematicPinStyle,
 } from "lib/common/schematicPinStyle"
 import { connectionTarget } from "lib/common/connectionsProp"
+import {
+  schematicPinLabel,
+  type SchematicPinLabel,
+} from "lib/common/schematicPinLabel"
 import type { Connections } from "lib/utility-types/connections-and-selectors"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export interface JumperProps extends CommonComponentProps {
   manufacturerPartNumber?: string
-  pinLabels?: Record<number | string, string | string[]>
+  pinLabels?: Record<
+    number | SchematicPinLabel,
+    SchematicPinLabel | SchematicPinLabel[]
+  >
   schPinStyle?: SchematicPinStyle
   schPinSpacing?: number | string
   schWidth?: number | string
@@ -47,7 +54,10 @@ export interface JumperProps extends CommonComponentProps {
 export const jumperProps = commonComponentProps.extend({
   manufacturerPartNumber: z.string().optional(),
   pinLabels: z
-    .record(z.number().or(z.string()), z.string().or(z.array(z.string())))
+    .record(
+      z.number().or(schematicPinLabel),
+      schematicPinLabel.or(z.array(schematicPinLabel)),
+    )
     .optional(),
   schPinStyle: schematicPinStyle.optional(),
   schPinSpacing: distance.optional(),

package/lib/components/pin-header.ts

@@ -12,6 +12,10 @@ import {
   schematicPinStyle,
 } from "lib/common/schematicPinStyle"
 import { connectionTarget } from "lib/common/connectionsProp"
+import {
+  schematicPinLabel,
+  type SchematicPinLabel,
+} from "lib/common/schematicPinLabel"
 import type { Connections } from "lib/utility-types/connections-and-selectors"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
@@ -65,7 +69,7 @@ export interface PinHeaderProps extends CommonComponentProps {
   /**
    * Labels for each pin
    */
-  pinLabels?: string[]
+  pinLabels?: SchematicPinLabel[]
 
   /**
    * Connections to other components
@@ -113,7 +117,7 @@ export const pinHeaderProps = commonComponentProps.extend({
   doubleRow: z.boolean().optional(),
   holeDiameter: distance.optional(),
   platedDiameter: distance.optional(),
-  pinLabels: z.array(z.string()).optional(),
+  pinLabels: z.array(schematicPinLabel).optional(),
   connections: z
     .custom<Connections>()
     .pipe(z.record(z.string(), connectionTarget))

package/lib/index.ts

@@ -8,6 +8,7 @@ export * from "./common/schematicOrientation"
 export * from "./common/schematicPinDefinitions"
 export * from "./common/schematicPinStyle"
 export * from "./common/cadModel"
+export * from "./common/schematicPinLabel"
 
 export * from "./components/board"
 export * from "./components/breakout"

package/package.json

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