@sampleapp.ai/sdk 1.0.31 → 1.0.33

package/dist/lib/api-client.js

@@ -1,5 +1,21 @@
 /**
  * SDK API Client for interacting with the SampleApp backend API
+ *
+ * Authentication: API keys are sent via Bearer token in the Authorization header.
+ * Set the apiKey in ApiClientConfig when creating the client.
+ *
+ * @example
+ * ```typescript
+ * const client = createApiClient({
+ *   apiKey: "your-api-key-here"
+ * });
+ *
+ * // API key is automatically sent as "Authorization: Bearer your-api-key-here"
+ * const response = await client.sdk.startSandbox({
+ *   env: { KEY: "value" }, // required when published_url is not available
+ *   chatUid: "chat-uid"
+ * });
+ * ```
  */
 /**
  * Extract container ID from a browser URL
@@ -66,31 +82,110 @@ class ApiClient {
         this.sdk = {
             /**
              * Start a sandbox
-             * @param request - The start sandbox request
+             *
+             * Authentication: API key is sent as Bearer token in Authorization header.
+             * The apiKey must be set in ApiClientConfig when creating the client.
+             *
+             * @param request - The start sandbox request (env and chatUid)
              * @returns The sandbox response with container URL
+             * @throws Error if apiKey is not set in client config
+             *
+             * @example
+             * ```typescript
+             * const client = createApiClient({ apiKey: "your-api-key" });
+             * const response = await client.sdk.startSandbox({
+             *   env: { ENV_VAR: "value" }, // required when published_url is not available
+             *   chatUid: "chat-uid-123"
+             * });
+             * ```
              */
             startSandbox: async (request) => {
+                if (!this.apiKey) {
+                    throw new Error("API key is required. Set apiKey in ApiClientConfig when creating the client.");
+                }
                 return this.request(["sdk", "start-sandbox"], {
                     method: "POST",
                     body: JSON.stringify(request),
                 });
             },
             /**
-             * Get the download URL for a container's code
-             * @param containerId - The container ID (extracted from browserUrl)
-             * @returns The full URL to download the code
+             * Download code as zip file from GitHub repository
+             *
+             * Authentication: API key is sent as Bearer token in Authorization header.
+             * The apiKey must be set in ApiClientConfig when creating the client.
+             *
+             * @param sandboxId - The sandbox content UID
+             * @returns Promise that resolves when download is initiated
+             * @throws Error if apiKey is not set in client config
              */
-            getDownloadCodeUrl: (containerId) => {
-                return `${this.baseUrl}/api/v1/sdk/download-code?container_id=${encodeURIComponent(containerId)}`;
+            downloadCode: async (sandboxId) => {
+                if (!this.apiKey) {
+                    throw new Error("API key is required. Set apiKey in ApiClientConfig when creating the client.");
+                }
+                const url = `${this.baseUrl}/api/v1/sdk/download-code?sandbox_id=${encodeURIComponent(sandboxId)}`;
+                // Make authenticated fetch request with Authorization header
+                const response = await fetch(url, {
+                    method: "GET",
+                    headers: {
+                        Authorization: `Bearer ${this.apiKey}`,
+                    },
+                });
+                if (!response.ok) {
+                    const errorText = await response.text();
+                    throw new Error(`Download failed: ${response.status} ${response.statusText}. ${errorText}`);
+                }
+                // Get the blob from the response
+                const blob = await response.blob();
+                // Create a download link and trigger it
+                const downloadUrl = window.URL.createObjectURL(blob);
+                const link = document.createElement("a");
+                link.href = downloadUrl;
+                link.download = `sandbox-${sandboxId}.zip`;
+                document.body.appendChild(link);
+                link.click();
+                document.body.removeChild(link);
+                window.URL.revokeObjectURL(downloadUrl);
             },
             /**
-             * Download code from a container
-             * @param containerId - The container ID (extracted from browserUrl)
-             * @returns Triggers a file download
+             * Start VM endpoint that starts a desktop sandbox, launches Chrome,
+             * navigates to the target URL, and returns a VNC viewer URL
+             *
+             * Authentication: API key is sent as Bearer token in Authorization header.
+             * The apiKey must be set in ApiClientConfig when creating the client.
+             *
+             * @param request - The start VM request with url, optional mode, and optional resolution
+             * @returns The sandbox response with sandboxId and vncUrl (if mode=json)
+             * @throws Error if apiKey is not set in client config
+             *
+             * @example
+             * ```typescript
+             * const client = createApiClient({ apiKey: "your-api-key" });
+             * const response = await client.sdk.startVm({
+             *   url: "https://example.com",
+             *   mode: "json",
+             *   resolution: [1920, 1080]
+             * });
+             * ```
              */
-            downloadCode: (containerId) => {
-                const url = this.sdk.getDownloadCodeUrl(containerId);
-                window.open(url, "_blank");
+            startVm: async (request) => {
+                if (!this.apiKey) {
+                    throw new Error("API key is required. Set apiKey in ApiClientConfig when creating the client.");
+                }
+                const queryParams = {
+                    url: request.url,
+                    mode: request.mode || "json",
+                };
+                // Add resolution if provided
+                if (request.resolution &&
+                    Array.isArray(request.resolution) &&
+                    request.resolution.length >= 2) {
+                    queryParams.width = request.resolution[0];
+                    queryParams.height = request.resolution[1];
+                }
+                return this.request(["sdk", "start-vm"], {
+                    method: "GET",
+                }, false, // API key is sent as Bearer token in Authorization header
+                queryParams);
             },
         };
         const defaultBaseUrl = getBaseUrl();
@@ -99,15 +194,22 @@ class ApiClient {
     }
     /**
      * Makes a request to the API
+     * Automatically includes Authorization: Bearer {apiKey} header if apiKey is set in config
      */
     async request(endpoint, options = {}, useApiKeyHeader = false, queryParams) {
         let url = `${this.baseUrl}/api/v1/${endpoint.join("/")}`;
         if (queryParams) {
             const params = new URLSearchParams();
             Object.entries(queryParams).forEach(([key, value]) => {
-                params.append(key, value.toString());
+                // Skip undefined/null values
+                if (value !== undefined && value !== null) {
+                    params.append(key, value.toString());
+                }
             });
-            url += `?${params.toString()}`;
+            const queryString = params.toString();
+            if (queryString) {
+                url += `?${queryString}`;
+            }
         }
         const headers = Object.assign({ "Content-Type": "application/json" }, options.headers);
         if (this.apiKey) {
@@ -128,8 +230,20 @@ class ApiClient {
 }
 /**
  * Create an API client instance
+ *
  * @param config - Configuration for the API client
+ * @param config.apiKey - API key for authentication (sent as Bearer token in Authorization header)
  * @returns An API client instance
+ *
+ * @example
+ * ```typescript
+ * // Create client with API key
+ * const client = createApiClient({
+ *   apiKey: process.env.NEXT_PUBLIC_SAMPLEAPP_API_KEY
+ * });
+ *
+ * // All requests will automatically include: Authorization: Bearer {apiKey}
+ * ```
  */
 export function createApiClient(config) {
     return new ApiClient(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sampleapp.ai/sdk",
-  "version": "1.0.31",
+  "version": "1.0.33",
   "type": "module",
   "description": "TypeScript SDK for your components",
   "main": "./dist/index.umd.js",