whio-api-sdk 1.0.191-bet-staging → 1.0.192-bet-staging

package/DEBUG_FUNCTIONALITY.md

@@ -0,0 +1,155 @@
+# Debug Functionality in Whio SDK
+
+The Whio SDK now includes debug functionality to help with troubleshooting and data extraction for sessions that may have issues with medical transcriptions.
+
+## New Debug Methods
+
+### 1. `getSessionsWithoutMedicalTranscriptions()`
+
+Returns a list of sessions for the user's organization that do not have medical transcriptions AND do not have primary transcription summaries.
+
+**Usage:**
+```typescript
+const problematicSessions = await sdk.getSessionsWithoutMedicalTranscriptions();
+```
+
+**Returns:**
+```typescript
+DebugSessionSummary[] // Array of session summaries
+```
+
+**DebugSessionSummary Type:**
+```typescript
+interface DebugSessionSummary {
+  id: string;
+  sessionName?: string;
+  dateTime: string;
+  createdAt: string;
+  user: {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    organizationId?: string;
+  };
+  template?: {
+    id: string;
+    title: string;
+  };
+  hasMedicalTranscription: boolean;
+  hasPrimaryTranscriptionSummary: boolean;
+}
+```
+
+### 2. `downloadSessionAsZip(sessionId: string)`
+
+Downloads a complete session as a ZIP file containing all related data (fully decrypted).
+
+**Usage:**
+```typescript
+const zipBlob = await sdk.downloadSessionAsZip('session-id-here');
+```
+
+**Returns:**
+```typescript
+Promise<Blob> // ZIP file as a Blob object
+```
+
+**ZIP Contents:**
+- `session.json` - Complete session data with all linked objects (decrypted)
+- `audio/` - Folder containing decrypted audio files with original names
+- `base64_audio/` - Folder containing base64 audio files as JSON
+
+### 3. `downloadSessionAsZipUrl(sessionId: string)`
+
+Downloads a session as a ZIP file and creates a download URL.
+
+**Usage:**
+```typescript
+const downloadUrl = await sdk.downloadSessionAsZipUrl('session-id-here');
+// Use the URL for download links, etc.
+// Remember to clean up: URL.revokeObjectURL(downloadUrl);
+```
+
+**Returns:**
+```typescript
+Promise<string> // URL string for the ZIP file
+```
+
+### 4. `downloadSessionAndTriggerDownload(sessionId: string, filename?: string)`
+
+Downloads a session as a ZIP file and automatically triggers browser download.
+
+**Usage:**
+```typescript
+await sdk.downloadSessionAndTriggerDownload('session-id-here', 'my-session.zip');
+```
+
+**Parameters:**
+- `sessionId: string` - The ID of the session to download
+- `filename?: string` - Optional custom filename (defaults to `session_{id}_{date}.zip`)
+
+## Example Usage
+
+```typescript
+import { ApiSDK } from 'whio-api-sdk';
+
+const sdk = new ApiSDK({
+  baseUrl: 'https://your-api-url.com/api',
+  storage: {
+    getItem: (key) => localStorage.getItem(key),
+    setItem: (key, value) => localStorage.setItem(key, value),
+    removeItem: (key) => localStorage.removeItem(key),
+  }
+});
+
+// Login first
+await sdk.login({ email: 'user@example.com', password: 'password' });
+
+// Get problematic sessions
+const sessions = await sdk.getSessionsWithoutMedicalTranscriptions();
+console.log(`Found ${sessions.length} sessions without medical transcriptions`);
+
+// Download the first session
+if (sessions.length > 0) {
+  const sessionId = sessions[0].id;
+  await sdk.downloadSessionAndTriggerDownload(sessionId);
+}
+```
+
+## Error Handling
+
+All debug methods use standard SDK error handling. Wrap calls in try-catch blocks:
+
+```typescript
+try {
+  const sessions = await sdk.getSessionsWithoutMedicalTranscriptions();
+  // Handle success
+} catch (error) {
+  console.error('Debug operation failed:', error.message);
+  // Handle error
+}
+```
+
+## Security Notes
+
+- All debug endpoints require authentication (Bearer token)
+- Users can only access data from their own organization
+- All data is decrypted before being included in ZIP downloads
+- ZIP files contain complete session data including transcripts, audio files, and summaries
+
+## Use Cases
+
+1. **Troubleshooting**: Identify sessions that may have failed processing
+2. **Data Export**: Export complete session data for analysis or backup
+3. **Quality Assurance**: Review sessions that don't have expected transcriptions
+4. **Migration**: Extract data for migration to other systems
+
+## API Endpoints
+
+The debug functionality calls these API endpoints:
+
+- `GET /debug/sessions/missing-medical-transcriptions` - List problematic sessions
+- `GET /debug/sessions/{id}/download` - Download session as ZIP
+
+These endpoints are automatically handled by the SDK methods.

package/debug-example.ts

@@ -0,0 +1,112 @@
+// debug-example.ts
+// Example usage of the new debug functionality in the Whio SDK
+
+import { ApiSDK, DebugSessionSummary } from './src/sdk';
+
+// Example function to demonstrate debug functionality
+async function demonstrateDebugFeatures() {
+  // Initialize SDK with your config
+  const sdk = new ApiSDK({
+    baseUrl: 'https://your-api-url.com/api', // Replace with your API URL
+    storage: {
+      getItem: (key) => localStorage.getItem(key),
+      setItem: (key, value) => localStorage.setItem(key, value),
+      removeItem: (key) => localStorage.removeItem(key),
+    }
+  });
+
+  try {
+    // First, login to get authentication
+    await sdk.login({
+      email: 'your-email@example.com',
+      password: 'your-password'
+    });
+
+    console.log('Logged in successfully!');
+
+    // === DEBUG FUNCTIONALITY ===
+
+    // 1. Get sessions that don't have medical transcriptions and primary transcription summaries
+    console.log('Fetching sessions without medical transcriptions...');
+    const sessionsWithoutMedicalTranscriptions: DebugSessionSummary[] = 
+      await sdk.getSessionsWithoutMedicalTranscriptions();
+
+    console.log(`Found ${sessionsWithoutMedicalTranscriptions.length} sessions without medical transcriptions:`);
+    
+    sessionsWithoutMedicalTranscriptions.forEach((session, index) => {
+      console.log(`${index + 1}. Session ID: ${session.id}`);
+      console.log(`   Name: ${session.sessionName || 'Unnamed'}`);
+      console.log(`   User: ${session.user.firstName} ${session.user.lastName} (${session.user.email})`);
+      console.log(`   Created: ${new Date(session.createdAt).toLocaleDateString()}`);
+      console.log(`   Template: ${session.template?.title || 'No template'}`);
+      console.log(`   Has Medical Transcription: ${session.hasMedicalTranscription}`);
+      console.log(`   Has Primary Summary: ${session.hasPrimaryTranscriptionSummary}`);
+      console.log('   ---');
+    });
+
+    // 2. Download a specific session as ZIP (if sessions exist)
+    if (sessionsWithoutMedicalTranscriptions.length > 0) {
+      const sessionId = sessionsWithoutMedicalTranscriptions[0].id;
+      console.log(`Downloading session ${sessionId} as ZIP...`);
+
+      // Method 1: Get blob for manual handling
+      const zipBlob = await sdk.downloadSessionAsZip(sessionId);
+      console.log(`Downloaded ZIP blob, size: ${zipBlob.size} bytes`);
+
+      // Method 2: Get URL for download link
+      const downloadUrl = await sdk.downloadSessionAsZipUrl(sessionId);
+      console.log(`Created download URL: ${downloadUrl}`);
+
+      // Method 3: Trigger automatic download in browser
+      // await sdk.downloadSessionAndTriggerDownload(sessionId, 'my-session-data.zip');
+      console.log('ZIP download would trigger automatically in browser');
+
+      // Clean up the URL when done
+      URL.revokeObjectURL(downloadUrl);
+    } else {
+      console.log('No sessions found to download');
+    }
+
+  } catch (error) {
+    console.error('Error during debug operations:', error);
+  }
+}
+
+// Example of how to use in a React component or web application
+export const DebugComponent = {
+  // Function to list sessions without medical transcriptions
+  async listProblematicSessions(sdk: ApiSDK): Promise<DebugSessionSummary[]> {
+    try {
+      return await sdk.getSessionsWithoutMedicalTranscriptions();
+    } catch (error) {
+      console.error('Failed to fetch problematic sessions:', error);
+      throw error;
+    }
+  },
+
+  // Function to download session with user feedback
+  async downloadSessionWithProgress(sdk: ApiSDK, sessionId: string, onProgress?: (message: string) => void): Promise<void> {
+    try {
+      onProgress?.('Starting download...');
+      
+      const blob = await sdk.downloadSessionAsZip(sessionId);
+      
+      onProgress?.('Download complete, preparing file...');
+      
+      // Create filename with timestamp
+      const timestamp = new Date().toISOString().split('T')[0];
+      const filename = `session_${sessionId}_${timestamp}.zip`;
+      
+      // Trigger download
+      await sdk.downloadSessionAndTriggerDownload(sessionId, filename);
+      
+      onProgress?.('Download triggered successfully!');
+    } catch (error) {
+      onProgress?.(`Download failed: ${error.message}`);
+      throw error;
+    }
+  }
+};
+
+// Export for use in other modules
+export { demonstrateDebugFeatures };

package/dist/src/sdk/sdk.d.ts

@@ -1,4 +1,4 @@
-import { LoginResponse, LoginCredentials, SDKConfig, User, UpdateUserDto, Organization, TemplateCategory, Template, Team, UserTemplate, TranscriptionSummary, TranscriptionAudioUploadResponse, PasswordChangeResponse, Session, CreateSessionDto, UpdateSessionDto, Agent, AudioFile, UpdateAudioFileDto, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto, Workflow, Base64AudioFile, CreateBase64AudioFileDto, UpdateBase64AudioFileDto, AddBase64ChunkResponse, Log, LogsResponse, LogStats, FilterLogsDto, CreateLogDto } from './types';
+import { LoginResponse, LoginCredentials, SDKConfig, User, UpdateUserDto, Organization, TemplateCategory, Template, Team, UserTemplate, TranscriptionSummary, TranscriptionAudioUploadResponse, PasswordChangeResponse, Session, CreateSessionDto, UpdateSessionDto, Agent, AudioFile, UpdateAudioFileDto, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto, Workflow, Base64AudioFile, CreateBase64AudioFileDto, UpdateBase64AudioFileDto, AddBase64ChunkResponse, Log, LogsResponse, LogStats, FilterLogsDto, CreateLogDto, DebugSessionSummary } from './types';
 export declare class ApiSDK {
     private baseUrl;
     private storage;
@@ -194,4 +194,24 @@ export declare class ApiSDK {
         organizationRoles: string[];
         teamRoles: string[];
     }>;
+    /**
+     * Get sessions that do not have medical transcriptions and primary transcription summaries
+     * for the current user's organization
+     */
+    getSessionsWithoutMedicalTranscriptions(): Promise<DebugSessionSummary[]>;
+    /**
+     * Download a session as a ZIP file containing all related data (decrypted)
+     * Returns a Blob that can be used to create a download link
+     */
+    downloadSessionAsZip(sessionId: string): Promise<Blob>;
+    /**
+     * Download a session as a ZIP file and create a download URL
+     * Returns a URL that can be used for direct download
+     */
+    downloadSessionAsZipUrl(sessionId: string): Promise<string>;
+    /**
+     * Download a session as a ZIP file and trigger browser download
+     * Optionally provide a custom filename
+     */
+    downloadSessionAndTriggerDownload(sessionId: string, filename?: string): Promise<void>;
 }

package/dist/src/sdk/sdk.js

@@ -1154,4 +1154,69 @@ export class ApiSDK {
             return this.request(`${urls.logs}/available-roles`, 'GET');
         });
     }
+    // ===== DEBUG METHODS =====
+    /**
+     * Get sessions that do not have medical transcriptions and primary transcription summaries
+     * for the current user's organization
+     */
+    getSessionsWithoutMedicalTranscriptions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(`${urls.debug}/sessions/missing-medical-transcriptions`, 'GET');
+        });
+    }
+    /**
+     * Download a session as a ZIP file containing all related data (decrypted)
+     * Returns a Blob that can be used to create a download link
+     */
+    downloadSessionAsZip(sessionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `${this.baseUrl}${urls.debug}/sessions/${sessionId}/download`;
+            // Get token first
+            yield this.getToken();
+            const defaultHeaders = {
+                'ngrok-skip-browser-warning': 'true'
+            };
+            if (this.accessToken) {
+                defaultHeaders['Authorization'] = `Bearer ${this.accessToken}`;
+            }
+            const response = yield fetch(url, {
+                method: 'GET',
+                headers: defaultHeaders,
+            });
+            if (!response.ok) {
+                const errorData = yield response.json().catch(() => ({}));
+                throw new Error(errorData.message || `Download failed with status ${response.status}`);
+            }
+            return response.blob();
+        });
+    }
+    /**
+     * Download a session as a ZIP file and create a download URL
+     * Returns a URL that can be used for direct download
+     */
+    downloadSessionAsZipUrl(sessionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const blob = yield this.downloadSessionAsZip(sessionId);
+            return URL.createObjectURL(blob);
+        });
+    }
+    /**
+     * Download a session as a ZIP file and trigger browser download
+     * Optionally provide a custom filename
+     */
+    downloadSessionAndTriggerDownload(sessionId, filename) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const blob = yield this.downloadSessionAsZip(sessionId);
+            const url = URL.createObjectURL(blob);
+            // Create temporary download link and click it
+            const link = document.createElement('a');
+            link.href = url;
+            link.download = filename || `session_${sessionId}_${new Date().toISOString().split('T')[0]}.zip`;
+            document.body.appendChild(link);
+            link.click();
+            document.body.removeChild(link);
+            // Clean up the URL object
+            URL.revokeObjectURL(url);
+        });
+    }
 }

package/dist/src/sdk/types.d.ts

@@ -496,3 +496,22 @@ export interface CreateLogDto {
     data?: any;
     additionalMeta?: Record<string, any>;
 }
+export interface DebugSessionSummary {
+    id: string;
+    sessionName?: string;
+    dateTime: string;
+    createdAt: string;
+    user: {
+        id: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        organizationId?: string;
+    };
+    template?: {
+        id: string;
+        title: string;
+    };
+    hasMedicalTranscription: boolean;
+    hasPrimaryTranscriptionSummary: boolean;
+}

package/dist/src/sdk/urls.d.ts

@@ -30,5 +30,6 @@ declare const urls: {
     audioFiles: string;
     workflows: string;
     logs: string;
+    debug: string;
 };
 export default urls;

package/dist/src/sdk/urls.js

@@ -43,5 +43,7 @@ const urls = {
     workflows: '/workflows',
     // Logs
     logs: '/logs',
+    // Debug
+    debug: '/debug',
 };
 export default urls;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whio-api-sdk",
-  "version": "1.0.191-bet-staging",
+  "version": "1.0.192-bet-staging",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/src/sdk/sdk.ts

@@ -60,6 +60,7 @@ import {
   LogStats,
   FilterLogsDto,
   CreateLogDto,
+  DebugSessionSummary,
 } from './types';
 import urls from './urls';
 import { jwtDecode } from 'jwt-decode';
@@ -1221,4 +1222,76 @@ export class ApiSDK {
     }>(`${urls.logs}/available-roles`, 'GET');
   }
 
+  // ===== DEBUG METHODS =====
+
+  /**
+   * Get sessions that do not have medical transcriptions and primary transcription summaries
+   * for the current user's organization
+   */
+  public async getSessionsWithoutMedicalTranscriptions(): Promise<DebugSessionSummary[]> {
+    return this.request<DebugSessionSummary[]>(`${urls.debug}/sessions/missing-medical-transcriptions`, 'GET');
+  }
+
+  /**
+   * Download a session as a ZIP file containing all related data (decrypted)
+   * Returns a Blob that can be used to create a download link
+   */
+  public async downloadSessionAsZip(sessionId: string): Promise<Blob> {
+    const url = `${this.baseUrl}${urls.debug}/sessions/${sessionId}/download`;
+    
+    // Get token first
+    await this.getToken();
+    
+    const defaultHeaders: Record<string, string> = {
+      'ngrok-skip-browser-warning': 'true'
+    };
+
+    if (this.accessToken) {
+      defaultHeaders['Authorization'] = `Bearer ${this.accessToken}`;
+    }
+
+    const response = await fetch(url, {
+      method: 'GET',
+      headers: defaultHeaders,
+    });
+
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({}));
+      throw new Error(
+        errorData.message || `Download failed with status ${response.status}`
+      );
+    }
+
+    return response.blob();
+  }
+
+  /**
+   * Download a session as a ZIP file and create a download URL
+   * Returns a URL that can be used for direct download
+   */
+  public async downloadSessionAsZipUrl(sessionId: string): Promise<string> {
+    const blob = await this.downloadSessionAsZip(sessionId);
+    return URL.createObjectURL(blob);
+  }
+
+  /**
+   * Download a session as a ZIP file and trigger browser download
+   * Optionally provide a custom filename
+   */
+  public async downloadSessionAndTriggerDownload(sessionId: string, filename?: string): Promise<void> {
+    const blob = await this.downloadSessionAsZip(sessionId);
+    const url = URL.createObjectURL(blob);
+    
+    // Create temporary download link and click it
+    const link = document.createElement('a');
+    link.href = url;
+    link.download = filename || `session_${sessionId}_${new Date().toISOString().split('T')[0]}.zip`;
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+    
+    // Clean up the URL object
+    URL.revokeObjectURL(url);
+  }
+
 }

package/src/sdk/types.ts

@@ -626,3 +626,24 @@ export interface CreateLogDto {
   data?: any;
   additionalMeta?: Record<string, any>;
 }
+
+// Debug types
+export interface DebugSessionSummary {
+  id: string;
+  sessionName?: string;
+  dateTime: string;
+  createdAt: string;
+  user: {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    organizationId?: string;
+  };
+  template?: {
+    id: string;
+    title: string;
+  };
+  hasMedicalTranscription: boolean;
+  hasPrimaryTranscriptionSummary: boolean;
+}

package/src/sdk/urls.ts

@@ -55,6 +55,9 @@ const urls = {
 
   // Logs
   logs: '/logs',
+
+  // Debug
+  debug: '/debug',
 }
 
 export default urls;