circuit-to-svg 0.0.260 → 0.0.261

package/dist/index.d.ts

@@ -46,6 +46,7 @@ interface Options$4 {
     width?: number;
     height?: number;
     shouldDrawErrors?: boolean;
+    showErrorsInTextOverlay?: boolean;
     shouldDrawRatsNest?: boolean;
     showCourtyards?: boolean;
     showPcbGroups?: boolean;
@@ -77,6 +78,7 @@ interface Options$3 {
     width?: number;
     height?: number;
     includeVersion?: boolean;
+    showErrorsInTextOverlay?: boolean;
 }
 interface AssemblySvgContext {
     transform: Matrix;
@@ -101,6 +103,7 @@ interface Options$2 {
     width?: number;
     height?: number;
     includeVersion?: boolean;
+    showErrorsInTextOverlay?: boolean;
 }
 interface PinoutLabel {
     pcb_port: PcbPort;
@@ -301,6 +304,7 @@ interface Options$1 {
         label: string;
     }>;
     includeVersion?: boolean;
+    showErrorsInTextOverlay?: boolean;
 }
 declare function convertCircuitJsonToSchematicSvg(circuitJson: AnyCircuitElement[], options?: Options$1): string;
 /**
@@ -322,14 +326,16 @@ interface ConvertSchematicSimulationParams {
     schematicHeightRatio?: number;
     schematicOptions?: Omit<Parameters<typeof convertCircuitJsonToSchematicSvg>[1], "width" | "height" | "includeVersion">;
     includeVersion?: boolean;
+    showErrorsInTextOverlay?: boolean;
 }
-declare function convertCircuitJsonToSchematicSimulationSvg({ circuitJson, simulation_experiment_id, simulation_transient_voltage_graph_ids, width, height, schematicHeightRatio, schematicOptions, includeVersion, }: ConvertSchematicSimulationParams): string;
+declare function convertCircuitJsonToSchematicSimulationSvg({ circuitJson, simulation_experiment_id, simulation_transient_voltage_graph_ids, width, height, schematicHeightRatio, schematicOptions, includeVersion, showErrorsInTextOverlay, }: ConvertSchematicSimulationParams): string;
 
 interface Options {
     layer: "top" | "bottom";
     width?: number;
     height?: number;
     includeVersion?: boolean;
+    showErrorsInTextOverlay?: boolean;
 }
 declare function convertCircuitJsonToSolderPasteMask(circuitJson: AnyCircuitElement[], options: Options): string;
 
@@ -353,4 +359,6 @@ declare const createSvgObjectsForSchComponentPortHovers: ({ component, transform
     circuitJson: AnyCircuitElement[];
 }) => INode[];
 
-export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type CircuitJsonWithSimulation, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutLabel, type PinoutSvgContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString, isSimulationExperiment, isSimulationTransientVoltageGraph, isSimulationVoltageProbe };
+declare function createErrorTextOverlay(circuitJson: AnyCircuitElement[], dataType?: string): INode | null;
+
+export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type CircuitJsonWithSimulation, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutLabel, type PinoutSvgContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createErrorTextOverlay, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString, isSimulationExperiment, isSimulationTransientVoltageGraph, isSimulationVoltageProbe };

package/dist/index.js

@@ -3502,7 +3502,7 @@ function getSoftwareUsedString(circuitJson) {
 var package_default = {
   name: "circuit-to-svg",
   type: "module",
-  version: "0.0.259",
+  version: "0.0.260",
   description: "Convert Circuit JSON to SVG",
   main: "dist/index.js",
   files: [
@@ -3625,6 +3625,53 @@ function getTypePriority(type) {
   return TYPE_PRIORITY[type] ?? DEFAULT_TYPE_PRIORITY;
 }
 
+// lib/utils/create-error-text-overlay.ts
+function createErrorTextOverlay(circuitJson, dataType = "error_text_overlay") {
+  const errorElms = circuitJson.filter(
+    (elm) => elm.type.endsWith("_error")
+  );
+  if (errorElms.length === 0) {
+    return null;
+  }
+  const errorMessages = errorElms.map((e) => e.message).filter((m) => !!m);
+  if (errorMessages.length === 0) {
+    return null;
+  }
+  const textBlock = {
+    name: "text",
+    type: "element",
+    value: "",
+    attributes: {
+      x: "10",
+      y: "20",
+      fill: "red",
+      "font-family": "monospace",
+      "font-size": "12px",
+      "data-type": dataType,
+      "data-layer": "global"
+    },
+    children: errorMessages.map((msg, i) => ({
+      name: "tspan",
+      type: "element",
+      value: "",
+      attributes: {
+        x: "10",
+        dy: i === 0 ? "0" : "1.2em"
+      },
+      children: [
+        {
+          type: "text",
+          value: msg,
+          name: "",
+          attributes: {},
+          children: []
+        }
+      ]
+    }))
+  };
+  return textBlock;
+}
+
 // lib/pcb/convert-circuit-json-to-pcb-svg.ts
 function convertCircuitJsonToPcbSvg(circuitJson, options) {
   const drawPaddingOutsideBoard = options?.drawPaddingOutsideBoard ?? true;
@@ -3859,6 +3906,15 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
   if (gridObjects.rect) {
     children.push(gridObjects.rect);
   }
+  if (options?.showErrorsInTextOverlay) {
+    const errorOverlay = createErrorTextOverlay(
+      circuitJson,
+      "pcb_error_text_overlay"
+    );
+    if (errorOverlay) {
+      children.push(errorOverlay);
+    }
+  }
   const softwareUsedString = getSoftwareUsedString(circuitJson);
   const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {
@@ -4865,29 +4921,14 @@ function convertCircuitJsonToAssemblySvg(soup, options) {
   ).flatMap((item) => createSvgObjects2(item, ctx, soup));
   const softwareUsedString = getSoftwareUsedString(soup);
   const version = CIRCUIT_TO_SVG_VERSION;
-  const svgObject = {
-    name: "svg",
-    type: "element",
-    attributes: {
-      xmlns: "http://www.w3.org/2000/svg",
-      width: svgWidth.toString(),
-      height: svgHeight.toString(),
-      ...softwareUsedString && {
-        "data-software-used-string": softwareUsedString
-      },
-      ...options?.includeVersion && {
-        "data-circuit-to-svg-version": version
-      }
-    },
-    value: "",
-    children: [
-      {
-        name: "style",
-        type: "element",
-        children: [
-          {
-            type: "text",
-            value: `
+  const children = [
+    {
+      name: "style",
+      type: "element",
+      children: [
+        {
+          type: "text",
+          value: `
               .assembly-component { 
                 fill: none; 
                 stroke: #000; 
@@ -4910,30 +4951,52 @@ function convertCircuitJsonToAssemblySvg(soup, options) {
                 stroke-width: 0.2; 
               }
             `,
-            name: "",
-            attributes: {},
-            children: []
-          }
-        ],
-        value: "",
-        attributes: {}
+          name: "",
+          attributes: {},
+          children: []
+        }
+      ],
+      value: "",
+      attributes: {}
+    },
+    {
+      name: "rect",
+      type: "element",
+      attributes: {
+        fill: "#fff",
+        x: "0",
+        y: "0",
+        width: svgWidth.toString(),
+        height: svgHeight.toString()
       },
-      {
-        name: "rect",
-        type: "element",
-        attributes: {
-          fill: "#fff",
-          x: "0",
-          y: "0",
-          width: svgWidth.toString(),
-          height: svgHeight.toString()
-        },
-        value: "",
-        children: []
+      value: "",
+      children: []
+    },
+    createSvgObjectFromAssemblyBoundary(transform, minX, minY, maxX, maxY),
+    ...svgObjects
+  ].filter((child) => child !== null);
+  if (options?.showErrorsInTextOverlay) {
+    const errorOverlay = createErrorTextOverlay(soup);
+    if (errorOverlay) {
+      children.push(errorOverlay);
+    }
+  }
+  const svgObject = {
+    name: "svg",
+    type: "element",
+    attributes: {
+      xmlns: "http://www.w3.org/2000/svg",
+      width: svgWidth.toString(),
+      height: svgHeight.toString(),
+      ...softwareUsedString && {
+        "data-software-used-string": softwareUsedString
       },
-      createSvgObjectFromAssemblyBoundary(transform, minX, minY, maxX, maxY),
-      ...svgObjects
-    ].filter((child) => child !== null)
+      ...options?.includeVersion && {
+        "data-circuit-to-svg-version": version
+      }
+    },
+    value: "",
+    children
   };
   return stringify2(svgObject);
 }
@@ -6230,6 +6293,28 @@ function convertCircuitJsonToPinoutSvg(soup, options) {
   ).flatMap((item) => createSvgObjects3(item, ctx, soup));
   const softwareUsedString = getSoftwareUsedString(soup);
   const version = CIRCUIT_TO_SVG_VERSION;
+  const children = [
+    {
+      name: "rect",
+      type: "element",
+      attributes: {
+        fill: "rgb(255, 255, 255)",
+        x: "0",
+        y: "0",
+        width: svgWidth.toString(),
+        height: svgHeight.toString()
+      },
+      value: "",
+      children: []
+    },
+    ...svgObjects
+  ].filter((child) => child !== null);
+  if (options?.showErrorsInTextOverlay) {
+    const errorOverlay = createErrorTextOverlay(soup);
+    if (errorOverlay) {
+      children.push(errorOverlay);
+    }
+  }
   const svgObject = {
     name: "svg",
     type: "element",
@@ -6245,22 +6330,7 @@ function convertCircuitJsonToPinoutSvg(soup, options) {
       }
     },
     value: "",
-    children: [
-      {
-        name: "rect",
-        type: "element",
-        attributes: {
-          fill: "rgb(255, 255, 255)",
-          x: "0",
-          y: "0",
-          width: svgWidth.toString(),
-          height: svgHeight.toString()
-        },
-        value: "",
-        children: []
-      },
-      ...svgObjects
-    ].filter((child) => child !== null)
+    children
   };
   return stringify3(svgObject);
 }
@@ -9781,6 +9851,12 @@ function convertCircuitJsonToSchematicSvg(circuitJson, options) {
   }
   const softwareUsedString = getSoftwareUsedString(circuitJson);
   const version = CIRCUIT_TO_SVG_VERSION;
+  if (options?.showErrorsInTextOverlay) {
+    const errorOverlay = createErrorTextOverlay(circuitJson);
+    if (errorOverlay) {
+      svgChildren.push(errorOverlay);
+    }
+  }
   const svgObject = {
     name: "svg",
     type: "element",
@@ -10476,7 +10552,8 @@ function convertCircuitJsonToSchematicSimulationSvg({
   height = DEFAULT_HEIGHT2,
   schematicHeightRatio = DEFAULT_SCHEMATIC_RATIO,
   schematicOptions,
-  includeVersion
+  includeVersion,
+  showErrorsInTextOverlay
 }) {
   const schematicElements = circuitJson.filter(
     (element) => !isSimulationExperiment(element) && !isSimulationTransientVoltageGraph(element)
@@ -10492,7 +10569,8 @@ function convertCircuitJsonToSchematicSimulationSvg({
     ...schematicOptions,
     width,
     height: schematicHeight,
-    includeVersion: false
+    includeVersion: false,
+    showErrorsInTextOverlay
   });
   const simulationSvg = convertCircuitJsonToSimulationGraphSvg({
     circuitJson,
@@ -10733,6 +10811,38 @@ function convertCircuitJsonToSolderPasteMask(circuitJson, options) {
   ).flatMap((item) => createSvgObjects4({ elm: item, ctx }));
   const softwareUsedString = getSoftwareUsedString(circuitJson);
   const version = CIRCUIT_TO_SVG_VERSION;
+  const children = [
+    {
+      name: "style",
+      type: "element",
+      children: [
+        {
+          type: "text",
+          value: ""
+        }
+      ]
+    },
+    {
+      name: "rect",
+      type: "element",
+      attributes: {
+        class: "boundary",
+        x: "0",
+        y: "0",
+        fill: "#000",
+        width: svgWidth.toString(),
+        height: svgHeight.toString()
+      }
+    },
+    createSvgObjectFromPcbBoundary2(transform, minX, minY, maxX, maxY),
+    ...svgObjects
+  ].filter((child) => child !== null);
+  if (options?.showErrorsInTextOverlay) {
+    const errorOverlay = createErrorTextOverlay(circuitJson);
+    if (errorOverlay) {
+      children.push(errorOverlay);
+    }
+  }
   const svgObject = {
     name: "svg",
     type: "element",
@@ -10748,32 +10858,7 @@ function convertCircuitJsonToSolderPasteMask(circuitJson, options) {
       }
     },
     value: "",
-    children: [
-      {
-        name: "style",
-        type: "element",
-        children: [
-          {
-            type: "text",
-            value: ""
-          }
-        ]
-      },
-      {
-        name: "rect",
-        type: "element",
-        attributes: {
-          class: "boundary",
-          x: "0",
-          y: "0",
-          fill: "#000",
-          width: svgWidth.toString(),
-          height: svgHeight.toString()
-        }
-      },
-      createSvgObjectFromPcbBoundary2(transform, minX, minY, maxX, maxY),
-      ...svgObjects
-    ].filter((child) => child !== null)
+    children
   };
   try {
     return stringify7(svgObject);
@@ -10844,6 +10929,7 @@ export {
   convertCircuitJsonToSchematicSvg,
   convertCircuitJsonToSimulationGraphSvg,
   convertCircuitJsonToSolderPasteMask,
+  createErrorTextOverlay,
   createSvgObjectsForSchComponentPortHovers,
   getSoftwareUsedString,
   isSimulationExperiment,