@ctchealth/plato-sdk 0.0.19 → 0.0.21

package/src/lib/plato-intefaces.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PdfSlidesAnalysisQueryDto = exports.PdfSlidesSortField = exports.PdfSlidesStatus = exports.RecommendationPriority = exports.CreationPhase = exports.SimulationRecordingsDto = exports.RecordingStatus = exports.SortOrder = exports.SimulationRecordingsQueryDto = exports.CreateSimulationDto = exports.ProductConfig = exports.CharacterCreateDto = exports.ContextDto = exports.ProfessionalProfileDto = exports.PersonalityAndBehaviourDto = exports.AvatarLanguage = exports.AssistantVoiceGender = exports.SegmentType = exports.PracticeType = exports.YearOfExperience = void 0;
+/**
+ * Copyright (c) 2025 ctcHealth. All rights reserved.
+ *
+ * This file is part of the ctcHealth Plato Platform, a proprietary software system developed by ctcHealth.
+ *
+ * This source code and all related materials are confidential and proprietary to ctcHealth.
+ * Unauthorized access, use, copying, modification, distribution, or disclosure is strictly prohibited
+ * and may result in disciplinary action and civil and/or criminal penalties.
+ *
+ * This software is intended solely for authorized use within ctcHealth and its designated partners.
+ *
+ * For internal use only.
+ */
+var YearOfExperience;
+(function (YearOfExperience) {
+    YearOfExperience["1-5"] = "1-5 years";
+    YearOfExperience["6-10"] = "6-10 years";
+    YearOfExperience["11-20"] = "16-20 years";
+    YearOfExperience["20+"] = "20+ years";
+})(YearOfExperience || (exports.YearOfExperience = YearOfExperience = {}));
+var PracticeType;
+(function (PracticeType) {
+    PracticeType["Private"] = "Private Practice";
+    PracticeType["Hospital"] = "Hospital";
+    PracticeType["AcademicMedicalCenter"] = "Academic Medical Center";
+    PracticeType["Clinic"] = "Clinic";
+})(PracticeType || (exports.PracticeType = PracticeType = {}));
+var SegmentType;
+(function (SegmentType) {
+    SegmentType["Traditionalist"] = "The Traditionalist";
+    SegmentType["Innovator"] = "The Innovator";
+    SegmentType["PatientOrientedPhysician"] = "The Patient-Oriented Physician";
+    SegmentType["FinanciallyDrivenPrescriber"] = "The Financially-Driven Prescriber";
+    SegmentType["EvidencePurist"] = "The Evidence-Purist";
+    SegmentType["CostConsciousPrescriber"] = "The Cost-Conscious Prescriber";
+})(SegmentType || (exports.SegmentType = SegmentType = {}));
+var AssistantVoiceGender;
+(function (AssistantVoiceGender) {
+    AssistantVoiceGender["Male"] = "Male";
+    AssistantVoiceGender["Female"] = "Female";
+})(AssistantVoiceGender || (exports.AssistantVoiceGender = AssistantVoiceGender = {}));
+var AvatarLanguage;
+(function (AvatarLanguage) {
+    AvatarLanguage["English"] = "en";
+    AvatarLanguage["German"] = "de";
+    AvatarLanguage["Spanish"] = "es";
+    AvatarLanguage["Italian"] = "it";
+    AvatarLanguage["French"] = "fr";
+    AvatarLanguage["Arabic"] = "ar";
+    AvatarLanguage["Russian"] = "ru";
+})(AvatarLanguage || (exports.AvatarLanguage = AvatarLanguage = {}));
+class PersonalityAndBehaviourDto {
+    riskTolerance;
+    researchOrientation;
+    recognitionNeed;
+    brandLoyalty;
+    patientEmpathy;
+}
+exports.PersonalityAndBehaviourDto = PersonalityAndBehaviourDto;
+class ProfessionalProfileDto {
+    practiceSettings;
+    yearOfExperience;
+    specialityAndDepartment;
+    location;
+}
+exports.ProfessionalProfileDto = ProfessionalProfileDto;
+class ContextDto {
+    subSpecialityOrTherapyFocus;
+    typicalPatientMix;
+    keyClinicalDrivers;
+}
+exports.ContextDto = ContextDto;
+class CharacterCreateDto {
+    name;
+    professionalProfile;
+    segment;
+    personalityAndBehaviour;
+    context;
+    assistantGender;
+}
+exports.CharacterCreateDto = CharacterCreateDto;
+class ProductConfig {
+    name;
+    description;
+}
+exports.ProductConfig = ProductConfig;
+class CreateSimulationDto {
+    persona;
+    product;
+    scenario;
+    objectives;
+    anticipatedObjections;
+    imageId;
+    avatarLanguage;
+    pdfSlideId;
+    isLearning;
+}
+exports.CreateSimulationDto = CreateSimulationDto;
+class SimulationRecordingsQueryDto {
+    limit;
+    page;
+    sort;
+}
+exports.SimulationRecordingsQueryDto = SimulationRecordingsQueryDto;
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "asc";
+    SortOrder["DESC"] = "desc";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+var RecordingStatus;
+(function (RecordingStatus) {
+    RecordingStatus["STARTED"] = "STARTED";
+    RecordingStatus["PROCESSING"] = "PROCESSING";
+    RecordingStatus["FINISHED"] = "FINISHED";
+    RecordingStatus["FAILED"] = "FAILED";
+})(RecordingStatus || (exports.RecordingStatus = RecordingStatus = {}));
+class SimulationRecordingsDto {
+    _id;
+    createdAt;
+    recordingStatus;
+}
+exports.SimulationRecordingsDto = SimulationRecordingsDto;
+var CreationPhase;
+(function (CreationPhase) {
+    CreationPhase["QUEUED"] = "QUEUED";
+    CreationPhase["STARTING"] = "STARTING";
+    CreationPhase["BUILD_HEADER"] = "BUILD_HEADER";
+    CreationPhase["SEGMENT_SELECTED"] = "SEGMENT_SELECTED";
+    CreationPhase["BUILD_CONTEXT"] = "BUILD_CONTEXT";
+    CreationPhase["BUILD_PSYCHOGRAPHICS"] = "BUILD_PSYCHOGRAPHICS";
+    CreationPhase["BUILD_OBJECTIVES"] = "BUILD_OBJECTIVES";
+    CreationPhase["PERSONA_ASSEMBLED"] = "PERSONA_ASSEMBLED";
+    CreationPhase["CORE"] = "CORE";
+    CreationPhase["BOUNDARIES"] = "BOUNDARIES";
+    CreationPhase["SPEECH_AND_THOUGHT"] = "SPEECH_AND_THOUGHT";
+    CreationPhase["CONVERSATION_EVOLUTION"] = "CONVERSATION_EVOLUTION";
+    CreationPhase["MEMORY"] = "MEMORY";
+    CreationPhase["OBJECTION_HANDLING"] = "OBJECTION_HANDLING";
+    CreationPhase["PERFORMANCE_EVALUATION"] = "PERFORMANCE_EVALUATION";
+    CreationPhase["BEHAVIORAL_FRAMEWORKS"] = "BEHAVIORAL_FRAMEWORKS";
+    CreationPhase["FINISHED"] = "FINISHED";
+    CreationPhase["ERROR"] = "ERROR";
+})(CreationPhase || (exports.CreationPhase = CreationPhase = {}));
+var RecommendationPriority;
+(function (RecommendationPriority) {
+    RecommendationPriority["HIGH"] = "high";
+    RecommendationPriority["MEDIUM"] = "medium";
+    RecommendationPriority["LOW"] = "low";
+})(RecommendationPriority || (exports.RecommendationPriority = RecommendationPriority = {}));
+var PdfSlidesStatus;
+(function (PdfSlidesStatus) {
+    PdfSlidesStatus["PENDING"] = "pending";
+    PdfSlidesStatus["STARTED"] = "started";
+    PdfSlidesStatus["PROCESSING"] = "processing";
+    PdfSlidesStatus["OVERVIEW"] = "overview";
+    PdfSlidesStatus["COMPLETED"] = "completed";
+    PdfSlidesStatus["FAILED"] = "failed";
+})(PdfSlidesStatus || (exports.PdfSlidesStatus = PdfSlidesStatus = {}));
+var PdfSlidesSortField;
+(function (PdfSlidesSortField) {
+    PdfSlidesSortField["CREATED_AT"] = "createdAt";
+    PdfSlidesSortField["FILENAME"] = "originalFilename";
+    PdfSlidesSortField["TOTAL_SLIDES"] = "totalSlides";
+})(PdfSlidesSortField || (exports.PdfSlidesSortField = PdfSlidesSortField = {}));
+class PdfSlidesAnalysisQueryDto {
+    limit;
+    page;
+    sort;
+    sortBy;
+}
+exports.PdfSlidesAnalysisQueryDto = PdfSlidesAnalysisQueryDto;
+//# sourceMappingURL=plato-intefaces.js.map

package/src/lib/plato-intefaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plato-intefaces.js","sourceRoot":"","sources":["../../../../../libs/plato-sdk/src/lib/plato-intefaces.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;GAYG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,qCAAmB,CAAA;IACnB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;AACrB,CAAC,EALW,gBAAgB,gCAAhB,gBAAgB,QAK3B;AAED,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4CAA4B,CAAA;IAC5B,qCAAqB,CAAA;IACrB,iEAAiD,CAAA;IACjD,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AACD,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,oDAAqC,CAAA;IACrC,0CAA2B,CAAA;IAC3B,0EAA2D,CAAA;IAC3D,gFAAiE,CAAA;IACjE,qDAAsC,CAAA;IACtC,wEAAyD,CAAA;AAC3D,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAED,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAED,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,gCAAc,CAAA;IACd,+BAAa,CAAA;IACb,gCAAc,CAAA;IACd,gCAAc,CAAA;IACd,+BAAa,CAAA;IACb,+BAAa,CAAA;IACb,gCAAc,CAAA;AAChB,CAAC,EARW,cAAc,8BAAd,cAAc,QAQzB;AAED,MAAa,0BAA0B;IACrC,aAAa,CAAU;IACvB,mBAAmB,CAAU;IAC7B,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,cAAc,CAAU;CACzB;AAND,gEAMC;AAED,MAAa,sBAAsB;IACjC,gBAAgB,CAAU;IAC1B,gBAAgB,CAAU;IAC1B,uBAAuB,CAAU;IACjC,QAAQ,CAAU;CACnB;AALD,wDAKC;AAED,MAAa,UAAU;IACrB,2BAA2B,CAAU;IACrC,iBAAiB,CAAU;IAC3B,kBAAkB,CAAU;CAC7B;AAJD,gCAIC;AAED,MAAa,kBAAkB;IAC7B,IAAI,CAAU;IACd,mBAAmB,CAA0B;IAC7C,OAAO,CAAe;IACtB,uBAAuB,CAA8B;IACrD,OAAO,CAAc;IACrB,eAAe,CAAwB;CACxC;AAPD,gDAOC;AAED,MAAa,aAAa;IACxB,IAAI,CAAU;IACd,WAAW,CAAU;CACtB;AAHD,sCAGC;AAED,MAAa,mBAAmB;IAC9B,OAAO,CAAsB;IAC7B,OAAO,CAAiB;IACxB,QAAQ,CAAU;IAClB,UAAU,CAAU;IACpB,qBAAqB,CAAU;IAC/B,OAAO,CAAU;IACjB,cAAc,CAAkB;IAChC,UAAU,CAAU;IACpB,UAAU,CAAW;CACtB;AAVD,kDAUC;AAID,MAAa,4BAA4B;IACvC,KAAK,CAAmB;IACxB,IAAI,CAAU;IACd,IAAI,CAAa;CAClB;AAJD,oEAIC;AAED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,wCAAqB,CAAA;IACrB,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAED,MAAa,uBAAuB;IAClC,GAAG,CAAU;IACb,SAAS,CAAQ;IACjB,eAAe,CAAmB;CACnC;AAJD,0DAIC;AA6GD,IAAY,aAmBX;AAnBD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,8CAA6B,CAAA;IAC7B,sDAAqC,CAAA;IACrC,gDAA+B,CAAA;IAC/B,8DAA6C,CAAA;IAC7C,sDAAqC,CAAA;IACrC,wDAAuC,CAAA;IACvC,8BAAa,CAAA;IACb,0CAAyB,CAAA;IACzB,0DAAyC,CAAA;IACzC,kEAAiD,CAAA;IACjD,kCAAiB,CAAA;IACjB,0DAAyC,CAAA;IACzC,kEAAiD,CAAA;IACjD,gEAA+C,CAAA;IAC/C,sCAAqB,CAAA;IACrB,gCAAe,CAAA;AACjB,CAAC,EAnBW,aAAa,6BAAb,aAAa,QAmBxB;AA+DD,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,uCAAa,CAAA;IACb,2CAAiB,CAAA;IACjB,qCAAW,CAAA;AACb,CAAC,EAJW,sBAAsB,sCAAtB,sBAAsB,QAIjC;AA2BD,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;IACvB,oCAAiB,CAAA;AACnB,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AAQD,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,8CAAwB,CAAA;IACxB,mDAA6B,CAAA;IAC7B,kDAA4B,CAAA;AAC9B,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,MAAa,yBAAyB;IACpC,KAAK,CAAmB;IACxB,IAAI,CAAU;IACd,IAAI,CAAa;IACjB,MAAM,CAAsB;CAC7B;AALD,8DAKC"}

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

@@ -0,0 +1,135 @@
+import { CallDTO, CreateSimulationDto, CreationPhase, SimulationRecordingsDto, SimulationRecordingsQueryDto, SimulationDetailsDto, RecommendationsResponseDto, PdfSlidesDto, PdfSlideDto, PdfSlidesAnalysisQueryDto, CheckPdfStatusResponse, AssistantImageDto } from './plato-intefaces';
+export interface ApiClientConfig {
+    baseUrl: string;
+    jwtToken: string;
+    publicKey: 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;
+    'call-ended-reason': {
+        reason: string;
+        isInactivity: boolean;
+    };
+}
+export type CallEventNames = keyof CallEventMap;
+export type CallEventListener<K extends CallEventNames> = (payload: CallEventMap[K]) => void;
+export declare class PlatoApiClient {
+    private config;
+    private http;
+    private eventListeners;
+    private callControllerInstance?;
+    private eventsAttached;
+    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;
+    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;
+    /**
+     * Starts a call for the given simulation.
+     * Polls the backend after call-end until the call is finalized, then emits 'call-details-ready'.
+     */
+    startCall(simulationId: string): Promise<{
+        stopCall: () => void;
+        callId: string;
+        on: <K extends CallEventNames>(event: K, listener: CallEventListener<K>) => void;
+        off: <K extends CallEventNames>(event: K, listener: CallEventListener<K>) => void;
+    }>;
+    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[]>;
+    /**
+     * Deletes a call and all associated data (messages, recommendations, recording).
+     * Only the owner of the call can delete it.
+     * @param callId - MongoDB ObjectId of the call
+     * @throws 404 if call not found
+     * @throws 403 if the caller is not the call owner
+     */
+    deleteCall(callId: string): Promise<void>;
+}