@tscircuit/3d-viewer 0.0.607 → 0.0.608

package/README.md

@@ -73,6 +73,24 @@ const MyPCBViewer = () => {
 export default MyPCBViewer
 ```
 
+### Navigate to a schematic component
+
+Pass `onViewSchematicComponent` to enable **Show on schematic** when a user
+right-clicks a component model (or long-presses it on touch devices). The callback
+receives `{ source_component_id, pcb_component_id, refdes }`, matching the PCB
+viewer. The host can switch tabs and focus the schematic using the source ID.
+Omit the callback when schematic navigation is unavailable.
+
+```tsx
+<CadViewer
+  circuitJson={circuitJson}
+  onViewSchematicComponent={({ source_component_id }) => {
+    // Find the schematic component with this source ID and focus it.
+    showSchematicComponent(source_component_id)
+  }}
+/>
+```
+
 ### Converting to SVG (Node.js)
 
 When using the SVG converter in Node.js environments, you'll need to provide JSDOM:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as React from 'react';
+import * as React$1 from 'react';
 import { AnyCircuitElement, PcbBoard } from 'circuit-json';
 import * as THREE from 'three';
 import { GLTFExporterOptions } from 'three-stdlib';
@@ -6,7 +6,53 @@ import { ManifoldToplevel } from 'manifold-3d';
 import { JSDOM } from 'jsdom';
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls.js';
 
-declare const CadViewer: (props: any) => React.JSX.Element;
+/** Same component identity contract as the PCB viewer. */
+interface ViewSchematicComponentEvent {
+    source_component_id: string;
+    pcb_component_id: string;
+    refdes: string;
+}
+
+type CameraPreset = "Custom" | "Top Down" | "Top Left Corner" | "Top Right Corner" | "Left Sideview" | "Right Sideview" | "Front" | "Top Center Angled";
+interface CameraAnimationConfig {
+    position: readonly [number, number, number];
+    target?: readonly [number, number, number];
+    up?: readonly [number, number, number];
+    durationMs?: number;
+}
+interface CameraController {
+    animateTo: (config: CameraAnimationConfig) => void;
+    animateToPreset: (preset: CameraPreset) => void;
+}
+declare const CameraAnimatorWithContext: React$1.FC;
+
+type ReferenceObjectType = "banana" | "credit-card" | "14in-macbook";
+
+interface Props {
+    /**
+     * @deprecated Use circuitJson instead.
+     */
+    soup?: AnyCircuitElement[];
+    circuitJson?: AnyCircuitElement[];
+    autoRotateDisabled?: boolean;
+    clickToInteractEnabled?: boolean;
+    cameraType?: "orthographic" | "perspective";
+    onUserInteraction?: () => void;
+    onCameraControllerReady?: (controller: CameraController | null) => void;
+    resolveStaticAsset?: (modelUrl: string) => string;
+    referenceObject?: ReferenceObjectType | null;
+}
+declare const CadViewerJscad: React$1.ForwardRefExoticComponent<Props & {
+    children?: React$1.ReactNode | undefined;
+} & React$1.RefAttributes<THREE.Object3D<THREE.Object3DEventMap>>>;
+
+type CadViewerProps = Omit<React.ComponentProps<typeof CadViewerJscad>, "circuitJson"> & {
+    circuitJson?: any[];
+    foldPcbs?: boolean;
+    /** Enable right-click navigation using the same identity as the PCB viewer. */
+    onViewSchematicComponent?: (event: ViewSchematicComponentEvent) => void;
+};
+declare const CadViewer: (props: CadViewerProps) => React$1.JSX.Element;
 
 interface CircuitToSvgOptions {
     width?: number;
@@ -34,11 +80,11 @@ type Options = Omit<GLTFExporterOptions, "animations" | "includeCustomExtensions
 declare function useSaveGltfAs(options?: Options & {
     filename?: string;
 }): [
-    ref3D: React.ForwardedRef<THREE.Object3D>,
+    ref3D: React$1.ForwardedRef<THREE.Object3D>,
     saveAs: (filename?: string) => Promise<void>
 ];
 declare function useExportGltfUrl(options?: Options): [
-    ref3D: React.ForwardedRef<THREE.Object3D>,
+    ref3D: React$1.ForwardedRef<THREE.Object3D>,
     url: string | undefined,
     error: ErrorEvent | undefined
 ];
@@ -112,24 +158,11 @@ declare const useManifoldBoardBuilder: (manifoldJSModule: ManifoldToplevel | nul
 
 declare function applyJsdomShim(jsdom: JSDOM): void;
 
-type CameraPreset = "Custom" | "Top Down" | "Top Left Corner" | "Top Right Corner" | "Left Sideview" | "Right Sideview" | "Front" | "Top Center Angled";
-interface CameraAnimationConfig {
-    position: readonly [number, number, number];
-    target?: readonly [number, number, number];
-    up?: readonly [number, number, number];
-    durationMs?: number;
-}
-interface CameraController {
-    animateTo: (config: CameraAnimationConfig) => void;
-    animateToPreset: (preset: CameraPreset) => void;
-}
-declare const CameraAnimatorWithContext: React.FC;
-
 declare const saveCameraToSession: (camera: THREE.Camera, controls: any) => void;
 declare const loadCameraFromSession: (camera: THREE.Camera, controls: any) => boolean;
 interface CameraControllerContextValue {
-    controlsRef: React.MutableRefObject<OrbitControls | null>;
-    mainCameraRef: React.MutableRefObject<THREE.Camera | null>;
+    controlsRef: React$1.MutableRefObject<OrbitControls | null>;
+    mainCameraRef: React$1.MutableRefObject<THREE.Camera | null>;
     defaultTarget: THREE.Vector3;
     baseDistance: number;
     controller: CameraController | null;
@@ -146,12 +179,12 @@ interface CameraControllerContextValue {
     loadCameraFromSession: (camera: THREE.Camera, controls: any) => boolean;
 }
 interface CameraControllerProviderProps {
-    children: React.ReactNode;
+    children: React$1.ReactNode;
     defaultTarget: THREE.Vector3;
     initialCameraPosition?: readonly [number, number, number];
     initialCameraType?: "perspective" | "orthographic";
 }
-declare const CameraControllerProvider: React.FC<CameraControllerProviderProps>;
+declare const CameraControllerProvider: React$1.FC<CameraControllerProviderProps>;
 declare const useCameraController: () => CameraControllerContextValue;
 
 declare const useCameraSession: () => {
@@ -159,4 +192,4 @@ declare const useCameraSession: () => {
     handleControlsChange: () => void;
 };
 
-export { CadViewer, CameraAnimatorWithContext, CameraControllerProvider, type ManifoldGeoms, applyJsdomShim, convertCircuitJsonTo3dSvg, loadCameraFromSession, saveCameraToSession, useCameraController, useCameraSession, useExportGltfUrl, useManifoldBoardBuilder, useSaveGltfAs };
+export { CadViewer, type CadViewerProps, CameraAnimatorWithContext, CameraControllerProvider, type ManifoldGeoms, type ViewSchematicComponentEvent, applyJsdomShim, convertCircuitJsonTo3dSvg, loadCameraFromSession, saveCameraToSession, useCameraController, useCameraSession, useExportGltfUrl, useManifoldBoardBuilder, useSaveGltfAs };