circuit-to-canvas 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AnyCircuitElement, PcbPlatedHole, PCBVia, PCBHole, PcbSmtPad, PCBTrace, PcbBoard, PcbSilkscreenText, PcbSilkscreenRect, PcbSilkscreenCircle, PcbSilkscreenLine, PcbSilkscreenPath, PcbCutout, PcbCopperPour, PcbCopperText, PcbFabricationNoteText, PcbFabricationNoteRect, PcbFabricationNotePath } from 'circuit-json';
+import { AnyCircuitElement, PcbPlatedHole, PCBVia, PCBHole, PcbSmtPad, PCBTrace, PcbBoard, PcbSilkscreenText, PcbSilkscreenRect, PcbSilkscreenCircle, PcbSilkscreenLine, PcbSilkscreenPath, PcbCutout, PcbCopperPour, PcbCopperText, PcbFabricationNoteText, PcbFabricationNoteRect, PcbNoteRect, PcbFabricationNotePath } from 'circuit-json';
 import { Matrix } from 'transformation-matrix';
 
 /**
@@ -355,6 +355,14 @@ interface DrawPcbFabricationNoteRectParams {
 }
 declare function drawPcbFabricationNoteRect(params: DrawPcbFabricationNoteRectParams): void;
 
+interface DrawPcbNoteRectParams {
+    ctx: CanvasContext;
+    rect: PcbNoteRect;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbNoteRect(params: DrawPcbNoteRectParams): void;
+
 interface DrawPcbFabricationNotePathParams {
     ctx: CanvasContext;
     path: PcbFabricationNotePath;
@@ -363,4 +371,4 @@ interface DrawPcbFabricationNotePathParams {
 }
 declare function drawPcbFabricationNotePath(params: DrawPcbFabricationNotePathParams): void;
 
-export { type AlphabetLayout, type AnchorAlignment, type CameraBounds, type CanvasContext, CircuitToCanvasDrawer, type CopperColorMap, type CopperLayerName, DEFAULT_PCB_COLOR_MAP, type DrawCircleParams, type DrawContext, type DrawElementsOptions, type DrawLineParams, type DrawOvalParams, type DrawPathParams, type DrawPcbBoardParams, type DrawPcbCopperPourParams, type DrawPcbCopperTextParams, type DrawPcbCutoutParams, type DrawPcbFabricationNotePathParams, type DrawPcbFabricationNoteRectParams, type DrawPcbFabricationNoteTextParams, type DrawPcbHoleParams, type DrawPcbPlatedHoleParams, type DrawPcbSilkscreenCircleParams, type DrawPcbSilkscreenLineParams, type DrawPcbSilkscreenPathParams, type DrawPcbSilkscreenRectParams, type DrawPcbSilkscreenTextParams, type DrawPcbSmtPadParams, type DrawPcbTraceParams, type DrawPcbViaParams, type DrawPillParams, type DrawPolygonParams, type DrawRectParams, type DrawTextParams, type DrawerConfig, type PcbColorMap, drawCircle, drawLine, drawOval, drawPath, drawPcbBoard, drawPcbCopperPour, drawPcbCopperText, drawPcbCutout, drawPcbFabricationNotePath, drawPcbFabricationNoteRect, drawPcbFabricationNoteText, drawPcbHole, drawPcbPlatedHole, drawPcbSilkscreenCircle, drawPcbSilkscreenLine, drawPcbSilkscreenPath, drawPcbSilkscreenRect, drawPcbSilkscreenText, drawPcbSmtPad, drawPcbTrace, drawPcbVia, drawPill, drawPolygon, drawRect, drawText, getAlphabetLayout, getTextStartPosition, strokeAlphabetText };
+export { type AlphabetLayout, type AnchorAlignment, type CameraBounds, type CanvasContext, CircuitToCanvasDrawer, type CopperColorMap, type CopperLayerName, DEFAULT_PCB_COLOR_MAP, type DrawCircleParams, type DrawContext, type DrawElementsOptions, type DrawLineParams, type DrawOvalParams, type DrawPathParams, type DrawPcbBoardParams, type DrawPcbCopperPourParams, type DrawPcbCopperTextParams, type DrawPcbCutoutParams, type DrawPcbFabricationNotePathParams, type DrawPcbFabricationNoteRectParams, type DrawPcbFabricationNoteTextParams, type DrawPcbHoleParams, type DrawPcbNoteRectParams, type DrawPcbPlatedHoleParams, type DrawPcbSilkscreenCircleParams, type DrawPcbSilkscreenLineParams, type DrawPcbSilkscreenPathParams, type DrawPcbSilkscreenRectParams, type DrawPcbSilkscreenTextParams, type DrawPcbSmtPadParams, type DrawPcbTraceParams, type DrawPcbViaParams, type DrawPillParams, type DrawPolygonParams, type DrawRectParams, type DrawTextParams, type DrawerConfig, type PcbColorMap, drawCircle, drawLine, drawOval, drawPath, drawPcbBoard, drawPcbCopperPour, drawPcbCopperText, drawPcbCutout, drawPcbFabricationNotePath, drawPcbFabricationNoteRect, drawPcbFabricationNoteText, drawPcbHole, drawPcbNoteRect, drawPcbPlatedHole, drawPcbSilkscreenCircle, drawPcbSilkscreenLine, drawPcbSilkscreenPath, drawPcbSilkscreenRect, drawPcbSilkscreenText, drawPcbSmtPad, drawPcbTrace, drawPcbVia, drawPill, drawPolygon, drawRect, drawText, getAlphabetLayout, getTextStartPosition, strokeAlphabetText };

package/dist/index.js

@@ -1055,6 +1055,28 @@ function drawPcbFabricationNoteRect(params) {
   });
 }
 
+// lib/drawer/elements/pcb-note-rect.ts
+function drawPcbNoteRect(params) {
+  const { ctx, rect, transform, colorMap } = params;
+  const defaultColor = "rgb(89, 148, 220)";
+  const color = rect.color ?? defaultColor;
+  const isFilled = rect.is_filled ?? false;
+  const hasStroke = rect.has_stroke ?? true;
+  const isStrokeDashed = rect.is_stroke_dashed ?? false;
+  drawRect({
+    ctx,
+    center: rect.center,
+    width: rect.width,
+    height: rect.height,
+    fill: isFilled ? color : void 0,
+    stroke: hasStroke ? color : void 0,
+    strokeWidth: hasStroke ? rect.stroke_width : void 0,
+    borderRadius: rect.corner_radius,
+    transform,
+    isStrokeDashed
+  });
+}
+
 // lib/drawer/elements/pcb-fabrication-note-path.ts
 function drawPcbFabricationNotePath(params) {
   const { ctx, path, transform, colorMap } = params;
@@ -1273,6 +1295,14 @@ var CircuitToCanvasDrawer = class {
         colorMap: this.colorMap
       });
     }
+    if (element.type === "pcb_note_rect") {
+      drawPcbNoteRect({
+        transform: this.realToCanvasMat,
+        colorMap: this.colorMap,
+        ctx: this.ctx,
+        rect: element
+      });
+    }
     if (element.type === "pcb_fabrication_note_path") {
       drawPcbFabricationNotePath({
         ctx: this.ctx,
@@ -1298,6 +1328,7 @@ export {
   drawPcbFabricationNoteRect,
   drawPcbFabricationNoteText,
   drawPcbHole,
+  drawPcbNoteRect,
   drawPcbPlatedHole,
   drawPcbSilkscreenCircle,
   drawPcbSilkscreenLine,

package/lib/drawer/CircuitToCanvasDrawer.ts

@@ -16,6 +16,7 @@ import type {
   PcbCopperText,
   PcbFabricationNoteText,
   PcbFabricationNoteRect,
+  PcbNoteRect,
   PcbFabricationNotePath,
 } from "circuit-json"
 import { identity, compose, translate, scale } from "transformation-matrix"
@@ -45,6 +46,7 @@ import { drawPcbCopperPour } from "./elements/pcb-copper-pour"
 import { drawPcbCopperText } from "./elements/pcb-copper-text"
 import { drawPcbFabricationNoteText } from "./elements/pcb-fabrication-note-text"
 import { drawPcbFabricationNoteRect } from "./elements/pcb-fabrication-note-rect"
+import { drawPcbNoteRect } from "./elements/pcb-note-rect"
 import { drawPcbFabricationNotePath } from "./elements/pcb-fabrication-note-path"
 
 export interface DrawElementsOptions {
@@ -288,6 +290,15 @@ export class CircuitToCanvasDrawer {
       })
     }
 
+    if (element.type === "pcb_note_rect") {
+      drawPcbNoteRect({
+        transform: this.realToCanvasMat,
+        colorMap: this.colorMap,
+        ctx: this.ctx,
+        rect: element as PcbNoteRect,
+      })
+    }
+
     if (element.type === "pcb_fabrication_note_path") {
       drawPcbFabricationNotePath({
         ctx: this.ctx,

package/lib/drawer/elements/index.ts

@@ -48,6 +48,11 @@ export {
   type DrawPcbFabricationNoteRectParams,
 } from "./pcb-fabrication-note-rect"
 
+export {
+  drawPcbNoteRect,
+  type DrawPcbNoteRectParams,
+} from "./pcb-note-rect"
+
 export {
   drawPcbFabricationNotePath,
   type DrawPcbFabricationNotePathParams,

package/lib/drawer/elements/pcb-note-rect.ts

@@ -0,0 +1,37 @@
+import type { PcbNoteRect } from "circuit-json"
+import type { Matrix } from "transformation-matrix"
+import type { PcbColorMap, CanvasContext } from "../types"
+import { drawRect } from "../shapes/rect"
+
+export interface DrawPcbNoteRectParams {
+  ctx: CanvasContext
+  rect: PcbNoteRect
+  transform: Matrix
+  colorMap: PcbColorMap
+}
+
+export function drawPcbNoteRect(params: DrawPcbNoteRectParams): void {
+  const { ctx, rect, transform, colorMap } = params
+
+  // Use the color from the rect if provided, otherwise use a default color
+  // Notes are typically shown in a distinct color
+  const defaultColor = "rgb(89, 148, 220)" // White color for notes
+  const color = rect.color ?? defaultColor
+
+  const isFilled = rect.is_filled ?? false
+  const hasStroke = rect.has_stroke ?? true
+  const isStrokeDashed = rect.is_stroke_dashed ?? false
+
+  drawRect({
+    ctx,
+    center: rect.center,
+    width: rect.width,
+    height: rect.height,
+    fill: isFilled ? color : undefined,
+    stroke: hasStroke ? color : undefined,
+    strokeWidth: hasStroke ? rect.stroke_width : undefined,
+    borderRadius: rect.corner_radius,
+    transform,
+    isStrokeDashed,
+  })
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "circuit-to-canvas",
   "main": "dist/index.js",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "type": "module",
   "scripts": {
     "build": "tsup-node ./lib/index.ts --format esm --dts",

package/tests/elements/pcb-note-rect-all-features.test.ts

@@ -0,0 +1,38 @@
+import { expect, test } from "bun:test"
+import { createCanvas } from "canvas"
+import type { PcbNoteRect } from "circuit-json"
+import { CircuitToCanvasDrawer } from "../../lib/drawer"
+
+test("draw pcb note rect with all features", async () => {
+  const canvas = createCanvas(100, 100)
+  const ctx = canvas.getContext("2d")
+  const drawer = new CircuitToCanvasDrawer(ctx)
+
+  ctx.fillStyle = "#1a1a1a"
+  ctx.fillRect(0, 0, 100, 100)
+
+  const rect: PcbNoteRect = {
+    type: "pcb_note_rect",
+    pcb_note_rect_id: "note_rect1",
+    pcb_component_id: "component1",
+    pcb_group_id: "group1",
+    subcircuit_id: "subcircuit1",
+    name: "Test Note",
+    text: "This is a test note",
+    center: { x: 50, y: 50 },
+    width: 60,
+    height: 40,
+    stroke_width: 2,
+    corner_radius: 5,
+    is_filled: true,
+    has_stroke: true,
+    is_stroke_dashed: true,
+    color: "#00FFFF", // Cyan color
+  }
+
+  drawer.drawElements([rect])
+
+  await expect(canvas.toBuffer("image/png")).toMatchPngSnapshot(
+    import.meta.path,
+  )
+})

package/tests/elements/pcb-note-rect-dashed-stroke.test.ts

@@ -0,0 +1,32 @@
+import { expect, test } from "bun:test"
+import { createCanvas } from "canvas"
+import type { PcbNoteRect } from "circuit-json"
+import { CircuitToCanvasDrawer } from "../../lib/drawer"
+
+test("draw pcb note rect with dashed stroke and no fill", async () => {
+  const canvas = createCanvas(100, 100)
+  const ctx = canvas.getContext("2d")
+  const drawer = new CircuitToCanvasDrawer(ctx)
+
+  ctx.fillStyle = "#1a1a1a"
+  ctx.fillRect(0, 0, 100, 100)
+
+  const rect: PcbNoteRect = {
+    type: "pcb_note_rect",
+    pcb_note_rect_id: "note_rect2",
+    center: { x: 50, y: 50 },
+    width: 60,
+    height: 40,
+    stroke_width: 2,
+    is_filled: false,
+    has_stroke: true,
+    is_stroke_dashed: true,
+    color: "#0000FF", // Blue color
+  }
+
+  drawer.drawElements([rect])
+
+  await expect(canvas.toBuffer("image/png")).toMatchPngSnapshot(
+    import.meta.path,
+  )
+})

package/tests/elements/pcb-note-rect-filled-no-stroke.test.ts

@@ -0,0 +1,32 @@
+import { expect, test } from "bun:test"
+import { createCanvas } from "canvas"
+import type { PcbNoteRect } from "circuit-json"
+import { CircuitToCanvasDrawer } from "../../lib/drawer"
+
+test("draw pcb note rect with fill and no stroke", async () => {
+  const canvas = createCanvas(100, 100)
+  const ctx = canvas.getContext("2d")
+  const drawer = new CircuitToCanvasDrawer(ctx)
+
+  ctx.fillStyle = "#1a1a1a"
+  ctx.fillRect(0, 0, 100, 100)
+
+  const rect: PcbNoteRect = {
+    type: "pcb_note_rect",
+    pcb_note_rect_id: "note_rect3",
+    center: { x: 50, y: 50 },
+    width: 60,
+    height: 40,
+    stroke_width: 2,
+    corner_radius: 8,
+    is_filled: true,
+    has_stroke: false,
+    is_stroke_dashed: false,
+  }
+
+  drawer.drawElements([rect])
+
+  await expect(canvas.toBuffer("image/png")).toMatchPngSnapshot(
+    import.meta.path,
+  )
+})