whio-api-sdk 1.0.187-bet-staging → 1.0.188-bet-staging

package/LOGS_SDK_USAGE.md

@@ -0,0 +1,244 @@
+# Logs SDK Usage Guide
+
+## Overview
+The SDK provides comprehensive logging functionality to query and analyze application logs with user context.
+
+## Installation & Setup
+
+```typescript
+import { ApiSDK, FilterLogsDto, LogsResponse, LogStats } from './sdk';
+
+const sdk = new ApiSDK({
+  baseUrl: 'https://your-api.com/api',
+  storage: localStorage // or your preferred storage
+});
+
+// Authenticate first
+await sdk.login({ email: 'user@example.com', password: 'password' });
+```
+
+## Available Methods
+
+### 1. Get Logs with Advanced Filtering
+
+```typescript
+// Get all logs with flexible filtering
+const filters: FilterLogsDto = {
+  controller: 'SessionsController',
+  userId: 'user-123',
+  level: 'error',
+  startDate: '2024-01-15T00:00:00Z',
+  endDate: '2024-01-16T00:00:00Z',
+  limit: 50,
+  offset: 0
+};
+
+const response: LogsResponse = await sdk.getLogs(filters);
+console.log(`Found ${response.total} logs`);
+response.logs.forEach(log => {
+  console.log(`[${log.level}] ${log.message}`, log.meta);
+});
+```
+
+### 2. Get User Logs
+
+```typescript
+// Get logs for a specific user
+const userLogs = await sdk.getLogsByUser('user-123', 100, 0);
+
+// Get your own logs
+const myLogs = await sdk.getMyLogs(50, 0);
+```
+
+### 3. Get Controller Logs
+
+```typescript
+// Monitor specific controller activity
+const controllerLogs = await sdk.getLogsByController('SessionsController', 100, 0);
+```
+
+### 4. Get Logs by Date Range
+
+```typescript
+// Get logs for last 7 days
+const startDate = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString();
+const endDate = new Date().toISOString();
+
+const recentLogs = await sdk.getLogsByDateRange(startDate, endDate, 100, 0);
+```
+
+### 5. Get Log Statistics
+
+```typescript
+// Get system-wide logging statistics
+const stats: LogStats = await sdk.getLogStats();
+console.log(`Total logs: ${stats.totalLogs}`);
+console.log(`Errors: ${stats.errorLogs}`);
+console.log(`Recent activity: ${stats.recentLogs}`);
+```
+
+## Response Format
+
+All log methods return a `LogsResponse` object:
+
+```typescript
+interface LogsResponse {
+  logs: Log[];
+  total: number;
+  limit: number;
+  offset: number;
+  hasMore: boolean;
+}
+
+interface Log {
+  id: number;
+  level: string;
+  message: string;
+  meta: {
+    userId?: string;
+    userEmail?: string;
+    organizationId?: string;
+    requestId?: string;
+    context?: string;
+    [key: string]: any;
+  };
+  timestamp: string;
+}
+```
+
+## Advanced Usage Examples
+
+### 1. Debug User Issues
+
+```typescript
+// Find all errors for a specific user in the last 24 hours
+const userErrors = await sdk.getLogs({
+  userId: 'user-123',
+  level: 'error',
+  startDate: new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString()
+});
+
+userErrors.logs.forEach(log => {
+  console.error(`User Error: ${log.message}`, {
+    timestamp: log.timestamp,
+    context: log.meta.context,
+    requestId: log.meta.requestId
+  });
+});
+```
+
+### 2. Monitor System Health
+
+```typescript
+// Get error statistics
+const stats = await sdk.getLogStats();
+const errorRate = (stats.errorLogs / stats.totalLogs) * 100;
+
+if (errorRate > 5) {
+  console.warn(`High error rate detected: ${errorRate.toFixed(2)}%`);
+}
+```
+
+### 3. Audit Organization Activity
+
+```typescript
+// Get all activity for an organization
+const orgActivity = await sdk.getLogs({
+  organizationId: 'org-456',
+  startDate: '2024-01-01T00:00:00Z',
+  endDate: '2024-01-31T23:59:59Z'
+});
+
+// Group by user
+const userActivity = orgActivity.logs.reduce((acc, log) => {
+  const userId = log.meta.userId;
+  if (userId) {
+    acc[userId] = (acc[userId] || 0) + 1;
+  }
+  return acc;
+}, {} as Record<string, number>);
+
+console.log('User activity:', userActivity);
+```
+
+### 4. Pagination Example
+
+```typescript
+// Paginate through all logs
+let offset = 0;
+const limit = 100;
+let hasMore = true;
+
+while (hasMore) {
+  const response = await sdk.getLogs({ limit, offset });
+
+  // Process logs
+  response.logs.forEach(log => {
+    console.log(`[${log.level}] ${log.message}`);
+  });
+
+  // Update pagination
+  offset += limit;
+  hasMore = response.hasMore;
+}
+```
+
+### 5. Real-time Log Monitoring
+
+```typescript
+// Poll for new logs every 30 seconds
+setInterval(async () => {
+  const recentLogs = await sdk.getLogs({
+    startDate: new Date(Date.now() - 30 * 1000).toISOString(),
+    level: 'error'
+  });
+
+  if (recentLogs.logs.length > 0) {
+    console.log(`Found ${recentLogs.logs.length} new errors`);
+    recentLogs.logs.forEach(log => {
+      console.error(log.message, log.meta);
+    });
+  }
+}, 30000);
+```
+
+## Error Handling
+
+```typescript
+try {
+  const logs = await sdk.getLogs({ userId: 'invalid-user' });
+} catch (error) {
+  if (error.status === 403) {
+    console.error('Insufficient permissions to view logs');
+  } else if (error.status === 404) {
+    console.error('User not found');
+  } else {
+    console.error('Failed to fetch logs:', error.message);
+  }
+}
+```
+
+## Permissions
+
+- **Users**: Can view their own logs via `getMyLogs()`
+- **Organization Admins**: Can view logs from users in their organization
+- **Superusers**: Can view all logs system-wide
+
+The SDK automatically handles permission restrictions based on your authentication level.
+
+## TypeScript Support
+
+All methods are fully typed for excellent IDE support:
+
+```typescript
+import type { FilterLogsDto, LogsResponse, LogStats } from './sdk/types';
+
+// Type-safe filtering
+const filters: FilterLogsDto = {
+  level: 'error', // TypeScript will suggest valid log levels
+  startDate: '2024-01-01T00:00:00Z' // ISO string expected
+};
+
+const response: LogsResponse = await sdk.getLogs(filters);
+// response.logs is properly typed as Log[]
+```

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 } 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 } from './types';
 export declare class ApiSDK {
     private baseUrl;
     private storage;
@@ -139,4 +139,39 @@ export declare class ApiSDK {
     getWorkflowsByOrganization(organizationId?: string): Promise<Workflow[]>;
     updateWorkflow(id: string, name: string, organizationId?: string): Promise<Workflow>;
     deleteWorkflow(id: string): Promise<void>;
+    /**
+     * Get logs with advanced filtering options
+     */
+    getLogs(filters?: FilterLogsDto): Promise<LogsResponse>;
+    /**
+     * Get logs for a specific user
+     */
+    getLogsByUser(userId: string, limit?: number, offset?: number): Promise<LogsResponse>;
+    /**
+     * Get logs for a specific controller
+     */
+    getLogsByController(controller: string, limit?: number, offset?: number): Promise<LogsResponse>;
+    /**
+     * Get logs for the current authenticated user
+     */
+    getMyLogs(limit?: number, offset?: number): Promise<LogsResponse>;
+    /**
+     * Get logs within a date range
+     */
+    getLogsByDateRange(startDate: string, endDate: string, limit?: number, offset?: number): Promise<LogsResponse>;
+    /**
+     * Get logging statistics
+     */
+    getLogStats(): Promise<LogStats>;
+    /**
+     * Create a manual log entry (app logs)
+     */
+    createLog(logData: CreateLogDto): Promise<Log>;
+    /**
+     * Convenience methods for different log levels
+     */
+    logInfo(message: string, context?: string, action?: string, data?: any): Promise<Log>;
+    logError(message: string, context?: string, action?: string, data?: any): Promise<Log>;
+    logWarn(message: string, context?: string, action?: string, data?: any): Promise<Log>;
+    logDebug(message: string, context?: string, action?: string, data?: any): Promise<Log>;
 }

package/dist/src/sdk/sdk.js

@@ -73,7 +73,6 @@ export class ApiSDK {
                 // If no token is available, try to get it
                 yield this.getToken();
             }
-            console.log(this.accessToken);
             if (this.accessToken) {
                 defaultHeaders['Authorization'] = `Bearer ${this.accessToken}`;
             }
@@ -485,7 +484,6 @@ export class ApiSDK {
     }
     addUserToOrganization(organizationId, userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.log('Adding user to organization:', organizationId, userId);
             yield this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
         });
     }
@@ -966,4 +964,146 @@ export class ApiSDK {
             yield this.request(`${urls.workflows}/${id}`, 'DELETE');
         });
     }
+    // ===== LOGS METHODS =====
+    /**
+     * Get logs with advanced filtering options
+     */
+    getLogs(filters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            if (filters) {
+                Object.entries(filters).forEach(([key, value]) => {
+                    if (value !== undefined && value !== null) {
+                        params.append(key, value.toString());
+                    }
+                });
+            }
+            const queryString = params.toString();
+            const url = queryString ? `${urls.logs}?${queryString}` : urls.logs;
+            return this.request(url, 'GET');
+        });
+    }
+    /**
+     * Get logs for a specific user
+     */
+    getLogsByUser(userId, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            if (limit !== undefined)
+                params.append('limit', limit.toString());
+            if (offset !== undefined)
+                params.append('offset', offset.toString());
+            const queryString = params.toString();
+            const url = queryString ? `${urls.logs}/user/${userId}?${queryString}` : `${urls.logs}/user/${userId}`;
+            return this.request(url, 'GET');
+        });
+    }
+    /**
+     * Get logs for a specific controller
+     */
+    getLogsByController(controller, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            if (limit !== undefined)
+                params.append('limit', limit.toString());
+            if (offset !== undefined)
+                params.append('offset', offset.toString());
+            const queryString = params.toString();
+            const url = queryString ? `${urls.logs}/controller/${controller}?${queryString}` : `${urls.logs}/controller/${controller}`;
+            return this.request(url, 'GET');
+        });
+    }
+    /**
+     * Get logs for the current authenticated user
+     */
+    getMyLogs(limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            if (limit !== undefined)
+                params.append('limit', limit.toString());
+            if (offset !== undefined)
+                params.append('offset', offset.toString());
+            const queryString = params.toString();
+            const url = queryString ? `${urls.logs}/my-logs?${queryString}` : `${urls.logs}/my-logs`;
+            return this.request(url, 'GET');
+        });
+    }
+    /**
+     * Get logs within a date range
+     */
+    getLogsByDateRange(startDate, endDate, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams();
+            params.append('startDate', startDate);
+            params.append('endDate', endDate);
+            if (limit !== undefined)
+                params.append('limit', limit.toString());
+            if (offset !== undefined)
+                params.append('offset', offset.toString());
+            return this.request(`${urls.logs}/date-range?${params.toString()}`, 'GET');
+        });
+    }
+    /**
+     * Get logging statistics
+     */
+    getLogStats() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(`${urls.logs}/stats`, 'GET');
+        });
+    }
+    /**
+     * Create a manual log entry (app logs)
+     */
+    createLog(logData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(urls.logs, 'POST', logData);
+        });
+    }
+    /**
+     * Convenience methods for different log levels
+     */
+    logInfo(message, context, action, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.createLog({
+                level: 'info',
+                message,
+                context,
+                action,
+                data,
+            });
+        });
+    }
+    logError(message, context, action, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.createLog({
+                level: 'error',
+                message,
+                context,
+                action,
+                data,
+            });
+        });
+    }
+    logWarn(message, context, action, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.createLog({
+                level: 'warn',
+                message,
+                context,
+                action,
+                data,
+            });
+        });
+    }
+    logDebug(message, context, action, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.createLog({
+                level: 'debug',
+                message,
+                context,
+                action,
+                data,
+            });
+        });
+    }
 }

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

@@ -451,3 +451,42 @@ export interface UpdateBase64AudioFileDto {
 export interface AddBase64ChunkResponse {
     count: number;
 }
+export interface Log {
+    id: number;
+    level: string;
+    message: string;
+    meta: any;
+    timestamp: string;
+}
+export interface LogsResponse {
+    logs: Log[];
+    total: number;
+    limit: number;
+    offset: number;
+    hasMore: boolean;
+}
+export interface LogStats {
+    totalLogs: number;
+    errorLogs: number;
+    warnLogs: number;
+    infoLogs: number;
+    recentLogs: number;
+}
+export interface FilterLogsDto {
+    controller?: string;
+    userId?: string;
+    organizationId?: string;
+    level?: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+    startDate?: string;
+    endDate?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface CreateLogDto {
+    level: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+    message: string;
+    context?: string;
+    action?: string;
+    data?: any;
+    additionalMeta?: Record<string, any>;
+}

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

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

package/dist/src/sdk/urls.js

@@ -41,5 +41,7 @@ const urls = {
     audioFiles: '/audio-files',
     // Workflows
     workflows: '/workflows',
+    // Logs
+    logs: '/logs',
 };
 export default urls;

package/package.json

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

package/src/sdk/sdk.ts

@@ -55,6 +55,11 @@ import {
   CreateBase64AudioFileDto,
   UpdateBase64AudioFileDto,
   AddBase64ChunkResponse,
+  Log,
+  LogsResponse,
+  LogStats,
+  FilterLogsDto,
+  CreateLogDto,
 } from './types';
 import urls from './urls';
 import { jwtDecode } from 'jwt-decode';
@@ -128,7 +133,6 @@ export class ApiSDK {
       await this.getToken();
     }
 
-    console.log(this.accessToken);
 
     if (this.accessToken) {
       defaultHeaders['Authorization'] = `Bearer ${this.accessToken}`;
@@ -595,7 +599,6 @@ export class ApiSDK {
   }
 
   public async addUserToOrganization(organizationId: string, userId: string): Promise<void> {
-    console.log('Adding user to organization:', organizationId, userId);
     await this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
   }
 
@@ -1026,4 +1029,143 @@ export class ApiSDK {
     await this.request(`${urls.workflows}/${id}`, 'DELETE');
   }
 
+  // ===== LOGS METHODS =====
+
+  /**
+   * Get logs with advanced filtering options
+   */
+  public async getLogs(filters?: FilterLogsDto): Promise<LogsResponse> {
+    const params = new URLSearchParams();
+
+    if (filters) {
+      Object.entries(filters).forEach(([key, value]) => {
+        if (value !== undefined && value !== null) {
+          params.append(key, value.toString());
+        }
+      });
+    }
+
+    const queryString = params.toString();
+    const url = queryString ? `${urls.logs}?${queryString}` : urls.logs;
+
+    return this.request<LogsResponse>(url, 'GET');
+  }
+
+  /**
+   * Get logs for a specific user
+   */
+  public async getLogsByUser(userId: string, limit?: number, offset?: number): Promise<LogsResponse> {
+    const params = new URLSearchParams();
+    if (limit !== undefined) params.append('limit', limit.toString());
+    if (offset !== undefined) params.append('offset', offset.toString());
+
+    const queryString = params.toString();
+    const url = queryString ? `${urls.logs}/user/${userId}?${queryString}` : `${urls.logs}/user/${userId}`;
+
+    return this.request<LogsResponse>(url, 'GET');
+  }
+
+  /**
+   * Get logs for a specific controller
+   */
+  public async getLogsByController(controller: string, limit?: number, offset?: number): Promise<LogsResponse> {
+    const params = new URLSearchParams();
+    if (limit !== undefined) params.append('limit', limit.toString());
+    if (offset !== undefined) params.append('offset', offset.toString());
+
+    const queryString = params.toString();
+    const url = queryString ? `${urls.logs}/controller/${controller}?${queryString}` : `${urls.logs}/controller/${controller}`;
+
+    return this.request<LogsResponse>(url, 'GET');
+  }
+
+  /**
+   * Get logs for the current authenticated user
+   */
+  public async getMyLogs(limit?: number, offset?: number): Promise<LogsResponse> {
+    const params = new URLSearchParams();
+    if (limit !== undefined) params.append('limit', limit.toString());
+    if (offset !== undefined) params.append('offset', offset.toString());
+
+    const queryString = params.toString();
+    const url = queryString ? `${urls.logs}/my-logs?${queryString}` : `${urls.logs}/my-logs`;
+
+    return this.request<LogsResponse>(url, 'GET');
+  }
+
+  /**
+   * Get logs within a date range
+   */
+  public async getLogsByDateRange(
+    startDate: string,
+    endDate: string,
+    limit?: number,
+    offset?: number
+  ): Promise<LogsResponse> {
+    const params = new URLSearchParams();
+    params.append('startDate', startDate);
+    params.append('endDate', endDate);
+    if (limit !== undefined) params.append('limit', limit.toString());
+    if (offset !== undefined) params.append('offset', offset.toString());
+
+    return this.request<LogsResponse>(`${urls.logs}/date-range?${params.toString()}`, 'GET');
+  }
+
+  /**
+   * Get logging statistics
+   */
+  public async getLogStats(): Promise<LogStats> {
+    return this.request<LogStats>(`${urls.logs}/stats`, 'GET');
+  }
+
+  /**
+   * Create a manual log entry (app logs)
+   */
+  public async createLog(logData: CreateLogDto): Promise<Log> {
+    return this.request<Log>(urls.logs, 'POST', logData);
+  }
+
+  /**
+   * Convenience methods for different log levels
+   */
+  public async logInfo(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+    return this.createLog({
+      level: 'info',
+      message,
+      context,
+      action,
+      data,
+    });
+  }
+
+  public async logError(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+    return this.createLog({
+      level: 'error',
+      message,
+      context,
+      action,
+      data,
+    });
+  }
+
+  public async logWarn(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+    return this.createLog({
+      level: 'warn',
+      message,
+      context,
+      action,
+      data,
+    });
+  }
+
+  public async logDebug(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+    return this.createLog({
+      level: 'debug',
+      message,
+      context,
+      action,
+      data,
+    });
+  }
+
 }

package/src/sdk/types.ts

@@ -575,3 +575,48 @@ export interface UpdateBase64AudioFileDto {
 export interface AddBase64ChunkResponse {
   count: number;
 }
+
+// Log types
+export interface Log {
+  id: number;
+  level: string;
+  message: string;
+  meta: any;
+  timestamp: string;
+}
+
+export interface LogsResponse {
+  logs: Log[];
+  total: number;
+  limit: number;
+  offset: number;
+  hasMore: boolean;
+}
+
+export interface LogStats {
+  totalLogs: number;
+  errorLogs: number;
+  warnLogs: number;
+  infoLogs: number;
+  recentLogs: number;
+}
+
+export interface FilterLogsDto {
+  controller?: string;
+  userId?: string;
+  organizationId?: string;
+  level?: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+  startDate?: string;
+  endDate?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface CreateLogDto {
+  level: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+  message: string;
+  context?: string;
+  action?: string;
+  data?: any;
+  additionalMeta?: Record<string, any>;
+}

package/src/sdk/urls.ts

@@ -52,6 +52,9 @@ const urls = {
   
   // Workflows
   workflows: '/workflows',
+
+  // Logs
+  logs: '/logs',
 }
 
 export default urls;