wiil-core-js 0.0.82

package/dist/core/service-configuration/base-agent-setup.d.ts

@@ -0,0 +1,147 @@
+import z from "zod";
+import { AgentRoleTemplateIdentifier, SupportedProprietor } from "../type-definitions";
+/**
+ * @fileoverview Shared base schemas for dynamic AI assistant setup and model configuration.
+ * @module service-configuration/base-agent-setup
+ *
+ * Provides foundational schemas for configuring AI assistants across different
+ * channels (phone, web) and reusable provider model configuration schemas.
+ */
+/**
+ * Text-based knowledge source schema.
+ * Used to create a new knowledge source from raw text during a web agent update.
+ *
+ * @typedef {Object} TextBasedKnowledgeSource
+ * @property {string|null} [name] - Optional human-readable name for the text knowledge source
+ * @property {string} content - Raw text content to create as a new knowledge source
+ */
+export declare const TextBasedKnowledgeSourceSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    content: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Base agent setup schema.
+ *
+ * @typedef {Object} DynamicBaseAgentSetup
+ * @property {string} assistantName - Name of the AI assistant (max 30 characters)
+ * @property {string} [instructionConfigurationId] - ID of the instruction configuration
+ * @property {AgentRoleTemplateIdentifier} [role_template_identifier] - Role/persona for the agent
+ * @property {AgentCapabilities[]} [capabilities] - List of enabled platform services
+ * @property {string[]} [knowledgeSourceIds] - Knowledge source IDs to associate
+ * @property {TextBasedKnowledgeSource} [textKnowledgeSource] - New text knowledge source to create and associate
+ * @property {string} [language] - Language ID (e.g., en, es, fr)
+ * @property {string} [voice] - Voice ID for voice interactions
+ * @property {SupportedProprietor} [providerType] - AI model provider type
+ * @property {string} [providerModelId] - Specific model ID from the provider
+ */
+export declare const DynamicBaseAgentSetupSchema: z.ZodObject<{
+    assistantName: z.ZodString;
+    instructionConfigurationId: z.ZodOptional<z.ZodString>;
+    role_template_identifier: z.ZodOptional<z.ZodEnum<typeof AgentRoleTemplateIdentifier>>;
+    capabilities: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<typeof import("../type-definitions").BusinessSupportServices>>>>;
+    knowledgeSourceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    textKnowledgeSource: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        content: z.ZodString;
+    }, z.core.$strip>>;
+    language: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    voice: z.ZodOptional<z.ZodString>;
+    providerType: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof SupportedProprietor>>>;
+    providerModelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Model configuration schema.
+ *
+ * @typedef {Object} DynamicModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ */
+export declare const DynamicModelConfigurationSchema: z.ZodObject<{
+    providerType: z.ZodEnum<typeof SupportedProprietor>;
+    providerModelId: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Speech-to-text model configuration schema.
+ *
+ * @typedef {Object} DynamicSTTModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ * @property {string} [languageId] - Language ID for speech recognition
+ */
+export declare const DynamicSTTModelConfigurationSchema: z.ZodObject<{
+    providerType: z.ZodEnum<typeof SupportedProprietor>;
+    providerModelId: z.ZodString;
+    languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Text-to-speech model configuration schema.
+ *
+ * @typedef {Object} DynamicTTSModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ * @property {string} [languageId] - Language ID for speech synthesis
+ * @property {string} [voiceId] - Voice ID for speech output
+ */
+export declare const DynamicTTSModelConfigurationSchema: z.ZodObject<{
+    providerType: z.ZodEnum<typeof SupportedProprietor>;
+    providerModelId: z.ZodString;
+    languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    voiceId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Agent processing state schema for tracking long-running setup operations.
+ *
+ * @typedef {Object} DynamicAgentProcessingState
+ * @property {string} status - Current processing status (pending, in_progress, completed, failed)
+ * @property {number} progressPercentage - Progress percentage (0-100)
+ * @property {string} [message] - Additional details about current state
+ */
+export declare const DynamicAgentProcessingStateSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+        in_progress: "in_progress";
+    }>;
+    progressPercentage: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Agent setup result schema.
+ * Extends BaseModelSchema to include id, createdAt, and updatedAt fields.
+ *
+ * @typedef {Object} DynamicAgentSetupResult
+ * @property {Object} processingState - Real-time processing state for async operations
+ * @property {boolean} [success] - Whether the setup was successful (nullable during processing)
+ * @property {string} [agentConfigurationId] - ID of the created agent configuration
+ * @property {string} [instructionConfigurationId] - ID of the created instruction configuration
+ * @property {string} [errorMessage] - Error message if setup failed
+ * @property {Object} [metadata] - Additional metadata about the setup
+ */
+export declare const DynamicAgentSetupResultSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    processingState: z.ZodObject<{
+        status: z.ZodEnum<{
+            pending: "pending";
+            completed: "completed";
+            failed: "failed";
+            in_progress: "in_progress";
+        }>;
+        progressPercentage: z.ZodNumber;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    success: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    agentConfigurationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    instructionConfigurationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    errorMessage: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+}, z.core.$strip>;
+export type DynamicBaseAgentSetup = z.infer<typeof DynamicBaseAgentSetupSchema>;
+export type DynamicModelConfiguration = z.infer<typeof DynamicModelConfigurationSchema>;
+export type DynamicSTTModelConfiguration = z.infer<typeof DynamicSTTModelConfigurationSchema>;
+export type DynamicTTSModelConfiguration = z.infer<typeof DynamicTTSModelConfigurationSchema>;
+export type DynamicAgentProcessingState = z.infer<typeof DynamicAgentProcessingStateSchema>;
+export type DynamicAgentSetupResult = z.infer<typeof DynamicAgentSetupResultSchema>;
+export type TextBasedKnowledgeSource = z.infer<typeof TextBasedKnowledgeSourceSchema>;

package/dist/core/service-configuration/base-agent-setup.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicAgentSetupResultSchema = exports.DynamicAgentProcessingStateSchema = exports.DynamicTTSModelConfigurationSchema = exports.DynamicSTTModelConfigurationSchema = exports.DynamicModelConfigurationSchema = exports.DynamicBaseAgentSetupSchema = exports.TextBasedKnowledgeSourceSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const type_definitions_1 = require("../type-definitions");
+const base_schema_1 = require("../base.schema");
+/**
+ * @fileoverview Shared base schemas for dynamic AI assistant setup and model configuration.
+ * @module service-configuration/base-agent-setup
+ *
+ * Provides foundational schemas for configuring AI assistants across different
+ * channels (phone, web) and reusable provider model configuration schemas.
+ */
+/**
+ * Text-based knowledge source schema.
+ * Used to create a new knowledge source from raw text during a web agent update.
+ *
+ * @typedef {Object} TextBasedKnowledgeSource
+ * @property {string|null} [name] - Optional human-readable name for the text knowledge source
+ * @property {string} content - Raw text content to create as a new knowledge source
+ */
+exports.TextBasedKnowledgeSourceSchema = zod_1.default.object({
+    name: zod_1.default.string().nullable().optional().describe("Optional human-readable name for the text knowledge source"),
+    content: zod_1.default.string().min(1, "Content is required").describe("Raw text content to create as a new knowledge source"),
+}).describe("Schema for creating a new text knowledge source during a web agent update");
+/**
+ * Base agent setup schema.
+ *
+ * @typedef {Object} DynamicBaseAgentSetup
+ * @property {string} assistantName - Name of the AI assistant (max 30 characters)
+ * @property {string} [instructionConfigurationId] - ID of the instruction configuration
+ * @property {AgentRoleTemplateIdentifier} [role_template_identifier] - Role/persona for the agent
+ * @property {AgentCapabilities[]} [capabilities] - List of enabled platform services
+ * @property {string[]} [knowledgeSourceIds] - Knowledge source IDs to associate
+ * @property {TextBasedKnowledgeSource} [textKnowledgeSource] - New text knowledge source to create and associate
+ * @property {string} [language] - Language ID (e.g., en, es, fr)
+ * @property {string} [voice] - Voice ID for voice interactions
+ * @property {SupportedProprietor} [providerType] - AI model provider type
+ * @property {string} [providerModelId] - Specific model ID from the provider
+ */
+exports.DynamicBaseAgentSetupSchema = zod_1.default.object({
+    assistantName: zod_1.default.string().max(30).describe("Name of the AI assistant to use in conversations"),
+    instructionConfigurationId: zod_1.default.string().optional().describe("ID of the instruction configuration to use for this assistant"),
+    role_template_identifier: zod_1.default.enum(type_definitions_1.AgentRoleTemplateIdentifier).optional().describe("The role or persona that the agent adopts with this instruction set"),
+    capabilities: zod_1.default.array(zod_1.default.enum(type_definitions_1.AgentCapabilities)).optional().default([]).describe("List of platform services (tools) enabled for this agent configuration"),
+    knowledgeSourceIds: zod_1.default.array(zod_1.default.string()).optional().describe("List of knowledge source IDs to associate with this assistant"),
+    textKnowledgeSource: exports.TextBasedKnowledgeSourceSchema.optional().describe("New text knowledge source to create and associate with this web agent"),
+    language: zod_1.default.string().optional().default("en").describe("Language ID for the assistant, e.g., en, es, fr, etc."),
+    voice: zod_1.default.string().optional().describe("Voice ID for the assistant, if applicable, used for voice interactions"),
+    providerType: zod_1.default.enum(type_definitions_1.SupportedProprietor).nullable().optional().describe("The AI model provider type for this agent configuration, e.g., OPENAI, AZURE, etc."),
+    providerModelId: zod_1.default.string().nullable().optional().describe("The specific model ID from the provider to use for this agent, e.g., gpt-4, gpt-3.5-turbo, etc."),
+}).describe("Base schema for setting up an AI assistant, used for both phone and web channels");
+/**
+ * Model configuration schema.
+ *
+ * @typedef {Object} DynamicModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ */
+exports.DynamicModelConfigurationSchema = zod_1.default.object({
+    providerType: zod_1.default.enum(type_definitions_1.SupportedProprietor).describe("The AI model provider type for this agent configuration, e.g., OPENAI, AZURE, etc."),
+    providerModelId: zod_1.default.string().describe("The specific model ID from the provider to use for this agent, e.g., gpt-4, gpt-3.5-turbo, etc."),
+}).describe("Base schema for model configuration");
+/**
+ * Speech-to-text model configuration schema.
+ *
+ * @typedef {Object} DynamicSTTModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ * @property {string} [languageId] - Language ID for speech recognition
+ */
+exports.DynamicSTTModelConfigurationSchema = exports.DynamicModelConfigurationSchema.extend({
+    languageId: zod_1.default.string().optional().default("en").describe("Language ID for the speech-to-text model, e.g., en, es, fr, etc."),
+}).describe("Schema for speech-to-text model configuration, extending the base model configuration with language support");
+/**
+ * Text-to-speech model configuration schema.
+ *
+ * @typedef {Object} DynamicTTSModelConfiguration
+ * @property {SupportedProprietor} providerType - AI model provider type
+ * @property {string} providerModelId - Specific model ID from the provider
+ * @property {string} [languageId] - Language ID for speech synthesis
+ * @property {string} [voiceId] - Voice ID for speech output
+ */
+exports.DynamicTTSModelConfigurationSchema = exports.DynamicModelConfigurationSchema.extend({
+    languageId: zod_1.default.string().optional().default("en").describe("Language ID for the text-to-speech model, e.g., en, es, fr, etc."),
+    voiceId: zod_1.default.string().optional().describe("Voice ID for the text-to-speech model, if applicable"),
+}).describe("Schema for text-to-speech model configuration, extending the base model configuration with language and voice support");
+/**
+ * Agent processing state schema for tracking long-running setup operations.
+ *
+ * @typedef {Object} DynamicAgentProcessingState
+ * @property {string} status - Current processing status (pending, in_progress, completed, failed)
+ * @property {number} progressPercentage - Progress percentage (0-100)
+ * @property {string} [message] - Additional details about current state
+ */
+exports.DynamicAgentProcessingStateSchema = zod_1.default.object({
+    status: zod_1.default.enum(["pending", "in_progress", "completed", "failed"]).describe("Current processing status of the agent setup"),
+    progressPercentage: zod_1.default.number().min(0).max(100).describe("Progress percentage of the agent setup process"),
+    message: zod_1.default.string().optional().describe("Optional message providing additional details about the current processing state"),
+}).describe("Schema for representing the processing state of a dynamic agent setup, useful for tracking long-running setup operations");
+/**
+ * Agent setup result schema.
+ * Extends BaseModelSchema to include id, createdAt, and updatedAt fields.
+ *
+ * @typedef {Object} DynamicAgentSetupResult
+ * @property {Object} processingState - Real-time processing state for async operations
+ * @property {boolean} [success] - Whether the setup was successful (nullable during processing)
+ * @property {string} [agentConfigurationId] - ID of the created agent configuration
+ * @property {string} [instructionConfigurationId] - ID of the created instruction configuration
+ * @property {string} [errorMessage] - Error message if setup failed
+ * @property {Object} [metadata] - Additional metadata about the setup
+ */
+exports.DynamicAgentSetupResultSchema = base_schema_1.BaseModelSchema.safeExtend({
+    processingState: exports.DynamicAgentProcessingStateSchema.describe("Optional field to provide real-time processing state of the agent setup, useful for asynchronous operations"),
+    success: zod_1.default.boolean().nullable().optional().describe("Indicates if the assistant setup was successful"),
+    agentConfigurationId: zod_1.default.string().nullable().optional().describe("ID of the agent configuration created for this assistant"),
+    instructionConfigurationId: zod_1.default.string().nullable().optional().describe("ID of the instruction configuration created for this assistant"),
+    errorMessage: zod_1.default.string().optional().describe("Error message if the setup failed, otherwise undefined"),
+    metadata: zod_1.default.record(zod_1.default.string(), zod_1.default.any()).nullable().optional().describe("Additional metadata about the assistant setup, if any"),
+}).describe("Schema for the result of creating or setting up a new AI assistant with dynamic setup");

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

@@ -0,0 +1,60 @@
+import { z } from "zod";
+/**
+ * @fileoverview Call transfer configuration schema definitions.
+ *
+ * Call transfer configurations enable AI agents to transfer calls to human operators or other
+ * phone numbers based on specific conditions or user requests. Supports both blind (immediate)
+ * and warm (announced) transfer types.
+ *
+ * @module service-configuration/call-transfer-config
+ */
+/**
+ * Zod schema for individual call transfer configuration.
+ *
+ * Defines the structure for configuring call transfers in the telephony system. Call transfer
+ * configurations are used by Agent Configurations to handle escalations and routing scenarios.
+ * Multiple transfer configurations can be defined, each with different conditions and destinations.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: Agent Configuration (call_transfer_config array)
+ * - **Purpose**: Enables agents to escalate or route calls to human operators or specialized teams
+ * - **Transfer Types**:
+ *   - **Blind Transfer**: Immediately transfers the call without announcement
+ *   - **Warm Transfer**: Announces the call to the recipient before connecting the caller
+ *
+ * **Use Cases:**
+ * - Sales inquiries → Transfer to sales team
+ * - Technical support escalation → Transfer to senior technician
+ * - Billing questions → Transfer to billing department
+ * - Emergency situations → Transfer to on-call manager
+ *
+ * @typedef {Object} CallTransferConfigProperties
+ * @property {string} transfer_number - The phone number to transfer calls to in E.164 international format (e.g., '+15551234567')
+ * @property {'blind' | 'warm'} transfer_type - Transfer type: 'blind' for immediate transfer without announcement, 'warm' for announced transfer where recipient can accept or decline (default: 'blind')
+ * @property {string[]} transfer_conditions - Array of natural language conditions or phrases that trigger this transfer (e.g., 'speak to sales', 'talk to manager', 'escalate to human')
+ *
+ * @example
+ * ```typescript
+ * const transferConfig: CallTransferConfig = {
+ *   transfer_number: '+15551234567',
+ *   transfer_type: 'warm',
+ *   transfer_conditions: ['speak to sales', 'talk to manager', 'escalate']
+ * };
+ * ```
+ */
+export declare const CallTransferConfigSchema: 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>;
+/**
+ * Type definition for call transfer configuration.
+ *
+ * Represents a single call transfer rule with target number, transfer method,
+ * and the conditions that trigger the transfer.
+ */
+export type CallTransferConfig = z.infer<typeof CallTransferConfigSchema>;

package/dist/core/service-configuration/call-transfer-config.schema.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallTransferConfigSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * @fileoverview Call transfer configuration schema definitions.
+ *
+ * Call transfer configurations enable AI agents to transfer calls to human operators or other
+ * phone numbers based on specific conditions or user requests. Supports both blind (immediate)
+ * and warm (announced) transfer types.
+ *
+ * @module service-configuration/call-transfer-config
+ */
+/**
+ * Zod schema for individual call transfer configuration.
+ *
+ * Defines the structure for configuring call transfers in the telephony system. Call transfer
+ * configurations are used by Agent Configurations to handle escalations and routing scenarios.
+ * Multiple transfer configurations can be defined, each with different conditions and destinations.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: Agent Configuration (call_transfer_config array)
+ * - **Purpose**: Enables agents to escalate or route calls to human operators or specialized teams
+ * - **Transfer Types**:
+ *   - **Blind Transfer**: Immediately transfers the call without announcement
+ *   - **Warm Transfer**: Announces the call to the recipient before connecting the caller
+ *
+ * **Use Cases:**
+ * - Sales inquiries → Transfer to sales team
+ * - Technical support escalation → Transfer to senior technician
+ * - Billing questions → Transfer to billing department
+ * - Emergency situations → Transfer to on-call manager
+ *
+ * @typedef {Object} CallTransferConfigProperties
+ * @property {string} transfer_number - The phone number to transfer calls to in E.164 international format (e.g., '+15551234567')
+ * @property {'blind' | 'warm'} transfer_type - Transfer type: 'blind' for immediate transfer without announcement, 'warm' for announced transfer where recipient can accept or decline (default: 'blind')
+ * @property {string[]} transfer_conditions - Array of natural language conditions or phrases that trigger this transfer (e.g., 'speak to sales', 'talk to manager', 'escalate to human')
+ *
+ * @example
+ * ```typescript
+ * const transferConfig: CallTransferConfig = {
+ *   transfer_number: '+15551234567',
+ *   transfer_type: 'warm',
+ *   transfer_conditions: ['speak to sales', 'talk to manager', 'escalate']
+ * };
+ * ```
+ */
+exports.CallTransferConfigSchema = zod_1.z.object({
+    transfer_number: zod_1.z.string().describe("Phone number in E.164 international format to transfer calls to (e.g., '+15551234567' for US numbers, '+442071234567' for UK numbers)"),
+    transfer_type: zod_1.z.enum(['blind', 'warm']).default('blind').describe("Type of call transfer: 'blind' for immediate transfer without announcement (faster, no option to decline), 'warm' for announced transfer where the recipient is informed before the caller is connected (professional, allows screening)"),
+    transfer_conditions: zod_1.z.array(zod_1.z.string()).describe("Array of natural language conditions, keywords, or phrases that trigger this call transfer (e.g., 'speak to sales', 'talk to a human', 'escalate to manager', 'billing question'). The agent will match these conditions during conversations to determine when to initiate the transfer.")
+});