@buildcores/render-client 1.5.0 → 1.7.0

package/dist/types.d.ts

@@ -226,6 +226,24 @@ export interface BuildRenderProps {
      * Works for both parts and shareCode rendering.
      */
     showGrid?: boolean;
+    /**
+     * Environment scene preset for rendering.
+     */
+    scene?: RenderScene;
+    /**
+     * Whether to show the environment background.
+     */
+    showBackground?: boolean;
+    /**
+     * Enable winter mode effects.
+     * Mutually exclusive with springMode.
+     */
+    winterMode?: boolean;
+    /**
+     * Enable spring mode effects.
+     * Mutually exclusive with winterMode.
+     */
+    springMode?: boolean;
     /**
      * Camera offset X for composition.
      * Positive values shift the build to the right, leaving room for text overlay on the left.
@@ -312,6 +330,46 @@ export interface BuildRenderProps {
      * @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
@@ -343,6 +401,22 @@ export interface ApiConfig {
      * ```
      */
     authToken?: string;
+    /**
+     * Auth mode for API requests.
+     * - legacy: Sends `authToken` directly as bearer token.
+     * - session: Uses `getRenderSessionToken` to fetch short-lived delegated tokens.
+     *
+     * @default "legacy"
+     */
+    authMode?: 'legacy' | 'session';
+    /**
+     * Session token supplier used when `authMode` is "session".
+     * Should call your backend endpoint that brokers BuildCores session tokens.
+     */
+    getRenderSessionToken?: () => Promise<{
+        token: string;
+        expiresAt: string;
+    }>;
 }
 /**
  * Enum defining all available PC part categories that can be rendered.
@@ -509,6 +583,24 @@ export interface RenderBuildRequest {
      * Defaults to true for cinematic profile, false otherwise.
      */
     showGrid?: boolean;
+    /**
+     * Environment scene preset.
+     */
+    scene?: RenderScene;
+    /**
+     * Whether to show the environment background.
+     */
+    showBackground?: boolean;
+    /**
+     * Enable winter mode effects.
+     * Mutually exclusive with springMode.
+     */
+    winterMode?: boolean;
+    /**
+     * Enable spring mode effects.
+     * Mutually exclusive with winterMode.
+     */
+    springMode?: boolean;
     /**
      * Horizontal offset for the camera view.
      * Positive values shift the build to the right, leaving room for text overlay on the left.
@@ -528,6 +620,15 @@ export interface RenderBuildRequest {
      * @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.
@@ -671,6 +772,11 @@ export 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.
@@ -702,6 +808,10 @@ export interface GridSettings {
     /** Render order for depth sorting (default: 0, use -1 to render before other objects) */
     renderOrder?: number;
 }
+/**
+ * Supported environment scene presets for render API endpoints.
+ */
+export type RenderScene = "sunset" | "dawn" | "night" | "warehouse" | "forest" | "apartment" | "studio" | "studio_v2" | "city" | "park" | "lobby";
 /**
  * Options for rendering a build by share code
  */
@@ -714,14 +824,24 @@ export interface RenderByShareCodeOptions {
     height?: number;
     /** Render quality profile */
     profile?: "cinematic" | "flat" | "fast";
+    /** Environment scene preset */
+    scene?: RenderScene;
+    /** Whether to show the environment background */
+    showBackground?: boolean;
     /** Show grid in render (default: true for cinematic profile) */
     showGrid?: boolean;
+    /** Enable winter mode effects (mutually exclusive with springMode) */
+    winterMode?: boolean;
+    /** Enable spring mode effects (mutually exclusive with winterMode) */
+    springMode?: boolean;
     /** Camera offset X for composition (positive = shift build right to leave room for text overlay) */
     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) */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildcores/render-client",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "type": "module",
   "description": "React component for interactive 360-degree video rendering",
   "repository": {