circuit-to-svg 0.0.227 → 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;
@@ -312,9 +320,17 @@ interface SimulationTransientVoltageGraphElement {
     end_time_ms: number;
     name?: string;
 }
-type CircuitJsonWithSimulation = AnyCircuitElement | SimulationExperimentElement | SimulationTransientVoltageGraphElement;
+interface SimulationVoltageProbeElement {
+    type: "simulation_voltage_probe";
+    simulation_voltage_probe_id: string;
+    name: string;
+    source_port_id?: string;
+    source_net_id?: string;
+}
+type CircuitJsonWithSimulation = AnyCircuitElement | SimulationExperimentElement | SimulationTransientVoltageGraphElement | SimulationVoltageProbeElement;
 declare function isSimulationTransientVoltageGraph(value: CircuitJsonWithSimulation): value is SimulationTransientVoltageGraphElement;
 declare function isSimulationExperiment(value: CircuitJsonWithSimulation): value is SimulationExperimentElement;
+declare function isSimulationVoltageProbe(value: CircuitJsonWithSimulation): value is SimulationVoltageProbeElement;
 
 interface ConvertSchematicSimulationParams {
     circuitJson: CircuitJsonWithSimulation[];
@@ -356,4 +372,4 @@ declare const createSvgObjectsForSchComponentPortHovers: ({ component, transform
     circuitJson: AnyCircuitElement[];
 }) => INode[];
 
-export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type CircuitJsonWithSimulation, type ColorMap, type ColorOverrides, type ExperimentType, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutLabel, type PinoutSvgContext, type SimulationExperimentElement, type SimulationTransientVoltageGraphElement, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString, isSimulationExperiment, isSimulationTransientVoltageGraph };
+export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type CircuitJsonWithSimulation, type ColorMap, type ColorOverrides, type ExperimentType, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutLabel, type PinoutSvgContext, type SimulationExperimentElement, type SimulationTransientVoltageGraphElement, type SimulationVoltageProbeElement, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString, isSimulationExperiment, isSimulationTransientVoltageGraph, isSimulationVoltageProbe };

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.226",
+  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 = {
@@ -8336,6 +8484,9 @@ function isSimulationTransientVoltageGraph(value) {
 function isSimulationExperiment(value) {
   return value?.type === "simulation_experiment";
 }
+function isSimulationVoltageProbe(value) {
+  return value?.type === "simulation_voltage_probe";
+}
 
 // lib/sim/convert-circuit-json-to-simulation-graph-svg.ts
 var DEFAULT_WIDTH = 1200;
@@ -8362,7 +8513,7 @@ function convertCircuitJsonToSimulationGraphSvg({
       `No simulation_transient_voltage_graph elements found for simulation_experiment_id "${simulation_experiment_id}"`
     );
   }
-  const preparedGraphs = prepareSimulationGraphs(graphs);
+  const preparedGraphs = prepareSimulationGraphs(graphs, circuitJson);
   const allPoints = preparedGraphs.flatMap((entry) => entry.points);
   if (allPoints.length === 0) {
     throw new Error(
@@ -8438,13 +8589,19 @@ function convertCircuitJsonToSimulationGraphSvg({
   );
   return stringify5(svgObject);
 }
-function prepareSimulationGraphs(graphs) {
+function prepareSimulationGraphs(graphs, circuitJson) {
   const palette = Array.isArray(colorMap.palette) ? colorMap.palette : [];
+  const voltageProbes = circuitJson.filter(isSimulationVoltageProbe);
+  const probeIdToName = /* @__PURE__ */ new Map();
+  for (const probe of voltageProbes) {
+    probeIdToName.set(probe.simulation_voltage_probe_id, probe.name);
+  }
   return graphs.map((graph, index) => {
     const points = createGraphPoints(graph);
     const paletteColor = palette.length > 0 ? palette[index % palette.length] : FALLBACK_LINE_COLOR;
     const color = paletteColor ?? FALLBACK_LINE_COLOR;
-    const label = graph.name || (graph.schematic_voltage_probe_id ? `Probe ${graph.schematic_voltage_probe_id}` : graph.simulation_transient_voltage_graph_id);
+    const probeName = graph.schematic_voltage_probe_id ? probeIdToName.get(graph.schematic_voltage_probe_id) : void 0;
+    const label = graph.name || probeName || (graph.schematic_voltage_probe_id ? `Probe ${graph.schematic_voltage_probe_id}` : graph.simulation_transient_voltage_graph_id);
     return { graph, points, color, label };
   }).filter((entry) => entry.points.length > 0);
 }
@@ -9261,6 +9418,7 @@ export {
   createSvgObjectsForSchComponentPortHovers,
   getSoftwareUsedString,
   isSimulationExperiment,
-  isSimulationTransientVoltageGraph
+  isSimulationTransientVoltageGraph,
+  isSimulationVoltageProbe
 };
 //# sourceMappingURL=index.js.map