@tscircuit/core 0.0.44 → 0.0.45

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 { traceProps, groupProps, boardProps, footprintProps, smtPadProps, resistorProps, ledProps, diodeProps, capacitorProps, traceHintProps, chipProps, jumperProps, silkscreenPathProps, platedHoleProps, constraintProps, holeProps, silkscreenTextProps } from '@tscircuit/props';
+import { traceProps, groupProps, boardProps, footprintProps, smtPadProps, resistorProps, ledProps, diodeProps, capacitorProps, traceHintProps, chipProps, jumperProps, silkscreenPathProps, platedHoleProps, constraintProps, holeProps, silkscreenTextProps, pcbKeepoutProps } from '@tscircuit/props';
 
 declare class Circuit {
     firstChild: PrimitiveComponent | null;
@@ -4029,6 +4029,80 @@ declare class SilkscreenText extends PrimitiveComponent<typeof silkscreenTextPro
     doInitialPcbPrimitiveRender(): void;
 }
 
+declare class Keepout extends PrimitiveComponent<typeof pcbKeepoutProps> {
+    pcb_keepout_id: string | null;
+    isPcbPrimitive: boolean;
+    get config(): {
+        zodProps: zod.ZodUnion<[zod.ZodObject<zod.objectUtil.extendShape<Omit<{
+            pcbX: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            pcbY: zod.ZodOptional<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">, {
+            shape: zod.ZodLiteral<"circle">;
+            radius: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+        }>, "strip", zod.ZodTypeAny, {
+            shape: "circle";
+            radius: number;
+            pcbX?: number | undefined;
+            pcbY?: number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | undefined;
+        }, {
+            shape: "circle";
+            radius: string | number;
+            pcbX?: string | number | undefined;
+            pcbY?: string | number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            } | undefined;
+        }>, zod.ZodObject<zod.objectUtil.extendShape<{
+            pcbX: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>>;
+            pcbY: zod.ZodOptional<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";
+            }>>;
+        }, {
+            shape: zod.ZodLiteral<"rect">;
+            width: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+            height: zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodNumber]>, number, string | number>;
+        }>, "strip", zod.ZodTypeAny, {
+            shape: "rect";
+            width: number;
+            height: number;
+            pcbX?: number | undefined;
+            pcbY?: number | undefined;
+            pcbRotation?: number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | undefined;
+        }, {
+            shape: "rect";
+            width: string | number;
+            height: string | number;
+            pcbX?: string | number | undefined;
+            pcbY?: string | number | undefined;
+            pcbRotation?: string | number | undefined;
+            layer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
+            } | undefined;
+        }>]>;
+    };
+    doInitialPcbPrimitiveRender(): void;
+}
+
 declare global {
     namespace JSX {
         interface IntrinsicElements {
@@ -4049,6 +4123,7 @@ declare global {
             schematictext: Props.SchematicTextProps;
             smtpad: Props.SmtPadProps;
             platedhole: Props.PlatedHoleProps;
+            keepout: Props.PcbKeepoutProps;
             hole: Props.HoleProps;
             port: Props.PortProps;
             group: Props.GroupProps;
@@ -4074,4 +4149,4 @@ declare global {
     }
 }
 
-export { Board, Capacitor, Chip, Circuit, Constraint, Diode, Footprint, Group, Hole, type IRenderable, Jumper, Led, Net, NormalComponent, PlatedHole, Port, PrimitiveComponent, Project, Renderable, Resistor, SilkscreenPath, SilkscreenText, SmtPad, Trace, TraceHint };
+export { Board, Capacitor, Chip, Circuit, Constraint, Diode, Footprint, Group, Hole, type IRenderable, Jumper, Keepout, Led, Net, NormalComponent, PlatedHole, Port, PrimitiveComponent, Project, Renderable, Resistor, SilkscreenPath, SilkscreenText, SmtPad, Trace, TraceHint };

package/dist/index.js

@@ -16,6 +16,7 @@ __export(components_exports, {
   Group: () => Group,
   Hole: () => Hole,
   Jumper: () => Jumper,
+  Keepout: () => Keepout,
   Led: () => Led,
   Net: () => Net,
   NormalComponent: () => NormalComponent,
@@ -1347,6 +1348,55 @@ var PlatedHole = class extends PrimitiveComponent {
   }
 };
 
+// lib/components/primitive-components/Keepout.ts
+import { pcbKeepoutProps } from "@tscircuit/props";
+import { decomposeTSR as decomposeTSR2 } from "transformation-matrix";
+var Keepout = class extends PrimitiveComponent {
+  pcb_keepout_id = null;
+  isPcbPrimitive = true;
+  get config() {
+    return {
+      zodProps: pcbKeepoutProps
+    };
+  }
+  doInitialPcbPrimitiveRender() {
+    const { db } = this.root;
+    const { _parsedProps: props } = this;
+    const position = this._getGlobalPcbPositionBeforeLayout();
+    const decomposedMat = decomposeTSR2(
+      this._computePcbGlobalTransformBeforeLayout()
+    );
+    const isRotated90 = Math.abs(decomposedMat.rotation.angle * (180 / Math.PI) - 90) < 0.01;
+    let pcb_keepout = null;
+    if (props.shape === "circle") {
+      pcb_keepout = db.pcb_keepout.insert({
+        layers: ["top"],
+        shape: "circle",
+        // @ts-ignore: no idea why this is triggering
+        radius: props.radius,
+        center: {
+          x: position.x,
+          y: position.y
+        }
+      });
+    } else if (props.shape === "rect") {
+      pcb_keepout = db.pcb_keepout.insert({
+        layers: ["top"],
+        shape: "rect",
+        ...isRotated90 ? { width: props.height, height: props.width } : { width: props.width, height: props.height },
+        // @ts-ignore: no idea why this is triggering
+        center: {
+          x: position.x,
+          y: position.y
+        }
+      });
+    }
+    if (pcb_keepout) {
+      this.pcb_keepout_id = pcb_keepout.pcb_keepout_id;
+    }
+  }
+};
+
 // lib/utils/createComponentsFromSoup.ts
 var createComponentsFromSoup = (soup) => {
   const components = [];
@@ -1395,6 +1445,25 @@ var createComponentsFromSoup = (soup) => {
           })
         );
       }
+    } else if (elm.type === "pcb_keepout" && elm.shape === "circle") {
+      components.push(
+        new Keepout({
+          pcbX: elm.center.x,
+          pcbY: elm.center.y,
+          shape: "circle",
+          radius: elm.radius
+        })
+      );
+    } else if (elm.type === "pcb_keepout" && elm.shape === "rect") {
+      components.push(
+        new Keepout({
+          pcbX: elm.center.x,
+          pcbY: elm.center.y,
+          shape: "rect",
+          width: elm.width,
+          height: elm.height
+        })
+      );
     }
   }
   return components;
@@ -2260,7 +2329,7 @@ searched component ${targetComponent.getString()}, which has ports: ${targetComp
       return;
     }
     const pcbElements = db.toArray().filter(
-      (elm) => elm.type === "pcb_smtpad" || elm.type === "pcb_trace" || elm.type === "pcb_plated_hole" || elm.type === "pcb_hole" || elm.type === "source_port" || elm.type === "pcb_port" || elm.type === "source_trace"
+      (elm) => elm.type === "pcb_smtpad" || elm.type === "pcb_trace" || elm.type === "pcb_plated_hole" || elm.type === "pcb_hole" || elm.type === "source_port" || elm.type === "pcb_port" || elm.type === "source_trace" || elm.type === "pcb_keepout"
     );
     const source_trace = db.source_trace.get(this.source_trace_id);
     const hints = ports.flatMap(
@@ -3299,6 +3368,7 @@ export {
   Group,
   Hole,
   Jumper,
+  Keepout,
   Led,
   Net,
   NormalComponent,

package/lib/components/index.ts

@@ -20,3 +20,4 @@ export { PlatedHole } from "./primitive-components/PlatedHole"
 export { Constraint } from "./primitive-components/Constraint"
 export { Hole } from "./primitive-components/Hole"
 export { SilkscreenText } from "./primitive-components/SilkscreenText"
+export { Keepout } from "./primitive-components/Keepout"

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

@@ -0,0 +1,58 @@
+import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+import { pcbKeepoutProps } from "@tscircuit/props"
+import type { RenderPhaseFn } from "../base-components/Renderable"
+import type { PCBKeepout } from "@tscircuit/soup"
+import { decomposeTSR } from "transformation-matrix"
+
+export class Keepout extends PrimitiveComponent<typeof pcbKeepoutProps> {
+  pcb_keepout_id: string | null = null
+
+  isPcbPrimitive = true
+
+  get config() {
+    return {
+      zodProps: pcbKeepoutProps,
+    }
+  }
+
+  doInitialPcbPrimitiveRender(): void {
+    const { db } = this.root!
+    const { _parsedProps: props } = this
+    const position = this._getGlobalPcbPositionBeforeLayout()
+    const decomposedMat = decomposeTSR(
+      this._computePcbGlobalTransformBeforeLayout(),
+    )
+    const isRotated90 =
+      Math.abs(decomposedMat.rotation.angle * (180 / Math.PI) - 90) < 0.01
+
+    let pcb_keepout: PCBKeepout | null = null
+    if (props.shape === "circle") {
+      pcb_keepout = db.pcb_keepout.insert({
+        layers: ["top"],
+        shape: "circle",
+        // @ts-ignore: no idea why this is triggering
+        radius: props.radius,
+        center: {
+          x: position.x,
+          y: position.y,
+        },
+      })
+    } else if (props.shape === "rect") {
+      pcb_keepout = db.pcb_keepout.insert({
+        layers: ["top"],
+        shape: "rect",
+        ...(isRotated90
+          ? { width: props.height, height: props.width }
+          : { width: props.width, height: props.height }),
+        // @ts-ignore: no idea why this is triggering
+        center: {
+          x: position.x,
+          y: position.y,
+        },
+      })
+    }
+    if (pcb_keepout) {
+      this.pcb_keepout_id = pcb_keepout.pcb_keepout_id
+    }
+  }
+}

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

@@ -294,7 +294,8 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
           elm.type === "pcb_hole" ||
           elm.type === "source_port" ||
           elm.type === "pcb_port" ||
-          elm.type === "source_trace",
+          elm.type === "source_trace" ||
+          elm.type === "pcb_keepout",
       )
 
     const source_trace = db.source_trace.get(this.source_trace_id!)!

package/lib/fiber/intrinsic-jsx.ts

@@ -21,6 +21,7 @@ declare global {
       schematictext: Props.SchematicTextProps
       smtpad: Props.SmtPadProps
       platedhole: Props.PlatedHoleProps
+      keepout: Props.PcbKeepoutProps
       hole: Props.HoleProps
       port: Props.PortProps
       group: Props.GroupProps

package/lib/utils/createComponentsFromSoup.ts

@@ -3,6 +3,7 @@ import type { PrimitiveComponent } from "../components/base-components/Primitive
 import { SmtPad } from "lib/components/primitive-components/SmtPad"
 import { SilkscreenPath } from "lib/components/primitive-components/SilkscreenPath"
 import { PlatedHole } from "lib/components/primitive-components/PlatedHole"
+import { Keepout } from "lib/components/primitive-components/Keepout"
 
 export const createComponentsFromSoup = (
   soup: AnySoupElement[],
@@ -53,6 +54,25 @@ export const createComponentsFromSoup = (
           }),
         )
       }
+    } else if (elm.type === "pcb_keepout" && elm.shape === "circle") {
+      components.push(
+        new Keepout({
+          pcbX: elm.center.x,
+          pcbY: elm.center.y,
+          shape: "circle",
+          radius: elm.radius,
+        }),
+      )
+    } else if (elm.type === "pcb_keepout" && elm.shape === "rect") {
+      components.push(
+        new Keepout({
+          pcbX: elm.center.x,
+          pcbY: elm.center.y,
+          shape: "rect",
+          width: elm.width,
+          height: elm.height,
+        }),
+      )
     }
   }
   return components

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tscircuit/core",
   "module": "index.ts",
   "type": "module",
-  "version": "0.0.44",
+  "version": "0.0.45",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "files": [
@@ -36,8 +36,8 @@
     "@lume/kiwi": "^0.4.3",
     "@tscircuit/infgrid-ijump-astar": "^0.0.9",
     "@tscircuit/props": "^0.0.62",
-    "@tscircuit/soup": "^0.0.66",
-    "@tscircuit/soup-util": "0.0.18",
+    "@tscircuit/soup": "^0.0.67",
+    "@tscircuit/soup-util": "^0.0.23",
     "footprinter": "^0.0.44",
     "react": "^18.3.1",
     "react-reconciler": "^0.29.2",