wiil-core-js 0.0.82

package/dist/core/conversation/translation-conversation.schema.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateTranslationServiceLogSchema = exports.CreateTranslationServiceLogSchema = exports.TranslationServiceLogSchema = exports.UpdateTranslationParticipantSchema = exports.CreateTranslationParticipantSchema = exports.TranslationParticipantSchema = exports.TranslationMessageSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const conversation_config_schema_1 = require("./conversation-config.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Translation conversation schema definitions for real-time translation services.
+ *
+ * Translation conversations manage the lifecycle, participants, and message history of real-time language
+ * translation sessions. Tracks individual translation messages, participant metadata, session duration,
+ * and conversation status for multilingual communication across language barriers.
+ *
+ * @module conversation/translation-conversation
+ */
+/**
+ * Translation message schema - represents one translation interaction.
+ *
+ * Individual translation message capturing the complete translation pipeline from speaker's original speech
+ * to translated output for the listener. Tracks both source and target text, languages, participants, and
+ * the provisioning chain used for STT → Translation → TTS processing.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used In**: TranslationServiceLog.transcribedConversationLog array
+ * - **Processing Pipeline**: Speaker audio → STT (originalText) → Translation (translatedText) → TTS → Target participant
+ * - **Provisioning**: References ProvisioningConfigChain with isTranslation=true
+ * - **Bidirectional**: Each spoken utterance creates messages for both participants in their languages
+ *
+ * **Translation Flow:**
+ * 1. Participant A speaks in Language A → captured as audio
+ * 2. STT transcribes audio → originalText in Language A
+ * 3. Translation model translates → translatedText in Language B
+ * 4. TTS synthesizes translatedText → audio for Participant B
+ * 5. TranslationMessage stored with both texts, languages, and metadata
+ *
+ * **Metadata Examples:**
+ * - audio_url: URL to original audio recording
+ * - confidence_score: STT transcription confidence (0-1)
+ * - processing_time_ms: Total pipeline latency
+ * - translation_model: LLM model used for translation
+ */
+exports.TranslationMessageSchema = zod_1.z.object({
+    messageId: zod_1.z.string().describe("Unique identifier for this translation message (typically UUID) used for message ordering, deduplication, and reference tracking"),
+    speakerParticipantId: zod_1.z.string().describe("ID of the participant who spoke this message in their original language (references TranslationParticipant)"),
+    targetParticipantId: zod_1.z.string().describe("ID of the participant who will receive the translated message in their language (references TranslationParticipant)"),
+    originalText: zod_1.z.string().optional().describe("Transcribed text from the speaker in their original language as output by STT model (e.g., 'Hello, how are you?' from English speaker)"),
+    translatedText: zod_1.z.string().optional().describe("Translated text in the target participant's language as output by translation model (e.g., 'Hola, ¿cómo estás?' for Spanish listener)"),
+    originalLanguage: base_schema_1.LanguageCodeSchema.describe("ISO 639-1 language code of the original spoken message matching the speaker's native language (e.g., 'en-US', 'es-ES', 'fr-FR')"),
+    targetLanguage: base_schema_1.LanguageCodeSchema.describe("ISO 639-1 language code for the translation output matching the target participant's native language (e.g., 'ja-JP', 'de-DE', 'zh-CN')"),
+    provisioningConfigId: zod_1.z.string().describe("ID of the provisioning configuration chain that processed this translation including STT, translation LLM, and TTS models (references ProvisioningConfigChain with isTranslation=true)"),
+    timestamp: zod_1.z.number().describe("Unix timestamp in milliseconds when this message was processed through the translation pipeline, used for message ordering and latency analysis"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional metadata as key-value pairs including audio recording URLs, STT confidence scores, processing times, translation model details, or quality metrics"),
+});
+/**
+ * Translation participant schema.
+ *
+ * Represents an individual participant in a translation session including their language preferences,
+ * authentication credentials, role, and message history. Participants can be anchors (session initiators)
+ * or secondary participants joining the translation conversation.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Extends**: BaseModelSchema with participant-specific fields
+ * - **Relationship to Session**: N:1 - Multiple participants in one translation session
+ * - **Referenced By**: TranslationMessage via speakerParticipantId and targetParticipantId
+ * - **Access Control**: participantToken authenticates WebRTC connections
+ *
+ * **Participant Roles:**
+ * - **Anchor (isAnchor=true)**: Session initiator, typically the customer or primary caller
+ * - **Secondary (isAnchor=false)**: Joining participant, typically agent or secondary caller
+ *
+ * **Message Storage:**
+ * - transcriptions: Translation messages where this participant is either speaker or target
+ * - participantTranscribedLogs: Full conversation messages for audit and quality review
+ *
+ * **Integration:**
+ * - partnerParticipantRecordId links to external systems (CRM, HR, contact databases)
+ * - Enables unified participant profiles across multiple sessions
+ */
+exports.TranslationParticipantSchema = base_schema_1.BaseModelSchema.safeExtend({
+    translationServiceLogId: zod_1.z.string().optional().describe("ID of the translation service log this participant belongs to (N:1 relationship, references TranslationServiceLog)"),
+    partnerParticipantRecordId: zod_1.z.string().optional().describe("External partner or system participant record ID for integration with CRM, HR systems, or contact databases enabling unified participant profiles"),
+    name: zod_1.z.string().optional().describe("Human-readable name of the participant for display in UI and logs (e.g., 'John Smith', 'Customer Support Agent')"),
+    isAnchor: zod_1.z.boolean().default(false).describe("Flag indicating if this participant is the anchor/initiator of the session (true for session starter, false for joining participants)"),
+    nativeLanguage: zod_1.z.string().min(2).max(5).describe("ISO 639-1 language code of the participant's native spoken language (2-5 characters, e.g., 'en', 'en-US', 'es-MX') used for translation direction"),
+    participantAccessId: zod_1.z.number().describe("Unique numeric identifier for the participant used for WebRTC connection authentication and audio stream routing"),
+    participantToken: zod_1.z.string().describe("Authentication token for the participant's WebRTC connection, short-lived credential for secure session access (expires after session)"),
+    transcriptions: zod_1.z.array(exports.TranslationMessageSchema).optional().describe("Array of translation messages where this participant is either the speaker or target, populated for participant-specific message history views"),
+    participantTranscribedLogs: zod_1.z.array(conversation_config_schema_1.ConversationMessageSchema).optional().describe("Array of full conversation messages for this participant including both original and translated content for comprehensive audit logs and quality review")
+});
+/**
+ * Schema for creating a new translation participant.
+ * Omits auto-generated fields.
+ */
+exports.CreateTranslationParticipantSchema = exports.TranslationParticipantSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating an existing translation participant.
+ * All fields are optional except id.
+ */
+exports.UpdateTranslationParticipantSchema = exports.CreateTranslationParticipantSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});
+/**
+ * Translation service log schema.
+ *
+ * Complete record of a translation session including participant information, session metadata, message
+ * history, and operational status. Primary entity for managing and tracking real-time translation services
+ * across organizations and projects.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Extends**: BaseModelSchema with translation session-specific fields
+ * - **Relationship to Participants**: 1:N - One session has multiple participants
+ * - **Relationship to Messages**: 1:N - One session contains multiple translation messages
+ * - **Scoped To**: Organization and optionally Project for multi-tenant isolation
+ *
+ * **Translation Directions:**
+ * - **BIDIRECTIONAL**: Both participants receive translations (A→B and B→A simultaneously)
+ * - **UNIDIRECTIONAL**: Only one direction of translation (e.g., customer to agent only)
+ *
+ * **Session Lifecycle:**
+ * - **ACTIVE**: Translation session in progress with real-time audio streaming
+ * - **COMPLETED**: Session successfully concluded, participants disconnected
+ * - **FAILED**: Session encountered errors (connection lost, processing failures)
+ * - **ABANDONED**: Session abandoned by participants before completion
+ *
+ * **Message Logging:**
+ * - transcribedConversationLog: Central message array for session-level history
+ * - logTranscriptionInParticipantRecords: Controls whether messages also stored per-participant
+ * - Enables both session-wide and participant-specific message retrieval
+ *
+ * **Use Cases:**
+ * - Multilingual customer support call tracking
+ * - International business meeting transcripts
+ * - Cross-border service interaction logs
+ * - Quality assurance and compliance auditing
+ */
+exports.TranslationServiceLogSchema = base_schema_1.BaseModelSchema.safeExtend({
+    organization_id: zod_1.z.string().describe("ID of the organization requesting the translation service for multi-tenant isolation, billing attribution, and access control"),
+    project_id: zod_1.z.string().optional().describe("Optional ID of the project associated with the translation service for organizational grouping, reporting, and project-specific analytics (references Project)"),
+    partner_initiator_id: zod_1.z.string().describe("Unique identifier for the initiator participant from external partner systems for cross-platform tracking and CRM integration"),
+    partner_session_id: zod_1.z.string().optional().describe("Optional external session ID for tracking the translation session in partner systems, enables correlation with external call/meeting records"),
+    sdrtn_id: zod_1.z.string().optional().describe("SDRTN (Session Description and Real-Time Networking) identifier for WebRTC connections enabling low-latency peer-to-peer audio streaming between participants"),
+    translationConfigId: zod_1.z.string().optional().nullable().describe("ID of the translation configuration chain to use for this service including STT, translation LLM, and TTS models (references ProvisioningConfigChain with isTranslation=true)"),
+    participants: zod_1.z.array(zod_1.z.string()).optional().describe("Array of participant IDs involved in this translation session (references TranslationParticipant records, typically 2 for standard sessions, more for conference scenarios)"),
+    durationInSeconds: zod_1.z.number().nonnegative().optional().default(60).describe("Duration of the translation session in seconds for billing calculations, analytics reporting, and session quality metrics (default: 60 for minimum billing)"),
+    status: zod_1.z.enum(type_definitions_1.ConversationStatus).default(type_definitions_1.ConversationStatus.ACTIVE).describe("Current operational status of the translation session (ACTIVE: in progress, COMPLETED: concluded, FAILED: errors, ABANDONED: participants disconnected prematurely)"),
+    direction: zod_1.z.enum(type_definitions_1.TranslationDirection).default(type_definitions_1.TranslationDirection.BIDIRECTIONAL).describe("Translation direction mode (BIDIRECTIONAL: both participants receive translations simultaneously, UNIDIRECTIONAL: one-way translation only for specific use cases)"),
+    transcribedConversationLog: zod_1.z.array(exports.TranslationMessageSchema).optional().describe("Array of translation messages capturing the complete conversation history with original and translated text for both participants, used for session playback and audit"),
+    logTranscriptionInParticipantRecords: zod_1.z.boolean().default(false).describe("Flag controlling whether translation messages are also stored in individual participant records (true for participant-specific history, false for session-only storage to reduce duplication)"),
+    translationSummary: zod_1.z.string().optional().describe("Optional AI-generated summary of the translation session including key discussion points, outcomes, and quality assessment for reporting and analytics"),
+    created_day: zod_1.z.string().optional().describe("The day the translation session was created in YYYY-MM-DD ISO format for daily aggregation queries, analytics partitioning, and billing period grouping"),
+});
+/**
+ * Schema for creating a new translation service log.
+ * Omits auto-generated fields.
+ */
+exports.CreateTranslationServiceLogSchema = exports.TranslationServiceLogSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating an existing translation service log.
+ * All fields are optional except id.
+ */
+exports.UpdateTranslationServiceLogSchema = exports.CreateTranslationServiceLogSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});

package/dist/core/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @fileoverview Central export point for all core schemas and utilities.
+ * @module core
+ */
+export * from './base.schema';
+export * from './account';
+export * from './assistant-setups';
+export * from './business-mgt';
+export * from './conversation';
+export * from './service-configuration';
+export * from './type-definitions';
+export * from './validators';

package/dist/core/index.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * @fileoverview Central export point for all core schemas and utilities.
+ * @module core
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Base schemas
+__exportStar(require("./base.schema"), exports);
+// Module exports
+__exportStar(require("./account"), exports);
+__exportStar(require("./assistant-setups"), exports);
+__exportStar(require("./business-mgt"), exports);
+__exportStar(require("./conversation"), exports);
+__exportStar(require("./service-configuration"), exports);
+__exportStar(require("./type-definitions"), exports);
+__exportStar(require("./validators"), exports);

package/dist/core/service-configuration/agent-config.schema.d.ts

@@ -0,0 +1,236 @@
+import { z } from "zod";
+import { AssistantType, LLMType } from "../type-definitions/service-config.definitions";
+/**
+ * @fileoverview Agent configuration schema definitions.
+ *
+ * Agent Configurations define the core behavior, capabilities, and personality of AI agents.
+ * They reference LLM models and instruction configurations, and can be reused across multiple
+ * deployments. The Instruction Configuration (1:N relationship) governs agent behavior.
+ *
+ * @module service-configuration/agent-config
+ */
+/**
+ * Zod schema for Agent Configuration validation.
+ *
+ * Agent Configurations define the core behavior, capabilities, and personality of AI agents in the
+ * Service Configuration architecture. They are designed to be reusable across multiple deployments,
+ * with each agent governed by an Instruction Configuration (1:N relationship). Multiple Agent
+ * Configurations can share the same Instruction Configuration for consistent behavioral guidelines.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Managed By**: Service Configuration (lifecycle management)
+ * - **Used By**: Deployment Configurations (N:1 - multiple deployments can use the same agent)
+ * - **Associated With**: Instruction Configuration (1:N - one instruction set can govern multiple agents)
+ * - **References**: Wiil Support Model Registry (via modelId)
+ * - **Reusability**: Designed to be reused across multiple deployments with different channels
+ *
+ * **Configuration Layers:**
+ * - **Agent Configuration**: Defines capabilities, model, and operational mode
+ * - **Instruction Configuration**: Defines behavioral guidelines and conversation flow
+ * - Together they create a complete agent persona
+ *
+ * @typedef {Object} AgentConfigurationProperties
+ * @property {string} id - Unique identifier for the agent configuration
+ * @property {string} modelId - Identifier of the LLM model from Wiil Support Registry (e.g., '2323*', 'EYUW&*EU@H$#'). References WiilSupportModel.modelId
+ * @property {string} name - Personal name for the AI agent (max 30 characters) (e.g., 'Sarah', 'James')
+ * @property {LLMType} defaultFunctionState - Default operational mode (TEXT, VOICE, MULTI_MODE) (default: MULTI_MODE)
+ * @property {boolean} [usesWiilSupportModel=true] - Whether this agent uses Wiil's supported model registry
+ * @property {Record<string, any>} [requiredModelConfig] - Additional model parameters (e.g., { voiceId: 'adam', languageId: 'en-US' })
+ * @property {boolean} [useCustomModel=false] - Whether to opt out of platform default model configurations and only use the specified modelId and requiredModelConfig
+ * @property {string|null} [textProcessingModelId] - Specific model ID to use for text processing, if different from the main modelId
+ * @property {string} instructionConfigurationId - ID of the instruction configuration providing behavioral guidelines (N:1)
+ * @property {AssistantType} assistantType - Channel specialization type (GENERAL, WEB, PHONE, etc.) (default: GENERAL)
+ * @property {CallTransferConfig[]} [call_transfer_config=[]] - Call transfer configurations for phone deployments
+ * @property {Record<string, any>} [metadata] - Additional metadata for organization and filtering
+ * @property {WiilSupportModel | null} [model] - Auto-populated model information from registry
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when last updated
+ *
+ * @example
+ * ```typescript
+ * const agentConfig: AgentConfiguration = {
+ *   id: '123*',
+ *   modelId: 'YUSI21217J1',
+ *   name: 'Sarah',
+ *   defaultFunctionState: LLMType.MULTI_MODE,
+ *   usesWiilSupportModel: true,
+ *   instructionConfigurationId: '456*',
+ *   assistantType: AssistantType.PHONE,
+ *   call_transfer_config: [
+ *     {
+ *       transfer_number: '+15551234567',
+ *       transfer_type: 'warm',
+ *       transfer_conditions: ['billing support', 'escalate']
+ *     }
+ *   ],
+ *   metadata: { department: 'support' },
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const AgentConfigurationSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    modelId: z.ZodString;
+    name: z.ZodString;
+    defaultFunctionState: z.ZodDefault<z.ZodEnum<typeof LLMType>>;
+    usesWiilSupportModel: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    requiredModelConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    useCustomModel: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    textProcessingModelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    instructionConfigurationId: z.ZodString;
+    assistantType: z.ZodDefault<z.ZodEnum<typeof AssistantType>>;
+    call_transfer_config: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        transfer_number: z.ZodString;
+        transfer_type: z.ZodDefault<z.ZodEnum<{
+            blind: "blind";
+            warm: "warm";
+        }>>;
+        transfer_conditions: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    model: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        modelId: z.ZodString;
+        proprietor: z.ZodEnum<typeof import("../type-definitions/service-config.definitions").SupportedProprietor>;
+        name: z.ZodString;
+        provider_model_id: z.ZodOptional<z.ZodString>;
+        description: z.ZodString;
+        type: z.ZodEnum<typeof LLMType>;
+        discontinued: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        supportedVoices: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            voiceId: z.ZodString;
+            name: z.ZodString;
+            description: z.ZodString;
+            gender: z.ZodEnum<{
+                neutral: "neutral";
+                male: "male";
+                female: "female";
+            }>;
+            language: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            isDefault: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>>>;
+        supportLanguages: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            languageId: z.ZodString;
+            name: z.ZodString;
+            code: z.ZodString;
+            isDefault: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            isExperimental: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        }, z.core.$strip>>>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Type definition for Agent Configuration.
+ *
+ * Represents a complete agent configuration including all metadata,
+ * model settings, and operational parameters.
+ */
+export type AgentConfiguration = z.infer<typeof AgentConfigurationSchema>;
+/**
+ * Zod schema for creating a new agent configuration.
+ *
+ * Omits auto-generated fields (id, timestamps, model) that are
+ * populated by the system during creation.
+ *
+ * @remarks
+ * This schema enforces required fields for agent creation while excluding
+ * fields that are automatically generated by the database or system.
+ *
+ * @example
+ * ```typescript
+ * const newAgent: CreateAgentConfiguration = {
+ *   modelId: 'gpt-4-turbo',
+ *   name: 'James',
+ *   defaultFunctionState: LLMType.MULTI_MODE,
+ *   usesWiilSupportModel: true,
+ *   instructionConfigurationId: '789*',
+ *   assistantType: AssistantType.WEB,
+ *   requiredModelConfig: {
+ *     voiceId: 'rachel',
+ *     languageId: 'en-US'
+ *   },
+ *   call_transfer_config: [],
+ *   metadata: { team: 'sales' }
+ * };
+ * ```
+ */
+export declare const CreateAgentConfigurationSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    name: z.ZodString;
+    modelId: z.ZodString;
+    defaultFunctionState: z.ZodDefault<z.ZodEnum<typeof LLMType>>;
+    usesWiilSupportModel: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    requiredModelConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    useCustomModel: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    textProcessingModelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    instructionConfigurationId: z.ZodString;
+    assistantType: z.ZodDefault<z.ZodEnum<typeof AssistantType>>;
+    call_transfer_config: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        transfer_number: z.ZodString;
+        transfer_type: z.ZodDefault<z.ZodEnum<{
+            blind: "blind";
+            warm: "warm";
+        }>>;
+        transfer_conditions: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>>;
+}, z.core.$strip>;
+/**
+ * Type definition for creating a new agent configuration.
+ *
+ * Represents the payload required to create a new agent, excluding
+ * system-generated fields.
+ */
+export type CreateAgentConfiguration = z.infer<typeof CreateAgentConfigurationSchema>;
+/**
+ * Zod schema for updating an existing agent configuration.
+ *
+ * All fields from CreateAgentConfigurationSchema are optional (partial),
+ * with the id field required to identify the configuration to update.
+ *
+ * @remarks
+ * Supports partial updates - only include the fields you want to modify.
+ * The id field is mandatory to specify which agent configuration to update.
+ *
+ * @example
+ * ```typescript
+ * const updatePayload: UpdateAgentConfiguration = {
+ *   id: '123*',
+ *   name: 'Alex',
+ *   metadata: { team: 'enterprise-sales' }
+ * };
+ * ```
+ */
+export declare const UpdateAgentConfigurationSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    name: z.ZodOptional<z.ZodString>;
+    modelId: z.ZodOptional<z.ZodString>;
+    defaultFunctionState: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof LLMType>>>;
+    usesWiilSupportModel: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    requiredModelConfig: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    useCustomModel: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    textProcessingModelId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    instructionConfigurationId: z.ZodOptional<z.ZodString>;
+    assistantType: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof AssistantType>>>;
+    call_transfer_config: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        transfer_number: z.ZodString;
+        transfer_type: z.ZodDefault<z.ZodEnum<{
+            blind: "blind";
+            warm: "warm";
+        }>>;
+        transfer_conditions: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Type definition for updating an existing agent configuration.
+ *
+ * Represents a partial update payload with required id field.
+ */
+export type UpdateAgentConfiguration = z.infer<typeof UpdateAgentConfigurationSchema>;
+export declare const AgentConfigurationDeleteRequestSchema: z.ZodObject<{
+    id: z.ZodString;
+    deletePhoneConfig: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type AgentConfigurationDeleteRequest = z.infer<typeof AgentConfigurationDeleteRequestSchema>;

package/dist/core/service-configuration/agent-config.schema.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentConfigurationDeleteRequestSchema = exports.UpdateAgentConfigurationSchema = exports.CreateAgentConfigurationSchema = exports.AgentConfigurationSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const support_llm_1 = require("./support-llm");
+const service_config_definitions_1 = require("../type-definitions/service-config.definitions");
+const call_transfer_config_schema_1 = require("./call-transfer-config.schema");
+/**
+ * @fileoverview Agent configuration schema definitions.
+ *
+ * Agent Configurations define the core behavior, capabilities, and personality of AI agents.
+ * They reference LLM models and instruction configurations, and can be reused across multiple
+ * deployments. The Instruction Configuration (1:N relationship) governs agent behavior.
+ *
+ * @module service-configuration/agent-config
+ */
+/**
+ * Zod schema for Agent Configuration validation.
+ *
+ * Agent Configurations define the core behavior, capabilities, and personality of AI agents in the
+ * Service Configuration architecture. They are designed to be reusable across multiple deployments,
+ * with each agent governed by an Instruction Configuration (1:N relationship). Multiple Agent
+ * Configurations can share the same Instruction Configuration for consistent behavioral guidelines.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Managed By**: Service Configuration (lifecycle management)
+ * - **Used By**: Deployment Configurations (N:1 - multiple deployments can use the same agent)
+ * - **Associated With**: Instruction Configuration (1:N - one instruction set can govern multiple agents)
+ * - **References**: Wiil Support Model Registry (via modelId)
+ * - **Reusability**: Designed to be reused across multiple deployments with different channels
+ *
+ * **Configuration Layers:**
+ * - **Agent Configuration**: Defines capabilities, model, and operational mode
+ * - **Instruction Configuration**: Defines behavioral guidelines and conversation flow
+ * - Together they create a complete agent persona
+ *
+ * @typedef {Object} AgentConfigurationProperties
+ * @property {string} id - Unique identifier for the agent configuration
+ * @property {string} modelId - Identifier of the LLM model from Wiil Support Registry (e.g., '2323*', 'EYUW&*EU@H$#'). References WiilSupportModel.modelId
+ * @property {string} name - Personal name for the AI agent (max 30 characters) (e.g., 'Sarah', 'James')
+ * @property {LLMType} defaultFunctionState - Default operational mode (TEXT, VOICE, MULTI_MODE) (default: MULTI_MODE)
+ * @property {boolean} [usesWiilSupportModel=true] - Whether this agent uses Wiil's supported model registry
+ * @property {Record<string, any>} [requiredModelConfig] - Additional model parameters (e.g., { voiceId: 'adam', languageId: 'en-US' })
+ * @property {boolean} [useCustomModel=false] - Whether to opt out of platform default model configurations and only use the specified modelId and requiredModelConfig
+ * @property {string|null} [textProcessingModelId] - Specific model ID to use for text processing, if different from the main modelId
+ * @property {string} instructionConfigurationId - ID of the instruction configuration providing behavioral guidelines (N:1)
+ * @property {AssistantType} assistantType - Channel specialization type (GENERAL, WEB, PHONE, etc.) (default: GENERAL)
+ * @property {CallTransferConfig[]} [call_transfer_config=[]] - Call transfer configurations for phone deployments
+ * @property {Record<string, any>} [metadata] - Additional metadata for organization and filtering
+ * @property {WiilSupportModel | null} [model] - Auto-populated model information from registry
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when last updated
+ *
+ * @example
+ * ```typescript
+ * const agentConfig: AgentConfiguration = {
+ *   id: '123*',
+ *   modelId: 'YUSI21217J1',
+ *   name: 'Sarah',
+ *   defaultFunctionState: LLMType.MULTI_MODE,
+ *   usesWiilSupportModel: true,
+ *   instructionConfigurationId: '456*',
+ *   assistantType: AssistantType.PHONE,
+ *   call_transfer_config: [
+ *     {
+ *       transfer_number: '+15551234567',
+ *       transfer_type: 'warm',
+ *       transfer_conditions: ['billing support', 'escalate']
+ *     }
+ *   ],
+ *   metadata: { department: 'support' },
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+exports.AgentConfigurationSchema = base_schema_1.BaseModelSchema.safeExtend({
+    modelId: zod_1.z.string().describe("Identifier of the LLM model from Wiil Support Registry to power this agent (e.g., 'YUSI21217J1', 'EYUW&*EU@H$#'). References WiilSupportModel.modelId"),
+    name: zod_1.z.string().max(30).describe("Personal name for the AI agent used in conversations (e.g., 'Sarah', 'James', 'Alex')"),
+    defaultFunctionState: zod_1.z.enum(service_config_definitions_1.LLMType).default(service_config_definitions_1.LLMType.MULTI_MODE).describe("Default operational mode (TEXT for text-only, VOICE for speech, MULTI_MODE for combined text/voice capabilities)"),
+    usesWiilSupportModel: zod_1.z.boolean().optional().default(true).describe("Whether this agent uses a model from Wiil's curated registry (true) or a custom external model (false)"),
+    requiredModelConfig: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Model-specific configuration parameters as key-value pairs (e.g., { voiceId: 'adam', languageId: 'en-US', temperature: 0.7 })"),
+    useCustomModel: zod_1.z.boolean().optional().default(false).describe("Whether to opt out of platform default model configurations and only use the specified modelId and requiredModelConfig"),
+    textProcessingModelId: zod_1.z.string().nullable().optional().describe("Specific model ID to use for text processing, if different from the main modelId"),
+    instructionConfigurationId: zod_1.z.string().describe("ID of the Instruction Configuration providing behavioral guidelines and conversation patterns. Multiple agents can share the same instruction configuration (N:1)"),
+    assistantType: zod_1.z.enum(service_config_definitions_1.AssistantType).default(service_config_definitions_1.AssistantType.GENERAL).describe("Channel specialization type for optimization (GENERAL for multi-channel, WEB for browser, PHONE for telephony, EMAIL for email)"),
+    call_transfer_config: zod_1.z.array(call_transfer_config_schema_1.CallTransferConfigSchema).optional().default([]).describe("Array of call transfer configurations for phone deployments, defining transfer destinations and conditions for escalation"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional metadata for organization including tags, categories, department, or custom attributes for filtering and reporting"),
+    model: support_llm_1.WiilSupportModelSchema.nullable().optional().describe("Complete model information auto-populated from Wiil registry (includes provider, voices, languages). Null if not loaded or custom model"),
+});
+/**
+ * Zod schema for creating a new agent configuration.
+ *
+ * Omits auto-generated fields (id, timestamps, model) that are
+ * populated by the system during creation.
+ *
+ * @remarks
+ * This schema enforces required fields for agent creation while excluding
+ * fields that are automatically generated by the database or system.
+ *
+ * @example
+ * ```typescript
+ * const newAgent: CreateAgentConfiguration = {
+ *   modelId: 'gpt-4-turbo',
+ *   name: 'James',
+ *   defaultFunctionState: LLMType.MULTI_MODE,
+ *   usesWiilSupportModel: true,
+ *   instructionConfigurationId: '789*',
+ *   assistantType: AssistantType.WEB,
+ *   requiredModelConfig: {
+ *     voiceId: 'rachel',
+ *     languageId: 'en-US'
+ *   },
+ *   call_transfer_config: [],
+ *   metadata: { team: 'sales' }
+ * };
+ * ```
+ */
+exports.CreateAgentConfigurationSchema = exports.AgentConfigurationSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+    model: true,
+});
+/**
+ * Zod schema for updating an existing agent configuration.
+ *
+ * All fields from CreateAgentConfigurationSchema are optional (partial),
+ * with the id field required to identify the configuration to update.
+ *
+ * @remarks
+ * Supports partial updates - only include the fields you want to modify.
+ * The id field is mandatory to specify which agent configuration to update.
+ *
+ * @example
+ * ```typescript
+ * const updatePayload: UpdateAgentConfiguration = {
+ *   id: '123*',
+ *   name: 'Alex',
+ *   metadata: { team: 'enterprise-sales' }
+ * };
+ * ```
+ */
+exports.UpdateAgentConfigurationSchema = exports.CreateAgentConfigurationSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});
+exports.AgentConfigurationDeleteRequestSchema = zod_1.z.object({
+    id: zod_1.z.string().describe("Unique identifier of the agent configuration to delete"),
+    deletePhoneConfig: zod_1.z.boolean().optional().default(true).describe("Whether to also delete associated phone configurations"),
+});