circuit-to-svg 0.0.228 → 0.0.229

package/dist/index.d.ts

@@ -2,6 +2,13 @@ import { AnyCircuitElement, PcbPort, SchematicComponent } from 'circuit-json';
 import { Matrix } from 'transformation-matrix';
 import { INode } from 'svgson';
 
+interface PcbGridOptions {
+    cellSize: number;
+    lineColor?: string;
+    majorCellSize?: number;
+    majorLineColor?: string;
+}
+
 type CopperLayerName = "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
 type CopperColorMap = Record<CopperLayerName, string> & {
     [layer: string]: string;
@@ -44,6 +51,7 @@ interface Options$4 {
     drawPaddingOutsideBoard?: boolean;
     includeVersion?: boolean;
     renderSolderMask?: boolean;
+    grid?: PcbGridOptions;
 }
 interface PcbContext {
     transform: Matrix;

package/dist/index.js

@@ -1842,6 +1842,143 @@ function createSvgObjectsFromPcbCopperPour(pour, ctx) {
   return [];
 }
 
+// lib/pcb/svg-object-fns/create-svg-objects-for-pcb-grid.ts
+import "svgson";
+var DEFAULT_GRID_LINE_COLOR = "rgba(255, 255, 255, 0.5)";
+var GRID_PATTERN_ID = "pcb-grid-pattern";
+function createSvgObjectsForPcbGrid({
+  grid,
+  svgWidth,
+  svgHeight
+}) {
+  if (!grid) {
+    return {};
+  }
+  const gridLineColor = grid.lineColor ?? DEFAULT_GRID_LINE_COLOR;
+  const gridCellSize = grid.cellSize;
+  const majorCellSize = grid.majorCellSize;
+  const majorLineColor = grid.majorLineColor ?? gridLineColor;
+  if (majorCellSize !== void 0) {
+    if (!gridCellSize || gridCellSize <= 0) {
+      throw new Error("grid.majorCellSize requires a positive grid.cellSize");
+    }
+    if (majorCellSize <= 0) {
+      throw new Error(
+        "grid.majorCellSize must be a positive multiple of grid.cellSize"
+      );
+    }
+    const ratio = majorCellSize / gridCellSize;
+    const nearestInteger = Math.round(ratio);
+    if (!Number.isFinite(ratio) || Math.abs(ratio - nearestInteger) > 1e-6) {
+      throw new Error(
+        "grid.majorCellSize must be a positive multiple of grid.cellSize"
+      );
+    }
+  }
+  if (!gridCellSize || gridCellSize <= 0) {
+    return {};
+  }
+  const hasMajorGrid = majorCellSize !== void 0;
+  const patternChildren = hasMajorGrid ? createMajorGridPatternChildren(
+    gridCellSize,
+    majorCellSize,
+    gridLineColor,
+    majorLineColor
+  ) : [
+    {
+      name: "path",
+      type: "element",
+      value: "",
+      attributes: {
+        d: `M ${gridCellSize} 0 L 0 0 0 ${gridCellSize}`,
+        fill: "none",
+        stroke: gridLineColor,
+        "stroke-width": "1",
+        "shape-rendering": "crispEdges"
+      },
+      children: []
+    }
+  ];
+  const defs = {
+    name: "defs",
+    type: "element",
+    value: "",
+    attributes: {},
+    children: [
+      {
+        name: "pattern",
+        type: "element",
+        value: "",
+        attributes: {
+          id: GRID_PATTERN_ID,
+          width: hasMajorGrid ? majorCellSize.toString() : gridCellSize.toString(),
+          height: hasMajorGrid ? majorCellSize.toString() : gridCellSize.toString(),
+          patternUnits: "userSpaceOnUse"
+        },
+        children: patternChildren
+      }
+    ]
+  };
+  const rect = {
+    name: "rect",
+    type: "element",
+    value: "",
+    attributes: {
+      x: "0",
+      y: "0",
+      width: svgWidth.toString(),
+      height: svgHeight.toString(),
+      fill: `url(#${GRID_PATTERN_ID})`,
+      "pointer-events": "none",
+      "data-type": "pcb_grid",
+      "data-pcb-layer": "global"
+    },
+    children: []
+  };
+  return { defs, rect };
+}
+function createMajorGridPatternChildren(cellSize, majorCellSize, lineColor, majorLineColor) {
+  const children = [];
+  const steps = Math.round(majorCellSize / cellSize);
+  for (let step = 0; step < steps; step += 1) {
+    const offset = Number((step * cellSize).toFixed(6));
+    const offsetString = offset.toString();
+    const color = step === 0 ? majorLineColor : lineColor;
+    const majorSizeString = majorCellSize.toString();
+    children.push({
+      name: "line",
+      type: "element",
+      value: "",
+      attributes: {
+        x1: offsetString,
+        y1: "0",
+        x2: offsetString,
+        y2: majorSizeString,
+        stroke: color,
+        "stroke-width": "1",
+        "shape-rendering": "crispEdges"
+      },
+      children: []
+    });
+    children.push({
+      name: "line",
+      type: "element",
+      value: "",
+      attributes: {
+        x1: "0",
+        y1: offsetString,
+        x2: majorSizeString,
+        y2: offsetString,
+        stroke: color,
+        "stroke-width": "1",
+        "shape-rendering": "crispEdges"
+      },
+      children: []
+    });
+  }
+  return children;
+}
+
 // lib/pcb/svg-object-fns/create-svg-objects-from-pcb-component.ts
 import { applyToPoint as applyToPoint19 } from "transformation-matrix";
 function createSvgObjectsFromPcbComponent(component, ctx) {
@@ -1897,7 +2034,7 @@ function getSoftwareUsedString(circuitJson) {
 var package_default = {
   name: "circuit-to-svg",
   type: "module",
-  version: "0.0.227",
+  version: "0.0.228",
   description: "Convert Circuit JSON to SVG",
   main: "dist/index.js",
   files: [
@@ -2176,30 +2313,41 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
           children: []
         }
       ]
-    },
-    {
-      name: "rect",
-      type: "element",
-      value: "",
-      attributes: {
-        class: "boundary",
-        x: "0",
-        y: "0",
-        fill: options?.backgroundColor ?? "#000",
-        width: svgWidth.toString(),
-        height: svgHeight.toString(),
-        "data-type": "pcb_background",
-        "data-pcb-layer": "global"
-      },
-      children: []
     }
   ];
+  const gridObjects = createSvgObjectsForPcbGrid({
+    grid: options?.grid,
+    svgWidth,
+    svgHeight
+  });
+  if (gridObjects.defs) {
+    children.push(gridObjects.defs);
+  }
+  children.push({
+    name: "rect",
+    type: "element",
+    value: "",
+    attributes: {
+      class: "boundary",
+      x: "0",
+      y: "0",
+      fill: options?.backgroundColor ?? "#000",
+      width: svgWidth.toString(),
+      height: svgHeight.toString(),
+      "data-type": "pcb_background",
+      "data-pcb-layer": "global"
+    },
+    children: []
+  });
   if (drawPaddingOutsideBoard) {
     children.push(
       createSvgObjectFromPcbBoundary(transform, minX, minY, maxX, maxY)
     );
   }
   children.push(...svgObjects);
+  if (gridObjects.rect) {
+    children.push(gridObjects.rect);
+  }
   const softwareUsedString = getSoftwareUsedString(circuitJson);
   const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {