@ctchealth/plato-sdk 0.0.18 → 0.0.19

package/src/lib/plato-intefaces.ts

@@ -0,0 +1,433 @@
+/**
+ * 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.
+ */
+export enum YearOfExperience {
+  '1-5' = '1-5 years',
+  '6-10' = '6-10 years',
+  '11-20' = '16-20 years',
+  '20+' = '20+ years',
+}
+
+export enum PracticeType {
+  Private = 'Private Practice',
+  Hospital = 'Hospital',
+  AcademicMedicalCenter = 'Academic Medical Center',
+  Clinic = 'Clinic',
+}
+export enum SegmentType {
+  Traditionalist = 'The Traditionalist',
+  Innovator = 'The Innovator',
+  PatientOrientedPhysician = 'The Patient-Oriented Physician',
+  FinanciallyDrivenPrescriber = 'The Financially-Driven Prescriber',
+  EvidencePurist = 'The Evidence-Purist',
+  CostConsciousPrescriber = 'The Cost-Conscious Prescriber',
+}
+
+export enum AssistantVoiceGender {
+  Male = 'Male',
+  Female = 'Female',
+}
+
+export enum AvatarLanguage {
+  English = 'en',
+  German = 'de',
+  Spanish = 'es',
+  Italian = 'it',
+  French = 'fr',
+  Arabic = 'ar',
+  Russian = 'ru',
+}
+
+export class PersonalityAndBehaviourDto {
+  riskTolerance!: number;
+  researchOrientation!: number;
+  recognitionNeed!: number;
+  brandLoyalty!: number;
+  patientEmpathy!: number;
+}
+
+export class ProfessionalProfileDto {
+  practiceSettings!: string;
+  yearOfExperience!: number;
+  specialityAndDepartment!: string;
+  location!: string;
+}
+
+export class ContextDto {
+  subSpecialityOrTherapyFocus!: string;
+  typicalPatientMix!: string;
+  keyClinicalDrivers!: string;
+}
+
+export class CharacterCreateDto {
+  name!: string;
+  professionalProfile!: ProfessionalProfileDto;
+  segment!: SegmentType;
+  personalityAndBehaviour!: PersonalityAndBehaviourDto;
+  context!: ContextDto;
+  assistantGender?: AssistantVoiceGender;
+}
+
+export class ProductConfig {
+  name!: string;
+  description!: string;
+}
+
+export class CreateSimulationDto {
+  persona!: CharacterCreateDto;
+  product!: ProductConfig;
+  scenario!: string;
+  objectives?: string;
+  anticipatedObjections?: string;
+  imageId!: string;
+  avatarLanguage!: AvatarLanguage;
+  pdfSlideId?: string;
+}
+
+export type RecordingsLimit = 5 | 10 | 25;
+
+export class SimulationRecordingsQueryDto {
+  limit?: RecordingsLimit;
+  page?: number;
+  sort?: SortOrder;
+}
+
+export enum SortOrder {
+  ASC = 'asc',
+  DESC = 'desc',
+}
+
+export enum RecordingStatus {
+  STARTED = 'STARTED',
+  PROCESSING = 'PROCESSING',
+  FINISHED = 'FINISHED',
+  FAILED = 'FAILED',
+}
+
+export class SimulationRecordingsDto {
+  _id!: string;
+  createdAt!: Date;
+  recordingStatus?: RecordingStatus;
+}
+
+//
+export interface CallCreateDto {
+  /**
+   * Call ID obtained
+   */
+  callId: string;
+  /**
+   * Call Assistant ID
+   */
+  assistantId: string;
+}
+
+export interface CallDTO {
+  /**
+   * call ID
+   */
+  _id: string;
+  /**
+   *  call ID obtained
+   */
+  callId: string;
+  /**
+   *  call User ID
+   */
+  platoUserId: string;
+  /**
+   *  call Assistant ID
+   */
+  assistantId: string;
+  /**
+   *  call summary of the conversation
+   */
+  summary: string;
+  /**
+   *  call transcript of the conversation
+   */
+  transcript: string;
+  /**
+   *  call feedback provided by the user
+   */
+  feedback: string;
+  /**
+   * Success Evaluation returned by model
+   */
+  successEvaluation: boolean;
+  /**
+   *  call Recording URL
+   */
+  recordingUrl: string;
+  /**
+   * Status of recording processing (e.g., 'STARTED', 'PROCESSING', 'FINISHED', 'FAILED')
+   */
+  recordingStatus?: RecordingStatus;
+  /**
+   * Date and Time of the creation of the message
+   */
+  createdAt: Date;
+  /**
+   * Date and Time of the creation of the message
+   */
+  endedAt: Date;
+  /**
+   * Rating of the call given by the user
+   */
+  rating: number;
+  /**
+   * Main strenghts of the user conversation based on the analysis of the AI
+   */
+  strengths: Array<string>;
+  /**
+   * Main weak points of the user conversation based on the analysis of the AI
+   */
+  weaknesses: Array<string>;
+  /**
+   * Name of Metric for the AI feedback report
+   */
+  metric1: string;
+  /**
+   * Name of Metric for the AI feedback report
+   */
+  metric2: string;
+  /**
+   * Name of Metric for the AI feedback report
+   */
+  metric3: string;
+  /**
+   * AI feedback value for Metric 1
+   */
+  metric1Value: number;
+  /**
+   * AI feedback value for Metric 2
+   */
+  metric2Value: number;
+  /**
+   * AI feedback value for Metric 3
+   */
+  metric3Value: number;
+  /**
+   * AI feedback value for the call score
+   */
+  score?: number;
+  /**
+   * Defines if the calls will be consider for the memory feature
+   */
+  inMemory: boolean;
+  /**
+   * Duration of the call in milliseconds
+   */
+  callDurationMs?: number;
+}
+
+export enum CreationPhase {
+  QUEUED = 'QUEUED',
+  STARTING = 'STARTING',
+  BUILD_HEADER = 'BUILD_HEADER',
+  SEGMENT_SELECTED = 'SEGMENT_SELECTED',
+  BUILD_CONTEXT = 'BUILD_CONTEXT',
+  BUILD_PSYCHOGRAPHICS = 'BUILD_PSYCHOGRAPHICS',
+  BUILD_OBJECTIVES = 'BUILD_OBJECTIVES',
+  PERSONA_ASSEMBLED = 'PERSONA_ASSEMBLED',
+  CORE = 'CORE',
+  BOUNDARIES = 'BOUNDARIES',
+  SPEECH_AND_THOUGHT = 'SPEECH_AND_THOUGHT',
+  CONVERSATION_EVOLUTION = 'CONVERSATION_EVOLUTION',
+  MEMORY = 'MEMORY',
+  OBJECTION_HANDLING = 'OBJECTION_HANDLING',
+  PERFORMANCE_EVALUATION = 'PERFORMANCE_EVALUATION',
+  BEHAVIORAL_FRAMEWORKS = 'BEHAVIORAL_FRAMEWORKS',
+  FINISHED = 'FINISHED',
+  ERROR = 'ERROR',
+}
+
+/**
+ * Presigned POST data for S3 upload.
+ */
+export interface PresignedPost {
+  url: string;
+  fields: Record<string, string>;
+}
+
+/**
+ * Response for requesting a PDF upload.
+ */
+export interface RequestPdfUploadResponse {
+  presignedPost: PresignedPost;
+  objectKey: string;
+  pdfId: string;
+}
+
+/**
+ * Persona description within simulation briefing
+ */
+export interface PersonaDescriptionDto {
+  summary: string;
+  details: string[];
+}
+
+/**
+ * Scenario context within simulation briefing
+ */
+export interface ScenarioContextDto {
+  summary: string;
+  steps: string[];
+}
+
+/**
+ * Training objectives within simulation briefing
+ */
+export interface TrainingObjectiveDto {
+  summary: string;
+  keyObjectives: string[];
+}
+
+/**
+ * Complete simulation briefing structure generated by multi-agent system
+ */
+export interface SimulationBriefingDto {
+  objectiveTag: string;
+  personaDescription: PersonaDescriptionDto;
+  scenarioContext: ScenarioContextDto;
+  trainingObjective: TrainingObjectiveDto;
+}
+
+export interface SimulationDetailsDto {
+  simulationId: string;
+  phase: CreationPhase;
+  assistantId: string;
+  configuration?: CreateSimulationDto;
+  simulationBriefing?: SimulationBriefingDto;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export enum RecommendationPriority {
+  HIGH = 'high',
+  MEDIUM = 'medium',
+  LOW = 'low',
+}
+
+export interface RecommendationItemDto {
+  title: string;
+  description: string;
+  priority: RecommendationPriority;
+}
+
+export interface PerformancePatternDto {
+  strength: string;
+  frequency: number;
+}
+
+export interface ImprovementAreaDto {
+  area: string;
+  frequency: number;
+}
+
+export interface RecommendationsResponseDto {
+  recommendations: RecommendationItemDto[];
+  strengths: PerformancePatternDto[];
+  improvementAreas: ImprovementAreaDto[];
+  summary: string;
+  callsAnalyzed: number;
+  generatedAt: Date;
+}
+
+export enum PdfSlidesStatus {
+  PENDING = 'pending',
+  STARTED = 'started',
+  PROCESSING = 'processing',
+  OVERVIEW = 'overview',
+  COMPLETED = 'completed',
+  FAILED = 'failed',
+}
+
+export interface CheckPdfStatusResponse {
+  status: PdfSlidesStatus;
+  processedBatches: number[];
+  totalBatches?: number;
+}
+
+export enum PdfSlidesSortField {
+  CREATED_AT = 'createdAt',
+  FILENAME = 'originalFilename',
+  TOTAL_SLIDES = 'totalSlides',
+}
+
+export class PdfSlidesAnalysisQueryDto {
+  limit?: RecordingsLimit;
+  page?: number;
+  sort?: SortOrder;
+  sortBy?: PdfSlidesSortField;
+}
+
+export interface SlideAnalysis {
+  slideNumber: number;
+  title?: string;
+  textExtraction?: string;
+  visualDescription?: string;
+}
+
+export interface PdfSlidesDto {
+  _id: string;
+  status: PdfSlidesStatus;
+  originalFilename: string;
+  totalSlides?: number;
+  lessonOverview?: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface PdfSlideDto {
+  _id: string;
+  status: PdfSlidesStatus;
+  originalFilename: string;
+  totalSlides?: number;
+  lessonOverview?: string;
+  slideAnalysis?: SlideAnalysis[];
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface AssistantImageDto {
+  _id: string;
+  imageUrl: string;
+}
+
+/**
+ * Represents the state of an active call stored in localStorage for recovery purposes.
+ * Used to detect and recover abandoned calls after page refresh.
+ */
+export interface ActiveCallState {
+  /**
+   * MongoDB ID of the call record
+   */
+  callId: string;
+  /**
+   * External call provider ID
+   */
+  externalCallId: string;
+  /**
+   * ID of the simulation this call belongs to
+   */
+  simulationId: string;
+  /**
+   * ISO 8601 timestamp when the call was started
+   */
+  startedAt: string;
+  /**
+   * Schema version for future compatibility
+   */
+  version: number;
+}