@ctchealth/plato-sdk 0.0.7 → 0.0.9

package/README.md

@@ -29,58 +29,51 @@ import { PlatoApiClient } from 'plato-sdk';
 const client = new PlatoApiClient({
   baseUrl: 'https://your-plato-api.com',
   token: 'your-api-token',
-  user: 'test@test.test'
+  user: 'test@test.test',
 });
 
 // Create a simulation
 const simulation = await client.createSimulation({
-  "persona": {
-    "professionalProfile": {
-      "location": "City Hospital, New York",
-      "practiceSettings": "Outpatient Clinic",
-      "yearOfExperience": 12,
-      "specialityAndDepartment": "Cardiology"
+  persona: {
+    professionalProfile: {
+      location: 'City Hospital, New York',
+      practiceSettings: 'Outpatient Clinic',
+      yearOfExperience: 12,
+      specialityAndDepartment: 'Cardiology',
     },
-    "segment": SegmentType.CostConsciousPrescriber,
-    "assistantGender": AssistantVoiceGender.Male,
-    "name": "Dr Vegapunk",
-    "personalityAndBehaviour": {
-      "riskTolerance": 40,
-      "researchOrientation": 70,
-      "recognitionNeed": 60,
-      "brandLoyalty": 55,
-      "patientEmpathy": 80,
-      "trainingDifficulty": 50,
-      "friendliness": 75
+    segment: SegmentType.CostConsciousPrescriber,
+    assistantGender: AssistantVoiceGender.Male,
+    name: 'Dr Vegapunk',
+    personalityAndBehaviour: {
+      riskTolerance: 40,
+      researchOrientation: 70,
+      recognitionNeed: 60,
+      brandLoyalty: 55,
+      patientEmpathy: 80,
+    },
+    context: {
+      subSpecialityOrTherapyFocus: 'Hypertension management',
+      typicalPatientMix: 'Elderly with comorbidities',
+      keyClinicalDrivers: 'Reducing cardiovascular risk',
     },
-    "context": {
-      "subSpecialityOrTherapyFocus": "Hypertension management",
-      "typicalPatientMix": "Elderly with comorbidities",
-      "keyClinicalDrivers": "Reducing cardiovascular risk"
-    }
   },
-  "product": {
-    "name": "Ibuprofen 1000mg",
-    "description": "A nonsteroidal anti-inflammatory drug used to reduce pain, inflammation, and fever"
+  product: {
+    name: 'Ibuprofen 1000mg',
+    description:
+      'A nonsteroidal anti-inflammatory drug used to reduce pain, inflammation, and fever',
   },
-  "presentation": "Oral tablets, 10 tablets per pack",
-  "scenario": "Discussing treatment options for an elderly patient with chronic arthritis",
-  "objectives": [
-    "Demonstrate efficacy of Ibuprofen in pain management",
-    "Highlight safety profile and contraindications",
-    "Encourage patient adherence"
+  presentation: 'Oral tablets, 10 tablets per pack',
+  scenario: 'Discussing treatment options for an elderly patient with chronic arthritis',
+  objectives: [
+    'Demonstrate efficacy of Ibuprofen in pain management',
+    'Highlight safety profile and contraindications',
+    'Encourage patient adherence',
   ],
-  "anticipatedObjections": [
-    "Concerns about gastrointestinal side effects",
-    "Preference for lower-cost generic alternatives",
-    "Potential interactions with other medications"
+  anticipatedObjections: [
+    'Concerns about gastrointestinal side effects',
+    'Preference for lower-cost generic alternatives',
+    'Potential interactions with other medications',
   ],
-  "trainingConfiguration": {
-    "trainingDifficulty": 70,
-    "communicationFormality": 75,
-    "friendlinessLevel": 65,
-    "subjectMatterExpertise": 80
-  }
 });
 
 // Check the simulation status - If simulation creation phase is equals to FINISHED, the simulation is ready to use
@@ -96,7 +89,7 @@ call.on('call-start', () => {
   console.log('Call started');
 });
 
-call.on('message', (message) => {
+call.on('message', message => {
   console.log('Message received:', message.transcript);
 });
 
@@ -121,6 +114,7 @@ new PlatoApiClient(config: ApiClientConfig)
 ```
 
 **Parameters:**
+
 - `config.baseUrl` (string): The base URL of the Plato API
 - `config.token` (string): Your API authentication token
 - `config.user` (string): Your user identifier
@@ -138,6 +132,7 @@ Creates a new medical training simulation. It may take a few minutes for the sim
 Starts a voice call with the AI persona for the specified simulation.
 
 **Returns:** Object with:
+
 - `stopCall()`: Function to end the call
 - `callId`: Unique identifier for the call
 - `on<K>(event: K, listener: CallEventListener<K>)`: Subscribe to call events
@@ -148,9 +143,11 @@ Starts a voice call with the AI persona for the specified simulation.
 Retrieves detailed information about a completed call, including transcript, summary, recording URL, ratings, and evaluation metrics.
 
 **Parameters:**
+
 - `callId` (string): The MongoDB `_id` of the call
 
 **Returns:** `Promise<CallDTO>` — An object containing:
+
 - `_id`: MongoDB ID of the call
 - `summary`: Summary of the conversation
 - `transcript`: Full transcript of the call
@@ -167,12 +164,63 @@ Retrieves detailed information about a completed call, including transcript, sum
 - And other call-related fields
 
 **Example:**
+
 ```typescript
 // After a call has ended, retrieve its details
 const callDetails = await client.getCallDetails(call._id);
 console.log('Call Summary:', callDetails.summary);
 ```
 
+##### getCallRecordings(queryParams: SimulationRecordingsQueryDto)
+
+Retrieves a paginated list of call recordings for the authenticated user.
+
+**Parameters:**
+
+- `queryParams` (SimulationRecordingsQueryDto): Query parameters for filtering and pagination
+  - `limit` (optional): Number of recordings per page (`5`, `10`, or `25`)
+  - `page` (optional): Page number for pagination
+  - `sort` (optional): Sort order (`'asc'` or `'desc'`)
+
+**Returns:** `Promise<SimulationRecordingsDto[]>` — An array of recording objects, each containing:
+
+- `_id`: MongoDB ID of the call
+- `createdAt`: Timestamp when the call was created
+- `recordingStatus`: Status of the recording (`'STARTED'`, `'PROCESSING'`, `'FINISHED'`, or `'FAILED'`)
+
+**Example:**
+
+```typescript
+// Get the 10 most recent call recordings
+const recordings = await client.getCallRecordings({
+  limit: 10,
+  page: 1,
+  sort: 'desc',
+});
+
+recordings.forEach(recording => {
+  console.log(`Call ${recording._id} - Status: ${recording.recordingStatus}`);
+});
+```
+
+##### getCallRecording(callId: string)
+
+Retrieves the recording URL for a specific call.
+
+**Parameters:**
+
+- `callId` (string): The MongoDB `_id` of the call
+
+**Returns:** `Promise<string>` — The URL to access the call recording
+
+**Example:**
+
+```typescript
+// Get the recording URL for a specific call
+const recordingUrl = await client.getCallRecording(call._id);
+console.log('Recording URL:', recordingUrl);
+```
+
 ## Checking Simulation Status
 
 You can check the current phase/status of a simulation using the `checkSimulationStatus` method. This is useful for polling the simulation creation process until it is ready or has failed.
@@ -203,19 +251,18 @@ The SDK provides a comprehensive event system for managing voice calls:
 
 ```typescript
 // Subscribe to events
-call.on('message', (message) => {
+call.on('message', message => {
   console.log('Transcript:', message.transcript);
   console.log('Type:', message.transcriptType); // 'final' or 'partial'
 });
 
-call.on('volume-level', (level) => {
+call.on('volume-level', level => {
   console.log('Volume level:', level);
 });
 
-call.on('error', (error) => {
+call.on('error', error => {
   console.error('Call error:', error);
 });
-
 ```
 
 ## Data Types
@@ -247,7 +294,7 @@ interface CharacterCreateDto {
   segment: SegmentType;
   personalityAndBehaviour: PersonalityAndBehaviourDto;
   context: ContextDto;
-  assistantGender: AssistantVoiceGender;
+  assistantGender?: AssistantVoiceGender;
 }
 ```
 
@@ -260,7 +307,7 @@ try {
   const client = new PlatoApiClient({
     baseUrl: 'https://api.plato.com',
     token: 'your-token',
-    user: 'your-user'
+    user: 'your-user',
   });
 
   const simulation = await client.createSimulation(simulationConfig);
@@ -270,7 +317,6 @@ try {
 }
 ```
 
-
 ## Support
 
 For support and questions, please contact the development team.

package/eslint.config.cjs

@@ -0,0 +1,121 @@
+const { defineConfig, globalIgnores } = require('eslint/config');
+const path = require('path');
+
+const typescriptEslintEslintPlugin = require('@typescript-eslint/eslint-plugin');
+const globals = require('globals');
+const tsParser = require('@typescript-eslint/parser');
+const jest = require('eslint-plugin-jest');
+const js = require('@eslint/js');
+const headers = require('eslint-plugin-headers');
+const { FlatCompat } = require('@eslint/eslintrc');
+const baseRules = require('../../eslint-config-base.cjs');
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+module.exports = defineConfig([
+  globalIgnores([
+    '**/.eslintrc.js',
+    'src/index.d.ts',
+    'scripts/db-migrations/archived/**/*',
+    '**/*.spec.ts',
+    '**/*.config.js',
+    '**/*.config.cjs',
+    '**/jest.config.ts',
+  ]),
+  {
+    files: ['**/*.ts'],
+    plugins: {
+      headers,
+    },
+    rules: {
+      'headers/header-format': [
+        'error',
+        {
+          source: 'string',
+          content: `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.`,
+          style: 'jsdoc',
+          trailingNewlines: 1,
+          preservePragmas: false,
+        },
+      ],
+    },
+  },
+  {
+    extends: compat.extends(
+      'plugin:@typescript-eslint/recommended',
+      'plugin:@typescript-eslint/recommended-requiring-type-checking',
+      'plugin:@typescript-eslint/strict'
+    ),
+
+    files: ['**/*.ts'],
+    ignores: ['**/*.json', '**/*.spec.ts'],
+
+    plugins: {
+      '@typescript-eslint': typescriptEslintEslintPlugin,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+
+      parser: tsParser,
+      ecmaVersion: 10,
+      sourceType: 'module',
+
+      parserOptions: {
+        project: path.join(__dirname, 'tsconfig.lib.json'),
+      },
+    },
+
+    rules: {
+      ...baseRules.rules, // shared rules
+      // project-specific rules
+      '@typescript-eslint/ban-ts-comment': 'warn',
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'warn',
+      '@typescript-eslint/promise-function-async': ['error'],
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/await-thenable': 'error',
+      semi: ['error', 'always'],
+      '@typescript-eslint/unbound-method': 'error',
+      'keyword-spacing': ['error'],
+      '@typescript-eslint/restrict-template-expressions': 'error',
+      '@typescript-eslint/prefer-regexp-exec': 'warn',
+      '@typescript-eslint/require-await': 'warn',
+      '@typescript-eslint/no-non-null-assertion': 'error',
+      '@typescript-eslint/no-unnecessary-condition': 'warn',
+      '@typescript-eslint/prefer-ts-expect-error': 'warn',
+      '@typescript-eslint/prefer-nullish-coalescing': 'off',
+      'space-infix-ops': 'off',
+    },
+  },
+  {
+    files: ['**/*.spec.ts'],
+    extends: compat.extends('plugin:jest/recommended'),
+
+    plugins: {
+      jest,
+    },
+
+    rules: {
+      '@typescript-eslint/unbound-method': 'off',
+      'jest/unbound-method': 'error',
+    },
+  },
+]);

package/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'plato-sdk',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/plato-sdk',
+};

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@ctchealth/plato-sdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@vapi-ai/web": "2.1.8"
+    "@vapi-ai/web": "2.1.8",
+    "axios": "^1.7.9"
   },
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "publishConfig": {
     "access": "public"
-  },
-  "types": "./src/index.d.ts"
-}
+  }
+}

package/project.json

@@ -0,0 +1,24 @@
+{
+  "name": "plato-sdk",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/plato-sdk/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/plato-sdk",
+        "main": "libs/plato-sdk/src/index.ts",
+        "tsConfig": "libs/plato-sdk/tsconfig.lib.json",
+        "assets": ["libs/plato-sdk/*.md"]
+      }
+    },
+    "nx-release-publish": {
+      "options": {
+        "packageRoot": "dist/{projectRoot}"
+      }
+    }
+  }
+}

package/src/lib/plato-intefaces.ts

@@ -0,0 +1,232 @@
+/**
+ * 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 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;
+  presentation?: string;
+  scenario!: string;
+  objectives?: string[];
+  anticipatedObjections?: 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;
+}
+
+export enum CreationStatus {
+  CREATING = 'CREATING',
+  READY = 'READY',
+  ERROR = 'ERROR',
+}
+export enum CreationPhase {
+  STARTING = 'STARTING',
+  CORE = 'CORE',
+  BOUNDARIES = 'BOUNDARIES',
+  SPEECH_AND_THOUGHT = 'SPEECH_AND_THOUGHT',
+  CONVERSATION_EVOLUTION = 'CONVERSATION_EVOLUTION',
+  MEMORY = 'MEMORY',
+  FINISHED = 'FINISHED',
+  ERROR = 'ERROR',
+}