circuit-json-to-tscircuit 0.0.59 → 0.0.60

package/dist/{chunk-QMIS5SJZ.js → chunk-76BQ2MMR.js}

@@ -499,6 +499,39 @@ var convertKeepouts = (circuitJson) => {
 
 // lib/generate-footprint-tsx/convert-notes.ts
 import { su as su8 } from "@tscircuit/soup-util";
+
+// lib/generate-footprint-tsx/convert-pcb-note-dimension.ts
+var convertPcbNoteDimension = (dimension) => {
+  const from = dimension.from ?? { x: 0, y: 0 };
+  const to = dimension.to ?? { x: 0, y: 0 };
+  const legacyOffset = "offset" in dimension && typeof dimension.offset === "number" ? dimension.offset : void 0;
+  const offsetDistance = dimension.offset_distance ?? legacyOffset;
+  const attrs = [
+    `from={{ x: ${from.x}, y: ${from.y} }}`,
+    `to={{ x: ${to.x}, y: ${to.y} }}`,
+    `font="${dimension.font ?? "tscircuit2024"}"`,
+    `fontSize={${dimension.font_size ?? 0}}`
+  ];
+  if (dimension.arrow_size !== void 0) {
+    attrs.push(`arrowSize={${dimension.arrow_size}}`);
+  }
+  if (offsetDistance !== void 0) {
+    attrs.push(`offset={${offsetDistance}}`);
+  }
+  if (dimension.offset_direction !== void 0) {
+    attrs.push(
+      `offsetDirection={${JSON.stringify(dimension.offset_direction)}}`
+    );
+  }
+  if (dimension.text !== void 0) {
+    attrs.push(`text="${escapeJsxText(dimension.text)}"`);
+  }
+  if (dimension.color !== void 0) attrs.push(`color="${dimension.color}"`);
+  if (dimension.layer === "bottom") attrs.push(`layer="bottom"`);
+  return [`<pcbnotedimension ${attrs.join(" ")} />`];
+};
+
+// lib/generate-footprint-tsx/convert-notes.ts
 var convertNotes = (circuitJson) => {
   const noteTexts = su8(circuitJson).pcb_note_text.list();
   const noteRects = su8(circuitJson).pcb_note_rect.list();
@@ -565,30 +598,7 @@ var convertNotes = (circuitJson) => {
     elementStrings.push(`<pcbnoteline ${attrs.join(" ")} />`);
   }
   for (const noteDimension of noteDimensions) {
-    const fromPoint = noteDimension.from ?? { x: 0, y: 0 };
-    const toPoint2 = noteDimension.to ?? { x: 0, y: 0 };
-    const attrs = [
-      `from={{ x: ${fromPoint.x}, y: ${fromPoint.y} }}`,
-      `to={{ x: ${toPoint2.x}, y: ${toPoint2.y} }}`,
-      `font="${noteDimension.font ?? "tscircuit2024"}"`,
-      `fontSize={${noteDimension.font_size ?? 0}}`
-    ];
-    if (noteDimension.arrow_size !== void 0) {
-      attrs.push(`arrowSize={${noteDimension.arrow_size}}`);
-    }
-    if ("offset" in noteDimension) {
-      const offsetValue = noteDimension.offset;
-      if (offsetValue !== void 0) {
-        attrs.push(`offset={${offsetValue}}`);
-      }
-    }
-    if (noteDimension.text !== void 0) {
-      attrs.push(`text="${escapeJsxText(noteDimension.text)}"`);
-    }
-    if (noteDimension.color !== void 0) {
-      attrs.push(`color="${noteDimension.color}"`);
-    }
-    elementStrings.push(`<pcbnotedimension ${attrs.join(" ")} />`);
+    elementStrings.push(...convertPcbNoteDimension(noteDimension));
   }
   return elementStrings;
 };

package/dist/cli/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-QMIS5SJZ.js";
+} from "../chunk-76BQ2MMR.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.58",
+  version: "0.0.59",
   repository: {
     type: "git",
     url: "https://github.com/tscircuit/circuit-json-to-tscircuit.git"
@@ -43,7 +43,7 @@ var package_default = {
     prettier: "^3.9.5",
     shiki: "^4.3.1",
     "stack-svgs": "^0.0.1",
-    tscircuit: "^0.0.2696",
+    tscircuit: "0.0.2703-libonly",
     tsup: "^8.3.5",
     zod: "^3.25.76"
   },

package/dist/lib/index.js

@@ -1,6 +1,6 @@
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-QMIS5SJZ.js";
+} from "../chunk-76BQ2MMR.js";
 export {
   convertCircuitJsonToTscircuit
 };

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

@@ -1,6 +1,7 @@
 import { su } from "@tscircuit/soup-util"
 import type { FootprintElementConverter } from "./converter-types"
 import { escapeJsxText } from "./footprint-tsx-attribute-formatters/escape-jsx-text"
+import { convertPcbNoteDimension } from "./convert-pcb-note-dimension"
 
 export const convertNotes: FootprintElementConverter = (circuitJson) => {
   const noteTexts = su(circuitJson).pcb_note_text.list()
@@ -80,34 +81,7 @@ export const convertNotes: FootprintElementConverter = (circuitJson) => {
   }
 
   for (const noteDimension of noteDimensions) {
-    const fromPoint = noteDimension.from ?? { x: 0, y: 0 }
-    const toPoint = noteDimension.to ?? { x: 0, y: 0 }
-    const attrs = [
-      `from={{ x: ${fromPoint.x}, y: ${fromPoint.y} }}`,
-      `to={{ x: ${toPoint.x}, y: ${toPoint.y} }}`,
-      `font="${noteDimension.font ?? "tscircuit2024"}"`,
-      `fontSize={${noteDimension.font_size ?? 0}}`,
-    ]
-
-    if (noteDimension.arrow_size !== undefined) {
-      attrs.push(`arrowSize={${noteDimension.arrow_size}}`)
-    }
-
-    if ("offset" in noteDimension) {
-      const offsetValue = (noteDimension as { offset?: number }).offset
-      if (offsetValue !== undefined) {
-        attrs.push(`offset={${offsetValue}}`)
-      }
-    }
-
-    if (noteDimension.text !== undefined) {
-      attrs.push(`text="${escapeJsxText(noteDimension.text)}"`)
-    }
-    if (noteDimension.color !== undefined) {
-      attrs.push(`color="${noteDimension.color}"`)
-    }
-
-    elementStrings.push(`<pcbnotedimension ${attrs.join(" ")} />`)
+    elementStrings.push(...convertPcbNoteDimension(noteDimension))
   }
 
   return elementStrings

package/lib/generate-footprint-tsx/convert-pcb-note-dimension.ts

@@ -0,0 +1,39 @@
+import type { PcbNoteDimension } from "circuit-json"
+import { escapeJsxText } from "./footprint-tsx-attribute-formatters/escape-jsx-text"
+
+export const convertPcbNoteDimension = (
+  dimension: PcbNoteDimension,
+): string[] => {
+  const from = dimension.from ?? { x: 0, y: 0 }
+  const to = dimension.to ?? { x: 0, y: 0 }
+  const legacyOffset =
+    "offset" in dimension && typeof dimension.offset === "number"
+      ? dimension.offset
+      : undefined
+  const offsetDistance = dimension.offset_distance ?? legacyOffset
+  const attrs = [
+    `from={{ x: ${from.x}, y: ${from.y} }}`,
+    `to={{ x: ${to.x}, y: ${to.y} }}`,
+    `font="${dimension.font ?? "tscircuit2024"}"`,
+    `fontSize={${dimension.font_size ?? 0}}`,
+  ]
+
+  if (dimension.arrow_size !== undefined) {
+    attrs.push(`arrowSize={${dimension.arrow_size}}`)
+  }
+  if (offsetDistance !== undefined) {
+    attrs.push(`offset={${offsetDistance}}`)
+  }
+  if (dimension.offset_direction !== undefined) {
+    attrs.push(
+      `offsetDirection={${JSON.stringify(dimension.offset_direction)}}`,
+    )
+  }
+  if (dimension.text !== undefined) {
+    attrs.push(`text="${escapeJsxText(dimension.text)}"`)
+  }
+  if (dimension.color !== undefined) attrs.push(`color="${dimension.color}"`)
+  if (dimension.layer === "bottom") attrs.push(`layer="bottom"`)
+
+  return [`<pcbnotedimension ${attrs.join(" ")} />`]
+}

package/package.json

@@ -6,7 +6,7 @@
     "./cli": "./dist/cli/main.js"
   },
   "type": "module",
-  "version": "0.0.59",
+  "version": "0.0.60",
   "repository": {
     "type": "git",
     "url": "https://github.com/tscircuit/circuit-json-to-tscircuit.git"
@@ -33,7 +33,7 @@
     "prettier": "^3.9.5",
     "shiki": "^4.3.1",
     "stack-svgs": "^0.0.1",
-    "tscircuit": "^0.0.2696",
+    "tscircuit": "0.0.2703-libonly",
     "tsup": "^8.3.5",
     "zod": "^3.25.76"
   },

package/tests/__snapshots__/pcb-note-dimension-offset-comparison.snap.svg

@@ -0,0 +1,8 @@
+<svg width="1624" height="600" viewBox="0 0 1624 600" xmlns="http://www.w3.org/2000/svg" aria-label="PCB note dimension source on left, generated tscircuit render on right" role="img">
+  <g transform="translate(0, 0)">
+    <style></style><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="100" y="50" width="600" height="500" data-type="pcb_boundary" data-pcb-layer="global"/><path class="pcb-board" d="M 100 550 L 700 550 L 700 50 L 100 50 Z" fill="none" stroke="rgba(255, 255, 255, 0.5)" stroke-width="5" data-type="pcb_board" data-pcb-layer="board"/><g class="pcb-note-dimension" data-type="pcb_note_dimension" data-pcb-note-dimension-id="pcb_note_dimension_0" data-pcb-layer="overlay"><path d="M 250 300 L 276.5165042944955 326.5165042944955" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-extension"/><path d="M 550 300 L 576.5165042944955 326.5165042944955" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-extension"/><path d="M 283.83883476483186 308.83883476483186 L 533.8388347648319 308.83883476483186" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-line"/><path d="M 258.83883476483186 308.83883476483186 L 283.83883476483186 296.33883476483186 L 283.83883476483186 321.33883476483186 Z" fill="#facc15" class="pcb-note-dimension-arrow"/><path d="M 558.8388347648319 308.83883476483186 L 533.8388347648319 296.33883476483186 L 533.8388347648319 321.33883476483186 Z" fill="#facc15" class="pcb-note-dimension-arrow"/><text x="408.83883476483186" y="271.33883476483186" fill="#facc15" font-size="40" font-family="Arial, sans-serif" text-anchor="middle" dominant-baseline="central" class="pcb-note-dimension-text" transform="rotate(0 408.83883476483186 271.33883476483186)">6 mm</text></g>
+  </g>
+  <g transform="translate(824, 0)">
+    <style></style><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="100" y="50" width="600" height="500" data-type="pcb_boundary" data-pcb-layer="global"/><path class="pcb-board" d="M 100 550 L 700 550 L 700 50 L 100 50 Z" fill="none" stroke="rgba(255, 255, 255, 0.5)" stroke-width="5" data-type="pcb_board" data-pcb-layer="board"/><g class="pcb-note-dimension" data-type="pcb_note_dimension" data-pcb-note-dimension-id="pcb_note_dimension_0__stack1" data-pcb-layer="overlay"><path d="M 250 300 L 276.5165042944955 326.5165042944955" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-extension"/><path d="M 550 300 L 576.5165042944955 326.5165042944955" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-extension"/><path d="M 283.83883476483186 308.83883476483186 L 533.8388347648319 308.83883476483186" stroke="#facc15" fill="none" stroke-width="5" stroke-linecap="round" class="pcb-note-dimension-line"/><path d="M 258.83883476483186 308.83883476483186 L 283.83883476483186 296.33883476483186 L 283.83883476483186 321.33883476483186 Z" fill="#facc15" class="pcb-note-dimension-arrow"/><path d="M 558.8388347648319 308.83883476483186 L 533.8388347648319 296.33883476483186 L 533.8388347648319 321.33883476483186 Z" fill="#facc15" class="pcb-note-dimension-arrow"/><text x="408.83883476483186" y="271.33883476483186" fill="#facc15" font-size="40" font-family="Arial, sans-serif" text-anchor="middle" dominant-baseline="central" class="pcb-note-dimension-text" transform="rotate(0 408.83883476483186 271.33883476483186)">6 mm</text></g>
+  </g>
+</svg>

package/tests/pcb-note-dimension-offset.test.tsx

@@ -0,0 +1,72 @@
+import { expect, test } from "bun:test"
+import type { CircuitJson } from "circuit-json"
+import { convertCircuitJsonToPcbSvg } from "circuit-to-svg"
+import { convertCircuitJsonToTscircuit } from "lib"
+import { stackSvgsHorizontally } from "stack-svgs"
+import { runTscircuitCode } from "tscircuit"
+
+test("preserves PCB note dimension offset direction", async () => {
+  const generatedTscircuit = convertCircuitJsonToTscircuit(sourceCircuitJson, {
+    componentName: "PcbNoteDimensionBoard",
+  })
+  const renderedCircuitJson = (await runTscircuitCode(
+    generatedTscircuit,
+  )) as CircuitJson
+  const renderedDimension = renderedCircuitJson.find(
+    (element) => element.type === "pcb_note_dimension",
+  )
+  expect(renderedDimension).toMatchObject({
+    from: { x: -3, y: 0 },
+    to: { x: 3, y: 0 },
+    layer: "bottom",
+    offset_distance: 0.25,
+    offset_direction: { x: 1, y: -1 },
+  })
+  expect(
+    renderedCircuitJson.filter((element) => element.type === "pcb_note_path"),
+  ).toHaveLength(0)
+
+  const comparisonSvg = stackSvgsHorizontally(
+    [
+      convertCircuitJsonToPcbSvg(sourceCircuitJson),
+      convertCircuitJsonToPcbSvg(renderedCircuitJson),
+    ],
+    {
+      gap: 24,
+      targetSize: 800,
+      rootAttributes: {
+        "aria-label":
+          "PCB note dimension source on left, generated tscircuit render on right",
+        role: "img",
+      },
+    },
+  )
+  await expect(comparisonSvg).toMatchSvgSnapshot(import.meta.path, "comparison")
+})
+
+const sourceCircuitJson: CircuitJson = [
+  {
+    type: "pcb_board",
+    pcb_board_id: "pcb_board_0",
+    center: { x: 0, y: 0 },
+    width: 12,
+    height: 10,
+    thickness: 1.6,
+    num_layers: 2,
+    material: "fr4",
+  },
+  {
+    type: "pcb_note_dimension",
+    pcb_note_dimension_id: "pcb_note_dimension_0",
+    layer: "bottom",
+    from: { x: -3, y: 0 },
+    to: { x: 3, y: 0 },
+    text: "6 mm",
+    font: "tscircuit2024",
+    font_size: 0.8,
+    color: "#facc15",
+    arrow_size: 0.5,
+    offset_distance: 0.25,
+    offset_direction: { x: 1, y: -1 },
+  },
+]