@ctchealth/plato-sdk 0.0.17 → 0.0.18

package/src/lib/utils.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Validates a file against size and type constraints.
+ *
+ * @param file - The file to check.
+ * @param maxFileSize - The maximum allowed file size in bytes.
+ * @param allowedMimeTypes - An array of allowed MIME types.
+ * @returns true if valid, or a descriptive error message if invalid.
+ */
+export declare function checkFile(file: File | Blob, maxFileSize: number, allowedMimeTypes: string[]): true | string;
+/**
+ * Calculates the SHA-256 hash of a file or blob.
+ *
+ * @param file - The file or blob to hash.
+ * @returns A promise that resolves to the hexadecimal SHA-256 hash.
+ */
+export declare function calculateHash(file: File | Blob): Promise<string>;
+/**
+ * Gets the page count of a PDF file.
+ *
+ * @param file - The PDF file or blob to check.
+ * @returns A promise that resolves to the number of pages in the PDF.
+ * @throws Error if the PDF cannot be parsed.
+ */
+export declare function getPdfPageCount(file: File | Blob): Promise<number>;

package/src/lib/utils.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkFile = checkFile;
+exports.calculateHash = calculateHash;
+exports.getPdfPageCount = getPdfPageCount;
+/**
+ * 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.
+ */
+const pdf_lib_1 = require("pdf-lib");
+/**
+ * Validates a file against size and type constraints.
+ *
+ * @param file - The file to check.
+ * @param maxFileSize - The maximum allowed file size in bytes.
+ * @param allowedMimeTypes - An array of allowed MIME types.
+ * @returns true if valid, or a descriptive error message if invalid.
+ */
+function checkFile(file, maxFileSize, allowedMimeTypes) {
+    if (file.size > maxFileSize) {
+        const uploadedSizeMB = (file.size / (1024 * 1024)).toFixed(2);
+        const maxSizeMB = (maxFileSize / (1024 * 1024)).toFixed(2);
+        return `File size (${uploadedSizeMB} MB) exceeds the maximum allowed size of ${maxSizeMB} MB.`;
+    }
+    if (!allowedMimeTypes.includes(file.type)) {
+        return `Invalid file type: ${file.type}. Allowed types are: ${allowedMimeTypes.join(', ')}.`;
+    }
+    return true;
+}
+/**
+ * Calculates the SHA-256 hash of a file or blob.
+ *
+ * @param file - The file or blob to hash.
+ * @returns A promise that resolves to the hexadecimal SHA-256 hash.
+ */
+async function calculateHash(file) {
+    const arrayBuffer = await file.arrayBuffer();
+    const hashBuffer = await crypto.subtle.digest('SHA-256', arrayBuffer);
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    const hashHex = hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+    return hashHex;
+}
+/**
+ * Gets the page count of a PDF file.
+ *
+ * @param file - The PDF file or blob to check.
+ * @returns A promise that resolves to the number of pages in the PDF.
+ * @throws Error if the PDF cannot be parsed.
+ */
+async function getPdfPageCount(file) {
+    try {
+        const arrayBuffer = await file.arrayBuffer();
+        const pdf = await pdf_lib_1.PDFDocument.load(arrayBuffer);
+        return pdf.getPageCount();
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : 'Unknown error';
+        throw new Error(`Failed to read PDF page count: ${message}`);
+    }
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../libs/plato-sdk/src/lib/utils.ts"],"names":[],"mappings":";;AAuBA,8BAgBC;AAQD,sCAMC;AASD,0CASC;AAvED;;;;;;;;;;;;GAYG;AACH,qCAAsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,SAAS,CACvB,IAAiB,EACjB,WAAmB,EACnB,gBAA0B;IAE1B,IAAI,IAAI,CAAC,IAAI,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,cAAc,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,SAAS,GAAG,CAAC,WAAW,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,cAAc,cAAc,4CAA4C,SAAS,MAAM,CAAC;IACjG,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,OAAO,sBAAsB,IAAI,CAAC,IAAI,wBAAwB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC/F,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CAAC,IAAiB;IACnD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,IAAiB;IACrD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,GAAG,GAAG,MAAM,qBAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC"}

package/eslint.config.cjs

@@ -1,121 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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/project.json

@@ -1,24 +0,0 @@
-{
-  "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

@@ -1,431 +0,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.
- */
-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',
-}
-
-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;
-  imageId!: string;
-  avatarLanguage!: AvatarLanguage;
-}
-
-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;
-}