@ctchealth/plato-sdk 0.0.16 → 0.0.17

package/README.md

@@ -445,6 +445,24 @@ Retrieves all available assistant images that can be used when creating a simula
 const images = await client.getAssistantImages();
 ```
 
+##### deleteSimulation(simulationId: string)
+
+Deletes a simulation and all associated data. This permanently removes the simulation, all its call records, and excludes it from future recommendations analysis.
+
+**Parameters:**
+
+- `simulationId` (string): The MongoDB `_id` of the simulation to delete
+
+**Returns:** `Promise<void>`
+
+**Example:**
+
+```typescript
+await client.deleteSimulation('507f1f77bcf86cd799439011');
+```
+
+**Note:** This action is irreversible. All calls and recordings linked to the simulation will also be deleted.
+
 ##### getRecommendations()
 
 Retrieves recommendations based on the user's recent call performance. Analyzes the 5 most recent calls using a sliding window of 3 calls to identify patterns and provide actionable insights. Calls shorter than 2 minutes are excluded from analysis. No new recommendations are generated if fewer than 3 eligible calls are available.
@@ -520,6 +538,7 @@ Retrieves detailed information about a simulation, including its original config
 - `phase`: Current creation phase
 - `assistantId`: The assistant ID (available after creation)
 - `configuration`: Original `CreateSimulationDto`
+- `simulationBriefing`: Optional `SimulationBriefingDto` with persona description, scenario context, and training objectives (available after creation phase reaches `FINISHED`)
 - `createdAt`, `updatedAt`: Timestamps
 
 **Example:**
@@ -539,6 +558,14 @@ if (simulationId) {
     if (details.phase !== CreationPhase.FINISHED) {
       startPolling(details.simulationId);
     }
+
+    // Access simulation briefing when available
+    if (details.simulationBriefing) {
+      console.log('Objective:', details.simulationBriefing.objectiveTag);
+      console.log('Persona:', details.simulationBriefing.personaDescription.summary);
+      console.log('Scenario:', details.simulationBriefing.scenarioContext.summary);
+      console.log('Training Goals:', details.simulationBriefing.trainingObjective.keyObjectives);
+    }
   } else {
     localStorage.removeItem('plato_simulation_id');
   }
@@ -1159,11 +1186,55 @@ interface SimulationDetailsDto {
   phase: CreationPhase;
   assistantId: string;
   configuration?: CreateSimulationDto;
+  simulationBriefing?: SimulationBriefingDto;
   createdAt: Date;
   updatedAt: Date;
 }
 ```
 
+### SimulationBriefingDto
+
+Structured briefing data generated by the multi-agent system. This data provides context about the simulation's objectives, persona, and scenario:
+
+```typescript
+interface SimulationBriefingDto {
+  objectiveTag: string;
+  personaDescription: PersonaDescriptionDto;
+  scenarioContext: ScenarioContextDto;
+  trainingObjective: TrainingObjectiveDto;
+}
+
+interface PersonaDescriptionDto {
+  summary: string;
+  details: string[];
+}
+
+interface ScenarioContextDto {
+  summary: string;
+  steps: string[];
+}
+
+interface TrainingObjectiveDto {
+  summary: string;
+  keyObjectives: string[];
+}
+```
+
+**Example:**
+
+```typescript
+const details = await client.getSimulationDetails(simulationId);
+
+if (details.simulationBriefing) {
+  console.log('Objective:', details.simulationBriefing.objectiveTag);
+  console.log('Persona:', details.simulationBriefing.personaDescription.summary);
+  console.log('Scenario:', details.simulationBriefing.scenarioContext.summary);
+  console.log('Training Goals:', details.simulationBriefing.trainingObjective.keyObjectives);
+}
+```
+
+**Note:** The `simulationBriefing` field is optional and will only be present for simulations created after the briefing feature was implemented.
+
 ### CreationPhase
 
 Enum representing the simulation creation phases:
@@ -1296,6 +1367,21 @@ interface AssistantImageDto {
 }
 ```
 
+### SegmentType
+
+Enum representing available doctor persona segments:
+
+```typescript
+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',
+}
+```
+
 ### AvatarLanguage
 
 Enum representing available avatar languages:

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,6 +1,6 @@
 {
   "name": "@ctchealth/plato-sdk",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "dependencies": {
     "tslib": "^2.3.0",
     "@vapi-ai/web": "2.1.8",
@@ -12,6 +12,5 @@
   "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/{constants.d.ts → constants.ts}

@@ -11,6 +11,6 @@
  *
  * For internal use only.
  */
-export declare const MAX_PDF_FILE_SIZE: number;
-export declare const ALLOWED_PDF_MIME_TYPES: string[];
-export declare const MAX_PDF_PAGES = 100;
+export const MAX_PDF_FILE_SIZE = 20 * 1024 * 1024; // 20MB
+export const ALLOWED_PDF_MIME_TYPES = ['application/pdf'];
+export const MAX_PDF_PAGES = 100;