@buildcores/render-client 1.4.1 → 1.6.0

package/dist/hooks/useContinuousSpin.d.ts

@@ -0,0 +1,17 @@
+export interface ContinuousSpinResult {
+    /** Current frame index (integer part) */
+    frame: number;
+    /** Next frame index for interpolation */
+    nextFrame: number;
+    /** Blend factor between frames (0-1), used for cross-fade interpolation */
+    blend: number;
+}
+/**
+ * Hook for continuous 360° spin animation with smooth interpolation support.
+ *
+ * @param enabled - Whether the animation is enabled
+ * @param duration - Duration in ms for one full rotation (default: 10000ms = 10 seconds)
+ * @param totalFrames - Total number of frames in the sprite (default: 72)
+ * @returns Object with current frame, next frame, and blend factor for smooth interpolation
+ */
+export declare function useContinuousSpin(enabled?: boolean, duration?: number, totalFrames?: number): ContinuousSpinResult;

package/dist/hooks/useSpriteRender.d.ts

@@ -35,13 +35,17 @@ export type SpriteRenderInput = {
     parts: RenderBuildRequest;
     showGrid?: boolean;
     cameraOffsetX?: number;
+    cameraZoom?: number;
     gridSettings?: RenderGridSettings;
+    frameQuality?: 'standard' | 'high';
 } | {
     type: 'shareCode';
     shareCode: string;
     profile?: 'cinematic' | 'flat' | 'fast';
     showGrid?: boolean;
     cameraOffsetX?: number;
+    cameraZoom?: number;
     gridSettings?: RenderGridSettings;
+    frameQuality?: 'standard' | 'high';
 };
 export declare const useSpriteRender: (input: RenderBuildRequest | SpriteRenderInput, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseSpriteRenderOptions) => UseSpriteRenderReturn;

package/dist/hooks/useZoomPan.d.ts

@@ -4,6 +4,7 @@ interface UseZoomOptions {
     displayHeight?: number;
     minScale?: number;
     maxScale?: number;
+    initialScale?: number;
 }
 interface UseZoomReturn {
     scale: number;
@@ -12,5 +13,5 @@ interface UseZoomReturn {
     handleTouchStart: (event: ReactTouchEvent<HTMLCanvasElement>) => boolean;
     reset: () => void;
 }
-export declare const useZoomPan: ({ displayWidth, displayHeight, minScale, maxScale, }?: UseZoomOptions) => UseZoomReturn;
+export declare const useZoomPan: ({ displayWidth, displayHeight, minScale, maxScale, initialScale, }?: UseZoomOptions) => UseZoomReturn;
 export {};

package/dist/index.d.ts

@@ -240,6 +240,121 @@ interface BuildRenderProps {
      * Works for both parts and shareCode rendering.
      */
     gridSettings?: GridSettings;
+    /**
+     * Animation mode for the auto-rotation.
+     *
+     * - **bounce**: (default) Quick back-and-forth partial rotation with pauses
+     * - **spin360**: Slow continuous 360° rotation
+     *
+     * @example
+     * ```tsx
+     * // Continuous slow spin (good for showcases)
+     * <BuildRender
+     *   shareCode="abc123"
+     *   animationMode="spin360"
+     *   spinDuration={12000}  // 12 seconds per full rotation
+     * />
+     * ```
+     *
+     * @default "bounce"
+     */
+    animationMode?: 'bounce' | 'spin360';
+    /**
+     * Duration in milliseconds for one full 360° rotation.
+     * Only applies when `animationMode` is "spin360".
+     *
+     * @example
+     * ```tsx
+     * <BuildRender
+     *   shareCode="abc123"
+     *   animationMode="spin360"
+     *   spinDuration={15000}  // 15 seconds per rotation
+     * />
+     * ```
+     *
+     * @default 10000 (10 seconds)
+     */
+    spinDuration?: number;
+    /**
+     * Whether to enable user interaction (drag to rotate, scroll to zoom).
+     *
+     * When set to `false`:
+     * - Drag-to-rotate is disabled
+     * - Scroll-to-zoom is disabled
+     * - Cursor shows as "pointer" instead of "grab"
+     * - Click events pass through (useful for wrapping in a link)
+     *
+     * @example
+     * ```tsx
+     * // Non-interactive showcase with link
+     * <a href="https://buildcores.com/build/abc123">
+     *   <BuildRender
+     *     shareCode="abc123"
+     *     animationMode="spin360"
+     *     interactive={false}
+     *   />
+     * </a>
+     * ```
+     *
+     * @default true
+     */
+    interactive?: boolean;
+    /**
+     * Frame quality for sprite renders.
+     * - **standard**: 72 frames (default) - good balance of quality and file size
+     * - **high**: 144 frames - smoother animation, larger file size (~2x file size)
+     *
+     * @example
+     * ```tsx
+     * <BuildRender
+     *   shareCode="abc123"
+     *   frameQuality="high"  // 144 frames for smoother rotation
+     * />
+     * ```
+     *
+     * @default "standard"
+     */
+    frameQuality?: 'standard' | 'high';
+    /**
+     * Initial zoom level for the build.
+     * Range: 0.5 (50%) to 2.5 (250%). Values less than 1 make the build appear smaller,
+     * values greater than 1 make it appear larger.
+     *
+     * @example
+     * ```tsx
+     * <BuildRender
+     *   shareCode="abc123"
+     *   zoom={0.7}  // 70% size - build appears smaller
+     * />
+     *
+     * <BuildRender
+     *   shareCode="abc123"
+     *   zoom={1.5}  // 150% size - build appears larger
+     * />
+     * ```
+     *
+     * @default 1
+     */
+    zoom?: number;
+    /**
+     * Camera zoom level for server-side rendering.
+     * Values > 1 move the camera further away (build appears smaller in the sprite).
+     * Values < 1 move the camera closer (build appears larger in the sprite).
+     *
+     * Use this for higher quality scaled-down renders vs client-side zoom scaling.
+     * Range: 0.5 to 2.0
+     *
+     * @example
+     * ```tsx
+     * <BuildRender
+     *   shareCode="abc123"
+     *   cameraZoom={1.3}  // Camera 30% further away - smaller build in sprite
+     * />
+     * ```
+     *
+     * @default 1
+     */
+    cameraZoom?: number;
 }
 /**
  * API configuration for environment and authentication
@@ -448,6 +563,23 @@ interface RenderBuildRequest {
      * Only applies when showGrid is true.
      */
     gridSettings?: GridSettings;
+    /**
+     * Frame quality for sprite renders.
+     * - **standard**: 72 frames (default) - good balance of quality and file size
+     * - **high**: 144 frames - smoother animation, larger file size
+     *
+     * @default "standard"
+     */
+    frameQuality?: 'standard' | 'high';
+    /**
+     * Camera zoom level for server-side rendering.
+     * Values > 1 move the camera further away (build appears smaller in the sprite).
+     * Values < 1 move the camera closer (build appears larger in the sprite).
+     * Range: 0.5 to 2.0
+     *
+     * @default 1
+     */
+    cameraZoom?: number;
 }
 /**
  * Response structure containing all available parts for each category.
@@ -591,6 +723,11 @@ interface BuildResponse {
     partDetails: {
         [K in PartCategory]?: PartDetailsWithCategory[];
     };
+    /**
+     * Whether the case in this build has an interactive 3D model available.
+     * If false, the build cannot be rendered in 3D.
+     */
+    hasInteractiveModel: boolean;
 }
 /**
  * Response from the get parts by IDs endpoint.
@@ -640,6 +777,10 @@ interface RenderByShareCodeOptions {
     cameraOffsetX?: number;
     /** Grid appearance settings (for thicker/more visible grid in renders) */
     gridSettings?: GridSettings;
+    /** Frame quality - 'standard' (72 frames) or 'high' (144 frames for smoother animation) */
+    frameQuality?: 'standard' | 'high';
+    /** Camera zoom level for rendering. Values > 1 move camera further (build appears smaller). Range: 0.5 to 2.0 */
+    cameraZoom?: number;
     /** Polling interval in milliseconds (default: 1500) */
     pollIntervalMs?: number;
     /** Timeout in milliseconds (default: 120000 = 2 minutes) */
@@ -708,6 +849,24 @@ declare function useBouncePatternProgress(enabled?: boolean): {
     isBouncing: boolean;
 };
 
+interface ContinuousSpinResult {
+    /** Current frame index (integer part) */
+    frame: number;
+    /** Next frame index for interpolation */
+    nextFrame: number;
+    /** Blend factor between frames (0-1), used for cross-fade interpolation */
+    blend: number;
+}
+/**
+ * Hook for continuous 360° spin animation with smooth interpolation support.
+ *
+ * @param enabled - Whether the animation is enabled
+ * @param duration - Duration in ms for one full rotation (default: 10000ms = 10 seconds)
+ * @param totalFrames - Total number of frames in the sprite (default: 72)
+ * @returns Object with current frame, next frame, and blend factor for smooth interpolation
+ */
+declare function useContinuousSpin(enabled?: boolean, duration?: number, totalFrames?: number): ContinuousSpinResult;
+
 /**
  * Compares two RenderBuildRequest objects for equality by checking if the same IDs
  * are present in each category array, regardless of order.
@@ -764,14 +923,18 @@ type SpriteRenderInput = {
     parts: RenderBuildRequest;
     showGrid?: boolean;
     cameraOffsetX?: number;
+    cameraZoom?: number;
     gridSettings?: RenderGridSettings;
+    frameQuality?: 'standard' | 'high';
 } | {
     type: 'shareCode';
     shareCode: string;
     profile?: 'cinematic' | 'flat' | 'fast';
     showGrid?: boolean;
     cameraOffsetX?: number;
+    cameraZoom?: number;
     gridSettings?: RenderGridSettings;
+    frameQuality?: 'standard' | 'high';
 };
 declare const useSpriteRender: (input: RenderBuildRequest | SpriteRenderInput, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseSpriteRenderOptions) => UseSpriteRenderReturn;
 
@@ -939,5 +1102,5 @@ declare const createRenderByShareCodeJob: (shareCode: string, config: ApiConfig,
  */
 declare const renderByShareCode: (shareCode: string, config: ApiConfig, options?: RenderByShareCodeOptions) => Promise<RenderByShareCodeResponse>;
 
-export { API_BASE_URL, API_ENDPOINTS, BuildRender, BuildRenderVideo, DragIcon, InstructionTooltip, LoadingErrorOverlay, PartCategory, arePartsEqual, buildApiUrl, buildHeaders, calculateCircularFrame, calculateCircularTime, createRenderByShareCodeJob, getAvailableParts, getBuildByShareCode, getPartsByIds, renderBuildExperimental, renderByShareCode, renderSpriteExperimental, useBouncePatternProgress, useBuildRender, useSpriteRender, useSpriteScrubbing, useVideoScrubbing };
+export { API_BASE_URL, API_ENDPOINTS, BuildRender, BuildRenderVideo, DragIcon, InstructionTooltip, LoadingErrorOverlay, PartCategory, arePartsEqual, buildApiUrl, buildHeaders, calculateCircularFrame, calculateCircularTime, createRenderByShareCodeJob, getAvailableParts, getBuildByShareCode, getPartsByIds, renderBuildExperimental, renderByShareCode, renderSpriteExperimental, useBouncePatternProgress, useBuildRender, useContinuousSpin, useSpriteRender, useSpriteScrubbing, useVideoScrubbing };
 export type { ApiConfig, AvailablePartsResponse, BuildRenderProps, BuildRenderVideoProps, BuildResponse, GetAvailablePartsOptions, GridSettings, PartDetails, PartDetailsWithCategory, PartsResponse, RenderAPIService, RenderBuildRequest, RenderBuildResponse, RenderByShareCodeJobResponse, RenderByShareCodeOptions, RenderByShareCodeResponse, RenderSpriteResponse, SpriteRenderInput, UseBuildRenderOptions, UseBuildRenderReturn, UseSpriteRenderOptions, UseSpriteRenderReturn };