wiil-core-js 0.0.82

package/dist/core/service-configuration/dynamic_setup/phone-agent-setup.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateDynamicPhoneAgentSchema = exports.DynamicPhoneAgentSetupResultSchema = exports.DynamicPhoneAgentSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_agent_setup_1 = require("../base-agent-setup");
+/**
+ * @fileoverview Phone agent setup schemas for AI assistant configuration.
+ * @module service-configuration/dynamic_setup/phone-agent-setup
+ *
+ * Provides schemas for configuring AI assistants deployed on phone/telephony channels.
+ * Extends the base agent setup with phone-specific settings like phone configuration,
+ * test numbers, and required voice interaction configurations (STT/TTS).
+ */
+/**
+ * Phone agent setup schema.
+ *
+ * @typedef {Object} DynamicPhoneAgentSetup
+ * @property {string} [phoneConfigurationId] - ID of the phone configuration
+ * @property {string} [testPhoneNumber] - Phone number for testing
+ * @property {Object} [sttConfiguration] - Speech-to-text configuration (required for voice)
+ * @property {Object} [ttsConfiguration] - Text-to-speech configuration (required for voice)
+ */
+exports.DynamicPhoneAgentSchema = base_agent_setup_1.DynamicBaseAgentSetupSchema.safeExtend({
+    phoneConfigurationId: zod_1.default.string().nullable().optional().describe("ID of the phone configuration to use for this assistant, defining telephony settings and integrations"),
+    testPhoneNumber: zod_1.default.string().nullable().optional().describe("Optional phone number to use for testing the phone assistant setup, if applicable"),
+    sttConfiguration: base_agent_setup_1.DynamicSTTModelConfigurationSchema.nullable().optional().describe("Speech-to-text model configuration for the phone assistant, if using voice interactions"),
+    ttsConfiguration: base_agent_setup_1.DynamicTTSModelConfigurationSchema.nullable().optional().describe("Text-to-speech model configuration for the phone assistant, if using voice interactions"),
+}).refine((data) => {
+    const hasSTT = data.sttConfiguration !== null && data.sttConfiguration !== undefined;
+    const hasTTS = data.ttsConfiguration !== null && data.ttsConfiguration !== undefined;
+    return hasSTT === hasTTS;
+}, { message: "Both sttConfiguration and ttsConfiguration must be provided together, or neither" }).describe("Schema for setting up a phone AI assistant with optional chain configuration capabilities");
+/**
+ * Phone agent setup result schema.
+ *
+ * @typedef {Object} DynamicPhoneAgentSetupResult
+ * @property {boolean} success - Whether the setup was successful
+ * @property {string} agentConfigurationId - ID of the created agent configuration
+ * @property {string} instructionConfigurationId - ID of the created instruction configuration
+ * @property {string} phoneNumber - Phone number associated with the configuration
+ */
+exports.DynamicPhoneAgentSetupResultSchema = base_agent_setup_1.DynamicAgentSetupResultSchema.safeExtend({
+    phoneNumber: zod_1.default.string().nullable().optional().describe("Phone number associated with the phone configuration used for this assistant"),
+}).describe("Schema for the result of creating or setting up a new phone AI assistant with dynamic setup");
+/**
+ * Schema for updating an existing phone agent configuration.
+ * All fields are optional except id.
+ */
+exports.UpdateDynamicPhoneAgentSchema = exports.DynamicPhoneAgentSchema.partial().extend({
+    id: zod_1.default.string().describe("ID of the existing phone agent configuration to update"),
+}).omit({
+    phoneConfigurationId: true, // Phone configuration cannot be changed after creation 
+}).describe("Schema for updating a phone AI assistant configuration, allowing partial updates to phone-specific fields");

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

@@ -0,0 +1,113 @@
+import z from "zod";
+import { OttCommunicationType } from "../../type-definitions";
+/**
+ * @fileoverview Web agent setup schemas for AI assistant configuration.
+ * @module service-configuration/dynamic_setup/web-agent-setup
+ *
+ * Provides schemas for configuring AI assistants deployed on web channels.
+ * Extends the base agent setup with web-specific settings like website URL,
+ * communication type, and optional voice interaction configurations.
+ */
+/**
+ * Web agent setup schema.
+ *
+ * @typedef {Object} DynamicWebAgentSetup
+ * @property {string} websiteUrl - URL of the website for this assistant
+ * @property {OttCommunicationType} [communicationType] - Communication method (text, voice, unified)
+ * @property {Object} [sttConfiguration] - Speech-to-text configuration for voice
+ * @property {Object} [ttsConfiguration] - Text-to-speech configuration for voice
+ */
+export declare const DynamicWebAgentSchema: z.ZodObject<{
+    assistantName: z.ZodString;
+    instructionConfigurationId: z.ZodOptional<z.ZodString>;
+    role_template_identifier: z.ZodOptional<z.ZodEnum<typeof import("../../type-definitions").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 import("../../type-definitions").SupportedProprietor>>>;
+    providerModelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    websiteUrl: z.ZodString;
+    communicationType: z.ZodDefault<z.ZodOptional<z.ZodEnum<typeof OttCommunicationType>>>;
+    sttConfiguration: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        providerType: z.ZodEnum<typeof import("../../type-definitions").SupportedProprietor>;
+        providerModelId: z.ZodString;
+        languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>;
+    ttsConfiguration: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        providerType: z.ZodEnum<typeof import("../../type-definitions").SupportedProprietor>;
+        providerModelId: z.ZodString;
+        languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        voiceId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Web agent setup result schema.
+ *
+ * @typedef {Object} DynamicWebAgentSetupResult
+ * @property {boolean} success - Whether the setup was successful
+ * @property {string} agentConfigurationId - ID of the created agent configuration
+ * @property {string} instructionConfigurationId - ID of the created instruction configuration
+ * @property {string[]} integrationSnippets - Code snippets for deploying the web assistant
+ */
+export declare const DynamicWebAgentSetupResultSchema: 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>>>;
+    integrationSnippets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing web agent configuration.
+ * All fields are optional except id.
+ */
+export declare const UpdateDynamicWebAgentSchema: z.ZodObject<{
+    assistantName: z.ZodOptional<z.ZodString>;
+    instructionConfigurationId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    role_template_identifier: z.ZodOptional<z.ZodOptional<z.ZodEnum<typeof import("../../type-definitions").AgentRoleTemplateIdentifier>>>;
+    capabilities: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<typeof import("../../type-definitions").BusinessSupportServices>>>>>;
+    knowledgeSourceIds: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    textKnowledgeSource: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        content: z.ZodString;
+    }, z.core.$strip>>>;
+    language: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+    voice: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    providerType: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof import("../../type-definitions").SupportedProprietor>>>>;
+    providerModelId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    websiteUrl: z.ZodOptional<z.ZodString>;
+    communicationType: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodEnum<typeof OttCommunicationType>>>>;
+    sttConfiguration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        providerType: z.ZodEnum<typeof import("../../type-definitions").SupportedProprietor>;
+        providerModelId: z.ZodString;
+        languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>>;
+    ttsConfiguration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        providerType: z.ZodEnum<typeof import("../../type-definitions").SupportedProprietor>;
+        providerModelId: z.ZodString;
+        languageId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        voiceId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type DynamicWebAgentSetup = z.infer<typeof DynamicWebAgentSchema>;
+export type UpdateDynamicWebAgent = z.infer<typeof UpdateDynamicWebAgentSchema>;
+export type DynamicWebAgentSetupResult = z.infer<typeof DynamicWebAgentSetupResultSchema>;

package/dist/core/service-configuration/dynamic_setup/web-agent-setup.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateDynamicWebAgentSchema = exports.DynamicWebAgentSetupResultSchema = exports.DynamicWebAgentSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_agent_setup_1 = require("../base-agent-setup");
+const type_definitions_1 = require("../../type-definitions");
+/**
+ * @fileoverview Web agent setup schemas for AI assistant configuration.
+ * @module service-configuration/dynamic_setup/web-agent-setup
+ *
+ * Provides schemas for configuring AI assistants deployed on web channels.
+ * Extends the base agent setup with web-specific settings like website URL,
+ * communication type, and optional voice interaction configurations.
+ */
+/**
+ * Web agent setup schema.
+ *
+ * @typedef {Object} DynamicWebAgentSetup
+ * @property {string} websiteUrl - URL of the website for this assistant
+ * @property {OttCommunicationType} [communicationType] - Communication method (text, voice, unified)
+ * @property {Object} [sttConfiguration] - Speech-to-text configuration for voice
+ * @property {Object} [ttsConfiguration] - Text-to-speech configuration for voice
+ */
+exports.DynamicWebAgentSchema = base_agent_setup_1.DynamicBaseAgentSetupSchema.safeExtend({
+    websiteUrl: zod_1.default.string().describe("URL of the website to use for this assistant, defining web-specific settings and integrations"),
+    communicationType: zod_1.default.enum(type_definitions_1.OttCommunicationType).optional().default(type_definitions_1.OttCommunicationType.UNIFIED).describe("Type of over-the-top communication method for the web channel. options: text, voice, unified"),
+    sttConfiguration: base_agent_setup_1.DynamicSTTModelConfigurationSchema.nullable().optional().describe("Speech-to-text model configuration for the web assistant, if using voice interactions"),
+    ttsConfiguration: base_agent_setup_1.DynamicTTSModelConfigurationSchema.nullable().optional().describe("Text-to-speech model configuration for the web assistant, if using voice interactions"),
+}).refine((data) => {
+    const hasSTT = data.sttConfiguration !== null && data.sttConfiguration !== undefined;
+    const hasTTS = data.ttsConfiguration !== null && data.ttsConfiguration !== undefined;
+    return hasSTT === hasTTS;
+}, { message: "Both sttConfiguration and ttsConfiguration must be provided together, or neither" }).describe("Schema for setting up a web AI assistant with optional chain configuration capabilities");
+/**
+ * Web agent setup result schema.
+ *
+ * @typedef {Object} DynamicWebAgentSetupResult
+ * @property {boolean} success - Whether the setup was successful
+ * @property {string} agentConfigurationId - ID of the created agent configuration
+ * @property {string} instructionConfigurationId - ID of the created instruction configuration
+ * @property {string[]} integrationSnippets - Code snippets for deploying the web assistant
+ */
+exports.DynamicWebAgentSetupResultSchema = base_agent_setup_1.DynamicAgentSetupResultSchema.safeExtend({
+    integrationSnippets: zod_1.default.array(zod_1.default.string()).nullable().optional().describe("List of code snippets or integration details for deploying the web assistant on the specified website, if applicable"),
+}).describe("Schema for the result of creating or setting up a new web AI assistant with dynamic setup");
+/**
+ * Schema for updating an existing web agent configuration.
+ * All fields are optional except id.
+ */
+exports.UpdateDynamicWebAgentSchema = exports.DynamicWebAgentSchema.partial().extend({
+    id: zod_1.default.string().describe("ID of the existing web agent configuration to update"),
+}).describe("Schema for updating a web AI assistant configuration, allowing partial updates to web-specific fields");

package/dist/core/service-configuration/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @fileoverview Central export point for all service configuration schemas.
+ * @module service-configuration
+ */
+export * from './agent-config.schema';
+export * from './base-agent-setup';
+export * from './call-transfer-config.schema';
+export * from './deployment-config.schema';
+export * from './instruction-config.schema';
+export * from './interaction-channels.schema';
+export * from './knowledge.schema';
+export * from './phone-config.schema';
+export * from './phone-number.schema';
+export * from './provisioning-config';
+export * from './support-llm';
+export * from './voice-language.schema';
+export * from './dynamic_setup';

package/dist/core/service-configuration/index.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * @fileoverview Central export point for all service configuration schemas.
+ * @module service-configuration
+ */
+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 });
+__exportStar(require("./agent-config.schema"), exports);
+__exportStar(require("./base-agent-setup"), exports);
+__exportStar(require("./call-transfer-config.schema"), exports);
+__exportStar(require("./deployment-config.schema"), exports);
+__exportStar(require("./instruction-config.schema"), exports);
+__exportStar(require("./interaction-channels.schema"), exports);
+__exportStar(require("./knowledge.schema"), exports);
+__exportStar(require("./phone-config.schema"), exports);
+__exportStar(require("./phone-number.schema"), exports);
+__exportStar(require("./provisioning-config"), exports);
+__exportStar(require("./support-llm"), exports);
+__exportStar(require("./voice-language.schema"), exports);
+__exportStar(require("./dynamic_setup"), exports);

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

@@ -0,0 +1,183 @@
+import { z } from "zod";
+import { BusinessSupportServices } from "../type-definitions/account-definitions";
+/**
+ * @fileoverview Instruction configuration schema definitions.
+ *
+ * The Instruction Configuration is the heart of agent behaviour in the Service Configuration architecture.
+ * It contains the prompts, guidelines, and contextual instructions that fundamentally define how agents
+ * operate during conversations.
+ *
+ * @module service-configuration/instruction-config
+ */
+/**
+ * Zod schema for Instruction Configuration validation.
+ *
+ * The Instruction Configuration is the heart of agent behaviour in the Service Configuration architecture.
+ * It contains the prompts, guidelines, and contextual instructions that fundamentally define how an agent
+ * operates during conversations. A single Instruction Configuration can be associated with multiple Agent
+ * Configurations (1:N relationship), allowing consistent behavioral guidelines across different agent types.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Central Role**: The Instruction Configuration is the core element that shapes agent behavior
+ * - **Relationship**: 1:N with Agent Configurations - one instruction set can govern multiple agents
+ * - **Reusability**: Designed to be reused across multiple deployments
+ * - **Managed By**: Service Configuration (lifecycle management)
+ * - **Used By**: Deployment Configurations reference instruction sets for agent behavior
+ *
+ * **Example Use Case:**
+ * A "Customer Service Guidelines" instruction set might govern both a "Sales Agent" and a "Support Agent",
+ * ensuring uniform tone and compliance while each agent maintains its specialized capabilities.
+ *
+ * @typedef {Object} InstructionConfigurationProperties
+ * @property {string} id - Unique identifier for the instruction configuration
+ * @property {string} instructionName - System-readable name, typically auto-generated based on role (e.g., 'customer-support-agent')
+ * @property {string} role - The role or persona the agent should adopt (e.g., 'Customer Support Specialist', 'Sales Representative')
+ * @property {string} introductionMessage - Initial greeting message presented to users when starting a conversation
+ * @property {string} instructions - Detailed instructions that guide agent behavior, responses, conversation flow, and decision-making processes
+ * @property {string} guardrails - Safety and behavioral constraints the agent must follow, including compliance rules, forbidden topics, and ethical guidelines
+ * @property {string[]} [requiredSkills] - Specific skills or capabilities required for this instruction set (e.g., 'appointment_booking', 'order_management')
+ * @property {Record<string, any>} [validationRules] - Custom validation rules for input/output processing to ensure response quality and format compliance
+ * @property {string} [serviceId] - ID of the service this instruction configuration is associated with for organizational purposes
+ * @property {BusinessSupportServices[]} [supportedServices=[]] - Platform business services (tools) enabled for this agent, such as appointment management or order processing
+ * @property {string[]} [tools] - Tool identifiers the agent can use with this instruction set for extended capabilities
+ * @property {boolean} [isTemplate=false] - Whether this is a reusable template for creating other instruction configurations
+ * @property {boolean} isPrimary - Whether this is the primary system instruction configuration template used as a baseline
+ * @property {Record<string, any>} [metadata] - Additional metadata for the instruction configuration, such as version info or custom attributes
+ * @property {string[]} [knowledgeSourceIds=[]] - Array of IDs referencing knowledge sources that provide context and information for this instruction set
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when the configuration was created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when the configuration was last updated
+ *
+ * @example
+ * ```typescript
+ * const instructionConfig: InstructionConfiguration = {
+ *   id: '123*',
+ *   instructionName: 'customer-support-agent',
+ *   role: 'Customer Support Specialist',
+ *   introductionMessage: 'Hello! How can I help you today?',
+ *   instructions: 'You are a helpful customer support agent...',
+ *   guardrails: 'Never share sensitive customer data...',
+ *   supportedServices: [BusinessSupportServices.APPOINTMENT_MANAGEMENT],
+ *   knowledgeSourceIds: ['789*'],
+ *   isTemplate: false,
+ *   isPrimary: false,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const InstructionConfigurationSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    instructionName: z.ZodString;
+    role: z.ZodString;
+    introductionMessage: z.ZodString;
+    instructions: z.ZodString;
+    guardrails: z.ZodString;
+    requiredSkills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    validationRules: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    serviceId: z.ZodOptional<z.ZodString>;
+    supportedServices: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<typeof BusinessSupportServices>>>>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isTemplate: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    isPrimary: z.ZodDefault<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    knowledgeSourceIds: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+}, z.core.$strip>;
+/**
+ * Type definition for Instruction Configuration.
+ *
+ * Represents a complete instruction configuration including all metadata,
+ * behavioral guidelines, and knowledge sources.
+ */
+export type InstructionConfiguration = z.infer<typeof InstructionConfigurationSchema>;
+/**
+ * Zod schema for creating a new instruction configuration.
+ *
+ * Omits auto-generated fields (id, timestamps) that are populated by the system.
+ *
+ * @remarks
+ * This schema enforces required fields for instruction creation while excluding
+ * fields that are automatically generated by the system.
+ *
+ * @example
+ * ```typescript
+ * const newInstruction: CreateInstructionConfiguration = {
+ *   instructionName: 'sales-agent',
+ *   role: 'Sales Representative',
+ *   introductionMessage: 'Hi! I can help you find the perfect solution.',
+ *   instructions: 'You are a knowledgeable sales agent...',
+ *   guardrails: 'Always be honest about product capabilities...',
+ *   supportedServices: [BusinessSupportServices.PRODUCT_ORDER_MANAGEMENT],
+ *   knowledgeSourceIds: ['123*'],
+ *   isTemplate: false,
+ *   isPrimary: false
+ * };
+ * ```
+ */
+export declare const CreateInstructionConfigurationSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    knowledgeSourceIds: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    instructionName: z.ZodString;
+    role: z.ZodString;
+    introductionMessage: z.ZodString;
+    instructions: z.ZodString;
+    guardrails: z.ZodString;
+    requiredSkills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    validationRules: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    serviceId: z.ZodOptional<z.ZodString>;
+    supportedServices: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<typeof BusinessSupportServices>>>>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isTemplate: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    isPrimary: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Type definition for creating a new instruction configuration.
+ *
+ * Represents the payload required to create a new instruction configuration,
+ * excluding system-generated fields.
+ */
+export type CreateInstructionConfiguration = z.infer<typeof CreateInstructionConfigurationSchema>;
+/**
+ * Zod schema for updating an existing instruction configuration.
+ *
+ * All fields from CreateInstructionConfigurationSchema 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 instruction configuration to update.
+ *
+ * @example
+ * ```typescript
+ * const updateInstruction: UpdateInstructionConfiguration = {
+ *   id: '123*',
+ *   introductionMessage: 'Hello! How may I assist you today?',
+ *   guardrails: 'Updated safety guidelines...'
+ * };
+ * ```
+ */
+export declare const UpdateInstructionConfigurationSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    knowledgeSourceIds: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>>;
+    instructionName: z.ZodOptional<z.ZodString>;
+    role: z.ZodOptional<z.ZodString>;
+    introductionMessage: z.ZodOptional<z.ZodString>;
+    instructions: z.ZodOptional<z.ZodString>;
+    guardrails: z.ZodOptional<z.ZodString>;
+    requiredSkills: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    validationRules: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    serviceId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    supportedServices: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<typeof BusinessSupportServices>>>>>;
+    tools: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    isTemplate: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    isPrimary: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Type definition for updating an existing instruction configuration.
+ *
+ * Represents a partial update payload with required id field.
+ */
+export type UpdateInstructionConfiguration = z.infer<typeof UpdateInstructionConfigurationSchema>;

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

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateInstructionConfigurationSchema = exports.CreateInstructionConfigurationSchema = exports.InstructionConfigurationSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const account_definitions_1 = require("../type-definitions/account-definitions");
+/**
+ * @fileoverview Instruction configuration schema definitions.
+ *
+ * The Instruction Configuration is the heart of agent behaviour in the Service Configuration architecture.
+ * It contains the prompts, guidelines, and contextual instructions that fundamentally define how agents
+ * operate during conversations.
+ *
+ * @module service-configuration/instruction-config
+ */
+/**
+ * Zod schema for Instruction Configuration validation.
+ *
+ * The Instruction Configuration is the heart of agent behaviour in the Service Configuration architecture.
+ * It contains the prompts, guidelines, and contextual instructions that fundamentally define how an agent
+ * operates during conversations. A single Instruction Configuration can be associated with multiple Agent
+ * Configurations (1:N relationship), allowing consistent behavioral guidelines across different agent types.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Central Role**: The Instruction Configuration is the core element that shapes agent behavior
+ * - **Relationship**: 1:N with Agent Configurations - one instruction set can govern multiple agents
+ * - **Reusability**: Designed to be reused across multiple deployments
+ * - **Managed By**: Service Configuration (lifecycle management)
+ * - **Used By**: Deployment Configurations reference instruction sets for agent behavior
+ *
+ * **Example Use Case:**
+ * A "Customer Service Guidelines" instruction set might govern both a "Sales Agent" and a "Support Agent",
+ * ensuring uniform tone and compliance while each agent maintains its specialized capabilities.
+ *
+ * @typedef {Object} InstructionConfigurationProperties
+ * @property {string} id - Unique identifier for the instruction configuration
+ * @property {string} instructionName - System-readable name, typically auto-generated based on role (e.g., 'customer-support-agent')
+ * @property {string} role - The role or persona the agent should adopt (e.g., 'Customer Support Specialist', 'Sales Representative')
+ * @property {string} introductionMessage - Initial greeting message presented to users when starting a conversation
+ * @property {string} instructions - Detailed instructions that guide agent behavior, responses, conversation flow, and decision-making processes
+ * @property {string} guardrails - Safety and behavioral constraints the agent must follow, including compliance rules, forbidden topics, and ethical guidelines
+ * @property {string[]} [requiredSkills] - Specific skills or capabilities required for this instruction set (e.g., 'appointment_booking', 'order_management')
+ * @property {Record<string, any>} [validationRules] - Custom validation rules for input/output processing to ensure response quality and format compliance
+ * @property {string} [serviceId] - ID of the service this instruction configuration is associated with for organizational purposes
+ * @property {BusinessSupportServices[]} [supportedServices=[]] - Platform business services (tools) enabled for this agent, such as appointment management or order processing
+ * @property {string[]} [tools] - Tool identifiers the agent can use with this instruction set for extended capabilities
+ * @property {boolean} [isTemplate=false] - Whether this is a reusable template for creating other instruction configurations
+ * @property {boolean} isPrimary - Whether this is the primary system instruction configuration template used as a baseline
+ * @property {Record<string, any>} [metadata] - Additional metadata for the instruction configuration, such as version info or custom attributes
+ * @property {string[]} [knowledgeSourceIds=[]] - Array of IDs referencing knowledge sources that provide context and information for this instruction set
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when the configuration was created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when the configuration was last updated
+ *
+ * @example
+ * ```typescript
+ * const instructionConfig: InstructionConfiguration = {
+ *   id: '123*',
+ *   instructionName: 'customer-support-agent',
+ *   role: 'Customer Support Specialist',
+ *   introductionMessage: 'Hello! How can I help you today?',
+ *   instructions: 'You are a helpful customer support agent...',
+ *   guardrails: 'Never share sensitive customer data...',
+ *   supportedServices: [BusinessSupportServices.APPOINTMENT_MANAGEMENT],
+ *   knowledgeSourceIds: ['789*'],
+ *   isTemplate: false,
+ *   isPrimary: false,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+exports.InstructionConfigurationSchema = base_schema_1.BaseModelSchema.safeExtend({
+    instructionName: zod_1.z.string().describe("System-readable name for the instruction configuration, typically auto-generated based on the role (e.g., 'customer-support-agent', 'sales-representative')"),
+    role: zod_1.z.string().describe("The role or persona the agent should adopt during conversations (e.g., 'Customer Support Specialist', 'Sales Representative', 'Technical Advisor')"),
+    introductionMessage: zod_1.z.string().describe("Initial greeting message presented to users when starting a conversation with the agent"),
+    instructions: zod_1.z.string().describe("Detailed instructions that fundamentally define how the agent operates, including behavioral guidelines, conversation flow, response patterns, and decision-making processes"),
+    guardrails: zod_1.z.string().describe("Safety and behavioral constraints the agent must strictly follow, including compliance rules, forbidden topics, ethical guidelines, and escalation criteria"),
+    requiredSkills: zod_1.z.array(zod_1.z.string()).optional().describe("Specific skills or capabilities required for this instruction set (e.g., 'appointment_booking', 'order_management', 'technical_troubleshooting')"),
+    validationRules: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Custom validation rules for input/output processing to ensure response quality, format compliance, and data integrity"),
+    serviceId: zod_1.z.string().optional().describe("ID of the parent service this instruction configuration is associated with for organizational and access control purposes"),
+    supportedServices: zod_1.z.array(zod_1.z.enum(account_definitions_1.BusinessSupportServices)).optional().default([]).describe("Array of platform business services (tools) enabled for this agent, such as appointment management, order processing, or payment handling"),
+    tools: zod_1.z.array(zod_1.z.string()).optional().describe("Array of tool identifiers the agent can use with this instruction set for extended capabilities and integrations"),
+    isTemplate: zod_1.z.boolean().optional().default(false).describe("Whether this instruction configuration is a reusable template that can be used as a baseline for creating other instruction configurations"),
+    isPrimary: zod_1.z.boolean().default(false).describe("Whether this is the primary system instruction configuration template used as the default baseline for new instruction configurations"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional metadata for the instruction configuration, such as version information, tags, custom attributes, or categorization data"),
+    knowledgeSourceIds: zod_1.z.array(zod_1.z.string()).optional().default([]).describe("Array of IDs referencing knowledge sources that provide contextual information, documentation, and domain knowledge for this instruction set (1:N relationship with Knowledge Sources)"),
+});
+/**
+ * Zod schema for creating a new instruction configuration.
+ *
+ * Omits auto-generated fields (id, timestamps) that are populated by the system.
+ *
+ * @remarks
+ * This schema enforces required fields for instruction creation while excluding
+ * fields that are automatically generated by the system.
+ *
+ * @example
+ * ```typescript
+ * const newInstruction: CreateInstructionConfiguration = {
+ *   instructionName: 'sales-agent',
+ *   role: 'Sales Representative',
+ *   introductionMessage: 'Hi! I can help you find the perfect solution.',
+ *   instructions: 'You are a knowledgeable sales agent...',
+ *   guardrails: 'Always be honest about product capabilities...',
+ *   supportedServices: [BusinessSupportServices.PRODUCT_ORDER_MANAGEMENT],
+ *   knowledgeSourceIds: ['123*'],
+ *   isTemplate: false,
+ *   isPrimary: false
+ * };
+ * ```
+ */
+exports.CreateInstructionConfigurationSchema = exports.InstructionConfigurationSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Zod schema for updating an existing instruction configuration.
+ *
+ * All fields from CreateInstructionConfigurationSchema 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 instruction configuration to update.
+ *
+ * @example
+ * ```typescript
+ * const updateInstruction: UpdateInstructionConfiguration = {
+ *   id: '123*',
+ *   introductionMessage: 'Hello! How may I assist you today?',
+ *   guardrails: 'Updated safety guidelines...'
+ * };
+ * ```
+ */
+exports.UpdateInstructionConfigurationSchema = exports.CreateInstructionConfigurationSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});