@tscircuit/props 0.0.182 → 0.0.184

package/lib/components/cutout.ts

@@ -0,0 +1,77 @@
+import { z } from "zod"
+import { distance, type Distance } from "lib/common/distance"
+import { point, type Point } from "lib/common/point"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+
+export interface RectCutoutProps
+  extends Omit<PcbLayoutProps, "layer" | "pcbRotation"> {
+  name?: string
+  shape: "rect"
+  width: Distance
+  height: Distance
+}
+
+export const rectCutoutProps = pcbLayoutProps
+  .omit({
+    layer: true,
+    pcbRotation: true,
+  })
+  .extend({
+    name: z.string().optional(),
+    shape: z.literal("rect"),
+    width: distance,
+    height: distance,
+  })
+expectTypesMatch<RectCutoutProps, z.input<typeof rectCutoutProps>>(true)
+
+export interface CircleCutoutProps
+  extends Omit<PcbLayoutProps, "layer" | "pcbRotation"> {
+  name?: string
+  shape: "circle"
+  radius: Distance
+}
+
+export const circleCutoutProps = pcbLayoutProps
+  .omit({
+    layer: true,
+    pcbRotation: true,
+  })
+  .extend({
+    name: z.string().optional(),
+    shape: z.literal("circle"),
+    radius: distance,
+  })
+expectTypesMatch<CircleCutoutProps, z.input<typeof circleCutoutProps>>(true)
+
+export interface PolygonCutoutProps
+  extends Omit<PcbLayoutProps, "layer" | "pcbRotation"> {
+  name?: string
+  shape: "polygon"
+  points: Point[]
+}
+
+export const polygonCutoutProps = pcbLayoutProps
+  .omit({
+    layer: true,
+    pcbRotation: true,
+  })
+  .extend({
+    name: z.string().optional(),
+    shape: z.literal("polygon"),
+    points: z.array(point),
+  })
+expectTypesMatch<PolygonCutoutProps, z.input<typeof polygonCutoutProps>>(true)
+
+export type CutoutProps =
+  | RectCutoutProps
+  | CircleCutoutProps
+  | PolygonCutoutProps
+
+export const cutoutProps = z.discriminatedUnion("shape", [
+  rectCutoutProps,
+  circleCutoutProps,
+  polygonCutoutProps,
+])
+
+export type CutoutPropsInput = z.input<typeof cutoutProps>

package/lib/components/platedhole.ts

@@ -55,7 +55,7 @@ export interface CircularHoleWithRectPlatedProps
   rectPadHeight: number | string
   holeShape?: "circle"
   padShape?: "rect"
-  shape?: "circularHoleWithRectPad"
+  shape?: "circular_hole_with_rect_pad"
   portHints?: PortHints
 }
 
@@ -112,17 +112,17 @@ export const platedHoleProps = z
         rectPadHeight: distance,
         holeShape: z.literal("circle").optional(),
         padShape: z.literal("rect").optional(),
-        shape: z.literal("circularHoleWithRectPad").optional(),
+        shape: z.literal("circular_hole_with_rect_pad").optional(),
         portHints: portHints.optional(),
       })
       .refine(
         (prop) => {
-          return prop.shape === "circularHoleWithRectPad"
+          return prop.shape === "circular_hole_with_rect_pad"
             ? prop.holeDiameter && prop.rectPadWidth && prop.rectPadHeight
             : true
         },
         {
-          message: "Missing required fields for circularHoleWithRectPad",
+          message: "Missing required fields for circular_hole_with_rect_pad",
         },
       ),
   ])

package/lib/index.ts

@@ -23,6 +23,7 @@ export * from "./components/group"
 export * from "./components/net"
 export * from "./components/constrainedlayout"
 export * from "./components/constraint"
+export * from "./components/cutout"
 export * from "./components/smtpad"
 export * from "./components/solderpaste"
 export * from "./components/hole"

package/package.json

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