whio-api-sdk 1.0.196-beta-staging → 1.0.198-beta-staging

package/src/sdk/types/common.types.ts

@@ -1,4 +1,5 @@
 // Common types used across the SDK
+import { WebSocketConfig } from './websocket.types';
 
 export interface SDKConfig {
   baseUrl?: string;
@@ -7,6 +8,7 @@ export interface SDKConfig {
     setItem: (key: string, value: string) => void | Promise<void>;
     removeItem: (key: string) => void | Promise<void>;
   };
+  websocket?: WebSocketConfig;
 }
 
 // Role type
@@ -24,3 +26,12 @@ export enum RoleType {
   TRIAL = 'TRIAL',
   PAID = 'PAID',
 }
+
+// Enum for session summary status to match API
+export enum SummaryStatus {
+  NONE = 'NONE',
+  READY = 'READY',
+  GENERATING = 'GENERATING',
+  GENERATED = 'GENERATED',
+  FAILED = 'FAILED',
+}

package/src/sdk/types/index.ts

@@ -11,3 +11,4 @@ export * from './audio.types';
 export * from './workflow.types';
 export * from './log.types';
 export * from './external-integration.types';
+export * from './websocket.types';

package/src/sdk/types/session.types.ts

@@ -1,6 +1,7 @@
 import { User } from './user.types';
 import { Template, TranscriptionSummary } from './template.types';
 import { AudioFile } from './audio.types';
+import { SummaryStatus } from './common.types';
 
 // Session types
 export interface Session {
@@ -14,6 +15,7 @@ export interface Session {
   templateName?: string;
   summary?: string;
   sessionName?: string;
+  summaryStatus: SummaryStatus;
   createdAt: string;
   updatedAt: string;
   templateId: string;
@@ -59,5 +61,6 @@ export interface UpdateSessionDto {
   templateName?: string;
   summary?: string;
   sessionName?: string;
+  summaryStatus?: SummaryStatus;
   primaryTranscriptionSummaryId?: string;
 }

package/src/sdk/types/websocket.types.ts

@@ -0,0 +1,48 @@
+// WebSocket related types
+
+export interface AudioChunkPayload {
+  sessionId: string;
+  audioChunk: number[] | number[][];
+  flag: 'end' | null;
+}
+
+export interface WebSocketConfig {
+  autoConnect?: boolean;
+  reconnectAttempts?: number;
+  reconnectDelay?: number;
+  maxReconnectDelay?: number;
+  namespace?: string;
+}
+
+export interface WebSocketConnectionStats {
+  isConnected: boolean;
+  reconnectAttempts: number;
+  lastConnectedAt?: Date;
+  lastDisconnectedAt?: Date;
+}
+
+export interface AudioStreamingOptions {
+  bufferSize?: number;
+  autoTranscribe?: boolean;
+}
+
+// WebSocket events
+export interface WebSocketEvents {
+  connected: (data: { message: string; userId: string; timestamp: string }) => void;
+  disconnected: (reason: string) => void;
+  'audio-chunk-received': (data: { 
+    sessionId: string; 
+    chunkCount: number; 
+    timestamp: string; 
+  }) => void;
+  'transcription-queued': (data: { 
+    sessionId: string; 
+    message: string; 
+    timestamp: string; 
+  }) => void;
+  'audio-error': (error: { error: string }) => void;
+  'transcription-error': (error: { sessionId: string; error: string }) => void;
+  'connection-error': (error: Error) => void;
+  'reconnecting': (attemptNumber: number) => void;
+  'reconnect-failed': () => void;
+}

package/test-websocket.mjs

@@ -0,0 +1,96 @@
+import { ApiSDK } from './dist/sdk/sdk.js';
+
+// Simple test to verify WebSocket functionality
+async function testWebSocketIntegration() {
+  console.log('Testing WebSocket integration...');
+
+  const sdk = new ApiSDK({
+    baseUrl: 'http://localhost:3000/api',
+    storage: {
+      getItem: (key) => null, // Simple in-memory storage for testing
+      setItem: (key, value) => {},
+      removeItem: (key) => {}
+    },
+    websocket: {
+      autoConnect: false, // Don't auto-connect for this test
+      reconnectAttempts: 3,
+      reconnectDelay: 1000,
+      maxReconnectDelay: 5000
+    }
+  });
+
+  // Test WebSocket module availability
+  console.log('✓ WebSocket module available:', !!sdk.websocket);
+  console.log('✓ WebSocket connection methods available:', {
+    connect: typeof sdk.connectWebSocket === 'function',
+    disconnect: typeof sdk.disconnectWebSocket === 'function',
+    isConnected: typeof sdk.isWebSocketConnected === 'function'
+  });
+
+  // Test audio streaming methods
+  console.log('✓ Audio streaming methods available:', {
+    streamAudioChunk: typeof sdk.streamAudioChunk === 'function',
+    streamAudioChunks: typeof sdk.streamAudioChunks === 'function'
+  });
+
+  // Test event handling
+  console.log('✓ Event handling methods available:', {
+    on: typeof sdk.onWebSocketEvent === 'function',
+    off: typeof sdk.offWebSocketEvent === 'function'
+  });
+
+  // Test connection stats
+  const stats = sdk.getWebSocketStats();
+  console.log('✓ Connection stats:', {
+    isConnected: stats.isConnected,
+    reconnectAttempts: stats.reconnectAttempts
+  });
+
+  // Test event listeners (without actually connecting)
+  let eventFired = false;
+  sdk.onWebSocketEvent('connected', (data) => {
+    eventFired = true;
+    console.log('Connected event fired:', data);
+  });
+
+  console.log('✓ Event listener registered successfully');
+
+  // Test error handling for streaming without connection
+  try {
+    sdk.streamAudioChunk('test-session', [0.1, 0.2, 0.3], false);
+    console.log('✗ Should have thrown error for streaming without connection');
+  } catch (error) {
+    console.log('✓ Correctly throws error when streaming without connection:', error.message);
+  }
+
+  console.log('\n🎉 All WebSocket integration tests passed!');
+  console.log('\nUsage example:');
+  console.log(`
+// Initialize SDK with WebSocket support
+const sdk = new ApiSDK({
+  baseUrl: 'https://your-api.com/api',
+  storage: localStorage, // or your storage implementation
+  websocket: {
+    autoConnect: true,
+    reconnectAttempts: -1 // infinite
+  }
+});
+
+// Listen for events
+sdk.onWebSocketEvent('connected', (data) => {
+  console.log('WebSocket connected:', data);
+});
+
+sdk.onWebSocketEvent('audio-chunk-received', (data) => {
+  console.log('Audio chunk processed:', data);
+});
+
+// Stream audio data
+sdk.streamAudioChunk('session-id', audioFloatArray, false);
+
+// Or stream multiple chunks
+await sdk.streamAudioChunks('session-id', [chunk1, chunk2, chunk3]);
+  `);
+}
+
+testWebSocketIntegration().catch(console.error);