@buildcores/render-client 1.6.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.
@@ -383,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.
@@ -549,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.
@@ -756,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
  */
@@ -768,8 +824,16 @@ 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) */

package/package.json

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