@tscircuit/core 0.0.17 → 0.0.18

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { ReactElement } from 'react';
 import { Matrix } from 'transformation-matrix';
 import { SchSymbol, BaseSymbolName } from 'schematic-symbols';
 import * as Props from '@tscircuit/props';
-import { boardProps, footprintProps, smtPadProps, resistorProps, ledProps, traceProps, traceHintProps, groupProps, chipProps, jumperProps, silkscreenPathProps } from '@tscircuit/props';
+import { boardProps, footprintProps, smtPadProps, resistorProps, ledProps, traceProps, traceHintProps, groupProps, chipProps, jumperProps, silkscreenPathProps, platedHoleProps } from '@tscircuit/props';
 import * as _tscircuit_layout from '@tscircuit/layout';
 
 declare class Project {
@@ -3217,6 +3217,87 @@ declare class SilkscreenPath extends PrimitiveComponent<typeof silkscreenPathPro
     doInitialPcbPrimitiveRender(): void;
 }
 
+declare class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
+    pcb_plated_hole_id: string | null;
+    matchedPort: Port | null;
+    isPcbPrimitive: boolean;
+    get config(): {
+        zodProps: zod.ZodUnion<[zod.ZodObject<zod.objectUtil.extendShape<Omit<{
+            pcbX: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            pcbY: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            pcbRotation: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            layer: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>, zod.ZodObject<{
+                name: zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>;
+            }, "strip", zod.ZodTypeAny, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>]>, "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6", "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>>;
+        }, "pcbRotation" | "layer">, {
+            shape: zod.ZodLiteral<"circle">;
+            holeDiameter: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            outerDiameter: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            portHints: zod.ZodOptional<zod.ZodArray<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, "many">>;
+        }>, "strip", zod.ZodTypeAny, {
+            pcbX: number;
+            pcbY: number;
+            shape: "circle";
+            holeDiameter: number;
+            outerDiameter: number;
+            portHints?: (string | number)[] | undefined;
+        }, {
+            pcbX: string | number;
+            pcbY: string | number;
+            shape: "circle";
+            holeDiameter: string | number;
+            outerDiameter: string | number;
+            portHints?: (string | number)[] | undefined;
+        }>, zod.ZodObject<zod.objectUtil.extendShape<Omit<{
+            pcbX: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            pcbY: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            pcbRotation: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            layer: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>, zod.ZodObject<{
+                name: zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6"]>;
+            }, "strip", zod.ZodTypeAny, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>]>, "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6", "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            }>>;
+        }, "pcbRotation" | "layer">, {
+            shape: zod.ZodLiteral<"oval">;
+            outerWidth: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            outerHeight: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            innerWidth: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            innerHeight: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            portHints: zod.ZodOptional<zod.ZodArray<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, "many">>;
+        }>, "strip", zod.ZodTypeAny, {
+            pcbX: number;
+            pcbY: number;
+            shape: "oval";
+            outerWidth: number;
+            outerHeight: number;
+            innerWidth: number;
+            innerHeight: number;
+            portHints?: (string | number)[] | undefined;
+        }, {
+            pcbX: string | number;
+            pcbY: string | number;
+            shape: "oval";
+            outerWidth: string | number;
+            outerHeight: string | number;
+            innerWidth: string | number;
+            innerHeight: string | number;
+            portHints?: (string | number)[] | undefined;
+        }>]>;
+    };
+    doInitialPortMatching(): void;
+    doInitialPcbPrimitiveRender(): void;
+}
+
 declare global {
     namespace JSX {
         interface IntrinsicElements {
@@ -3259,4 +3340,4 @@ declare global {
     }
 }
 
-export { Board, Capacitor, Chip, Footprint, Group, type IRenderable, Jumper, Led, Net, NormalComponent, Port, PrimitiveComponent, Project, Renderable, Resistor, SilkscreenPath, SmtPad, Trace, TraceHint };
+export { Board, Capacitor, Chip, Footprint, Group, type IRenderable, Jumper, Led, Net, NormalComponent, PlatedHole, Port, PrimitiveComponent, Project, Renderable, Resistor, SilkscreenPath, SmtPad, Trace, TraceHint };

package/dist/index.js

@@ -16,6 +16,7 @@ __export(components_exports, {
   Led: () => Led,
   Net: () => Net,
   NormalComponent: () => NormalComponent,
+  PlatedHole: () => PlatedHole,
   Port: () => Port,
   PrimitiveComponent: () => PrimitiveComponent,
   Renderable: () => Renderable,
@@ -829,6 +830,55 @@ var SilkscreenPath = class extends PrimitiveComponent {
   }
 };
 
+// lib/components/primitive-components/PlatedHole.ts
+import { platedHoleProps } from "@tscircuit/props";
+var PlatedHole = class extends PrimitiveComponent {
+  pcb_plated_hole_id = null;
+  matchedPort = null;
+  isPcbPrimitive = true;
+  get config() {
+    return {
+      zodProps: platedHoleProps
+    };
+  }
+  doInitialPortMatching() {
+    const parentPorts = (this.parent?.children ?? []).filter(
+      (c) => c.componentName === "Port"
+    );
+    if (!this.props.portHints) {
+      return;
+    }
+    for (const port of parentPorts) {
+      if (port.isMatchingAnyOf(this.props.portHints)) {
+        this.matchedPort = port;
+        port.registerMatch(this);
+        return;
+      }
+    }
+  }
+  doInitialPcbPrimitiveRender() {
+    const { db } = this.project;
+    const { _parsedProps: props } = this;
+    if (!props.portHints) return;
+    const position = this.getGlobalPcbPosition();
+    if (props.shape === "circle") {
+      const plated_hole_input = {
+        pcb_component_id: this.parent?.pcb_component_id,
+        pcb_port_id: this.matchedPort?.pcb_port_id,
+        layers: ["top", "bottom"],
+        outer_diameter: props.outerDiameter,
+        hole_diameter: props.holeDiameter,
+        shape: "circle",
+        port_hints: this.getNameAndAliases(),
+        x: position.x,
+        y: position.y,
+        type: "pcb_plated_hole"
+      };
+      const pcb_plated_hole = db.pcb_plated_hole.insert(plated_hole_input);
+    }
+  }
+};
+
 // lib/utils/createComponentsFromSoup.ts
 var createComponentsFromSoup = (soup) => {
   const components = [];
@@ -864,6 +914,19 @@ var createComponentsFromSoup = (soup) => {
           strokeWidth: elm.stroke_width
         })
       );
+    } else if (elm.type === "pcb_plated_hole" && elm.shape === "circle") {
+      if (elm.shape === "circle") {
+        components.push(
+          new PlatedHole({
+            pcbX: elm.x,
+            pcbY: elm.y,
+            shape: "circle",
+            holeDiameter: elm.hole_diameter,
+            outerDiameter: elm.outer_diameter,
+            portHints: elm.port_hints
+          })
+        );
+      }
     }
   }
   return components;
@@ -2194,6 +2257,7 @@ export {
   Led,
   Net,
   NormalComponent,
+  PlatedHole,
   Port,
   PrimitiveComponent,
   Project,

package/lib/components/index.ts

@@ -15,3 +15,4 @@ export { Group } from "./primitive-components/Group"
 export { Chip } from "./normal-components/Chip"
 export { Jumper } from "./normal-components/Jumper"
 export { SilkscreenPath } from "./primitive-components/SilkscreenPath"
+export { PlatedHole } from "./primitive-components/PlatedHole"

package/lib/components/primitive-components/PlatedHole.ts

@@ -0,0 +1,60 @@
+import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+import { platedHoleProps } from "@tscircuit/props"
+import type { Port } from "./Port"
+import type { PCBPlatedHoleInput } from "@tscircuit/soup"
+
+export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
+  pcb_plated_hole_id: string | null = null
+  matchedPort: Port | null = null
+  isPcbPrimitive = true
+
+  get config() {
+    return {
+      zodProps: platedHoleProps,
+    }
+  }
+
+  doInitialPortMatching(): void {
+    const parentPorts = (this.parent?.children ?? []).filter(
+      (c) => c.componentName === "Port",
+    ) as Port[]
+
+    if (!this.props.portHints) {
+      return
+    }
+
+    for (const port of parentPorts) {
+      if (port.isMatchingAnyOf(this.props.portHints)) {
+        this.matchedPort = port
+        port.registerMatch(this)
+        return
+      }
+    }
+  }
+
+  doInitialPcbPrimitiveRender(): void {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+    if (!props.portHints) return
+    const position = this.getGlobalPcbPosition()
+    if (props.shape === "circle") {
+      const plated_hole_input: PCBPlatedHoleInput = {
+        pcb_component_id: this.parent?.pcb_component_id!,
+        pcb_port_id: this.matchedPort?.pcb_port_id!,
+        layers: ["top", "bottom"],
+        outer_diameter: props.outerDiameter,
+        hole_diameter: props.holeDiameter,
+        shape: "circle",
+        port_hints: this.getNameAndAliases(),
+        x: position.x,
+        y: position.y,
+        type: "pcb_plated_hole",
+      }
+
+      // @ts-ignore - some issue with soup-util types it seems
+      const pcb_plated_hole = db.pcb_plated_hole.insert(plated_hole_input)
+
+      // this.pcb_plated_hole_id = pcb_plated_hole.pcb_plated_hole_id
+    }
+  }
+}

package/lib/utils/createComponentsFromSoup.ts

@@ -2,6 +2,7 @@ import type { AnySoupElement } from "@tscircuit/soup"
 import type { PrimitiveComponent } from "../components/base-components/PrimitiveComponent"
 import { SmtPad } from "lib/components/primitive-components/SmtPad"
 import { SilkscreenPath } from "lib/components/primitive-components/SilkscreenPath"
+import { PlatedHole } from "lib/components/primitive-components/PlatedHole"
 
 export const createComponentsFromSoup = (
   soup: AnySoupElement[],
@@ -39,6 +40,19 @@ export const createComponentsFromSoup = (
           strokeWidth: elm.stroke_width,
         }),
       )
+    } else if (elm.type === "pcb_plated_hole" && elm.shape === "circle") {
+      if (elm.shape === "circle") {
+        components.push(
+          new PlatedHole({
+            pcbX: elm.x,
+            pcbY: elm.y,
+            shape: "circle",
+            holeDiameter: elm.hole_diameter,
+            outerDiameter: elm.outer_diameter,
+            portHints: elm.port_hints,
+          }),
+        )
+      }
     }
   }
   return components

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tscircuit/core",
   "module": "index.ts",
   "type": "module",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "files": [