@tscircuit/props 0.0.640 → 0.0.641

package/lib/common/pcbPath.ts

@@ -0,0 +1,41 @@
+import { layer_ref, type LayerRefInput } from "circuit-json"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+import { point, type Point } from "./point"
+
+export interface PcbPathPoint extends Point {
+  via?: boolean
+  fromLayer?: LayerRefInput
+  toLayer?: LayerRefInput
+}
+
+const basePcbPathPoint = point.extend({
+  via: z.boolean().optional(),
+  fromLayer: layer_ref.optional(),
+  toLayer: layer_ref.optional(),
+})
+
+export const pcbPathPoint = basePcbPathPoint.superRefine((value, ctx) => {
+  if (value.via) {
+    if (!value.toLayer) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "toLayer is required when via is true",
+        path: ["toLayer"],
+      })
+    }
+  } else if (value.fromLayer || value.toLayer) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "fromLayer/toLayer are only allowed when via is true",
+      path: ["via"],
+    })
+  }
+})
+
+export const pcbPath = z.array(z.union([pcbPathPoint, z.string()]))
+
+export type PcbPath = Array<PcbPathPoint | string>
+
+expectTypesMatch<PcbPathPoint, z.input<typeof pcbPathPoint>>(true)
+expectTypesMatch<PcbPath, z.input<typeof pcbPath>>(true)

package/lib/components/antenna.ts

@@ -0,0 +1,23 @@
+import {
+  type CommonComponentProps,
+  commonComponentProps,
+} from "lib/common/layout"
+import { type PcbPath, pcbPath } from "lib/common/pcbPath"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/** Props for an antenna component with an optional explicit PCB path. */
+export interface AntennaProps extends CommonComponentProps {
+  /**
+   * Explicit antenna path. Entries use the same selector, point, and via
+   * syntax as trace pcbPath entries.
+   */
+  pcbPath?: PcbPath
+}
+
+export const antennaProps = commonComponentProps.extend({
+  pcbPath: pcbPath.optional(),
+})
+
+type InferredAntennaProps = z.input<typeof antennaProps>
+expectTypesMatch<AntennaProps, InferredAntennaProps>(true)

package/lib/components/trace.ts

@@ -1,6 +1,7 @@
-import { distance, layer_ref, route_hint_point } from "circuit-json"
+import { distance, route_hint_point } from "circuit-json"
 import { z } from "zod"
 import { point } from "../common/point"
+import { pcbPath } from "../common/pcbPath"
 
 export const portRef = z.union([
   z.string(),
@@ -13,32 +14,6 @@ export const portRef = z.union([
   ),
 ])
 
-const pcbPathPoint = point
-  .extend({
-    via: z.boolean().optional(),
-    fromLayer: layer_ref.optional(),
-    toLayer: layer_ref.optional(),
-  })
-  .superRefine((value, ctx) => {
-    if (value.via) {
-      if (!value.toLayer) {
-        ctx.addIssue({
-          code: z.ZodIssueCode.custom,
-          message: "toLayer is required when via is true",
-          path: ["toLayer"],
-        })
-      }
-    } else if (value.fromLayer || value.toLayer) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
-        message: "fromLayer/toLayer are only allowed when via is true",
-        path: ["via"],
-      })
-    }
-  })
-
-const pcbPath = z.array(z.union([pcbPathPoint, z.string()]))
-
 const baseTraceProps = z.object({
   key: z.string().optional(),
   name: z.string().optional(),

package/lib/index.ts

@@ -6,6 +6,7 @@ export * from "./common/portHints"
 export * from "./common/layout"
 export * from "./common/pinAttributeMap"
 export * from "./common/point3"
+export * from "./common/pcbPath"
 export * from "./common/portHints"
 export * from "./common/footprintProp"
 export * from "./common/symbolProp"
@@ -57,6 +58,7 @@ export * from "./components/drc-check"
 export * from "./components/smtpad"
 export * from "./components/solderpaste"
 export * from "./components/hole"
+export * from "./components/antenna"
 export * from "./components/trace"
 export * from "./components/bus"
 export * from "./components/differentialpair"

package/package.json

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