@tscircuit/props 0.0.579 → 0.0.580

package/lib/common/commonShape.ts

@@ -0,0 +1,50 @@
+import { distance, type Distance } from "lib/common/distance"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface PillShapeProps {
+  shape: "pill"
+  width: Distance
+  height: Distance
+}
+
+export interface RectShapeProps {
+  shape: "rect"
+  width: Distance
+  height: Distance
+}
+
+export interface CircleShapeProps {
+  shape: "circle"
+  radius: Distance
+}
+
+export type CommonShapeProps =
+  | PillShapeProps
+  | RectShapeProps
+  | CircleShapeProps
+
+export const pillShapeProps = z.object({
+  shape: z.literal("pill"),
+  width: distance,
+  height: distance,
+})
+
+export const rectShapeProps = z.object({
+  shape: z.literal("rect"),
+  width: distance,
+  height: distance,
+})
+
+export const circleShapeProps = z.object({
+  shape: z.literal("circle"),
+  radius: distance,
+})
+
+export const commonShapeProps = z.discriminatedUnion("shape", [
+  pillShapeProps,
+  rectShapeProps,
+  circleShapeProps,
+])
+
+expectTypesMatch<CommonShapeProps, z.input<typeof commonShapeProps>>(true)

package/lib/enclosure/cutout-aperture.ts

@@ -0,0 +1,63 @@
+import {
+  circleShapeProps,
+  type CircleShapeProps,
+  type CommonShapeProps,
+  pillShapeProps,
+  type PillShapeProps,
+  rectShapeProps,
+  type RectShapeProps,
+} from "lib/common/commonShape"
+import { distance, type Distance } from "lib/common/distance"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export const enclosureCutoutApertureShapes = ["pill", "rect", "circle"] as const
+
+export type EnclosureCutoutApertureShape = CommonShapeProps["shape"]
+
+/**
+ * Describes the nominal enclosure opening required by a component.
+ *
+ * Numeric values are interpreted as mm.
+ */
+export interface PillEnclosureCutoutApertureProps extends PillShapeProps {
+  /** Additional clearance around the nominal opening. */
+  margin?: Distance
+}
+
+export interface RectEnclosureCutoutApertureProps extends RectShapeProps {
+  /** Additional clearance around the nominal opening. */
+  margin?: Distance
+}
+
+export interface CircleEnclosureCutoutApertureProps extends CircleShapeProps {
+  /** Additional clearance around the nominal opening. */
+  margin?: Distance
+}
+
+export type EnclosureCutoutApertureProps =
+  | PillEnclosureCutoutApertureProps
+  | RectEnclosureCutoutApertureProps
+  | CircleEnclosureCutoutApertureProps
+
+const apertureOnlyProps = {
+  margin: distance.optional(),
+}
+
+export const enclosureCutoutApertureProps = z.discriminatedUnion("shape", [
+  pillShapeProps.extend(apertureOnlyProps),
+  rectShapeProps.extend(apertureOnlyProps),
+  circleShapeProps.extend(apertureOnlyProps),
+])
+
+type InferredEnclosureCutoutApertureProps = z.input<
+  typeof enclosureCutoutApertureProps
+>
+export type ParsedEnclosureCutoutApertureProps = z.output<
+  typeof enclosureCutoutApertureProps
+>
+
+expectTypesMatch<
+  EnclosureCutoutApertureProps,
+  InferredEnclosureCutoutApertureProps
+>(true)

package/lib/enclosure/index.ts

@@ -1,9 +1,12 @@
+import { enclosureCutoutApertureProps } from "./cutout-aperture"
 import { enclosureFdmBoxProps } from "./fdm/box"
 
+export * from "./cutout-aperture"
 export * from "./fdm"
 
 export const enclosureProps = {
+  cutoutaperture: enclosureCutoutApertureProps,
   fdm: {
-    Box: enclosureFdmBoxProps,
+    box: enclosureFdmBoxProps,
   },
 } as const

package/lib/index.ts

@@ -1,4 +1,5 @@
 export * from "./common/direction"
+export * from "./common/commonShape"
 export * from "./enclosure"
 export * from "./common/portHints"
 export * from "./common/layout"

package/package.json

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