@tscircuit/props 0.0.189 → 0.0.191

package/lib/components/connector.ts

@@ -0,0 +1,53 @@
+import { distance } from "circuit-json"
+import {
+  type CommonComponentProps,
+  commonComponentProps,
+} from "lib/common/layout"
+import {
+  type SchematicPortArrangement,
+  schematicPortArrangement,
+} from "lib/common/schematicPinDefinitions"
+import {
+  type SchematicPinStyle,
+  schematicPinStyle,
+} from "lib/common/schematicPinStyle"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface ConnectorProps extends CommonComponentProps {
+  manufacturerPartNumber?: string
+  pinLabels?: Record<number | string, string | string[]>
+  schPinStyle?: SchematicPinStyle
+  schPinSpacing?: number | string
+  schWidth?: number | string
+  schHeight?: number | string
+  schDirection?: "left" | "right"
+  schPortArrangement?: SchematicPortArrangement
+  /**
+   * Groups of pins that are internally connected (bridged)
+   * e.g., [["1","2"], ["2","3"]]
+   */
+  internallyConnectedPins?: string[][]
+  /**
+   * Connector standard, e.g. usb_c, m2
+   */
+  standard?: "usb_c" | "m2"
+}
+
+export const connectorProps = commonComponentProps.extend({
+  manufacturerPartNumber: z.string().optional(),
+  pinLabels: z
+    .record(z.number().or(z.string()), z.string().or(z.array(z.string())))
+    .optional(),
+  schPinStyle: schematicPinStyle.optional(),
+  schPinSpacing: distance.optional(),
+  schWidth: distance.optional(),
+  schHeight: distance.optional(),
+  schDirection: z.enum(["left", "right"]).optional(),
+  schPortArrangement: schematicPortArrangement.optional(),
+  internallyConnectedPins: z.array(z.array(z.string())).optional(),
+  standard: z.enum(["usb_c", "m2"]).optional(),
+})
+
+type InferredConnectorProps = z.input<typeof connectorProps>
+expectTypesMatch<ConnectorProps, InferredConnectorProps>(true)

package/lib/components/pin-header.ts

@@ -3,6 +3,10 @@ import {
   type CommonComponentProps,
   commonComponentProps,
 } from "lib/common/layout"
+import {
+  schematicPinArrangement,
+  type SchematicPinArrangement,
+} from "lib/common/schematicPinDefinitions"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
@@ -56,6 +60,11 @@ export interface PinHeaderProps extends CommonComponentProps {
    * Direction the header is facing
    */
   facingDirection?: "left" | "right"
+
+  /**
+   * Pin arrangement in schematic view
+   */
+  schPinArrangement?: SchematicPinArrangement
 }
 
 export const pinHeaderProps = commonComponentProps.extend({
@@ -69,6 +78,7 @@ export const pinHeaderProps = commonComponentProps.extend({
   platedDiameter: distance.optional(),
   pinLabels: z.array(z.string()).optional(),
   facingDirection: z.enum(["left", "right"]).optional(),
+  schPinArrangement: schematicPinArrangement.optional(),
 })
 
 type InferredPinHeaderProps = z.input<typeof pinHeaderProps>

package/lib/index.ts

@@ -11,6 +11,7 @@ export * from "./common/cadModel"
 export * from "./components/board"
 export * from "./components/chip"
 export * from "./components/jumper"
+export * from "./components/connector"
 export * from "./components/fuse"
 export * from "./components/platedhole"
 

package/package.json

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