@buildcores/render-client 1.0.7 → 1.0.9

package/dist/api.d.ts

@@ -1,7 +1,8 @@
-import { RenderBuildRequest, AvailablePartsResponse } from "./types";
+import { RenderBuildRequest, AvailablePartsResponse, ApiConfig } from "./types";
 declare const API_BASE_URL = "https://www.renderapi.buildcores.com";
 export declare const API_ENDPOINTS: {
     readonly RENDER_BUILD_EXPERIMENTAL: "/render-build-experimental";
+    readonly RENDER_BUILD: "/render-build";
     readonly AVAILABLE_PARTS: "/available-parts";
 };
 export interface RenderBuildResponse {
@@ -18,6 +19,23 @@ export interface RenderBuildResponse {
         format?: string;
     };
 }
+export interface RenderJobCreateResponse {
+    job_id: string;
+    status: "queued" | "processing" | "completed" | "error";
+}
+export interface RenderJobStatusResponse {
+    job_id: string;
+    status: "queued" | "processing" | "completed" | "error";
+    url?: string | null;
+    video_url?: string | null;
+    sprite_url?: string | null;
+    error?: string | null;
+    end_time?: string | null;
+}
+export interface RenderBuildAsyncResponse {
+    /** Final URL to the rendered MP4 (or sprite) asset */
+    videoUrl: string;
+}
 export interface RenderSpriteResponse {
     /**
      * The rendered sprite sheet as a Blob (when format is "sprite")
@@ -49,13 +67,15 @@ export interface RenderAPIService {
      */
     getAvailableParts(config: ApiConfig): Promise<AvailablePartsResponse>;
 }
-export interface ApiConfig {
-    environment?: "staging" | "prod";
-    authToken?: string;
-}
 export declare const buildApiUrl: (endpoint: string, config: ApiConfig) => string;
 export declare const buildHeaders: (config: ApiConfig) => Record<string, string>;
 export declare const renderBuildExperimental: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderBuildResponse>;
+export declare const createRenderBuildJob: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderJobCreateResponse>;
+export declare const getRenderBuildStatus: (jobId: string, config: ApiConfig) => Promise<RenderJobStatusResponse>;
+export declare const renderBuild: (request: RenderBuildRequest, config: ApiConfig, options?: {
+    pollIntervalMs?: number;
+    timeoutMs?: number;
+}) => Promise<RenderBuildAsyncResponse>;
 export declare const renderSpriteExperimental: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderSpriteResponse>;
 export declare const getAvailableParts: (config: ApiConfig) => Promise<AvailablePartsResponse>;
 export { API_BASE_URL };

package/dist/hooks/useBuildRender.d.ts

@@ -9,4 +9,12 @@ export interface UseBuildRenderReturn {
     isRenderingBuild: boolean;
     renderError: string | null;
 }
-export declare const useBuildRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void) => UseBuildRenderReturn;
+export interface UseBuildRenderOptions {
+    /**
+     * Choose which backend flow to use
+     * - 'async' (default): uses /render-build and polls /render-build/{jobId}
+     * - 'experimental': uses /render-build-experimental and returns Blob
+     */
+    mode?: "async" | "experimental";
+}
+export declare const useBuildRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseBuildRenderOptions) => UseBuildRenderReturn;

package/dist/hooks/useSpriteRender.d.ts

@@ -9,4 +9,12 @@ export interface UseSpriteRenderReturn {
         totalFrames: number;
     } | null;
 }
-export declare const useSpriteRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void) => UseSpriteRenderReturn;
+export interface UseSpriteRenderOptions {
+    /**
+     * Choose which backend flow to use
+     * - 'async' (default): uses /render-build and polls /render-build/{jobId} with format 'sprite'
+     * - 'experimental': uses /render-build-experimental and returns Blob
+     */
+    mode?: "async" | "experimental";
+}
+export declare const useSpriteRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseSpriteRenderOptions) => UseSpriteRenderReturn;

package/dist/index.d.ts

@@ -79,7 +79,7 @@ interface BuildRenderVideoProps {
      * />
      * ```
      */
-    apiConfig: ApiConfig$1;
+    apiConfig: ApiConfig;
     /**
      * Optional mouse sensitivity for dragging (default: 0.005).
      *
@@ -188,7 +188,7 @@ interface BuildRenderProps {
      * />
      * ```
      */
-    apiConfig: ApiConfig$1;
+    apiConfig: ApiConfig;
     /**
      * Optional mouse sensitivity for dragging (default: 0.05).
      *
@@ -211,7 +211,7 @@ interface BuildRenderProps {
 /**
  * API configuration for environment and authentication
  */
-interface ApiConfig$1 {
+interface ApiConfig {
     /**
      * Environment to use for API requests
      * - 'staging': Development/testing environment
@@ -455,7 +455,15 @@ interface UseBuildRenderReturn {
     isRenderingBuild: boolean;
     renderError: string | null;
 }
-declare const useBuildRender: (parts: RenderBuildRequest, apiConfig: ApiConfig$1, onLoadStart?: () => void) => UseBuildRenderReturn;
+interface UseBuildRenderOptions {
+    /**
+     * Choose which backend flow to use
+     * - 'async' (default): uses /render-build and polls /render-build/{jobId}
+     * - 'experimental': uses /render-build-experimental and returns Blob
+     */
+    mode?: "async" | "experimental";
+}
+declare const useBuildRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseBuildRenderOptions) => UseBuildRenderReturn;
 
 interface UseSpriteRenderReturn {
     spriteSrc: string | null;
@@ -467,7 +475,15 @@ interface UseSpriteRenderReturn {
         totalFrames: number;
     } | null;
 }
-declare const useSpriteRender: (parts: RenderBuildRequest, apiConfig: ApiConfig$1, onLoadStart?: () => void) => UseSpriteRenderReturn;
+interface UseSpriteRenderOptions {
+    /**
+     * Choose which backend flow to use
+     * - 'async' (default): uses /render-build and polls /render-build/{jobId} with format 'sprite'
+     * - 'experimental': uses /render-build-experimental and returns Blob
+     */
+    mode?: "async" | "experimental";
+}
+declare const useSpriteRender: (parts: RenderBuildRequest, apiConfig: ApiConfig, onLoadStart?: () => void, options?: UseSpriteRenderOptions) => UseSpriteRenderReturn;
 
 interface DragIconProps {
     width?: number;
@@ -494,6 +510,7 @@ declare const InstructionTooltip: React__default.FC<InstructionTooltipProps>;
 declare const API_BASE_URL = "https://www.renderapi.buildcores.com";
 declare const API_ENDPOINTS: {
     readonly RENDER_BUILD_EXPERIMENTAL: "/render-build-experimental";
+    readonly RENDER_BUILD: "/render-build";
     readonly AVAILABLE_PARTS: "/available-parts";
 };
 interface RenderBuildResponse {
@@ -541,10 +558,6 @@ interface RenderAPIService {
      */
     getAvailableParts(config: ApiConfig): Promise<AvailablePartsResponse>;
 }
-interface ApiConfig {
-    environment?: "staging" | "prod";
-    authToken?: string;
-}
 declare const buildApiUrl: (endpoint: string, config: ApiConfig) => string;
 declare const buildHeaders: (config: ApiConfig) => Record<string, string>;
 declare const renderBuildExperimental: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderBuildResponse>;
@@ -552,4 +565,4 @@ declare const renderSpriteExperimental: (request: RenderBuildRequest, config: Ap
 declare const getAvailableParts: (config: ApiConfig) => Promise<AvailablePartsResponse>;
 
 export { API_BASE_URL, API_ENDPOINTS, BuildRender, BuildRenderVideo, DragIcon, InstructionTooltip, LoadingErrorOverlay, PartCategory, arePartsEqual, buildApiUrl, buildHeaders, calculateCircularFrame, calculateCircularTime, getAvailableParts, renderBuildExperimental, renderSpriteExperimental, useBouncePatternProgress, useBuildRender, useSpriteRender, useSpriteScrubbing, useVideoScrubbing };
-export type { ApiConfig$1 as ApiConfig, AvailablePartsResponse, BuildRenderProps, BuildRenderVideoProps, PartDetails, RenderAPIService, RenderBuildRequest, RenderBuildResponse, RenderSpriteResponse, UseBuildRenderReturn, UseSpriteRenderReturn };
+export type { ApiConfig, AvailablePartsResponse, BuildRenderProps, BuildRenderVideoProps, PartDetails, RenderAPIService, RenderBuildRequest, RenderBuildResponse, RenderSpriteResponse, UseBuildRenderOptions, UseBuildRenderReturn, UseSpriteRenderOptions, UseSpriteRenderReturn };

package/dist/index.esm.js

@@ -324,6 +324,7 @@ const API_BASE_URL = "https://www.renderapi.buildcores.com";
 // API Endpoints
 const API_ENDPOINTS = {
     RENDER_BUILD_EXPERIMENTAL: "/render-build-experimental",
+    RENDER_BUILD: "/render-build",
     AVAILABLE_PARTS: "/available-parts",
 };
 // API URL helpers
@@ -346,6 +347,7 @@ const buildHeaders = (config) => {
     }
     return headers;
 };
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 // API Implementation
 const renderBuildExperimental = async (request, config) => {
     const requestWithFormat = {
@@ -369,6 +371,68 @@ const renderBuildExperimental = async (request, config) => {
         },
     };
 };
+// New async endpoints implementation
+const createRenderBuildJob = async (request, config) => {
+    const body = {
+        parts: request.parts,
+        // If provided, forward format; default handled server-side but we keep explicit default
+        ...(request.format ? { format: request.format } : {}),
+    };
+    const response = await fetch(buildApiUrl(API_ENDPOINTS.RENDER_BUILD, config), {
+        method: "POST",
+        headers: buildHeaders(config),
+        body: JSON.stringify(body),
+    });
+    if (!response.ok) {
+        throw new Error(`Create render job failed: ${response.status} ${response.statusText}`);
+    }
+    const data = (await response.json());
+    if (!data?.job_id) {
+        throw new Error("Create render job failed: missing job_id in response");
+    }
+    return data;
+};
+const getRenderBuildStatus = async (jobId, config) => {
+    const url = buildApiUrl(`${API_ENDPOINTS.RENDER_BUILD}/${encodeURIComponent(jobId)}`, config);
+    const response = await fetch(url, {
+        method: "GET",
+        headers: buildHeaders(config),
+    });
+    if (response.status === 404) {
+        throw new Error("Render job not found");
+    }
+    if (!response.ok) {
+        throw new Error(`Get render job status failed: ${response.status} ${response.statusText}`);
+    }
+    return (await response.json());
+};
+const renderBuild = async (request, config, options) => {
+    const pollIntervalMs = 1500;
+    const timeoutMs = 120000; // 2 minutes default
+    const { job_id } = await createRenderBuildJob(request, config);
+    const start = Date.now();
+    // Poll until completed or error or timeout
+    for (;;) {
+        const status = await getRenderBuildStatus(job_id, config);
+        if (status.status === "completed") {
+            const requestedFormat = request.format ?? "video";
+            const finalUrl = (requestedFormat === "sprite"
+                ? status.sprite_url || status.url || undefined
+                : status.video_url || status.url || undefined);
+            if (!finalUrl) {
+                throw new Error("Render job completed but no URL returned");
+            }
+            return { videoUrl: finalUrl };
+        }
+        if (status.status === "error") {
+            throw new Error(status.error || "Render job failed");
+        }
+        if (Date.now() - start > timeoutMs) {
+            throw new Error("Timed out waiting for render job to complete");
+        }
+        await sleep(pollIntervalMs);
+    }
+};
 const renderSpriteExperimental = async (request, config) => {
     const requestWithFormat = {
         ...request,
@@ -473,7 +537,7 @@ const arePartsEqual = (parts1, parts2) => {
     }
     return true;
 };
-const useBuildRender = (parts, apiConfig, onLoadStart) => {
+const useBuildRender = (parts, apiConfig, onLoadStart, options) => {
     const [videoSrc, setVideoSrc] = useState(null);
     const [isRenderingBuild, setIsRenderingBuild] = useState(false);
     const [renderError, setRenderError] = useState(null);
@@ -483,15 +547,27 @@ const useBuildRender = (parts, apiConfig, onLoadStart) => {
             setIsRenderingBuild(true);
             setRenderError(null);
             onLoadStart?.();
-            const response = await renderBuildExperimental(currentParts, apiConfig);
-            const objectUrl = URL.createObjectURL(response.video);
-            // Clean up previous video URL before setting new one
-            setVideoSrc((prevSrc) => {
-                if (prevSrc) {
-                    URL.revokeObjectURL(prevSrc);
-                }
-                return objectUrl;
-            });
+            const mode = options?.mode ?? "async";
+            if (mode === "experimental") {
+                const response = await renderBuildExperimental(currentParts, apiConfig);
+                const objectUrl = URL.createObjectURL(response.video);
+                setVideoSrc((prevSrc) => {
+                    if (prevSrc && prevSrc.startsWith("blob:")) {
+                        URL.revokeObjectURL(prevSrc);
+                    }
+                    return objectUrl;
+                });
+            }
+            else {
+                const { videoUrl } = await renderBuild(currentParts, apiConfig);
+                // Clean up previous object URL (if any) before setting new one
+                setVideoSrc((prevSrc) => {
+                    if (prevSrc && prevSrc.startsWith("blob:")) {
+                        URL.revokeObjectURL(prevSrc);
+                    }
+                    return videoUrl;
+                });
+            }
         }
         catch (error) {
             setRenderError(error instanceof Error ? error.message : "Failed to render build");
@@ -499,7 +575,7 @@ const useBuildRender = (parts, apiConfig, onLoadStart) => {
         finally {
             setIsRenderingBuild(false);
         }
-    }, [apiConfig, onLoadStart]);
+    }, [apiConfig, onLoadStart, options?.mode]);
     // Effect to call API when parts content changes (using custom equality check)
     useEffect(() => {
         const shouldFetch = previousPartsRef.current === null ||
@@ -512,7 +588,7 @@ const useBuildRender = (parts, apiConfig, onLoadStart) => {
     // Cleanup effect for component unmount
     useEffect(() => {
         return () => {
-            if (videoSrc) {
+            if (videoSrc && videoSrc.startsWith("blob:")) {
                 URL.revokeObjectURL(videoSrc);
             }
         };
@@ -524,7 +600,7 @@ const useBuildRender = (parts, apiConfig, onLoadStart) => {
     };
 };
 
-const useSpriteRender = (parts, apiConfig, onLoadStart) => {
+const useSpriteRender = (parts, apiConfig, onLoadStart, options) => {
     const [spriteSrc, setSpriteSrc] = useState(null);
     const [isRenderingSprite, setIsRenderingSprite] = useState(false);
     const [renderError, setRenderError] = useState(null);
@@ -535,21 +611,36 @@ const useSpriteRender = (parts, apiConfig, onLoadStart) => {
             setIsRenderingSprite(true);
             setRenderError(null);
             onLoadStart?.();
-            const response = await renderSpriteExperimental(currentParts, apiConfig);
-            const objectUrl = URL.createObjectURL(response.sprite);
-            // Clean up previous sprite URL before setting new one
-            setSpriteSrc((prevSrc) => {
-                if (prevSrc) {
-                    URL.revokeObjectURL(prevSrc);
-                }
-                return objectUrl;
-            });
-            // Set sprite metadata
-            setSpriteMetadata({
-                cols: response.metadata?.cols || 12,
-                rows: response.metadata?.rows || 6,
-                totalFrames: response.metadata?.totalFrames || 72,
-            });
+            const mode = options?.mode ?? "async";
+            if (mode === "experimental") {
+                const response = await renderSpriteExperimental(currentParts, apiConfig);
+                const objectUrl = URL.createObjectURL(response.sprite);
+                // Clean up previous sprite URL before setting new one
+                setSpriteSrc((prevSrc) => {
+                    if (prevSrc && prevSrc.startsWith("blob:")) {
+                        URL.revokeObjectURL(prevSrc);
+                    }
+                    return objectUrl;
+                });
+                // Set sprite metadata
+                setSpriteMetadata({
+                    cols: response.metadata?.cols || 12,
+                    rows: response.metadata?.rows || 6,
+                    totalFrames: response.metadata?.totalFrames || 72,
+                });
+            }
+            else {
+                // Async job-based flow: request sprite format and use returned URL
+                const { videoUrl: spriteUrl } = await renderBuild({ ...currentParts, format: "sprite" }, apiConfig);
+                setSpriteSrc((prevSrc) => {
+                    if (prevSrc && prevSrc.startsWith("blob:")) {
+                        URL.revokeObjectURL(prevSrc);
+                    }
+                    return spriteUrl;
+                });
+                // No metadata from async endpoint; keep defaults
+                setSpriteMetadata({ cols: 12, rows: 6, totalFrames: 72 });
+            }
         }
         catch (error) {
             setRenderError(error instanceof Error ? error.message : "Failed to render sprite");
@@ -557,7 +648,7 @@ const useSpriteRender = (parts, apiConfig, onLoadStart) => {
         finally {
             setIsRenderingSprite(false);
         }
-    }, [apiConfig, onLoadStart]);
+    }, [apiConfig, onLoadStart, options?.mode]);
     // Effect to call API when parts content changes (using custom equality check)
     useEffect(() => {
         const shouldFetch = previousPartsRef.current === null ||
@@ -570,7 +661,7 @@ const useSpriteRender = (parts, apiConfig, onLoadStart) => {
     // Cleanup effect for component unmount
     useEffect(() => {
         return () => {
-            if (spriteSrc) {
+            if (spriteSrc && spriteSrc.startsWith("blob:")) {
                 URL.revokeObjectURL(spriteSrc);
             }
         };