circuit-to-svg 0.0.165 → 0.0.166

package/README.md

@@ -72,6 +72,11 @@ writeFileSync('board.svg', pcbSvg)
 
 Converts a schematic circuit description to an SVG string.
 
+#### Options
+
+- `includeVersion` – if `true`, add a `data-circuit-to-svg-version` attribute to
+  the root `<svg>`.
+
 ### convertCircuitJsonToPcbSvg
 
 `convertCircuitJsonToPcbSvg(circuitJson: AnyCircuitElement[], options?): string`
@@ -87,6 +92,8 @@ Converts a PCB layout description to an SVG string.
   `"#000"`.
 - `drawPaddingOutsideBoard` – if `false`, omit the board outline and extra
   padding around it. Defaults to `true`.
+- `includeVersion` – if `true`, add a `data-circuit-to-svg-version` attribute to
+  the root `<svg>`.
 
 ### convertCircuitJsonToAssemblySvg
 
@@ -97,6 +104,8 @@ Converts circuit JSON into an assembly view of the board and components.
 #### Options
 
 - `width` and `height` – dimensions of the output SVG. Defaults to `800x600`.
+- `includeVersion` – if `true`, add a `data-circuit-to-svg-version` attribute to
+  the root `<svg>`.
 
 ## Contributing
 

package/dist/index.d.ts

@@ -40,6 +40,7 @@ interface Options$3 {
     matchBoardAspectRatio?: boolean;
     backgroundColor?: string;
     drawPaddingOutsideBoard?: boolean;
+    includeVersion?: boolean;
 }
 interface PcbContext {
     transform: Matrix;
@@ -57,6 +58,7 @@ declare const circuitJsonToPcbSvg: typeof convertCircuitJsonToPcbSvg;
 interface Options$2 {
     width?: number;
     height?: number;
+    includeVersion?: boolean;
 }
 interface AssemblySvgContext {
     transform: Matrix;
@@ -239,6 +241,7 @@ interface Options$1 {
         y: number;
         label: string;
     }>;
+    includeVersion?: boolean;
 }
 declare function convertCircuitJsonToSchematicSvg(circuitJson: AnyCircuitElement[], options?: Options$1): string;
 /**
@@ -250,9 +253,12 @@ interface Options {
     layer: "top" | "bottom";
     width?: number;
     height?: number;
+    includeVersion?: boolean;
 }
 declare function convertCircuitJsonToSolderPasteMask(circuitJson: AnyCircuitElement[], options: Options): string;
 
 declare function getSoftwareUsedString(circuitJson: AnyCircuitElement[]): string | undefined;
 
-export { type AssemblySvgContext, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSolderPasteMask, getSoftwareUsedString };
+declare const CIRCUIT_TO_SVG_VERSION: string;
+
+export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSolderPasteMask, getSoftwareUsedString };

package/dist/index.js

@@ -1442,6 +1442,72 @@ function getSoftwareUsedString(circuitJson) {
   return metadata?.software_used_string;
 }
 
+// package.json
+var package_default = {
+  name: "circuit-to-svg",
+  type: "module",
+  version: "0.0.165",
+  description: "Convert Circuit JSON to SVG",
+  main: "dist/index.js",
+  files: [
+    "dist"
+  ],
+  scripts: {
+    start: "storybook dev -p 6006",
+    prepublish: "npm run build",
+    build: "tsup-node ./lib/index.ts --format esm --dts --sourcemap",
+    format: "biome format . --write",
+    "format:check": "biome format .",
+    storybook: "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  license: "ISC",
+  devDependencies: {
+    "@biomejs/biome": "^1.9.4",
+    "@chromatic-com/storybook": "^1.6.1",
+    "@storybook/addon-essentials": "^8.2.5",
+    "@storybook/addon-interactions": "^8.2.5",
+    "@storybook/addon-links": "^8.2.5",
+    "@storybook/addon-onboarding": "^8.2.5",
+    "@storybook/blocks": "^8.2.5",
+    "@storybook/react": "^8.2.5",
+    "@storybook/react-vite": "^8.2.5",
+    "@storybook/test": "^8.2.5",
+    "@tscircuit/core": "0.0.477",
+    "@tscircuit/plop": "^0.0.10",
+    "@types/bun": "^1.2.8",
+    biome: "^0.3.3",
+    "bun-match-svg": "^0.0.6",
+    "circuit-json": "^0.0.218",
+    esbuild: "^0.20.2",
+    "performance-now": "^2.1.0",
+    react: "^18.3.1",
+    "schematic-symbols": "^0.0.153",
+    storybook: "^8.2.5",
+    tsup: "^8.0.2",
+    typescript: "^5.4.5",
+    "vite-tsconfig-paths": "^5.0.1",
+    "@tscircuit/checks": "^0.0.44",
+    "@tscircuit/circuit-json-util": "^0.0.47",
+    "@tscircuit/footprinter": "^0.0.91"
+  },
+  peerDependencies: {
+    "circuit-json": "*",
+    "@tscircuit/circuit-json-util": "*",
+    "@tscircuit/footprinter": "*",
+    "schematic-symbols": "*"
+  },
+  dependencies: {
+    "@types/node": "^22.5.5",
+    "bun-types": "^1.1.40",
+    svgson: "^5.3.1",
+    "transformation-matrix": "^2.16.1"
+  }
+};
+
+// lib/package-version.ts
+var CIRCUIT_TO_SVG_VERSION = package_default.version;
+
 // lib/pcb/convert-circuit-json-to-pcb-svg.ts
 var OBJECT_ORDER = [
   "pcb_trace_error",
@@ -1641,6 +1707,7 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
   }
   children.push(...svgObjects);
   const softwareUsedString = getSoftwareUsedString(circuitJson);
+  const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {
     name: "svg",
     type: "element",
@@ -1650,6 +1717,9 @@ function convertCircuitJsonToPcbSvg(circuitJson, options) {
       height: svgHeight.toString(),
       ...softwareUsedString && {
         "data-software-used-string": softwareUsedString
+      },
+      ...options?.includeVersion && {
+        "data-circuit-to-svg-version": version
       }
     },
     value: "",
@@ -2470,6 +2540,7 @@ function convertCircuitJsonToAssemblySvg(soup, options) {
     (a, b) => (OBJECT_ORDER2.indexOf(b.type) ?? 9999) - (OBJECT_ORDER2.indexOf(a.type) ?? 9999)
   ).flatMap((item) => createSvgObjects2(item, ctx, soup));
   const softwareUsedString = getSoftwareUsedString(soup);
+  const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {
     name: "svg",
     type: "element",
@@ -2479,6 +2550,9 @@ function convertCircuitJsonToAssemblySvg(soup, options) {
       height: svgHeight.toString(),
       ...softwareUsedString && {
         "data-software-used-string": softwareUsedString
+      },
+      ...options?.includeVersion && {
+        "data-circuit-to-svg-version": version
       }
     },
     value: "",
@@ -5874,6 +5948,7 @@ function convertCircuitJsonToSchematicSvg(circuitJson, options) {
     );
   }
   const softwareUsedString = getSoftwareUsedString(circuitJson);
+  const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {
     name: "svg",
     type: "element",
@@ -5885,6 +5960,9 @@ function convertCircuitJsonToSchematicSvg(circuitJson, options) {
       "data-real-to-screen-transform": toSVG(transform),
       ...softwareUsedString && {
         "data-software-used-string": softwareUsedString
+      },
+      ...options?.includeVersion && {
+        "data-circuit-to-svg-version": version
       }
     },
     children: [
@@ -6072,6 +6150,7 @@ function convertCircuitJsonToSolderPasteMask(circuitJson, options) {
     (a, b) => (OBJECT_ORDER3.indexOf(b.type) ?? 9999) - (OBJECT_ORDER3.indexOf(a.type) ?? 9999)
   ).flatMap((item) => createSvgObjects3({ elm: item, ctx }));
   const softwareUsedString = getSoftwareUsedString(circuitJson);
+  const version = CIRCUIT_TO_SVG_VERSION;
   const svgObject = {
     name: "svg",
     type: "element",
@@ -6081,6 +6160,9 @@ function convertCircuitJsonToSolderPasteMask(circuitJson, options) {
       height: svgHeight.toString(),
       ...softwareUsedString && {
         "data-software-used-string": softwareUsedString
+      },
+      ...options.includeVersion && {
+        "data-circuit-to-svg-version": version
       }
     },
     value: "",
@@ -6170,6 +6252,7 @@ function createSvgObjectFromPcbBoundary2(transform, minX, minY, maxX, maxY) {
   };
 }
 export {
+  CIRCUIT_TO_SVG_VERSION,
   circuitJsonToPcbSvg,
   circuitJsonToSchematicSvg,
   convertCircuitJsonToAssemblySvg,