Merge pull request #306 from ShiboSoftwareDev/main

feat: Add pinout SVG support

Author: ShiboSoftwareDev

README.md

@@ -16,6 +16,7 @@ This service converts TSCircuit code or pre-generated circuit JSON into various
 - `svg_type` (required): The type of SVG to generate
   - `pcb` - PCB layout view
   - `schematic` - Circuit schematic view
+  - `pinout` - Pinout diagram view
   - `3d` - 3D visualization view
 
 **Input Methods:**
@@ -95,6 +96,11 @@ curl "https://svg.tscircuit.com/?svg_type=pcb&code=YOUR_ENCODED_CODE"
 curl "https://svg.tscircuit.com/?svg_type=schematic&code=YOUR_ENCODED_CODE"
 ```
 
+**Pinout View:**
+```bash
+curl "https://svg.tscircuit.com/?svg_type=pinout&code=YOUR_ENCODED_CODE"
+```
+
 **3D Visualization:**
 ```bash
 curl "https://svg.tscircuit.com/?svg_type=3d&code=YOUR_ENCODED_CODE"

bun.lock

@@ -6,7 +6,7 @@
       "dependencies": {
         "@tscircuit/simple-3d-svg": "^0.0.22",
         "circuit-json-to-simple-3d": "^0.0.9",
-        "circuit-to-svg": "^0.0.158",
+        "circuit-to-svg": "^0.0.199",
         "jscad-fiber": "^0.0.85",
       },
       "devDependencies": {
@@ -292,7 +292,7 @@
 
     "circuit-json-to-simple-3d": ["[email protected]", "", { "peerDependencies": { "typescript": "^5" } }, "sha512-thpCtDb9LpAQfGO+Z0hae19sxVAmJAMYM/It9UTMCtyXC3zoUHwRcp/oqtMO/ZIW+JDBhiR8AHmmtKScL2kW7Q=="],
 
-    "circuit-to-svg": ["[email protected].158", "", { "dependencies": { "@types/node": "^22.5.5", "bun-types": "^1.1.40", "svgson": "^5.3.1", "transformation-matrix": "^2.16.1" }, "peerDependencies": { "@tscircuit/circuit-json-util": "*", "@tscircuit/footprinter": "*", "circuit-json": "*", "schematic-symbols": "*" } }, "sha512-TdKxfJ3x+5/cT8wbyXC++jvsEWacKS0KWRcKNZ8qvz73nPcs8y5+iUUH1c0k6YkkY1aZwrjiTqYNYVtTSuySyg=="],
+    "circuit-to-svg": ["[email protected].199", "", { "dependencies": { "@types/node": "^22.5.5", "bun-types": "^1.1.40", "calculate-elbow": "0.0.12", "svgson": "^5.3.1", "transformation-matrix": "^2.16.1" }, "peerDependencies": { "tscircuit": "*" } }, "sha512-FTYGuM9IXElYTJrZOK99YiKI3kFSaUwgcLfu/X+cGlWge8OyICPt+6J7ikwCFZXw+YgSbXqcaFbfOktrq57tSw=="],
 
     "cli-cursor": ["[email protected]", "", { "dependencies": { "restore-cursor": "^5.0.0" } }, "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw=="],
 

endpoint.ts

@@ -3,6 +3,7 @@ import { CircuitRunner } from "@tscircuit/eval/eval"
 import {
   convertCircuitJsonToPcbSvg,
   convertCircuitJsonToSchematicSvg,
+  convertCircuitJsonToPinoutSvg,
 } from "circuit-to-svg"
 import { convertCircuitJsonToSimple3dSvg } from "circuit-json-to-simple-3d/dist/index.js"
 import { getHtmlForGeneratedUrlPage } from "./get-html-for-generated-url-page"
@@ -126,7 +127,7 @@ export default async (req: Request) => {
   // Check for both svg_type and view parameters, with svg_type taking precedence
   const svgType =
     url.searchParams.get("svg_type") || url.searchParams.get("view")
-  if (!svgType || !["pcb", "schematic", "3d"].includes(svgType)) {
+  if (!svgType || !["pcb", "schematic", "3d", "pinout"].includes(svgType)) {
     return new Response(
       JSON.stringify({
         ok: false,
@@ -142,6 +143,8 @@ export default async (req: Request) => {
       svgContent = convertCircuitJsonToPcbSvg(circuitJson)
     } else if (svgType === "schematic") {
       svgContent = convertCircuitJsonToSchematicSvg(circuitJson)
+    } else if (svgType === "pinout") {
+      svgContent = convertCircuitJsonToPinoutSvg(circuitJson)
     } else {
       // Extract 3D SVG parameters from URL and POST body (URL takes precedence)
       const backgroundColor =

get-html-for-generated-url-page.ts

@@ -12,6 +12,7 @@ export const getHtmlForGeneratedUrlPage = (
 
   const pcbSvgUrl = `${urlPrefix}/?svg_type=pcb&code=${encodeURIComponent(compressedCode)}`
   const schSvgUrl = `${urlPrefix}/?svg_type=schematic&code=${encodeURIComponent(compressedCode)}`
+  const pinoutSvgUrl = `${urlPrefix}/?svg_type=pinout&code=${encodeURIComponent(compressedCode)}`
   const threeDSvgUrl = `${urlPrefix}/?svg_type=3d&code=${encodeURIComponent(compressedCode)}`
 
   return `
@@ -36,6 +37,10 @@ export const getHtmlForGeneratedUrlPage = (
           <td>Schematic SVG URL</td>
           <td><a href="${schSvgUrl}">${schSvgUrl}</a></td>
         </tr>
+        <tr>
+          <td>Pinout SVG URL</td>
+          <td><a href="${pinoutSvgUrl}">${pinoutSvgUrl}</a></td>
+        </tr>
        <tr>
           <td>3D SVG URL</td>
           <td><a href="${threeDSvgUrl}">${threeDSvgUrl}</a></td>

package.json

@@ -30,7 +30,7 @@
   "dependencies": {
     "@tscircuit/simple-3d-svg": "^0.0.22",
     "circuit-json-to-simple-3d": "^0.0.9",
-    "circuit-to-svg": "^0.0.158",
+    "circuit-to-svg": "^0.0.199",
     "jscad-fiber": "^0.0.85"
   }
 }