@tscircuit/props 0.0.536 → 0.0.538

package/lib/components/drc-check.ts

@@ -0,0 +1,16 @@
+import { customDrcCheckFn, type CustomDrcCheckFn } from "lib/customDrc"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface DrcCheckProps {
+  name?: string
+  checkFn: CustomDrcCheckFn
+}
+
+export const drcCheckProps = z.object({
+  name: z.string().optional(),
+  checkFn: customDrcCheckFn,
+})
+
+type InferredDrcCheckProps = z.input<typeof drcCheckProps>
+expectTypesMatch<DrcCheckProps, InferredDrcCheckProps>(true)

package/lib/customDrc.ts

@@ -0,0 +1,78 @@
+import type {
+  AnyCircuitElement,
+  CircuitJsonError,
+  PcbComponent,
+  PcbPort,
+  SourceComponentBase,
+  SourceNet,
+  SourcePort,
+} from "circuit-json"
+import { z } from "zod"
+
+type MaybePromise<T> = T | Promise<T>
+type CircuitJsonWarning = Extract<AnyCircuitElement, { warning_type: string }>
+
+export type CustomDrcCheckInput =
+  | Partial<CircuitJsonError>
+  | Partial<CircuitJsonWarning>
+
+export interface SelectionResultComponent {
+  getPort: (name: string) => SelectionResultPort | null
+  getPorts: () => SelectionResultPort[]
+  getPcbComponent: () => PcbComponent | null
+  getSourceComponent: () => SourceComponentBase | null
+}
+
+export interface SelectionResultPort {
+  getPcbPort: () => PcbPort | null
+  getSourcePort: () => SourcePort | null
+}
+
+export interface SelectionResultNet {
+  getSourceNet: () => SourceNet | null
+}
+
+export type SelectionResult =
+  | SelectionResultComponent
+  | SelectionResultPort
+  | SelectionResultNet
+
+export type CustomDrcConnectable =
+  | string
+  | AnyCircuitElement
+  | SelectionResult
+  | null
+  | undefined
+
+export interface CustomDrcSelect {
+  (selector: `net.${string}`): SelectionResultNet | null
+  (selector: `${string}.${string}`): SelectionResultPort | null
+  (selector: string): SelectionResult | null
+}
+
+export interface CustomDrcSelectAll {
+  (selector: `chip${string}`): SelectionResultComponent[]
+  (selector: string): SelectionResult[]
+}
+
+export interface CustomDrcCheckContext {
+  select: CustomDrcSelect
+  selectAll: CustomDrcSelectAll
+  isConnected: (a: CustomDrcConnectable, b: CustomDrcConnectable) => boolean
+  isPulledUp: (a: CustomDrcConnectable) => boolean
+  isPulledDown: (a: CustomDrcConnectable) => boolean
+  getResistanceBetween: (
+    a: CustomDrcConnectable,
+    b: CustomDrcConnectable,
+  ) => number | null
+}
+
+export type CustomDrcCheckFn = (
+  ctx: CustomDrcCheckContext,
+) => MaybePromise<
+  CustomDrcCheckInput | CustomDrcCheckInput[] | null | undefined | void
+>
+
+export const customDrcCheckFn = z.custom<CustomDrcCheckFn>(
+  (value) => typeof value === "function",
+)

package/lib/generated/jlcpcb-autocomplete.ts

@@ -2488,6 +2488,5 @@ export type JlcpcbKnownPartNumber =
   | "C783588"
   | "C3265019"
 
-export type JlcpcbAutocompleteStringPath = AutocompleteString<
-  `jlcpcb:${JlcpcbKnownPartNumber}` | `jlcpcb:C${number}`
->
+export type JlcpcbAutocompleteStringPath =
+  AutocompleteString<`jlcpcb:${JlcpcbKnownPartNumber}`>

package/lib/index.ts

@@ -20,6 +20,7 @@ export * from "./common/schematicSize"
 export * from "./common/kicadFootprintMetadata"
 export * from "./common/kicadSymbolMetadata"
 export * from "./common/kicadPinMetadata"
+export * from "./customDrc"
 
 export * from "./components/board"
 export * from "./components/panel"
@@ -49,6 +50,7 @@ export * from "./components/fiducial"
 export * from "./components/constrainedlayout"
 export * from "./components/constraint"
 export * from "./components/cutout"
+export * from "./components/drc-check"
 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.536",
+  "version": "0.0.538",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",
@@ -32,7 +32,7 @@
     "@types/node": "^20.12.11",
     "@types/react": "^18.3.2",
     "ava": "^6.1.3",
-    "circuit-json": "^0.0.425",
+    "circuit-json": "^0.0.428",
     "expect-type": "^1.3.0",
     "glob": "^11.0.0",
     "madge": "^8.0.0",