@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendMetadataNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const helper_1 = require("../utils/helper");
+exports.sendMetadataNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sendMetadata",
+    defaultLabel: "Send Metadata",
+    summary: "Sends metadata via SIP INFO messages",
+    fields: [
+        {
+            key: "metadata",
+            label: "Metadata",
+            type: "json",
+            defaultValue: { myParamName: "myParamValue" },
+            params: {
+                require: true,
+            },
+            description: "The metadata to send via SIP INFO messages",
+        },
+    ],
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    form: [
+        {
+            type: "field",
+            key: "metadata",
+        },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { metadata } = config;
+        const voiceGateway2Payload = {
+            "sip:request": {
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: "",
+                method: "INFO",
+                actionHook: "/info",
+            },
+        };
+        if (metadata) {
+            if ((0, helper_1.isValidJSON)(metadata)) {
+                voiceGateway2Payload["sip:request"].body = JSON.stringify(metadata);
+                api.say(null, {
+                    _cognigy: {
+                        _voiceGateway2: {
+                            json: voiceGateway2Payload,
+                        },
+                    },
+                });
+            }
+            else {
+                api.log("error", "Invalid JSON in Metadata Field");
+            }
+        }
+    },
+});
+//# sourceMappingURL=sendMetadata.js.map

package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js

@@ -0,0 +1,354 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setSessionConfigNode = exports.voiceConfigFields = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const setSessionConfig_mapper_1 = require("../../voice/mappers/setSessionConfig.mapper");
+const setSessionConfig_mapper_2 = require("../../voice/mappers/setSessionConfig.mapper");
+exports.voiceConfigFields = [
+    {
+        key: "bargeInMinWordCount",
+        type: "slider",
+        label: "Barge In Minimum Words",
+        description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
+        defaultValue: 1,
+        params: {
+            min: 0,
+            max: 5,
+            step: 1
+        }
+    },
+    {
+        key: "bargeInOnSpeech",
+        type: "toggle",
+        label: "Barge In On Speech",
+        description: "Allows the user to interrupt bot output with speech",
+        defaultValue: false
+    },
+    {
+        key: "bargeInOnDtmf",
+        type: "toggle",
+        label: "Barge In On DTMF",
+        description: "Allows the user to interrupt bot output with DTMF. If you enable this feature, you also need to enable the sending of DTMF digits",
+        defaultValue: false
+    },
+    {
+        key: "sttVendor",
+        type: "sttSelect",
+        label: "_unused_",
+        description: "_unused_",
+        defaultValue: "",
+        params: {
+            languageKey: "config.sttLanguage"
+        }
+    },
+    {
+        key: "sttHints",
+        type: "textArray",
+        label: "STT Hints",
+        description: "Array of words or phrases to assist speech detection",
+        defaultValue: [""]
+    },
+    {
+        key: "sttVadEnabled",
+        type: "toggle",
+        label: "Enable Voice Activity Detection",
+        description: "Delay connection to cloud recognizer until speech is detected",
+        defaultValue: true
+    },
+    {
+        key: "sttDisablePunctuation",
+        type: "toggle",
+        label: "Disable STT Punctuation",
+        description: "Prevents the STT response from the bot to include punctuation marks",
+        defaultValue: false
+    },
+    {
+        key: "sttVadMode",
+        type: "slider",
+        label: "VAD Sensitivity",
+        description: "Detection sensitivity, the lowest value has the highest sensitivity",
+        defaultValue: 1,
+        params: {
+            min: 0,
+            max: 3,
+            step: 1
+        },
+        condition: {
+            key: "sttVadEnabled",
+            value: true
+        }
+    },
+    {
+        key: "sttVadVoiceMs",
+        type: "slider",
+        label: "Minimal Voice Duration",
+        description: "Milliseconds of speech activity required before connecting to the cloud recognizer",
+        defaultValue: 100,
+        params: {
+            min: 100,
+            max: 1000,
+            step: 100
+        },
+        condition: {
+            key: "sttVadEnabled",
+            value: true
+        }
+    },
+    {
+        key: "ttsDisableCache",
+        type: "toggle",
+        label: "Disable TTS Audio Caching",
+        description: "Disable TTS audio caching for a reduced number of queries to TSS vendor. Warning, " +
+            "disabling caching increases your TTS costs",
+        defaultValue: false
+    },
+    {
+        key: "ttsVendor",
+        defaultValue: "",
+        type: "ttsSelect",
+        label: "_unused_",
+        description: "_unused_",
+        params: {
+            languageKey: "config.ttsLanguage",
+            voiceKey: "config.ttsVoice"
+        }
+    },
+    {
+        key: "userNoInputMode",
+        type: "select",
+        label: "User No Input Mode",
+        description: "Define what should happen if a user does not provide input to the bot in time",
+        defaultValue: "event",
+        params: {
+            options: [
+                {
+                    label: "Speak", value: "speech"
+                },
+                {
+                    label: "Play File", value: "play"
+                },
+                {
+                    label: "Send Event", value: "event"
+                }
+            ]
+        }
+    },
+    {
+        key: "userNoInputTimeout",
+        type: "number",
+        label: "User No Input Timeout",
+        description: "Define the timeout for user input in ms",
+        defaultValue: 10000,
+        params: {
+            min: 1000,
+        },
+    },
+    {
+        key: "userNoInputRetries",
+        type: "number",
+        label: "User No Input Retries",
+        description: "Define how often the bot should retry to get an input from a user before completing the call",
+        defaultValue: 1,
+        params: {
+            min: 0,
+        },
+    },
+    {
+        key: "userNoInputSpeech",
+        type: "cognigyText",
+        label: "User No Input Speech",
+        description: "Define a prompt to speak in case a user does not answer the bot in time",
+        defaultValue: "",
+        condition: {
+            key: "userNoInputMode",
+            value: "speech"
+        },
+        params: {
+            required: true
+        }
+    },
+    {
+        key: "userNoInputUrl",
+        type: "cognigyText",
+        label: "User No Input URL",
+        description: "Define which URL will be played in case a user does not answer the bot in time. MP3 and WAV files are supported",
+        defaultValue: "",
+        condition: {
+            key: "userNoInputMode",
+            value: "play"
+        },
+        params: {
+            required: true
+        }
+    },
+    {
+        key: "dtmfEnable",
+        type: "toggle",
+        label: "Capture DTMF Signals",
+        description: "Enables capturing of DTMF signals by the bot",
+        defaultValue: false
+    },
+    {
+        key: "dtmfInterDigitTimeout",
+        type: "number",
+        label: "DTMF Inter Digit Timeout",
+        description: "Defines the timeout in between collected DTMF digits",
+        defaultValue: 2000,
+        params: {
+            min: 1000,
+            max: 60000,
+        },
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        },
+    },
+    {
+        key: "dtmfMaxDigits",
+        type: "number",
+        label: "DTMF Max Digits",
+        description: "Defines the maximum number of digits which can be entered by the user, the digits are being submitted automatically once this limit is reached",
+        defaultValue: 1,
+        params: {
+            min: 1,
+        },
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "dtmfMinDigits",
+        type: "number",
+        label: "DTMF Min Digits",
+        description: "Defines the mininum number of digits before they are forwarded to the bot. This can be overridden by a submit digit",
+        defaultValue: 1,
+        params: {
+            min: 1,
+        },
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "dtmfSubmitDigit",
+        type: "cognigyText",
+        label: "DTMF Submit Digit",
+        description: "Defines the DTMF submit digit which will be used for submitting the previously entered digits. This overrides the minimum digits validation",
+        defaultValue: "#",
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "asrDigit",
+        type: "cognigyText",
+        label: "Continuous ASR Submit Digit",
+        description: "Defines a special DTMF key, which sends the accumulated recognitions to the flow",
+        defaultValue: "",
+        condition: {
+            key: "asrEnabled",
+            value: true
+        }
+    },
+    {
+        key: "asrEnabled",
+        type: "toggle",
+        label: "Enable Continuous ASR",
+        description: "Enables Continuous ASR",
+        defaultValue: false
+    },
+    {
+        key: "asrTimeout",
+        type: "number",
+        label: "Continuous ASR Timeout",
+        description: "Defines the number of milliseconds of silence before the accumulated recognitions are send to the flow",
+        defaultValue: 0,
+        params: {
+            min: 0,
+        },
+        condition: {
+            key: "asrEnabled",
+            value: true
+        }
+    },
+];
+exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setSessionConfig",
+    defaultLabel: "Set Session Config",
+    summary: "Change configuration settings for the call session",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: exports.voiceConfigFields,
+    sections: [
+        {
+            key: "params_stt",
+            label: "Recognizer (STT)",
+            defaultCollapsed: true,
+            fields: ["sttVendor", "sttHints", "sttDisablePunctuation", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
+        },
+        {
+            key: "params_tts",
+            label: "Synthesizer (TTS)",
+            defaultCollapsed: true,
+            fields: ["ttsVendor"]
+        },
+        {
+            key: "params_bargein",
+            label: "Barge In",
+            defaultCollapsed: true,
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"]
+        },
+        {
+            key: "params_user_timeouts",
+            label: "User Input Timeout",
+            defaultCollapsed: true,
+            fields: [
+                "userNoInputMode",
+                "userNoInputSpeech",
+                "userNoInputUrl",
+                "userNoInputTimeout",
+                "userNoInputRetries"
+            ]
+        },
+        {
+            key: "params_dtmf",
+            label: "DTMF",
+            defaultCollapsed: true,
+            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"]
+        },
+        {
+            key: "params_continuous_asr",
+            label: "Continuous ASR",
+            defaultCollapsed: true,
+            fields: ["asrEnabled", "asrDigit", "asrTimeout"],
+        }
+    ],
+    form: [
+        { type: "section", key: "params_tts" },
+        { type: "section", key: "params_stt" },
+        { type: "section", key: "params_bargein" },
+        { type: "section", key: "params_user_timeouts" },
+        { type: "section", key: "params_dtmf" },
+        { type: "section", key: "params_continuous_asr" },
+    ],
+    function: async ({ cognigy, config }) => {
+        try {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, cognigy.api));
+            cognigy.api.say(null, {
+                _cognigy: payload,
+            });
+        }
+        catch (error) {
+            throw new Error(`[VG2] Error on set session config node. Error message: ${error.message}`);
+        }
+        ;
+    }
+});
+//# sourceMappingURL=setSessionConfig.js.map

package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transferNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
+const constants_1 = require("../utils/constants");
+const design_1 = require("../utils/design");
+const helper_1 = require("../utils/helper");
+exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "transfer",
+    defaultLabel: "Transfer",
+    preview: {
+        key: "referTo",
+        type: "text",
+    },
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    fields: [
+        {
+            key: "referTo",
+            label: "Target",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "E.164 syntax or a SIP URI are supported",
+            defaultValue: "+49123456789",
+        },
+        {
+            key: "useTransferSipHeaders",
+            label: "Custom Transfer SIP Headers",
+            type: "toggle",
+            description: "Add data to be sent as SIP headers in the generated SIP message",
+            defaultValue: false,
+        },
+        {
+            key: "transferSipHeaders",
+            label: "Transfer SIP Headers",
+            type: "json",
+            description: "The data to be sent as SIP headers in the generated SIP message",
+            defaultValue: {
+                "X-Custom-Header": "YourValue",
+            },
+            condition: {
+                key: "useTransferSipHeaders",
+                value: true,
+            },
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: ["useTransferSipHeaders", "transferSipHeaders"],
+        },
+    ],
+    form: [
+        {
+            type: "field",
+            key: "referTo",
+        },
+        {
+            type: "section",
+            key: "advanced",
+        },
+    ],
+    summary: "Transfer the call to another target",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const transferParams = {
+            transferReason: "",
+            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            useTransferSipHeaders,
+            transferSipHeaders,
+        };
+        try {
+            if (useTransferSipHeaders &&
+                transferSipHeaders &&
+                !(0, helper_1.isValidJSON)(transferSipHeaders)) {
+                delete transferParams.transferSipHeaders;
+                transferParams.useTransferSipHeaders = false;
+                api.log("error", "Invalid JSON in Transfer SIP Headers");
+            }
+            const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);
+            api.say(null, {
+                _cognigy: payload,
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on Transfer node. Error message: ${error.message}`);
+        }
+    },
+});
+//# sourceMappingURL=transfer.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENDPOINTS = void 0;
+exports.ENDPOINTS = {
+    VOICE_GATEWAY: "voiceGateway2",
+};
+//# sourceMappingURL=constants.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/design.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeColor = void 0;
+exports.nodeColor = "#F5A623";
+//# sourceMappingURL=design.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/helper.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidJSON = exports.cleanTarget = void 0;
+function cleanTarget(target) {
+    if (target.includes("@")) {
+        const sip = target.replace(/\s/g, "");
+        if (target.substring(0, 4) === "sip:")
+            return sip;
+        return `sip:${sip}`;
+    }
+    const cleanedNumber = target.replace(/\s|\(|\)|\-/g, "");
+    let number = cleanedNumber;
+    if (number.substring(0, 4) === "tel:")
+        number = number.substring(4);
+    if (number.substring(0, 2) === "00")
+        return `+${number.slice(2)}`;
+    return number;
+}
+exports.cleanTarget = cleanTarget;
+function isValidJSON(json) {
+    try {
+        if (json &&
+            typeof json === "object" &&
+            Object.entries(json).length &&
+            !Array.isArray(json)) {
+            for (const value of Object.values(json)) {
+                if (["string", "number", "boolean"].includes(typeof value)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isValidJSON = isValidJSON;
+//# sourceMappingURL=helper.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripNulls = void 0;
+function stripNulls(data) {
+    Object.entries(data).forEach(([key, value]) => {
+        if (typeof value === "undefined" || typeof value === null || (typeof value === "string" && value.length == 0)) {
+            delete data[key];
+        }
+        if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string")) {
+            stripNulls(value);
+        }
+        if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string" || typeof value !== "boolean") && Object.keys(value).length === 0) {
+            delete data[key];
+        }
+    });
+    return data;
+}
+exports.stripNulls = stripNulls;
+//# sourceMappingURL=strip-nulls.js.map

package/build/shared/constants.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
+exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
 exports.CREATED_BY_SSO = "000000000000000000000550";
 exports.SYSTEM = "000000000000000000000000";
+exports.SYSTEM_EMAIL = "system@mail.com";
+exports.SCOPED_USER = "000000000000000000000660";
 exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = 900;
 exports.MAX_INT32 = 2147483647;
 exports.BASIC_EXTENSION = "@cognigy/basic-nodes";
@@ -10,4 +12,12 @@ exports.MONGO_DB_EXTENSION = "@cognigy/mongodb";
 exports.SQL_EXTENSION = "@cognigy/mssql";
 exports.SMTP_EXTENSION = "@cognigy/smtp";
 exports.VOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
+exports.MICROSOFT_EXTENSION = "@cognigy/microsoft";
+// to minimize confusion and also to not break existing voicegateway nodes implementation,
+// we will call the new set of voice nodes voiceGateway2
+exports.VOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
+exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = "@cognigy/internal-storage-provider";
+exports.EMBEDDED_EXTENSION = "@embedded/";
+exports.X_COGNIGY_ORIGIN = "x-cognigy-origin";
+exports.ADMIN_CONSOLE_URL_TOKEN = "ffffffffffffffffffff55555555555555555eeeeeeeeeeeeeeeaaaaaaaaaaaa";
 //# sourceMappingURL=constants.js.map

package/build/shared/errors/baseError.js

@@ -15,8 +15,41 @@ class BaseError extends Error {
         this.httpStatusText = httpStatusText || "Internal Server Error";
         this.loggerstack = stack;
         this.details = details || {};
-        this.meta = meta;
-        exports.errorLogger.log("error", stack, message || name, meta);
+        this.meta = meta || {};
+        if (this.meta.originalError) {
+            if (this.meta.originalError instanceof BaseError) {
+                // if the passed error is already an instance of our base class error class, no need to 
+                this.originalErrorDetails = this.meta.originalError.originalErrorDetails;
+            }
+            else {
+                this.originalErrorDetails = this.parseOriginalError(this.meta.originalError);
+            }
+            this.meta.originalError = this.originalErrorDetails;
+        }
+        exports.errorLogger.log("error", stack, message || name, this.meta);
+    }
+    parseOriginalError(error) {
+        return {
+            message: error.message,
+            stack: error.stack,
+            name: error.name,
+            code: error.code,
+            data: error.data,
+            path: error.path
+        };
+    }
+    toErrorLogDetails() {
+        return {
+            name: this.name,
+            code: this.code,
+            httpStatusCode: this.httpStatusCode,
+            httpStatusText: this.httpStatusText,
+            loggerstack: this.loggerstack,
+            details: this.details,
+            meta: this.meta,
+            originalError: this.originalErrorDetails,
+            stack: this.stack
+        };
     }
     toResponse() {
         return {

package/build/shared/handoverClients/interfaces/TAnyProviderResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TAnyProviderResponse.js.map

package/build/shared/handoverClients/interfaces/THandoverEventType.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handoverEventTypes = void 0;
+exports.handoverEventTypes = [
+    "agentReply",
+    "conversationClosed",
+    "conversationFailed",
+    "agentTypingOn",
+    "agentTypingOff",
+    "unknown"
+];
+//# sourceMappingURL=THandoverEventType.js.map