circuit-json-to-tscircuit 0.0.29 → 0.0.30

package/dist/{chunk-O2XG7HJL.js → chunk-Y7MQ2KXU.js}

@@ -251,14 +251,35 @@ var convertHoles = (circuitJson) => {
   return elementStrings;
 };
 
-// lib/generate-footprint-tsx/convert-notes.ts
+// lib/generate-footprint-tsx/convert-keepouts.ts
 import { su as su6 } from "@tscircuit/soup-util";
+var convertKeepouts = (circuitJson) => {
+  const pcbKeepouts = su6(circuitJson).pcb_keepout.list();
+  const elementStrings = [];
+  for (const keepout of pcbKeepouts) {
+    if (keepout.shape === "rect") {
+      elementStrings.push(
+        `<keepout shape="rect" pcbX="${formatMm(keepout.center.x)}" pcbY="${formatMm(keepout.center.y)}" width="${formatMm(keepout.width)}" height="${formatMm(keepout.height)}" />`
+      );
+    } else if (keepout.shape === "circle") {
+      elementStrings.push(
+        `<keepout shape="circle" pcbX="${formatMm(keepout.center.x)}" pcbY="${formatMm(keepout.center.y)}" radius="${formatMm(keepout.radius)}" />`
+      );
+    } else {
+      console.warn(`Unhandled pcb_keepout shape: ${keepout.shape}`);
+    }
+  }
+  return elementStrings;
+};
+
+// lib/generate-footprint-tsx/convert-notes.ts
+import { su as su7 } from "@tscircuit/soup-util";
 var convertNotes = (circuitJson) => {
-  const noteTexts = su6(circuitJson).pcb_note_text.list();
-  const noteRects = su6(circuitJson).pcb_note_rect.list();
-  const notePaths = su6(circuitJson).pcb_note_path.list();
-  const noteLines = su6(circuitJson).pcb_note_line.list();
-  const noteDimensions = su6(circuitJson).pcb_note_dimension.list();
+  const noteTexts = su7(circuitJson).pcb_note_text.list();
+  const noteRects = su7(circuitJson).pcb_note_rect.list();
+  const notePaths = su7(circuitJson).pcb_note_path.list();
+  const noteLines = su7(circuitJson).pcb_note_line.list();
+  const noteDimensions = su7(circuitJson).pcb_note_dimension.list();
   const elementStrings = [];
   for (const noteText of noteTexts) {
     const anchorPosition = noteText.anchor_position ?? { x: 0, y: 0 };
@@ -348,14 +369,14 @@ var convertNotes = (circuitJson) => {
 };
 
 // lib/generate-footprint-tsx/convert-plated-holes.ts
-import { su as su7 } from "@tscircuit/soup-util";
+import { su as su8 } from "@tscircuit/soup-util";
 import { mmStr as mmStr3 } from "@tscircuit/mm";
 var formatOptionalMmAttr = (attrName, value) => {
   if (value === void 0) return "";
   return ` ${attrName}="${mmStr3(value)}"`;
 };
 var convertPlatedHoles = (circuitJson) => {
-  const platedHoles = su7(circuitJson).pcb_plated_hole.list();
+  const platedHoles = su8(circuitJson).pcb_plated_hole.list();
   const elementStrings = [];
   for (const platedHole of platedHoles) {
     if (platedHole.shape === "oval" || platedHole.shape === "pill") {
@@ -385,12 +406,12 @@ var convertPlatedHoles = (circuitJson) => {
 };
 
 // lib/generate-footprint-tsx/convert-silkscreen.ts
-import { su as su8 } from "@tscircuit/soup-util";
+import { su as su9 } from "@tscircuit/soup-util";
 var convertSilkscreen = (circuitJson) => {
-  const silkscreenLines = su8(circuitJson).pcb_silkscreen_line.list();
-  const silkscreenPaths = su8(circuitJson).pcb_silkscreen_path.list();
-  const silkscreenRects = su8(circuitJson).pcb_silkscreen_rect.list();
-  const silkscreenCircles = su8(circuitJson).pcb_silkscreen_circle.list();
+  const silkscreenLines = su9(circuitJson).pcb_silkscreen_line.list();
+  const silkscreenPaths = su9(circuitJson).pcb_silkscreen_path.list();
+  const silkscreenRects = su9(circuitJson).pcb_silkscreen_rect.list();
+  const silkscreenCircles = su9(circuitJson).pcb_silkscreen_circle.list();
   const elementStrings = [];
   for (const silkscreenPath of silkscreenPaths) {
     elementStrings.push(
@@ -452,9 +473,9 @@ var convertSilkscreen = (circuitJson) => {
 };
 
 // lib/generate-footprint-tsx/convert-silkscreen-text.ts
-import { su as su9 } from "@tscircuit/soup-util";
+import { su as su10 } from "@tscircuit/soup-util";
 var convertSilkscreenText = (circuitJson) => {
-  const silkscreenTexts = su9(circuitJson).pcb_silkscreen_text.list();
+  const silkscreenTexts = su10(circuitJson).pcb_silkscreen_text.list();
   const elementStrings = [];
   for (const silkscreenText of silkscreenTexts) {
     const pcbX = silkscreenText.anchor_position?.x ?? 0;
@@ -467,10 +488,10 @@ var convertSilkscreenText = (circuitJson) => {
 };
 
 // lib/generate-footprint-tsx/convert-smt-pads.ts
-import { su as su10 } from "@tscircuit/soup-util";
+import { su as su11 } from "@tscircuit/soup-util";
 import { mmStr as mmStr4 } from "@tscircuit/mm";
 var convertSmtPads = (circuitJson) => {
-  const smtPads = su10(circuitJson).pcb_smtpad.list();
+  const smtPads = su11(circuitJson).pcb_smtpad.list();
   const elementStrings = [];
   for (const smtPad of smtPads) {
     if (smtPad.shape === "circle") {
@@ -508,6 +529,7 @@ var generateFootprintTsx = (circuitJson) => {
     convertFabrication,
     convertSilkscreenText,
     convertCopperText,
+    convertKeepouts,
     convertCutouts,
     convertNotes,
     convertCourtyard
@@ -524,15 +546,15 @@ var generateFootprintTsx = (circuitJson) => {
 };
 
 // lib/generate-symbol-tsx.ts
-import { su as su11 } from "@tscircuit/soup-util";
+import { su as su12 } from "@tscircuit/soup-util";
 var generateSymbolTsx = (circuitJson) => {
-  const schematicArcs = su11(circuitJson).schematic_arc.list();
-  const schematicLines = su11(circuitJson).schematic_line.list();
-  const schematicPaths = su11(circuitJson).schematic_path.list();
-  const schematicTexts = su11(circuitJson).schematic_text.list();
-  const schematicCircles = su11(circuitJson).schematic_circle.list();
-  const schematicBoxes = su11(circuitJson).schematic_box.list();
-  const schematicRects = su11(circuitJson).schematic_rect.list();
+  const schematicArcs = su12(circuitJson).schematic_arc.list();
+  const schematicLines = su12(circuitJson).schematic_line.list();
+  const schematicPaths = su12(circuitJson).schematic_path.list();
+  const schematicTexts = su12(circuitJson).schematic_text.list();
+  const schematicCircles = su12(circuitJson).schematic_circle.list();
+  const schematicBoxes = su12(circuitJson).schematic_box.list();
+  const schematicRects = su12(circuitJson).schematic_rect.list();
   const elementStrings = [];
   for (const arc of schematicArcs) {
     const center = arc.center ?? { x: 0, y: 0 };

package/dist/cli/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-O2XG7HJL.js";
+} from "../chunk-Y7MQ2KXU.js";
 
 // cli/main.ts
 import { Command } from "commander";
@@ -16,7 +16,7 @@ var package_default = {
     "./cli": "./dist/cli/main.js"
   },
   type: "module",
-  version: "0.0.28",
+  version: "0.0.29",
   scripts: {
     build: "tsup-node lib/index.ts cli/main.ts --format esm --dts",
     test: "bun test",

package/dist/lib/index.js

@@ -1,6 +1,6 @@
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-O2XG7HJL.js";
+} from "../chunk-Y7MQ2KXU.js";
 export {
   convertCircuitJsonToTscircuit
 };

package/lib/generate-footprint-tsx/convert-keepouts.ts

@@ -0,0 +1,24 @@
+import { su } from "@tscircuit/soup-util"
+import type { FootprintElementConverter } from "./converter-types"
+import { formatMm } from "./helpers"
+
+export const convertKeepouts: FootprintElementConverter = (circuitJson) => {
+  const pcbKeepouts = su(circuitJson).pcb_keepout.list()
+  const elementStrings: string[] = []
+
+  for (const keepout of pcbKeepouts) {
+    if (keepout.shape === "rect") {
+      elementStrings.push(
+        `<keepout shape="rect" pcbX="${formatMm(keepout.center.x)}" pcbY="${formatMm(keepout.center.y)}" width="${formatMm(keepout.width)}" height="${formatMm(keepout.height)}" />`,
+      )
+    } else if (keepout.shape === "circle") {
+      elementStrings.push(
+        `<keepout shape="circle" pcbX="${formatMm(keepout.center.x)}" pcbY="${formatMm(keepout.center.y)}" radius="${formatMm(keepout.radius)}" />`,
+      )
+    } else {
+      console.warn(`Unhandled pcb_keepout shape: ${(keepout as any).shape}`)
+    }
+  }
+
+  return elementStrings
+}

package/lib/generate-footprint-tsx.tsx

@@ -5,6 +5,7 @@ import { convertCourtyard } from "./generate-footprint-tsx/convert-courtyard"
 import { convertCutouts } from "./generate-footprint-tsx/convert-cutouts"
 import { convertFabrication } from "./generate-footprint-tsx/convert-fabrication"
 import { convertHoles } from "./generate-footprint-tsx/convert-holes"
+import { convertKeepouts } from "./generate-footprint-tsx/convert-keepouts"
 import { convertNotes } from "./generate-footprint-tsx/convert-notes"
 import { convertPlatedHoles } from "./generate-footprint-tsx/convert-plated-holes"
 import { convertSilkscreen } from "./generate-footprint-tsx/convert-silkscreen"
@@ -22,6 +23,7 @@ export const generateFootprintTsx = (
     convertFabrication,
     convertSilkscreenText,
     convertCopperText,
+    convertKeepouts,
     convertCutouts,
     convertNotes,
     convertCourtyard,

package/package.json

@@ -6,7 +6,7 @@
     "./cli": "./dist/cli/main.js"
   },
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "scripts": {
     "build": "tsup-node lib/index.ts cli/main.ts --format esm --dts",
     "test": "bun test",

package/tests/__snapshots__/test17-support-pcb-keepouts-pcb.snap.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="800" height="600" data-software-used-string="@tscircuit/core@0.0.1090"><style></style><defs><pattern id="pcb-keepout-pattern" width="20" height="20" patternUnits="userSpaceOnUse"><line x1="-20" y1="0" x2="0" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="-15" y1="0" x2="5" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="-10" y1="0" x2="10" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="-5" y1="0" x2="15" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="0" y1="0" x2="20" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="5" y1="0" x2="25" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="10" y1="0" x2="30" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="15" y1="0" x2="35" y2="20" stroke="#FF6B6B" stroke-width="1"/><line x1="20" y1="0" x2="40" y2="20" stroke="#FF6B6B" stroke-width="1"/></pattern></defs><rect class="boundary" x="0" y="0" fill="#000" width="800" height="600" data-type="pcb_background" data-pcb-layer="global"/><rect class="pcb-boundary" fill="none" stroke="#fff" stroke-width="0.3" x="127.27272727272725" y="27.272727272727252" width="545.4545454545455" height="545.4545454545455" data-type="pcb_boundary" data-pcb-layer="global"/><path class="pcb-board" d="M 127.27272727272725 572.7272727272727 L 672.7272727272727 572.7272727272727 L 672.7272727272727 27.272727272727252 L 127.27272727272725 27.272727272727252 Z" fill="none" stroke="rgba(255, 255, 255, 0.5)" stroke-width="2.7272727272727275" data-type="pcb_board" data-pcb-layer="board"/><rect class="pcb-keepout pcb-keepout-rect pcb-keepout-background" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_0" stroke="none" x="-43.63636363636364" y="-19.09090909090909" width="87.27272727272728" height="38.18181818181818" fill="rgba(255, 107, 107, 0.2)" transform="matrix(1,0,0,1,359.0909090909091,245.45454545454544)"/><rect class="pcb-keepout pcb-keepout-rect pcb-keepout-pattern" fill="url(#pcb-keepout-pattern)" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_0" stroke="none" x="-43.63636363636364" y="-19.09090909090909" width="87.27272727272728" height="38.18181818181818" transform="matrix(1,0,0,1,359.0909090909091,245.45454545454544)"/><circle class="pcb-keepout pcb-keepout-circle pcb-keepout-background" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_1" stroke="none" cx="468.1818181818182" cy="327.27272727272725" r="24.545454545454547" fill="rgba(255, 107, 107, 0.2)"/><circle class="pcb-keepout pcb-keepout-circle pcb-keepout-pattern" fill="url(#pcb-keepout-pattern)" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_1" stroke="none" cx="468.1818181818182" cy="327.27272727272725" r="24.545454545454547"/><rect class="pcb-keepout pcb-keepout-rect pcb-keepout-background" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_2" stroke="none" x="-43.63636363636364" y="-19.09090909090909" width="87.27272727272728" height="38.18181818181818" fill="rgba(255, 107, 107, 0.2)" transform="matrix(1,0,0,1,359.0909090909091,245.45454545454544)"/><rect class="pcb-keepout pcb-keepout-rect pcb-keepout-pattern" fill="url(#pcb-keepout-pattern)" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_2" stroke="none" x="-43.63636363636364" y="-19.09090909090909" width="87.27272727272728" height="38.18181818181818" transform="matrix(1,0,0,1,359.0909090909091,245.45454545454544)"/><circle class="pcb-keepout pcb-keepout-circle pcb-keepout-background" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_3" stroke="none" cx="468.1818181818182" cy="327.27272727272725" r="24.545454545454547" fill="rgba(255, 107, 107, 0.2)"/><circle class="pcb-keepout pcb-keepout-circle pcb-keepout-pattern" fill="url(#pcb-keepout-pattern)" data-type="pcb_keepout" data-pcb-layer="top" data-pcb-keepout-id="pcb_keepout_3" stroke="none" cx="468.1818181818182" cy="327.27272727272725" r="24.545454545454547"/></svg>

package/tests/test17-support-pcb-keepouts.test.tsx

@@ -0,0 +1,82 @@
+import { expect, test } from "bun:test"
+import { convertCircuitJsonToPcbSvg } from "circuit-to-svg"
+import type { AnyCircuitElement } from "circuit-json"
+import { convertCircuitJsonToTscircuit } from "lib"
+import { runTscircuitCode } from "tscircuit"
+
+test("test17 support pcb keepouts", async () => {
+  const tscircuit = convertCircuitJsonToTscircuit(circuitJson, {
+    componentName: "Test17Component",
+  })
+
+  expect(tscircuit).toMatchInlineSnapshot(`
+    "import { type ChipProps } from "tscircuit"
+    export const Test17Component = (props: ChipProps) => (
+      <chip
+        footprint={<footprint>
+            <keepout shape="rect" pcbX="-1.5mm" pcbY="2mm" width="3.2mm" height="1.4mm" />
+    <keepout shape="circle" pcbX="2.5mm" pcbY="-1mm" radius="0.9mm" />
+          </footprint>}
+        {...props}
+      />
+    )"
+  `)
+
+  const renderedCircuitJson = (await runTscircuitCode(`
+${tscircuit}
+
+circuit.add(
+  <board width="20mm" height="20mm">
+    <Test17Component />
+  </board>,
+)
+  `)) as AnyCircuitElement[]
+
+  const renderedKeepouts = renderedCircuitJson.filter(
+    (elm) => elm.type === "pcb_keepout",
+  )
+
+  expect(renderedKeepouts.length).toBeGreaterThanOrEqual(2)
+  expect(renderedKeepouts).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        type: "pcb_keepout",
+        layers: ["top"],
+        shape: "rect",
+        width: 3.2,
+        height: 1.4,
+        center: { x: -1.5, y: 2 },
+      }),
+      expect.objectContaining({
+        type: "pcb_keepout",
+        layers: ["top"],
+        shape: "circle",
+        radius: 0.9,
+        center: { x: 2.5, y: -1 },
+      }),
+    ]),
+  )
+
+  const pcbSvg = convertCircuitJsonToPcbSvg(renderedCircuitJson)
+  await expect(pcbSvg).toMatchSvgSnapshot(import.meta.path, "pcb")
+})
+
+const circuitJson: AnyCircuitElement[] = [
+  {
+    type: "pcb_keepout",
+    pcb_keepout_id: "keepout_rect",
+    shape: "rect",
+    center: { x: -1.5, y: 2 },
+    width: 3.2,
+    height: 1.4,
+    layers: ["top"],
+  },
+  {
+    type: "pcb_keepout",
+    pcb_keepout_id: "keepout_circle",
+    shape: "circle",
+    center: { x: 2.5, y: -1 },
+    radius: 0.9,
+    layers: ["top"],
+  },
+]