@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/charts/descriptors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
+exports.cognigyInternalStorageProviderModule = exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 /* Nodes */
@@ -11,83 +11,105 @@ const data_1 = require("./data");
 const logic_1 = require("./logic");
 const message_1 = require("./message");
 const nlu_1 = require("./nlu");
-const profile_1 = require("./profile");
+const voice_1 = require("./voice");
+const analytics_1 = require("./analytics");
 const service_1 = require("./service");
+const apps_1 = require("./apps");
+const liveAgent_1 = require("./liveAgent");
 // import { REQUIRED_FIELDS } from "./requiredFields";
 // import { ALL_FIELDS } from "./allFields";
-exports.cognigyBasicModule = createNodeDescriptor_1.createExtension({
-    nodes: [
-        start_1.START,
-        end_1.END,
-        placeholder_1.PLACEHOLDER,
-        data_1.ADD_TO_CONTEXT,
-        data_1.COPY_DATA_TO_CONTEXT,
-        data_1.COPY_SLOTS_TO_CONTEXT,
-        data_1.REMOVE_FROM_CONTEXT,
-        data_1.RESET_CONTEXT,
-        data_1.CODE,
-        data_1.LOG,
-        //CHECK_FRUSTRATION,
-        logic_1.INTERVAL,
-        logic_1.ELSE_INTERVAL,
-        logic_1.ON_INTERVAL,
-        logic_1.ONCE,
-        logic_1.ON_FIRST_EXECUTION,
-        logic_1.AFTERWARDS,
-        logic_1.SLEEP,
-        logic_1.STOP,
-        logic_1.WAIT,
-        logic_1.RESET_STATE,
-        logic_1.SET_STATE,
-        logic_1.THINK,
-        logic_1.IF,
-        logic_1.THEN,
-        logic_1.ELSE,
-        logic_1.SWITCH,
-        logic_1.CASE,
-        logic_1.DEFAULT,
-        logic_1.EXECUTE_FLOW,
-        logic_1.GO_TO,
-        logic_1.SWITCH_LOCALE,
-        message_1.SAY,
-        //SEND_IMAGE,
-        message_1.SEND_TEXT,
-        message_1.DATE_PICKER,
-        message_1.OPTIONAL_QUESTION,
-        message_1.QUESTION,
-        message_1.ON_ANSWER,
-        message_1.ON_QUESTION,
-        //CHECK_CHANNEL_CHANGE,
-        message_1.ON_NO,
-        message_1.ON_YES,
-        message_1.UNCHANGED,
-        nlu_1.REGEX_SLOT_FILLER,
-        nlu_1.EXECUTE_COGNIGY_NLU,
-        nlu_1.ADD_LEXICON_KEYPHRASE,
-        profile_1.ACTIVATE_PROFILE,
-        profile_1.COMPLETE_GOAL,
-        profile_1.DEACTIVATE_PROFILE,
-        profile_1.DELETE_PROFILE,
-        profile_1.MERGE_PROFILE,
-        profile_1.UPDATE_PROFILE,
-        profile_1.BLIND_MODE,
-        profile_1.OVERWRITE_ANALYTICS,
-        service_1.HANDOVER,
-        service_1.HTTP_REQUEST,
-        service_1.TRIGGER_FUNCTION,
-        service_1.ON_SCHEDULING_ERROR,
-        service_1.ON_SCHEDULED,
-        // REQUIRED_FIELDS,
-        //ALL_FIELDS,
-        logic_1.ENABLE_SLOT_FILLERS,
-        logic_1.DISABLE_SLOT_FILLERS
-    ],
+const nodes = [
+    start_1.START,
+    end_1.END,
+    placeholder_1.PLACEHOLDER,
+    data_1.ADD_TO_CONTEXT,
+    data_1.COPY_DATA_TO_CONTEXT,
+    data_1.COPY_SLOTS_TO_CONTEXT,
+    data_1.REMOVE_FROM_CONTEXT,
+    data_1.RESET_CONTEXT,
+    data_1.CODE,
+    data_1.LOG,
+    logic_1.INTERVAL,
+    logic_1.ELSE_INTERVAL,
+    logic_1.ON_INTERVAL,
+    logic_1.ONCE,
+    logic_1.ON_FIRST_EXECUTION,
+    logic_1.AFTERWARDS,
+    logic_1.SLEEP,
+    logic_1.STOP,
+    logic_1.WAIT,
+    logic_1.RESET_STATE,
+    logic_1.SET_STATE,
+    logic_1.THINK,
+    logic_1.THINK_V2,
+    logic_1.IF,
+    logic_1.THEN,
+    logic_1.ELSE,
+    logic_1.SWITCH,
+    logic_1.CASE,
+    logic_1.DEFAULT,
+    logic_1.EXECUTE_FLOW,
+    logic_1.GO_TO,
+    logic_1.SWITCH_LOCALE,
+    logic_1.SET_TRANSLATION,
+    message_1.SAY,
+    message_1.SEND_TEXT,
+    message_1.DATE_PICKER,
+    message_1.OPTIONAL_QUESTION,
+    message_1.QUESTION,
+    message_1.ON_ANSWER,
+    message_1.ON_QUESTION,
+    message_1.ON_NO,
+    message_1.ON_YES,
+    message_1.UNCHANGED,
+    nlu_1.REGEX_SLOT_FILLER,
+    nlu_1.EXECUTE_COGNIGY_NLU,
+    nlu_1.ADD_LEXICON_KEYPHRASE,
+    nlu_1.FUZZY_SEARCH,
+    nlu_1.MATCH_PATTERN,
+    analytics_1.ACTIVATE_PROFILE,
+    analytics_1.COMPLETE_GOAL,
+    analytics_1.DEACTIVATE_PROFILE,
+    analytics_1.DELETE_PROFILE,
+    analytics_1.MERGE_PROFILE,
+    analytics_1.UPDATE_PROFILE,
+    analytics_1.BLIND_MODE,
+    analytics_1.OVERWRITE_ANALYTICS,
+    service_1.HANDOVER,
+    service_1.HANDOVER_V2,
+    service_1.CHECK_AGENT_AVAILABILITY,
+    service_1.HTTP_REQUEST,
+    service_1.TRIGGER_FUNCTION,
+    service_1.ON_SCHEDULING_ERROR,
+    service_1.ON_SCHEDULED,
+    // REQUIRED_FIELDS,
+    //ALL_FIELDS,
+    logic_1.ENABLE_SLOT_FILLERS,
+    logic_1.DISABLE_SLOT_FILLERS,
+];
+if (process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true") {
+    nodes.push(liveAgent_1.ASSIST_INFO);
+}
+if (process.env.FEATURE_USE_COGNIGY_APPS === "true") {
+    nodes.push(apps_1.INIT_APP_SESSION, apps_1.SET_APP_STATE, apps_1.GET_APP_SESSION_PIN, apps_1.SET_HTML_APP_STATE, apps_1.SET_ADAPTIVE_CARD_APP_STATE);
+}
+if (process.env.FEATURE_TMP_ENABLE_GENERIC_VOICE_NODES === "true") {
+    nodes.push(voice_1.HANG_UP, voice_1.PLAY, voice_1.TRANSFER_VOICE, voice_1.BARGE_IN, voice_1.CONTINUOUS_ASR, voice_1.DTMF, voice_1.USER_INPUT_TIMEOUT, voice_1.SESSION_SPEECH_PARAMETERS);
+}
+if (process.env.FEATURE_DISABLE_INSIGHTS !== "true") {
+    nodes.push(analytics_1.SET_RATING, analytics_1.REQUEST_RATING);
+}
+if (process.env.FEATURE_ENABLE_EXTRACT_ANSWER === "true") {
+    nodes.push(nlu_1.EXTRACT_ANSWER);
+}
+exports.cognigyBasicModule = (0, createNodeDescriptor_1.createExtension)({
+    nodes,
     connections: [
         service_1.HTTP_CONNECTION_BASIC,
         service_1.HTTP_CONNECTION_APIKEYAUTHKEY,
         service_1.HTTP_CONNECTION_APIKEYXKEY,
         service_1.HTTP_CONNECTION_OAUTH2,
-    ]
+    ],
 });
 var mongoDB_1 = require("./connectionNodes/mongoDB");
 Object.defineProperty(exports, "cognigyMongoDBModule", { enumerable: true, get: function () { return mongoDB_1.cognigyMongoDBModule; } });
@@ -97,4 +119,10 @@ var smtp_1 = require("./connectionNodes/smtp");
 Object.defineProperty(exports, "cognigySMTPModule", { enumerable: true, get: function () { return smtp_1.cognigySMTPModule; } });
 var voicegateway_1 = require("./voicegateway");
 Object.defineProperty(exports, "cognigyVoiceGatewayModule", { enumerable: true, get: function () { return voicegateway_1.cognigyVoiceGatewayModule; } });
+var microsoft_1 = require("./microsoft");
+Object.defineProperty(exports, "cognigyMicrosoftModule", { enumerable: true, get: function () { return microsoft_1.cognigyMicrosoftModule; } });
+var voicegateway2_1 = require("./voicegateway2");
+Object.defineProperty(exports, "cognigyVoiceGateway2Module", { enumerable: true, get: function () { return voicegateway2_1.cognigyVoiceGateway2Module; } });
+var internalStorageProviders_1 = require("./connectionNodes/internalStorageProviders");
+Object.defineProperty(exports, "cognigyInternalStorageProviderModule", { enumerable: true, get: function () { return internalStorageProviders_1.cognigyInternalStorageProviderModule; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/liveAgent/assistInfo.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ASSIST_INFO = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const utils_1 = require("./utils");
+/**
+ * Node name: 'assistInfo'
+ *
+ * Purpose:
+ * Sends an info summary to the live agent
+ */
+exports.ASSIST_INFO = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "assistInfo",
+    defaultLabel: "Agent Assist Card",
+    summary: "Send an info summary to the live agent",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [
+        {
+            key: "cardType",
+            type: "select",
+            label: "Assist Card Types",
+            defaultValue: "basic",
+            params: {
+                options: [
+                    {
+                        label: "Basic Info Card",
+                        value: "basic"
+                    },
+                    {
+                        label: "Suggested Replies",
+                        value: "suggested"
+                    },
+                    {
+                        label: "Table Card",
+                        value: "table"
+                    },
+                    {
+                        label: "Custom Adaptive Card",
+                        value: "custom"
+                    },
+                ]
+            }
+        },
+        {
+            key: "title",
+            type: "cognigyText",
+            label: "Title",
+            description: "The title of the card",
+            defaultValue: "",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "custom",
+                negate: true
+            },
+        },
+        {
+            key: "subtitle",
+            type: "cognigyText",
+            label: "Subtitle",
+            description: "The subtitle of the card",
+            defaultValue: "",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "custom",
+                negate: true
+            },
+        },
+        {
+            key: "body",
+            type: "cognigyText",
+            label: "Body",
+            description: "The description of the basic info card",
+            defaultValue: "",
+            params: {
+                required: true,
+                multiline: true,
+                rows: 3,
+                maxRows: 5
+            },
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicImage",
+            type: "cognigyText",
+            label: "Image",
+            description: "The URL to the image (optional)",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicActionTitle",
+            type: "cognigyText",
+            label: "Action Title",
+            description: "The Title of the action (optional)",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicActionUrl",
+            type: "cognigyText",
+            label: "Action URL",
+            description: "The URL of the action (optional)",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "body",
+            type: "cognigyText",
+            label: "Body",
+            description: "The description of suggested replies",
+            defaultValue: "",
+            params: {
+                required: true,
+                multiline: true,
+                rows: 3,
+                maxRows: 5
+            },
+            condition: {
+                key: "cardType",
+                value: "suggested"
+            }
+        },
+        {
+            key: "suggestedActionTitles",
+            type: "cognigyTextArray",
+            label: "Suggestions",
+            description: "Array of suggested replies",
+            condition: {
+                key: "cardType",
+                value: "suggested"
+            }
+        },
+        {
+            key: "tableFacts",
+            type: "keyValuePairs",
+            label: "Table",
+            description: "Key value pairs that will be displayed in a table",
+            defaultValue: "{}",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "table"
+            }
+        },
+        {
+            key: "customJson",
+            type: "json",
+            label: "JSON",
+            defaultValue: JSON.stringify({
+                "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+                "type": "AdaptiveCard",
+                "version": "1.5",
+                "body": []
+            }, null, 4),
+            condition: {
+                key: "cardType",
+                value: "custom"
+            }
+        },
+    ],
+    tags: ["basic", "message"],
+    preview: {
+        key: "title",
+        type: "text",
+    },
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const dataResponse = (0, utils_1.buildCognigyWhisperAssistResponse)(config);
+        api.say("", dataResponse);
+    },
+});
+//# sourceMappingURL=assistInfo.js.map

package/build/shared/charts/descriptors/liveAgent/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ASSIST_INFO = void 0;
+var assistInfo_1 = require("./assistInfo");
+Object.defineProperty(exports, "ASSIST_INFO", { enumerable: true, get: function () { return assistInfo_1.ASSIST_INFO; } });
+//# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/liveAgent/utils/buildCognigyWhisperAssistResponse.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCognigyWhisperAssistResponse = void 0;
+const buildCognigyWhisperAssistResponse = (config) => {
+    const { cardType, title, subtitle, body, basicImage, basicActionTitle, basicActionUrl, suggestedActionTitles, tableFacts, customJson } = config;
+    let adaptiveCard = {};
+    const basicCardData = {
+        version: "1.5",
+        $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+        type: "AdaptiveCard",
+    };
+    const actions = [];
+    switch (cardType) {
+        case "basic":
+            if (basicActionTitle && basicActionUrl) {
+                actions.push({
+                    type: "Action.OpenUrl",
+                    title: basicActionTitle,
+                    url: basicActionUrl
+                });
+            }
+            adaptiveCard = Object.assign(Object.assign({}, basicCardData), { body: [
+                    {
+                        type: "TextBlock",
+                        size: "default",
+                        weight: "bolder",
+                        text: title,
+                    },
+                    {
+                        type: "TextBlock",
+                        spacing: "None",
+                        text: subtitle,
+                        isSubtle: true,
+                        wrap: true
+                    },
+                    basicImage ? {
+                        type: "Image",
+                        url: basicImage
+                    } : {},
+                    {
+                        type: "TextBlock",
+                        text: body,
+                        wrap: true
+                    },
+                    {
+                        type: "ActionSet",
+                        actions
+                    }
+                ] });
+            break;
+        case "suggested":
+            suggestedActionTitles.forEach((title) => {
+                if (title) {
+                    actions.push({
+                        type: "Action.Execute",
+                        title
+                    });
+                }
+            });
+            adaptiveCard = Object.assign(Object.assign({}, basicCardData), { body: [
+                    {
+                        type: "TextBlock",
+                        size: "default",
+                        weight: "bolder",
+                        text: title,
+                    },
+                    {
+                        type: "TextBlock",
+                        spacing: "None",
+                        text: subtitle,
+                        isSubtle: true,
+                        wrap: true
+                    },
+                    {
+                        type: "TextBlock",
+                        text: body,
+                        wrap: true
+                    },
+                    {
+                        type: "ActionSet",
+                        actions
+                    }
+                ] });
+            break;
+        case "table":
+            /**
+             * @example
+             * {
+             * 		title: "Key1",
+             * 		value: "Value 1",
+             * }
+             */
+            const facts = Object.keys(tableFacts).map(key => {
+                return {
+                    "title": key,
+                    "value": tableFacts[key]
+                };
+            });
+            adaptiveCard = Object.assign(Object.assign({}, basicCardData), { body: [
+                    {
+                        type: "TextBlock",
+                        size: "default",
+                        weight: "bolder",
+                        text: title,
+                    },
+                    {
+                        type: "TextBlock",
+                        spacing: "None",
+                        text: subtitle,
+                        isSubtle: true,
+                        wrap: true
+                    },
+                    {
+                        type: "FactSet",
+                        facts
+                    },
+                ] });
+            break;
+        case "custom":
+            adaptiveCard = customJson;
+            break;
+        default:
+            throw new Error(`Unknown card type: ${cardType}`);
+    }
+    return {
+        _cognigy: {
+            _whisperAssist: {
+                cardType,
+                adaptiveCard
+            }
+        }
+    };
+};
+exports.buildCognigyWhisperAssistResponse = buildCognigyWhisperAssistResponse;
+//# sourceMappingURL=buildCognigyWhisperAssistResponse.js.map

package/build/shared/charts/descriptors/liveAgent/utils/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCognigyWhisperAssistResponse = void 0;
+var buildCognigyWhisperAssistResponse_1 = require("./buildCognigyWhisperAssistResponse");
+Object.defineProperty(exports, "buildCognigyWhisperAssistResponse", { enumerable: true, get: function () { return buildCognigyWhisperAssistResponse_1.buildCognigyWhisperAssistResponse; } });
+//# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/logic/disableSlotFillers.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Disables slot fillers
  */
-exports.DISABLE_SLOT_FILLERS = createNodeDescriptor_1.createNodeDescriptor({
+exports.DISABLE_SLOT_FILLERS = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "disableSlotFillers",
     defaultLabel: "Disable Slot Fillers",
     summary: 'Disable Slot Fillers',

package/build/shared/charts/descriptors/logic/enableSlotFillers.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Enables slot fillers
  */
-exports.ENABLE_SLOT_FILLERS = createNodeDescriptor_1.createNodeDescriptor({
+exports.ENABLE_SLOT_FILLERS = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "enableSlotFillers",
     defaultLabel: "Enable Slot Fillers",
     summary: 'Enable Slot Fillers',

package/build/shared/charts/descriptors/logic/executeFlow.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Executes a given node in a given Flow
  */
-exports.EXECUTE_FLOW = createNodeDescriptor_1.createNodeDescriptor({
+exports.EXECUTE_FLOW = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "executeFlow",
     defaultLabel: "Execute Flow",
     summary: 'Executes another Flow, then continues the calling Flow',

package/build/shared/charts/descriptors/logic/goTo.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Jumps to a given node in a given Flow
  */
-exports.GO_TO = createNodeDescriptor_1.createNodeDescriptor({
+exports.GO_TO = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "goTo",
     defaultLabel: "Go To",
     summary: "Jumps to a specific Node in a Flow",
@@ -134,6 +134,7 @@ exports.GO_TO = createNodeDescriptor_1.createNodeDescriptor({
         }
         if (!api.checkThink(thisNodeId)) {
             api.resetNextNodes();
+            api.setThinkMarker(config.flowNode.flow);
             // Check if execution is to wait at Node for Input
             if (executionMode === "wait") {
                 await api.goToNode(config.flowNode);

package/build/shared/charts/descriptors/logic/if/else.js

@@ -3,19 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ELSE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
-exports.ELSE = createNodeDescriptor_1.createNodeDescriptor({
+exports.ELSE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "else",
     parentType: "if",
     defaultLabel: "Else",
     appearance: {
         color: '#B3A7EA',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     constraints: {
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         movable: false,
         placement: {},

package/build/shared/charts/descriptors/logic/if/if.js

@@ -3,13 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IF = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
-exports.IF = createNodeDescriptor_1.createNodeDescriptor({
+exports.IF = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "if",
     defaultLabel: 'If',
     summary: "Evaluates a condition and branches",
     appearance: {
-        color: '#8A7BC4',
+        color: '#9483D4',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'hexagon',
         showIcon: false
     },

package/build/shared/charts/descriptors/logic/if/then.js

@@ -3,19 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.THEN = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
-exports.THEN = createNodeDescriptor_1.createNodeDescriptor({
+exports.THEN = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "then",
     parentType: "if",
     defaultLabel: "Then",
     appearance: {
         color: '#B3A7EA',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     constraints: {
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         movable: false,
         placement: {},