@buildcores/render-client 1.0.11 → 1.1.0

package/dist/api.d.ts

@@ -1,4 +1,4 @@
-import { RenderBuildRequest, AvailablePartsResponse, ApiConfig } from "./types";
+import { RenderBuildRequest, AvailablePartsResponse, ApiConfig, PartCategory, GetAvailablePartsOptions } from "./types";
 declare const API_BASE_URL = "https://www.renderapi.buildcores.com";
 export declare const API_ENDPOINTS: {
     readonly RENDER_BUILD_EXPERIMENTAL: "/render-build-experimental";
@@ -65,7 +65,7 @@ export interface RenderAPIService {
      * @param config - API configuration (environment, auth token) - required
      * @returns Promise with available parts by category
      */
-    getAvailableParts(config: ApiConfig): Promise<AvailablePartsResponse>;
+    getAvailableParts(category: PartCategory, config: ApiConfig, options?: GetAvailablePartsOptions): Promise<AvailablePartsResponse>;
 }
 export declare const buildApiUrl: (endpoint: string, config: ApiConfig) => string;
 export declare const buildHeaders: (config: ApiConfig) => Record<string, string>;
@@ -77,5 +77,5 @@ export declare const renderBuild: (request: RenderBuildRequest, config: ApiConfi
     timeoutMs?: number;
 }) => Promise<RenderBuildAsyncResponse>;
 export declare const renderSpriteExperimental: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderSpriteResponse>;
-export declare const getAvailableParts: (config: ApiConfig) => Promise<AvailablePartsResponse>;
+export declare const getAvailableParts: (category: PartCategory, config: ApiConfig, options?: GetAvailablePartsOptions) => Promise<AvailablePartsResponse>;
 export { API_BASE_URL };

package/dist/index.d.ts

@@ -177,6 +177,13 @@ interface BuildRenderProps {
      * ```
      */
     apiConfig: ApiConfig;
+    /**
+     * Options to configure the internal useSpriteRender hook
+     * (e.g., choose async vs experimental rendering flow)
+     */
+    useSpriteRenderOptions?: {
+        mode?: "async" | "experimental";
+    };
     /**
      * Optional mouse sensitivity for dragging (default: 0.05).
      *
@@ -391,9 +398,45 @@ interface PartDetails {
     /** URL to part image */
     image: string;
 }
-type AvailablePartsResponse = {
-    [K in PartCategory]: PartDetails[];
-};
+/**
+ * Pagination metadata for available parts responses
+ */
+interface AvailablePartsPagination {
+    /** Total number of parts available for this category */
+    total: number;
+    /** Number of parts returned in this response */
+    limit: number;
+    /** Number of parts skipped */
+    skip: number;
+    /** Whether there are more parts available */
+    hasNext: boolean;
+    /** Whether there are previous parts available */
+    hasPrev: boolean;
+}
+/**
+ * Response envelope for the available parts endpoint.
+ * Returns parts for the requested category under `data` keyed by category name.
+ */
+interface AvailablePartsResponse {
+    /**
+     * Parts grouped by category. Only the requested category key is expected
+     * to be present in the response.
+     */
+    data: Partial<Record<PartCategory, PartDetails[]>>;
+    /** The requested category */
+    category: PartCategory;
+    /** Optional pagination information */
+    pagination?: AvailablePartsPagination;
+}
+/**
+ * Query options for fetching available parts
+ */
+interface GetAvailablePartsOptions {
+    /** Number of parts to return (default 20, min 1, max 100) */
+    limit?: number;
+    /** Number of parts to skip for pagination (default 0) */
+    skip?: number;
+}
 
 declare const BuildRender: React.FC<BuildRenderProps>;
 
@@ -544,13 +587,13 @@ interface RenderAPIService {
      * @param config - API configuration (environment, auth token) - required
      * @returns Promise with available parts by category
      */
-    getAvailableParts(config: ApiConfig): Promise<AvailablePartsResponse>;
+    getAvailableParts(category: PartCategory, config: ApiConfig, options?: GetAvailablePartsOptions): Promise<AvailablePartsResponse>;
 }
 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>;
 declare const renderSpriteExperimental: (request: RenderBuildRequest, config: ApiConfig) => Promise<RenderSpriteResponse>;
-declare const getAvailableParts: (config: ApiConfig) => Promise<AvailablePartsResponse>;
+declare const getAvailableParts: (category: PartCategory, config: ApiConfig, options?: GetAvailablePartsOptions) => 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, AvailablePartsResponse, BuildRenderProps, BuildRenderVideoProps, PartDetails, RenderAPIService, RenderBuildRequest, RenderBuildResponse, RenderSpriteResponse, UseBuildRenderOptions, UseBuildRenderReturn, UseSpriteRenderOptions, UseSpriteRenderReturn };
+export type { ApiConfig, AvailablePartsResponse, BuildRenderProps, BuildRenderVideoProps, GetAvailablePartsOptions, PartDetails, RenderAPIService, RenderBuildRequest, RenderBuildResponse, RenderSpriteResponse, UseBuildRenderOptions, UseBuildRenderReturn, UseSpriteRenderOptions, UseSpriteRenderReturn };

package/dist/index.esm.js

@@ -458,15 +458,24 @@ const renderSpriteExperimental = async (request, config) => {
         },
     };
 };
-const getAvailableParts = async (config) => {
-    const response = await fetch(buildApiUrl(API_ENDPOINTS.AVAILABLE_PARTS, config), {
+const getAvailableParts = async (category, config, options) => {
+    const base = buildApiUrl(API_ENDPOINTS.AVAILABLE_PARTS, config);
+    const params = new URLSearchParams();
+    params.set("category", category);
+    if (typeof options?.limit === "number")
+        params.set("limit", String(options.limit));
+    if (typeof options?.skip === "number")
+        params.set("skip", String(options.skip));
+    const separator = base.includes("?") ? "&" : "?";
+    const url = `${base}${separator}${params.toString()}`;
+    const response = await fetch(url, {
         method: "GET",
         headers: buildHeaders(config),
     });
     if (!response.ok) {
         throw new Error(`Get available parts failed: ${response.status} ${response.statusText}`);
     }
-    return response.json();
+    return (await response.json());
 };
 
 /**
@@ -729,7 +738,7 @@ const InstructionTooltip = ({ isVisible, progressValue, instructionIcon, }) => {
             } })) }));
 };
 
-const BuildRender = ({ parts, width, height, size, apiConfig, mouseSensitivity = 0.2, touchSensitivity = 0.2, }) => {
+const BuildRender = ({ parts, width, height, size, apiConfig, useSpriteRenderOptions, mouseSensitivity = 0.2, touchSensitivity = 0.2, }) => {
     const canvasRef = useRef(null);
     const [img, setImg] = useState(null);
     const [isLoading, setIsLoading] = useState(true);
@@ -737,7 +746,7 @@ const BuildRender = ({ parts, width, height, size, apiConfig, mouseSensitivity =
     const displayW = width ?? size ?? 300;
     const displayH = height ?? size ?? 300;
     // Use custom hook for sprite rendering
-    const { spriteSrc, isRenderingSprite, renderError, spriteMetadata } = useSpriteRender(parts, apiConfig);
+    const { spriteSrc, isRenderingSprite, renderError, spriteMetadata } = useSpriteRender(parts, apiConfig, undefined, useSpriteRenderOptions);
     const { value: progressValue, isBouncing } = useBouncePatternProgress(bouncingAllowed);
     const total = spriteMetadata ? spriteMetadata.totalFrames : 72;
     const cols = spriteMetadata ? spriteMetadata.cols : 12;