add key as optional parameter for trace props (#50)

* add key as optional parameter for trace props

* add key to common component props

* fix type issue by adding to zod prop

* formatbot: Automatically format code

* switch to bun lockfiles

* update lockfile

* switch typehceck to bun

* update formatcheck

---------

Co-authored-by: tscircuitbot <tscircuitbot@users.noreply.github.com>

.github/workflows/formatcheck.yml

@@ -1,25 +1,26 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
 name: Format Check
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   format-check:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Use Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: '22'
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
 
-    - name: Install dependencies
-      run: npm ci
+      - name: Install dependencies
+        run: bun install
 
-    - name: Run format check
-      run: npm run format:check
+      - name: Run format check
+        run: bun run format:check

.github/workflows/npm-typecheck.yml

@@ -14,13 +14,13 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Use Node.js
-        uses: actions/setup-node@v3
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
         with:
-          node-version: "22"
+          bun-version: latest
 
       - name: Install dependencies
-        run: npm ci
+        run: bun i
 
-      - name: Run format check
-        run: npx tsc --noEmit
+      - name: Run type check
+        run: bunx tsc --noEmit

.gitignore

@@ -2,3 +2,4 @@ node_modules
 dist
 .vscode
 .aider*
+package-lock.json

lib/common/layout.ts

@@ -82,6 +82,7 @@ export const supplierProps = z.object({
 expectTypesMatch<SupplierProps, z.input<typeof supplierProps>>(true)
 
 export interface CommonComponentProps extends CommonLayoutProps {
+  key?: any
   name: string
   supplierPartNumbers?: SupplierProps["supplierPartNumbers"]
   cadModel?: CadModelProp
@@ -92,6 +93,7 @@ export interface CommonComponentProps extends CommonLayoutProps {
 export const commonComponentProps = commonLayoutProps
   .merge(supplierProps)
   .extend({
+    key: z.any().optional(),
     name: z.string(),
     cadModel: cadModelProp.optional(),
     children: z.any().optional(),

lib/components/trace.ts

@@ -0,0 +1,30 @@
+import { z } from "zod"
+import { distance, route_hint_point } from "@tscircuit/soup"
+import { point } from "../common/point"
+
+export const portRef = z.union([
+  z.string(),
+  z.custom<{ getPortSelector: () => string }>((v) =>
+    Boolean(v.getPortSelector),
+  ),
+])
+
+const baseTraceProps = z.object({
+  key: z.string().optional(),
+  path: z.array(portRef),
+  thickness: distance.optional(),
+  schematicRouteHints: z.array(point).optional(),
+  pcbRouteHints: z.array(route_hint_point).optional(),
+})
+
+export const traceProps = z.union([
+  baseTraceProps.extend({
+    path: z.array(portRef),
+  }),
+  baseTraceProps.extend({
+    from: portRef,
+    to: portRef,
+  }),
+])
+
+export type TraceProps = z.input<typeof traceProps>

lib/index.ts

@@ -57,6 +57,7 @@ export * from "./components/constrainedlayout"
 export * from "./components/constraint"
 export * from "./components/smtpad"
 export * from "./components/hole"
+export * from "./components/trace"
 
 export const inductorProps = commonComponentProps.extend({
   inductance,
@@ -96,31 +97,6 @@ export const netAliasProps = commonLayoutProps.extend({
 })
 export type NetAliasProps = z.input<typeof netAliasProps>
 
-export const portRef = z.union([
-  z.string(),
-  z.custom<{ getPortSelector: () => string }>((v) =>
-    Boolean(v.getPortSelector),
-  ),
-])
-
-export const traceProps = z
-  .object({
-    path: z.array(portRef),
-    thickness: distance.optional(),
-    schematicRouteHints: z.array(point).optional(),
-    pcbRouteHints: z.array(route_hint_point).optional(),
-  })
-  .or(
-    z.object({
-      from: portRef,
-      to: portRef,
-      thickness: distance.optional(),
-      schematicRouteHints: z.array(point).optional(),
-      pcbRouteHints: z.array(route_hint_point).optional(),
-    }),
-  )
-export type TraceProps = z.input<typeof traceProps>
-
 export const platedHoleProps = z.union([
   pcbLayoutProps.omit({ pcbRotation: true, layer: true }).extend({
     name: z.string().optional(),