@tscircuit/3d-viewer 0.0.114 → 0.0.115

package/README.md

@@ -70,6 +70,45 @@ const MyPCBViewer = () => {
 export default MyPCBViewer
 ```
 
+### Converting to SVG (Node.js)
+
+When using the SVG converter in Node.js environments, you'll need to provide JSDOM:
+
+```typescript
+import { JSDOM } from 'jsdom'
+import { convert3dCircuitToSvg } from '@tscircuit/3d-viewer/3d'
+import { applyJsdomShim } from '@tscircuit/3d-viewer/utils'
+
+// Setup JSDOM environment
+const dom = new JSDOM()
+applyJsdomShim(dom)
+
+// Convert circuit to SVG
+const options = {
+  width: 800,
+  height: 600,
+  backgroundColor: "#ffffff",
+  padding: 20,
+  zoom: 50,
+  camera: {
+    position: { x: 0, y: 0, z: 100 },
+    lookAt: { x: 0, y: 0, z: 0 }
+  }
+}
+
+const svgString = await convert3dCircuitToSvg(circuitJson, options)
+```
+
+The `convert3dCircuitToSvg` function accepts the following options:
+- `width`: Width of the output SVG (default: 800)
+- `height`: Height of the output SVG (default: 600)
+- `backgroundColor`: Background color in hex format (default: "#ffffff")
+- `padding`: Padding around the board (default: 20)
+- `zoom`: Zoom level (default: 1.5)
+- `camera`: Camera position and lookAt configuration
+  - `position`: {x, y, z} coordinates for camera position
+  - `lookAt`: {x, y, z} coordinates for camera target
+
 ## API Reference
 
 ### `<CadViewer>`

package/dist/{index.d.ts → index.d.mts}

@@ -1,7 +1,38 @@
+import { AnySoupElement } from '@tscircuit/soup';
 import * as React from 'react';
 import * as THREE from 'three';
 import { GLTFExporterOptions } from 'three-stdlib';
-import { AnySoupElement } from '@tscircuit/soup';
+import { JSDOM } from 'jsdom';
+
+interface Props {
+    soup?: AnySoupElement[];
+    autoRotateDisabled?: boolean;
+}
+declare const CadViewer: React.ForwardRefExoticComponent<Props & {
+    children?: React.ReactNode | undefined;
+} & React.RefAttributes<THREE.Object3D<THREE.Object3DEventMap>>>;
+
+interface CircuitToSvgOptions {
+    width?: number;
+    height?: number;
+    viewAngle?: "top" | "isometric" | "front" | "side";
+    backgroundColor?: string;
+    padding?: number;
+    zoom?: number;
+    camera?: {
+        position: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        lookAt?: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+}
+declare function convertCircuitJsonTo3dSvg(circuitJson: AnySoupElement[], options?: CircuitToSvgOptions): Promise<string>;
 
 type Options = Omit<GLTFExporterOptions, "animations" | "includeCustomExtensions">;
 declare function useSaveGltfAs(options?: Options & {
@@ -16,12 +47,6 @@ declare function useExportGltfUrl(options?: Options): [
     error: ErrorEvent | undefined
 ];
 
-interface Props {
-    soup?: AnySoupElement[];
-    autoRotateDisabled?: boolean;
-}
-declare const CadViewer: React.ForwardRefExoticComponent<Props & {
-    children?: React.ReactNode | undefined;
-} & React.RefAttributes<THREE.Object3D<THREE.Object3DEventMap>>>;
+declare function applyJsdomShim(jsdom: JSDOM): void;
 
-export { CadViewer, useExportGltfUrl, useSaveGltfAs };
+export { CadViewer, applyJsdomShim, convertCircuitJsonTo3dSvg, useExportGltfUrl, useSaveGltfAs };