@cognigy/rest-api-client 2025.21.0 → 2025.23.0

package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js

@@ -33,35 +33,6 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
             continue;
         }
         const toolId = child.config.toolId;
-        if ((child.type === "aiAgentJobTool" || child.type === "llmPromptTool") &&
-            (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
-            if (!toolId) {
-                throw new Error(`Tool ID is missing in Tool Node configuration.`);
-            }
-            const parsedToolId = yield api.parseCognigyScriptText(toolId);
-            if (!validateToolId(parsedToolId)) {
-                throw new Error(`Tool ID ${parsedToolId} is not valid. Please use only alphanumeric characters, dashes and underscores.`);
-            }
-            if (toolIds.includes(parsedToolId)) {
-                throw new Error(`Tool ID ${parsedToolId} is not unique. Please ensure each tool has a unique id.`);
-            }
-            toolIds.push(parsedToolId);
-            toolNames.push(parsedToolId);
-            const tool = {
-                type: "function",
-                function: {
-                    name: parsedToolId,
-                    description: yield api.parseCognigyScriptText(child.config.description),
-                },
-            };
-            if (useStrict) {
-                tool.function.strict = true;
-            }
-            if (child.config.useParameters) {
-                tool.function.parameters = child.config.parameters;
-            }
-            tools.push(tool);
-        }
         if ((child.type === "aiAgentJobMCPTool" || child.type === "llmPromptMCPTool") &&
             (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
             if (!child.config.mcpServerUrl) {
@@ -74,13 +45,16 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
             const toolFilter = child.config.toolFilter;
             const mcpHeaders = child.config.mcpHeaders;
             let mcpTools = null;
+            let fetchedFromCache = null;
             try {
-                mcpTools = yield api.fetchMcpTools({
+                const fetched = yield api.fetchMcpTools({
                     mcpServerUrl,
                     timeout,
                     cacheTools,
                     mcpHeaders,
                 });
+                mcpTools = fetched.tools;
+                fetchedFromCache = fetched.fromCache;
             }
             catch (error) {
                 const errorDetails = error instanceof Error
@@ -93,11 +67,12 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
             }
             if (mcpTools) {
                 if (sendDebug) {
+                    const sourceLabel = fetchedFromCache ? "from cache" : "from MCP server";
                     if (mcpTools.length === 0) {
-                        (_b = api.logDebugMessage) === null || _b === void 0 ? void 0 : _b.call(api, `No tools fetched from MCP Tool "${child.config.name}".`, "MCP Tool");
+                        (_b = api.logDebugMessage) === null || _b === void 0 ? void 0 : _b.call(api, `No tools fetched from MCP Tool "${child.config.name}" (${sourceLabel}).`, "MCP Tool");
                     }
                     if (mcpTools.length > 0) {
-                        const messageLines = [`Fetched tools from MCP Tool "${child.config.name}"`];
+                        const messageLines = [`Fetched tools from MCP Tool "${child.config.name}" (${sourceLabel})`];
                         mcpTools.forEach((tool) => {
                             messageLines.push(`<br>- <b>${tool.name}</b>: ${tool.description}`);
                             if (child.config.debugMessageParameters && tool.inputSchema) {
@@ -162,6 +137,34 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
                 tools.push(...structuredMcpTools);
             }
         }
+        if (!["llmPromptMCPTool", "aiAgentJobMCPTool"].includes(child.type) && (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
+            if (!toolId) {
+                throw new Error(`Tool ID is missing in Tool Node configuration.`);
+            }
+            const parsedToolId = yield api.parseCognigyScriptText(toolId);
+            if (!validateToolId(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not valid. Please use only alphanumeric characters, dashes and underscores.`);
+            }
+            if (toolIds.includes(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not unique. Please ensure each tool has a unique id.`);
+            }
+            toolIds.push(parsedToolId);
+            toolNames.push(parsedToolId);
+            const tool = {
+                type: "function",
+                function: {
+                    name: parsedToolId,
+                    description: yield api.parseCognigyScriptText(child.config.description),
+                },
+            };
+            if (useStrict) {
+                tool.function.strict = true;
+            }
+            if (child.config.useParameters) {
+                tool.function.parameters = child.config.parameters;
+            }
+            tools.push(tool);
+        }
     }
     ;
     return {

package/dist/esm/shared/charts/descriptors/service/index.js

@@ -28,6 +28,7 @@ export { AI_AGENT_JOB_MCP_TOOL } from "./aiAgent/aiAgentJobMCPTool";
 export { AI_AGENT_TOOL_ANSWER } from "./aiAgent/aiAgentToolAnswer";
 export { AI_AGENT_HANDOVER } from "./aiAgent/aiAgentHandover";
 export { AI_AGENT_JOB_CALL_MCP_TOOL } from "./aiAgent/aiAgentJobCallMCPTool";
+export { KNOWLEDGE_TOOL } from "./agentTools/knowledgeTool";
 export { LOAD_AI_AGENT } from "./aiAgent/loadAiAgent";
 export { LIVE_AGENT_CONNECTION, RINGCENTRAL_ENGAGE_CONNECTION, CHATWOOT_CONNECTION, EIGHT_BY_EIGHT_CONNECTION, GENESYS_CLOUD_CONNECTION, GENESYS_CLOUD_CONNECTION_OM } from "./handoverConnections";
 export { NICECXONEAAH_AUTHENTICATION_CONNECTION } from "./niceCXOneAAHAuthenticationConnection";

package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js

@@ -1,9 +1,10 @@
 import { __awaiter, __rest } from "tslib";
+/* Npm modules */
+import * as crypto from "crypto";
 /* Custom modules */
 import { createNodeDescriptor } from "../../../createNodeDescriptor";
 import { GO_TO } from "../../logic";
 import { createToolDefinitions } from "../aiAgent/helpers/createToolDefinitions";
-import { v4 as randomUUID } from "uuid";
 import { createLastConverationString, createLastUserInputString, writeLLMDebugLogs } from "../../nlu/generativeSlotFiller/prompt";
 import { InternalServerError } from "../../../../errors";
 import { TranscriptEntryType, TranscriptRole } from "../../../../interfaces/transcripts/transcripts";
@@ -15,7 +16,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
         collapsable: true,
         placement: {
             children: {
-                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool"],
+                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool", "knowledgeTool"],
             },
         },
     },
@@ -778,8 +779,8 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
             }
         });
         try {
-            const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = randomUUID();
+            const isStreamingChannel = input.endpointType === "webchat3" || input.channel === "adminconsole";
+            const _messageId = crypto.randomUUID();
             // Start measuring LLM latency and time to first output if debug flag is enabled
             let firstOutputTime = null;
             /**
@@ -842,6 +843,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                     rolesWhiteList: [TranscriptRole.USER, TranscriptRole.ASSISTANT, TranscriptRole.TOOL],
                     excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT],
                     useTextAlternativeForLLM,
+                    excludeUserEventMessages: true,
                 });
                 llmPromptOptions["transcript"] = transcript;
                 llmPromptOptions["chat"] = [{
@@ -887,7 +889,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 // Find the child node with the toolId of the tool call
                 let toolChild = undefined;
                 for (const child of childConfigs) {
-                    if (child.type === "llmPromptTool" && ((_e = child.config) === null || _e === void 0 ? void 0 : _e.toolId) && (yield api.parseCognigyScriptText((_f = child.config) === null || _f === void 0 ? void 0 : _f.toolId)) === mainToolCall.function.name) {
+                    if (!["llmPromptDefault", "llmPromptMCPTool"].includes(child.type) && ((_e = child.config) === null || _e === void 0 ? void 0 : _e.toolId) && (yield api.parseCognigyScriptText((_f = child.config) === null || _f === void 0 ? void 0 : _f.toolId)) === mainToolCall.function.name) {
                         toolChild = child;
                         break;
                     }

package/dist/esm/shared/charts/descriptors/voice/mappers/msTeamsTransfer.mapper.js

@@ -0,0 +1,33 @@
+export const msTeamsTransfer = {
+    handleInput(endpointType, params) {
+        try {
+            return this.handleVGInput(params);
+        }
+        catch (error) {
+            throw Error(error.message);
+        }
+    },
+    handleVGInput(transferParam) {
+        const { transferTarget, callerName, topic, context, callSentiment, suggestedActions, } = transferParam;
+        const payload = {
+            _voiceGateway2: {
+                json: {}
+            }
+        };
+        let headers = {
+            "X-MS-TEAMS-CALLER-NAME": callerName,
+            "X-MS-TEAMS-CALL-TOPIC": topic,
+            "X-MS-TEAMS-CALL-CONTEXT": context,
+            "X-MS-TEAMS-CALL-CALL-SENTIMENT": callSentiment,
+            "X-MS-TEAMS-SUGGESTED-ACTIONS": suggestedActions,
+        };
+        const referVerb = {
+            "referTo": transferTarget,
+            "actionHook": 'refer',
+            headers
+        };
+        payload._voiceGateway2.json["sip:refer"] = referVerb;
+        return payload;
+    },
+};
+//# sourceMappingURL=msTeamsTransfer.mapper.js.map

package/dist/esm/shared/charts/descriptors/voicegateway2/index.js

@@ -5,22 +5,27 @@ import { hangupNode } from "./nodes/hangup";
 import { playNode } from "./nodes/play";
 import { referNode } from "./nodes/refer";
 import { transferNode } from "./nodes/transfer";
+import { msTeamsTransferNode } from "./nodes/msTeamsTransfer";
 import { setSessionConfigNode } from "./nodes/setSessionConfig";
 import { sendMetadataNode } from "./nodes/sendMetadata";
 import { recordNode } from "./nodes/record";
 import { muteSpeechInputNode } from "./nodes/muteSpeechInput";
+const nodes = [
+    setSessionConfigNode,
+    dtmfNode,
+    hangupNode,
+    playNode,
+    referNode,
+    transferNode,
+    sendMetadataNode,
+    recordNode,
+    muteSpeechInputNode,
+];
+if (process.env.FEATURE_DISABLE_MS_TEAMS_TRANSFER_NODE !== "true") {
+    nodes.push(msTeamsTransferNode);
+}
 export const cognigyVoiceGateway2Module = createExtension({
-    nodes: [
-        setSessionConfigNode,
-        dtmfNode,
-        hangupNode,
-        playNode,
-        referNode,
-        transferNode,
-        sendMetadataNode,
-        recordNode,
-        muteSpeechInputNode,
-    ],
+    nodes,
     connections: []
 });
 //# sourceMappingURL=index.js.map

package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/msTeamsTransfer.js

@@ -0,0 +1,124 @@
+import { __awaiter } from "tslib";
+/** Custom Modules */
+import { createNodeDescriptor } from "../../../createNodeDescriptor";
+/** Helper Modules */
+import { msTeamsTransfer } from "../../voice/mappers/msTeamsTransfer.mapper";
+import { nodeColor } from "../utils/design";
+const customHeaderDefaultValue = "X-Custom-Header";
+export const msTeamsTransferNode = createNodeDescriptor({
+    type: "msTeamsTransfer",
+    defaultLabel: "MS Teams Transfer",
+    preview: {
+        key: "transferTarget",
+        type: "text",
+    },
+    appearance: {
+        color: nodeColor,
+    },
+    tags: ["voice"],
+    fields: [
+        {
+            key: "transferTarget",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TARGET__LABEL",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TARGET__DESCRIPTION",
+            defaultValue: "+49123456789",
+        },
+        {
+            key: "callerName",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CALLER_NAME__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CALLER_NAME__DESCRIPTION",
+            defaultValue: "",
+        },
+        {
+            key: "topic",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__TOPIC__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__TOPIC__DESCRIPTION",
+            defaultValue: "",
+        },
+        {
+            key: "context",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CONTEXT__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CONTEXT__DESCRIPTION",
+            defaultValue: "My context",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: "callSentiment",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CALL_SENTIMENT__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__CALL_SENTIMENT__DESCRIPTION",
+            defaultValue: "",
+        },
+        {
+            key: "suggestedActions",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__SUGGESTED_ACTIONS__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__MSTEAMS_TRANSFER__FIELDS__SUGGESTED_ACTIONS__DESCRIPTION",
+            defaultValue: "",
+        },
+    ],
+    form: [
+        {
+            type: "field",
+            key: "transferTarget"
+        },
+        {
+            type: "field",
+            key: "callerName"
+        },
+        {
+            type: "field",
+            key: "topic"
+        },
+        {
+            type: "field",
+            key: "context"
+        },
+        {
+            type: "field",
+            key: "callSentiment"
+        },
+        {
+            type: "field",
+            key: "suggestedActions"
+        },
+    ],
+    summary: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__SUMMARY",
+    function: ({ cognigy, config, }) => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, input } = cognigy;
+        const { transferTarget, callerName, topic, context, callSentiment, suggestedActions, } = config;
+        const transferParams = {
+            transferTarget,
+            callerName,
+            topic,
+            context,
+            callSentiment,
+            suggestedActions,
+        };
+        try {
+            if (input.channel === "adminconsole") {
+                let textWarningAdminChannel = "Transferring a call is not supported in the Interaction Panel, please use the VoiceGateway endpoint.";
+                yield api.say(textWarningAdminChannel, null);
+                return;
+            }
+            const payload = msTeamsTransfer.handleInput("voiceGateway2", transferParams);
+            yield api.say(null, {
+                _cognigy: payload,
+            });
+            api.logDebugMessage(`UI__DEBUG_MODE__MS_TEAMS__TRANSFER__MESSAGE ${transferTarget}`);
+        }
+        catch (error) {
+            throw new Error(`Error on Transfer node type:. Error message: ${error.message}`);
+        }
+    }),
+});
+//# sourceMappingURL=msTeamsTransfer.js.map

package/dist/esm/shared/interfaces/IProfile.js

@@ -3,12 +3,16 @@ import { createQuerySchema } from "../helper/createQuerySchema";
 import { entityMetaSchema } from "./resources/IEntityMeta";
 ;
 ;
+export const profileTypes = [
+    "simulator",
+];
 export const profileDataSchema = {
     title: "profileDataSchema",
     type: "object",
     additionalProperties: false,
     properties: {
         active: { type: "boolean" },
+        type: { type: "string", enum: [...profileTypes] },
         contactIds: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 1 },
         contactIdsHash: { type: "string" },
         expiresAt: { type: "object" },

package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js

@@ -43,6 +43,9 @@ export const generativeAIModels = [
     "gemini-1.5-flash",
     "gemini-2.0-flash",
     "gemini-2.0-flash-lite",
+    "gemini-2.5-pro",
+    "gemini-2.5-flash",
+    "gemini-2.5-flash-lite",
     "amazon.nova-lite-v1:0",
     "amazon.nova-pro-v1:0",
     "amazon.nova-micro-v1:0",

package/dist/esm/shared/interfaces/resources/IAuditEvent.js

@@ -4,7 +4,8 @@ export const auditEventTypes = [
     "replace",
     "patch",
     "delete",
-    "unauthorized",
+    "authentication",
+    "authorization",
 ];
 export const actionTypes = [
     "acceptTermsOfService",
@@ -109,6 +110,10 @@ export const actionTypes = [
     "updateObservationConfig",
     "resolveAiOpsCenterError",
     "odataRequest",
+    "loginSucceeded",
+    "loginFailed",
+    "loginError",
+    "unauthorized",
 ];
 export const auditEventSchema = {
     title: "auditEventSchema",

package/dist/esm/shared/interfaces/resources/IChartNode.js

@@ -1,5 +1,11 @@
 /* Custom Modules */
 import { createQuerySchema } from "../../helper/createQuerySchema";
+export var ConvertActionType;
+(function (ConvertActionType) {
+    ConvertActionType["ADDED"] = "added";
+    ConvertActionType["REMOVED"] = "removed";
+    ConvertActionType["UPDATED"] = "updated";
+})(ConvertActionType || (ConvertActionType = {}));
 export const defaultNodeFields = [
     "label",
     "comment",

package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js

@@ -369,7 +369,17 @@ export const nodeDescriptorSchema = {
     properties: {
         _id: { type: "string", format: "mongo-id" },
         type: { type: "string", minLength: 1, maxLength: 200 },
-        parentType: { type: ["string", "null"], minLength: 1, maxLength: 200 },
+        parentType: {
+            oneOf: [
+                { type: "null" },
+                { type: "string", minLength: 1, maxLength: 200 },
+                {
+                    type: "array",
+                    items: { type: "string", minLength: 1, maxLength: 200 },
+                    minItems: 1
+                }
+            ]
+        },
         defaultLabel: {
             oneOf: [
                 { type: "string", minLength: 1, maxLength: 200 },

package/dist/esm/shared/interfaces/resources/settings/IAgentSettings.js

@@ -1,9 +1,10 @@
 import { entityMetaSchema } from "../IEntityMeta";
 import { sharedSettingsSchema } from "./ISharedSettings";
-import { generativeAISettingsDataSchema } from "./IGenerativeAISettings";
-import { audioPreviewSettingsDataSchema } from "./IAudioPreviewSettings";
-import { translationSettingsDataSchema } from "./ITranslationSettings";
-import { knowledgeAISettingsDataSchema } from "./IKnowledgeAISettings";
+import { generativeAISettingsDataSchema, } from "./IGenerativeAISettings";
+import { audioPreviewSettingsDataSchema, } from "./IAudioPreviewSettings";
+import { translationSettingsDataSchema, } from "./ITranslationSettings";
+import { knowledgeAISettingsDataSchema, } from "./IKnowledgeAISettings";
+import { piiDataRedactionSettingsSchema, } from "./IPiiDataRedactionSettings";
 export const agentSettingsDataSchema = {
     title: "agentSettingsDataSchema",
     type: "object",
@@ -11,31 +12,35 @@ export const agentSettingsDataSchema = {
     properties: Object.assign(Object.assign({}, sharedSettingsSchema.properties), { trackDataOnlyInputs: { type: "boolean" }, collectAnalytics: { type: "boolean" }, timezone: { type: "string", format: "timezone" }, useCaseSensitiveIntentMapping: { type: "boolean" }, translationSettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, translationSettingsDataSchema.properties)
+            properties: Object.assign({}, translationSettingsDataSchema.properties),
         }, audioPreviewSettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, audioPreviewSettingsDataSchema.properties)
+            properties: Object.assign({}, audioPreviewSettingsDataSchema.properties),
         }, generativeAISettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, generativeAISettingsDataSchema.properties)
+            properties: Object.assign({}, generativeAISettingsDataSchema.properties),
         }, currencySettings: {
             type: ["object", "null"],
             additionalProperties: false,
             properties: {
                 currency: { type: "string", format: "currency-code" },
-            }
+            },
         }, knowledgeAISettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, knowledgeAISettingsDataSchema.properties)
-        } })
+            properties: Object.assign({}, knowledgeAISettingsDataSchema.properties),
+        }, piiDataRedactionSettings: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            properties: Object.assign({}, piiDataRedactionSettingsSchema.properties),
+        } }),
 };
 export const agentSettingsSchema = {
     title: "agentSettingsSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), agentSettingsDataSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
+    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), agentSettingsDataSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
 };
 //# sourceMappingURL=IAgentSettings.js.map

package/dist/esm/shared/interfaces/resources/settings/IPiiDataRedactionSettings.js

@@ -0,0 +1,139 @@
+export var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType || (EPiiBehaviorType = {}));
+export const piiFieldSettingsSchema = {
+    title: "piiFieldSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["enabled", "name"],
+    properties: {
+        enabled: { type: "boolean" },
+        behavior: {
+            oneOf: [
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["type"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.PREDEFINED_ALIAS],
+                        },
+                        customAlias: { type: "null" },
+                    },
+                },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    // @ts-ignore
+                    required: ["type", "customAlias"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                        },
+                        customAlias: {
+                            type: "string",
+                            minLength: 3,
+                            maxLength: 100
+                        },
+                    },
+                },
+            ],
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: { type: "string", minLength: 3, maxLength: 100, pattern: "^[a-zA-Z0-9_\\s]+$" },
+    },
+    if: {
+        properties: {
+            enabled: { const: true }
+        }
+    },
+    then: {
+        required: ["enabled", "name", "behavior", "scope"]
+    },
+    else: {
+        required: ["enabled", "name"]
+    }
+};
+export const customPatternSettingsSchema = {
+    title: "customPatternSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["name", "regex", "behavior", "scope"],
+    properties: {
+        regex: {
+            type: "string",
+            minLength: 1,
+            maxLength: 1000
+        },
+        behavior: {
+            type: "object",
+            additionalProperties: false,
+            // @ts-ignore
+            required: ["type", "customAlias"],
+            properties: {
+                type: {
+                    type: "string",
+                    enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                },
+                customAlias: {
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 100
+                },
+            },
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: {
+            type: "string",
+            minLength: 3,
+            maxLength: 100,
+            pattern: "^[a-zA-Z0-9_\\s]+$"
+        },
+    },
+};
+export const piiDataRedactionSettingsSchema = {
+    title: "piiDataRedactionSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "emailAddress",
+        "phoneNumber",
+        "creditCard",
+        "ssn",
+        "ipAddressV4",
+        "ipAddressV6",
+    ],
+    properties: {
+        emailAddress: piiFieldSettingsSchema,
+        phoneNumber: piiFieldSettingsSchema,
+        creditCard: piiFieldSettingsSchema,
+        ssn: piiFieldSettingsSchema,
+        ipAddressV4: piiFieldSettingsSchema,
+        ipAddressV6: piiFieldSettingsSchema,
+        customTypes: {
+            type: ["object", "null"],
+            additionalProperties: customPatternSettingsSchema
+        },
+    },
+};
+//# sourceMappingURL=IPiiDataRedactionSettings.js.map

package/dist/esm/shared/interfaces/resources/settings/index.js

@@ -1,8 +1,9 @@
 export { agentSettingsDataSchema, agentSettingsSchema, } from "./IAgentSettings";
-export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema } from "./IFlowSettings";
+export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema, } from "./IFlowSettings";
 export { sharedSettingsSchema } from "./ISharedSettings";
-export { generativeAISettingsDataSchema } from "./IGenerativeAISettings";
-export { audioPreviewSettingsDataSchema, audioPreviewProviders } from "./IAudioPreviewSettings";
-export { translationSettingsDataSchema, translationProviders } from "./ITranslationSettings";
+export { generativeAISettingsDataSchema, } from "./IGenerativeAISettings";
+export { audioPreviewSettingsDataSchema, audioPreviewProviders, } from "./IAudioPreviewSettings";
+export { translationSettingsDataSchema, translationProviders, } from "./ITranslationSettings";
 export { knowledgeAISettingsDataSchema, fileExtractorOptions, } from "./IKnowledgeAISettings";
+export { EPiiBehaviorType, piiDataRedactionSettingsSchema, } from "./IPiiDataRedactionSettings";
 //# sourceMappingURL=index.js.map