@ctchealth/plato-sdk 0.0.17 → 0.0.18

package/src/lib/plato-sdk.d.ts

@@ -0,0 +1,193 @@
+import { CallDTO, CreateSimulationDto, CreationPhase, SimulationRecordingsDto, SimulationRecordingsQueryDto, SimulationDetailsDto, RecommendationsResponseDto, PdfSlidesDto, PdfSlideDto, PdfSlidesAnalysisQueryDto, CheckPdfStatusResponse, AssistantImageDto } from './plato-intefaces';
+export interface ApiClientConfig {
+    baseUrl: string;
+    token?: string;
+    user?: string;
+    jwtToken?: string;
+}
+export interface ToolCall {
+    function: {
+        name: string;
+        arguments: {
+            slideNumber?: number;
+            progressObjectiveNumber?: number;
+            [key: string]: unknown;
+        };
+    };
+    id: string;
+}
+/**
+ * Event map for call events, providing strict typing for each event's payload.
+ * There are no inputs for the events and all of them return void.
+ */
+export interface CallEventMap {
+    'call-start': undefined;
+    'call-end': undefined;
+    'speech-start': undefined;
+    'speech-end': undefined;
+    error: Error;
+    message: {
+        type: string;
+        role: string;
+        transcript?: string;
+        transcriptType: 'final' | 'partial';
+        toolCallList?: ToolCall[];
+        toolCalls?: ToolCall[];
+        [key: string]: unknown;
+    };
+    'volume-level': number;
+    'call-details-ready': CallDTO;
+}
+export type CallEventNames = keyof CallEventMap;
+export type CallEventListener<K extends CallEventNames> = (payload: CallEventMap[K]) => void;
+export declare class PlatoApiClient {
+    private config;
+    private static readonly ACTIVE_CALL_STORAGE_KEY;
+    private http;
+    private eventListeners;
+    private callControllerInstance?;
+    private eventsAttached;
+    private currentCallId?;
+    private vapiEventNames;
+    eventNames: CallEventNames[];
+    constructor(config: ApiClientConfig);
+    /**
+     * Update the JWT token for all subsequent requests.
+     * Useful when the token is refreshed or when switching user context.
+     */
+    setJwtToken(jwtToken: string): void;
+    /**
+     * Remove the JWT token from subsequent requests.
+     */
+    clearJwtToken(): void;
+    /**
+     * Register a listener for a call event with strict typing.
+     * @param event Event name
+     * @param listener Listener function
+     */
+    private on;
+    /**
+     * Remove a listener for a call event with strict typing.
+     * @param event Event name
+     * @param listener Listener function
+     */
+    private off;
+    /**
+     * Internal: Attach event listeners and propagate to registered listeners.
+     */
+    private attachEvents;
+    /**
+     * Internal: Emit SDK-specific events that are not part of Vapi.
+     */
+    private emit;
+    /**
+     * Store active call state in localStorage for recovery purposes.
+     * @private
+     */
+    private storeCallState;
+    /**
+     * Retrieve active call state from localStorage.
+     * Validates the stored data and clears it if invalid.
+     * @private
+     * @returns The stored call state or null if not found or invalid
+     */
+    private getStoredCallState;
+    /**
+     * Clear active call state from localStorage.
+     * @private
+     */
+    private clearCallState;
+    /**
+     * Check if a stored call is considered abandoned based on age.
+     * Calls older than 5 minutes are considered abandoned.
+     * @private
+     * @param state The call state to check
+     * @returns true if the call is abandoned, false otherwise
+     */
+    private isCallAbandoned;
+    /**
+     * Recover and clean up any abandoned calls from previous sessions.
+     *
+     * This method should be called during application initialization,
+     * typically in ngOnInit() or useEffect(). It detects calls that were
+     * active when the page was last refreshed and notifies the backend
+     * to process them if they're older than 5 minutes.
+     *
+     * The backend endpoint is idempotent, so calling this method multiple
+     * times for the same call is safe.
+     *
+     * @returns Promise<boolean> - true if an abandoned call was recovered and processed
+     *
+     * @example
+     * // In Angular component
+     * async ngOnInit(): Promise<void> {
+     *   const recovered = await this.platoClient.recoverAbandonedCall();
+     *   if (recovered) {
+     *     console.log('Recovered abandoned call from previous session');
+     *   }
+     * }
+     *
+     * @example
+     * // In React component
+     * useEffect(() => {
+     *   platoClient.recoverAbandonedCall()
+     *     .then(recovered => {
+     *       if (recovered) {
+     *         console.log('Recovered abandoned call');
+     *       }
+     *     })
+     *     .catch(console.error);
+     * }, []);
+     */
+    recoverAbandonedCall(): Promise<boolean>;
+    createSimulation(createSimulationParams: CreateSimulationDto): Promise<{
+        simulationId: string;
+        phase: CreationPhase;
+    }>;
+    checkSimulationStatus(simulationId: string): Promise<{
+        phase: CreationPhase;
+    }>;
+    getUserSimulations(): Promise<Array<{
+        simulationId: string;
+        phase: CreationPhase;
+    }>>;
+    getSimulationDetails(simulationId: string): Promise<SimulationDetailsDto>;
+    /**
+     * Deletes a simulation (assistant) from the server and Vapi.
+     * @param simulationId - MongoDB ObjectId of the simulation
+     * @throws 404 if simulation not found
+     */
+    deleteSimulation(simulationId: string): Promise<void>;
+    getCallDetails(callId: string): Promise<CallDTO>;
+    getCallRecordings(queryParams: SimulationRecordingsQueryDto): Promise<SimulationRecordingsDto[]>;
+    getCallRecording(callId: string): Promise<string>;
+    /**
+     * Remove all listeners for all call events.
+     */
+    private removeAllEventListeners;
+    startCall(simulationId: string): Promise<{
+        stopCall: () => void;
+        callId: string;
+        /**
+         * Subscribe to call events for this call with strict typing.
+         * @param event Event name
+         * @param listener Listener function
+         */
+        on: <K extends CallEventNames>(event: K, listener: CallEventListener<K>) => void;
+        /**
+         * Unsubscribe from call events for this call with strict typing.
+         * @param event Event name
+         * @param listener Listener function
+         */
+        off: <K extends CallEventNames>(event: K, listener: CallEventListener<K>) => void;
+    }>;
+    private onCallEnded;
+    private createCall;
+    uploadPdfSlides(file: File | Blob): Promise<string>;
+    getRecommendations(): Promise<RecommendationsResponseDto>;
+    getSlidesAnalysis(queryParams: PdfSlidesAnalysisQueryDto): Promise<PdfSlidesDto[]>;
+    getSlideAnalysis(id: string): Promise<PdfSlideDto>;
+    deleteSlideAnalysis(id: string): Promise<void>;
+    checkPdfStatus(id: string): Promise<CheckPdfStatusResponse>;
+    getAssistantImages(): Promise<AssistantImageDto[]>;
+}